One Level Up Top Level

src/http/modules/ngx_http_upstream_ip_hash_module.c - nginx source code

Global variables defined

Data types defined

Functions defined

Source code


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


  8. #include <ngx_config.h>
  9. #include <ngx_core.h>
  10. #include <ngx_http.h>


  13. ‌typedef struct {
  14.     /* the round robin data must be first */
  15.     ngx_http_upstream_rr_peer_data_t   rrp;

  17.     ngx_uint_t                         hash;

  19.     u_char                             addrlen;
  20.     u_char                            *addr;

  22.     u_char                             tries;

  24.     ngx_event_get_peer_pt              get_rr_peer;
  25. ‌} ngx_http_upstream_ip_hash_peer_data_t;


  28. static ngx_int_t ngx_http_upstream_init_ip_hash_peer(ngx_http_request_t *r,
  29.     ngx_http_upstream_srv_conf_t *us);
  30. static ngx_int_t ngx_http_upstream_get_ip_hash_peer(ngx_peer_connection_t *pc,
  31.     void *data);
  32. static char *ngx_http_upstream_ip_hash(ngx_conf_t *cf, ngx_command_t *cmd,
  33.     void *conf);


  36. ‌static ngx_command_t  ngx_http_upstream_ip_hash_commands[] = {

  38.     { ngx_string("ip_hash"),
  39.       NGX_HTTP_UPS_CONF|NGX_CONF_NOARGS,
  40.       ngx_http_upstream_ip_hash,
  41.       0,
  42.       0,
  43.       NULL },

  45.       ngx_null_command
  46. };


  49. ‌static ngx_http_module_t  ngx_http_upstream_ip_hash_module_ctx = {
  50.     NULL,                                  /* preconfiguration */
  51.     NULL,                                  /* postconfiguration */

  53.     NULL,                                  /* create main configuration */
  54.     NULL,                                  /* init main configuration */

  56.     NULL,                                  /* create server configuration */
  57.     NULL,                                  /* merge server configuration */

  59.     NULL,                                  /* create location configuration */
  60.     NULL                                   /* merge location configuration */
  61. };


  64. ‌ngx_module_t  ngx_http_upstream_ip_hash_module = {
  65.     NGX_MODULE_V1,
  66.     &ngx_http_upstream_ip_hash_module_ctx, /* module context */
  67.     ngx_http_upstream_ip_hash_commands,    /* module directives */
  68.     NGX_HTTP_MODULE,                       /* module type */
  69.     NULL,                                  /* init master */
  70.     NULL,                                  /* init module */
  71.     NULL,                                  /* init process */
  72.     NULL,                                  /* init thread */
  73.     NULL,                                  /* exit thread */
  74.     NULL,                                  /* exit process */
  75.     NULL,                                  /* exit master */
  76.     NGX_MODULE_V1_PADDING
  77. };


  80. ‌static u_char ngx_http_upstream_ip_hash_pseudo_addr[3];


  83. static ngx_int_t
  84. ‌ngx_http_upstream_init_ip_hash(ngx_conf_t *cf, ngx_http_upstream_srv_conf_t *us)
  85. {
  86.     if (ngx_http_upstream_init_round_robin(cf, us) != NGX_OK) {
  87.         return NGX_ERROR;
  88.     }

  90.     us->peer.init = ngx_http_upstream_init_ip_hash_peer;

  92.     return NGX_OK;
  93. }


  96. static ngx_int_t
  97. ‌ngx_http_upstream_init_ip_hash_peer(ngx_http_request_t *r,
  98.     ngx_http_upstream_srv_conf_t *us)
  99. {
  100.     struct sockaddr_in                     *sin;
  101. #if (NGX_HAVE_INET6)
  102.     struct sockaddr_in6                    *sin6;
  103. #endif
  104.     ngx_http_upstream_ip_hash_peer_data_t  *iphp;

  106.     iphp = ngx_palloc(r->pool, sizeof(ngx_http_upstream_ip_hash_peer_data_t));
  107.     if (iphp == NULL) {
  108.         return NGX_ERROR;
  109.     }

  111.     r->upstream->peer.data = &iphp->rrp;

  113.     if (ngx_http_upstream_init_round_robin_peer(r, us) != NGX_OK) {
  114.         return NGX_ERROR;
  115.     }

  117.     r->upstream->peer.get = ngx_http_upstream_get_ip_hash_peer;

  119.     switch (r->connection->sockaddr->sa_family) {

  121.     case AF_INET:
  122.         sin = (struct sockaddr_in *) r->connection->sockaddr;
  123.         iphp->addr = (u_char *) &sin->sin_addr.s_addr;
  124.         iphp->addrlen = 3;
  125.         break;

  127. #if (NGX_HAVE_INET6)
  128.     case AF_INET6:
  129.         sin6 = (struct sockaddr_in6 *) r->connection->sockaddr;
  130.         iphp->addr = (u_char *) &sin6->sin6_addr.s6_addr;
  131.         iphp->addrlen = 16;
  132.         break;
  133. #endif

  135.     default:
  136.         iphp->addr = ngx_http_upstream_ip_hash_pseudo_addr;
  137.         iphp->addrlen = 3;
  138.     }

  140.     iphp->hash = 89;
  141.     iphp->tries = 0;
  142.     iphp->get_rr_peer = ngx_http_upstream_get_round_robin_peer;

  144.     return NGX_OK;
  145. }


  148. static ngx_int_t
  149. ‌ngx_http_upstream_get_ip_hash_peer(ngx_peer_connection_t *pc, void *data)
  150. {
  151.     ngx_http_upstream_ip_hash_peer_data_t  *iphp = data;

  153.     time_t                        now;
  154.     ngx_int_t                     w;
  155.     uintptr_t                     m;
  156.     ngx_uint_t                    i, n, p, hash;
  157.     ngx_http_upstream_rr_peer_t  *peer;

  159.     ngx_log_debug1(NGX_LOG_DEBUG_HTTP, pc->log, 0,
  160.                    "get ip hash peer, try: %ui", pc->tries);

  162.     /* TODO: cached */

  164.     ngx_http_upstream_rr_peers_rlock(iphp->rrp.peers);

  166.     if (iphp->tries > 20 || iphp->rrp.peers->number < 2) {
  167.         ngx_http_upstream_rr_peers_unlock(iphp->rrp.peers);
  168.         return iphp->get_rr_peer(pc, &iphp->rrp);
  169.     }

  171. #if (NGX_HTTP_UPSTREAM_ZONE)
  172.     if (iphp->rrp.peers->config && iphp->rrp.config != *iphp->rrp.peers->config)
  173.     {
  174.         ngx_http_upstream_rr_peers_unlock(iphp->rrp.peers);
  175.         return iphp->get_rr_peer(pc, &iphp->rrp);
  176.     }
  177. #endif

  179.     now = ngx_time();

  181.     pc->cached = 0;
  182.     pc->connection = NULL;

  184.     hash = iphp->hash;

  186.     for ( ;; ) {

  188.         for (i = 0; i < (ngx_uint_t) iphp->addrlen; i++) {
  189.             hash = (hash * 113 + iphp->addr[i]) % 6271;
  190.         }

  192.         w = hash % iphp->rrp.peers->total_weight;
  193.         peer = iphp->rrp.peers->peer;
  194.         p = 0;

  196.         while (w >= peer->weight) {
  197.             w -= peer->weight;
  198.             peer = peer->next;
  199.             p++;
  200.         }

  202.         n = p / (8 * sizeof(uintptr_t));
  203.         m = (uintptr_t) 1 << p % (8 * sizeof(uintptr_t));

  205.         if (iphp->rrp.tried[n] & m) {
  206.             goto next;
  207.         }

  209.         ngx_log_debug2(NGX_LOG_DEBUG_HTTP, pc->log, 0,
  210.                        "get ip hash peer, hash: %ui %04XL", p, (uint64_t) m);

  212.         ngx_http_upstream_rr_peer_lock(iphp->rrp.peers, peer);

  214.         if (peer->down) {
  215.             ngx_http_upstream_rr_peer_unlock(iphp->rrp.peers, peer);
  216.             goto next;
  217.         }

  219.         if (peer->max_fails
  220.             && peer->fails >= peer->max_fails
  221.             && now - peer->checked <= peer->fail_timeout)
  222.         {
  223.             ngx_http_upstream_rr_peer_unlock(iphp->rrp.peers, peer);
  224.             goto next;
  225.         }

  227.         if (peer->max_conns && peer->conns >= peer->max_conns) {
  228.             ngx_http_upstream_rr_peer_unlock(iphp->rrp.peers, peer);
  229.             goto next;
  230.         }

  232.         break;

  234.     next:

  236.         if (++iphp->tries > 20) {
  237.             ngx_http_upstream_rr_peers_unlock(iphp->rrp.peers);
  238.             return iphp->get_rr_peer(pc, &iphp->rrp);
  239.         }
  240.     }

  242.     iphp->rrp.current = peer;
  243.     ngx_http_upstream_rr_peer_ref(iphp->rrp.peers, peer);

  245.     pc->sockaddr = peer->sockaddr;
  246.     pc->socklen = peer->socklen;
  247.     pc->name = &peer->name;

  249.     peer->conns++;

  251.     if (now - peer->checked > peer->fail_timeout) {
  252.         peer->checked = now;
  253.     }

  255.     ngx_http_upstream_rr_peer_unlock(iphp->rrp.peers, peer);
  256.     ngx_http_upstream_rr_peers_unlock(iphp->rrp.peers);

  258.     iphp->rrp.tried[n] |= m;
  259.     iphp->hash = hash;

  261.     return NGX_OK;
  262. }


  265. static char *
  266. ‌ngx_http_upstream_ip_hash(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
  267. {
  268.     ngx_http_upstream_srv_conf_t  *uscf;

  270.     uscf = ngx_http_conf_get_module_srv_conf(cf, ngx_http_upstream_module);

  272.     if (uscf->peer.init_upstream) {
  273.         ngx_conf_log_error(NGX_LOG_WARN, cf, 0,
  274.                            "load balancing method redefined");
  275.     }

  277.     uscf->peer.init_upstream = ngx_http_upstream_init_ip_hash;

  279.     uscf->flags = NGX_HTTP_UPSTREAM_CREATE
  280.                   |NGX_HTTP_UPSTREAM_MODIFY
  281.                   |NGX_HTTP_UPSTREAM_WEIGHT
  282.                   |NGX_HTTP_UPSTREAM_MAX_CONNS
  283.                   |NGX_HTTP_UPSTREAM_MAX_FAILS
  284.                   |NGX_HTTP_UPSTREAM_FAIL_TIMEOUT
  285.                   |NGX_HTTP_UPSTREAM_DOWN;

  287.     return NGX_CONF_OK;
  288. }

One Level Up Top Level