One Level Up Top Level

src/http/ngx_http_upstream_round_robin.h - nginx

Data types defined

Functions defined

Macros defined

Source code


  2. /*
  3. * Copyright (C) Igor Sysoev
  4. * Copyright (C) Nginx, Inc.
  5. */


  8. #ifndef _NGX_HTTP_UPSTREAM_ROUND_ROBIN_H_INCLUDED_
  9. ‌#define _NGX_HTTP_UPSTREAM_ROUND_ROBIN_H_INCLUDED_


  12. #include <ngx_config.h>
  13. #include <ngx_core.h>
  14. #include <ngx_http.h>


  17. #if (NGX_HTTP_UPSTREAM_SID)
  18. ‌#define NGX_HTTP_UPSTREAM_SID_LEN    32  /* md5 in hex */
  19. #endif

  21. ‌#define NGX_HTTP_UPSTREAM_FAILED     1

  23. #if (NGX_HTTP_UPSTREAM_STICKY)
  24. ‌#define NGX_HTTP_UPSTREAM_DRAINING   8
  25. #endif


  28. ‌typedef struct ngx_http_upstream_rr_peers_s  ngx_http_upstream_rr_peers_t;
  29. ‌typedef struct ngx_http_upstream_rr_peer_s   ngx_http_upstream_rr_peer_t;


  32. #if (NGX_HTTP_UPSTREAM_ZONE)

  34. ‌typedef struct {
  35.     ngx_event_t                     event;         /* must be first */
  36.     ngx_uint_t                      worker;
  37.     ngx_str_t                       name;
  38.     ngx_str_t                       service;
  39.     time_t                          valid;
  40.     ngx_http_upstream_rr_peers_t   *peers;
  41.     ngx_http_upstream_rr_peer_t    *peer;
  42. ‌} ngx_http_upstream_host_t;

  44. #endif


  47. ‌struct ngx_http_upstream_rr_peer_s {
  48.     struct sockaddr                *sockaddr;
  49.     socklen_t                       socklen;
  50.     ngx_str_t                       name;
  51.     ngx_str_t                       server;

  53.     ngx_int_t                       current_weight;
  54.     ngx_int_t                       effective_weight;
  55.     ngx_int_t                       weight;

  57.     ngx_uint_t                      conns;
  58.     ngx_uint_t                      max_conns;

  60.     ngx_uint_t                      fails;
  61.     time_t                          accessed;
  62.     time_t                          checked;

  64.     ngx_uint_t                      max_fails;
  65.     time_t                          fail_timeout;
  66.     ngx_msec_t                      slow_start;
  67.     ngx_msec_t                      start_time;

  69.     ngx_uint_t                      down;

  71. #if (NGX_HTTP_SSL || NGX_COMPAT)
  72.     void                           *ssl_session;
  73.     int                             ssl_session_len;
  74. #endif

  76. #if (NGX_HTTP_UPSTREAM_SID || NGX_COMPAT)
  77.     unsigned                        route:1;
  78. #endif

  80. #if (NGX_HTTP_UPSTREAM_ZONE)
  81.     unsigned                        zombie:1;

  83.     ngx_atomic_t                    lock;
  84.     ngx_uint_t                      refs;
  85.     ngx_http_upstream_host_t       *host;
  86. #endif

  88. #if (NGX_HTTP_UPSTREAM_SID || NGX_COMPAT)
  89.     ngx_str_t                       sid;
  90. #endif

  92.     ngx_http_upstream_rr_peer_t    *next;

  94. #if (NGX_HTTP_UPSTREAM_LEAST_TIME || NGX_COMPAT)
  95.     ngx_msec_t                      header_time;
  96.     ngx_msec_t                      response_time;
  97.     ngx_msec_t                      inflight_time;
  98.     ngx_msec_t                      inflight_last;
  99.     ngx_msec_t                      inflight_reqs_changed;
  100.     ngx_uint_t                      inflight_reqs;
  101. #endif

  103.     NGX_COMPAT_BEGIN(7)
  104.     NGX_COMPAT_END
  105. };


  108. ‌struct ngx_http_upstream_rr_peers_s {
  109.     ngx_uint_t                      number;

  111. #if (NGX_HTTP_UPSTREAM_ZONE)
  112.     ngx_slab_pool_t                *shpool;
  113.     ngx_atomic_t                    rwlock;
  114.     ngx_uint_t                     *config;
  115.     ngx_http_upstream_rr_peer_t    *resolve;
  116.     ngx_http_upstream_rr_peers_t   *zone_next;
  117. #endif

  119.     ngx_uint_t                      total_weight;
  120.     ngx_uint_t                      tries;

  122.     unsigned                        single:1;
  123.     unsigned                        weighted:1;

  125.     ngx_str_t                      *name;

  127.     ngx_http_upstream_rr_peers_t   *next;

  129.     ngx_http_upstream_rr_peer_t    *peer;
  130. };


  133. #if (NGX_HTTP_UPSTREAM_ZONE)

  135. ‌#define ngx_http_upstream_rr_peers_rlock(peers)                               \
  136.                                                                               \
  137.     if (peers->shpool) {                                                      \
  138.         ngx_rwlock_rlock(&peers->rwlock);                                     \
  139.     }

  141. ‌#define ngx_http_upstream_rr_peers_wlock(peers)                               \
  142.                                                                               \
  143.     if (peers->shpool) {                                                      \
  144.         ngx_rwlock_wlock(&peers->rwlock);                                     \
  145.     }

  147. ‌#define ngx_http_upstream_rr_peers_unlock(peers)                              \
  148.                                                                               \
  149.     if (peers->shpool) {                                                      \
  150.         ngx_rwlock_unlock(&peers->rwlock);                                    \
  151.     }


  154. ‌#define ngx_http_upstream_rr_peer_lock(peers, peer)                           \
  155.                                                                               \
  156.     if (peers->shpool) {                                                      \
  157.         ngx_rwlock_wlock(&peer->lock);                                        \
  158.     }

  160. ‌#define ngx_http_upstream_rr_peer_unlock(peers, peer)                         \
  161.                                                                               \
  162.     if (peers->shpool) {                                                      \
  163.         ngx_rwlock_unlock(&peer->lock);                                       \
  164.     }


  167. ‌#define ngx_http_upstream_rr_peer_ref(peers, peer)                            \
  168.     (peer)->refs++;


  171. static ngx_inline void
  172. ‌ngx_http_upstream_rr_peer_free_locked(ngx_http_upstream_rr_peers_t *peers,
  173.     ngx_http_upstream_rr_peer_t *peer)
  174. {
  175.     if (peer->refs) {
  176.         peer->zombie = 1;
  177.         return;
  178.     }

  180.     ngx_slab_free_locked(peers->shpool, peer->sockaddr);
  181.     ngx_slab_free_locked(peers->shpool, peer->name.data);
  182. #if (NGX_HTTP_UPSTREAM_SID)
  183.     ngx_slab_free_locked(peers->shpool, peer->sid.data);
  184. #endif

  186.     if (peer->server.data) {
  187.         ngx_slab_free_locked(peers->shpool, peer->server.data);
  188.     }

  190. #if (NGX_HTTP_SSL)
  191.     if (peer->ssl_session) {
  192.         ngx_slab_free_locked(peers->shpool, peer->ssl_session);
  193.     }
  194. #endif

  196.     ngx_slab_free_locked(peers->shpool, peer);
  197. }


  200. static ngx_inline void
  201. ‌ngx_http_upstream_rr_peer_free(ngx_http_upstream_rr_peers_t *peers,
  202.     ngx_http_upstream_rr_peer_t *peer)
  203. {
  204.     ngx_shmtx_lock(&peers->shpool->mutex);
  205.     ngx_http_upstream_rr_peer_free_locked(peers, peer);
  206.     ngx_shmtx_unlock(&peers->shpool->mutex);
  207. }


  210. static ngx_inline ngx_int_t
  211. ‌ngx_http_upstream_rr_peer_unref(ngx_http_upstream_rr_peers_t *peers,
  212.     ngx_http_upstream_rr_peer_t *peer)
  213. {
  214.     peer->refs--;

  216.     if (peers->shpool == NULL) {
  217.         return NGX_OK;
  218.     }

  220.     if (peer->refs == 0 && peer->zombie) {
  221.         ngx_http_upstream_rr_peer_free(peers, peer);
  222.         return NGX_DONE;
  223.     }

  225.     return NGX_OK;
  226. }

  228. #else

  230. ‌#define ngx_http_upstream_rr_peers_rlock(peers)
  231. ‌#define ngx_http_upstream_rr_peers_wlock(peers)
  232. ‌#define ngx_http_upstream_rr_peers_unlock(peers)
  233. ‌#define ngx_http_upstream_rr_peer_lock(peers, peer)
  234. ‌#define ngx_http_upstream_rr_peer_unlock(peers, peer)
  235. ‌#define ngx_http_upstream_rr_peer_ref(peers, peer)
  236. ‌#define ngx_http_upstream_rr_peer_unref(peers, peer)  NGX_OK

  238. #endif


  241. ‌typedef struct {
  242.     ngx_uint_t                      config;
  243.     ngx_http_upstream_rr_peers_t   *peers;
  244.     ngx_http_upstream_rr_peer_t    *current;
  245.     uintptr_t                      *tried;
  246.     uintptr_t                       data;
  247. ‌} ngx_http_upstream_rr_peer_data_t;


  250. /* exponential moving average + rounding */
  251. ‌#define ngx_http_upstream_response_time_avg(avg, v)                            \
  252.     *(avg) = (*(avg) ? (0.5 + ((double) (v) * 0.05 + (double) (*(avg)) * 0.95))\
  253.                      : (v))


  256. ngx_int_t ngx_http_upstream_init_round_robin(ngx_conf_t *cf,
  257.     ngx_http_upstream_srv_conf_t *us);
  258. ngx_int_t ngx_http_upstream_init_round_robin_peer(ngx_http_request_t *r,
  259.     ngx_http_upstream_srv_conf_t *us);
  260. ngx_int_t ngx_http_upstream_create_round_robin_peer(ngx_http_request_t *r,
  261.     ngx_http_upstream_resolved_t *ur);
  262. ngx_int_t ngx_http_upstream_get_round_robin_peer(ngx_peer_connection_t *pc,
  263.     void *data);
  264. void ngx_http_upstream_free_round_robin_peer(ngx_peer_connection_t *pc,
  265.     void *data, ngx_uint_t state);
  266. void ngx_http_upstream_free_round_robin_peer_locked(ngx_peer_connection_t *pc,
  267.     void *data, ngx_uint_t state);

  269. #if (NGX_HTTP_SSL)
  270. ngx_int_t
  271.     ngx_http_upstream_set_round_robin_peer_session(ngx_peer_connection_t *pc,
  272.     void *data);
  273. void ngx_http_upstream_save_round_robin_peer_session(ngx_peer_connection_t *pc,
  274.     void *data);
  275. #endif

  277. #if (NGX_HTTP_UPSTREAM_SID)

  279. ‌#define ngx_http_upstream_copy_round_robin_sid(dst, src)                      \
  280.     ngx_http_upstream_init_round_robin_sid(dst,                               \
  281.                                            (src)->route ? &(src)->sid : NULL)

  283. void ngx_http_upstream_init_round_robin_sid(ngx_http_upstream_rr_peer_t *peer,
  284.     ngx_str_t *route);
  285. ngx_http_upstream_rr_peer_t *ngx_http_upstream_get_rr_peer_by_sid(
  286.     ngx_http_upstream_rr_peer_data_t *rrp, ngx_str_t *hint, ngx_uint_t *p,
  287.     ngx_uint_t lock);

  289. #endif


  292. #endif /* _NGX_HTTP_UPSTREAM_ROUND_ROBIN_H_INCLUDED_ */

One Level Up Top Level