One Level Up Top Level

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


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

  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

  27. ‌#define NGX_HTTP_UNKNOWN                   0x0001
  28. ‌#define NGX_HTTP_GET                       0x0002
  29. ‌#define NGX_HTTP_HEAD                      0x0004
  30. ‌#define NGX_HTTP_POST                      0x0008
  31. ‌#define NGX_HTTP_PUT                       0x0010
  32. ‌#define NGX_HTTP_DELETE                    0x0020
  33. ‌#define NGX_HTTP_MKCOL                     0x0040
  34. ‌#define NGX_HTTP_COPY                      0x0080
  35. ‌#define NGX_HTTP_MOVE                      0x0100
  36. ‌#define NGX_HTTP_OPTIONS                   0x0200
  37. ‌#define NGX_HTTP_PROPFIND                  0x0400
  38. ‌#define NGX_HTTP_PROPPATCH                 0x0800
  39. ‌#define NGX_HTTP_LOCK                      0x1000
  40. ‌#define NGX_HTTP_UNLOCK                    0x2000
  41. ‌#define NGX_HTTP_PATCH                     0x4000
  42. ‌#define NGX_HTTP_TRACE                     0x8000

  44. ‌#define NGX_HTTP_CONNECTION_CLOSE          1
  45. ‌#define NGX_HTTP_CONNECTION_KEEP_ALIVE     2


  48. ‌#define NGX_NONE                           1


  51. ‌#define NGX_HTTP_PARSE_HEADER_DONE         1

  53. ‌#define NGX_HTTP_CLIENT_ERROR              10
  54. ‌#define NGX_HTTP_PARSE_INVALID_METHOD      10
  55. ‌#define NGX_HTTP_PARSE_INVALID_REQUEST     11
  56. ‌#define NGX_HTTP_PARSE_INVALID_09_METHOD   12

  58. ‌#define NGX_HTTP_PARSE_INVALID_HEADER      13


  61. /* unused                                  1 */
  62. ‌#define NGX_HTTP_SUBREQUEST_IN_MEMORY      2
  63. ‌#define NGX_HTTP_SUBREQUEST_WAITED         4
  64. ‌#define NGX_HTTP_LOG_UNSAFE                8


  67. ‌#define NGX_HTTP_CONTINUE                  100
  68. ‌#define NGX_HTTP_SWITCHING_PROTOCOLS       101
  69. ‌#define NGX_HTTP_PROCESSING                102

  71. ‌#define NGX_HTTP_OK                        200
  72. ‌#define NGX_HTTP_CREATED                   201
  73. ‌#define NGX_HTTP_ACCEPTED                  202
  74. ‌#define NGX_HTTP_NO_CONTENT                204
  75. ‌#define NGX_HTTP_PARTIAL_CONTENT           206

  77. ‌#define NGX_HTTP_SPECIAL_RESPONSE          300
  78. ‌#define NGX_HTTP_MOVED_PERMANENTLY         301
  79. ‌#define NGX_HTTP_MOVED_TEMPORARILY         302
  80. ‌#define NGX_HTTP_SEE_OTHER                 303
  81. ‌#define NGX_HTTP_NOT_MODIFIED              304
  82. ‌#define NGX_HTTP_TEMPORARY_REDIRECT        307

  84. ‌#define NGX_HTTP_BAD_REQUEST               400
  85. ‌#define NGX_HTTP_UNAUTHORIZED              401
  86. ‌#define NGX_HTTP_FORBIDDEN                 403
  87. ‌#define NGX_HTTP_NOT_FOUND                 404
  88. ‌#define NGX_HTTP_NOT_ALLOWED               405
  89. ‌#define NGX_HTTP_REQUEST_TIME_OUT          408
  90. ‌#define NGX_HTTP_CONFLICT                  409
  91. ‌#define NGX_HTTP_LENGTH_REQUIRED           411
  92. ‌#define NGX_HTTP_PRECONDITION_FAILED       412
  93. ‌#define NGX_HTTP_REQUEST_ENTITY_TOO_LARGE  413
  94. ‌#define NGX_HTTP_REQUEST_URI_TOO_LARGE     414
  95. ‌#define NGX_HTTP_UNSUPPORTED_MEDIA_TYPE    415
  96. ‌#define NGX_HTTP_RANGE_NOT_SATISFIABLE     416


  99. /* Our own HTTP codes */

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

  104. ‌#define NGX_HTTP_NGINX_CODES               494

  106. ‌#define NGX_HTTP_REQUEST_HEADER_TOO_LARGE  494

  108. ‌#define NGX_HTTPS_CERT_ERROR               495
  109. ‌#define NGX_HTTPS_NO_CERT                  496

  111. /*
  112. * We use the special code for the plain HTTP requests that are sent to
  113. * HTTPS port to distinguish it from 4XX in an error page redirection
  114. */
  115. ‌#define NGX_HTTP_TO_HTTPS                  497

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

  119. /*
  120. * HTTP does not define the code for the case when a client closed
  121. * the connection while we are processing its request so we introduce
  122. * own code to log such situation when a client has closed the connection
  123. * before we even try to send the HTTP header to it
  124. */
  125. ‌#define NGX_HTTP_CLIENT_CLOSED_REQUEST     499


  128. ‌#define NGX_HTTP_INTERNAL_SERVER_ERROR     500
  129. ‌#define NGX_HTTP_NOT_IMPLEMENTED           501
  130. ‌#define NGX_HTTP_BAD_GATEWAY               502
  131. ‌#define NGX_HTTP_SERVICE_UNAVAILABLE       503
  132. ‌#define NGX_HTTP_GATEWAY_TIME_OUT          504
  133. ‌#define NGX_HTTP_INSUFFICIENT_STORAGE      507


  136. ‌#define NGX_HTTP_LOWLEVEL_BUFFERED         0xf0
  137. ‌#define NGX_HTTP_WRITE_BUFFERED            0x10
  138. ‌#define NGX_HTTP_GZIP_BUFFERED             0x20
  139. ‌#define NGX_HTTP_SSI_BUFFERED              0x01
  140. ‌#define NGX_HTTP_SUB_BUFFERED              0x02
  141. ‌#define NGX_HTTP_COPY_BUFFERED             0x04


  144. typedef enum {
  145.     NGX_HTTP_INITING_REQUEST_STATE = 0,
  146.     NGX_HTTP_READING_REQUEST_STATE,
  147.     NGX_HTTP_PROCESS_REQUEST_STATE,

  149.     NGX_HTTP_CONNECT_UPSTREAM_STATE,
  150.     NGX_HTTP_WRITING_UPSTREAM_STATE,
  151.     NGX_HTTP_READING_UPSTREAM_STATE,

  153.     NGX_HTTP_WRITING_REQUEST_STATE,
  154.     NGX_HTTP_LINGERING_CLOSE_STATE,
  155.     NGX_HTTP_KEEPALIVE_STATE
  156. ‌} ngx_http_state_e;


  159. typedef struct {
  160.     ngx_str_t                         name;
  161.     ngx_uint_t                        offset;
  162.     ngx_http_header_handler_pt        handler;
  163. ‌} ngx_http_header_t;


  166. typedef struct {
  167.     ngx_str_t                         name;
  168.     ngx_uint_t                        offset;
  169. ‌} ngx_http_header_out_t;


  172. typedef struct {
  173.     ngx_list_t                        headers;

  175.     ngx_table_elt_t                  *host;
  176.     ngx_table_elt_t                  *connection;
  177.     ngx_table_elt_t                  *if_modified_since;
  178.     ngx_table_elt_t                  *if_unmodified_since;
  179.     ngx_table_elt_t                  *if_match;
  180.     ngx_table_elt_t                  *if_none_match;
  181.     ngx_table_elt_t                  *user_agent;
  182.     ngx_table_elt_t                  *referer;
  183.     ngx_table_elt_t                  *content_length;
  184.     ngx_table_elt_t                  *content_type;

  186.     ngx_table_elt_t                  *range;
  187.     ngx_table_elt_t                  *if_range;

  189.     ngx_table_elt_t                  *transfer_encoding;
  190.     ngx_table_elt_t                  *expect;
  191.     ngx_table_elt_t                  *upgrade;

  193. #if (NGX_HTTP_GZIP)
  194.     ngx_table_elt_t                  *accept_encoding;
  195.     ngx_table_elt_t                  *via;
  196. #endif

  198.     ngx_table_elt_t                  *authorization;

  200.     ngx_table_elt_t                  *keep_alive;

  202. #if (NGX_HTTP_X_FORWARDED_FOR)
  203.     ngx_array_t                       x_forwarded_for;
  204. #endif

  206. #if (NGX_HTTP_REALIP)
  207.     ngx_table_elt_t                  *x_real_ip;
  208. #endif

  210. #if (NGX_HTTP_HEADERS)
  211.     ngx_table_elt_t                  *accept;
  212.     ngx_table_elt_t                  *accept_language;
  213. #endif

  215. #if (NGX_HTTP_DAV)
  216.     ngx_table_elt_t                  *depth;
  217.     ngx_table_elt_t                  *destination;
  218.     ngx_table_elt_t                  *overwrite;
  219.     ngx_table_elt_t                  *date;
  220. #endif

  222.     ngx_str_t                         user;
  223.     ngx_str_t                         passwd;

  225.     ngx_array_t                       cookies;

  227.     ngx_str_t                         server;
  228.     off_t                             content_length_n;
  229.     time_t                            keep_alive_n;

  231.     unsigned                          connection_type:2;
  232.     unsigned                          chunked:1;
  233.     unsigned                          msie:1;
  234.     unsigned                          msie6:1;
  235.     unsigned                          opera:1;
  236.     unsigned                          gecko:1;
  237.     unsigned                          chrome:1;
  238.     unsigned                          safari:1;
  239.     unsigned                          konqueror:1;
  240. ‌} ngx_http_headers_in_t;


  243. typedef struct {
  244.     ngx_list_t                        headers;

  246.     ngx_uint_t                        status;
  247.     ngx_str_t                         status_line;

  249.     ngx_table_elt_t                  *server;
  250.     ngx_table_elt_t                  *date;
  251.     ngx_table_elt_t                  *content_length;
  252.     ngx_table_elt_t                  *content_encoding;
  253.     ngx_table_elt_t                  *location;
  254.     ngx_table_elt_t                  *refresh;
  255.     ngx_table_elt_t                  *last_modified;
  256.     ngx_table_elt_t                  *content_range;
  257.     ngx_table_elt_t                  *accept_ranges;
  258.     ngx_table_elt_t                  *www_authenticate;
  259.     ngx_table_elt_t                  *expires;
  260.     ngx_table_elt_t                  *etag;

  262.     ngx_str_t                        *override_charset;

  264.     size_t                            content_type_len;
  265.     ngx_str_t                         content_type;
  266.     ngx_str_t                         charset;
  267.     u_char                           *content_type_lowcase;
  268.     ngx_uint_t                        content_type_hash;

  270.     ngx_array_t                       cache_control;

  272.     off_t                             content_length_n;
  273.     time_t                            date_time;
  274.     time_t                            last_modified_time;
  275. ‌} ngx_http_headers_out_t;


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

  280. typedef struct {
  281.     ngx_temp_file_t                  *temp_file;
  282.     ngx_chain_t                      *bufs;
  283.     ngx_buf_t                        *buf;
  284.     off_t                             rest;
  285.     ngx_chain_t                      *free;
  286.     ngx_chain_t                      *busy;
  287.     ngx_http_chunked_t               *chunked;
  288.     ngx_http_client_body_handler_pt   post_handler;
  289. ‌} ngx_http_request_body_t;


  292. ‌typedef struct ngx_http_addr_conf_s  ngx_http_addr_conf_t;

  294. typedef struct {
  295.     ngx_http_addr_conf_t             *addr_conf;
  296.     ngx_http_conf_ctx_t              *conf_ctx;

  298. #if (NGX_HTTP_SSL && defined SSL_CTRL_SET_TLSEXT_HOSTNAME)
  299.     ngx_str_t                        *ssl_servername;
  300. #if (NGX_PCRE)
  301.     ngx_http_regex_t                 *ssl_servername_regex;
  302. #endif
  303. #endif

  305.     ngx_buf_t                       **busy;
  306.     ngx_int_t                         nbusy;

  308.     ngx_buf_t                       **free;
  309.     ngx_int_t                         nfree;

  311. #if (NGX_HTTP_SSL)
  312.     unsigned                          ssl:1;
  313. #endif
  314.     unsigned                          proxy_protocol:1;
  315. ‌} ngx_http_connection_t;


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

  320. ‌typedef struct ngx_http_cleanup_s  ngx_http_cleanup_t;

  322. ‌struct ngx_http_cleanup_s {
  323.     ngx_http_cleanup_pt               handler;
  324.     void                             *data;
  325.     ngx_http_cleanup_t               *next;
  326. };


  329. ‌typedef ngx_int_t (*ngx_http_post_subrequest_pt)(ngx_http_request_t *r,
  330.     void *data, ngx_int_t rc);

  332. typedef struct {
  333.     ngx_http_post_subrequest_pt       handler;
  334.     void                             *data;
  335. ‌} ngx_http_post_subrequest_t;


  338. ‌typedef struct ngx_http_postponed_request_s  ngx_http_postponed_request_t;

  340. ‌struct ngx_http_postponed_request_s {
  341.     ngx_http_request_t               *request;
  342.     ngx_chain_t                      *out;
  343.     ngx_http_postponed_request_t     *next;
  344. };


  347. ‌typedef struct ngx_http_posted_request_s  ngx_http_posted_request_t;

  349. ‌struct ngx_http_posted_request_s {
  350.     ngx_http_request_t               *request;
  351.     ngx_http_posted_request_t        *next;
  352. };


  355. ‌typedef ngx_int_t (*ngx_http_handler_pt)(ngx_http_request_t *r);
  356. ‌typedef void (*ngx_http_event_handler_pt)(ngx_http_request_t *r);


  359. ‌struct ngx_http_request_s {
  360.     uint32_t                          signature;         /* "HTTP" */

  362.     ngx_connection_t                 *connection;

  364.     void                            **ctx;
  365.     void                            **main_conf;
  366.     void                            **srv_conf;
  367.     void                            **loc_conf;

  369.     ngx_http_event_handler_pt         read_event_handler;
  370.     ngx_http_event_handler_pt         write_event_handler;

  372. #if (NGX_HTTP_CACHE)
  373.     ngx_http_cache_t                 *cache;
  374. #endif

  376.     ngx_http_upstream_t              *upstream;
  377.     ngx_array_t                      *upstream_states;
  378.                                          /* of ngx_http_upstream_state_t */

  380.     ngx_pool_t                       *pool;
  381.     ngx_buf_t                        *header_in;

  383.     ngx_http_headers_in_t             headers_in;
  384.     ngx_http_headers_out_t            headers_out;

  386.     ngx_http_request_body_t          *request_body;

  388.     time_t                            lingering_time;
  389.     time_t                            start_sec;
  390.     ngx_msec_t                        start_msec;

  392.     ngx_uint_t                        method;
  393.     ngx_uint_t                        http_version;

  395.     ngx_str_t                         request_line;
  396.     ngx_str_t                         uri;
  397.     ngx_str_t                         args;
  398.     ngx_str_t                         exten;
  399.     ngx_str_t                         unparsed_uri;

  401.     ngx_str_t                         method_name;
  402.     ngx_str_t                         http_protocol;

  404.     ngx_chain_t                      *out;
  405.     ngx_http_request_t               *main;
  406.     ngx_http_request_t               *parent;
  407.     ngx_http_postponed_request_t     *postponed;
  408.     ngx_http_post_subrequest_t       *post_subrequest;
  409.     ngx_http_posted_request_t        *posted_requests;

  411.     ngx_int_t                         phase_handler;
  412.     ngx_http_handler_pt               content_handler;
  413.     ngx_uint_t                        access_code;

  415.     ngx_http_variable_value_t        *variables;

  417. #if (NGX_PCRE)
  418.     ngx_uint_t                        ncaptures;
  419.     int                              *captures;
  420.     u_char                           *captures_data;
  421. #endif

  423.     size_t                            limit_rate;
  424.     size_t                            limit_rate_after;

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

  429.     off_t                             request_length;

  431.     ngx_uint_t                        err_status;

  433.     ngx_http_connection_t            *http_connection;
  434. #if (NGX_HTTP_SPDY)
  435.     ngx_http_spdy_stream_t           *spdy_stream;
  436. #endif

  438.     ngx_http_log_handler_pt           log_handler;

  440.     ngx_http_cleanup_t               *cleanup;

  442.     unsigned                          subrequests:8;
  443.     unsigned                          count:8;
  444.     unsigned                          blocked:8;

  446.     unsigned                          aio:1;

  448.     unsigned                          http_state:4;

  450.     /* URI with "/." and on Win32 with "//" */
  451.     unsigned                          complex_uri:1;

  453.     /* URI with "%" */
  454.     unsigned                          quoted_uri:1;

  456.     /* URI with "+" */
  457.     unsigned                          plus_in_uri:1;

  459.     /* URI with " " */
  460.     unsigned                          space_in_uri:1;

  462.     unsigned                          invalid_header:1;

  464.     unsigned                          add_uri_to_alias:1;
  465.     unsigned                          valid_location:1;
  466.     unsigned                          valid_unparsed_uri:1;
  467.     unsigned                          uri_changed:1;
  468.     unsigned                          uri_changes:4;

  470.     unsigned                          request_body_in_single_buf:1;
  471.     unsigned                          request_body_in_file_only:1;
  472.     unsigned                          request_body_in_persistent_file:1;
  473.     unsigned                          request_body_in_clean_file:1;
  474.     unsigned                          request_body_file_group_access:1;
  475.     unsigned                          request_body_file_log_level:3;

  477.     unsigned                          subrequest_in_memory:1;
  478.     unsigned                          waited:1;

  480. #if (NGX_HTTP_CACHE)
  481.     unsigned                          cached:1;
  482. #endif

  484. #if (NGX_HTTP_GZIP)
  485.     unsigned                          gzip_tested:1;
  486.     unsigned                          gzip_ok:1;
  487.     unsigned                          gzip_vary:1;
  488. #endif

  490.     unsigned                          proxy:1;
  491.     unsigned                          bypass_cache:1;
  492.     unsigned                          no_cache:1;

  494.     /*
  495.      * instead of using the request context data in
  496.      * ngx_http_limit_conn_module and ngx_http_limit_req_module
  497.      * we use the single bits in the request structure
  498.      */
  499.     unsigned                          limit_conn_set:1;
  500.     unsigned                          limit_req_set:1;

  502. #if 0
  503.     unsigned                          cacheable:1;
  504. #endif

  506.     unsigned                          pipeline:1;
  507.     unsigned                          chunked:1;
  508.     unsigned                          header_only:1;
  509.     unsigned                          keepalive:1;
  510.     unsigned                          lingering_close:1;
  511.     unsigned                          discard_body:1;
  512.     unsigned                          internal:1;
  513.     unsigned                          error_page:1;
  514.     unsigned                          filter_finalize:1;
  515.     unsigned                          post_action:1;
  516.     unsigned                          request_complete:1;
  517.     unsigned                          request_output:1;
  518.     unsigned                          header_sent:1;
  519.     unsigned                          expect_tested:1;
  520.     unsigned                          root_tested:1;
  521.     unsigned                          done:1;
  522.     unsigned                          logged:1;

  524.     unsigned                          buffered:4;

  526.     unsigned                          main_filter_need_in_memory:1;
  527.     unsigned                          filter_need_in_memory:1;
  528.     unsigned                          filter_need_temporary:1;
  529.     unsigned                          allow_ranges:1;
  530.     unsigned                          single_range:1;
  531.     unsigned                          disable_not_modified:1;

  533. #if (NGX_STAT_STUB)
  534.     unsigned                          stat_reading:1;
  535.     unsigned                          stat_writing:1;
  536. #endif

  538.     /* used to parse HTTP headers */

  540.     ngx_uint_t                        state;

  542.     ngx_uint_t                        header_hash;
  543.     ngx_uint_t                        lowcase_index;
  544.     u_char                            lowcase_header[NGX_HTTP_LC_HEADER_LEN];

  546.     u_char                           *header_name_start;
  547.     u_char                           *header_name_end;
  548.     u_char                           *header_start;
  549.     u_char                           *header_end;

  551.     /*
  552.      * a memory that can be reused after parsing a request line
  553.      * via ngx_http_ephemeral_t
  554.      */

  556.     u_char                           *uri_start;
  557.     u_char                           *uri_end;
  558.     u_char                           *uri_ext;
  559.     u_char                           *args_start;
  560.     u_char                           *request_start;
  561.     u_char                           *request_end;
  562.     u_char                           *method_end;
  563.     u_char                           *schema_start;
  564.     u_char                           *schema_end;
  565.     u_char                           *host_start;
  566.     u_char                           *host_end;
  567.     u_char                           *port_start;
  568.     u_char                           *port_end;

  570.     unsigned                          http_minor:16;
  571.     unsigned                          http_major:16;
  572. };


  575. typedef struct {
  576.     ngx_http_posted_request_t         terminal_posted_request;
  577. #if (NGX_HAVE_AIO_SENDFILE)
  578.     u_char                            aio_preload;
  579. #endif
  580. ‌} ngx_http_ephemeral_t;


  583. extern ngx_http_header_t       ngx_http_headers_in[];
  584. extern ngx_http_header_out_t   ngx_http_headers_out[];


  587. ‌#define ngx_http_set_connection_log(c, l)                                     \
  588.                                                                               \
  589.     c->log->file = l->file;                                                   \
  590.     c->log->next = l->next;                                                   \
  591.     c->log->writer = l->writer;                                               \
  592.     c->log->wdata = l->wdata;                                                 \
  593.     if (!(c->log->log_level & NGX_LOG_DEBUG_CONNECTION)) {                    \
  594.         c->log->log_level = l->log_level;                                     \
  595.     }


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


  602. #endif /* _NGX_HTTP_REQUEST_H_INCLUDED_ */

One Level Up Top Level