One Level Up Top Level

src/stream/ngx_stream.h - nginx

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.     int                            protocol;
  66. #if (NGX_HAVE_SETFIB)
  67.     int                            setfib;
  68. #endif
  69. #if (NGX_HAVE_TCP_FASTOPEN)
  70.     int                            fastopen;
  71. #endif
  72. #if (NGX_HAVE_KEEPALIVE_TUNABLE)
  73.     int                            tcp_keepidle;
  74.     int                            tcp_keepintvl;
  75.     int                            tcp_keepcnt;
  76. #endif

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


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


  95. ‌typedef struct ngx_stream_phase_handler_s  ngx_stream_phase_handler_t;

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


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


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


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


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

  123.     ngx_stream_phase_engine_t      phase_engine;

  125.     ngx_hash_t                     variables_hash;

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

  131.     ngx_uint_t                     server_names_hash_max_size;
  132.     ngx_uint_t                     server_names_hash_bucket_size;

  134.     ngx_uint_t                     variables_hash_max_size;
  135.     ngx_uint_t                     variables_hash_bucket_size;

  137.     ngx_hash_keys_arrays_t        *variables_keys;

  139.     ngx_array_t                   *ports;

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


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

  149.     ngx_stream_content_handler_pt  handler;

  151.     ngx_stream_conf_ctx_t         *ctx;

  153.     u_char                        *file_name;
  154.     ngx_uint_t                     line;

  156.     ngx_str_t                      server_name;

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

  162.     ngx_log_t                     *error_log;

  164.     ngx_msec_t                     resolver_timeout;
  165.     ngx_resolver_t                *resolver;

  167.     ngx_msec_t                     proxy_protocol_timeout;

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


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


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


  188. ‌typedef struct {
  189.     ngx_hash_combined_t            names;

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


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

  200.     ngx_stream_virtual_names_t    *virtual_names;

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


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


  213. #if (NGX_HAVE_INET6)

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

  220. #endif


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


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


  238. ‌typedef struct {
  239.     ngx_stream_listen_opt_t        opt;

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

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

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

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


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

  264.     ngx_connection_t              *connection;

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

  270.     ngx_log_handler_pt             log_handler;

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

  276.     ngx_stream_virtual_names_t    *virtual_names;

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

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

  289.     ngx_int_t                      phase_handler;
  290.     ngx_uint_t                     status;

  292.     unsigned                       ssl:1;

  294.     unsigned                       stat_processing:1;

  296.     unsigned                       health_check:1;

  298.     unsigned                       limit_conn_status:2;
  299. };


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

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

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


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

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


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


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


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

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

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


  348. ‌#define NGX_STREAM_WRITE_BUFFERED  0x10


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

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

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

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


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


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


  381. extern ngx_stream_filter_pt  ngx_stream_top_filter;


  384. #endif /* _NGX_STREAM_H_INCLUDED_ */

One Level Up Top Level