One Level Up Top Level

src/http/ngx_http_upstream.h - nginx

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;
  74. ‌} ngx_http_upstream_state_t;


  77. ‌typedef struct {
  78.     ngx_hash_t                       headers_in_hash;
  79.     ngx_array_t                      upstreams;
  80.                                              /* ngx_http_upstream_srv_conf_t */
  81. ‌} ngx_http_upstream_main_conf_t;

  83. ‌typedef struct ngx_http_upstream_srv_conf_s  ngx_http_upstream_srv_conf_t;

  85. ‌typedef ngx_int_t (*ngx_http_upstream_init_pt)(ngx_conf_t *cf,
  86.     ngx_http_upstream_srv_conf_t *us);
  87. ‌typedef ngx_int_t (*ngx_http_upstream_init_peer_pt)(ngx_http_request_t *r,
  88.     ngx_http_upstream_srv_conf_t *us);


  91. ‌typedef struct {
  92.     ngx_http_upstream_init_pt        init_upstream;
  93.     ngx_http_upstream_init_peer_pt   init;
  94.     void                            *data;
  95. ‌} ngx_http_upstream_peer_t;


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

  109.     unsigned                         backup:1;

  111. #if (NGX_HTTP_UPSTREAM_ZONE)
  112.     ngx_str_t                        host;
  113.     ngx_str_t                        service;
  114. #endif

  116. #if (NGX_HTTP_UPSTREAM_SID || NGX_COMPAT)
  117.     ngx_str_t                        sid;
  118. #endif
  119. ‌} ngx_http_upstream_server_t;


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


  132. ‌struct ngx_http_upstream_srv_conf_s {
  133.     ngx_http_upstream_peer_t         peer;
  134.     void                           **srv_conf;

  136.     ngx_array_t                     *servers;  /* ngx_http_upstream_server_t */

  138.     ngx_uint_t                       flags;
  139.     ngx_str_t                        host;
  140.     u_char                          *file_name;
  141.     ngx_uint_t                       line;
  142.     in_port_t                        port;
  143.     ngx_uint_t                       no_port;  /* unsigned no_port:1 */

  145. #if (NGX_HTTP_UPSTREAM_ZONE)
  146.     ngx_shm_zone_t                  *shm_zone;
  147.     ngx_resolver_t                  *resolver;
  148.     ngx_msec_t                       resolver_timeout;
  149. #endif
  150. };


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


  162. ‌typedef struct {
  163.     ngx_http_upstream_srv_conf_t    *upstream;

  165.     ngx_msec_t                       connect_timeout;
  166.     ngx_msec_t                       send_timeout;
  167.     ngx_msec_t                       read_timeout;
  168.     ngx_msec_t                       next_upstream_timeout;

  170.     size_t                           send_lowat;
  171.     size_t                           buffer_size;
  172.     ngx_http_complex_value_t        *limit_rate;

  174.     size_t                           busy_buffers_size;
  175.     size_t                           max_temp_file_size;
  176.     size_t                           temp_file_write_size;

  178.     size_t                           busy_buffers_size_conf;
  179.     size_t                           max_temp_file_size_conf;
  180.     size_t                           temp_file_write_size_conf;

  182.     ngx_bufs_t                       bufs;

  184.     ngx_uint_t                       ignore_headers;
  185.     ngx_uint_t                       next_upstream;
  186.     ngx_uint_t                       store_access;
  187.     ngx_uint_t                       next_upstream_tries;
  188.     ngx_flag_t                       buffering;
  189.     ngx_flag_t                       request_buffering;
  190.     ngx_flag_t                       pass_request_headers;
  191.     ngx_flag_t                       pass_request_body;
  192.     ngx_flag_t                       pass_trailers;
  193.     ngx_flag_t                       pass_early_hints;

  195.     ngx_flag_t                       ignore_client_abort;
  196.     ngx_flag_t                       intercept_errors;
  197.     ngx_flag_t                       cyclic_temp_file;
  198.     ngx_flag_t                       force_ranges;

  200.     ngx_path_t                      *temp_path;

  202.     ngx_hash_t                       hide_headers_hash;
  203.     ngx_array_t                     *hide_headers;
  204.     ngx_array_t                     *pass_headers;

  206.     ngx_http_upstream_local_t       *local;
  207.     ngx_flag_t                       socket_keepalive;

  209. #if (NGX_HTTP_CACHE)
  210.     ngx_shm_zone_t                  *cache_zone;
  211.     ngx_http_complex_value_t        *cache_value;

  213.     ngx_uint_t                       cache_min_uses;
  214.     ngx_uint_t                       cache_use_stale;
  215.     ngx_uint_t                       cache_methods;

  217.     off_t                            cache_max_range_offset;

  219.     ngx_flag_t                       cache_lock;
  220.     ngx_msec_t                       cache_lock_timeout;
  221.     ngx_msec_t                       cache_lock_age;

  223.     ngx_flag_t                       cache_revalidate;
  224.     ngx_flag_t                       cache_convert_head;
  225.     ngx_flag_t                       cache_background_update;

  227.     ngx_array_t                     *cache_valid;
  228.     ngx_array_t                     *cache_bypass;
  229.     ngx_array_t                     *cache_purge;
  230.     ngx_array_t                     *no_cache;
  231. #endif

  233.     ngx_array_t                     *store_lengths;
  234.     ngx_array_t                     *store_values;

  236. #if (NGX_HTTP_CACHE)
  237.     signed                           cache:2;
  238. #endif
  239.     signed                           store:2;
  240.     unsigned                         intercept_404:1;
  241.     unsigned                         change_buffering:1;
  242.     unsigned                         preserve_output:1;
  243.     unsigned                         ignore_input:1;

  245. #if (NGX_HTTP_SSL || NGX_COMPAT)
  246.     ngx_ssl_t                       *ssl;
  247.     ngx_flag_t                       ssl_session_reuse;

  249.     ngx_http_complex_value_t        *ssl_name;
  250.     ngx_flag_t                       ssl_server_name;
  251.     ngx_flag_t                       ssl_verify;

  253.     ngx_http_complex_value_t        *ssl_certificate;
  254.     ngx_http_complex_value_t        *ssl_certificate_key;
  255.     ngx_ssl_cache_t                 *ssl_certificate_cache;
  256.     ngx_array_t                     *ssl_passwords;
  257. #endif

  259.     ngx_str_t                        module;

  261.     NGX_COMPAT_BEGIN(5)
  262.     NGX_COMPAT_END
  263. ‌} ngx_http_upstream_conf_t;


  266. ‌typedef struct {
  267.     ngx_str_t                        name;
  268.     ngx_http_header_handler_pt       handler;
  269.     ngx_uint_t                       offset;
  270.     ngx_http_header_handler_pt       copy_handler;
  271.     ngx_uint_t                       conf;
  272.     ngx_uint_t                       redirect;  /* unsigned   redirect:1; */
  273. ‌} ngx_http_upstream_header_t;


  276. ‌typedef struct {
  277.     ngx_list_t                       headers;
  278.     ngx_list_t                       trailers;

  280.     ngx_uint_t                       status_n;
  281.     ngx_str_t                        status_line;

  283.     ngx_table_elt_t                 *status;
  284.     ngx_table_elt_t                 *date;
  285.     ngx_table_elt_t                 *server;
  286.     ngx_table_elt_t                 *connection;

  288.     ngx_table_elt_t                 *expires;
  289.     ngx_table_elt_t                 *etag;
  290.     ngx_table_elt_t                 *x_accel_expires;
  291.     ngx_table_elt_t                 *x_accel_redirect;
  292.     ngx_table_elt_t                 *x_accel_limit_rate;

  294.     ngx_table_elt_t                 *content_type;
  295.     ngx_table_elt_t                 *content_length;

  297.     ngx_table_elt_t                 *last_modified;
  298.     ngx_table_elt_t                 *location;
  299.     ngx_table_elt_t                 *refresh;
  300.     ngx_table_elt_t                 *www_authenticate;
  301.     ngx_table_elt_t                 *transfer_encoding;
  302.     ngx_table_elt_t                 *vary;

  304.     ngx_table_elt_t                 *cache_control;
  305.     ngx_table_elt_t                 *set_cookie;

  307.     off_t                            content_length_n;
  308.     time_t                           last_modified_time;

  310.     unsigned                         connection_close:1;
  311.     unsigned                         chunked:1;
  312.     unsigned                         no_cache:1;
  313.     unsigned                         expired:1;
  314. ‌} ngx_http_upstream_headers_in_t;


  317. ‌typedef struct {
  318.     ngx_str_t                        host;
  319.     in_port_t                        port;
  320.     ngx_uint_t                       no_port; /* unsigned no_port:1 */

  322.     ngx_uint_t                       naddrs;
  323.     ngx_resolver_addr_t             *addrs;

  325.     struct sockaddr                 *sockaddr;
  326.     socklen_t                        socklen;
  327.     ngx_str_t                        name;

  329.     ngx_resolver_ctx_t              *ctx;
  330. ‌} ngx_http_upstream_resolved_t;


  333. ‌typedef void (*ngx_http_upstream_handler_pt)(ngx_http_request_t *r,
  334.     ngx_http_upstream_t *u);


  337. ‌struct ngx_http_upstream_s {
  338.     ngx_http_upstream_handler_pt     read_event_handler;
  339.     ngx_http_upstream_handler_pt     write_event_handler;

  341.     ngx_peer_connection_t            peer;

  343.     ngx_event_pipe_t                *pipe;

  345.     ngx_chain_t                     *request_bufs;

  347.     ngx_output_chain_ctx_t           output;
  348.     ngx_chain_writer_ctx_t           writer;

  350.     ngx_http_upstream_conf_t        *conf;
  351.     ngx_http_upstream_srv_conf_t    *upstream;
  352. #if (NGX_HTTP_CACHE)
  353.     ngx_array_t                     *caches;
  354. #endif

  356.     ngx_http_upstream_headers_in_t   headers_in;

  358.     ngx_http_upstream_resolved_t    *resolved;

  360.     ngx_buf_t                        from_client;

  362.     ngx_buf_t                        buffer;
  363.     off_t                            length;
  364.     off_t                            early_hints_length;

  366.     ngx_chain_t                     *out_bufs;
  367.     ngx_chain_t                     *busy_bufs;
  368.     ngx_chain_t                     *free_bufs;

  370.     ngx_int_t                      (*input_filter_init)(void *data);
  371.     ngx_int_t                      (*input_filter)(void *data, ssize_t bytes);
  372.     void                            *input_filter_ctx;

  374. #if (NGX_HTTP_CACHE)
  375.     ngx_int_t                      (*create_key)(ngx_http_request_t *r);
  376. #endif
  377.     ngx_int_t                      (*create_request)(ngx_http_request_t *r);
  378.     ngx_int_t                      (*reinit_request)(ngx_http_request_t *r);
  379.     ngx_int_t                      (*process_header)(ngx_http_request_t *r);
  380.     void                           (*abort_request)(ngx_http_request_t *r);
  381.     void                           (*finalize_request)(ngx_http_request_t *r,
  382.                                          ngx_int_t rc);
  383.     ngx_int_t                      (*rewrite_redirect)(ngx_http_request_t *r,
  384.                                          ngx_table_elt_t *h, size_t prefix);
  385.     ngx_int_t                      (*rewrite_cookie)(ngx_http_request_t *r,
  386.                                          ngx_table_elt_t *h);

  388.     ngx_msec_t                       start_time;

  390.     ngx_http_upstream_state_t       *state;

  392.     ngx_str_t                        method;
  393.     ngx_str_t                        schema;
  394.     ngx_str_t                        uri;

  396. #if (NGX_HTTP_SSL || NGX_COMPAT)
  397.     ngx_str_t                        ssl_name;
  398.     ngx_str_t                        ssl_alpn_protocol;
  399. #endif

  401.     ngx_http_cleanup_pt             *cleanup;

  403.     unsigned                         store:1;
  404.     unsigned                         cacheable:1;
  405.     unsigned                         accel:1;
  406.     unsigned                         ssl:1;
  407. #if (NGX_HTTP_CACHE)
  408.     unsigned                         cache_status:3;
  409. #endif

  411.     unsigned                         buffering:1;
  412.     unsigned                         keepalive:1;
  413.     unsigned                         upgrade:1;
  414.     unsigned                         error:1;

  416.     unsigned                         request_sent:1;
  417.     unsigned                         request_body_sent:1;
  418.     unsigned                         request_body_blocked:1;
  419.     unsigned                         header_sent:1;
  420.     unsigned                         response_received:1;
  421. };


  424. ‌typedef struct {
  425.     ngx_uint_t                      status;
  426.     ngx_uint_t                      mask;
  427. ‌} ngx_http_upstream_next_t;


  430. ‌typedef struct {
  431.     ngx_str_t   key;
  432.     ngx_str_t   value;
  433.     ngx_uint_t  skip_empty;
  434. ‌} ngx_http_upstream_param_t;


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


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


  460. extern ngx_module_t        ngx_http_upstream_module;
  461. extern ngx_conf_bitmask_t  ngx_http_upstream_cache_method_mask[];
  462. extern ngx_conf_bitmask_t  ngx_http_upstream_ignore_headers_masks[];


  465. #endif /* _NGX_HTTP_UPSTREAM_H_INCLUDED_ */

One Level Up Top Level