One Level Up Top Level

src/http/ngx_http_core_module.h - nginx source code

Data types defined

Macros defined

Source code


  2. /*
  3. * Copyright (C) Igor Sysoev
  4. * Copyright (C) Nginx, Inc.
  5. */


  8. #ifndef _NGX_HTTP_CORE_H_INCLUDED_
  9. ‌#define _NGX_HTTP_CORE_H_INCLUDED_


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

  16. #if (NGX_THREADS)
  17. #include <ngx_thread_pool.h>
  18. #elif (NGX_COMPAT)
  19. ‌typedef struct ngx_thread_pool_s  ngx_thread_pool_t;
  20. #endif


  23. ‌#define NGX_HTTP_GZIP_PROXIED_OFF       0x0002
  24. ‌#define NGX_HTTP_GZIP_PROXIED_EXPIRED   0x0004
  25. ‌#define NGX_HTTP_GZIP_PROXIED_NO_CACHE  0x0008
  26. ‌#define NGX_HTTP_GZIP_PROXIED_NO_STORE  0x0010
  27. ‌#define NGX_HTTP_GZIP_PROXIED_PRIVATE   0x0020
  28. ‌#define NGX_HTTP_GZIP_PROXIED_NO_LM     0x0040
  29. ‌#define NGX_HTTP_GZIP_PROXIED_NO_ETAG   0x0080
  30. ‌#define NGX_HTTP_GZIP_PROXIED_AUTH      0x0100
  31. ‌#define NGX_HTTP_GZIP_PROXIED_ANY       0x0200


  34. ‌#define NGX_HTTP_AIO_OFF                0
  35. ‌#define NGX_HTTP_AIO_ON                 1
  36. ‌#define NGX_HTTP_AIO_THREADS            2


  39. ‌#define NGX_HTTP_SATISFY_ALL            0
  40. ‌#define NGX_HTTP_SATISFY_ANY            1


  43. ‌#define NGX_HTTP_LINGERING_OFF          0
  44. ‌#define NGX_HTTP_LINGERING_ON           1
  45. ‌#define NGX_HTTP_LINGERING_ALWAYS       2


  48. ‌#define NGX_HTTP_IMS_OFF                0
  49. ‌#define NGX_HTTP_IMS_EXACT              1
  50. ‌#define NGX_HTTP_IMS_BEFORE             2


  53. ‌#define NGX_HTTP_KEEPALIVE_DISABLE_NONE    0x0002
  54. ‌#define NGX_HTTP_KEEPALIVE_DISABLE_MSIE6   0x0004
  55. ‌#define NGX_HTTP_KEEPALIVE_DISABLE_SAFARI  0x0008


  58. ‌#define NGX_HTTP_SERVER_TOKENS_OFF      0
  59. ‌#define NGX_HTTP_SERVER_TOKENS_ON       1
  60. ‌#define NGX_HTTP_SERVER_TOKENS_BUILD    2


  63. ‌typedef struct ngx_http_location_tree_node_s  ngx_http_location_tree_node_t;
  64. ‌typedef struct ngx_http_core_loc_conf_s  ngx_http_core_loc_conf_t;


  67. ‌typedef struct {
  68.     struct sockaddr           *sockaddr;
  69.     socklen_t                  socklen;
  70.     ngx_str_t                  addr_text;

  72.     unsigned                   set:1;
  73.     unsigned                   default_server:1;
  74.     unsigned                   bind:1;
  75.     unsigned                   wildcard:1;
  76.     unsigned                   ssl:1;
  77.     unsigned                   http2:1;
  78.     unsigned                   quic:1;
  79. #if (NGX_HAVE_INET6)
  80.     unsigned                   ipv6only:1;
  81. #endif
  82.     unsigned                   deferred_accept:1;
  83.     unsigned                   reuseport:1;
  84.     unsigned                   so_keepalive:2;
  85.     unsigned                   proxy_protocol:1;

  87.     int                        backlog;
  88.     int                        rcvbuf;
  89.     int                        sndbuf;
  90.     int                        type;
  91. #if (NGX_HAVE_SETFIB)
  92.     int                        setfib;
  93. #endif
  94. #if (NGX_HAVE_TCP_FASTOPEN)
  95.     int                        fastopen;
  96. #endif
  97. #if (NGX_HAVE_KEEPALIVE_TUNABLE)
  98.     int                        tcp_keepidle;
  99.     int                        tcp_keepintvl;
  100.     int                        tcp_keepcnt;
  101. #endif

  103. #if (NGX_HAVE_DEFERRED_ACCEPT && defined SO_ACCEPTFILTER)
  104.     char                      *accept_filter;
  105. #endif
  106. ‌} ngx_http_listen_opt_t;


  109. ‌typedef enum {
  110.     NGX_HTTP_POST_READ_PHASE = 0,

  112.     NGX_HTTP_SERVER_REWRITE_PHASE,

  114.     NGX_HTTP_FIND_CONFIG_PHASE,
  115.     NGX_HTTP_REWRITE_PHASE,
  116.     NGX_HTTP_POST_REWRITE_PHASE,

  118.     NGX_HTTP_PREACCESS_PHASE,

  120.     NGX_HTTP_ACCESS_PHASE,
  121.     NGX_HTTP_POST_ACCESS_PHASE,

  123.     NGX_HTTP_PRECONTENT_PHASE,

  125.     NGX_HTTP_CONTENT_PHASE,

  127.     NGX_HTTP_LOG_PHASE
  128. ‌} ngx_http_phases;

  130. ‌typedef struct ngx_http_phase_handler_s  ngx_http_phase_handler_t;

  132. ‌typedef ngx_int_t (*ngx_http_phase_handler_pt)(ngx_http_request_t *r,
  133.     ngx_http_phase_handler_t *ph);

  135. ‌struct ngx_http_phase_handler_s {
  136.     ngx_http_phase_handler_pt  checker;
  137.     ngx_http_handler_pt        handler;
  138.     ngx_uint_t                 next;
  139. };


  142. ‌typedef struct {
  143.     ngx_http_phase_handler_t  *handlers;
  144.     ngx_uint_t                 server_rewrite_index;
  145.     ngx_uint_t                 location_rewrite_index;
  146. ‌} ngx_http_phase_engine_t;


  149. ‌typedef struct {
  150.     ngx_array_t                handlers;
  151. ‌} ngx_http_phase_t;


  154. ‌typedef struct {
  155.     ngx_array_t                servers;         /* ngx_http_core_srv_conf_t */

  157.     ngx_http_phase_engine_t    phase_engine;

  159.     ngx_hash_t                 headers_in_hash;

  161.     ngx_hash_t                 variables_hash;

  163.     ngx_array_t                variables;         /* ngx_http_variable_t */
  164.     ngx_array_t                prefix_variables;  /* ngx_http_variable_t */
  165.     ngx_uint_t                 ncaptures;

  167.     ngx_uint_t                 server_names_hash_max_size;
  168.     ngx_uint_t                 server_names_hash_bucket_size;

  170.     ngx_uint_t                 variables_hash_max_size;
  171.     ngx_uint_t                 variables_hash_bucket_size;

  173.     ngx_hash_keys_arrays_t    *variables_keys;

  175.     ngx_array_t               *ports;

  177.     ngx_http_phase_t           phases[NGX_HTTP_LOG_PHASE + 1];
  178. ‌} ngx_http_core_main_conf_t;


  181. ‌typedef struct {
  182.     /* array of the ngx_http_server_name_t, "server_name" directive */
  183.     ngx_array_t                 server_names;

  185.     /* server ctx */
  186.     ngx_http_conf_ctx_t        *ctx;

  188.     u_char                     *file_name;
  189.     ngx_uint_t                  line;

  191.     ngx_str_t                   server_name;

  193.     size_t                      connection_pool_size;
  194.     size_t                      request_pool_size;
  195.     size_t                      client_header_buffer_size;

  197.     ngx_bufs_t                  large_client_header_buffers;

  199.     ngx_msec_t                  client_header_timeout;

  201.     ngx_flag_t                  ignore_invalid_headers;
  202.     ngx_flag_t                  merge_slashes;
  203.     ngx_flag_t                  underscores_in_headers;

  205.     unsigned                    listen:1;
  206. #if (NGX_PCRE)
  207.     unsigned                    captures:1;
  208. #endif

  210.     ngx_http_core_loc_conf_t  **named_locations;
  211. ‌} ngx_http_core_srv_conf_t;


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


  217. ‌typedef struct {
  218. #if (NGX_PCRE)
  219.     ngx_http_regex_t          *regex;
  220. #endif
  221.     ngx_http_core_srv_conf_t  *server;   /* virtual name server conf */
  222.     ngx_str_t                  name;
  223. ‌} ngx_http_server_name_t;


  226. ‌typedef struct {
  227.     ngx_hash_combined_t        names;

  229.     ngx_uint_t                 nregex;
  230.     ngx_http_server_name_t    *regex;
  231. ‌} ngx_http_virtual_names_t;


  234. ‌struct ngx_http_addr_conf_s {
  235.     /* the default server configuration for this address:port */
  236.     ngx_http_core_srv_conf_t  *default_server;

  238.     ngx_http_virtual_names_t  *virtual_names;

  240.     unsigned                   ssl:1;
  241.     unsigned                   http2:1;
  242.     unsigned                   quic:1;
  243.     unsigned                   proxy_protocol:1;
  244. };


  247. ‌typedef struct {
  248.     in_addr_t                  addr;
  249.     ngx_http_addr_conf_t       conf;
  250. ‌} ngx_http_in_addr_t;


  253. #if (NGX_HAVE_INET6)

  255. ‌typedef struct {
  256.     struct in6_addr            addr6;
  257.     ngx_http_addr_conf_t       conf;
  258. ‌} ngx_http_in6_addr_t;

  260. #endif


  263. ‌typedef struct {
  264.     /* ngx_http_in_addr_t or ngx_http_in6_addr_t */
  265.     void                      *addrs;
  266.     ngx_uint_t                 naddrs;
  267. ‌} ngx_http_port_t;


  270. ‌typedef struct {
  271.     ngx_int_t                  family;
  272.     ngx_int_t                  type;
  273.     in_port_t                  port;
  274.     ngx_array_t                addrs;     /* array of ngx_http_conf_addr_t */
  275. ‌} ngx_http_conf_port_t;


  278. ‌typedef struct {
  279.     ngx_http_listen_opt_t      opt;

  281.     unsigned                   protocols:3;
  282.     unsigned                   protocols_set:1;
  283.     unsigned                   protocols_changed:1;

  285.     ngx_hash_t                 hash;
  286.     ngx_hash_wildcard_t       *wc_head;
  287.     ngx_hash_wildcard_t       *wc_tail;

  289. #if (NGX_PCRE)
  290.     ngx_uint_t                 nregex;
  291.     ngx_http_server_name_t    *regex;
  292. #endif

  294.     /* the default server configuration for this address:port */
  295.     ngx_http_core_srv_conf_t  *default_server;
  296.     ngx_array_t                servers;  /* array of ngx_http_core_srv_conf_t */
  297. ‌} ngx_http_conf_addr_t;


  300. ‌typedef struct {
  301.     ngx_int_t                  status;
  302.     ngx_int_t                  overwrite;
  303.     ngx_http_complex_value_t   value;
  304.     ngx_str_t                  args;
  305. ‌} ngx_http_err_page_t;


  308. ‌struct ngx_http_core_loc_conf_s {
  309.     ngx_str_t     name;          /* location name */
  310.     ngx_str_t     escaped_name;

  312. #if (NGX_PCRE)
  313.     ngx_http_regex_t  *regex;
  314. #endif

  316.     unsigned      noname:1;   /* "if () {}" block or limit_except */
  317.     unsigned      lmt_excpt:1;
  318.     unsigned      named:1;

  320.     unsigned      exact_match:1;
  321.     unsigned      noregex:1;

  323.     unsigned      auto_redirect:1;
  324. #if (NGX_HTTP_GZIP)
  325.     unsigned      gzip_disable_msie6:2;
  326.     unsigned      gzip_disable_degradation:2;
  327. #endif

  329.     ngx_http_location_tree_node_t   *static_locations;
  330. #if (NGX_PCRE)
  331.     ngx_http_core_loc_conf_t       **regex_locations;
  332. #endif

  334.     /* pointer to the modules' loc_conf */
  335.     void        **loc_conf;

  337.     uint32_t      limit_except;
  338.     void        **limit_except_loc_conf;

  340.     ngx_http_handler_pt  handler;

  342.     /* location name length for inclusive location with inherited alias */
  343.     size_t        alias;
  344.     ngx_str_t     root;                    /* root, alias */
  345.     ngx_str_t     post_action;

  347.     ngx_array_t  *root_lengths;
  348.     ngx_array_t  *root_values;

  350.     ngx_array_t  *types;
  351.     ngx_hash_t    types_hash;
  352.     ngx_str_t     default_type;

  354.     off_t         client_max_body_size;    /* client_max_body_size */
  355.     off_t         directio;                /* directio */
  356.     off_t         directio_alignment;      /* directio_alignment */

  358.     size_t        client_body_buffer_size; /* client_body_buffer_size */
  359.     size_t        send_lowat;              /* send_lowat */
  360.     size_t        postpone_output;         /* postpone_output */
  361.     size_t        sendfile_max_chunk;      /* sendfile_max_chunk */
  362.     size_t        read_ahead;              /* read_ahead */
  363.     size_t        subrequest_output_buffer_size;
  364.                                            /* subrequest_output_buffer_size */

  366.     ngx_http_complex_value_t  *limit_rate; /* limit_rate */
  367.     ngx_http_complex_value_t  *limit_rate_after; /* limit_rate_after */

  369.     ngx_msec_t    client_body_timeout;     /* client_body_timeout */
  370.     ngx_msec_t    send_timeout;            /* send_timeout */
  371.     ngx_msec_t    keepalive_time;          /* keepalive_time */
  372.     ngx_msec_t    keepalive_timeout;       /* keepalive_timeout */
  373.     ngx_msec_t    lingering_time;          /* lingering_time */
  374.     ngx_msec_t    lingering_timeout;       /* lingering_timeout */
  375.     ngx_msec_t    resolver_timeout;        /* resolver_timeout */
  376.     ngx_msec_t    auth_delay;              /* auth_delay */

  378.     ngx_resolver_t  *resolver;             /* resolver */

  380.     time_t        keepalive_header;        /* keepalive_timeout */

  382.     ngx_uint_t    keepalive_requests;      /* keepalive_requests */
  383.     ngx_uint_t    keepalive_disable;       /* keepalive_disable */
  384.     ngx_uint_t    satisfy;                 /* satisfy */
  385.     ngx_uint_t    lingering_close;         /* lingering_close */
  386.     ngx_uint_t    if_modified_since;       /* if_modified_since */
  387.     ngx_uint_t    max_ranges;              /* max_ranges */
  388.     ngx_uint_t    client_body_in_file_only; /* client_body_in_file_only */

  390.     ngx_flag_t    client_body_in_single_buffer;
  391.                                            /* client_body_in_singe_buffer */
  392.     ngx_flag_t    internal;                /* internal */
  393.     ngx_flag_t    sendfile;                /* sendfile */
  394.     ngx_flag_t    aio;                     /* aio */
  395.     ngx_flag_t    aio_write;               /* aio_write */
  396.     ngx_flag_t    tcp_nopush;              /* tcp_nopush */
  397.     ngx_flag_t    tcp_nodelay;             /* tcp_nodelay */
  398.     ngx_flag_t    reset_timedout_connection; /* reset_timedout_connection */
  399.     ngx_flag_t    absolute_redirect;       /* absolute_redirect */
  400.     ngx_flag_t    server_name_in_redirect; /* server_name_in_redirect */
  401.     ngx_flag_t    port_in_redirect;        /* port_in_redirect */
  402.     ngx_flag_t    msie_padding;            /* msie_padding */
  403.     ngx_flag_t    msie_refresh;            /* msie_refresh */
  404.     ngx_flag_t    log_not_found;           /* log_not_found */
  405.     ngx_flag_t    log_subrequest;          /* log_subrequest */
  406.     ngx_flag_t    recursive_error_pages;   /* recursive_error_pages */
  407.     ngx_uint_t    server_tokens;           /* server_tokens */
  408.     ngx_flag_t    chunked_transfer_encoding; /* chunked_transfer_encoding */
  409.     ngx_flag_t    etag;                    /* etag */

  411. #if (NGX_HTTP_GZIP)
  412.     ngx_flag_t    gzip_vary;               /* gzip_vary */

  414.     ngx_uint_t    gzip_http_version;       /* gzip_http_version */
  415.     ngx_uint_t    gzip_proxied;            /* gzip_proxied */

  417. #if (NGX_PCRE)
  418.     ngx_array_t  *gzip_disable;            /* gzip_disable */
  419. #endif
  420. #endif

  422. #if (NGX_THREADS || NGX_COMPAT)
  423.     ngx_thread_pool_t         *thread_pool;
  424.     ngx_http_complex_value_t  *thread_pool_value;
  425. #endif

  427. #if (NGX_HAVE_OPENAT)
  428.     ngx_uint_t    disable_symlinks;        /* disable_symlinks */
  429.     ngx_http_complex_value_t  *disable_symlinks_from;
  430. #endif

  432.     ngx_array_t  *error_pages;             /* error_page */

  434.     ngx_path_t   *client_body_temp_path;   /* client_body_temp_path */

  436.     ngx_open_file_cache_t  *open_file_cache;
  437.     time_t        open_file_cache_valid;
  438.     ngx_uint_t    open_file_cache_min_uses;
  439.     ngx_flag_t    open_file_cache_errors;
  440.     ngx_flag_t    open_file_cache_events;

  442.     ngx_log_t    *error_log;

  444.     ngx_uint_t    types_hash_max_size;
  445.     ngx_uint_t    types_hash_bucket_size;

  447.     ngx_queue_t  *locations;

  449. #if 0
  450.     ngx_http_core_loc_conf_t  *prev_location;
  451. #endif
  452. };


  455. ‌typedef struct {
  456.     ngx_queue_t                      queue;
  457.     ngx_http_core_loc_conf_t        *exact;
  458.     ngx_http_core_loc_conf_t        *inclusive;
  459.     ngx_str_t                       *name;
  460.     u_char                          *file_name;
  461.     ngx_uint_t                       line;
  462.     ngx_queue_t                      list;
  463. ‌} ngx_http_location_queue_t;


  466. ‌struct ngx_http_location_tree_node_s {
  467.     ngx_http_location_tree_node_t   *left;
  468.     ngx_http_location_tree_node_t   *right;
  469.     ngx_http_location_tree_node_t   *tree;

  471.     ngx_http_core_loc_conf_t        *exact;
  472.     ngx_http_core_loc_conf_t        *inclusive;

  474.     u_short                          len;
  475.     u_char                           auto_redirect;
  476.     u_char                           name[1];
  477. };


  480. void ngx_http_core_run_phases(ngx_http_request_t *r);
  481. ngx_int_t ngx_http_core_generic_phase(ngx_http_request_t *r,
  482.     ngx_http_phase_handler_t *ph);
  483. ngx_int_t ngx_http_core_rewrite_phase(ngx_http_request_t *r,
  484.     ngx_http_phase_handler_t *ph);
  485. ngx_int_t ngx_http_core_find_config_phase(ngx_http_request_t *r,
  486.     ngx_http_phase_handler_t *ph);
  487. ngx_int_t ngx_http_core_post_rewrite_phase(ngx_http_request_t *r,
  488.     ngx_http_phase_handler_t *ph);
  489. ngx_int_t ngx_http_core_access_phase(ngx_http_request_t *r,
  490.     ngx_http_phase_handler_t *ph);
  491. ngx_int_t ngx_http_core_post_access_phase(ngx_http_request_t *r,
  492.     ngx_http_phase_handler_t *ph);
  493. ngx_int_t ngx_http_core_content_phase(ngx_http_request_t *r,
  494.     ngx_http_phase_handler_t *ph);


  497. void *ngx_http_test_content_type(ngx_http_request_t *r, ngx_hash_t *types_hash);
  498. ngx_int_t ngx_http_set_content_type(ngx_http_request_t *r);
  499. void ngx_http_set_exten(ngx_http_request_t *r);
  500. ngx_int_t ngx_http_set_etag(ngx_http_request_t *r);
  501. void ngx_http_weak_etag(ngx_http_request_t *r);
  502. ngx_int_t ngx_http_send_response(ngx_http_request_t *r, ngx_uint_t status,
  503.     ngx_str_t *ct, ngx_http_complex_value_t *cv);
  504. u_char *ngx_http_map_uri_to_path(ngx_http_request_t *r, ngx_str_t *name,
  505.     size_t *root_length, size_t reserved);
  506. ngx_int_t ngx_http_auth_basic_user(ngx_http_request_t *r);
  507. #if (NGX_HTTP_GZIP)
  508. ngx_int_t ngx_http_gzip_ok(ngx_http_request_t *r);
  509. #endif


  512. ngx_int_t ngx_http_subrequest(ngx_http_request_t *r,
  513.     ngx_str_t *uri, ngx_str_t *args, ngx_http_request_t **psr,
  514.     ngx_http_post_subrequest_t *ps, ngx_uint_t flags);
  515. ngx_int_t ngx_http_internal_redirect(ngx_http_request_t *r,
  516.     ngx_str_t *uri, ngx_str_t *args);
  517. ngx_int_t ngx_http_named_location(ngx_http_request_t *r, ngx_str_t *name);


  520. ngx_http_cleanup_t *ngx_http_cleanup_add(ngx_http_request_t *r, size_t size);


  523. ‌typedef ngx_int_t (*ngx_http_output_header_filter_pt)(ngx_http_request_t *r);
  524. ‌typedef ngx_int_t (*ngx_http_output_body_filter_pt)
  525.     (ngx_http_request_t *r, ngx_chain_t *chain);
  526. ‌typedef ngx_int_t (*ngx_http_request_body_filter_pt)
  527.     (ngx_http_request_t *r, ngx_chain_t *chain);


  530. ngx_int_t ngx_http_output_filter(ngx_http_request_t *r, ngx_chain_t *chain);
  531. ngx_int_t ngx_http_write_filter(ngx_http_request_t *r, ngx_chain_t *chain);
  532. ngx_int_t ngx_http_request_body_save_filter(ngx_http_request_t *r,
  533.     ngx_chain_t *chain);


  536. ngx_int_t ngx_http_set_disable_symlinks(ngx_http_request_t *r,
  537.     ngx_http_core_loc_conf_t *clcf, ngx_str_t *path, ngx_open_file_info_t *of);

  539. ngx_int_t ngx_http_get_forwarded_addr(ngx_http_request_t *r, ngx_addr_t *addr,
  540.     ngx_table_elt_t *headers, ngx_str_t *value, ngx_array_t *proxies,
  541.     int recursive);

  543. ngx_int_t ngx_http_link_multi_headers(ngx_http_request_t *r);


  546. extern ngx_module_t  ngx_http_core_module;

  548. extern ngx_uint_t ngx_http_max_module;

  550. extern ngx_str_t  ngx_http_core_get_method;


  553. ‌#define ngx_http_clear_content_length(r)                                      \
  554.                                                                               \
  555.     r->headers_out.content_length_n = -1;                                     \
  556.     if (r->headers_out.content_length) {                                      \
  557.         r->headers_out.content_length->hash = 0;                              \
  558.         r->headers_out.content_length = NULL;                                 \
  559.     }

  561. ‌#define ngx_http_clear_accept_ranges(r)                                       \
  562.                                                                               \
  563.     r->allow_ranges = 0;                                                      \
  564.     if (r->headers_out.accept_ranges) {                                       \
  565.         r->headers_out.accept_ranges->hash = 0;                               \
  566.         r->headers_out.accept_ranges = NULL;                                  \
  567.     }

  569. ‌#define ngx_http_clear_last_modified(r)                                       \
  570.                                                                               \
  571.     r->headers_out.last_modified_time = -1;                                   \
  572.     if (r->headers_out.last_modified) {                                       \
  573.         r->headers_out.last_modified->hash = 0;                               \
  574.         r->headers_out.last_modified = NULL;                                  \
  575.     }

  577. ‌#define ngx_http_clear_location(r)                                            \
  578.                                                                               \
  579.     if (r->headers_out.location) {                                            \
  580.         r->headers_out.location->hash = 0;                                    \
  581.         r->headers_out.location = NULL;                                       \
  582.     }

  584. ‌#define ngx_http_clear_etag(r)                                                \
  585.                                                                               \
  586.     if (r->headers_out.etag) {                                                \
  587.         r->headers_out.etag->hash = 0;                                        \
  588.         r->headers_out.etag = NULL;                                           \
  589.     }


  592. #endif /* _NGX_HTTP_CORE_H_INCLUDED_ */

One Level Up Top Level