One Level Up Top Level

src/http/ngx_http_upstream.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_UPSTREAM_H_INCLUDED_
  9. ‌#define _NGX_HTTP_UPSTREAM_H_INCLUDED_


  12. #include <ngx_config.h>
  13. #include <ngx_core.h>
  14. #include <ngx_event.h>
  15. #include <ngx_event_connect.h>
  16. #include <ngx_event_pipe.h>
  17. #include <ngx_http.h>


  20. ‌#define NGX_HTTP_UPSTREAM_FT_ERROR           0x00000002
  21. ‌#define NGX_HTTP_UPSTREAM_FT_TIMEOUT         0x00000004
  22. ‌#define NGX_HTTP_UPSTREAM_FT_INVALID_HEADER  0x00000008
  23. ‌#define NGX_HTTP_UPSTREAM_FT_HTTP_500        0x00000010
  24. ‌#define NGX_HTTP_UPSTREAM_FT_HTTP_502        0x00000020
  25. ‌#define NGX_HTTP_UPSTREAM_FT_HTTP_503        0x00000040
  26. ‌#define NGX_HTTP_UPSTREAM_FT_HTTP_504        0x00000080
  27. ‌#define NGX_HTTP_UPSTREAM_FT_HTTP_403        0x00000100
  28. ‌#define NGX_HTTP_UPSTREAM_FT_HTTP_404        0x00000200
  29. ‌#define NGX_HTTP_UPSTREAM_FT_UPDATING        0x00000400
  30. ‌#define NGX_HTTP_UPSTREAM_FT_BUSY_LOCK       0x00000800
  31. ‌#define NGX_HTTP_UPSTREAM_FT_MAX_WAITING     0x00001000
  32. ‌#define NGX_HTTP_UPSTREAM_FT_NOLIVE          0x40000000
  33. ‌#define NGX_HTTP_UPSTREAM_FT_OFF             0x80000000

  35. ‌#define NGX_HTTP_UPSTREAM_FT_STATUS          (NGX_HTTP_UPSTREAM_FT_HTTP_500  \
  36.                                              |NGX_HTTP_UPSTREAM_FT_HTTP_502  \
  37.                                              |NGX_HTTP_UPSTREAM_FT_HTTP_503  \
  38.                                              |NGX_HTTP_UPSTREAM_FT_HTTP_504  \
  39.                                              |NGX_HTTP_UPSTREAM_FT_HTTP_403  \
  40.                                              |NGX_HTTP_UPSTREAM_FT_HTTP_404)

  42. ‌#define NGX_HTTP_UPSTREAM_INVALID_HEADER     40


  45. ‌#define NGX_HTTP_UPSTREAM_IGN_XA_REDIRECT    0x00000002
  46. ‌#define NGX_HTTP_UPSTREAM_IGN_XA_EXPIRES     0x00000004
  47. ‌#define NGX_HTTP_UPSTREAM_IGN_EXPIRES        0x00000008
  48. ‌#define NGX_HTTP_UPSTREAM_IGN_CACHE_CONTROL  0x00000010
  49. ‌#define NGX_HTTP_UPSTREAM_IGN_SET_COOKIE     0x00000020
  50. ‌#define NGX_HTTP_UPSTREAM_IGN_XA_LIMIT_RATE  0x00000040
  51. ‌#define NGX_HTTP_UPSTREAM_IGN_XA_BUFFERING   0x00000080
  52. ‌#define NGX_HTTP_UPSTREAM_IGN_XA_CHARSET     0x00000100
  53. ‌#define NGX_HTTP_UPSTREAM_IGN_VARY           0x00000200


  56. typedef struct {
  57.     ngx_msec_t                       bl_time;
  58.     ngx_uint_t                       bl_state;

  60.     ngx_uint_t                       status;
  61.     time_t                           response_sec;
  62.     ngx_uint_t                       response_msec;
  63.     time_t                           header_sec;
  64.     ngx_uint_t                       header_msec;
  65.     off_t                            response_length;

  67.     ngx_str_t                       *peer;
  68. ‌} ngx_http_upstream_state_t;


  71. typedef struct {
  72.     ngx_hash_t                       headers_in_hash;
  73.     ngx_array_t                      upstreams;
  74.                                              /* ngx_http_upstream_srv_conf_t */
  75. ‌} ngx_http_upstream_main_conf_t;

  77. ‌typedef struct ngx_http_upstream_srv_conf_s  ngx_http_upstream_srv_conf_t;

  79. ‌typedef ngx_int_t (*ngx_http_upstream_init_pt)(ngx_conf_t *cf,
  80.     ngx_http_upstream_srv_conf_t *us);
  81. ‌typedef ngx_int_t (*ngx_http_upstream_init_peer_pt)(ngx_http_request_t *r,
  82.     ngx_http_upstream_srv_conf_t *us);


  85. typedef struct {
  86.     ngx_http_upstream_init_pt        init_upstream;
  87.     ngx_http_upstream_init_peer_pt   init;
  88.     void                            *data;
  89. ‌} ngx_http_upstream_peer_t;


  92. typedef struct {
  93.     ngx_str_t                        name;
  94.     ngx_addr_t                      *addrs;
  95.     ngx_uint_t                       naddrs;
  96.     ngx_uint_t                       weight;
  97.     ngx_uint_t                       max_fails;
  98.     time_t                           fail_timeout;

  100.     unsigned                         down:1;
  101.     unsigned                         backup:1;
  102. ‌} ngx_http_upstream_server_t;


  105. ‌#define NGX_HTTP_UPSTREAM_CREATE        0x0001
  106. ‌#define NGX_HTTP_UPSTREAM_WEIGHT        0x0002
  107. ‌#define NGX_HTTP_UPSTREAM_MAX_FAILS     0x0004
  108. ‌#define NGX_HTTP_UPSTREAM_FAIL_TIMEOUT  0x0008
  109. ‌#define NGX_HTTP_UPSTREAM_DOWN          0x0010
  110. ‌#define NGX_HTTP_UPSTREAM_BACKUP        0x0020


  113. ‌struct ngx_http_upstream_srv_conf_s {
  114.     ngx_http_upstream_peer_t         peer;
  115.     void                           **srv_conf;

  117.     ngx_array_t                     *servers;  /* ngx_http_upstream_server_t */

  119.     ngx_uint_t                       flags;
  120.     ngx_str_t                        host;
  121.     u_char                          *file_name;
  122.     ngx_uint_t                       line;
  123.     in_port_t                        port;
  124.     in_port_t                        default_port;
  125.     ngx_uint_t                       no_port;  /* unsigned no_port:1 */
  126. };


  129. typedef struct {
  130.     ngx_addr_t                      *addr;
  131.     ngx_http_complex_value_t        *value;
  132. ‌} ngx_http_upstream_local_t;


  135. typedef struct {
  136.     ngx_http_upstream_srv_conf_t    *upstream;

  138.     ngx_msec_t                       connect_timeout;
  139.     ngx_msec_t                       send_timeout;
  140.     ngx_msec_t                       read_timeout;
  141.     ngx_msec_t                       timeout;
  142.     ngx_msec_t                       next_upstream_timeout;

  144.     size_t                           send_lowat;
  145.     size_t                           buffer_size;
  146.     size_t                           limit_rate;

  148.     size_t                           busy_buffers_size;
  149.     size_t                           max_temp_file_size;
  150.     size_t                           temp_file_write_size;

  152.     size_t                           busy_buffers_size_conf;
  153.     size_t                           max_temp_file_size_conf;
  154.     size_t                           temp_file_write_size_conf;

  156.     ngx_bufs_t                       bufs;

  158.     ngx_uint_t                       ignore_headers;
  159.     ngx_uint_t                       next_upstream;
  160.     ngx_uint_t                       store_access;
  161.     ngx_uint_t                       next_upstream_tries;
  162.     ngx_flag_t                       buffering;
  163.     ngx_flag_t                       pass_request_headers;
  164.     ngx_flag_t                       pass_request_body;

  166.     ngx_flag_t                       ignore_client_abort;
  167.     ngx_flag_t                       intercept_errors;
  168.     ngx_flag_t                       cyclic_temp_file;
  169.     ngx_flag_t                       force_ranges;

  171.     ngx_path_t                      *temp_path;

  173.     ngx_hash_t                       hide_headers_hash;
  174.     ngx_array_t                     *hide_headers;
  175.     ngx_array_t                     *pass_headers;

  177.     ngx_http_upstream_local_t       *local;

  179. #if (NGX_HTTP_CACHE)
  180.     ngx_shm_zone_t                  *cache_zone;
  181.     ngx_http_complex_value_t        *cache_value;

  183.     ngx_uint_t                       cache_min_uses;
  184.     ngx_uint_t                       cache_use_stale;
  185.     ngx_uint_t                       cache_methods;

  187.     ngx_flag_t                       cache_lock;
  188.     ngx_msec_t                       cache_lock_timeout;
  189.     ngx_msec_t                       cache_lock_age;

  191.     ngx_flag_t                       cache_revalidate;

  193.     ngx_array_t                     *cache_valid;
  194.     ngx_array_t                     *cache_bypass;
  195.     ngx_array_t                     *no_cache;
  196. #endif

  198.     ngx_array_t                     *store_lengths;
  199.     ngx_array_t                     *store_values;

  201. #if (NGX_HTTP_CACHE)
  202.     signed                           cache:2;
  203. #endif
  204.     signed                           store:2;
  205.     unsigned                         intercept_404:1;
  206.     unsigned                         change_buffering:1;

  208. #if (NGX_HTTP_SSL)
  209.     ngx_ssl_t                       *ssl;
  210.     ngx_flag_t                       ssl_session_reuse;

  212.     ngx_http_complex_value_t        *ssl_name;
  213.     ngx_flag_t                       ssl_server_name;
  214.     ngx_flag_t                       ssl_verify;
  215. #endif

  217.     ngx_str_t                        module;
  218. ‌} ngx_http_upstream_conf_t;


  221. typedef struct {
  222.     ngx_str_t                        name;
  223.     ngx_http_header_handler_pt       handler;
  224.     ngx_uint_t                       offset;
  225.     ngx_http_header_handler_pt       copy_handler;
  226.     ngx_uint_t                       conf;
  227.     ngx_uint_t                       redirect;  /* unsigned   redirect:1; */
  228. ‌} ngx_http_upstream_header_t;


  231. typedef struct {
  232.     ngx_list_t                       headers;

  234.     ngx_uint_t                       status_n;
  235.     ngx_str_t                        status_line;

  237.     ngx_table_elt_t                 *status;
  238.     ngx_table_elt_t                 *date;
  239.     ngx_table_elt_t                 *server;
  240.     ngx_table_elt_t                 *connection;

  242.     ngx_table_elt_t                 *expires;
  243.     ngx_table_elt_t                 *etag;
  244.     ngx_table_elt_t                 *x_accel_expires;
  245.     ngx_table_elt_t                 *x_accel_redirect;
  246.     ngx_table_elt_t                 *x_accel_limit_rate;

  248.     ngx_table_elt_t                 *content_type;
  249.     ngx_table_elt_t                 *content_length;

  251.     ngx_table_elt_t                 *last_modified;
  252.     ngx_table_elt_t                 *location;
  253.     ngx_table_elt_t                 *accept_ranges;
  254.     ngx_table_elt_t                 *www_authenticate;
  255.     ngx_table_elt_t                 *transfer_encoding;
  256.     ngx_table_elt_t                 *vary;

  258. #if (NGX_HTTP_GZIP)
  259.     ngx_table_elt_t                 *content_encoding;
  260. #endif

  262.     ngx_array_t                      cache_control;
  263.     ngx_array_t                      cookies;

  265.     off_t                            content_length_n;
  266.     time_t                           last_modified_time;

  268.     unsigned                         connection_close:1;
  269.     unsigned                         chunked:1;
  270. ‌} ngx_http_upstream_headers_in_t;


  273. typedef struct {
  274.     ngx_str_t                        host;
  275.     in_port_t                        port;
  276.     ngx_uint_t                       no_port; /* unsigned no_port:1 */

  278.     ngx_uint_t                       naddrs;
  279.     ngx_addr_t                      *addrs;

  281.     struct sockaddr                 *sockaddr;
  282.     socklen_t                        socklen;

  284.     ngx_resolver_ctx_t              *ctx;
  285. ‌} ngx_http_upstream_resolved_t;


  288. ‌typedef void (*ngx_http_upstream_handler_pt)(ngx_http_request_t *r,
  289.     ngx_http_upstream_t *u);


  292. ‌struct ngx_http_upstream_s {
  293.     ngx_http_upstream_handler_pt     read_event_handler;
  294.     ngx_http_upstream_handler_pt     write_event_handler;

  296.     ngx_peer_connection_t            peer;

  298.     ngx_event_pipe_t                *pipe;

  300.     ngx_chain_t                     *request_bufs;

  302.     ngx_output_chain_ctx_t           output;
  303.     ngx_chain_writer_ctx_t           writer;

  305.     ngx_http_upstream_conf_t        *conf;
  306. #if (NGX_HTTP_CACHE)
  307.     ngx_array_t                     *caches;
  308. #endif

  310.     ngx_http_upstream_headers_in_t   headers_in;

  312.     ngx_http_upstream_resolved_t    *resolved;

  314.     ngx_buf_t                        from_client;

  316.     ngx_buf_t                        buffer;
  317.     off_t                            length;

  319.     ngx_chain_t                     *out_bufs;
  320.     ngx_chain_t                     *busy_bufs;
  321.     ngx_chain_t                     *free_bufs;

  323.     ngx_int_t                      (*input_filter_init)(void *data);
  324.     ngx_int_t                      (*input_filter)(void *data, ssize_t bytes);
  325.     void                            *input_filter_ctx;

  327. #if (NGX_HTTP_CACHE)
  328.     ngx_int_t                      (*create_key)(ngx_http_request_t *r);
  329. #endif
  330.     ngx_int_t                      (*create_request)(ngx_http_request_t *r);
  331.     ngx_int_t                      (*reinit_request)(ngx_http_request_t *r);
  332.     ngx_int_t                      (*process_header)(ngx_http_request_t *r);
  333.     void                           (*abort_request)(ngx_http_request_t *r);
  334.     void                           (*finalize_request)(ngx_http_request_t *r,
  335.                                          ngx_int_t rc);
  336.     ngx_int_t                      (*rewrite_redirect)(ngx_http_request_t *r,
  337.                                          ngx_table_elt_t *h, size_t prefix);
  338.     ngx_int_t                      (*rewrite_cookie)(ngx_http_request_t *r,
  339.                                          ngx_table_elt_t *h);

  341.     ngx_msec_t                       timeout;

  343.     ngx_http_upstream_state_t       *state;

  345.     ngx_str_t                        method;
  346.     ngx_str_t                        schema;
  347.     ngx_str_t                        uri;

  349. #if (NGX_HTTP_SSL)
  350.     ngx_str_t                        ssl_name;
  351. #endif

  353.     ngx_http_cleanup_pt             *cleanup;

  355.     unsigned                         store:1;
  356.     unsigned                         cacheable:1;
  357.     unsigned                         accel:1;
  358.     unsigned                         ssl:1;
  359. #if (NGX_HTTP_CACHE)
  360.     unsigned                         cache_status:3;
  361. #endif

  363.     unsigned                         buffering:1;
  364.     unsigned                         keepalive:1;
  365.     unsigned                         upgrade:1;

  367.     unsigned                         request_sent:1;
  368.     unsigned                         header_sent:1;
  369. };


  372. typedef struct {
  373.     ngx_uint_t                      status;
  374.     ngx_uint_t                      mask;
  375. ‌} ngx_http_upstream_next_t;


  378. typedef struct {
  379.     ngx_str_t   key;
  380.     ngx_str_t   value;
  381.     ngx_uint_t  skip_empty;
  382. ‌} ngx_http_upstream_param_t;


  385. ngx_int_t ngx_http_upstream_cookie_variable(ngx_http_request_t *r,
  386.     ngx_http_variable_value_t *v, uintptr_t data);
  387. ngx_int_t ngx_http_upstream_header_variable(ngx_http_request_t *r,
  388.     ngx_http_variable_value_t *v, uintptr_t data);

  390. ngx_int_t ngx_http_upstream_create(ngx_http_request_t *r);
  391. void ngx_http_upstream_init(ngx_http_request_t *r);
  392. ngx_http_upstream_srv_conf_t *ngx_http_upstream_add(ngx_conf_t *cf,
  393.     ngx_url_t *u, ngx_uint_t flags);
  394. char *ngx_http_upstream_bind_set_slot(ngx_conf_t *cf, ngx_command_t *cmd,
  395.     void *conf);
  396. char *ngx_http_upstream_param_set_slot(ngx_conf_t *cf, ngx_command_t *cmd,
  397.     void *conf);
  398. ngx_int_t ngx_http_upstream_hide_headers_hash(ngx_conf_t *cf,
  399.     ngx_http_upstream_conf_t *conf, ngx_http_upstream_conf_t *prev,
  400.     ngx_str_t *default_hide_headers, ngx_hash_init_t *hash);


  403. ‌#define ngx_http_conf_upstream_srv_conf(uscf, module)                         \
  404.     uscf->srv_conf[module.ctx_index]


  407. extern ngx_module_t        ngx_http_upstream_module;
  408. extern ngx_conf_bitmask_t  ngx_http_upstream_cache_method_mask[];
  409. extern ngx_conf_bitmask_t  ngx_http_upstream_ignore_headers_masks[];


  412. #endif /* _NGX_HTTP_UPSTREAM_H_INCLUDED_ */

One Level Up Top Level