2 * This program is free software; you can redistribute it and/or
3 * modify it under the terms of the GNU General Public License
4 * as published by the Free Software Foundation; either version
5 * 2 of the License, or (at your option) any later version.
7 * Robert Olsson <robert.olsson@its.uu.se> Uppsala Universitet
8 * & Swedish University of Agricultural Sciences.
10 * Jens Laas <jens.laas@data.slu.se> Swedish University of
11 * Agricultural Sciences.
13 * Hans Liss <hans.liss@its.uu.se> Uppsala Universitet
15 * This work is based on the LPC-trie which is originally described in:
17 * An experimental study of compression methods for dynamic tries
18 * Stefan Nilsson and Matti Tikkanen. Algorithmica, 33(1):19-33, 2002.
19 * http://www.csc.kth.se/~snilsson/software/dyntrie2/
22 * IP-address lookup using LC-tries. Stefan Nilsson and Gunnar Karlsson
23 * IEEE Journal on Selected Areas in Communications, 17(6):1083-1092, June 1999
26 * Code from fib_hash has been reused which includes the following header:
29 * INET An implementation of the TCP/IP protocol suite for the LINUX
30 * operating system. INET is implemented using the BSD Socket
31 * interface as the means of communication with the user level.
33 * IPv4 FIB: lookup engine and maintenance routines.
36 * Authors: Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
38 * This program is free software; you can redistribute it and/or
39 * modify it under the terms of the GNU General Public License
40 * as published by the Free Software Foundation; either version
41 * 2 of the License, or (at your option) any later version.
43 * Substantial contributions to this work comes from:
45 * David S. Miller, <davem@davemloft.net>
46 * Stephen Hemminger <shemminger@osdl.org>
47 * Paul E. McKenney <paulmck@us.ibm.com>
48 * Patrick McHardy <kaber@trash.net>
51 #define VERSION "0.409"
53 #include <asm/uaccess.h>
54 #include <linux/bitops.h>
55 #include <linux/types.h>
56 #include <linux/kernel.h>
58 #include <linux/string.h>
59 #include <linux/socket.h>
60 #include <linux/sockios.h>
61 #include <linux/errno.h>
63 #include <linux/inet.h>
64 #include <linux/inetdevice.h>
65 #include <linux/netdevice.h>
66 #include <linux/if_arp.h>
67 #include <linux/proc_fs.h>
68 #include <linux/rcupdate.h>
69 #include <linux/skbuff.h>
70 #include <linux/netlink.h>
71 #include <linux/init.h>
72 #include <linux/list.h>
73 #include <linux/slab.h>
74 #include <linux/export.h>
75 #include <net/net_namespace.h>
77 #include <net/protocol.h>
78 #include <net/route.h>
81 #include <net/ip_fib.h>
82 #include <net/switchdev.h>
83 #include "fib_lookup.h"
85 #define MAX_STAT_DEPTH 32
87 #define KEYLENGTH (8*sizeof(t_key))
88 #define KEY_MAX ((t_key)~0)
90 typedef unsigned int t_key;
92 #define IS_TRIE(n) ((n)->pos >= KEYLENGTH)
93 #define IS_TNODE(n) ((n)->bits)
94 #define IS_LEAF(n) (!(n)->bits)
98 unsigned char pos; /* 2log(KEYLENGTH) bits needed */
99 unsigned char bits; /* 2log(KEYLENGTH) bits needed */
102 /* This list pointer if valid if (pos | bits) == 0 (LEAF) */
103 struct hlist_head leaf;
104 /* This array is valid if (pos | bits) > 0 (TNODE) */
105 struct key_vector __rcu *tnode[0];
111 t_key empty_children; /* KEYLENGTH bits needed */
112 t_key full_children; /* KEYLENGTH bits needed */
113 struct key_vector __rcu *parent;
114 struct key_vector kv[1];
115 #define tn_bits kv[0].bits
118 #define TNODE_SIZE(n) offsetof(struct tnode, kv[0].tnode[n])
119 #define LEAF_SIZE TNODE_SIZE(1)
121 #ifdef CONFIG_IP_FIB_TRIE_STATS
122 struct trie_use_stats {
124 unsigned int backtrack;
125 unsigned int semantic_match_passed;
126 unsigned int semantic_match_miss;
127 unsigned int null_node_hit;
128 unsigned int resize_node_skipped;
133 unsigned int totdepth;
134 unsigned int maxdepth;
137 unsigned int nullpointers;
138 unsigned int prefixes;
139 unsigned int nodesizes[MAX_STAT_DEPTH];
143 struct key_vector kv[1];
144 #ifdef CONFIG_IP_FIB_TRIE_STATS
145 struct trie_use_stats __percpu *stats;
149 static struct key_vector *resize(struct trie *t, struct key_vector *tn);
150 static size_t tnode_free_size;
153 * synchronize_rcu after call_rcu for that many pages; it should be especially
154 * useful before resizing the root node with PREEMPT_NONE configs; the value was
155 * obtained experimentally, aiming to avoid visible slowdown.
157 static const int sync_pages = 128;
159 static struct kmem_cache *fn_alias_kmem __read_mostly;
160 static struct kmem_cache *trie_leaf_kmem __read_mostly;
162 static inline struct tnode *tn_info(struct key_vector *kv)
164 return container_of(kv, struct tnode, kv[0]);
167 /* caller must hold RTNL */
168 #define node_parent(tn) rtnl_dereference(tn_info(tn)->parent)
169 #define get_child(tn, i) rtnl_dereference((tn)->tnode[i])
171 /* caller must hold RCU read lock or RTNL */
172 #define node_parent_rcu(tn) rcu_dereference_rtnl(tn_info(tn)->parent)
173 #define get_child_rcu(tn, i) rcu_dereference_rtnl((tn)->tnode[i])
175 /* wrapper for rcu_assign_pointer */
176 static inline void node_set_parent(struct key_vector *n, struct key_vector *tp)
179 rcu_assign_pointer(tn_info(n)->parent, tp);
182 #define NODE_INIT_PARENT(n, p) RCU_INIT_POINTER(tn_info(n)->parent, p)
184 /* This provides us with the number of children in this node, in the case of a
185 * leaf this will return 0 meaning none of the children are accessible.
187 static inline unsigned long child_length(const struct key_vector *tn)
189 return (1ul << tn->bits) & ~(1ul);
192 #define get_cindex(key, kv) (((key) ^ (kv)->key) >> (kv)->pos)
194 static inline unsigned long get_index(t_key key, struct key_vector *kv)
196 unsigned long index = key ^ kv->key;
198 if ((BITS_PER_LONG <= KEYLENGTH) && (KEYLENGTH == kv->pos))
201 return index >> kv->pos;
204 /* To understand this stuff, an understanding of keys and all their bits is
205 * necessary. Every node in the trie has a key associated with it, but not
206 * all of the bits in that key are significant.
208 * Consider a node 'n' and its parent 'tp'.
210 * If n is a leaf, every bit in its key is significant. Its presence is
211 * necessitated by path compression, since during a tree traversal (when
212 * searching for a leaf - unless we are doing an insertion) we will completely
213 * ignore all skipped bits we encounter. Thus we need to verify, at the end of
214 * a potentially successful search, that we have indeed been walking the
217 * Note that we can never "miss" the correct key in the tree if present by
218 * following the wrong path. Path compression ensures that segments of the key
219 * that are the same for all keys with a given prefix are skipped, but the
220 * skipped part *is* identical for each node in the subtrie below the skipped
221 * bit! trie_insert() in this implementation takes care of that.
223 * if n is an internal node - a 'tnode' here, the various parts of its key
224 * have many different meanings.
227 * _________________________________________________________________
228 * | i | i | i | i | i | i | i | N | N | N | S | S | S | S | S | C |
229 * -----------------------------------------------------------------
230 * 31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16
232 * _________________________________________________________________
233 * | C | C | C | u | u | u | u | u | u | u | u | u | u | u | u | u |
234 * -----------------------------------------------------------------
235 * 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
242 * First, let's just ignore the bits that come before the parent tp, that is
243 * the bits from (tp->pos + tp->bits) to 31. They are *known* but at this
244 * point we do not use them for anything.
246 * The bits from (tp->pos) to (tp->pos + tp->bits - 1) - "N", above - are the
247 * index into the parent's child array. That is, they will be used to find
248 * 'n' among tp's children.
250 * The bits from (n->pos + n->bits) to (tn->pos - 1) - "S" - are skipped bits
253 * All the bits we have seen so far are significant to the node n. The rest
254 * of the bits are really not needed or indeed known in n->key.
256 * The bits from (n->pos) to (n->pos + n->bits - 1) - "C" - are the index into
257 * n's child array, and will of course be different for each child.
259 * The rest of the bits, from 0 to (n->pos + n->bits), are completely unknown
263 static const int halve_threshold = 25;
264 static const int inflate_threshold = 50;
265 static const int halve_threshold_root = 15;
266 static const int inflate_threshold_root = 30;
268 static void __alias_free_mem(struct rcu_head *head)
270 struct fib_alias *fa = container_of(head, struct fib_alias, rcu);
271 kmem_cache_free(fn_alias_kmem, fa);
274 static inline void alias_free_mem_rcu(struct fib_alias *fa)
276 call_rcu(&fa->rcu, __alias_free_mem);
279 #define TNODE_KMALLOC_MAX \
280 ilog2((PAGE_SIZE - TNODE_SIZE(0)) / sizeof(struct key_vector *))
281 #define TNODE_VMALLOC_MAX \
282 ilog2((SIZE_MAX - TNODE_SIZE(0)) / sizeof(struct key_vector *))
284 static void __node_free_rcu(struct rcu_head *head)
286 struct tnode *n = container_of(head, struct tnode, rcu);
289 kmem_cache_free(trie_leaf_kmem, n);
290 else if (n->tn_bits <= TNODE_KMALLOC_MAX)
296 #define node_free(n) call_rcu(&tn_info(n)->rcu, __node_free_rcu)
298 static struct tnode *tnode_alloc(int bits)
302 /* verify bits is within bounds */
303 if (bits > TNODE_VMALLOC_MAX)
306 /* determine size and verify it is non-zero and didn't overflow */
307 size = TNODE_SIZE(1ul << bits);
309 if (size <= PAGE_SIZE)
310 return kzalloc(size, GFP_KERNEL);
312 return vzalloc(size);
315 static inline void empty_child_inc(struct key_vector *n)
317 ++tn_info(n)->empty_children ? : ++tn_info(n)->full_children;
320 static inline void empty_child_dec(struct key_vector *n)
322 tn_info(n)->empty_children-- ? : tn_info(n)->full_children--;
325 static struct key_vector *leaf_new(t_key key, struct fib_alias *fa)
327 struct tnode *kv = kmem_cache_alloc(trie_leaf_kmem, GFP_KERNEL);
328 struct key_vector *l = kv->kv;
333 /* initialize key vector */
337 l->slen = fa->fa_slen;
339 /* link leaf to fib alias */
340 INIT_HLIST_HEAD(&l->leaf);
341 hlist_add_head(&fa->fa_list, &l->leaf);
346 static struct key_vector *tnode_new(t_key key, int pos, int bits)
348 struct tnode *tnode = tnode_alloc(bits);
349 unsigned int shift = pos + bits;
350 struct key_vector *tn = tnode->kv;
352 /* verify bits and pos their msb bits clear and values are valid */
353 BUG_ON(!bits || (shift > KEYLENGTH));
355 pr_debug("AT %p s=%zu %zu\n", tnode, TNODE_SIZE(0),
356 sizeof(struct key_vector *) << bits);
361 if (bits == KEYLENGTH)
362 tnode->full_children = 1;
364 tnode->empty_children = 1ul << bits;
366 tn->key = (shift < KEYLENGTH) ? (key >> shift) << shift : 0;
374 /* Check whether a tnode 'n' is "full", i.e. it is an internal node
375 * and no bits are skipped. See discussion in dyntree paper p. 6
377 static inline int tnode_full(struct key_vector *tn, struct key_vector *n)
379 return n && ((n->pos + n->bits) == tn->pos) && IS_TNODE(n);
382 /* Add a child at position i overwriting the old value.
383 * Update the value of full_children and empty_children.
385 static void put_child(struct key_vector *tn, unsigned long i,
386 struct key_vector *n)
388 struct key_vector *chi = get_child(tn, i);
391 BUG_ON(i >= child_length(tn));
393 /* update emptyChildren, overflow into fullChildren */
394 if (n == NULL && chi != NULL)
396 if (n != NULL && chi == NULL)
399 /* update fullChildren */
400 wasfull = tnode_full(tn, chi);
401 isfull = tnode_full(tn, n);
403 if (wasfull && !isfull)
404 tn_info(tn)->full_children--;
405 else if (!wasfull && isfull)
406 tn_info(tn)->full_children++;
408 if (n && (tn->slen < n->slen))
411 rcu_assign_pointer(tn->tnode[i], n);
414 static void update_children(struct key_vector *tn)
418 /* update all of the child parent pointers */
419 for (i = child_length(tn); i;) {
420 struct key_vector *inode = get_child(tn, --i);
425 /* Either update the children of a tnode that
426 * already belongs to us or update the child
427 * to point to ourselves.
429 if (node_parent(inode) == tn)
430 update_children(inode);
432 node_set_parent(inode, tn);
436 static inline void put_child_root(struct key_vector *tp, t_key key,
437 struct key_vector *n)
440 rcu_assign_pointer(tp->tnode[0], n);
442 put_child(tp, get_index(key, tp), n);
445 static inline void tnode_free_init(struct key_vector *tn)
447 tn_info(tn)->rcu.next = NULL;
450 static inline void tnode_free_append(struct key_vector *tn,
451 struct key_vector *n)
453 tn_info(n)->rcu.next = tn_info(tn)->rcu.next;
454 tn_info(tn)->rcu.next = &tn_info(n)->rcu;
457 static void tnode_free(struct key_vector *tn)
459 struct callback_head *head = &tn_info(tn)->rcu;
463 tnode_free_size += TNODE_SIZE(1ul << tn->bits);
466 tn = container_of(head, struct tnode, rcu)->kv;
469 if (tnode_free_size >= PAGE_SIZE * sync_pages) {
475 static struct key_vector *replace(struct trie *t,
476 struct key_vector *oldtnode,
477 struct key_vector *tn)
479 struct key_vector *tp = node_parent(oldtnode);
482 /* setup the parent pointer out of and back into this node */
483 NODE_INIT_PARENT(tn, tp);
484 put_child_root(tp, tn->key, tn);
486 /* update all of the child parent pointers */
489 /* all pointers should be clean so we are done */
490 tnode_free(oldtnode);
492 /* resize children now that oldtnode is freed */
493 for (i = child_length(tn); i;) {
494 struct key_vector *inode = get_child(tn, --i);
496 /* resize child node */
497 if (tnode_full(tn, inode))
498 tn = resize(t, inode);
504 static struct key_vector *inflate(struct trie *t,
505 struct key_vector *oldtnode)
507 struct key_vector *tn;
511 pr_debug("In inflate\n");
513 tn = tnode_new(oldtnode->key, oldtnode->pos - 1, oldtnode->bits + 1);
517 /* prepare oldtnode to be freed */
518 tnode_free_init(oldtnode);
520 /* Assemble all of the pointers in our cluster, in this case that
521 * represents all of the pointers out of our allocated nodes that
522 * point to existing tnodes and the links between our allocated
525 for (i = child_length(oldtnode), m = 1u << tn->pos; i;) {
526 struct key_vector *inode = get_child(oldtnode, --i);
527 struct key_vector *node0, *node1;
534 /* A leaf or an internal node with skipped bits */
535 if (!tnode_full(oldtnode, inode)) {
536 put_child(tn, get_index(inode->key, tn), inode);
540 /* drop the node in the old tnode free list */
541 tnode_free_append(oldtnode, inode);
543 /* An internal node with two children */
544 if (inode->bits == 1) {
545 put_child(tn, 2 * i + 1, get_child(inode, 1));
546 put_child(tn, 2 * i, get_child(inode, 0));
550 /* We will replace this node 'inode' with two new
551 * ones, 'node0' and 'node1', each with half of the
552 * original children. The two new nodes will have
553 * a position one bit further down the key and this
554 * means that the "significant" part of their keys
555 * (see the discussion near the top of this file)
556 * will differ by one bit, which will be "0" in
557 * node0's key and "1" in node1's key. Since we are
558 * moving the key position by one step, the bit that
559 * we are moving away from - the bit at position
560 * (tn->pos) - is the one that will differ between
561 * node0 and node1. So... we synthesize that bit in the
564 node1 = tnode_new(inode->key | m, inode->pos, inode->bits - 1);
567 node0 = tnode_new(inode->key, inode->pos, inode->bits - 1);
569 tnode_free_append(tn, node1);
572 tnode_free_append(tn, node0);
574 /* populate child pointers in new nodes */
575 for (k = child_length(inode), j = k / 2; j;) {
576 put_child(node1, --j, get_child(inode, --k));
577 put_child(node0, j, get_child(inode, j));
578 put_child(node1, --j, get_child(inode, --k));
579 put_child(node0, j, get_child(inode, j));
582 /* link new nodes to parent */
583 NODE_INIT_PARENT(node1, tn);
584 NODE_INIT_PARENT(node0, tn);
586 /* link parent to nodes */
587 put_child(tn, 2 * i + 1, node1);
588 put_child(tn, 2 * i, node0);
591 /* setup the parent pointers into and out of this node */
592 return replace(t, oldtnode, tn);
594 /* all pointers should be clean so we are done */
600 static struct key_vector *halve(struct trie *t,
601 struct key_vector *oldtnode)
603 struct key_vector *tn;
606 pr_debug("In halve\n");
608 tn = tnode_new(oldtnode->key, oldtnode->pos + 1, oldtnode->bits - 1);
612 /* prepare oldtnode to be freed */
613 tnode_free_init(oldtnode);
615 /* Assemble all of the pointers in our cluster, in this case that
616 * represents all of the pointers out of our allocated nodes that
617 * point to existing tnodes and the links between our allocated
620 for (i = child_length(oldtnode); i;) {
621 struct key_vector *node1 = get_child(oldtnode, --i);
622 struct key_vector *node0 = get_child(oldtnode, --i);
623 struct key_vector *inode;
625 /* At least one of the children is empty */
626 if (!node1 || !node0) {
627 put_child(tn, i / 2, node1 ? : node0);
631 /* Two nonempty children */
632 inode = tnode_new(node0->key, oldtnode->pos, 1);
635 tnode_free_append(tn, inode);
637 /* initialize pointers out of node */
638 put_child(inode, 1, node1);
639 put_child(inode, 0, node0);
640 NODE_INIT_PARENT(inode, tn);
642 /* link parent to node */
643 put_child(tn, i / 2, inode);
646 /* setup the parent pointers into and out of this node */
647 return replace(t, oldtnode, tn);
649 /* all pointers should be clean so we are done */
655 static struct key_vector *collapse(struct trie *t,
656 struct key_vector *oldtnode)
658 struct key_vector *n, *tp;
661 /* scan the tnode looking for that one child that might still exist */
662 for (n = NULL, i = child_length(oldtnode); !n && i;)
663 n = get_child(oldtnode, --i);
665 /* compress one level */
666 tp = node_parent(oldtnode);
667 put_child_root(tp, oldtnode->key, n);
668 node_set_parent(n, tp);
676 static unsigned char update_suffix(struct key_vector *tn)
678 unsigned char slen = tn->pos;
679 unsigned long stride, i;
681 /* search though the list of children looking for nodes that might
682 * have a suffix greater than the one we currently have. This is
683 * why we start with a stride of 2 since a stride of 1 would
684 * represent the nodes with suffix length equal to tn->pos
686 for (i = 0, stride = 0x2ul ; i < child_length(tn); i += stride) {
687 struct key_vector *n = get_child(tn, i);
689 if (!n || (n->slen <= slen))
692 /* update stride and slen based on new value */
693 stride <<= (n->slen - slen);
697 /* if slen covers all but the last bit we can stop here
698 * there will be nothing longer than that since only node
699 * 0 and 1 << (bits - 1) could have that as their suffix
702 if ((slen + 1) >= (tn->pos + tn->bits))
711 /* From "Implementing a dynamic compressed trie" by Stefan Nilsson of
712 * the Helsinki University of Technology and Matti Tikkanen of Nokia
713 * Telecommunications, page 6:
714 * "A node is doubled if the ratio of non-empty children to all
715 * children in the *doubled* node is at least 'high'."
717 * 'high' in this instance is the variable 'inflate_threshold'. It
718 * is expressed as a percentage, so we multiply it with
719 * child_length() and instead of multiplying by 2 (since the
720 * child array will be doubled by inflate()) and multiplying
721 * the left-hand side by 100 (to handle the percentage thing) we
722 * multiply the left-hand side by 50.
724 * The left-hand side may look a bit weird: child_length(tn)
725 * - tn->empty_children is of course the number of non-null children
726 * in the current node. tn->full_children is the number of "full"
727 * children, that is non-null tnodes with a skip value of 0.
728 * All of those will be doubled in the resulting inflated tnode, so
729 * we just count them one extra time here.
731 * A clearer way to write this would be:
733 * to_be_doubled = tn->full_children;
734 * not_to_be_doubled = child_length(tn) - tn->empty_children -
737 * new_child_length = child_length(tn) * 2;
739 * new_fill_factor = 100 * (not_to_be_doubled + 2*to_be_doubled) /
741 * if (new_fill_factor >= inflate_threshold)
743 * ...and so on, tho it would mess up the while () loop.
746 * 100 * (not_to_be_doubled + 2*to_be_doubled) / new_child_length >=
750 * 100 * (not_to_be_doubled + 2*to_be_doubled) >=
751 * inflate_threshold * new_child_length
753 * expand not_to_be_doubled and to_be_doubled, and shorten:
754 * 100 * (child_length(tn) - tn->empty_children +
755 * tn->full_children) >= inflate_threshold * new_child_length
757 * expand new_child_length:
758 * 100 * (child_length(tn) - tn->empty_children +
759 * tn->full_children) >=
760 * inflate_threshold * child_length(tn) * 2
763 * 50 * (tn->full_children + child_length(tn) -
764 * tn->empty_children) >= inflate_threshold *
768 static inline bool should_inflate(struct key_vector *tp, struct key_vector *tn)
770 unsigned long used = child_length(tn);
771 unsigned long threshold = used;
773 /* Keep root node larger */
774 threshold *= IS_TRIE(tp) ? inflate_threshold_root : inflate_threshold;
775 used -= tn_info(tn)->empty_children;
776 used += tn_info(tn)->full_children;
778 /* if bits == KEYLENGTH then pos = 0, and will fail below */
780 return (used > 1) && tn->pos && ((50 * used) >= threshold);
783 static inline bool should_halve(struct key_vector *tp, struct key_vector *tn)
785 unsigned long used = child_length(tn);
786 unsigned long threshold = used;
788 /* Keep root node larger */
789 threshold *= IS_TRIE(tp) ? halve_threshold_root : halve_threshold;
790 used -= tn_info(tn)->empty_children;
792 /* if bits == KEYLENGTH then used = 100% on wrap, and will fail below */
794 return (used > 1) && (tn->bits > 1) && ((100 * used) < threshold);
797 static inline bool should_collapse(struct key_vector *tn)
799 unsigned long used = child_length(tn);
801 used -= tn_info(tn)->empty_children;
803 /* account for bits == KEYLENGTH case */
804 if ((tn->bits == KEYLENGTH) && tn_info(tn)->full_children)
807 /* One child or none, time to drop us from the trie */
812 static struct key_vector *resize(struct trie *t, struct key_vector *tn)
814 #ifdef CONFIG_IP_FIB_TRIE_STATS
815 struct trie_use_stats __percpu *stats = t->stats;
817 struct key_vector *tp = node_parent(tn);
818 unsigned long cindex = get_index(tn->key, tp);
819 int max_work = MAX_WORK;
821 pr_debug("In tnode_resize %p inflate_threshold=%d threshold=%d\n",
822 tn, inflate_threshold, halve_threshold);
824 /* track the tnode via the pointer from the parent instead of
825 * doing it ourselves. This way we can let RCU fully do its
826 * thing without us interfering
828 BUG_ON(tn != get_child(tp, cindex));
830 /* Double as long as the resulting node has a number of
831 * nonempty nodes that are above the threshold.
833 while (should_inflate(tp, tn) && max_work) {
836 #ifdef CONFIG_IP_FIB_TRIE_STATS
837 this_cpu_inc(stats->resize_node_skipped);
843 tn = get_child(tp, cindex);
846 /* Return if at least one inflate is run */
847 if (max_work != MAX_WORK)
848 return node_parent(tn);
850 /* Halve as long as the number of empty children in this
851 * node is above threshold.
853 while (should_halve(tp, tn) && max_work) {
856 #ifdef CONFIG_IP_FIB_TRIE_STATS
857 this_cpu_inc(stats->resize_node_skipped);
863 tn = get_child(tp, cindex);
866 /* Only one child remains */
867 if (should_collapse(tn))
868 return collapse(t, tn);
870 /* update parent in case inflate or halve failed */
871 tp = node_parent(tn);
873 /* Return if at least one deflate was run */
874 if (max_work != MAX_WORK)
877 /* push the suffix length to the parent node */
878 if (tn->slen > tn->pos) {
879 unsigned char slen = update_suffix(tn);
888 static void leaf_pull_suffix(struct key_vector *tp, struct key_vector *l)
890 while ((tp->slen > tp->pos) && (tp->slen > l->slen)) {
891 if (update_suffix(tp) > l->slen)
893 tp = node_parent(tp);
897 static void leaf_push_suffix(struct key_vector *tn, struct key_vector *l)
899 /* if this is a new leaf then tn will be NULL and we can sort
900 * out parent suffix lengths as a part of trie_rebalance
902 while (tn->slen < l->slen) {
904 tn = node_parent(tn);
908 /* rcu_read_lock needs to be hold by caller from readside */
909 static struct key_vector *fib_find_node(struct trie *t,
910 struct key_vector **tp, u32 key)
912 struct key_vector *pn, *n = t->kv;
913 unsigned long index = 0;
917 n = get_child_rcu(n, index);
922 index = get_cindex(key, n);
924 /* This bit of code is a bit tricky but it combines multiple
925 * checks into a single check. The prefix consists of the
926 * prefix plus zeros for the bits in the cindex. The index
927 * is the difference between the key and this value. From
928 * this we can actually derive several pieces of data.
929 * if (index >= (1ul << bits))
930 * we have a mismatch in skip bits and failed
932 * we know the value is cindex
934 * This check is safe even if bits == KEYLENGTH due to the
935 * fact that we can only allocate a node with 32 bits if a
936 * long is greater than 32 bits.
938 if (index >= (1ul << n->bits)) {
943 /* keep searching until we find a perfect match leaf or NULL */
944 } while (IS_TNODE(n));
951 /* Return the first fib alias matching TOS with
952 * priority less than or equal to PRIO.
954 static struct fib_alias *fib_find_alias(struct hlist_head *fah, u8 slen,
957 struct fib_alias *fa;
962 hlist_for_each_entry(fa, fah, fa_list) {
963 if (fa->fa_slen < slen)
965 if (fa->fa_slen != slen)
967 if (fa->fa_tos > tos)
969 if (fa->fa_info->fib_priority >= prio || fa->fa_tos < tos)
976 static void trie_rebalance(struct trie *t, struct key_vector *tn)
982 static int fib_insert_node(struct trie *t, struct key_vector *tp,
983 struct fib_alias *new, t_key key)
985 struct key_vector *n, *l;
987 l = leaf_new(key, new);
991 /* retrieve child from parent node */
992 n = get_child(tp, get_index(key, tp));
994 /* Case 2: n is a LEAF or a TNODE and the key doesn't match.
996 * Add a new tnode here
997 * first tnode need some special handling
998 * leaves us in position for handling as case 3
1001 struct key_vector *tn;
1003 tn = tnode_new(key, __fls(key ^ n->key), 1);
1007 /* initialize routes out of node */
1008 NODE_INIT_PARENT(tn, tp);
1009 put_child(tn, get_index(key, tn) ^ 1, n);
1011 /* start adding routes into the node */
1012 put_child_root(tp, key, tn);
1013 node_set_parent(n, tn);
1015 /* parent now has a NULL spot where the leaf can go */
1019 /* Case 3: n is NULL, and will just insert a new leaf */
1020 NODE_INIT_PARENT(l, tp);
1021 put_child_root(tp, key, l);
1022 trie_rebalance(t, tp);
1031 static int fib_insert_alias(struct trie *t, struct key_vector *tp,
1032 struct key_vector *l, struct fib_alias *new,
1033 struct fib_alias *fa, t_key key)
1036 return fib_insert_node(t, tp, new, key);
1039 hlist_add_before_rcu(&new->fa_list, &fa->fa_list);
1041 struct fib_alias *last;
1043 hlist_for_each_entry(last, &l->leaf, fa_list) {
1044 if (new->fa_slen < last->fa_slen)
1050 hlist_add_behind_rcu(&new->fa_list, &fa->fa_list);
1052 hlist_add_head_rcu(&new->fa_list, &l->leaf);
1055 /* if we added to the tail node then we need to update slen */
1056 if (l->slen < new->fa_slen) {
1057 l->slen = new->fa_slen;
1058 leaf_push_suffix(tp, l);
1064 /* Caller must hold RTNL. */
1065 int fib_table_insert(struct fib_table *tb, struct fib_config *cfg)
1067 struct trie *t = (struct trie *)tb->tb_data;
1068 struct fib_alias *fa, *new_fa;
1069 struct key_vector *l, *tp;
1070 struct fib_info *fi;
1071 u8 plen = cfg->fc_dst_len;
1072 u8 slen = KEYLENGTH - plen;
1073 u8 tos = cfg->fc_tos;
1077 if (plen > KEYLENGTH)
1080 key = ntohl(cfg->fc_dst);
1082 pr_debug("Insert table=%u %08x/%d\n", tb->tb_id, key, plen);
1084 if ((plen < KEYLENGTH) && (key << plen))
1087 fi = fib_create_info(cfg);
1093 l = fib_find_node(t, &tp, key);
1094 fa = l ? fib_find_alias(&l->leaf, slen, tos, fi->fib_priority) : NULL;
1096 /* Now fa, if non-NULL, points to the first fib alias
1097 * with the same keys [prefix,tos,priority], if such key already
1098 * exists or to the node before which we will insert new one.
1100 * If fa is NULL, we will need to allocate a new one and
1101 * insert to the tail of the section matching the suffix length
1105 if (fa && fa->fa_tos == tos &&
1106 fa->fa_info->fib_priority == fi->fib_priority) {
1107 struct fib_alias *fa_first, *fa_match;
1110 if (cfg->fc_nlflags & NLM_F_EXCL)
1114 * 1. Find exact match for type, scope, fib_info to avoid
1116 * 2. Find next 'fa' (or head), NLM_F_APPEND inserts before it
1120 hlist_for_each_entry_from(fa, fa_list) {
1121 if ((fa->fa_slen != slen) || (fa->fa_tos != tos))
1123 if (fa->fa_info->fib_priority != fi->fib_priority)
1125 if (fa->fa_type == cfg->fc_type &&
1126 fa->fa_info == fi) {
1132 if (cfg->fc_nlflags & NLM_F_REPLACE) {
1133 struct fib_info *fi_drop;
1143 new_fa = kmem_cache_alloc(fn_alias_kmem, GFP_KERNEL);
1147 fi_drop = fa->fa_info;
1148 new_fa->fa_tos = fa->fa_tos;
1149 new_fa->fa_info = fi;
1150 new_fa->fa_type = cfg->fc_type;
1151 state = fa->fa_state;
1152 new_fa->fa_state = state & ~FA_S_ACCESSED;
1153 new_fa->fa_slen = fa->fa_slen;
1155 err = netdev_switch_fib_ipv4_add(key, plen, fi,
1161 netdev_switch_fib_ipv4_abort(fi);
1162 kmem_cache_free(fn_alias_kmem, new_fa);
1166 hlist_replace_rcu(&fa->fa_list, &new_fa->fa_list);
1168 alias_free_mem_rcu(fa);
1170 fib_release_info(fi_drop);
1171 if (state & FA_S_ACCESSED)
1172 rt_cache_flush(cfg->fc_nlinfo.nl_net);
1173 rtmsg_fib(RTM_NEWROUTE, htonl(key), new_fa, plen,
1174 tb->tb_id, &cfg->fc_nlinfo, NLM_F_REPLACE);
1178 /* Error if we find a perfect match which
1179 * uses the same scope, type, and nexthop
1185 if (!(cfg->fc_nlflags & NLM_F_APPEND))
1189 if (!(cfg->fc_nlflags & NLM_F_CREATE))
1193 new_fa = kmem_cache_alloc(fn_alias_kmem, GFP_KERNEL);
1197 new_fa->fa_info = fi;
1198 new_fa->fa_tos = tos;
1199 new_fa->fa_type = cfg->fc_type;
1200 new_fa->fa_state = 0;
1201 new_fa->fa_slen = slen;
1203 /* (Optionally) offload fib entry to switch hardware. */
1204 err = netdev_switch_fib_ipv4_add(key, plen, fi, tos,
1209 netdev_switch_fib_ipv4_abort(fi);
1210 goto out_free_new_fa;
1213 /* Insert new entry to the list. */
1214 err = fib_insert_alias(t, tp, l, new_fa, fa, key);
1216 goto out_sw_fib_del;
1219 tb->tb_num_default++;
1221 rt_cache_flush(cfg->fc_nlinfo.nl_net);
1222 rtmsg_fib(RTM_NEWROUTE, htonl(key), new_fa, plen, tb->tb_id,
1223 &cfg->fc_nlinfo, 0);
1228 netdev_switch_fib_ipv4_del(key, plen, fi, tos, cfg->fc_type, tb->tb_id);
1230 kmem_cache_free(fn_alias_kmem, new_fa);
1232 fib_release_info(fi);
1237 static inline t_key prefix_mismatch(t_key key, struct key_vector *n)
1239 t_key prefix = n->key;
1241 return (key ^ prefix) & (prefix | -prefix);
1244 /* should be called with rcu_read_lock */
1245 int fib_table_lookup(struct fib_table *tb, const struct flowi4 *flp,
1246 struct fib_result *res, int fib_flags)
1248 struct trie *t = (struct trie *)tb->tb_data;
1249 #ifdef CONFIG_IP_FIB_TRIE_STATS
1250 struct trie_use_stats __percpu *stats = t->stats;
1252 const t_key key = ntohl(flp->daddr);
1253 struct key_vector *n, *pn;
1254 struct fib_alias *fa;
1255 unsigned long index;
1261 n = get_child_rcu(pn, cindex);
1265 #ifdef CONFIG_IP_FIB_TRIE_STATS
1266 this_cpu_inc(stats->gets);
1269 /* Step 1: Travel to the longest prefix match in the trie */
1271 index = get_cindex(key, n);
1273 /* This bit of code is a bit tricky but it combines multiple
1274 * checks into a single check. The prefix consists of the
1275 * prefix plus zeros for the "bits" in the prefix. The index
1276 * is the difference between the key and this value. From
1277 * this we can actually derive several pieces of data.
1278 * if (index >= (1ul << bits))
1279 * we have a mismatch in skip bits and failed
1281 * we know the value is cindex
1283 * This check is safe even if bits == KEYLENGTH due to the
1284 * fact that we can only allocate a node with 32 bits if a
1285 * long is greater than 32 bits.
1287 if (index >= (1ul << n->bits))
1290 /* we have found a leaf. Prefixes have already been compared */
1294 /* only record pn and cindex if we are going to be chopping
1295 * bits later. Otherwise we are just wasting cycles.
1297 if (n->slen > n->pos) {
1302 n = get_child_rcu(n, index);
1307 /* Step 2: Sort out leaves and begin backtracing for longest prefix */
1309 /* record the pointer where our next node pointer is stored */
1310 struct key_vector __rcu **cptr = n->tnode;
1312 /* This test verifies that none of the bits that differ
1313 * between the key and the prefix exist in the region of
1314 * the lsb and higher in the prefix.
1316 if (unlikely(prefix_mismatch(key, n)) || (n->slen == n->pos))
1319 /* exit out and process leaf */
1320 if (unlikely(IS_LEAF(n)))
1323 /* Don't bother recording parent info. Since we are in
1324 * prefix match mode we will have to come back to wherever
1325 * we started this traversal anyway
1328 while ((n = rcu_dereference(*cptr)) == NULL) {
1330 #ifdef CONFIG_IP_FIB_TRIE_STATS
1332 this_cpu_inc(stats->null_node_hit);
1334 /* If we are at cindex 0 there are no more bits for
1335 * us to strip at this level so we must ascend back
1336 * up one level to see if there are any more bits to
1337 * be stripped there.
1340 t_key pkey = pn->key;
1342 /* If we don't have a parent then there is
1343 * nothing for us to do as we do not have any
1344 * further nodes to parse.
1348 #ifdef CONFIG_IP_FIB_TRIE_STATS
1349 this_cpu_inc(stats->backtrack);
1351 /* Get Child's index */
1352 pn = node_parent_rcu(pn);
1353 cindex = get_index(pkey, pn);
1356 /* strip the least significant bit from the cindex */
1357 cindex &= cindex - 1;
1359 /* grab pointer for next child node */
1360 cptr = &pn->tnode[cindex];
1365 /* this line carries forward the xor from earlier in the function */
1366 index = key ^ n->key;
1368 /* Step 3: Process the leaf, if that fails fall back to backtracing */
1369 hlist_for_each_entry_rcu(fa, &n->leaf, fa_list) {
1370 struct fib_info *fi = fa->fa_info;
1373 if ((index >= (1ul << fa->fa_slen)) &&
1374 ((BITS_PER_LONG > KEYLENGTH) || (fa->fa_slen != KEYLENGTH)))
1376 if (fa->fa_tos && fa->fa_tos != flp->flowi4_tos)
1380 if (fa->fa_info->fib_scope < flp->flowi4_scope)
1382 fib_alias_accessed(fa);
1383 err = fib_props[fa->fa_type].error;
1384 if (unlikely(err < 0)) {
1385 #ifdef CONFIG_IP_FIB_TRIE_STATS
1386 this_cpu_inc(stats->semantic_match_passed);
1390 if (fi->fib_flags & RTNH_F_DEAD)
1392 for (nhsel = 0; nhsel < fi->fib_nhs; nhsel++) {
1393 const struct fib_nh *nh = &fi->fib_nh[nhsel];
1395 if (nh->nh_flags & RTNH_F_DEAD)
1397 if (flp->flowi4_oif && flp->flowi4_oif != nh->nh_oif)
1400 if (!(fib_flags & FIB_LOOKUP_NOREF))
1401 atomic_inc(&fi->fib_clntref);
1403 res->prefixlen = KEYLENGTH - fa->fa_slen;
1404 res->nh_sel = nhsel;
1405 res->type = fa->fa_type;
1406 res->scope = fi->fib_scope;
1409 res->fa_head = &n->leaf;
1410 #ifdef CONFIG_IP_FIB_TRIE_STATS
1411 this_cpu_inc(stats->semantic_match_passed);
1416 #ifdef CONFIG_IP_FIB_TRIE_STATS
1417 this_cpu_inc(stats->semantic_match_miss);
1421 EXPORT_SYMBOL_GPL(fib_table_lookup);
1423 static void fib_remove_alias(struct trie *t, struct key_vector *tp,
1424 struct key_vector *l, struct fib_alias *old)
1426 /* record the location of the previous list_info entry */
1427 struct hlist_node **pprev = old->fa_list.pprev;
1428 struct fib_alias *fa = hlist_entry(pprev, typeof(*fa), fa_list.next);
1430 /* remove the fib_alias from the list */
1431 hlist_del_rcu(&old->fa_list);
1433 /* if we emptied the list this leaf will be freed and we can sort
1434 * out parent suffix lengths as a part of trie_rebalance
1436 if (hlist_empty(&l->leaf)) {
1437 put_child_root(tp, l->key, NULL);
1439 trie_rebalance(t, tp);
1443 /* only access fa if it is pointing at the last valid hlist_node */
1447 /* update the trie with the latest suffix length */
1448 l->slen = fa->fa_slen;
1449 leaf_pull_suffix(tp, l);
1452 /* Caller must hold RTNL. */
1453 int fib_table_delete(struct fib_table *tb, struct fib_config *cfg)
1455 struct trie *t = (struct trie *) tb->tb_data;
1456 struct fib_alias *fa, *fa_to_delete;
1457 struct key_vector *l, *tp;
1458 u8 plen = cfg->fc_dst_len;
1459 u8 slen = KEYLENGTH - plen;
1460 u8 tos = cfg->fc_tos;
1463 if (plen > KEYLENGTH)
1466 key = ntohl(cfg->fc_dst);
1468 if ((plen < KEYLENGTH) && (key << plen))
1471 l = fib_find_node(t, &tp, key);
1475 fa = fib_find_alias(&l->leaf, slen, tos, 0);
1479 pr_debug("Deleting %08x/%d tos=%d t=%p\n", key, plen, tos, t);
1481 fa_to_delete = NULL;
1482 hlist_for_each_entry_from(fa, fa_list) {
1483 struct fib_info *fi = fa->fa_info;
1485 if ((fa->fa_slen != slen) || (fa->fa_tos != tos))
1488 if ((!cfg->fc_type || fa->fa_type == cfg->fc_type) &&
1489 (cfg->fc_scope == RT_SCOPE_NOWHERE ||
1490 fa->fa_info->fib_scope == cfg->fc_scope) &&
1491 (!cfg->fc_prefsrc ||
1492 fi->fib_prefsrc == cfg->fc_prefsrc) &&
1493 (!cfg->fc_protocol ||
1494 fi->fib_protocol == cfg->fc_protocol) &&
1495 fib_nh_match(cfg, fi) == 0) {
1504 netdev_switch_fib_ipv4_del(key, plen, fa_to_delete->fa_info, tos,
1505 cfg->fc_type, tb->tb_id);
1507 rtmsg_fib(RTM_DELROUTE, htonl(key), fa_to_delete, plen, tb->tb_id,
1508 &cfg->fc_nlinfo, 0);
1511 tb->tb_num_default--;
1513 fib_remove_alias(t, tp, l, fa_to_delete);
1515 if (fa_to_delete->fa_state & FA_S_ACCESSED)
1516 rt_cache_flush(cfg->fc_nlinfo.nl_net);
1518 fib_release_info(fa_to_delete->fa_info);
1519 alias_free_mem_rcu(fa_to_delete);
1523 /* Scan for the next leaf starting at the provided key value */
1524 static struct key_vector *leaf_walk_rcu(struct key_vector **tn, t_key key)
1526 struct key_vector *pn, *n = *tn;
1527 unsigned long cindex;
1529 /* this loop is meant to try and find the key in the trie */
1531 /* record parent and next child index */
1533 cindex = get_index(key, pn);
1535 if (cindex >> pn->bits)
1538 /* descend into the next child */
1539 n = get_child_rcu(pn, cindex++);
1543 /* guarantee forward progress on the keys */
1544 if (IS_LEAF(n) && (n->key >= key))
1546 } while (IS_TNODE(n));
1548 /* this loop will search for the next leaf with a greater key */
1549 while (!IS_TRIE(pn)) {
1550 /* if we exhausted the parent node we will need to climb */
1551 if (cindex >= (1ul << pn->bits)) {
1552 t_key pkey = pn->key;
1554 pn = node_parent_rcu(pn);
1555 cindex = get_index(pkey, pn) + 1;
1559 /* grab the next available node */
1560 n = get_child_rcu(pn, cindex++);
1564 /* no need to compare keys since we bumped the index */
1568 /* Rescan start scanning in new node */
1574 return NULL; /* Root of trie */
1576 /* if we are at the limit for keys just return NULL for the tnode */
1581 /* Caller must hold RTNL */
1582 void fib_table_flush_external(struct fib_table *tb)
1584 struct trie *t = (struct trie *)tb->tb_data;
1585 struct key_vector *pn = t->kv;
1586 unsigned long cindex = 1;
1587 struct hlist_node *tmp;
1588 struct fib_alias *fa;
1590 /* walk trie in reverse order */
1592 struct key_vector *n;
1595 t_key pkey = pn->key;
1597 /* cannot resize the trie vector */
1601 /* no need to resize like in flush below */
1602 pn = node_parent(pn);
1603 cindex = get_index(pkey, pn);
1608 /* grab the next available node */
1609 n = get_child(pn, cindex);
1614 /* record pn and cindex for leaf walking */
1616 cindex = 1ul << n->bits;
1621 hlist_for_each_entry_safe(fa, tmp, &n->leaf, fa_list) {
1622 struct fib_info *fi = fa->fa_info;
1624 if (!fi || !(fi->fib_flags & RTNH_F_EXTERNAL))
1627 netdev_switch_fib_ipv4_del(n->key,
1628 KEYLENGTH - fa->fa_slen,
1630 fa->fa_type, tb->tb_id);
1635 /* Caller must hold RTNL. */
1636 int fib_table_flush(struct fib_table *tb)
1638 struct trie *t = (struct trie *)tb->tb_data;
1639 struct key_vector *pn = t->kv;
1640 unsigned long cindex = 1;
1641 struct hlist_node *tmp;
1642 struct fib_alias *fa;
1645 /* walk trie in reverse order */
1647 unsigned char slen = 0;
1648 struct key_vector *n;
1651 t_key pkey = pn->key;
1653 /* cannot resize the trie vector */
1657 /* resize completed node */
1659 cindex = get_index(pkey, pn);
1664 /* grab the next available node */
1665 n = get_child(pn, cindex);
1670 /* record pn and cindex for leaf walking */
1672 cindex = 1ul << n->bits;
1677 hlist_for_each_entry_safe(fa, tmp, &n->leaf, fa_list) {
1678 struct fib_info *fi = fa->fa_info;
1680 if (!fi || !(fi->fib_flags & RTNH_F_DEAD)) {
1685 netdev_switch_fib_ipv4_del(n->key,
1686 KEYLENGTH - fa->fa_slen,
1688 fa->fa_type, tb->tb_id);
1689 hlist_del_rcu(&fa->fa_list);
1690 fib_release_info(fa->fa_info);
1691 alias_free_mem_rcu(fa);
1695 /* update leaf slen */
1698 if (hlist_empty(&n->leaf)) {
1699 put_child_root(pn, n->key, NULL);
1702 leaf_pull_suffix(pn, n);
1706 pr_debug("trie_flush found=%d\n", found);
1710 static void __trie_free_rcu(struct rcu_head *head)
1712 struct fib_table *tb = container_of(head, struct fib_table, rcu);
1713 #ifdef CONFIG_IP_FIB_TRIE_STATS
1714 struct trie *t = (struct trie *)tb->tb_data;
1716 free_percpu(t->stats);
1717 #endif /* CONFIG_IP_FIB_TRIE_STATS */
1721 void fib_free_table(struct fib_table *tb)
1723 call_rcu(&tb->rcu, __trie_free_rcu);
1726 static int fn_trie_dump_leaf(struct key_vector *l, struct fib_table *tb,
1727 struct sk_buff *skb, struct netlink_callback *cb)
1729 __be32 xkey = htonl(l->key);
1730 struct fib_alias *fa;
1736 /* rcu_read_lock is hold by caller */
1737 hlist_for_each_entry_rcu(fa, &l->leaf, fa_list) {
1743 if (fib_dump_info(skb, NETLINK_CB(cb->skb).portid,
1749 KEYLENGTH - fa->fa_slen,
1751 fa->fa_info, NLM_F_MULTI) < 0) {
1762 /* rcu_read_lock needs to be hold by caller from readside */
1763 int fib_table_dump(struct fib_table *tb, struct sk_buff *skb,
1764 struct netlink_callback *cb)
1766 struct trie *t = (struct trie *)tb->tb_data;
1767 struct key_vector *l, *tp = t->kv;
1768 /* Dump starting at last key.
1769 * Note: 0.0.0.0/0 (ie default) is first key.
1771 int count = cb->args[2];
1772 t_key key = cb->args[3];
1774 while ((l = leaf_walk_rcu(&tp, key)) != NULL) {
1775 if (fn_trie_dump_leaf(l, tb, skb, cb) < 0) {
1777 cb->args[2] = count;
1784 memset(&cb->args[4], 0,
1785 sizeof(cb->args) - 4*sizeof(cb->args[0]));
1787 /* stop loop if key wrapped back to 0 */
1793 cb->args[2] = count;
1798 void __init fib_trie_init(void)
1800 fn_alias_kmem = kmem_cache_create("ip_fib_alias",
1801 sizeof(struct fib_alias),
1802 0, SLAB_PANIC, NULL);
1804 trie_leaf_kmem = kmem_cache_create("ip_fib_trie",
1806 0, SLAB_PANIC, NULL);
1809 struct fib_table *fib_trie_table(u32 id)
1811 struct fib_table *tb;
1814 tb = kzalloc(sizeof(*tb) + sizeof(struct trie), GFP_KERNEL);
1819 tb->tb_default = -1;
1820 tb->tb_num_default = 0;
1822 t = (struct trie *) tb->tb_data;
1823 t->kv[0].pos = KEYLENGTH;
1824 t->kv[0].slen = KEYLENGTH;
1825 #ifdef CONFIG_IP_FIB_TRIE_STATS
1826 t->stats = alloc_percpu(struct trie_use_stats);
1836 #ifdef CONFIG_PROC_FS
1837 /* Depth first Trie walk iterator */
1838 struct fib_trie_iter {
1839 struct seq_net_private p;
1840 struct fib_table *tb;
1841 struct key_vector *tnode;
1846 static struct key_vector *fib_trie_get_next(struct fib_trie_iter *iter)
1848 unsigned long cindex = iter->index;
1849 struct key_vector *pn = iter->tnode;
1852 pr_debug("get_next iter={node=%p index=%d depth=%d}\n",
1853 iter->tnode, iter->index, iter->depth);
1855 while (!IS_TRIE(pn)) {
1856 while (cindex < child_length(pn)) {
1857 struct key_vector *n = get_child_rcu(pn, cindex++);
1864 iter->index = cindex;
1866 /* push down one level */
1875 /* Current node exhausted, pop back up */
1877 pn = node_parent_rcu(pn);
1878 cindex = get_index(pkey, pn) + 1;
1882 /* record root node so further searches know we are done */
1889 static struct key_vector *fib_trie_get_first(struct fib_trie_iter *iter,
1892 struct key_vector *n, *pn = t->kv;
1897 n = rcu_dereference(pn->tnode[0]);
1914 static void trie_collect_stats(struct trie *t, struct trie_stat *s)
1916 struct key_vector *n;
1917 struct fib_trie_iter iter;
1919 memset(s, 0, sizeof(*s));
1922 for (n = fib_trie_get_first(&iter, t); n; n = fib_trie_get_next(&iter)) {
1924 struct fib_alias *fa;
1927 s->totdepth += iter.depth;
1928 if (iter.depth > s->maxdepth)
1929 s->maxdepth = iter.depth;
1931 hlist_for_each_entry_rcu(fa, &n->leaf, fa_list)
1935 if (n->bits < MAX_STAT_DEPTH)
1936 s->nodesizes[n->bits]++;
1937 s->nullpointers += tn_info(n)->empty_children;
1944 * This outputs /proc/net/fib_triestats
1946 static void trie_show_stats(struct seq_file *seq, struct trie_stat *stat)
1948 unsigned int i, max, pointers, bytes, avdepth;
1951 avdepth = stat->totdepth*100 / stat->leaves;
1955 seq_printf(seq, "\tAver depth: %u.%02d\n",
1956 avdepth / 100, avdepth % 100);
1957 seq_printf(seq, "\tMax depth: %u\n", stat->maxdepth);
1959 seq_printf(seq, "\tLeaves: %u\n", stat->leaves);
1960 bytes = LEAF_SIZE * stat->leaves;
1962 seq_printf(seq, "\tPrefixes: %u\n", stat->prefixes);
1963 bytes += sizeof(struct fib_alias) * stat->prefixes;
1965 seq_printf(seq, "\tInternal nodes: %u\n\t", stat->tnodes);
1966 bytes += TNODE_SIZE(0) * stat->tnodes;
1968 max = MAX_STAT_DEPTH;
1969 while (max > 0 && stat->nodesizes[max-1] == 0)
1973 for (i = 1; i < max; i++)
1974 if (stat->nodesizes[i] != 0) {
1975 seq_printf(seq, " %u: %u", i, stat->nodesizes[i]);
1976 pointers += (1<<i) * stat->nodesizes[i];
1978 seq_putc(seq, '\n');
1979 seq_printf(seq, "\tPointers: %u\n", pointers);
1981 bytes += sizeof(struct key_vector *) * pointers;
1982 seq_printf(seq, "Null ptrs: %u\n", stat->nullpointers);
1983 seq_printf(seq, "Total size: %u kB\n", (bytes + 1023) / 1024);
1986 #ifdef CONFIG_IP_FIB_TRIE_STATS
1987 static void trie_show_usage(struct seq_file *seq,
1988 const struct trie_use_stats __percpu *stats)
1990 struct trie_use_stats s = { 0 };
1993 /* loop through all of the CPUs and gather up the stats */
1994 for_each_possible_cpu(cpu) {
1995 const struct trie_use_stats *pcpu = per_cpu_ptr(stats, cpu);
1997 s.gets += pcpu->gets;
1998 s.backtrack += pcpu->backtrack;
1999 s.semantic_match_passed += pcpu->semantic_match_passed;
2000 s.semantic_match_miss += pcpu->semantic_match_miss;
2001 s.null_node_hit += pcpu->null_node_hit;
2002 s.resize_node_skipped += pcpu->resize_node_skipped;
2005 seq_printf(seq, "\nCounters:\n---------\n");
2006 seq_printf(seq, "gets = %u\n", s.gets);
2007 seq_printf(seq, "backtracks = %u\n", s.backtrack);
2008 seq_printf(seq, "semantic match passed = %u\n",
2009 s.semantic_match_passed);
2010 seq_printf(seq, "semantic match miss = %u\n", s.semantic_match_miss);
2011 seq_printf(seq, "null node hit= %u\n", s.null_node_hit);
2012 seq_printf(seq, "skipped node resize = %u\n\n", s.resize_node_skipped);
2014 #endif /* CONFIG_IP_FIB_TRIE_STATS */
2016 static void fib_table_print(struct seq_file *seq, struct fib_table *tb)
2018 if (tb->tb_id == RT_TABLE_LOCAL)
2019 seq_puts(seq, "Local:\n");
2020 else if (tb->tb_id == RT_TABLE_MAIN)
2021 seq_puts(seq, "Main:\n");
2023 seq_printf(seq, "Id %d:\n", tb->tb_id);
2027 static int fib_triestat_seq_show(struct seq_file *seq, void *v)
2029 struct net *net = (struct net *)seq->private;
2033 "Basic info: size of leaf:"
2034 " %Zd bytes, size of tnode: %Zd bytes.\n",
2035 LEAF_SIZE, TNODE_SIZE(0));
2037 for (h = 0; h < FIB_TABLE_HASHSZ; h++) {
2038 struct hlist_head *head = &net->ipv4.fib_table_hash[h];
2039 struct fib_table *tb;
2041 hlist_for_each_entry_rcu(tb, head, tb_hlist) {
2042 struct trie *t = (struct trie *) tb->tb_data;
2043 struct trie_stat stat;
2048 fib_table_print(seq, tb);
2050 trie_collect_stats(t, &stat);
2051 trie_show_stats(seq, &stat);
2052 #ifdef CONFIG_IP_FIB_TRIE_STATS
2053 trie_show_usage(seq, t->stats);
2061 static int fib_triestat_seq_open(struct inode *inode, struct file *file)
2063 return single_open_net(inode, file, fib_triestat_seq_show);
2066 static const struct file_operations fib_triestat_fops = {
2067 .owner = THIS_MODULE,
2068 .open = fib_triestat_seq_open,
2070 .llseek = seq_lseek,
2071 .release = single_release_net,
2074 static struct key_vector *fib_trie_get_idx(struct seq_file *seq, loff_t pos)
2076 struct fib_trie_iter *iter = seq->private;
2077 struct net *net = seq_file_net(seq);
2081 for (h = 0; h < FIB_TABLE_HASHSZ; h++) {
2082 struct hlist_head *head = &net->ipv4.fib_table_hash[h];
2083 struct fib_table *tb;
2085 hlist_for_each_entry_rcu(tb, head, tb_hlist) {
2086 struct key_vector *n;
2088 for (n = fib_trie_get_first(iter,
2089 (struct trie *) tb->tb_data);
2090 n; n = fib_trie_get_next(iter))
2101 static void *fib_trie_seq_start(struct seq_file *seq, loff_t *pos)
2105 return fib_trie_get_idx(seq, *pos);
2108 static void *fib_trie_seq_next(struct seq_file *seq, void *v, loff_t *pos)
2110 struct fib_trie_iter *iter = seq->private;
2111 struct net *net = seq_file_net(seq);
2112 struct fib_table *tb = iter->tb;
2113 struct hlist_node *tb_node;
2115 struct key_vector *n;
2118 /* next node in same table */
2119 n = fib_trie_get_next(iter);
2123 /* walk rest of this hash chain */
2124 h = tb->tb_id & (FIB_TABLE_HASHSZ - 1);
2125 while ((tb_node = rcu_dereference(hlist_next_rcu(&tb->tb_hlist)))) {
2126 tb = hlist_entry(tb_node, struct fib_table, tb_hlist);
2127 n = fib_trie_get_first(iter, (struct trie *) tb->tb_data);
2132 /* new hash chain */
2133 while (++h < FIB_TABLE_HASHSZ) {
2134 struct hlist_head *head = &net->ipv4.fib_table_hash[h];
2135 hlist_for_each_entry_rcu(tb, head, tb_hlist) {
2136 n = fib_trie_get_first(iter, (struct trie *) tb->tb_data);
2148 static void fib_trie_seq_stop(struct seq_file *seq, void *v)
2154 static void seq_indent(struct seq_file *seq, int n)
2160 static inline const char *rtn_scope(char *buf, size_t len, enum rt_scope_t s)
2163 case RT_SCOPE_UNIVERSE: return "universe";
2164 case RT_SCOPE_SITE: return "site";
2165 case RT_SCOPE_LINK: return "link";
2166 case RT_SCOPE_HOST: return "host";
2167 case RT_SCOPE_NOWHERE: return "nowhere";
2169 snprintf(buf, len, "scope=%d", s);
2174 static const char *const rtn_type_names[__RTN_MAX] = {
2175 [RTN_UNSPEC] = "UNSPEC",
2176 [RTN_UNICAST] = "UNICAST",
2177 [RTN_LOCAL] = "LOCAL",
2178 [RTN_BROADCAST] = "BROADCAST",
2179 [RTN_ANYCAST] = "ANYCAST",
2180 [RTN_MULTICAST] = "MULTICAST",
2181 [RTN_BLACKHOLE] = "BLACKHOLE",
2182 [RTN_UNREACHABLE] = "UNREACHABLE",
2183 [RTN_PROHIBIT] = "PROHIBIT",
2184 [RTN_THROW] = "THROW",
2186 [RTN_XRESOLVE] = "XRESOLVE",
2189 static inline const char *rtn_type(char *buf, size_t len, unsigned int t)
2191 if (t < __RTN_MAX && rtn_type_names[t])
2192 return rtn_type_names[t];
2193 snprintf(buf, len, "type %u", t);
2197 /* Pretty print the trie */
2198 static int fib_trie_seq_show(struct seq_file *seq, void *v)
2200 const struct fib_trie_iter *iter = seq->private;
2201 struct key_vector *n = v;
2203 if (IS_TRIE(node_parent_rcu(n)))
2204 fib_table_print(seq, iter->tb);
2207 __be32 prf = htonl(n->key);
2209 seq_indent(seq, iter->depth-1);
2210 seq_printf(seq, " +-- %pI4/%zu %u %u %u\n",
2211 &prf, KEYLENGTH - n->pos - n->bits, n->bits,
2212 tn_info(n)->full_children,
2213 tn_info(n)->empty_children);
2215 __be32 val = htonl(n->key);
2216 struct fib_alias *fa;
2218 seq_indent(seq, iter->depth);
2219 seq_printf(seq, " |-- %pI4\n", &val);
2221 hlist_for_each_entry_rcu(fa, &n->leaf, fa_list) {
2222 char buf1[32], buf2[32];
2224 seq_indent(seq, iter->depth + 1);
2225 seq_printf(seq, " /%zu %s %s",
2226 KEYLENGTH - fa->fa_slen,
2227 rtn_scope(buf1, sizeof(buf1),
2228 fa->fa_info->fib_scope),
2229 rtn_type(buf2, sizeof(buf2),
2232 seq_printf(seq, " tos=%d", fa->fa_tos);
2233 seq_putc(seq, '\n');
2240 static const struct seq_operations fib_trie_seq_ops = {
2241 .start = fib_trie_seq_start,
2242 .next = fib_trie_seq_next,
2243 .stop = fib_trie_seq_stop,
2244 .show = fib_trie_seq_show,
2247 static int fib_trie_seq_open(struct inode *inode, struct file *file)
2249 return seq_open_net(inode, file, &fib_trie_seq_ops,
2250 sizeof(struct fib_trie_iter));
2253 static const struct file_operations fib_trie_fops = {
2254 .owner = THIS_MODULE,
2255 .open = fib_trie_seq_open,
2257 .llseek = seq_lseek,
2258 .release = seq_release_net,
2261 struct fib_route_iter {
2262 struct seq_net_private p;
2263 struct fib_table *main_tb;
2264 struct key_vector *tnode;
2269 static struct key_vector *fib_route_get_idx(struct fib_route_iter *iter,
2272 struct fib_table *tb = iter->main_tb;
2273 struct key_vector *l, **tp = &iter->tnode;
2277 /* use cache location of next-to-find key */
2278 if (iter->pos > 0 && pos >= iter->pos) {
2282 t = (struct trie *)tb->tb_data;
2283 iter->tnode = t->kv;
2288 while ((l = leaf_walk_rcu(tp, key)) != NULL) {
2297 /* handle unlikely case of a key wrap */
2303 iter->key = key; /* remember it */
2305 iter->pos = 0; /* forget it */
2310 static void *fib_route_seq_start(struct seq_file *seq, loff_t *pos)
2313 struct fib_route_iter *iter = seq->private;
2314 struct fib_table *tb;
2319 tb = fib_get_table(seq_file_net(seq), RT_TABLE_MAIN);
2326 return fib_route_get_idx(iter, *pos);
2328 t = (struct trie *)tb->tb_data;
2329 iter->tnode = t->kv;
2333 return SEQ_START_TOKEN;
2336 static void *fib_route_seq_next(struct seq_file *seq, void *v, loff_t *pos)
2338 struct fib_route_iter *iter = seq->private;
2339 struct key_vector *l = NULL;
2340 t_key key = iter->key;
2344 /* only allow key of 0 for start of sequence */
2345 if ((v == SEQ_START_TOKEN) || key)
2346 l = leaf_walk_rcu(&iter->tnode, key);
2349 iter->key = l->key + 1;
2358 static void fib_route_seq_stop(struct seq_file *seq, void *v)
2364 static unsigned int fib_flag_trans(int type, __be32 mask, const struct fib_info *fi)
2366 unsigned int flags = 0;
2368 if (type == RTN_UNREACHABLE || type == RTN_PROHIBIT)
2370 if (fi && fi->fib_nh->nh_gw)
2371 flags |= RTF_GATEWAY;
2372 if (mask == htonl(0xFFFFFFFF))
2379 * This outputs /proc/net/route.
2380 * The format of the file is not supposed to be changed
2381 * and needs to be same as fib_hash output to avoid breaking
2384 static int fib_route_seq_show(struct seq_file *seq, void *v)
2386 struct fib_alias *fa;
2387 struct key_vector *l = v;
2390 if (v == SEQ_START_TOKEN) {
2391 seq_printf(seq, "%-127s\n", "Iface\tDestination\tGateway "
2392 "\tFlags\tRefCnt\tUse\tMetric\tMask\t\tMTU"
2397 prefix = htonl(l->key);
2399 hlist_for_each_entry_rcu(fa, &l->leaf, fa_list) {
2400 const struct fib_info *fi = fa->fa_info;
2401 __be32 mask = inet_make_mask(KEYLENGTH - fa->fa_slen);
2402 unsigned int flags = fib_flag_trans(fa->fa_type, mask, fi);
2404 if ((fa->fa_type == RTN_BROADCAST) ||
2405 (fa->fa_type == RTN_MULTICAST))
2408 seq_setwidth(seq, 127);
2412 "%s\t%08X\t%08X\t%04X\t%d\t%u\t"
2413 "%d\t%08X\t%d\t%u\t%u",
2414 fi->fib_dev ? fi->fib_dev->name : "*",
2416 fi->fib_nh->nh_gw, flags, 0, 0,
2420 fi->fib_advmss + 40 : 0),
2425 "*\t%08X\t%08X\t%04X\t%d\t%u\t"
2426 "%d\t%08X\t%d\t%u\t%u",
2427 prefix, 0, flags, 0, 0, 0,
2436 static const struct seq_operations fib_route_seq_ops = {
2437 .start = fib_route_seq_start,
2438 .next = fib_route_seq_next,
2439 .stop = fib_route_seq_stop,
2440 .show = fib_route_seq_show,
2443 static int fib_route_seq_open(struct inode *inode, struct file *file)
2445 return seq_open_net(inode, file, &fib_route_seq_ops,
2446 sizeof(struct fib_route_iter));
2449 static const struct file_operations fib_route_fops = {
2450 .owner = THIS_MODULE,
2451 .open = fib_route_seq_open,
2453 .llseek = seq_lseek,
2454 .release = seq_release_net,
2457 int __net_init fib_proc_init(struct net *net)
2459 if (!proc_create("fib_trie", S_IRUGO, net->proc_net, &fib_trie_fops))
2462 if (!proc_create("fib_triestat", S_IRUGO, net->proc_net,
2463 &fib_triestat_fops))
2466 if (!proc_create("route", S_IRUGO, net->proc_net, &fib_route_fops))
2472 remove_proc_entry("fib_triestat", net->proc_net);
2474 remove_proc_entry("fib_trie", net->proc_net);
2479 void __net_exit fib_proc_exit(struct net *net)
2481 remove_proc_entry("fib_trie", net->proc_net);
2482 remove_proc_entry("fib_triestat", net->proc_net);
2483 remove_proc_entry("route", net->proc_net);
2486 #endif /* CONFIG_PROC_FS */