net/netfilter/ipvs/ip_vs_lblc.c

   1 /*
   2  * IPVS:        Locality-Based Least-Connection scheduling module
   3  *
   4  * Authors:     Wensong Zhang <wensong@gnuchina.org>
   5  *
   6  *              This program is free software; you can redistribute it and/or
   7  *              modify it under the terms of the GNU General Public License
   8  *              as published by the Free Software Foundation; either version
   9  *              2 of the License, or (at your option) any later version.
  10  *
  11  * Changes:
  12  *     Martin Hamilton         :    fixed the terrible locking bugs
  13  *                                   *lock(tbl->lock) ==> *lock(&tbl->lock)
  14  *     Wensong Zhang           :    fixed the uninitilized tbl->lock bug
  15  *     Wensong Zhang           :    added doing full expiration check to
  16  *                                   collect stale entries of 24+ hours when
  17  *                                   no partial expire check in a half hour
  18  *     Julian Anastasov        :    replaced del_timer call with del_timer_sync
  19  *                                   to avoid the possible race between timer
  20  *                                   handler and del_timer thread in SMP
  21  *
  22  */
  23
  24 /*
  25  * The lblc algorithm is as follows (pseudo code):
  26  *
  27  *       if cachenode[dest_ip] is null then
  28  *               n, cachenode[dest_ip] <- {weighted least-conn node};
  29  *       else
  30  *               n <- cachenode[dest_ip];
  31  *               if (n is dead) OR
  32  *                  (n.conns>n.weight AND
  33  *                   there is a node m with m.conns<m.weight/2) then
  34  *                 n, cachenode[dest_ip] <- {weighted least-conn node};
  35  *
  36  *       return n;
  37  *
  38  * Thanks must go to Wenzhuo Zhang for talking WCCP to me and pushing
  39  * me to write this module.
  40  */
  41
  42 #include <linux/ip.h>
  43 #include <linux/module.h>
  44 #include <linux/kernel.h>
  45 #include <linux/skbuff.h>
  46 #include <linux/jiffies.h>
  47
  48 /* for sysctl */
  49 #include <linux/fs.h>
  50 #include <linux/sysctl.h>
  51
  52 #include <net/ip_vs.h>
  53
  54
  55 /*
  56  *    It is for garbage collection of stale IPVS lblc entries,
  57  *    when the table is full.
  58  */
  59 #define CHECK_EXPIRE_INTERVAL   (60*HZ)
  60 #define ENTRY_TIMEOUT           (6*60*HZ)
  61
  62 /*
  63  *    It is for full expiration check.
  64  *    When there is no partial expiration check (garbage collection)
  65  *    in a half hour, do a full expiration check to collect stale
  66  *    entries that haven't been touched for a day.
  67  */
  68 #define COUNT_FOR_FULL_EXPIRATION   30
  69 static int sysctl_ip_vs_lblc_expiration = 24*60*60*HZ;
  70
  71
  72 /*
  73  *     for IPVS lblc entry hash table
  74  */
  75 #ifndef CONFIG_IP_VS_LBLC_TAB_BITS
  76 #define CONFIG_IP_VS_LBLC_TAB_BITS      10
  77 #endif
  78 #define IP_VS_LBLC_TAB_BITS     CONFIG_IP_VS_LBLC_TAB_BITS
  79 #define IP_VS_LBLC_TAB_SIZE     (1 << IP_VS_LBLC_TAB_BITS)
  80 #define IP_VS_LBLC_TAB_MASK     (IP_VS_LBLC_TAB_SIZE - 1)
  81
  82
  83 /*
  84  *      IPVS lblc entry represents an association between destination
  85  *      IP address and its destination server
  86  */
  87 struct ip_vs_lblc_entry {
  88         struct list_head        list;
  89         __be32                  addr;           /* destination IP address */
  90         struct ip_vs_dest       *dest;          /* real server (cache) */
  91         unsigned long           lastuse;        /* last used time */
  92 };
  93
  94
  95 /*
  96  *      IPVS lblc hash table
  97  */
  98 struct ip_vs_lblc_table {
  99         struct list_head        bucket[IP_VS_LBLC_TAB_SIZE];  /* hash bucket */
 100         atomic_t                entries;        /* number of entries */
 101         int                     max_size;       /* maximum size of entries */
 102         struct timer_list       periodic_timer; /* collect stale entries */
 103         int                     rover;          /* rover for expire check */
 104         int                     counter;        /* counter for no expire */
 105 };
 106
 107
 108 /*
 109  *      IPVS LBLC sysctl table
 110  */
 111
 112 static ctl_table vs_vars_table[] = {
 113         {
 114                 .procname       = "lblc_expiration",
 115                 .data           = &sysctl_ip_vs_lblc_expiration,
 116                 .maxlen         = sizeof(int),
 117                 .mode           = 0644,
 118                 .proc_handler   = &proc_dointvec_jiffies,
 119         },
 120         { .ctl_name = 0 }
 121 };
 122
 123 static struct ctl_table_header * sysctl_header;
 124
 125 static inline void ip_vs_lblc_free(struct ip_vs_lblc_entry *en)
 126 {
 127         list_del(&en->list);
 128         /*
 129          * We don't kfree dest because it is refered either by its service
 130          * or the trash dest list.
 131          */
 132         atomic_dec(&en->dest->refcnt);
 133         kfree(en);
 134 }
 135
 136
 137 /*
 138  *      Returns hash value for IPVS LBLC entry
 139  */
 140 static inline unsigned ip_vs_lblc_hashkey(__be32 addr)
 141 {
 142         return (ntohl(addr)*2654435761UL) & IP_VS_LBLC_TAB_MASK;
 143 }
 144
 145
 146 /*
 147  *      Hash an entry in the ip_vs_lblc_table.
 148  *      returns bool success.
 149  */
 150 static void
 151 ip_vs_lblc_hash(struct ip_vs_lblc_table *tbl, struct ip_vs_lblc_entry *en)
 152 {
 153         unsigned hash = ip_vs_lblc_hashkey(en->addr);
 154
 155         list_add(&en->list, &tbl->bucket[hash]);
 156         atomic_inc(&tbl->entries);
 157 }
 158
 159
 160 /*
 161  *  Get ip_vs_lblc_entry associated with supplied parameters. Called under read
 162  *  lock
 163  */
 164 static inline struct ip_vs_lblc_entry *
 165 ip_vs_lblc_get(struct ip_vs_lblc_table *tbl, __be32 addr)
 166 {
 167         unsigned hash = ip_vs_lblc_hashkey(addr);
 168         struct ip_vs_lblc_entry *en;
 169
 170         list_for_each_entry(en, &tbl->bucket[hash], list)
 171                 if (en->addr == addr)
 172                         return en;
 173
 174         return NULL;
 175 }
 176
 177
 178 /*
 179  * Create or update an ip_vs_lblc_entry, which is a mapping of a destination IP
 180  * address to a server. Called under write lock.
 181  */
 182 static inline struct ip_vs_lblc_entry *
 183 ip_vs_lblc_new(struct ip_vs_lblc_table *tbl, __be32 daddr,
 184                struct ip_vs_dest *dest)
 185 {
 186         struct ip_vs_lblc_entry *en;
 187
 188         en = ip_vs_lblc_get(tbl, daddr);
 189         if (!en) {
 190                 en = kmalloc(sizeof(*en), GFP_ATOMIC);
 191                 if (!en) {
 192                         IP_VS_ERR("ip_vs_lblc_new(): no memory\n");
 193                         return NULL;
 194                 }
 195
 196                 en->addr = daddr;
 197                 en->lastuse = jiffies;
 198
 199                 atomic_inc(&dest->refcnt);
 200                 en->dest = dest;
 201
 202                 ip_vs_lblc_hash(tbl, en);
 203         } else if (en->dest != dest) {
 204                 atomic_dec(&en->dest->refcnt);
 205                 atomic_inc(&dest->refcnt);
 206                 en->dest = dest;
 207         }
 208
 209         return en;
 210 }
 211
 212
 213 /*
 214  *      Flush all the entries of the specified table.
 215  */
 216 static void ip_vs_lblc_flush(struct ip_vs_lblc_table *tbl)
 217 {
 218         struct ip_vs_lblc_entry *en, *nxt;
 219         int i;
 220
 221         for (i=0; i<IP_VS_LBLC_TAB_SIZE; i++) {
 222                 list_for_each_entry_safe(en, nxt, &tbl->bucket[i], list) {
 223                         ip_vs_lblc_free(en);
 224                         atomic_dec(&tbl->entries);
 225                 }
 226         }
 227 }
 228
 229
 230 static inline void ip_vs_lblc_full_check(struct ip_vs_service *svc)
 231 {
 232         struct ip_vs_lblc_table *tbl = svc->sched_data;
 233         struct ip_vs_lblc_entry *en, *nxt;
 234         unsigned long now = jiffies;
 235         int i, j;
 236
 237         for (i=0, j=tbl->rover; i<IP_VS_LBLC_TAB_SIZE; i++) {
 238                 j = (j + 1) & IP_VS_LBLC_TAB_MASK;
 239
 240                 write_lock(&svc->sched_lock);
 241                 list_for_each_entry_safe(en, nxt, &tbl->bucket[j], list) {
 242                         if (time_before(now,
 243                                         en->lastuse + sysctl_ip_vs_lblc_expiration))
 244                                 continue;
 245
 246                         ip_vs_lblc_free(en);
 247                         atomic_dec(&tbl->entries);
 248                 }
 249                 write_unlock(&svc->sched_lock);
 250         }
 251         tbl->rover = j;
 252 }
 253
 254
 255 /*
 256  *      Periodical timer handler for IPVS lblc table
 257  *      It is used to collect stale entries when the number of entries
 258  *      exceeds the maximum size of the table.
 259  *
 260  *      Fixme: we probably need more complicated algorithm to collect
 261  *             entries that have not been used for a long time even
 262  *             if the number of entries doesn't exceed the maximum size
 263  *             of the table.
 264  *      The full expiration check is for this purpose now.
 265  */
 266 static void ip_vs_lblc_check_expire(unsigned long data)
 267 {
 268         struct ip_vs_service *svc = (struct ip_vs_service *) data;
 269         struct ip_vs_lblc_table *tbl = svc->sched_data;
 270         unsigned long now = jiffies;
 271         int goal;
 272         int i, j;
 273         struct ip_vs_lblc_entry *en, *nxt;
 274
 275         if ((tbl->counter % COUNT_FOR_FULL_EXPIRATION) == 0) {
 276                 /* do full expiration check */
 277                 ip_vs_lblc_full_check(svc);
 278                 tbl->counter = 1;
 279                 goto out;
 280         }
 281
 282         if (atomic_read(&tbl->entries) <= tbl->max_size) {
 283                 tbl->counter++;
 284                 goto out;
 285         }
 286
 287         goal = (atomic_read(&tbl->entries) - tbl->max_size)*4/3;
 288         if (goal > tbl->max_size/2)
 289                 goal = tbl->max_size/2;
 290
 291         for (i=0, j=tbl->rover; i<IP_VS_LBLC_TAB_SIZE; i++) {
 292                 j = (j + 1) & IP_VS_LBLC_TAB_MASK;
 293
 294                 write_lock(&svc->sched_lock);
 295                 list_for_each_entry_safe(en, nxt, &tbl->bucket[j], list) {
 296                         if (time_before(now, en->lastuse + ENTRY_TIMEOUT))
 297                                 continue;
 298
 299                         ip_vs_lblc_free(en);
 300                         atomic_dec(&tbl->entries);
 301                         goal--;
 302                 }
 303                 write_unlock(&svc->sched_lock);
 304                 if (goal <= 0)
 305                         break;
 306         }
 307         tbl->rover = j;
 308
 309   out:
 310         mod_timer(&tbl->periodic_timer, jiffies+CHECK_EXPIRE_INTERVAL);
 311 }
 312
 313
 314 static int ip_vs_lblc_init_svc(struct ip_vs_service *svc)
 315 {
 316         int i;
 317         struct ip_vs_lblc_table *tbl;
 318
 319         /*
 320          *    Allocate the ip_vs_lblc_table for this service
 321          */
 322         tbl = kmalloc(sizeof(*tbl), GFP_ATOMIC);
 323         if (tbl == NULL) {
 324                 IP_VS_ERR("ip_vs_lblc_init_svc(): no memory\n");
 325                 return -ENOMEM;
 326         }
 327         svc->sched_data = tbl;
 328         IP_VS_DBG(6, "LBLC hash table (memory=%Zdbytes) allocated for "
 329                   "current service\n", sizeof(*tbl));
 330
 331         /*
 332          *    Initialize the hash buckets
 333          */
 334         for (i=0; i<IP_VS_LBLC_TAB_SIZE; i++) {
 335                 INIT_LIST_HEAD(&tbl->bucket[i]);
 336         }
 337         tbl->max_size = IP_VS_LBLC_TAB_SIZE*16;
 338         tbl->rover = 0;
 339         tbl->counter = 1;
 340
 341         /*
 342          *    Hook periodic timer for garbage collection
 343          */
 344         setup_timer(&tbl->periodic_timer, ip_vs_lblc_check_expire,
 345                         (unsigned long)svc);
 346         mod_timer(&tbl->periodic_timer, jiffies + CHECK_EXPIRE_INTERVAL);
 347
 348         return 0;
 349 }
 350
 351
 352 static int ip_vs_lblc_done_svc(struct ip_vs_service *svc)
 353 {
 354         struct ip_vs_lblc_table *tbl = svc->sched_data;
 355
 356         /* remove periodic timer */
 357         del_timer_sync(&tbl->periodic_timer);
 358
 359         /* got to clean up table entries here */
 360         ip_vs_lblc_flush(tbl);
 361
 362         /* release the table itself */
 363         kfree(tbl);
 364         IP_VS_DBG(6, "LBLC hash table (memory=%Zdbytes) released\n",
 365                   sizeof(*tbl));
 366
 367         return 0;
 368 }
 369
 370
 371 static inline struct ip_vs_dest *
 372 __ip_vs_lblc_schedule(struct ip_vs_service *svc, struct iphdr *iph)
 373 {
 374         struct ip_vs_dest *dest, *least;
 375         int loh, doh;
 376
 377         /*
 378          * We think the overhead of processing active connections is fifty
 379          * times higher than that of inactive connections in average. (This
 380          * fifty times might not be accurate, we will change it later.) We
 381          * use the following formula to estimate the overhead:
 382          *                dest->activeconns*50 + dest->inactconns
 383          * and the load:
 384          *                (dest overhead) / dest->weight
 385          *
 386          * Remember -- no floats in kernel mode!!!
 387          * The comparison of h1*w2 > h2*w1 is equivalent to that of
 388          *                h1/w1 > h2/w2
 389          * if every weight is larger than zero.
 390          *
 391          * The server with weight=0 is quiesced and will not receive any
 392          * new connection.
 393          */
 394         list_for_each_entry(dest, &svc->destinations, n_list) {
 395                 if (dest->flags & IP_VS_DEST_F_OVERLOAD)
 396                         continue;
 397                 if (atomic_read(&dest->weight) > 0) {
 398                         least = dest;
 399                         loh = atomic_read(&least->activeconns) * 50
 400                                 + atomic_read(&least->inactconns);
 401                         goto nextstage;
 402                 }
 403         }
 404         return NULL;
 405
 406         /*
 407          *    Find the destination with the least load.
 408          */
 409   nextstage:
 410         list_for_each_entry_continue(dest, &svc->destinations, n_list) {
 411                 if (dest->flags & IP_VS_DEST_F_OVERLOAD)
 412                         continue;
 413
 414                 doh = atomic_read(&dest->activeconns) * 50
 415                         + atomic_read(&dest->inactconns);
 416                 if (loh * atomic_read(&dest->weight) >
 417                     doh * atomic_read(&least->weight)) {
 418                         least = dest;
 419                         loh = doh;
 420                 }
 421         }
 422
 423         IP_VS_DBG(6, "LBLC: server %d.%d.%d.%d:%d "
 424                   "activeconns %d refcnt %d weight %d overhead %d\n",
 425                   NIPQUAD(least->addr.ip), ntohs(least->port),
 426                   atomic_read(&least->activeconns),
 427                   atomic_read(&least->refcnt),
 428                   atomic_read(&least->weight), loh);
 429
 430         return least;
 431 }
 432
 433
 434 /*
 435  *   If this destination server is overloaded and there is a less loaded
 436  *   server, then return true.
 437  */
 438 static inline int
 439 is_overloaded(struct ip_vs_dest *dest, struct ip_vs_service *svc)
 440 {
 441         if (atomic_read(&dest->activeconns) > atomic_read(&dest->weight)) {
 442                 struct ip_vs_dest *d;
 443
 444                 list_for_each_entry(d, &svc->destinations, n_list) {
 445                         if (atomic_read(&d->activeconns)*2
 446                             < atomic_read(&d->weight)) {
 447                                 return 1;
 448                         }
 449                 }
 450         }
 451         return 0;
 452 }
 453
 454
 455 /*
 456  *    Locality-Based (weighted) Least-Connection scheduling
 457  */
 458 static struct ip_vs_dest *
 459 ip_vs_lblc_schedule(struct ip_vs_service *svc, const struct sk_buff *skb)
 460 {
 461         struct ip_vs_lblc_table *tbl = svc->sched_data;
 462         struct iphdr *iph = ip_hdr(skb);
 463         struct ip_vs_dest *dest = NULL;
 464         struct ip_vs_lblc_entry *en;
 465
 466         IP_VS_DBG(6, "ip_vs_lblc_schedule(): Scheduling...\n");
 467
 468         /* First look in our cache */
 469         read_lock(&svc->sched_lock);
 470         en = ip_vs_lblc_get(tbl, iph->daddr);
 471         if (en) {
 472                 /* We only hold a read lock, but this is atomic */
 473                 en->lastuse = jiffies;
 474
 475                 /*
 476                  * If the destination is not available, i.e. it's in the trash,
 477                  * we must ignore it, as it may be removed from under our feet,
 478                  * if someone drops our reference count. Our caller only makes
 479                  * sure that destinations, that are not in the trash, are not
 480                  * moved to the trash, while we are scheduling. But anyone can
 481                  * free up entries from the trash at any time.
 482                  */
 483
 484                 if (en->dest->flags & IP_VS_DEST_F_AVAILABLE)
 485                         dest = en->dest;
 486         }
 487         read_unlock(&svc->sched_lock);
 488
 489         /* If the destination has a weight and is not overloaded, use it */
 490         if (dest && atomic_read(&dest->weight) > 0 && !is_overloaded(dest, svc))
 491                 goto out;
 492
 493         /* No cache entry or it is invalid, time to schedule */
 494         dest = __ip_vs_lblc_schedule(svc, iph);
 495         if (!dest) {
 496                 IP_VS_DBG(1, "no destination available\n");
 497                 return NULL;
 498         }
 499
 500         /* If we fail to create a cache entry, we'll just use the valid dest */
 501         write_lock(&svc->sched_lock);
 502         ip_vs_lblc_new(tbl, iph->daddr, dest);
 503         write_unlock(&svc->sched_lock);
 504
 505 out:
 506         IP_VS_DBG(6, "LBLC: destination IP address %u.%u.%u.%u "
 507                   "--> server %u.%u.%u.%u:%d\n",
 508                   NIPQUAD(iph->daddr),
 509                   NIPQUAD(dest->addr.ip),
 510                   ntohs(dest->port));
 511
 512         return dest;
 513 }
 514
 515
 516 /*
 517  *      IPVS LBLC Scheduler structure
 518  */
 519 static struct ip_vs_scheduler ip_vs_lblc_scheduler =
 520 {
 521         .name =                 "lblc",
 522         .refcnt =               ATOMIC_INIT(0),
 523         .module =               THIS_MODULE,
 524         .n_list =               LIST_HEAD_INIT(ip_vs_lblc_scheduler.n_list),
 525 #ifdef CONFIG_IP_VS_IPV6
 526         .supports_ipv6 =        0,
 527 #endif
 528         .init_service =         ip_vs_lblc_init_svc,
 529         .done_service =         ip_vs_lblc_done_svc,
 530         .schedule =             ip_vs_lblc_schedule,
 531 };
 532
 533
 534 static int __init ip_vs_lblc_init(void)
 535 {
 536         int ret;
 537
 538         sysctl_header = register_sysctl_paths(net_vs_ctl_path, vs_vars_table);
 539         ret = register_ip_vs_scheduler(&ip_vs_lblc_scheduler);
 540         if (ret)
 541                 unregister_sysctl_table(sysctl_header);
 542         return ret;
 543 }
 544
 545
 546 static void __exit ip_vs_lblc_cleanup(void)
 547 {
 548         unregister_sysctl_table(sysctl_header);
 549         unregister_ip_vs_scheduler(&ip_vs_lblc_scheduler);
 550 }
 551
 552
 553 module_init(ip_vs_lblc_init);
 554 module_exit(ip_vs_lblc_cleanup);
 555 MODULE_LICENSE("GPL");