One Level Up Top Level

src/stream/ngx_stream_upstream_round_robin.h - nginx-1.31.3 nginx/ @ 42f8df65b

Data types defined

Functions defined

Macros defined

Source code


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


  8. #ifndef _NGX_STREAM_UPSTREAM_ROUND_ROBIN_H_INCLUDED_
  9. ‌#define _NGX_STREAM_UPSTREAM_ROUND_ROBIN_H_INCLUDED_


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


  17. ‌#define NGX_STREAM_UPSTREAM_FAILED      1


  20. ‌typedef struct ngx_stream_upstream_rr_peers_s  ngx_stream_upstream_rr_peers_t;
  21. ‌typedef struct ngx_stream_upstream_rr_peer_s   ngx_stream_upstream_rr_peer_t;


  24. #if (NGX_STREAM_UPSTREAM_ZONE)

  26. ‌typedef struct {
  27.     ngx_event_t                      event;         /* must be first */
  28.     ngx_uint_t                       worker;
  29.     ngx_str_t                        name;
  30.     ngx_str_t                        service;
  31.     time_t                           valid;
  32.     ngx_stream_upstream_rr_peers_t  *peers;
  33.     ngx_stream_upstream_rr_peer_t   *peer;
  34. ‌} ngx_stream_upstream_host_t;

  36. #endif


  39. ‌struct ngx_stream_upstream_rr_peer_s {
  40.     struct sockaddr                 *sockaddr;
  41.     socklen_t                        socklen;
  42.     ngx_str_t                        name;
  43.     ngx_str_t                        server;

  45.     ngx_int_t                        current_weight;
  46.     ngx_int_t                        effective_weight;
  47.     ngx_int_t                        weight;

  49.     ngx_uint_t                       conns;
  50.     ngx_uint_t                       max_conns;

  52.     ngx_uint_t                       fails;
  53.     time_t                           accessed;
  54.     time_t                           checked;

  56.     ngx_uint_t                       max_fails;
  57.     time_t                           fail_timeout;
  58.     ngx_msec_t                       slow_start;
  59.     ngx_msec_t                       start_time;

  61.     ngx_uint_t                       down;

  63.     void                            *ssl_session;
  64.     int                              ssl_session_len;

  66. #if (NGX_STREAM_UPSTREAM_ZONE)
  67.     unsigned                         zombie:1;

  69.     ngx_atomic_t                     lock;
  70.     ngx_uint_t                       refs;
  71.     ngx_stream_upstream_host_t      *host;
  72. #endif

  74.     ngx_stream_upstream_rr_peer_t   *next;

  76. #if (NGX_STREAM_UPSTREAM_LEAST_TIME || NGX_COMPAT)
  77.     ngx_msec_t                       connect_time;
  78.     ngx_msec_t                       first_byte_time;
  79.     ngx_msec_t                       response_time;
  80.     ngx_msec_t                       inflight_time;
  81.     ngx_msec_t                       inflight_last;
  82.     ngx_msec_t                       inflight_reqs_changed;
  83.     ngx_uint_t                       inflight_reqs;
  84. #endif

  86.     NGX_COMPAT_BEGIN(7)
  87.     NGX_COMPAT_END
  88. };


  91. ‌struct ngx_stream_upstream_rr_peers_s {
  92.     ngx_uint_t                       number;

  94. #if (NGX_STREAM_UPSTREAM_ZONE)
  95.     ngx_slab_pool_t                 *shpool;
  96.     ngx_atomic_t                     rwlock;
  97.     ngx_uint_t                      *config;
  98.     ngx_stream_upstream_rr_peer_t   *resolve;
  99.     ngx_stream_upstream_rr_peers_t  *zone_next;
  100. #endif

  102.     ngx_uint_t                       total_weight;
  103.     ngx_uint_t                       tries;

  105.     unsigned                         single:1;
  106.     unsigned                         weighted:1;

  108.     ngx_str_t                       *name;

  110.     ngx_stream_upstream_rr_peers_t  *next;

  112.     ngx_stream_upstream_rr_peer_t   *peer;
  113. };


  116. #if (NGX_STREAM_UPSTREAM_ZONE)

  118. ‌#define ngx_stream_upstream_rr_peers_rlock(peers)                             \
  119.                                                                               \
  120.     if (peers->shpool) {                                                      \
  121.         ngx_rwlock_rlock(&peers->rwlock);                                     \
  122.     }

  124. ‌#define ngx_stream_upstream_rr_peers_wlock(peers)                             \
  125.                                                                               \
  126.     if (peers->shpool) {                                                      \
  127.         ngx_rwlock_wlock(&peers->rwlock);                                     \
  128.     }

  130. ‌#define ngx_stream_upstream_rr_peers_unlock(peers)                            \
  131.                                                                               \
  132.     if (peers->shpool) {                                                      \
  133.         ngx_rwlock_unlock(&peers->rwlock);                                    \
  134.     }


  137. ‌#define ngx_stream_upstream_rr_peer_lock(peers, peer)                         \
  138.                                                                               \
  139.     if (peers->shpool) {                                                      \
  140.         ngx_rwlock_wlock(&peer->lock);                                        \
  141.     }

  143. ‌#define ngx_stream_upstream_rr_peer_unlock(peers, peer)                       \
  144.                                                                               \
  145.     if (peers->shpool) {                                                      \
  146.         ngx_rwlock_unlock(&peer->lock);                                       \
  147.     }


  150. ‌#define ngx_stream_upstream_rr_peer_ref(peers, peer)                          \
  151.     (peer)->refs++;


  154. static ngx_inline void
  155. ‌ngx_stream_upstream_rr_peer_free_locked(ngx_stream_upstream_rr_peers_t *peers,
  156.     ngx_stream_upstream_rr_peer_t *peer)
  157. {
  158.     if (peer->refs) {
  159.         peer->zombie = 1;
  160.         return;
  161.     }

  163.     ngx_slab_free_locked(peers->shpool, peer->sockaddr);
  164.     ngx_slab_free_locked(peers->shpool, peer->name.data);

  166.     if (peer->server.data) {
  167.         ngx_slab_free_locked(peers->shpool, peer->server.data);
  168.     }

  170. #if (NGX_STREAM_SSL)
  171.     if (peer->ssl_session) {
  172.         ngx_slab_free_locked(peers->shpool, peer->ssl_session);
  173.     }
  174. #endif

  176.     ngx_slab_free_locked(peers->shpool, peer);
  177. }


  180. static ngx_inline void
  181. ‌ngx_stream_upstream_rr_peer_free(ngx_stream_upstream_rr_peers_t *peers,
  182.     ngx_stream_upstream_rr_peer_t *peer)
  183. {
  184.     ngx_shmtx_lock(&peers->shpool->mutex);
  185.     ngx_stream_upstream_rr_peer_free_locked(peers, peer);
  186.     ngx_shmtx_unlock(&peers->shpool->mutex);
  187. }


  190. static ngx_inline ngx_int_t
  191. ‌ngx_stream_upstream_rr_peer_unref(ngx_stream_upstream_rr_peers_t *peers,
  192.     ngx_stream_upstream_rr_peer_t *peer)
  193. {
  194.     peer->refs--;

  196.     if (peers->shpool == NULL) {
  197.         return NGX_OK;
  198.     }

  200.     if (peer->refs == 0 && peer->zombie) {
  201.         ngx_stream_upstream_rr_peer_free(peers, peer);
  202.         return NGX_DONE;
  203.     }

  205.     return NGX_OK;
  206. }

  208. #else

  210. ‌#define ngx_stream_upstream_rr_peers_rlock(peers)
  211. ‌#define ngx_stream_upstream_rr_peers_wlock(peers)
  212. ‌#define ngx_stream_upstream_rr_peers_unlock(peers)
  213. ‌#define ngx_stream_upstream_rr_peer_lock(peers, peer)
  214. ‌#define ngx_stream_upstream_rr_peer_unlock(peers, peer)
  215. ‌#define ngx_stream_upstream_rr_peer_ref(peers, peer)
  216. ‌#define ngx_stream_upstream_rr_peer_unref(peers, peer)  NGX_OK

  218. #endif


  221. ‌typedef struct {
  222.     ngx_uint_t                       config;
  223.     ngx_stream_upstream_rr_peers_t  *peers;
  224.     ngx_stream_upstream_rr_peer_t   *current;
  225.     uintptr_t                       *tried;
  226.     uintptr_t                        data;
  227. ‌} ngx_stream_upstream_rr_peer_data_t;


  230. /* exponential moving average + rounding */
  231. ‌#define ngx_stream_upstream_response_time_avg(avg, v)                          \
  232.     *(avg) = (*(avg) ? (0.5 + ((double) (v) * 0.05 + (double) (*(avg)) * 0.95))\
  233.                      : (v))


  236. ngx_int_t ngx_stream_upstream_init_round_robin(ngx_conf_t *cf,
  237.     ngx_stream_upstream_srv_conf_t *us);
  238. ngx_int_t ngx_stream_upstream_init_round_robin_peer(ngx_stream_session_t *s,
  239.     ngx_stream_upstream_srv_conf_t *us);
  240. ngx_int_t ngx_stream_upstream_create_round_robin_peer(ngx_stream_session_t *s,
  241.     ngx_stream_upstream_resolved_t *ur);
  242. ngx_int_t ngx_stream_upstream_get_round_robin_peer(ngx_peer_connection_t *pc,
  243.     void *data);
  244. void ngx_stream_upstream_free_round_robin_peer(ngx_peer_connection_t *pc,
  245.     void *data, ngx_uint_t state);
  246. void ngx_stream_upstream_free_round_robin_peer_locked(ngx_peer_connection_t *pc,
  247.     void *data, ngx_uint_t state);
  248. void ngx_stream_upstream_notify_round_robin_peer_locked(
  249.     ngx_peer_connection_t *pc, void *data, ngx_uint_t type);


  252. #endif /* _NGX_STREAM_UPSTREAM_ROUND_ROBIN_H_INCLUDED_ */

One Level Up Top Level