One Level Up Top Level

src/stream/ngx_stream.h - nginx source code

Data types defined

Macros defined

Source code


  2. /*
  3. * Copyright (C) Roman Arutyunyan
  4. * Copyright (C) Nginx, Inc.
  5. */


  8. #ifndef _NGX_STREAM_H_INCLUDED_
  9. ‌#define _NGX_STREAM_H_INCLUDED_


  12. #include <ngx_config.h>
  13. #include <ngx_core.h>

  15. #if (NGX_STREAM_SSL)
  16. #include <ngx_stream_ssl_module.h>
  17. #endif


  20. ‌typedef struct ngx_stream_session_s  ngx_stream_session_t;


  23. #include <ngx_stream_variables.h>
  24. #include <ngx_stream_script.h>
  25. #include <ngx_stream_upstream.h>
  26. #include <ngx_stream_upstream_round_robin.h>


  29. ‌#define NGX_STREAM_OK                        200
  30. ‌#define NGX_STREAM_BAD_REQUEST               400
  31. ‌#define NGX_STREAM_FORBIDDEN                 403
  32. ‌#define NGX_STREAM_INTERNAL_SERVER_ERROR     500
  33. ‌#define NGX_STREAM_BAD_GATEWAY               502
  34. ‌#define NGX_STREAM_SERVICE_UNAVAILABLE       503


  37. ‌typedef struct {
  38.     void                         **main_conf;
  39.     void                         **srv_conf;
  40. ‌} ngx_stream_conf_ctx_t;


  43. ‌typedef struct {
  44.     struct sockaddr               *sockaddr;
  45.     socklen_t                      socklen;
  46.     ngx_str_t                      addr_text;

  48.     unsigned                       set:1;
  49.     unsigned                       default_server:1;
  50.     unsigned                       bind:1;
  51.     unsigned                       wildcard:1;
  52.     unsigned                       ssl:1;
  53. #if (NGX_HAVE_INET6)
  54.     unsigned                       ipv6only:1;
  55. #endif
  56.     unsigned                       deferred_accept:1;
  57.     unsigned                       reuseport:1;
  58.     unsigned                       so_keepalive:2;
  59.     unsigned                       proxy_protocol:1;

  61.     int                            backlog;
  62.     int                            rcvbuf;
  63.     int                            sndbuf;
  64.     int                            type;
  65. #if (NGX_HAVE_SETFIB)
  66.     int                            setfib;
  67. #endif
  68. #if (NGX_HAVE_TCP_FASTOPEN)
  69.     int                            fastopen;
  70. #endif
  71. #if (NGX_HAVE_KEEPALIVE_TUNABLE)
  72.     int                            tcp_keepidle;
  73.     int                            tcp_keepintvl;
  74.     int                            tcp_keepcnt;
  75. #endif

  77. #if (NGX_HAVE_DEFERRED_ACCEPT && defined SO_ACCEPTFILTER)
  78.     char                          *accept_filter;
  79. #endif
  80. ‌} ngx_stream_listen_opt_t;


  83. ‌typedef enum {
  84.     NGX_STREAM_POST_ACCEPT_PHASE = 0,
  85.     NGX_STREAM_PREACCESS_PHASE,
  86.     NGX_STREAM_ACCESS_PHASE,
  87.     NGX_STREAM_SSL_PHASE,
  88.     NGX_STREAM_PREREAD_PHASE,
  89.     NGX_STREAM_CONTENT_PHASE,
  90.     NGX_STREAM_LOG_PHASE
  91. ‌} ngx_stream_phases;


  94. ‌typedef struct ngx_stream_phase_handler_s  ngx_stream_phase_handler_t;

  96. ‌typedef ngx_int_t (*ngx_stream_phase_handler_pt)(ngx_stream_session_t *s,
  97.     ngx_stream_phase_handler_t *ph);
  98. ‌typedef ngx_int_t (*ngx_stream_handler_pt)(ngx_stream_session_t *s);
  99. ‌typedef void (*ngx_stream_content_handler_pt)(ngx_stream_session_t *s);


  102. ‌struct ngx_stream_phase_handler_s {
  103.     ngx_stream_phase_handler_pt    checker;
  104.     ngx_stream_handler_pt          handler;
  105.     ngx_uint_t                     next;
  106. };


  109. ‌typedef struct {
  110.     ngx_stream_phase_handler_t    *handlers;
  111. ‌} ngx_stream_phase_engine_t;


  114. ‌typedef struct {
  115.     ngx_array_t                    handlers;
  116. ‌} ngx_stream_phase_t;


  119. ‌typedef struct {
  120.     ngx_array_t                    servers;     /* ngx_stream_core_srv_conf_t */

  122.     ngx_stream_phase_engine_t      phase_engine;

  124.     ngx_hash_t                     variables_hash;

  126.     ngx_array_t                    variables;        /* ngx_stream_variable_t */
  127.     ngx_array_t                    prefix_variables; /* ngx_stream_variable_t */
  128.     ngx_uint_t                     ncaptures;

  130.     ngx_uint_t                     server_names_hash_max_size;
  131.     ngx_uint_t                     server_names_hash_bucket_size;

  133.     ngx_uint_t                     variables_hash_max_size;
  134.     ngx_uint_t                     variables_hash_bucket_size;

  136.     ngx_hash_keys_arrays_t        *variables_keys;

  138.     ngx_array_t                   *ports;

  140.     ngx_stream_phase_t             phases[NGX_STREAM_LOG_PHASE + 1];
  141. ‌} ngx_stream_core_main_conf_t;


  144. ‌typedef struct {
  145.     /* array of the ngx_stream_server_name_t, "server_name" directive */
  146.     ngx_array_t                    server_names;

  148.     ngx_stream_content_handler_pt  handler;

  150.     ngx_stream_conf_ctx_t         *ctx;

  152.     u_char                        *file_name;
  153.     ngx_uint_t                     line;

  155.     ngx_str_t                      server_name;

  157.     ngx_flag_t                     tcp_nodelay;
  158.     size_t                         preread_buffer_size;
  159.     ngx_msec_t                     preread_timeout;

  161.     ngx_log_t                     *error_log;

  163.     ngx_msec_t                     resolver_timeout;
  164.     ngx_resolver_t                *resolver;

  166.     ngx_msec_t                     proxy_protocol_timeout;

  168.     unsigned                       listen:1;
  169. #if (NGX_PCRE)
  170.     unsigned                       captures:1;
  171. #endif
  172. ‌} ngx_stream_core_srv_conf_t;


  175. /* list of structures to find core_srv_conf quickly at run time */


  178. ‌typedef struct {
  179. #if (NGX_PCRE)
  180.     ngx_stream_regex_t            *regex;
  181. #endif
  182.     ngx_stream_core_srv_conf_t    *server;   /* virtual name server conf */
  183.     ngx_str_t                      name;
  184. ‌} ngx_stream_server_name_t;


  187. ‌typedef struct {
  188.     ngx_hash_combined_t            names;

  190.     ngx_uint_t                     nregex;
  191.     ngx_stream_server_name_t      *regex;
  192. ‌} ngx_stream_virtual_names_t;


  195. ‌typedef struct {
  196.     /* the default server configuration for this address:port */
  197.     ngx_stream_core_srv_conf_t    *default_server;

  199.     ngx_stream_virtual_names_t    *virtual_names;

  201.     unsigned                       ssl:1;
  202.     unsigned                       proxy_protocol:1;
  203. ‌} ngx_stream_addr_conf_t;


  206. ‌typedef struct {
  207.     in_addr_t                      addr;
  208.     ngx_stream_addr_conf_t         conf;
  209. ‌} ngx_stream_in_addr_t;


  212. #if (NGX_HAVE_INET6)

  214. ‌typedef struct {
  215.     struct in6_addr                addr6;
  216.     ngx_stream_addr_conf_t         conf;
  217. ‌} ngx_stream_in6_addr_t;

  219. #endif


  222. ‌typedef struct {
  223.     /* ngx_stream_in_addr_t or ngx_stream_in6_addr_t */
  224.     void                          *addrs;
  225.     ngx_uint_t                     naddrs;
  226. ‌} ngx_stream_port_t;


  229. ‌typedef struct {
  230.     int                            family;
  231.     int                            type;
  232.     in_port_t                      port;
  233.     ngx_array_t                    addrs; /* array of ngx_stream_conf_addr_t */
  234. ‌} ngx_stream_conf_port_t;


  237. ‌typedef struct {
  238.     ngx_stream_listen_opt_t        opt;

  240.     unsigned                       protocols:3;
  241.     unsigned                       protocols_set:1;
  242.     unsigned                       protocols_changed:1;

  244.     ngx_hash_t                     hash;
  245.     ngx_hash_wildcard_t           *wc_head;
  246.     ngx_hash_wildcard_t           *wc_tail;

  248. #if (NGX_PCRE)
  249.     ngx_uint_t                     nregex;
  250.     ngx_stream_server_name_t      *regex;
  251. #endif

  253.     /* the default server configuration for this address:port */
  254.     ngx_stream_core_srv_conf_t    *default_server;
  255.     ngx_array_t                    servers;
  256.                                       /* array of ngx_stream_core_srv_conf_t */
  257. ‌} ngx_stream_conf_addr_t;


  260. ‌struct ngx_stream_session_s {
  261.     uint32_t                       signature;         /* "STRM" */

  263.     ngx_connection_t              *connection;

  265.     off_t                          received;
  266.     time_t                         start_sec;
  267.     ngx_msec_t                     start_msec;

  269.     ngx_log_handler_pt             log_handler;

  271.     void                         **ctx;
  272.     void                         **main_conf;
  273.     void                         **srv_conf;

  275.     ngx_stream_virtual_names_t    *virtual_names;

  277.     ngx_stream_upstream_t         *upstream;
  278.     ngx_array_t                   *upstream_states;
  279.                                            /* of ngx_stream_upstream_state_t */
  280.     ngx_stream_variable_value_t   *variables;

  282. #if (NGX_PCRE)
  283.     ngx_uint_t                     ncaptures;
  284.     int                           *captures;
  285.     u_char                        *captures_data;
  286. #endif

  288.     ngx_int_t                      phase_handler;
  289.     ngx_uint_t                     status;

  291.     unsigned                       ssl:1;

  293.     unsigned                       stat_processing:1;

  295.     unsigned                       health_check:1;

  297.     unsigned                       limit_conn_status:2;
  298. };


  301. ‌typedef struct {
  302.     ngx_int_t                    (*preconfiguration)(ngx_conf_t *cf);
  303.     ngx_int_t                    (*postconfiguration)(ngx_conf_t *cf);

  305.     void                        *(*create_main_conf)(ngx_conf_t *cf);
  306.     char                        *(*init_main_conf)(ngx_conf_t *cf, void *conf);

  308.     void                        *(*create_srv_conf)(ngx_conf_t *cf);
  309.     char                        *(*merge_srv_conf)(ngx_conf_t *cf, void *prev,
  310.                                                    void *conf);
  311. ‌} ngx_stream_module_t;


  314. ‌#define NGX_STREAM_MODULE       0x4d525453     /* "STRM" */

  316. ‌#define NGX_STREAM_MAIN_CONF    0x02000000
  317. ‌#define NGX_STREAM_SRV_CONF     0x04000000
  318. ‌#define NGX_STREAM_UPS_CONF     0x08000000


  321. ‌#define NGX_STREAM_MAIN_CONF_OFFSET  offsetof(ngx_stream_conf_ctx_t, main_conf)
  322. ‌#define NGX_STREAM_SRV_CONF_OFFSET   offsetof(ngx_stream_conf_ctx_t, srv_conf)


  325. ‌#define ngx_stream_get_module_ctx(s, module)   (s)->ctx[module.ctx_index]
  326. ‌#define ngx_stream_set_ctx(s, c, module)       s->ctx[module.ctx_index] = c;
  327. ‌#define ngx_stream_delete_ctx(s, module)       s->ctx[module.ctx_index] = NULL;


  330. ‌#define ngx_stream_get_module_main_conf(s, module)                             \
  331.     (s)->main_conf[module.ctx_index]
  332. ‌#define ngx_stream_get_module_srv_conf(s, module)                              \
  333.     (s)->srv_conf[module.ctx_index]

  335. ‌#define ngx_stream_conf_get_module_main_conf(cf, module)                       \
  336.     ((ngx_stream_conf_ctx_t *) cf->ctx)->main_conf[module.ctx_index]
  337. ‌#define ngx_stream_conf_get_module_srv_conf(cf, module)                        \
  338.     ((ngx_stream_conf_ctx_t *) cf->ctx)->srv_conf[module.ctx_index]

  340. ‌#define ngx_stream_cycle_get_module_main_conf(cycle, module)                   \
  341.     (cycle->conf_ctx[ngx_stream_module.index] ?                                \
  342.         ((ngx_stream_conf_ctx_t *) cycle->conf_ctx[ngx_stream_module.index])   \
  343.             ->main_conf[module.ctx_index]:                                     \
  344.         NULL)


  347. ‌#define NGX_STREAM_WRITE_BUFFERED  0x10


  350. ngx_int_t ngx_stream_add_listen(ngx_conf_t *cf,
  351.     ngx_stream_core_srv_conf_t *cscf, ngx_stream_listen_opt_t *lsopt);

  353. void ngx_stream_core_run_phases(ngx_stream_session_t *s);
  354. ngx_int_t ngx_stream_core_generic_phase(ngx_stream_session_t *s,
  355.     ngx_stream_phase_handler_t *ph);
  356. ngx_int_t ngx_stream_core_preread_phase(ngx_stream_session_t *s,
  357.     ngx_stream_phase_handler_t *ph);
  358. ngx_int_t ngx_stream_core_content_phase(ngx_stream_session_t *s,
  359.     ngx_stream_phase_handler_t *ph);

  361. ngx_int_t ngx_stream_validate_host(ngx_str_t *host, ngx_pool_t *pool,
  362.     ngx_uint_t alloc);
  363. ngx_int_t ngx_stream_find_virtual_server(ngx_stream_session_t *s,
  364.     ngx_str_t *host, ngx_stream_core_srv_conf_t **cscfp);

  366. void ngx_stream_init_connection(ngx_connection_t *c);
  367. void ngx_stream_session_handler(ngx_event_t *rev);
  368. void ngx_stream_finalize_session(ngx_stream_session_t *s, ngx_uint_t rc);


  371. extern ngx_module_t  ngx_stream_module;
  372. extern ngx_uint_t    ngx_stream_max_module;
  373. extern ngx_module_t  ngx_stream_core_module;


  376. ‌typedef ngx_int_t (*ngx_stream_filter_pt)(ngx_stream_session_t *s,
  377.     ngx_chain_t *chain, ngx_uint_t from_upstream);


  380. extern ngx_stream_filter_pt  ngx_stream_top_filter;


  383. #endif /* _NGX_STREAM_H_INCLUDED_ */

One Level Up Top Level