net/ipv4/inetpeer.c

   1 /*
   2  *              INETPEER - A storage for permanent information about peers
   3  *
   4  *  This source is covered by the GNU GPL, the same as all kernel sources.
   5  *
   6  *  Authors:    Andrey V. Savochkin <saw@msu.ru>
   7  */
   8
   9 #include <linux/module.h>
  10 #include <linux/types.h>
  11 #include <linux/slab.h>
  12 #include <linux/interrupt.h>
  13 #include <linux/spinlock.h>
  14 #include <linux/random.h>
  15 #include <linux/timer.h>
  16 #include <linux/time.h>
  17 #include <linux/kernel.h>
  18 #include <linux/mm.h>
  19 #include <linux/net.h>
  20 #include <net/ip.h>
  21 #include <net/inetpeer.h>
  22 #include <net/secure_seq.h>
  23
  24 /*
  25  *  Theory of operations.
  26  *  We keep one entry for each peer IP address.  The nodes contains long-living
  27  *  information about the peer which doesn't depend on routes.
  28  *  At this moment this information consists only of ID field for the next
  29  *  outgoing IP packet.  This field is incremented with each packet as encoded
  30  *  in inet_getid() function (include/net/inetpeer.h).
  31  *  At the moment of writing this notes identifier of IP packets is generated
  32  *  to be unpredictable using this code only for packets subjected
  33  *  (actually or potentially) to defragmentation.  I.e. DF packets less than
  34  *  PMTU in size uses a constant ID and do not use this code (see
  35  *  ip_select_ident() in include/net/ip.h).
  36  *
  37  *  Route cache entries hold references to our nodes.
  38  *  New cache entries get references via lookup by destination IP address in
  39  *  the avl tree.  The reference is grabbed only when it's needed i.e. only
  40  *  when we try to output IP packet which needs an unpredictable ID (see
  41  *  __ip_select_ident() in net/ipv4/route.c).
  42  *  Nodes are removed only when reference counter goes to 0.
  43  *  When it's happened the node may be removed when a sufficient amount of
  44  *  time has been passed since its last use.  The less-recently-used entry can
  45  *  also be removed if the pool is overloaded i.e. if the total amount of
  46  *  entries is greater-or-equal than the threshold.
  47  *
  48  *  Node pool is organised as an AVL tree.
  49  *  Such an implementation has been chosen not just for fun.  It's a way to
  50  *  prevent easy and efficient DoS attacks by creating hash collisions.  A huge
  51  *  amount of long living nodes in a single hash slot would significantly delay
  52  *  lookups performed with disabled BHs.
  53  *
  54  *  Serialisation issues.
  55  *  1.  Nodes may appear in the tree only with the pool lock held.
  56  *  2.  Nodes may disappear from the tree only with the pool lock held
  57  *      AND reference count being 0.
  58  *  3.  Nodes appears and disappears from unused node list only under
  59  *      "inet_peer_unused_lock".
  60  *  4.  Global variable peer_total is modified under the pool lock.
  61  *  5.  struct inet_peer fields modification:
  62  *              avl_left, avl_right, avl_parent, avl_height: pool lock
  63  *              unused: unused node list lock
  64  *              refcnt: atomically against modifications on other CPU;
  65  *                 usually under some other lock to prevent node disappearing
  66  *              dtime: unused node list lock
  67  *              daddr: unchangeable
  68  *              ip_id_count: atomic value (no lock needed)
  69  */
  70
  71 static struct kmem_cache *peer_cachep __read_mostly;
  72
  73 #define node_height(x) x->avl_height
  74
  75 #define peer_avl_empty ((struct inet_peer *)&peer_fake_node)
  76 #define peer_avl_empty_rcu ((struct inet_peer __rcu __force *)&peer_fake_node)
  77 static const struct inet_peer peer_fake_node = {
  78         .avl_left       = peer_avl_empty_rcu,
  79         .avl_right      = peer_avl_empty_rcu,
  80         .avl_height     = 0
  81 };
  82
  83 struct inet_peer_base {
  84         struct inet_peer __rcu *root;
  85         seqlock_t       lock;
  86         int             total;
  87 };
  88
  89 static struct inet_peer_base v4_peers = {
  90         .root           = peer_avl_empty_rcu,
  91         .lock           = __SEQLOCK_UNLOCKED(v4_peers.lock),
  92         .total          = 0,
  93 };
  94
  95 static struct inet_peer_base v6_peers = {
  96         .root           = peer_avl_empty_rcu,
  97         .lock           = __SEQLOCK_UNLOCKED(v6_peers.lock),
  98         .total          = 0,
  99 };
 100
 101 #define PEER_MAXDEPTH 40 /* sufficient for about 2^27 nodes */
 102
 103 /* Exported for sysctl_net_ipv4.  */
 104 int inet_peer_threshold __read_mostly = 65536 + 128;    /* start to throw entries more
 105                                          * aggressively at this stage */
 106 int inet_peer_minttl __read_mostly = 120 * HZ;  /* TTL under high load: 120 sec */
 107 int inet_peer_maxttl __read_mostly = 10 * 60 * HZ;      /* usual time to live: 10 min */
 108 int inet_peer_gc_mintime __read_mostly = 10 * HZ;
 109 int inet_peer_gc_maxtime __read_mostly = 120 * HZ;
 110
 111 static struct {
 112         struct list_head        list;
 113         spinlock_t              lock;
 114 } unused_peers = {
 115         .list                   = LIST_HEAD_INIT(unused_peers.list),
 116         .lock                   = __SPIN_LOCK_UNLOCKED(unused_peers.lock),
 117 };
 118
 119 static void peer_check_expire(unsigned long dummy);
 120 static DEFINE_TIMER(peer_periodic_timer, peer_check_expire, 0, 0);
 121
 122
 123 /* Called from ip_output.c:ip_init  */
 124 void __init inet_initpeers(void)
 125 {
 126         struct sysinfo si;
 127
 128         /* Use the straight interface to information about memory. */
 129         si_meminfo(&si);
 130         /* The values below were suggested by Alexey Kuznetsov
 131          * <kuznet@ms2.inr.ac.ru>.  I don't have any opinion about the values
 132          * myself.  --SAW
 133          */
 134         if (si.totalram <= (32768*1024)/PAGE_SIZE)
 135                 inet_peer_threshold >>= 1; /* max pool size about 1MB on IA32 */
 136         if (si.totalram <= (16384*1024)/PAGE_SIZE)
 137                 inet_peer_threshold >>= 1; /* about 512KB */
 138         if (si.totalram <= (8192*1024)/PAGE_SIZE)
 139                 inet_peer_threshold >>= 2; /* about 128KB */
 140
 141         peer_cachep = kmem_cache_create("inet_peer_cache",
 142                         sizeof(struct inet_peer),
 143                         0, SLAB_HWCACHE_ALIGN | SLAB_PANIC,
 144                         NULL);
 145
 146         /* All the timers, started at system startup tend
 147            to synchronize. Perturb it a bit.
 148          */
 149         peer_periodic_timer.expires = jiffies
 150                 + net_random() % inet_peer_gc_maxtime
 151                 + inet_peer_gc_maxtime;
 152         add_timer(&peer_periodic_timer);
 153 }
 154
 155 /* Called with or without local BH being disabled. */
 156 static void unlink_from_unused(struct inet_peer *p)
 157 {
 158         spin_lock_bh(&unused_peers.lock);
 159         list_del_init(&p->unused);
 160         spin_unlock_bh(&unused_peers.lock);
 161 }
 162
 163 static int addr_compare(const struct inetpeer_addr *a,
 164                         const struct inetpeer_addr *b)
 165 {
 166         int i, n = (a->family == AF_INET ? 1 : 4);
 167
 168         for (i = 0; i < n; i++) {
 169                 if (a->addr.a6[i] == b->addr.a6[i])
 170                         continue;
 171                 if (a->addr.a6[i] < b->addr.a6[i])
 172                         return -1;
 173                 return 1;
 174         }
 175
 176         return 0;
 177 }
 178
 179 #define rcu_deref_locked(X, BASE)                               \
 180         rcu_dereference_protected(X, lockdep_is_held(&(BASE)->lock.lock))
 181
 182 /*
 183  * Called with local BH disabled and the pool lock held.
 184  */
 185 #define lookup(_daddr, _stack, _base)                           \
 186 ({                                                              \
 187         struct inet_peer *u;                                    \
 188         struct inet_peer __rcu **v;                             \
 189                                                                 \
 190         stackptr = _stack;                                      \
 191         *stackptr++ = &_base->root;                             \
 192         for (u = rcu_deref_locked(_base->root, _base);          \
 193              u != peer_avl_empty; ) {                           \
 194                 int cmp = addr_compare(_daddr, &u->daddr);      \
 195                 if (cmp == 0)                                   \
 196                         break;                                  \
 197                 if (cmp == -1)                                  \
 198                         v = &u->avl_left;                       \
 199                 else                                            \
 200                         v = &u->avl_right;                      \
 201                 *stackptr++ = v;                                \
 202                 u = rcu_deref_locked(*v, _base);                \
 203         }                                                       \
 204         u;                                                      \
 205 })
 206
 207 static bool atomic_add_unless_return(atomic_t *ptr, int a, int u, int *newv)
 208 {
 209         int cur, old = atomic_read(ptr);
 210
 211         while (old != u) {
 212                 *newv = old + a;
 213                 cur = atomic_cmpxchg(ptr, old, *newv);
 214                 if (cur == old)
 215                         return true;
 216                 old = cur;
 217         }
 218         return false;
 219 }
 220
 221 /*
 222  * Called with rcu_read_lock()
 223  * Because we hold no lock against a writer, its quite possible we fall
 224  * in an endless loop.
 225  * But every pointer we follow is guaranteed to be valid thanks to RCU.
 226  * We exit from this function if number of links exceeds PEER_MAXDEPTH
 227  */
 228 static struct inet_peer *lookup_rcu(const struct inetpeer_addr *daddr,
 229                                     struct inet_peer_base *base,
 230                                     int *newrefcnt)
 231 {
 232         struct inet_peer *u = rcu_dereference(base->root);
 233         int count = 0;
 234
 235         while (u != peer_avl_empty) {
 236                 int cmp = addr_compare(daddr, &u->daddr);
 237                 if (cmp == 0) {
 238                         /* Before taking a reference, check if this entry was
 239                          * deleted, unlink_from_pool() sets refcnt=-1 to make
 240                          * distinction between an unused entry (refcnt=0) and
 241                          * a freed one.
 242                          */
 243                         if (!atomic_add_unless_return(&u->refcnt, 1, -1, newrefcnt))
 244                                 u = NULL;
 245                         return u;
 246                 }
 247                 if (cmp == -1)
 248                         u = rcu_dereference(u->avl_left);
 249                 else
 250                         u = rcu_dereference(u->avl_right);
 251                 if (unlikely(++count == PEER_MAXDEPTH))
 252                         break;
 253         }
 254         return NULL;
 255 }
 256
 257 /* Called with local BH disabled and the pool lock held. */
 258 #define lookup_rightempty(start, base)                          \
 259 ({                                                              \
 260         struct inet_peer *u;                                    \
 261         struct inet_peer __rcu **v;                             \
 262         *stackptr++ = &start->avl_left;                         \
 263         v = &start->avl_left;                                   \
 264         for (u = rcu_deref_locked(*v, base);                    \
 265              u->avl_right != peer_avl_empty_rcu; ) {            \
 266                 v = &u->avl_right;                              \
 267                 *stackptr++ = v;                                \
 268                 u = rcu_deref_locked(*v, base);                 \
 269         }                                                       \
 270         u;                                                      \
 271 })
 272
 273 /* Called with local BH disabled and the pool lock held.
 274  * Variable names are the proof of operation correctness.
 275  * Look into mm/map_avl.c for more detail description of the ideas.
 276  */
 277 static void peer_avl_rebalance(struct inet_peer __rcu **stack[],
 278                                struct inet_peer __rcu ***stackend,
 279                                struct inet_peer_base *base)
 280 {
 281         struct inet_peer __rcu **nodep;
 282         struct inet_peer *node, *l, *r;
 283         int lh, rh;
 284
 285         while (stackend > stack) {
 286                 nodep = *--stackend;
 287                 node = rcu_deref_locked(*nodep, base);
 288                 l = rcu_deref_locked(node->avl_left, base);
 289                 r = rcu_deref_locked(node->avl_right, base);
 290                 lh = node_height(l);
 291                 rh = node_height(r);
 292                 if (lh > rh + 1) { /* l: RH+2 */
 293                         struct inet_peer *ll, *lr, *lrl, *lrr;
 294                         int lrh;
 295                         ll = rcu_deref_locked(l->avl_left, base);
 296                         lr = rcu_deref_locked(l->avl_right, base);
 297                         lrh = node_height(lr);
 298                         if (lrh <= node_height(ll)) {   /* ll: RH+1 */
 299                                 RCU_INIT_POINTER(node->avl_left, lr);   /* lr: RH or RH+1 */
 300                                 RCU_INIT_POINTER(node->avl_right, r);   /* r: RH */
 301                                 node->avl_height = lrh + 1; /* RH+1 or RH+2 */
 302                                 RCU_INIT_POINTER(l->avl_left, ll);       /* ll: RH+1 */
 303                                 RCU_INIT_POINTER(l->avl_right, node);   /* node: RH+1 or RH+2 */
 304                                 l->avl_height = node->avl_height + 1;
 305                                 RCU_INIT_POINTER(*nodep, l);
 306                         } else { /* ll: RH, lr: RH+1 */
 307                                 lrl = rcu_deref_locked(lr->avl_left, base);/* lrl: RH or RH-1 */
 308                                 lrr = rcu_deref_locked(lr->avl_right, base);/* lrr: RH or RH-1 */
 309                                 RCU_INIT_POINTER(node->avl_left, lrr);  /* lrr: RH or RH-1 */
 310                                 RCU_INIT_POINTER(node->avl_right, r);   /* r: RH */
 311                                 node->avl_height = rh + 1; /* node: RH+1 */
 312                                 RCU_INIT_POINTER(l->avl_left, ll);      /* ll: RH */
 313                                 RCU_INIT_POINTER(l->avl_right, lrl);    /* lrl: RH or RH-1 */
 314                                 l->avl_height = rh + 1; /* l: RH+1 */
 315                                 RCU_INIT_POINTER(lr->avl_left, l);      /* l: RH+1 */
 316                                 RCU_INIT_POINTER(lr->avl_right, node);  /* node: RH+1 */
 317                                 lr->avl_height = rh + 2;
 318                                 RCU_INIT_POINTER(*nodep, lr);
 319                         }
 320                 } else if (rh > lh + 1) { /* r: LH+2 */
 321                         struct inet_peer *rr, *rl, *rlr, *rll;
 322                         int rlh;
 323                         rr = rcu_deref_locked(r->avl_right, base);
 324                         rl = rcu_deref_locked(r->avl_left, base);
 325                         rlh = node_height(rl);
 326                         if (rlh <= node_height(rr)) {   /* rr: LH+1 */
 327                                 RCU_INIT_POINTER(node->avl_right, rl);  /* rl: LH or LH+1 */
 328                                 RCU_INIT_POINTER(node->avl_left, l);    /* l: LH */
 329                                 node->avl_height = rlh + 1; /* LH+1 or LH+2 */
 330                                 RCU_INIT_POINTER(r->avl_right, rr);     /* rr: LH+1 */
 331                                 RCU_INIT_POINTER(r->avl_left, node);    /* node: LH+1 or LH+2 */
 332                                 r->avl_height = node->avl_height + 1;
 333                                 RCU_INIT_POINTER(*nodep, r);
 334                         } else { /* rr: RH, rl: RH+1 */
 335                                 rlr = rcu_deref_locked(rl->avl_right, base);/* rlr: LH or LH-1 */
 336                                 rll = rcu_deref_locked(rl->avl_left, base);/* rll: LH or LH-1 */
 337                                 RCU_INIT_POINTER(node->avl_right, rll); /* rll: LH or LH-1 */
 338                                 RCU_INIT_POINTER(node->avl_left, l);    /* l: LH */
 339                                 node->avl_height = lh + 1; /* node: LH+1 */
 340                                 RCU_INIT_POINTER(r->avl_right, rr);     /* rr: LH */
 341                                 RCU_INIT_POINTER(r->avl_left, rlr);     /* rlr: LH or LH-1 */
 342                                 r->avl_height = lh + 1; /* r: LH+1 */
 343                                 RCU_INIT_POINTER(rl->avl_right, r);     /* r: LH+1 */
 344                                 RCU_INIT_POINTER(rl->avl_left, node);   /* node: LH+1 */
 345                                 rl->avl_height = lh + 2;
 346                                 RCU_INIT_POINTER(*nodep, rl);
 347                         }
 348                 } else {
 349                         node->avl_height = (lh > rh ? lh : rh) + 1;
 350                 }
 351         }
 352 }
 353
 354 /* Called with local BH disabled and the pool lock held. */
 355 #define link_to_pool(n, base)                                   \
 356 do {                                                            \
 357         n->avl_height = 1;                                      \
 358         n->avl_left = peer_avl_empty_rcu;                       \
 359         n->avl_right = peer_avl_empty_rcu;                      \
 360         /* lockless readers can catch us now */                 \
 361         rcu_assign_pointer(**--stackptr, n);                    \
 362         peer_avl_rebalance(stack, stackptr, base);              \
 363 } while (0)
 364
 365 static void inetpeer_free_rcu(struct rcu_head *head)
 366 {
 367         kmem_cache_free(peer_cachep, container_of(head, struct inet_peer, rcu));
 368 }
 369
 370 /* May be called with local BH enabled. */
 371 static void unlink_from_pool(struct inet_peer *p, struct inet_peer_base *base,
 372                              struct inet_peer __rcu **stack[PEER_MAXDEPTH])
 373 {
 374         int do_free;
 375
 376         do_free = 0;
 377
 378         write_seqlock_bh(&base->lock);
 379         /* Check the reference counter.  It was artificially incremented by 1
 380          * in cleanup() function to prevent sudden disappearing.  If we can
 381          * atomically (because of lockless readers) take this last reference,
 382          * it's safe to remove the node and free it later.
 383          * We use refcnt=-1 to alert lockless readers this entry is deleted.
 384          */
 385         if (atomic_cmpxchg(&p->refcnt, 1, -1) == 1) {
 386                 struct inet_peer __rcu ***stackptr, ***delp;
 387                 if (lookup(&p->daddr, stack, base) != p)
 388                         BUG();
 389                 delp = stackptr - 1; /* *delp[0] == p */
 390                 if (p->avl_left == peer_avl_empty_rcu) {
 391                         *delp[0] = p->avl_right;
 392                         --stackptr;
 393                 } else {
 394                         /* look for a node to insert instead of p */
 395                         struct inet_peer *t;
 396                         t = lookup_rightempty(p, base);
 397                         BUG_ON(rcu_deref_locked(*stackptr[-1], base) != t);
 398                         **--stackptr = t->avl_left;
 399                         /* t is removed, t->daddr > x->daddr for any
 400                          * x in p->avl_left subtree.
 401                          * Put t in the old place of p. */
 402                         RCU_INIT_POINTER(*delp[0], t);
 403                         t->avl_left = p->avl_left;
 404                         t->avl_right = p->avl_right;
 405                         t->avl_height = p->avl_height;
 406                         BUG_ON(delp[1] != &p->avl_left);
 407                         delp[1] = &t->avl_left; /* was &p->avl_left */
 408                 }
 409                 peer_avl_rebalance(stack, stackptr, base);
 410                 base->total--;
 411                 do_free = 1;
 412         }
 413         write_sequnlock_bh(&base->lock);
 414
 415         if (do_free)
 416                 call_rcu(&p->rcu, inetpeer_free_rcu);
 417         else
 418                 /* The node is used again.  Decrease the reference counter
 419                  * back.  The loop "cleanup -> unlink_from_unused
 420                  *   -> unlink_from_pool -> putpeer -> link_to_unused
 421                  *   -> cleanup (for the same node)"
 422                  * doesn't really exist because the entry will have a
 423                  * recent deletion time and will not be cleaned again soon.
 424                  */
 425                 inet_putpeer(p);
 426 }
 427
 428 static struct inet_peer_base *family_to_base(int family)
 429 {
 430         return (family == AF_INET ? &v4_peers : &v6_peers);
 431 }
 432
 433 static struct inet_peer_base *peer_to_base(struct inet_peer *p)
 434 {
 435         return family_to_base(p->daddr.family);
 436 }
 437
 438 /* May be called with local BH enabled. */
 439 static int cleanup_once(unsigned long ttl, struct inet_peer __rcu **stack[PEER_MAXDEPTH])
 440 {
 441         struct inet_peer *p = NULL;
 442
 443         /* Remove the first entry from the list of unused nodes. */
 444         spin_lock_bh(&unused_peers.lock);
 445         if (!list_empty(&unused_peers.list)) {
 446                 __u32 delta;
 447
 448                 p = list_first_entry(&unused_peers.list, struct inet_peer, unused);
 449                 delta = (__u32)jiffies - p->dtime;
 450
 451                 if (delta < ttl) {
 452                         /* Do not prune fresh entries. */
 453                         spin_unlock_bh(&unused_peers.lock);
 454                         return -1;
 455                 }
 456
 457                 list_del_init(&p->unused);
 458
 459                 /* Grab an extra reference to prevent node disappearing
 460                  * before unlink_from_pool() call. */
 461                 atomic_inc(&p->refcnt);
 462         }
 463         spin_unlock_bh(&unused_peers.lock);
 464
 465         if (p == NULL)
 466                 /* It means that the total number of USED entries has
 467                  * grown over inet_peer_threshold.  It shouldn't really
 468                  * happen because of entry limits in route cache. */
 469                 return -1;
 470
 471         unlink_from_pool(p, peer_to_base(p), stack);
 472         return 0;
 473 }
 474
 475 /* Called with or without local BH being disabled. */
 476 struct inet_peer *inet_getpeer(struct inetpeer_addr *daddr, int create)
 477 {
 478         struct inet_peer __rcu **stack[PEER_MAXDEPTH], ***stackptr;
 479         struct inet_peer_base *base = family_to_base(daddr->family);
 480         struct inet_peer *p;
 481         unsigned int sequence;
 482         int invalidated, newrefcnt = 0;
 483
 484         /* Look up for the address quickly, lockless.
 485          * Because of a concurrent writer, we might not find an existing entry.
 486          */
 487         rcu_read_lock();
 488         sequence = read_seqbegin(&base->lock);
 489         p = lookup_rcu(daddr, base, &newrefcnt);
 490         invalidated = read_seqretry(&base->lock, sequence);
 491         rcu_read_unlock();
 492
 493         if (p) {
 494 found:          /* The existing node has been found.
 495                  * Remove the entry from unused list if it was there.
 496                  */
 497                 if (newrefcnt == 1)
 498                         unlink_from_unused(p);
 499                 return p;
 500         }
 501
 502         /* If no writer did a change during our lookup, we can return early. */
 503         if (!create && !invalidated)
 504                 return NULL;
 505
 506         /* retry an exact lookup, taking the lock before.
 507          * At least, nodes should be hot in our cache.
 508          */
 509         write_seqlock_bh(&base->lock);
 510         p = lookup(daddr, stack, base);
 511         if (p != peer_avl_empty) {
 512                 newrefcnt = atomic_inc_return(&p->refcnt);
 513                 write_sequnlock_bh(&base->lock);
 514                 goto found;
 515         }
 516         p = create ? kmem_cache_alloc(peer_cachep, GFP_ATOMIC) : NULL;
 517         if (p) {
 518                 p->daddr = *daddr;
 519                 atomic_set(&p->refcnt, 1);
 520                 atomic_set(&p->rid, 0);
 521                 atomic_set(&p->ip_id_count, secure_ip_id(daddr->addr.a4));
 522                 p->tcp_ts_stamp = 0;
 523                 p->metrics[RTAX_LOCK-1] = INETPEER_METRICS_NEW;
 524                 p->rate_tokens = 0;
 525                 p->rate_last = 0;
 526                 p->pmtu_expires = 0;
 527                 p->pmtu_orig = 0;
 528                 memset(&p->redirect_learned, 0, sizeof(p->redirect_learned));
 529                 INIT_LIST_HEAD(&p->unused);
 530
 531
 532                 /* Link the node. */
 533                 link_to_pool(p, base);
 534                 base->total++;
 535         }
 536         write_sequnlock_bh(&base->lock);
 537
 538         if (base->total >= inet_peer_threshold)
 539                 /* Remove one less-recently-used entry. */
 540                 cleanup_once(0, stack);
 541
 542         return p;
 543 }
 544
 545 static int compute_total(void)
 546 {
 547         return v4_peers.total + v6_peers.total;
 548 }
 549 EXPORT_SYMBOL_GPL(inet_getpeer);
 550
 551 /* Called with local BH disabled. */
 552 static void peer_check_expire(unsigned long dummy)
 553 {
 554         unsigned long now = jiffies;
 555         int ttl, total;
 556         struct inet_peer __rcu **stack[PEER_MAXDEPTH];
 557
 558         total = compute_total();
 559         if (total >= inet_peer_threshold)
 560                 ttl = inet_peer_minttl;
 561         else
 562                 ttl = inet_peer_maxttl
 563                                 - (inet_peer_maxttl - inet_peer_minttl) / HZ *
 564                                         total / inet_peer_threshold * HZ;
 565         while (!cleanup_once(ttl, stack)) {
 566                 if (jiffies != now)
 567                         break;
 568         }
 569
 570         /* Trigger the timer after inet_peer_gc_mintime .. inet_peer_gc_maxtime
 571          * interval depending on the total number of entries (more entries,
 572          * less interval). */
 573         total = compute_total();
 574         if (total >= inet_peer_threshold)
 575                 peer_periodic_timer.expires = jiffies + inet_peer_gc_mintime;
 576         else
 577                 peer_periodic_timer.expires = jiffies
 578                         + inet_peer_gc_maxtime
 579                         - (inet_peer_gc_maxtime - inet_peer_gc_mintime) / HZ *
 580                                 total / inet_peer_threshold * HZ;
 581         add_timer(&peer_periodic_timer);
 582 }
 583
 584 void inet_putpeer(struct inet_peer *p)
 585 {
 586         local_bh_disable();
 587
 588         if (atomic_dec_and_lock(&p->refcnt, &unused_peers.lock)) {
 589                 list_add_tail(&p->unused, &unused_peers.list);
 590                 p->dtime = (__u32)jiffies;
 591                 spin_unlock(&unused_peers.lock);
 592         }
 593
 594         local_bh_enable();
 595 }
 596 EXPORT_SYMBOL_GPL(inet_putpeer);
 597
 598 /*
 599  *      Check transmit rate limitation for given message.
 600  *      The rate information is held in the inet_peer entries now.
 601  *      This function is generic and could be used for other purposes
 602  *      too. It uses a Token bucket filter as suggested by Alexey Kuznetsov.
 603  *
 604  *      Note that the same inet_peer fields are modified by functions in
 605  *      route.c too, but these work for packet destinations while xrlim_allow
 606  *      works for icmp destinations. This means the rate limiting information
 607  *      for one "ip object" is shared - and these ICMPs are twice limited:
 608  *      by source and by destination.
 609  *
 610  *      RFC 1812: 4.3.2.8 SHOULD be able to limit error message rate
 611  *                        SHOULD allow setting of rate limits
 612  *
 613  *      Shared between ICMPv4 and ICMPv6.
 614  */
 615 #define XRLIM_BURST_FACTOR 6
 616 bool inet_peer_xrlim_allow(struct inet_peer *peer, int timeout)
 617 {
 618         unsigned long now, token;
 619         bool rc = false;
 620
 621         if (!peer)
 622                 return true;
 623
 624         token = peer->rate_tokens;
 625         now = jiffies;
 626         token += now - peer->rate_last;
 627         peer->rate_last = now;
 628         if (token > XRLIM_BURST_FACTOR * timeout)
 629                 token = XRLIM_BURST_FACTOR * timeout;
 630         if (token >= timeout) {
 631                 token -= timeout;
 632                 rc = true;
 633         }
 634         peer->rate_tokens = token;
 635         return rc;
 636 }
 637 EXPORT_SYMBOL(inet_peer_xrlim_allow);