One Level Up Top Level

src/http/ngx_http_upstream.h - nginx-1.31.4 nginx/ @ 8d9666701

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
  46. ‌#define NGX_HTTP_UPSTREAM_EARLY_HINTS        41


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


  60. ‌#define NGX_HTTP_UPSTREAM_NOTIFY_HEADER      0x1


  63. ‌typedef struct {
  64.     ngx_uint_t                       status;
  65.     ngx_msec_t                       response_time;
  66.     ngx_msec_t                       connect_time;
  67.     ngx_msec_t                       header_time;
  68.     ngx_msec_t                       queue_time;
  69.     off_t                            response_length;
  70.     off_t                            bytes_received;
  71.     off_t                            bytes_sent;

  73.     ngx_str_t                       *peer;

  75.     NGX_COMPAT_BEGIN(2)
  76.     NGX_COMPAT_END
  77. ‌} ngx_http_upstream_state_t;


  80. ‌typedef struct {
  81.     ngx_hash_t                       headers_in_hash;
  82.     ngx_array_t                      upstreams;
  83.                                              /* ngx_http_upstream_srv_conf_t */
  84. ‌} ngx_http_upstream_main_conf_t;

  86. ‌typedef struct ngx_http_upstream_srv_conf_s  ngx_http_upstream_srv_conf_t;

  88. ‌typedef ngx_int_t (*ngx_http_upstream_init_pt)(ngx_conf_t *cf,
  89.     ngx_http_upstream_srv_conf_t *us);
  90. ‌typedef ngx_int_t (*ngx_http_upstream_init_peer_pt)(ngx_http_request_t *r,
  91.     ngx_http_upstream_srv_conf_t *us);


  94. ‌typedef struct {
  95.     ngx_http_upstream_init_pt        init_upstream;
  96.     ngx_http_upstream_init_peer_pt   init;
  97.     void                            *data;
  98. ‌} ngx_http_upstream_peer_t;


  101. ‌typedef struct {
  102.     ngx_str_t                        name;
  103.     ngx_addr_t                      *addrs;
  104.     ngx_uint_t                       naddrs;
  105.     ngx_uint_t                       weight;
  106.     ngx_uint_t                       max_conns;
  107.     ngx_uint_t                       max_fails;
  108.     time_t                           fail_timeout;
  109.     ngx_msec_t                       slow_start;
  110.     ngx_uint_t                       down;

  112.     unsigned                         backup:1;

  114. #if (NGX_HTTP_UPSTREAM_ZONE)
  115.     ngx_str_t                        host;
  116.     ngx_str_t                        service;
  117. #endif

  119. #if (NGX_HTTP_UPSTREAM_SID || NGX_COMPAT)
  120.     ngx_str_t                        sid;
  121. #endif
  122. ‌} ngx_http_upstream_server_t;


  125. ‌#define NGX_HTTP_UPSTREAM_CREATE        0x0001
  126. ‌#define NGX_HTTP_UPSTREAM_WEIGHT        0x0002
  127. ‌#define NGX_HTTP_UPSTREAM_MAX_FAILS     0x0004
  128. ‌#define NGX_HTTP_UPSTREAM_FAIL_TIMEOUT  0x0008
  129. ‌#define NGX_HTTP_UPSTREAM_DOWN          0x0010
  130. ‌#define NGX_HTTP_UPSTREAM_BACKUP        0x0020
  131. ‌#define NGX_HTTP_UPSTREAM_MODIFY        0x0040
  132. ‌#define NGX_HTTP_UPSTREAM_MAX_CONNS     0x0100


  135. ‌struct ngx_http_upstream_srv_conf_s {
  136.     ngx_http_upstream_peer_t         peer;
  137.     void                           **srv_conf;

  139.     ngx_array_t                     *servers;  /* ngx_http_upstream_server_t */

  141.     ngx_uint_t                       flags;
  142.     ngx_str_t                        host;
  143.     u_char                          *file_name;
  144.     ngx_uint_t                       line;
  145.     in_port_t                        port;
  146.     ngx_uint_t                       no_port;  /* unsigned no_port:1 */

  148. #if (NGX_HTTP_UPSTREAM_ZONE)
  149.     ngx_shm_zone_t                  *shm_zone;
  150.     ngx_resolver_t                  *resolver;
  151.     ngx_msec_t                       resolver_timeout;
  152. #endif
  153. };


  156. ‌typedef struct {
  157.     ngx_addr_t                      *addr;
  158.     ngx_http_complex_value_t        *value;
  159. #if (NGX_HAVE_TRANSPARENT_PROXY)
  160.     ngx_uint_t                       transparent; /* unsigned  transparent:1; */
  161. #endif
  162. ‌} ngx_http_upstream_local_t;


  165. ‌typedef struct {
  166.     ngx_http_upstream_srv_conf_t    *upstream;

  168.     ngx_msec_t                       connect_timeout;
  169.     ngx_msec_t                       send_timeout;
  170.     ngx_msec_t                       read_timeout;
  171.     ngx_msec_t                       next_upstream_timeout;

  173.     size_t                           send_lowat;
  174.     size_t                           buffer_size;
  175.     ngx_http_complex_value_t        *limit_rate;

  177.     size_t                           busy_buffers_size;
  178.     size_t                           max_temp_file_size;
  179.     size_t                           temp_file_write_size;

  181.     size_t                           busy_buffers_size_conf;
  182.     size_t                           max_temp_file_size_conf;
  183.     size_t                           temp_file_write_size_conf;

  185.     ngx_bufs_t                       bufs;

  187.     ngx_uint_t                       ignore_headers;
  188.     ngx_uint_t                       next_upstream;
  189.     ngx_uint_t                       store_access;
  190.     ngx_uint_t                       next_upstream_tries;
  191.     ngx_flag_t                       buffering;
  192.     ngx_flag_t                       request_buffering;
  193.     ngx_flag_t                       pass_request_headers;
  194.     ngx_flag_t                       pass_request_body;
  195.     ngx_flag_t                       pass_trailers;
  196.     ngx_flag_t                       pass_early_hints;

  198.     ngx_flag_t                       ignore_client_abort;
  199.     ngx_flag_t                       intercept_errors;
  200.     ngx_flag_t                       cyclic_temp_file;
  201.     ngx_flag_t                       force_ranges;

  203.     ngx_path_t                      *temp_path;

  205.     ngx_hash_t                       hide_headers_hash;
  206.     ngx_array_t                     *hide_headers;
  207.     ngx_array_t                     *pass_headers;

  209.     ngx_http_upstream_local_t       *local;
  210.     ngx_flag_t                       socket_keepalive;
  211.     size_t                           socket_rcvbuf;
  212.     size_t                           socket_sndbuf;

  214. #if (NGX_HTTP_CACHE)
  215.     ngx_shm_zone_t                  *cache_zone;
  216.     ngx_http_complex_value_t        *cache_value;

  218.     ngx_uint_t                       cache_min_uses;
  219.     ngx_uint_t                       cache_use_stale;
  220.     ngx_uint_t                       cache_methods;

  222.     off_t                            cache_max_range_offset;

  224.     ngx_flag_t                       cache_lock;
  225.     ngx_msec_t                       cache_lock_timeout;
  226.     ngx_msec_t                       cache_lock_age;

  228.     ngx_flag_t                       cache_revalidate;
  229.     ngx_flag_t                       cache_convert_head;
  230.     ngx_flag_t                       cache_background_update;

  232.     ngx_array_t                     *cache_valid;
  233.     ngx_array_t                     *cache_bypass;
  234.     ngx_array_t                     *cache_purge;
  235.     ngx_array_t                     *no_cache;
  236. #endif

  238.     ngx_array_t                     *store_lengths;
  239.     ngx_array_t                     *store_values;

  241. #if (NGX_HTTP_CACHE)
  242.     signed                           cache:2;
  243. #endif
  244.     signed                           store:2;
  245.     unsigned                         intercept_404:1;
  246.     unsigned                         change_buffering:1;
  247.     unsigned                         preserve_output:1;
  248.     unsigned                         ignore_input:1;

  250. #if (NGX_HTTP_SSL || NGX_COMPAT)
  251.     ngx_ssl_t                       *ssl;
  252.     ngx_flag_t                       ssl_session_reuse;

  254.     ngx_http_complex_value_t        *ssl_name;
  255.     ngx_flag_t                       ssl_server_name;
  256.     ngx_flag_t                       ssl_verify;

  258.     ngx_http_complex_value_t        *ssl_certificate;
  259.     ngx_http_complex_value_t        *ssl_certificate_key;
  260.     ngx_ssl_cache_t                 *ssl_certificate_cache;
  261.     ngx_array_t                     *ssl_passwords;
  262. #endif

  264.     ngx_str_t                        module;

  266.     NGX_COMPAT_BEGIN(5)
  267.     NGX_COMPAT_END
  268. ‌} ngx_http_upstream_conf_t;


  271. ‌typedef struct {
  272.     ngx_str_t                        name;
  273.     ngx_http_header_handler_pt       handler;
  274.     ngx_uint_t                       offset;
  275.     ngx_http_header_handler_pt       copy_handler;
  276.     ngx_uint_t                       conf;
  277.     ngx_uint_t                       redirect;  /* unsigned   redirect:1; */
  278. ‌} ngx_http_upstream_header_t;


  281. ‌typedef struct {
  282.     ngx_list_t                       headers;
  283.     ngx_list_t                       trailers;

  285.     ngx_uint_t                       status_n;
  286.     ngx_str_t                        status_line;

  288.     ngx_table_elt_t                 *status;
  289.     ngx_table_elt_t                 *date;
  290.     ngx_table_elt_t                 *server;
  291.     ngx_table_elt_t                 *connection;

  293.     ngx_table_elt_t                 *expires;
  294.     ngx_table_elt_t                 *etag;
  295.     ngx_table_elt_t                 *x_accel_expires;
  296.     ngx_table_elt_t                 *x_accel_redirect;
  297.     ngx_table_elt_t                 *x_accel_limit_rate;

  299.     ngx_table_elt_t                 *content_type;
  300.     ngx_table_elt_t                 *content_length;

  302.     ngx_table_elt_t                 *last_modified;
  303.     ngx_table_elt_t                 *location;
  304.     ngx_table_elt_t                 *refresh;
  305.     ngx_table_elt_t                 *www_authenticate;
  306.     ngx_table_elt_t                 *transfer_encoding;
  307.     ngx_table_elt_t                 *vary;

  309.     ngx_table_elt_t                 *cache_control;
  310.     ngx_table_elt_t                 *set_cookie;

  312.     off_t                            content_length_n;
  313.     time_t                           last_modified_time;

  315.     unsigned                         connection_close:1;
  316.     unsigned                         chunked:1;
  317.     unsigned                         no_cache:1;
  318.     unsigned                         expired:1;
  319. ‌} ngx_http_upstream_headers_in_t;


  322. ‌typedef struct {
  323.     ngx_str_t                        host;
  324.     in_port_t                        port;
  325.     ngx_uint_t                       no_port; /* unsigned no_port:1 */

  327.     ngx_uint_t                       naddrs;
  328.     ngx_resolver_addr_t             *addrs;

  330.     struct sockaddr                 *sockaddr;
  331.     socklen_t                        socklen;
  332.     ngx_str_t                        name;

  334.     ngx_resolver_ctx_t              *ctx;
  335. ‌} ngx_http_upstream_resolved_t;


  338. ‌typedef void (*ngx_http_upstream_handler_pt)(ngx_http_request_t *r,
  339.     ngx_http_upstream_t *u);


  342. ‌struct ngx_http_upstream_s {
  343.     ngx_http_upstream_handler_pt     read_event_handler;
  344.     ngx_http_upstream_handler_pt     write_event_handler;

  346.     ngx_peer_connection_t            peer;

  348.     ngx_event_pipe_t                *pipe;

  350.     ngx_chain_t                     *request_bufs;

  352.     ngx_output_chain_ctx_t           output;
  353.     ngx_chain_writer_ctx_t           writer;

  355.     ngx_http_upstream_conf_t        *conf;
  356.     ngx_http_upstream_srv_conf_t    *upstream;
  357. #if (NGX_HTTP_CACHE)
  358.     ngx_array_t                     *caches;
  359. #endif

  361.     ngx_http_upstream_headers_in_t   headers_in;

  363.     ngx_http_upstream_resolved_t    *resolved;

  365.     ngx_buf_t                        from_client;

  367.     ngx_buf_t                        buffer;
  368.     off_t                            length;
  369.     off_t                            early_hints_length;

  371.     ngx_chain_t                     *out_bufs;
  372.     ngx_chain_t                     *busy_bufs;
  373.     ngx_chain_t                     *free_bufs;

  375.     ngx_int_t                      (*input_filter_init)(void *data);
  376.     ngx_int_t                      (*input_filter)(void *data, ssize_t bytes);
  377.     void                            *input_filter_ctx;

  379. #if (NGX_HTTP_CACHE)
  380.     ngx_int_t                      (*create_key)(ngx_http_request_t *r);
  381. #endif
  382.     ngx_int_t                      (*create_request)(ngx_http_request_t *r);
  383.     ngx_int_t                      (*reinit_request)(ngx_http_request_t *r);
  384.     ngx_int_t                      (*process_header)(ngx_http_request_t *r);
  385.     void                           (*abort_request)(ngx_http_request_t *r);
  386.     void                           (*finalize_request)(ngx_http_request_t *r,
  387.                                          ngx_int_t rc);
  388.     ngx_int_t                      (*rewrite_redirect)(ngx_http_request_t *r,
  389.                                          ngx_table_elt_t *h, size_t prefix);
  390.     ngx_int_t                      (*rewrite_cookie)(ngx_http_request_t *r,
  391.                                          ngx_table_elt_t *h);

  393.     ngx_msec_t                       start_time;

  395.     ngx_http_upstream_state_t       *state;

  397.     ngx_str_t                        method;
  398.     ngx_str_t                        schema;
  399.     ngx_str_t                        uri;

  401. #if (NGX_HTTP_SSL || NGX_COMPAT)
  402.     ngx_str_t                        ssl_name;
  403.     ngx_str_t                        ssl_alpn_protocol;
  404. #endif

  406.     ngx_http_cleanup_pt             *cleanup;

  408.     unsigned                         store:1;
  409.     unsigned                         cacheable:1;
  410.     unsigned                         accel:1;
  411.     unsigned                         ssl:1;
  412. #if (NGX_HTTP_CACHE)
  413.     unsigned                         cache_status:3;
  414. #endif

  416.     unsigned                         buffering:1;
  417.     unsigned                         keepalive:1;
  418.     unsigned                         upgrade:1;
  419.     unsigned                         error:1;

  421.     unsigned                         request_sent:1;
  422.     unsigned                         request_body_sent:1;
  423.     unsigned                         request_body_blocked:1;
  424.     unsigned                         header_sent:1;
  425.     unsigned                         response_received:1;
  426. };


  429. ‌typedef struct {
  430.     ngx_uint_t                      status;
  431.     ngx_uint_t                      mask;
  432. ‌} ngx_http_upstream_next_t;


  435. ‌typedef struct {
  436.     ngx_str_t   key;
  437.     ngx_str_t   value;
  438.     ngx_uint_t  skip_empty;
  439. ‌} ngx_http_upstream_param_t;


  442. ngx_int_t ngx_http_upstream_create(ngx_http_request_t *r);
  443. void ngx_http_upstream_init(ngx_http_request_t *r);
  444. ngx_int_t ngx_http_upstream_non_buffered_filter_init(void *data);
  445. ngx_int_t ngx_http_upstream_non_buffered_filter(void *data, ssize_t bytes);
  446. ngx_http_upstream_srv_conf_t *ngx_http_upstream_add(ngx_conf_t *cf,
  447.     ngx_url_t *u, ngx_uint_t flags);
  448. char *ngx_http_upstream_bind_set_slot(ngx_conf_t *cf, ngx_command_t *cmd,
  449.     void *conf);
  450. char *ngx_http_upstream_param_set_slot(ngx_conf_t *cf, ngx_command_t *cmd,
  451.     void *conf);
  452. ngx_int_t ngx_http_upstream_hide_headers_hash(ngx_conf_t *cf,
  453.     ngx_http_upstream_conf_t *conf, ngx_http_upstream_conf_t *prev,
  454.     ngx_str_t *default_hide_headers, ngx_hash_init_t *hash);
  455. #if (NGX_HTTP_SSL)
  456. ngx_int_t ngx_http_upstream_merge_ssl_passwords(ngx_conf_t *cf,
  457.     ngx_http_upstream_conf_t *conf, ngx_http_upstream_conf_t *prev);
  458. #endif


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


  465. extern ngx_module_t        ngx_http_upstream_module;
  466. extern ngx_conf_bitmask_t  ngx_http_upstream_cache_method_mask[];
  467. extern ngx_conf_bitmask_t  ngx_http_upstream_ignore_headers_masks[];


  470. #endif /* _NGX_HTTP_UPSTREAM_H_INCLUDED_ */

One Level Up Top Level