One Level Up Top Level

src/http/ngx_http_core_module.h - nginx-1.7.10

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>


  17. ‌#define NGX_HTTP_GZIP_PROXIED_OFF       0x0002
  18. ‌#define NGX_HTTP_GZIP_PROXIED_EXPIRED   0x0004
  19. ‌#define NGX_HTTP_GZIP_PROXIED_NO_CACHE  0x0008
  20. ‌#define NGX_HTTP_GZIP_PROXIED_NO_STORE  0x0010
  21. ‌#define NGX_HTTP_GZIP_PROXIED_PRIVATE   0x0020
  22. ‌#define NGX_HTTP_GZIP_PROXIED_NO_LM     0x0040
  23. ‌#define NGX_HTTP_GZIP_PROXIED_NO_ETAG   0x0080
  24. ‌#define NGX_HTTP_GZIP_PROXIED_AUTH      0x0100
  25. ‌#define NGX_HTTP_GZIP_PROXIED_ANY       0x0200


  28. ‌#define NGX_HTTP_AIO_OFF                0
  29. ‌#define NGX_HTTP_AIO_ON                 1
  30. ‌#define NGX_HTTP_AIO_SENDFILE           2


  33. ‌#define NGX_HTTP_SATISFY_ALL            0
  34. ‌#define NGX_HTTP_SATISFY_ANY            1


  37. ‌#define NGX_HTTP_LINGERING_OFF          0
  38. ‌#define NGX_HTTP_LINGERING_ON           1
  39. ‌#define NGX_HTTP_LINGERING_ALWAYS       2


  42. ‌#define NGX_HTTP_IMS_OFF                0
  43. ‌#define NGX_HTTP_IMS_EXACT              1
  44. ‌#define NGX_HTTP_IMS_BEFORE             2


  47. ‌#define NGX_HTTP_KEEPALIVE_DISABLE_NONE    0x0002
  48. ‌#define NGX_HTTP_KEEPALIVE_DISABLE_MSIE6   0x0004
  49. ‌#define NGX_HTTP_KEEPALIVE_DISABLE_SAFARI  0x0008


  52. ‌typedef struct ngx_http_location_tree_node_s  ngx_http_location_tree_node_t;
  53. ‌typedef struct ngx_http_core_loc_conf_s  ngx_http_core_loc_conf_t;


  56. typedef struct {
  57.     union {
  58.         struct sockaddr        sockaddr;
  59.         struct sockaddr_in     sockaddr_in;
  60. #if (NGX_HAVE_INET6)
  61.         struct sockaddr_in6    sockaddr_in6;
  62. #endif
  63. #if (NGX_HAVE_UNIX_DOMAIN)
  64.         struct sockaddr_un     sockaddr_un;
  65. #endif
  66.         u_char                 sockaddr_data[NGX_SOCKADDRLEN];
  67.     } u;

  69.     socklen_t                  socklen;

  71.     unsigned                   set:1;
  72.     unsigned                   default_server:1;
  73.     unsigned                   bind:1;
  74.     unsigned                   wildcard:1;
  75. #if (NGX_HTTP_SSL)
  76.     unsigned                   ssl:1;
  77. #endif
  78. #if (NGX_HTTP_SPDY)
  79.     unsigned                   spdy:1;
  80. #endif
  81. #if (NGX_HAVE_INET6 && defined IPV6_V6ONLY)
  82.     unsigned                   ipv6only:1;
  83. #endif
  84.     unsigned                   so_keepalive:2;
  85.     unsigned                   proxy_protocol:1;

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

  102. #if (NGX_HAVE_DEFERRED_ACCEPT && defined SO_ACCEPTFILTER)
  103.     char                      *accept_filter;
  104. #endif
  105. #if (NGX_HAVE_DEFERRED_ACCEPT && defined TCP_DEFER_ACCEPT)
  106.     ngx_uint_t                 deferred_accept;
  107. #endif

  109.     u_char                     addr[NGX_SOCKADDR_STRLEN + 1];
  110. ‌} ngx_http_listen_opt_t;


  113. typedef enum {
  114.     NGX_HTTP_POST_READ_PHASE = 0,

  116.     NGX_HTTP_SERVER_REWRITE_PHASE,

  118.     NGX_HTTP_FIND_CONFIG_PHASE,
  119.     NGX_HTTP_REWRITE_PHASE,
  120.     NGX_HTTP_POST_REWRITE_PHASE,

  122.     NGX_HTTP_PREACCESS_PHASE,

  124.     NGX_HTTP_ACCESS_PHASE,
  125.     NGX_HTTP_POST_ACCESS_PHASE,

  127.     NGX_HTTP_TRY_FILES_PHASE,
  128.     NGX_HTTP_CONTENT_PHASE,

  130.     NGX_HTTP_LOG_PHASE
  131. ‌} ngx_http_phases;

  133. ‌typedef struct ngx_http_phase_handler_s  ngx_http_phase_handler_t;

  135. ‌typedef ngx_int_t (*ngx_http_phase_handler_pt)(ngx_http_request_t *r,
  136.     ngx_http_phase_handler_t *ph);

  138. ‌struct ngx_http_phase_handler_s {
  139.     ngx_http_phase_handler_pt  checker;
  140.     ngx_http_handler_pt        handler;
  141.     ngx_uint_t                 next;
  142. };


  145. typedef struct {
  146.     ngx_http_phase_handler_t  *handlers;
  147.     ngx_uint_t                 server_rewrite_index;
  148.     ngx_uint_t                 location_rewrite_index;
  149. ‌} ngx_http_phase_engine_t;


  152. typedef struct {
  153.     ngx_array_t                handlers;
  154. ‌} ngx_http_phase_t;


  157. typedef struct {
  158.     ngx_array_t                servers;         /* ngx_http_core_srv_conf_t */

  160.     ngx_http_phase_engine_t    phase_engine;

  162.     ngx_hash_t                 headers_in_hash;

  164.     ngx_hash_t                 variables_hash;

  166.     ngx_array_t                variables;       /* ngx_http_variable_t */
  167.     ngx_uint_t                 ncaptures;

  169.     ngx_uint_t                 server_names_hash_max_size;
  170.     ngx_uint_t                 server_names_hash_bucket_size;

  172.     ngx_uint_t                 variables_hash_max_size;
  173.     ngx_uint_t                 variables_hash_bucket_size;

  175.     ngx_hash_keys_arrays_t    *variables_keys;

  177.     ngx_array_t               *ports;

  179.     ngx_uint_t                 try_files;       /* unsigned  try_files:1 */

  181.     ngx_http_phase_t           phases[NGX_HTTP_LOG_PHASE + 1];
  182. ‌} ngx_http_core_main_conf_t;


  185. typedef struct {
  186.     /* array of the ngx_http_server_name_t, "server_name" directive */
  187.     ngx_array_t                 server_names;

  189.     /* server ctx */
  190.     ngx_http_conf_ctx_t        *ctx;

  192.     ngx_str_t                   server_name;

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

  198.     ngx_bufs_t                  large_client_header_buffers;

  200.     ngx_msec_t                  client_header_timeout;

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

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

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


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


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


  227. typedef struct {
  228.      ngx_hash_combined_t       names;

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


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

  239.     ngx_http_virtual_names_t  *virtual_names;

  241. #if (NGX_HTTP_SSL)
  242.     unsigned                   ssl:1;
  243. #endif
  244. #if (NGX_HTTP_SPDY)
  245.     unsigned                   spdy:1;
  246. #endif
  247.     unsigned                   proxy_protocol:1;
  248. };


  251. typedef struct {
  252.     in_addr_t                  addr;
  253.     ngx_http_addr_conf_t       conf;
  254. ‌} ngx_http_in_addr_t;


  257. #if (NGX_HAVE_INET6)

  259. typedef struct {
  260.     struct in6_addr            addr6;
  261.     ngx_http_addr_conf_t       conf;
  262. ‌} ngx_http_in6_addr_t;

  264. #endif


  267. typedef struct {
  268.     /* ngx_http_in_addr_t or ngx_http_in6_addr_t */
  269.     void                      *addrs;
  270.     ngx_uint_t                 naddrs;
  271. ‌} ngx_http_port_t;


  274. typedef struct {
  275.     ngx_int_t                  family;
  276.     in_port_t                  port;
  277.     ngx_array_t                addrs;     /* array of ngx_http_conf_addr_t */
  278. ‌} ngx_http_conf_port_t;


  281. typedef struct {
  282.     ngx_http_listen_opt_t      opt;

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

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

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


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


  307. typedef struct {
  308.     ngx_array_t               *lengths;
  309.     ngx_array_t               *values;
  310.     ngx_str_t                  name;

  312.     unsigned                   code:10;
  313.     unsigned                   test_dir:1;
  314. ‌} ngx_http_try_file_t;


  317. ‌struct ngx_http_core_loc_conf_s {
  318.     ngx_str_t     name;          /* location name */

  320. #if (NGX_PCRE)
  321.     ngx_http_regex_t  *regex;
  322. #endif

  324.     unsigned      noname:1;   /* "if () {}" block or limit_except */
  325.     unsigned      lmt_excpt:1;
  326.     unsigned      named:1;

  328.     unsigned      exact_match:1;
  329.     unsigned      noregex:1;

  331.     unsigned      auto_redirect:1;
  332. #if (NGX_HTTP_GZIP)
  333.     unsigned      gzip_disable_msie6:2;
  334. #if (NGX_HTTP_DEGRADATION)
  335.     unsigned      gzip_disable_degradation:2;
  336. #endif
  337. #endif

  339.     ngx_http_location_tree_node_t   *static_locations;
  340. #if (NGX_PCRE)
  341.     ngx_http_core_loc_conf_t       **regex_locations;
  342. #endif

  344.     /* pointer to the modules' loc_conf */
  345.     void        **loc_conf;

  347.     uint32_t      limit_except;
  348.     void        **limit_except_loc_conf;

  350.     ngx_http_handler_pt  handler;

  352.     /* location name length for inclusive location with inherited alias */
  353.     size_t        alias;
  354.     ngx_str_t     root;                    /* root, alias */
  355.     ngx_str_t     post_action;

  357.     ngx_array_t  *root_lengths;
  358.     ngx_array_t  *root_values;

  360.     ngx_array_t  *types;
  361.     ngx_hash_t    types_hash;
  362.     ngx_str_t     default_type;

  364.     off_t         client_max_body_size;    /* client_max_body_size */
  365.     off_t         directio;                /* directio */
  366.     off_t         directio_alignment;      /* directio_alignment */

  368.     size_t        client_body_buffer_size; /* client_body_buffer_size */
  369.     size_t        send_lowat;              /* send_lowat */
  370.     size_t        postpone_output;         /* postpone_output */
  371.     size_t        limit_rate;              /* limit_rate */
  372.     size_t        limit_rate_after;        /* limit_rate_after */
  373.     size_t        sendfile_max_chunk;      /* sendfile_max_chunk */
  374.     size_t        read_ahead;              /* read_ahead */

  376.     ngx_msec_t    client_body_timeout;     /* client_body_timeout */
  377.     ngx_msec_t    send_timeout;            /* send_timeout */
  378.     ngx_msec_t    keepalive_timeout;       /* keepalive_timeout */
  379.     ngx_msec_t    lingering_time;          /* lingering_time */
  380.     ngx_msec_t    lingering_timeout;       /* lingering_timeout */
  381.     ngx_msec_t    resolver_timeout;        /* resolver_timeout */

  383.     ngx_resolver_t  *resolver;             /* resolver */

  385.     time_t        keepalive_header;        /* keepalive_timeout */

  387.     ngx_uint_t    keepalive_requests;      /* keepalive_requests */
  388.     ngx_uint_t    keepalive_disable;       /* keepalive_disable */
  389.     ngx_uint_t    satisfy;                 /* satisfy */
  390.     ngx_uint_t    lingering_close;         /* lingering_close */
  391.     ngx_uint_t    if_modified_since;       /* if_modified_since */
  392.     ngx_uint_t    max_ranges;              /* max_ranges */
  393.     ngx_uint_t    client_body_in_file_only; /* client_body_in_file_only */

  395.     ngx_flag_t    client_body_in_single_buffer;
  396.                                            /* client_body_in_singe_buffer */
  397.     ngx_flag_t    internal;                /* internal */
  398.     ngx_flag_t    sendfile;                /* sendfile */
  399. #if (NGX_HAVE_FILE_AIO)
  400.     ngx_flag_t    aio;                     /* aio */
  401. #endif
  402.     ngx_flag_t    tcp_nopush;              /* tcp_nopush */
  403.     ngx_flag_t    tcp_nodelay;             /* tcp_nodelay */
  404.     ngx_flag_t    reset_timedout_connection; /* reset_timedout_connection */
  405.     ngx_flag_t    server_name_in_redirect; /* server_name_in_redirect */
  406.     ngx_flag_t    port_in_redirect;        /* port_in_redirect */
  407.     ngx_flag_t    msie_padding;            /* msie_padding */
  408.     ngx_flag_t    msie_refresh;            /* msie_refresh */
  409.     ngx_flag_t    log_not_found;           /* log_not_found */
  410.     ngx_flag_t    log_subrequest;          /* log_subrequest */
  411.     ngx_flag_t    recursive_error_pages;   /* recursive_error_pages */
  412.     ngx_flag_t    server_tokens;           /* server_tokens */
  413.     ngx_flag_t    chunked_transfer_encoding; /* chunked_transfer_encoding */
  414.     ngx_flag_t    etag;                    /* etag */

  416. #if (NGX_HTTP_GZIP)
  417.     ngx_flag_t    gzip_vary;               /* gzip_vary */

  419.     ngx_uint_t    gzip_http_version;       /* gzip_http_version */
  420.     ngx_uint_t    gzip_proxied;            /* gzip_proxied */

  422. #if (NGX_PCRE)
  423.     ngx_array_t  *gzip_disable;            /* gzip_disable */
  424. #endif
  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 */
  433.     ngx_http_try_file_t    *try_files;     /* try_files */

  435.     ngx_path_t   *client_body_temp_path;   /* client_body_temp_path */

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

  443.     ngx_log_t    *error_log;

  445.     ngx_uint_t    types_hash_max_size;
  446.     ngx_uint_t    types_hash_bucket_size;

  448.     ngx_queue_t  *locations;

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


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


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

  472.     ngx_http_core_loc_conf_t        *exact;
  473.     ngx_http_core_loc_conf_t        *inclusive;

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


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


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


  515. ngx_int_t ngx_http_subrequest(ngx_http_request_t *r,
  516.     ngx_str_t *uri, ngx_str_t *args, ngx_http_request_t **sr,
  517.     ngx_http_post_subrequest_t *psr, ngx_uint_t flags);
  518. ngx_int_t ngx_http_internal_redirect(ngx_http_request_t *r,
  519.     ngx_str_t *uri, ngx_str_t *args);
  520. ngx_int_t ngx_http_named_location(ngx_http_request_t *r, ngx_str_t *name);


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


  526. ‌typedef ngx_int_t (*ngx_http_output_header_filter_pt)(ngx_http_request_t *r);
  527. ‌typedef ngx_int_t (*ngx_http_output_body_filter_pt)
  528.     (ngx_http_request_t *r, ngx_chain_t *chain);


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


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

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


  543. extern ngx_module_t  ngx_http_core_module;

  545. extern ngx_uint_t ngx_http_max_module;

  547. extern ngx_str_t  ngx_http_core_get_method;


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

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

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

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

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


  589. #endif /* _NGX_HTTP_CORE_H_INCLUDED_ */

One Level Up Top Level