One Level Up Top Level

src/http/ngx_http_request.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_REQUEST_H_INCLUDED_
  9. ‌#define _NGX_HTTP_REQUEST_H_INCLUDED_


  12. ‌#define NGX_HTTP_MAX_URI_CHANGES           10
  13. ‌#define NGX_HTTP_MAX_SUBREQUESTS           50

  15. /* must be 2^n */
  16. ‌#define NGX_HTTP_LC_HEADER_LEN             32


  19. ‌#define NGX_HTTP_DISCARD_BUFFER_SIZE       4096
  20. ‌#define NGX_HTTP_LINGERING_BUFFER_SIZE     4096


  23. ‌#define NGX_HTTP_VERSION_9                 9
  24. ‌#define NGX_HTTP_VERSION_10                1000
  25. ‌#define NGX_HTTP_VERSION_11                1001
  26. ‌#define NGX_HTTP_VERSION_20                2000
  27. ‌#define NGX_HTTP_VERSION_30                3000

  29. ‌#define NGX_HTTP_UNKNOWN                   0x00000001
  30. ‌#define NGX_HTTP_GET                       0x00000002
  31. ‌#define NGX_HTTP_HEAD                      0x00000004
  32. ‌#define NGX_HTTP_POST                      0x00000008
  33. ‌#define NGX_HTTP_PUT                       0x00000010
  34. ‌#define NGX_HTTP_DELETE                    0x00000020
  35. ‌#define NGX_HTTP_MKCOL                     0x00000040
  36. ‌#define NGX_HTTP_COPY                      0x00000080
  37. ‌#define NGX_HTTP_MOVE                      0x00000100
  38. ‌#define NGX_HTTP_OPTIONS                   0x00000200
  39. ‌#define NGX_HTTP_PROPFIND                  0x00000400
  40. ‌#define NGX_HTTP_PROPPATCH                 0x00000800
  41. ‌#define NGX_HTTP_LOCK                      0x00001000
  42. ‌#define NGX_HTTP_UNLOCK                    0x00002000
  43. ‌#define NGX_HTTP_PATCH                     0x00004000
  44. ‌#define NGX_HTTP_TRACE                     0x00008000
  45. ‌#define NGX_HTTP_CONNECT                   0x00010000

  47. ‌#define NGX_HTTP_CONNECTION_CLOSE          1
  48. ‌#define NGX_HTTP_CONNECTION_KEEP_ALIVE     2


  51. ‌#define NGX_NONE                           1


  54. ‌#define NGX_HTTP_PARSE_HEADER_DONE         1

  56. ‌#define NGX_HTTP_CLIENT_ERROR              10
  57. ‌#define NGX_HTTP_PARSE_INVALID_METHOD      10
  58. ‌#define NGX_HTTP_PARSE_INVALID_REQUEST     11
  59. ‌#define NGX_HTTP_PARSE_INVALID_VERSION     12
  60. ‌#define NGX_HTTP_PARSE_INVALID_09_METHOD   13

  62. ‌#define NGX_HTTP_PARSE_INVALID_HEADER      14


  65. /* unused                                  1 */
  66. ‌#define NGX_HTTP_SUBREQUEST_IN_MEMORY      2
  67. ‌#define NGX_HTTP_SUBREQUEST_WAITED         4
  68. ‌#define NGX_HTTP_SUBREQUEST_CLONE          8
  69. ‌#define NGX_HTTP_SUBREQUEST_BACKGROUND     16

  71. ‌#define NGX_HTTP_LOG_UNSAFE                1


  74. ‌#define NGX_HTTP_CONTINUE                  100
  75. ‌#define NGX_HTTP_SWITCHING_PROTOCOLS       101
  76. ‌#define NGX_HTTP_PROCESSING                102

  78. ‌#define NGX_HTTP_OK                        200
  79. ‌#define NGX_HTTP_CREATED                   201
  80. ‌#define NGX_HTTP_ACCEPTED                  202
  81. ‌#define NGX_HTTP_NO_CONTENT                204
  82. ‌#define NGX_HTTP_PARTIAL_CONTENT           206

  84. ‌#define NGX_HTTP_SPECIAL_RESPONSE          300
  85. ‌#define NGX_HTTP_MOVED_PERMANENTLY         301
  86. ‌#define NGX_HTTP_MOVED_TEMPORARILY         302
  87. ‌#define NGX_HTTP_SEE_OTHER                 303
  88. ‌#define NGX_HTTP_NOT_MODIFIED              304
  89. ‌#define NGX_HTTP_TEMPORARY_REDIRECT        307
  90. ‌#define NGX_HTTP_PERMANENT_REDIRECT        308

  92. ‌#define NGX_HTTP_BAD_REQUEST               400
  93. ‌#define NGX_HTTP_UNAUTHORIZED              401
  94. ‌#define NGX_HTTP_FORBIDDEN                 403
  95. ‌#define NGX_HTTP_NOT_FOUND                 404
  96. ‌#define NGX_HTTP_NOT_ALLOWED               405
  97. ‌#define NGX_HTTP_REQUEST_TIME_OUT          408
  98. ‌#define NGX_HTTP_CONFLICT                  409
  99. ‌#define NGX_HTTP_LENGTH_REQUIRED           411
  100. ‌#define NGX_HTTP_PRECONDITION_FAILED       412
  101. ‌#define NGX_HTTP_REQUEST_ENTITY_TOO_LARGE  413
  102. ‌#define NGX_HTTP_REQUEST_URI_TOO_LARGE     414
  103. ‌#define NGX_HTTP_UNSUPPORTED_MEDIA_TYPE    415
  104. ‌#define NGX_HTTP_RANGE_NOT_SATISFIABLE     416
  105. ‌#define NGX_HTTP_MISDIRECTED_REQUEST       421
  106. ‌#define NGX_HTTP_TOO_MANY_REQUESTS         429


  109. /* Our own HTTP codes */

  111. /* The special code to close connection without any response */
  112. ‌#define NGX_HTTP_CLOSE                     444

  114. ‌#define NGX_HTTP_NGINX_CODES               494

  116. ‌#define NGX_HTTP_REQUEST_HEADER_TOO_LARGE  494

  118. ‌#define NGX_HTTPS_CERT_ERROR               495
  119. ‌#define NGX_HTTPS_NO_CERT                  496

  121. /*
  122. * We use the special code for the plain HTTP requests that are sent to
  123. * HTTPS port to distinguish it from 4XX in an error page redirection
  124. */
  125. ‌#define NGX_HTTP_TO_HTTPS                  497

  127. /* 498 is the canceled code for the requests with invalid host name */

  129. /*
  130. * HTTP does not define the code for the case when a client closed
  131. * the connection while we are processing its request so we introduce
  132. * own code to log such situation when a client has closed the connection
  133. * before we even try to send the HTTP header to it
  134. */
  135. ‌#define NGX_HTTP_CLIENT_CLOSED_REQUEST     499


  138. ‌#define NGX_HTTP_INTERNAL_SERVER_ERROR     500
  139. ‌#define NGX_HTTP_NOT_IMPLEMENTED           501
  140. ‌#define NGX_HTTP_BAD_GATEWAY               502
  141. ‌#define NGX_HTTP_SERVICE_UNAVAILABLE       503
  142. ‌#define NGX_HTTP_GATEWAY_TIME_OUT          504
  143. ‌#define NGX_HTTP_VERSION_NOT_SUPPORTED     505
  144. ‌#define NGX_HTTP_INSUFFICIENT_STORAGE      507


  147. ‌#define NGX_HTTP_LOWLEVEL_BUFFERED         0xf0
  148. ‌#define NGX_HTTP_WRITE_BUFFERED            0x10
  149. ‌#define NGX_HTTP_GZIP_BUFFERED             0x20
  150. ‌#define NGX_HTTP_SSI_BUFFERED              0x01
  151. ‌#define NGX_HTTP_SUB_BUFFERED              0x02
  152. ‌#define NGX_HTTP_COPY_BUFFERED             0x04


  155. ‌typedef enum {
  156.     NGX_HTTP_INITING_REQUEST_STATE = 0,
  157.     NGX_HTTP_READING_REQUEST_STATE,
  158.     NGX_HTTP_PROCESS_REQUEST_STATE,

  160.     NGX_HTTP_CONNECT_UPSTREAM_STATE,
  161.     NGX_HTTP_WRITING_UPSTREAM_STATE,
  162.     NGX_HTTP_READING_UPSTREAM_STATE,

  164.     NGX_HTTP_WRITING_REQUEST_STATE,
  165.     NGX_HTTP_LINGERING_CLOSE_STATE,
  166.     NGX_HTTP_KEEPALIVE_STATE
  167. ‌} ngx_http_state_e;


  170. ‌typedef struct {
  171.     ngx_str_t                         name;
  172.     ngx_uint_t                        offset;
  173.     ngx_http_header_handler_pt        handler;
  174. ‌} ngx_http_header_t;


  177. ‌typedef struct {
  178.     ngx_str_t                         name;
  179.     ngx_uint_t                        offset;
  180. ‌} ngx_http_header_out_t;


  183. ‌typedef struct {
  184.     ngx_list_t                        headers;

  186.     ngx_table_elt_t                  *host;
  187.     ngx_table_elt_t                  *connection;
  188.     ngx_table_elt_t                  *if_modified_since;
  189.     ngx_table_elt_t                  *if_unmodified_since;
  190.     ngx_table_elt_t                  *if_match;
  191.     ngx_table_elt_t                  *if_none_match;
  192.     ngx_table_elt_t                  *user_agent;
  193.     ngx_table_elt_t                  *referer;
  194.     ngx_table_elt_t                  *content_length;
  195.     ngx_table_elt_t                  *content_range;
  196.     ngx_table_elt_t                  *content_type;

  198.     ngx_table_elt_t                  *range;
  199.     ngx_table_elt_t                  *if_range;

  201.     ngx_table_elt_t                  *transfer_encoding;
  202.     ngx_table_elt_t                  *te;
  203.     ngx_table_elt_t                  *expect;
  204.     ngx_table_elt_t                  *upgrade;

  206. #if (NGX_HTTP_GZIP || NGX_HTTP_HEADERS)
  207.     ngx_table_elt_t                  *accept_encoding;
  208.     ngx_table_elt_t                  *via;
  209. #endif

  211.     ngx_table_elt_t                  *authorization;

  213.     ngx_table_elt_t                  *keep_alive;

  215. #if (NGX_HTTP_X_FORWARDED_FOR)
  216.     ngx_table_elt_t                  *x_forwarded_for;
  217. #endif

  219. #if (NGX_HTTP_REALIP)
  220.     ngx_table_elt_t                  *x_real_ip;
  221. #endif

  223. #if (NGX_HTTP_HEADERS)
  224.     ngx_table_elt_t                  *accept;
  225.     ngx_table_elt_t                  *accept_language;
  226. #endif

  228. #if (NGX_HTTP_DAV)
  229.     ngx_table_elt_t                  *depth;
  230.     ngx_table_elt_t                  *destination;
  231.     ngx_table_elt_t                  *overwrite;
  232.     ngx_table_elt_t                  *date;
  233. #endif

  235.     ngx_table_elt_t                  *cookie;

  237.     ngx_str_t                         user;
  238.     ngx_str_t                         passwd;

  240.     ngx_str_t                         server;
  241.     off_t                             content_length_n;
  242.     time_t                            keep_alive_n;

  244.     unsigned                          connection_type:2;
  245.     unsigned                          chunked:1;
  246.     unsigned                          multi:1;
  247.     unsigned                          multi_linked:1;
  248.     unsigned                          msie:1;
  249.     unsigned                          msie6:1;
  250.     unsigned                          opera:1;
  251.     unsigned                          gecko:1;
  252.     unsigned                          chrome:1;
  253.     unsigned                          safari:1;
  254.     unsigned                          konqueror:1;
  255. ‌} ngx_http_headers_in_t;


  258. ‌typedef struct {
  259.     ngx_list_t                        headers;
  260.     ngx_list_t                        trailers;

  262.     ngx_uint_t                        status;
  263.     ngx_str_t                         status_line;

  265.     ngx_table_elt_t                  *server;
  266.     ngx_table_elt_t                  *date;
  267.     ngx_table_elt_t                  *content_length;
  268.     ngx_table_elt_t                  *content_encoding;
  269.     ngx_table_elt_t                  *location;
  270.     ngx_table_elt_t                  *refresh;
  271.     ngx_table_elt_t                  *last_modified;
  272.     ngx_table_elt_t                  *content_range;
  273.     ngx_table_elt_t                  *accept_ranges;
  274.     ngx_table_elt_t                  *www_authenticate;
  275.     ngx_table_elt_t                  *expires;
  276.     ngx_table_elt_t                  *etag;

  278.     ngx_table_elt_t                  *cache_control;
  279.     ngx_table_elt_t                  *link;

  281.     ngx_str_t                        *override_charset;

  283.     size_t                            content_type_len;
  284.     ngx_str_t                         content_type;
  285.     ngx_str_t                         charset;
  286.     u_char                           *content_type_lowcase;
  287.     ngx_uint_t                        content_type_hash;

  289.     off_t                             content_length_n;
  290.     off_t                             content_offset;
  291.     time_t                            date_time;
  292.     time_t                            last_modified_time;
  293. ‌} ngx_http_headers_out_t;


  296. ‌typedef void (*ngx_http_client_body_handler_pt)(ngx_http_request_t *r);

  298. ‌typedef struct {
  299.     ngx_temp_file_t                  *temp_file;
  300.     ngx_chain_t                      *bufs;
  301.     ngx_buf_t                        *buf;
  302.     off_t                             rest;
  303.     off_t                             received;
  304.     ngx_chain_t                      *free;
  305.     ngx_chain_t                      *busy;
  306.     ngx_http_chunked_t               *chunked;
  307.     ngx_http_client_body_handler_pt   post_handler;
  308.     unsigned                          filter_need_buffering:1;
  309.     unsigned                          last_sent:1;
  310.     unsigned                          last_saved:1;
  311. ‌} ngx_http_request_body_t;


  314. ‌typedef struct ngx_http_addr_conf_s  ngx_http_addr_conf_t;

  316. ‌typedef struct {
  317.     ngx_http_addr_conf_t             *addr_conf;
  318.     ngx_http_conf_ctx_t              *conf_ctx;

  320. #if (NGX_HTTP_SSL || NGX_COMPAT)
  321.     ngx_str_t                        *ssl_servername;
  322. #if (NGX_PCRE)
  323.     ngx_http_regex_t                 *ssl_servername_regex;
  324. #endif
  325. #endif

  327.     ngx_chain_t                      *busy;
  328.     ngx_int_t                         nbusy;

  330.     ngx_chain_t                      *free;

  332.     unsigned                          ssl:1;
  333.     unsigned                          proxy_protocol:1;
  334. ‌} ngx_http_connection_t;


  337. ‌typedef void (*ngx_http_cleanup_pt)(void *data);

  339. ‌typedef struct ngx_http_cleanup_s  ngx_http_cleanup_t;

  341. ‌struct ngx_http_cleanup_s {
  342.     ngx_http_cleanup_pt               handler;
  343.     void                             *data;
  344.     ngx_http_cleanup_t               *next;
  345. };


  348. ‌typedef ngx_int_t (*ngx_http_post_subrequest_pt)(ngx_http_request_t *r,
  349.     void *data, ngx_int_t rc);

  351. ‌typedef struct {
  352.     ngx_http_post_subrequest_pt       handler;
  353.     void                             *data;
  354. ‌} ngx_http_post_subrequest_t;


  357. ‌typedef struct ngx_http_postponed_request_s  ngx_http_postponed_request_t;

  359. ‌struct ngx_http_postponed_request_s {
  360.     ngx_http_request_t               *request;
  361.     ngx_chain_t                      *out;
  362.     ngx_http_postponed_request_t     *next;
  363. };


  366. ‌typedef struct ngx_http_posted_request_s  ngx_http_posted_request_t;

  368. ‌struct ngx_http_posted_request_s {
  369.     ngx_http_request_t               *request;
  370.     ngx_http_posted_request_t        *next;
  371. };


  374. ‌typedef ngx_int_t (*ngx_http_handler_pt)(ngx_http_request_t *r);
  375. ‌typedef void (*ngx_http_event_handler_pt)(ngx_http_request_t *r);


  378. ‌struct ngx_http_request_s {
  379.     uint32_t                          signature;         /* "HTTP" */

  381.     ngx_connection_t                 *connection;

  383.     void                            **ctx;
  384.     void                            **main_conf;
  385.     void                            **srv_conf;
  386.     void                            **loc_conf;

  388.     ngx_http_event_handler_pt         read_event_handler;
  389.     ngx_http_event_handler_pt         write_event_handler;

  391. #if (NGX_HTTP_CACHE)
  392.     ngx_http_cache_t                 *cache;
  393. #endif

  395.     ngx_http_upstream_t              *upstream;
  396.     ngx_array_t                      *upstream_states;
  397.                                          /* of ngx_http_upstream_state_t */

  399.     ngx_pool_t                       *pool;
  400.     ngx_buf_t                        *header_in;

  402.     ngx_http_headers_in_t             headers_in;
  403.     ngx_http_headers_out_t            headers_out;

  405.     ngx_http_request_body_t          *request_body;

  407.     time_t                            lingering_time;
  408.     time_t                            start_sec;
  409.     ngx_msec_t                        start_msec;

  411.     ngx_uint_t                        method;
  412.     ngx_uint_t                        http_version;

  414.     ngx_str_t                         request_line;
  415.     ngx_str_t                         uri;
  416.     ngx_str_t                         args;
  417.     ngx_str_t                         exten;
  418.     ngx_str_t                         unparsed_uri;

  420.     ngx_str_t                         method_name;
  421.     ngx_str_t                         http_protocol;
  422.     ngx_str_t                         schema;

  424.     ngx_chain_t                      *out;
  425.     ngx_http_request_t               *main;
  426.     ngx_http_request_t               *parent;
  427.     ngx_http_postponed_request_t     *postponed;
  428.     ngx_http_post_subrequest_t       *post_subrequest;
  429.     ngx_http_posted_request_t        *posted_requests;

  431.     ngx_int_t                         phase_handler;
  432.     ngx_http_handler_pt               content_handler;
  433.     ngx_uint_t                        access_code;

  435.     ngx_http_variable_value_t        *variables;

  437. #if (NGX_PCRE)
  438.     ngx_uint_t                        ncaptures;
  439.     int                              *captures;
  440.     u_char                           *captures_data;
  441. #endif

  443.     size_t                            limit_rate;
  444.     size_t                            limit_rate_after;

  446.     /* used to learn the Apache compatible response length without a header */
  447.     size_t                            header_size;

  449.     off_t                             request_length;

  451.     ngx_uint_t                        err_status;

  453.     ngx_http_connection_t            *http_connection;
  454.     ngx_http_v2_stream_t             *stream;
  455.     ngx_http_v3_parse_t              *v3_parse;

  457.     ngx_http_log_handler_pt           log_handler;

  459.     ngx_http_cleanup_t               *cleanup;

  461.     unsigned                          count:16;
  462.     unsigned                          subrequests:8;
  463.     unsigned                          blocked:8;

  465.     unsigned                          aio:1;

  467.     unsigned                          http_state:4;

  469.     /* URI with "/." and on Win32 with "//" */
  470.     unsigned                          complex_uri:1;

  472.     /* URI with "%" */
  473.     unsigned                          quoted_uri:1;

  475.     /* URI with "+" */
  476.     unsigned                          plus_in_uri:1;

  478.     /* URI with empty path */
  479.     unsigned                          empty_path_in_uri:1;

  481.     unsigned                          invalid_header:1;

  483.     unsigned                          add_uri_to_alias:1;
  484.     unsigned                          valid_location:1;
  485.     unsigned                          valid_unparsed_uri:1;
  486.     unsigned                          uri_changed:1;
  487.     unsigned                          uri_changes:4;

  489.     unsigned                          request_body_in_single_buf:1;
  490.     unsigned                          request_body_in_file_only:1;
  491.     unsigned                          request_body_in_persistent_file:1;
  492.     unsigned                          request_body_in_clean_file:1;
  493.     unsigned                          request_body_file_group_access:1;
  494.     unsigned                          request_body_file_log_level:3;
  495.     unsigned                          request_body_no_buffering:1;

  497.     unsigned                          subrequest_in_memory:1;
  498.     unsigned                          waited:1;

  500. #if (NGX_HTTP_CACHE)
  501.     unsigned                          cached:1;
  502. #endif

  504. #if (NGX_HTTP_GZIP)
  505.     unsigned                          gzip_tested:1;
  506.     unsigned                          gzip_ok:1;
  507.     unsigned                          gzip_vary:1;
  508. #endif

  510. #if (NGX_PCRE)
  511.     unsigned                          realloc_captures:1;
  512. #endif

  514.     unsigned                          proxy:1;
  515.     unsigned                          bypass_cache:1;
  516.     unsigned                          no_cache:1;

  518.     /*
  519.      * instead of using the request context data in
  520.      * ngx_http_limit_conn_module and ngx_http_limit_req_module
  521.      * we use the bit fields in the request structure
  522.      */
  523.     unsigned                          limit_conn_status:2;
  524.     unsigned                          limit_req_status:3;

  526.     unsigned                          limit_rate_set:1;
  527.     unsigned                          limit_rate_after_set:1;

  529. #if 0
  530.     unsigned                          cacheable:1;
  531. #endif

  533.     unsigned                          pipeline:1;
  534.     unsigned                          chunked:1;
  535.     unsigned                          header_only:1;
  536.     unsigned                          expect_trailers:1;
  537.     unsigned                          keepalive:1;
  538.     unsigned                          lingering_close:1;
  539.     unsigned                          discard_body:1;
  540.     unsigned                          reading_body:1;
  541.     unsigned                          internal:1;
  542.     unsigned                          error_page:1;
  543.     unsigned                          filter_finalize:1;
  544.     unsigned                          post_action:1;
  545.     unsigned                          request_complete:1;
  546.     unsigned                          request_output:1;
  547.     unsigned                          header_sent:1;
  548.     unsigned                          response_sent:1;
  549.     unsigned                          expect_tested:1;
  550.     unsigned                          root_tested:1;
  551.     unsigned                          done:1;
  552.     unsigned                          logged:1;
  553.     unsigned                          terminated:1;

  555.     unsigned                          buffered:4;

  557.     unsigned                          main_filter_need_in_memory:1;
  558.     unsigned                          filter_need_in_memory:1;
  559.     unsigned                          filter_need_temporary:1;
  560.     unsigned                          preserve_body:1;
  561.     unsigned                          allow_ranges:1;
  562.     unsigned                          subrequest_ranges:1;
  563.     unsigned                          single_range:1;
  564.     unsigned                          disable_not_modified:1;
  565.     unsigned                          stat_reading:1;
  566.     unsigned                          stat_writing:1;
  567.     unsigned                          stat_processing:1;

  569.     unsigned                          background:1;
  570.     unsigned                          health_check:1;

  572.     /* used to parse HTTP headers */

  574.     ngx_uint_t                        state;

  576.     ngx_uint_t                        header_hash;
  577.     ngx_uint_t                        lowcase_index;
  578.     u_char                            lowcase_header[NGX_HTTP_LC_HEADER_LEN];

  580.     u_char                           *header_name_start;
  581.     u_char                           *header_name_end;
  582.     u_char                           *header_start;
  583.     u_char                           *header_end;

  585.     /*
  586.      * a memory that can be reused after parsing a request line
  587.      * via ngx_http_ephemeral_t
  588.      */

  590.     u_char                           *uri_start;
  591.     u_char                           *uri_end;
  592.     u_char                           *uri_ext;
  593.     u_char                           *args_start;
  594.     u_char                           *request_start;
  595.     u_char                           *request_end;
  596.     u_char                           *method_end;
  597.     u_char                           *schema_start;
  598.     u_char                           *schema_end;
  599.     u_char                           *host_start;
  600.     u_char                           *host_end;

  602.     unsigned                          http_minor:16;
  603.     unsigned                          http_major:16;
  604. };


  607. ‌typedef struct {
  608.     ngx_http_posted_request_t         terminal_posted_request;
  609. ‌} ngx_http_ephemeral_t;


  612. ‌#define ngx_http_ephemeral(r)  (void *) (&r->uri_start)


  615. extern ngx_http_header_t       ngx_http_headers_in[];
  616. extern ngx_http_header_out_t   ngx_http_headers_out[];


  619. ‌#define ngx_http_set_log_request(log, r)                                      \
  620.     ((ngx_http_log_ctx_t *) log->data)->current_request = r


  623. #endif /* _NGX_HTTP_REQUEST_H_INCLUDED_ */

One Level Up Top Level