One Level Up Top Level

src/http/ngx_http_upstream.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_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_HTTP_429        0x00000400
  30. ‌#define NGX_HTTP_UPSTREAM_FT_UPDATING        0x00000800
  31. ‌#define NGX_HTTP_UPSTREAM_FT_BUSY_LOCK       0x00001000
  32. ‌#define NGX_HTTP_UPSTREAM_FT_MAX_WAITING     0x00002000
  33. ‌#define NGX_HTTP_UPSTREAM_FT_NON_IDEMPOTENT  0x00004000
  34. ‌#define NGX_HTTP_UPSTREAM_FT_NOLIVE          0x40000000
  35. ‌#define NGX_HTTP_UPSTREAM_FT_OFF             0x80000000

  37. ‌#define NGX_HTTP_UPSTREAM_FT_STATUS          (NGX_HTTP_UPSTREAM_FT_HTTP_500  \
  38.                                              |NGX_HTTP_UPSTREAM_FT_HTTP_502  \
  39.                                              |NGX_HTTP_UPSTREAM_FT_HTTP_503  \
  40.                                              |NGX_HTTP_UPSTREAM_FT_HTTP_504  \
  41.                                              |NGX_HTTP_UPSTREAM_FT_HTTP_403  \
  42.                                              |NGX_HTTP_UPSTREAM_FT_HTTP_404  \
  43.                                              |NGX_HTTP_UPSTREAM_FT_HTTP_429)

  45. ‌#define NGX_HTTP_UPSTREAM_INVALID_HEADER     40


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


  59. ‌typedef struct {
  60.     ngx_uint_t                       status;
  61.     ngx_msec_t                       response_time;
  62.     ngx_msec_t                       connect_time;
  63.     ngx_msec_t                       header_time;
  64.     ngx_msec_t                       queue_time;
  65.     off_t                            response_length;
  66.     off_t                            bytes_received;
  67.     off_t                            bytes_sent;

  69.     ngx_str_t                       *peer;
  70. ‌} ngx_http_upstream_state_t;


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

  79. ‌typedef struct ngx_http_upstream_srv_conf_s  ngx_http_upstream_srv_conf_t;

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


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


  94. ‌typedef struct {
  95.     ngx_str_t                        name;
  96.     ngx_addr_t                      *addrs;
  97.     ngx_uint_t                       naddrs;
  98.     ngx_uint_t                       weight;
  99.     ngx_uint_t                       max_conns;
  100.     ngx_uint_t                       max_fails;
  101.     time_t                           fail_timeout;
  102.     ngx_msec_t                       slow_start;
  103.     ngx_uint_t                       down;

  105.     unsigned                         backup:1;

  107. #if (NGX_HTTP_UPSTREAM_ZONE)
  108.     ngx_str_t                        host;
  109.     ngx_str_t                        service;
  110. #endif

  112.     NGX_COMPAT_BEGIN(2)
  113.     NGX_COMPAT_END
  114. ‌} ngx_http_upstream_server_t;


  117. ‌#define NGX_HTTP_UPSTREAM_CREATE        0x0001
  118. ‌#define NGX_HTTP_UPSTREAM_WEIGHT        0x0002
  119. ‌#define NGX_HTTP_UPSTREAM_MAX_FAILS     0x0004
  120. ‌#define NGX_HTTP_UPSTREAM_FAIL_TIMEOUT  0x0008
  121. ‌#define NGX_HTTP_UPSTREAM_DOWN          0x0010
  122. ‌#define NGX_HTTP_UPSTREAM_BACKUP        0x0020
  123. ‌#define NGX_HTTP_UPSTREAM_MODIFY        0x0040
  124. ‌#define NGX_HTTP_UPSTREAM_MAX_CONNS     0x0100


  127. ‌struct ngx_http_upstream_srv_conf_s {
  128.     ngx_http_upstream_peer_t         peer;
  129.     void                           **srv_conf;

  131.     ngx_array_t                     *servers;  /* ngx_http_upstream_server_t */

  133.     ngx_uint_t                       flags;
  134.     ngx_str_t                        host;
  135.     u_char                          *file_name;
  136.     ngx_uint_t                       line;
  137.     in_port_t                        port;
  138.     ngx_uint_t                       no_port;  /* unsigned no_port:1 */

  140. #if (NGX_HTTP_UPSTREAM_ZONE)
  141.     ngx_shm_zone_t                  *shm_zone;
  142.     ngx_resolver_t                  *resolver;
  143.     ngx_msec_t                       resolver_timeout;
  144. #endif
  145. };


  148. ‌typedef struct {
  149.     ngx_addr_t                      *addr;
  150.     ngx_http_complex_value_t        *value;
  151. #if (NGX_HAVE_TRANSPARENT_PROXY)
  152.     ngx_uint_t                       transparent; /* unsigned  transparent:1; */
  153. #endif
  154. ‌} ngx_http_upstream_local_t;


  157. ‌typedef struct {
  158.     ngx_http_upstream_srv_conf_t    *upstream;

  160.     ngx_msec_t                       connect_timeout;
  161.     ngx_msec_t                       send_timeout;
  162.     ngx_msec_t                       read_timeout;
  163.     ngx_msec_t                       next_upstream_timeout;

  165.     size_t                           send_lowat;
  166.     size_t                           buffer_size;
  167.     ngx_http_complex_value_t        *limit_rate;

  169.     size_t                           busy_buffers_size;
  170.     size_t                           max_temp_file_size;
  171.     size_t                           temp_file_write_size;

  173.     size_t                           busy_buffers_size_conf;
  174.     size_t                           max_temp_file_size_conf;
  175.     size_t                           temp_file_write_size_conf;

  177.     ngx_bufs_t                       bufs;

  179.     ngx_uint_t                       ignore_headers;
  180.     ngx_uint_t                       next_upstream;
  181.     ngx_uint_t                       store_access;
  182.     ngx_uint_t                       next_upstream_tries;
  183.     ngx_flag_t                       buffering;
  184.     ngx_flag_t                       request_buffering;
  185.     ngx_flag_t                       pass_request_headers;
  186.     ngx_flag_t                       pass_request_body;
  187.     ngx_flag_t                       pass_trailers;

  189.     ngx_flag_t                       ignore_client_abort;
  190.     ngx_flag_t                       intercept_errors;
  191.     ngx_flag_t                       cyclic_temp_file;
  192.     ngx_flag_t                       force_ranges;

  194.     ngx_path_t                      *temp_path;

  196.     ngx_hash_t                       hide_headers_hash;
  197.     ngx_array_t                     *hide_headers;
  198.     ngx_array_t                     *pass_headers;

  200.     ngx_http_upstream_local_t       *local;
  201.     ngx_flag_t                       socket_keepalive;

  203. #if (NGX_HTTP_CACHE)
  204.     ngx_shm_zone_t                  *cache_zone;
  205.     ngx_http_complex_value_t        *cache_value;

  207.     ngx_uint_t                       cache_min_uses;
  208.     ngx_uint_t                       cache_use_stale;
  209.     ngx_uint_t                       cache_methods;

  211.     off_t                            cache_max_range_offset;

  213.     ngx_flag_t                       cache_lock;
  214.     ngx_msec_t                       cache_lock_timeout;
  215.     ngx_msec_t                       cache_lock_age;

  217.     ngx_flag_t                       cache_revalidate;
  218.     ngx_flag_t                       cache_convert_head;
  219.     ngx_flag_t                       cache_background_update;

  221.     ngx_array_t                     *cache_valid;
  222.     ngx_array_t                     *cache_bypass;
  223.     ngx_array_t                     *cache_purge;
  224.     ngx_array_t                     *no_cache;
  225. #endif

  227.     ngx_array_t                     *store_lengths;
  228.     ngx_array_t                     *store_values;

  230. #if (NGX_HTTP_CACHE)
  231.     signed                           cache:2;
  232. #endif
  233.     signed                           store:2;
  234.     unsigned                         intercept_404:1;
  235.     unsigned                         change_buffering:1;
  236.     unsigned                         preserve_output:1;

  238. #if (NGX_HTTP_SSL || NGX_COMPAT)
  239.     ngx_ssl_t                       *ssl;
  240.     ngx_flag_t                       ssl_session_reuse;

  242.     ngx_http_complex_value_t        *ssl_name;
  243.     ngx_flag_t                       ssl_server_name;
  244.     ngx_flag_t                       ssl_verify;

  246.     ngx_http_complex_value_t        *ssl_certificate;
  247.     ngx_http_complex_value_t        *ssl_certificate_key;
  248.     ngx_array_t                     *ssl_passwords;
  249. #endif

  251.     ngx_str_t                        module;

  253.     NGX_COMPAT_BEGIN(2)
  254.     NGX_COMPAT_END
  255. ‌} ngx_http_upstream_conf_t;


  258. ‌typedef struct {
  259.     ngx_str_t                        name;
  260.     ngx_http_header_handler_pt       handler;
  261.     ngx_uint_t                       offset;
  262.     ngx_http_header_handler_pt       copy_handler;
  263.     ngx_uint_t                       conf;
  264.     ngx_uint_t                       redirect;  /* unsigned   redirect:1; */
  265. ‌} ngx_http_upstream_header_t;


  268. ‌typedef struct {
  269.     ngx_list_t                       headers;
  270.     ngx_list_t                       trailers;

  272.     ngx_uint_t                       status_n;
  273.     ngx_str_t                        status_line;

  275.     ngx_table_elt_t                 *status;
  276.     ngx_table_elt_t                 *date;
  277.     ngx_table_elt_t                 *server;
  278.     ngx_table_elt_t                 *connection;

  280.     ngx_table_elt_t                 *expires;
  281.     ngx_table_elt_t                 *etag;
  282.     ngx_table_elt_t                 *x_accel_expires;
  283.     ngx_table_elt_t                 *x_accel_redirect;
  284.     ngx_table_elt_t                 *x_accel_limit_rate;

  286.     ngx_table_elt_t                 *content_type;
  287.     ngx_table_elt_t                 *content_length;

  289.     ngx_table_elt_t                 *last_modified;
  290.     ngx_table_elt_t                 *location;
  291.     ngx_table_elt_t                 *refresh;
  292.     ngx_table_elt_t                 *www_authenticate;
  293.     ngx_table_elt_t                 *transfer_encoding;
  294.     ngx_table_elt_t                 *vary;

  296.     ngx_table_elt_t                 *cache_control;
  297.     ngx_table_elt_t                 *set_cookie;

  299.     off_t                            content_length_n;
  300.     time_t                           last_modified_time;

  302.     unsigned                         connection_close:1;
  303.     unsigned                         chunked:1;
  304.     unsigned                         no_cache:1;
  305.     unsigned                         expired:1;
  306. ‌} ngx_http_upstream_headers_in_t;


  309. ‌typedef struct {
  310.     ngx_str_t                        host;
  311.     in_port_t                        port;
  312.     ngx_uint_t                       no_port; /* unsigned no_port:1 */

  314.     ngx_uint_t                       naddrs;
  315.     ngx_resolver_addr_t             *addrs;

  317.     struct sockaddr                 *sockaddr;
  318.     socklen_t                        socklen;
  319.     ngx_str_t                        name;

  321.     ngx_resolver_ctx_t              *ctx;
  322. ‌} ngx_http_upstream_resolved_t;


  325. ‌typedef void (*ngx_http_upstream_handler_pt)(ngx_http_request_t *r,
  326.     ngx_http_upstream_t *u);


  329. ‌struct ngx_http_upstream_s {
  330.     ngx_http_upstream_handler_pt     read_event_handler;
  331.     ngx_http_upstream_handler_pt     write_event_handler;

  333.     ngx_peer_connection_t            peer;

  335.     ngx_event_pipe_t                *pipe;

  337.     ngx_chain_t                     *request_bufs;

  339.     ngx_output_chain_ctx_t           output;
  340.     ngx_chain_writer_ctx_t           writer;

  342.     ngx_http_upstream_conf_t        *conf;
  343.     ngx_http_upstream_srv_conf_t    *upstream;
  344. #if (NGX_HTTP_CACHE)
  345.     ngx_array_t                     *caches;
  346. #endif

  348.     ngx_http_upstream_headers_in_t   headers_in;

  350.     ngx_http_upstream_resolved_t    *resolved;

  352.     ngx_buf_t                        from_client;

  354.     ngx_buf_t                        buffer;
  355.     off_t                            length;

  357.     ngx_chain_t                     *out_bufs;
  358.     ngx_chain_t                     *busy_bufs;
  359.     ngx_chain_t                     *free_bufs;

  361.     ngx_int_t                      (*input_filter_init)(void *data);
  362.     ngx_int_t                      (*input_filter)(void *data, ssize_t bytes);
  363.     void                            *input_filter_ctx;

  365. #if (NGX_HTTP_CACHE)
  366.     ngx_int_t                      (*create_key)(ngx_http_request_t *r);
  367. #endif
  368.     ngx_int_t                      (*create_request)(ngx_http_request_t *r);
  369.     ngx_int_t                      (*reinit_request)(ngx_http_request_t *r);
  370.     ngx_int_t                      (*process_header)(ngx_http_request_t *r);
  371.     void                           (*abort_request)(ngx_http_request_t *r);
  372.     void                           (*finalize_request)(ngx_http_request_t *r,
  373.                                          ngx_int_t rc);
  374.     ngx_int_t                      (*rewrite_redirect)(ngx_http_request_t *r,
  375.                                          ngx_table_elt_t *h, size_t prefix);
  376.     ngx_int_t                      (*rewrite_cookie)(ngx_http_request_t *r,
  377.                                          ngx_table_elt_t *h);

  379.     ngx_msec_t                       start_time;

  381.     ngx_http_upstream_state_t       *state;

  383.     ngx_str_t                        method;
  384.     ngx_str_t                        schema;
  385.     ngx_str_t                        uri;

  387. #if (NGX_HTTP_SSL || NGX_COMPAT)
  388.     ngx_str_t                        ssl_name;
  389. #endif

  391.     ngx_http_cleanup_pt             *cleanup;

  393.     unsigned                         store:1;
  394.     unsigned                         cacheable:1;
  395.     unsigned                         accel:1;
  396.     unsigned                         ssl:1;
  397. #if (NGX_HTTP_CACHE)
  398.     unsigned                         cache_status:3;
  399. #endif

  401.     unsigned                         buffering:1;
  402.     unsigned                         keepalive:1;
  403.     unsigned                         upgrade:1;
  404.     unsigned                         error:1;

  406.     unsigned                         request_sent:1;
  407.     unsigned                         request_body_sent:1;
  408.     unsigned                         request_body_blocked:1;
  409.     unsigned                         header_sent:1;
  410. };


  413. ‌typedef struct {
  414.     ngx_uint_t                      status;
  415.     ngx_uint_t                      mask;
  416. ‌} ngx_http_upstream_next_t;


  419. ‌typedef struct {
  420.     ngx_str_t   key;
  421.     ngx_str_t   value;
  422.     ngx_uint_t  skip_empty;
  423. ‌} ngx_http_upstream_param_t;


  426. ngx_int_t ngx_http_upstream_create(ngx_http_request_t *r);
  427. void ngx_http_upstream_init(ngx_http_request_t *r);
  428. ngx_int_t ngx_http_upstream_non_buffered_filter_init(void *data);
  429. ngx_int_t ngx_http_upstream_non_buffered_filter(void *data, ssize_t bytes);
  430. ngx_http_upstream_srv_conf_t *ngx_http_upstream_add(ngx_conf_t *cf,
  431.     ngx_url_t *u, ngx_uint_t flags);
  432. char *ngx_http_upstream_bind_set_slot(ngx_conf_t *cf, ngx_command_t *cmd,
  433.     void *conf);
  434. char *ngx_http_upstream_param_set_slot(ngx_conf_t *cf, ngx_command_t *cmd,
  435.     void *conf);
  436. ngx_int_t ngx_http_upstream_hide_headers_hash(ngx_conf_t *cf,
  437.     ngx_http_upstream_conf_t *conf, ngx_http_upstream_conf_t *prev,
  438.     ngx_str_t *default_hide_headers, ngx_hash_init_t *hash);


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


  445. extern ngx_module_t        ngx_http_upstream_module;
  446. extern ngx_conf_bitmask_t  ngx_http_upstream_cache_method_mask[];
  447. extern ngx_conf_bitmask_t  ngx_http_upstream_ignore_headers_masks[];


  450. #endif /* _NGX_HTTP_UPSTREAM_H_INCLUDED_ */

One Level Up Top Level