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 descibed 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.nada.kth.se/~snilsson/public/papers/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
25 * Version: $Id: fib_trie.c,v 1.3 2005/06/08 14:20:01 robert Exp $
28 * Code from fib_hash has been reused which includes the following header:
31 * INET An implementation of the TCP/IP protocol suite for the LINUX
32 * operating system. INET is implemented using the BSD Socket
33 * interface as the means of communication with the user level.
35 * IPv4 FIB: lookup engine and maintenance routines.
38 * Authors: Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
40 * This program is free software; you can redistribute it and/or
41 * modify it under the terms of the GNU General Public License
42 * as published by the Free Software Foundation; either version
43 * 2 of the License, or (at your option) any later version.
45 * Substantial contributions to this work comes from:
47 * David S. Miller, <davem@davemloft.net>
48 * Stephen Hemminger <shemminger@osdl.org>
49 * Paul E. McKenney <paulmck@us.ibm.com>
50 * Patrick McHardy <kaber@trash.net>
53 #define VERSION "0.408"
55 #include <asm/uaccess.h>
56 #include <asm/system.h>
57 #include <linux/bitops.h>
58 #include <linux/types.h>
59 #include <linux/kernel.h>
61 #include <linux/string.h>
62 #include <linux/socket.h>
63 #include <linux/sockios.h>
64 #include <linux/errno.h>
66 #include <linux/inet.h>
67 #include <linux/inetdevice.h>
68 #include <linux/netdevice.h>
69 #include <linux/if_arp.h>
70 #include <linux/proc_fs.h>
71 #include <linux/rcupdate.h>
72 #include <linux/skbuff.h>
73 #include <linux/netlink.h>
74 #include <linux/init.h>
75 #include <linux/list.h>
76 #include <net/net_namespace.h>
78 #include <net/protocol.h>
79 #include <net/route.h>
82 #include <net/ip_fib.h>
83 #include "fib_lookup.h"
85 #define MAX_STAT_DEPTH 32
87 #define KEYLENGTH (8*sizeof(t_key))
89 typedef unsigned int t_key;
93 #define NODE_TYPE_MASK 0x1UL
94 #define NODE_TYPE(node) ((node)->parent & NODE_TYPE_MASK)
96 #define IS_TNODE(n) (!(n->parent & T_LEAF))
97 #define IS_LEAF(n) (n->parent & T_LEAF)
100 unsigned long parent;
105 unsigned long parent;
107 struct hlist_head list;
112 struct hlist_node hlist;
115 struct list_head falh;
119 unsigned long parent;
121 unsigned char pos; /* 2log(KEYLENGTH) bits needed */
122 unsigned char bits; /* 2log(KEYLENGTH) bits needed */
123 unsigned int full_children; /* KEYLENGTH bits needed */
124 unsigned int empty_children; /* KEYLENGTH bits needed */
126 struct node *child[0];
129 #ifdef CONFIG_IP_FIB_TRIE_STATS
130 struct trie_use_stats {
132 unsigned int backtrack;
133 unsigned int semantic_match_passed;
134 unsigned int semantic_match_miss;
135 unsigned int null_node_hit;
136 unsigned int resize_node_skipped;
141 unsigned int totdepth;
142 unsigned int maxdepth;
145 unsigned int nullpointers;
146 unsigned int prefixes;
147 unsigned int nodesizes[MAX_STAT_DEPTH];
152 #ifdef CONFIG_IP_FIB_TRIE_STATS
153 struct trie_use_stats stats;
157 static void put_child(struct trie *t, struct tnode *tn, int i, struct node *n);
158 static void tnode_put_child_reorg(struct tnode *tn, int i, struct node *n,
160 static struct node *resize(struct trie *t, struct tnode *tn);
161 static struct tnode *inflate(struct trie *t, struct tnode *tn);
162 static struct tnode *halve(struct trie *t, struct tnode *tn);
163 static void tnode_free(struct tnode *tn);
165 static struct kmem_cache *fn_alias_kmem __read_mostly;
166 static struct kmem_cache *trie_leaf_kmem __read_mostly;
168 static inline struct tnode *node_parent(struct node *node)
170 return (struct tnode *)(node->parent & ~NODE_TYPE_MASK);
173 static inline struct tnode *node_parent_rcu(struct node *node)
175 struct tnode *ret = node_parent(node);
177 return rcu_dereference(ret);
180 static inline void node_set_parent(struct node *node, struct tnode *ptr)
182 rcu_assign_pointer(node->parent,
183 (unsigned long)ptr | NODE_TYPE(node));
186 static inline struct node *tnode_get_child(struct tnode *tn, unsigned int i)
188 BUG_ON(i >= 1U << tn->bits);
193 static inline struct node *tnode_get_child_rcu(struct tnode *tn, unsigned int i)
195 struct node *ret = tnode_get_child(tn, i);
197 return rcu_dereference(ret);
200 static inline int tnode_child_length(const struct tnode *tn)
202 return 1 << tn->bits;
205 static inline t_key mask_pfx(t_key k, unsigned short l)
207 return (l == 0) ? 0 : k >> (KEYLENGTH-l) << (KEYLENGTH-l);
210 static inline t_key tkey_extract_bits(t_key a, int offset, int bits)
212 if (offset < KEYLENGTH)
213 return ((t_key)(a << offset)) >> (KEYLENGTH - bits);
218 static inline int tkey_equals(t_key a, t_key b)
223 static inline int tkey_sub_equals(t_key a, int offset, int bits, t_key b)
225 if (bits == 0 || offset >= KEYLENGTH)
227 bits = bits > KEYLENGTH ? KEYLENGTH : bits;
228 return ((a ^ b) << offset) >> (KEYLENGTH - bits) == 0;
231 static inline int tkey_mismatch(t_key a, int offset, t_key b)
238 while ((diff << i) >> (KEYLENGTH-1) == 0)
244 To understand this stuff, an understanding of keys and all their bits is
245 necessary. Every node in the trie has a key associated with it, but not
246 all of the bits in that key are significant.
248 Consider a node 'n' and its parent 'tp'.
250 If n is a leaf, every bit in its key is significant. Its presence is
251 necessitated by path compression, since during a tree traversal (when
252 searching for a leaf - unless we are doing an insertion) we will completely
253 ignore all skipped bits we encounter. Thus we need to verify, at the end of
254 a potentially successful search, that we have indeed been walking the
257 Note that we can never "miss" the correct key in the tree if present by
258 following the wrong path. Path compression ensures that segments of the key
259 that are the same for all keys with a given prefix are skipped, but the
260 skipped part *is* identical for each node in the subtrie below the skipped
261 bit! trie_insert() in this implementation takes care of that - note the
262 call to tkey_sub_equals() in trie_insert().
264 if n is an internal node - a 'tnode' here, the various parts of its key
265 have many different meanings.
268 _________________________________________________________________
269 | i | i | i | i | i | i | i | N | N | N | S | S | S | S | S | C |
270 -----------------------------------------------------------------
271 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
273 _________________________________________________________________
274 | C | C | C | u | u | u | u | u | u | u | u | u | u | u | u | u |
275 -----------------------------------------------------------------
276 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
283 First, let's just ignore the bits that come before the parent tp, that is
284 the bits from 0 to (tp->pos-1). They are *known* but at this point we do
285 not use them for anything.
287 The bits from (tp->pos) to (tp->pos + tp->bits - 1) - "N", above - are the
288 index into the parent's child array. That is, they will be used to find
289 'n' among tp's children.
291 The bits from (tp->pos + tp->bits) to (n->pos - 1) - "S" - are skipped bits
294 All the bits we have seen so far are significant to the node n. The rest
295 of the bits are really not needed or indeed known in n->key.
297 The bits from (n->pos) to (n->pos + n->bits - 1) - "C" - are the index into
298 n's child array, and will of course be different for each child.
301 The rest of the bits, from (n->pos + n->bits) onward, are completely unknown
306 static inline void check_tnode(const struct tnode *tn)
308 WARN_ON(tn && tn->pos+tn->bits > 32);
311 static const int halve_threshold = 25;
312 static const int inflate_threshold = 50;
313 static const int halve_threshold_root = 8;
314 static const int inflate_threshold_root = 15;
317 static void __alias_free_mem(struct rcu_head *head)
319 struct fib_alias *fa = container_of(head, struct fib_alias, rcu);
320 kmem_cache_free(fn_alias_kmem, fa);
323 static inline void alias_free_mem_rcu(struct fib_alias *fa)
325 call_rcu(&fa->rcu, __alias_free_mem);
328 static void __leaf_free_rcu(struct rcu_head *head)
330 struct leaf *l = container_of(head, struct leaf, rcu);
331 kmem_cache_free(trie_leaf_kmem, l);
334 static void __leaf_info_free_rcu(struct rcu_head *head)
336 kfree(container_of(head, struct leaf_info, rcu));
339 static inline void free_leaf_info(struct leaf_info *leaf)
341 call_rcu(&leaf->rcu, __leaf_info_free_rcu);
344 static struct tnode *tnode_alloc(size_t size)
348 if (size <= PAGE_SIZE)
349 return kzalloc(size, GFP_KERNEL);
351 pages = alloc_pages(GFP_KERNEL|__GFP_ZERO, get_order(size));
355 return page_address(pages);
358 static void __tnode_free_rcu(struct rcu_head *head)
360 struct tnode *tn = container_of(head, struct tnode, rcu);
361 size_t size = sizeof(struct tnode) +
362 (sizeof(struct node *) << tn->bits);
364 if (size <= PAGE_SIZE)
367 free_pages((unsigned long)tn, get_order(size));
370 static inline void tnode_free(struct tnode *tn)
373 struct leaf *l = (struct leaf *) tn;
374 call_rcu_bh(&l->rcu, __leaf_free_rcu);
376 call_rcu(&tn->rcu, __tnode_free_rcu);
379 static struct leaf *leaf_new(void)
381 struct leaf *l = kmem_cache_alloc(trie_leaf_kmem, GFP_KERNEL);
384 INIT_HLIST_HEAD(&l->list);
389 static struct leaf_info *leaf_info_new(int plen)
391 struct leaf_info *li = kmalloc(sizeof(struct leaf_info), GFP_KERNEL);
394 INIT_LIST_HEAD(&li->falh);
399 static struct tnode *tnode_new(t_key key, int pos, int bits)
401 size_t sz = sizeof(struct tnode) + (sizeof(struct node *) << bits);
402 struct tnode *tn = tnode_alloc(sz);
405 tn->parent = T_TNODE;
409 tn->full_children = 0;
410 tn->empty_children = 1<<bits;
413 pr_debug("AT %p s=%u %lu\n", tn, (unsigned int) sizeof(struct tnode),
414 (unsigned long) (sizeof(struct node) << bits));
419 * Check whether a tnode 'n' is "full", i.e. it is an internal node
420 * and no bits are skipped. See discussion in dyntree paper p. 6
423 static inline int tnode_full(const struct tnode *tn, const struct node *n)
425 if (n == NULL || IS_LEAF(n))
428 return ((struct tnode *) n)->pos == tn->pos + tn->bits;
431 static inline void put_child(struct trie *t, struct tnode *tn, int i,
434 tnode_put_child_reorg(tn, i, n, -1);
438 * Add a child at position i overwriting the old value.
439 * Update the value of full_children and empty_children.
442 static void tnode_put_child_reorg(struct tnode *tn, int i, struct node *n,
445 struct node *chi = tn->child[i];
448 BUG_ON(i >= 1<<tn->bits);
450 /* update emptyChildren */
451 if (n == NULL && chi != NULL)
452 tn->empty_children++;
453 else if (n != NULL && chi == NULL)
454 tn->empty_children--;
456 /* update fullChildren */
458 wasfull = tnode_full(tn, chi);
460 isfull = tnode_full(tn, n);
461 if (wasfull && !isfull)
463 else if (!wasfull && isfull)
467 node_set_parent(n, tn);
469 rcu_assign_pointer(tn->child[i], n);
472 static struct node *resize(struct trie *t, struct tnode *tn)
476 struct tnode *old_tn;
477 int inflate_threshold_use;
478 int halve_threshold_use;
484 pr_debug("In tnode_resize %p inflate_threshold=%d threshold=%d\n",
485 tn, inflate_threshold, halve_threshold);
488 if (tn->empty_children == tnode_child_length(tn)) {
493 if (tn->empty_children == tnode_child_length(tn) - 1)
494 for (i = 0; i < tnode_child_length(tn); i++) {
501 /* compress one level */
502 node_set_parent(n, NULL);
507 * Double as long as the resulting node has a number of
508 * nonempty nodes that are above the threshold.
512 * From "Implementing a dynamic compressed trie" by Stefan Nilsson of
513 * the Helsinki University of Technology and Matti Tikkanen of Nokia
514 * Telecommunications, page 6:
515 * "A node is doubled if the ratio of non-empty children to all
516 * children in the *doubled* node is at least 'high'."
518 * 'high' in this instance is the variable 'inflate_threshold'. It
519 * is expressed as a percentage, so we multiply it with
520 * tnode_child_length() and instead of multiplying by 2 (since the
521 * child array will be doubled by inflate()) and multiplying
522 * the left-hand side by 100 (to handle the percentage thing) we
523 * multiply the left-hand side by 50.
525 * The left-hand side may look a bit weird: tnode_child_length(tn)
526 * - tn->empty_children is of course the number of non-null children
527 * in the current node. tn->full_children is the number of "full"
528 * children, that is non-null tnodes with a skip value of 0.
529 * All of those will be doubled in the resulting inflated tnode, so
530 * we just count them one extra time here.
532 * A clearer way to write this would be:
534 * to_be_doubled = tn->full_children;
535 * not_to_be_doubled = tnode_child_length(tn) - tn->empty_children -
538 * new_child_length = tnode_child_length(tn) * 2;
540 * new_fill_factor = 100 * (not_to_be_doubled + 2*to_be_doubled) /
542 * if (new_fill_factor >= inflate_threshold)
544 * ...and so on, tho it would mess up the while () loop.
547 * 100 * (not_to_be_doubled + 2*to_be_doubled) / new_child_length >=
551 * 100 * (not_to_be_doubled + 2*to_be_doubled) >=
552 * inflate_threshold * new_child_length
554 * expand not_to_be_doubled and to_be_doubled, and shorten:
555 * 100 * (tnode_child_length(tn) - tn->empty_children +
556 * tn->full_children) >= inflate_threshold * new_child_length
558 * expand new_child_length:
559 * 100 * (tnode_child_length(tn) - tn->empty_children +
560 * tn->full_children) >=
561 * inflate_threshold * tnode_child_length(tn) * 2
564 * 50 * (tn->full_children + tnode_child_length(tn) -
565 * tn->empty_children) >= inflate_threshold *
566 * tnode_child_length(tn)
572 /* Keep root node larger */
575 inflate_threshold_use = inflate_threshold_root;
577 inflate_threshold_use = inflate_threshold;
581 while ((tn->full_children > 0 && max_resize-- &&
582 50 * (tn->full_children + tnode_child_length(tn)
583 - tn->empty_children)
584 >= inflate_threshold_use * tnode_child_length(tn))) {
591 #ifdef CONFIG_IP_FIB_TRIE_STATS
592 t->stats.resize_node_skipped++;
598 if (max_resize < 0) {
600 pr_warning("Fix inflate_threshold_root."
601 " Now=%d size=%d bits\n",
602 inflate_threshold_root, tn->bits);
604 pr_warning("Fix inflate_threshold."
605 " Now=%d size=%d bits\n",
606 inflate_threshold, tn->bits);
612 * Halve as long as the number of empty children in this
613 * node is above threshold.
617 /* Keep root node larger */
620 halve_threshold_use = halve_threshold_root;
622 halve_threshold_use = halve_threshold;
626 while (tn->bits > 1 && max_resize-- &&
627 100 * (tnode_child_length(tn) - tn->empty_children) <
628 halve_threshold_use * tnode_child_length(tn)) {
634 #ifdef CONFIG_IP_FIB_TRIE_STATS
635 t->stats.resize_node_skipped++;
641 if (max_resize < 0) {
643 pr_warning("Fix halve_threshold_root."
644 " Now=%d size=%d bits\n",
645 halve_threshold_root, tn->bits);
647 pr_warning("Fix halve_threshold."
648 " Now=%d size=%d bits\n",
649 halve_threshold, tn->bits);
652 /* Only one child remains */
653 if (tn->empty_children == tnode_child_length(tn) - 1)
654 for (i = 0; i < tnode_child_length(tn); i++) {
661 /* compress one level */
663 node_set_parent(n, NULL);
668 return (struct node *) tn;
671 static struct tnode *inflate(struct trie *t, struct tnode *tn)
673 struct tnode *oldtnode = tn;
674 int olen = tnode_child_length(tn);
677 pr_debug("In inflate\n");
679 tn = tnode_new(oldtnode->key, oldtnode->pos, oldtnode->bits + 1);
682 return ERR_PTR(-ENOMEM);
685 * Preallocate and store tnodes before the actual work so we
686 * don't get into an inconsistent state if memory allocation
687 * fails. In case of failure we return the oldnode and inflate
688 * of tnode is ignored.
691 for (i = 0; i < olen; i++) {
694 inode = (struct tnode *) tnode_get_child(oldtnode, i);
697 inode->pos == oldtnode->pos + oldtnode->bits &&
699 struct tnode *left, *right;
700 t_key m = ~0U << (KEYLENGTH - 1) >> inode->pos;
702 left = tnode_new(inode->key&(~m), inode->pos + 1,
707 right = tnode_new(inode->key|m, inode->pos + 1,
715 put_child(t, tn, 2*i, (struct node *) left);
716 put_child(t, tn, 2*i+1, (struct node *) right);
720 for (i = 0; i < olen; i++) {
722 struct node *node = tnode_get_child(oldtnode, i);
723 struct tnode *left, *right;
730 /* A leaf or an internal node with skipped bits */
732 if (IS_LEAF(node) || ((struct tnode *) node)->pos >
733 tn->pos + tn->bits - 1) {
734 if (tkey_extract_bits(node->key,
735 oldtnode->pos + oldtnode->bits,
737 put_child(t, tn, 2*i, node);
739 put_child(t, tn, 2*i+1, node);
743 /* An internal node with two children */
744 inode = (struct tnode *) node;
746 if (inode->bits == 1) {
747 put_child(t, tn, 2*i, inode->child[0]);
748 put_child(t, tn, 2*i+1, inode->child[1]);
754 /* An internal node with more than two children */
756 /* We will replace this node 'inode' with two new
757 * ones, 'left' and 'right', each with half of the
758 * original children. The two new nodes will have
759 * a position one bit further down the key and this
760 * means that the "significant" part of their keys
761 * (see the discussion near the top of this file)
762 * will differ by one bit, which will be "0" in
763 * left's key and "1" in right's key. Since we are
764 * moving the key position by one step, the bit that
765 * we are moving away from - the bit at position
766 * (inode->pos) - is the one that will differ between
767 * left and right. So... we synthesize that bit in the
769 * The mask 'm' below will be a single "one" bit at
770 * the position (inode->pos)
773 /* Use the old key, but set the new significant
777 left = (struct tnode *) tnode_get_child(tn, 2*i);
778 put_child(t, tn, 2*i, NULL);
782 right = (struct tnode *) tnode_get_child(tn, 2*i+1);
783 put_child(t, tn, 2*i+1, NULL);
787 size = tnode_child_length(left);
788 for (j = 0; j < size; j++) {
789 put_child(t, left, j, inode->child[j]);
790 put_child(t, right, j, inode->child[j + size]);
792 put_child(t, tn, 2*i, resize(t, left));
793 put_child(t, tn, 2*i+1, resize(t, right));
797 tnode_free(oldtnode);
801 int size = tnode_child_length(tn);
804 for (j = 0; j < size; j++)
806 tnode_free((struct tnode *)tn->child[j]);
810 return ERR_PTR(-ENOMEM);
814 static struct tnode *halve(struct trie *t, struct tnode *tn)
816 struct tnode *oldtnode = tn;
817 struct node *left, *right;
819 int olen = tnode_child_length(tn);
821 pr_debug("In halve\n");
823 tn = tnode_new(oldtnode->key, oldtnode->pos, oldtnode->bits - 1);
826 return ERR_PTR(-ENOMEM);
829 * Preallocate and store tnodes before the actual work so we
830 * don't get into an inconsistent state if memory allocation
831 * fails. In case of failure we return the oldnode and halve
832 * of tnode is ignored.
835 for (i = 0; i < olen; i += 2) {
836 left = tnode_get_child(oldtnode, i);
837 right = tnode_get_child(oldtnode, i+1);
839 /* Two nonempty children */
843 newn = tnode_new(left->key, tn->pos + tn->bits, 1);
848 put_child(t, tn, i/2, (struct node *)newn);
853 for (i = 0; i < olen; i += 2) {
854 struct tnode *newBinNode;
856 left = tnode_get_child(oldtnode, i);
857 right = tnode_get_child(oldtnode, i+1);
859 /* At least one of the children is empty */
861 if (right == NULL) /* Both are empty */
863 put_child(t, tn, i/2, right);
868 put_child(t, tn, i/2, left);
872 /* Two nonempty children */
873 newBinNode = (struct tnode *) tnode_get_child(tn, i/2);
874 put_child(t, tn, i/2, NULL);
875 put_child(t, newBinNode, 0, left);
876 put_child(t, newBinNode, 1, right);
877 put_child(t, tn, i/2, resize(t, newBinNode));
879 tnode_free(oldtnode);
883 int size = tnode_child_length(tn);
886 for (j = 0; j < size; j++)
888 tnode_free((struct tnode *)tn->child[j]);
892 return ERR_PTR(-ENOMEM);
896 /* readside must use rcu_read_lock currently dump routines
897 via get_fa_head and dump */
899 static struct leaf_info *find_leaf_info(struct leaf *l, int plen)
901 struct hlist_head *head = &l->list;
902 struct hlist_node *node;
903 struct leaf_info *li;
905 hlist_for_each_entry_rcu(li, node, head, hlist)
906 if (li->plen == plen)
912 static inline struct list_head *get_fa_head(struct leaf *l, int plen)
914 struct leaf_info *li = find_leaf_info(l, plen);
922 static void insert_leaf_info(struct hlist_head *head, struct leaf_info *new)
924 struct leaf_info *li = NULL, *last = NULL;
925 struct hlist_node *node;
927 if (hlist_empty(head)) {
928 hlist_add_head_rcu(&new->hlist, head);
930 hlist_for_each_entry(li, node, head, hlist) {
931 if (new->plen > li->plen)
937 hlist_add_after_rcu(&last->hlist, &new->hlist);
939 hlist_add_before_rcu(&new->hlist, &li->hlist);
943 /* rcu_read_lock needs to be hold by caller from readside */
946 fib_find_node(struct trie *t, u32 key)
953 n = rcu_dereference(t->trie);
955 while (n != NULL && NODE_TYPE(n) == T_TNODE) {
956 tn = (struct tnode *) n;
960 if (tkey_sub_equals(tn->key, pos, tn->pos-pos, key)) {
961 pos = tn->pos + tn->bits;
962 n = tnode_get_child_rcu(tn,
963 tkey_extract_bits(key,
969 /* Case we have found a leaf. Compare prefixes */
971 if (n != NULL && IS_LEAF(n) && tkey_equals(key, n->key))
972 return (struct leaf *)n;
977 static struct node *trie_rebalance(struct trie *t, struct tnode *tn)
980 t_key cindex, key = tn->key;
983 while (tn != NULL && (tp = node_parent((struct node *)tn)) != NULL) {
984 cindex = tkey_extract_bits(key, tp->pos, tp->bits);
985 wasfull = tnode_full(tp, tnode_get_child(tp, cindex));
986 tn = (struct tnode *) resize(t, (struct tnode *)tn);
988 tnode_put_child_reorg((struct tnode *)tp, cindex,
989 (struct node *)tn, wasfull);
991 tp = node_parent((struct node *) tn);
997 /* Handle last (top) tnode */
999 tn = (struct tnode *)resize(t, (struct tnode *)tn);
1001 return (struct node *)tn;
1004 /* only used from updater-side */
1006 static struct list_head *fib_insert_node(struct trie *t, u32 key, int plen)
1009 struct tnode *tp = NULL, *tn = NULL;
1013 struct list_head *fa_head = NULL;
1014 struct leaf_info *li;
1020 /* If we point to NULL, stop. Either the tree is empty and we should
1021 * just put a new leaf in if, or we have reached an empty child slot,
1022 * and we should just put our new leaf in that.
1023 * If we point to a T_TNODE, check if it matches our key. Note that
1024 * a T_TNODE might be skipping any number of bits - its 'pos' need
1025 * not be the parent's 'pos'+'bits'!
1027 * If it does match the current key, get pos/bits from it, extract
1028 * the index from our key, push the T_TNODE and walk the tree.
1030 * If it doesn't, we have to replace it with a new T_TNODE.
1032 * If we point to a T_LEAF, it might or might not have the same key
1033 * as we do. If it does, just change the value, update the T_LEAF's
1034 * value, and return it.
1035 * If it doesn't, we need to replace it with a T_TNODE.
1038 while (n != NULL && NODE_TYPE(n) == T_TNODE) {
1039 tn = (struct tnode *) n;
1043 if (tkey_sub_equals(tn->key, pos, tn->pos-pos, key)) {
1045 pos = tn->pos + tn->bits;
1046 n = tnode_get_child(tn,
1047 tkey_extract_bits(key,
1051 BUG_ON(n && node_parent(n) != tn);
1057 * n ----> NULL, LEAF or TNODE
1059 * tp is n's (parent) ----> NULL or TNODE
1062 BUG_ON(tp && IS_LEAF(tp));
1064 /* Case 1: n is a leaf. Compare prefixes */
1066 if (n != NULL && IS_LEAF(n) && tkey_equals(key, n->key)) {
1067 l = (struct leaf *) n;
1068 li = leaf_info_new(plen);
1073 fa_head = &li->falh;
1074 insert_leaf_info(&l->list, li);
1083 li = leaf_info_new(plen);
1086 tnode_free((struct tnode *) l);
1090 fa_head = &li->falh;
1091 insert_leaf_info(&l->list, li);
1093 if (t->trie && n == NULL) {
1094 /* Case 2: n is NULL, and will just insert a new leaf */
1096 node_set_parent((struct node *)l, tp);
1098 cindex = tkey_extract_bits(key, tp->pos, tp->bits);
1099 put_child(t, (struct tnode *)tp, cindex, (struct node *)l);
1101 /* Case 3: n is a LEAF or a TNODE and the key doesn't match. */
1103 * Add a new tnode here
1104 * first tnode need some special handling
1108 pos = tp->pos+tp->bits;
1113 newpos = tkey_mismatch(key, pos, n->key);
1114 tn = tnode_new(n->key, newpos, 1);
1117 tn = tnode_new(key, newpos, 1); /* First tnode */
1122 tnode_free((struct tnode *) l);
1126 node_set_parent((struct node *)tn, tp);
1128 missbit = tkey_extract_bits(key, newpos, 1);
1129 put_child(t, tn, missbit, (struct node *)l);
1130 put_child(t, tn, 1-missbit, n);
1133 cindex = tkey_extract_bits(key, tp->pos, tp->bits);
1134 put_child(t, (struct tnode *)tp, cindex,
1137 rcu_assign_pointer(t->trie, (struct node *)tn);
1142 if (tp && tp->pos + tp->bits > 32)
1143 pr_warning("fib_trie"
1144 " tp=%p pos=%d, bits=%d, key=%0x plen=%d\n",
1145 tp, tp->pos, tp->bits, key, plen);
1147 /* Rebalance the trie */
1149 rcu_assign_pointer(t->trie, trie_rebalance(t, tp));
1155 * Caller must hold RTNL.
1157 static int fn_trie_insert(struct fib_table *tb, struct fib_config *cfg)
1159 struct trie *t = (struct trie *) tb->tb_data;
1160 struct fib_alias *fa, *new_fa;
1161 struct list_head *fa_head = NULL;
1162 struct fib_info *fi;
1163 int plen = cfg->fc_dst_len;
1164 u8 tos = cfg->fc_tos;
1172 key = ntohl(cfg->fc_dst);
1174 pr_debug("Insert table=%u %08x/%d\n", tb->tb_id, key, plen);
1176 mask = ntohl(inet_make_mask(plen));
1183 fi = fib_create_info(cfg);
1189 l = fib_find_node(t, key);
1193 fa_head = get_fa_head(l, plen);
1194 fa = fib_find_alias(fa_head, tos, fi->fib_priority);
1197 /* Now fa, if non-NULL, points to the first fib alias
1198 * with the same keys [prefix,tos,priority], if such key already
1199 * exists or to the node before which we will insert new one.
1201 * If fa is NULL, we will need to allocate a new one and
1202 * insert to the head of f.
1204 * If f is NULL, no fib node matched the destination key
1205 * and we need to allocate a new one of those as well.
1208 if (fa && fa->fa_tos == tos &&
1209 fa->fa_info->fib_priority == fi->fib_priority) {
1210 struct fib_alias *fa_first, *fa_match;
1213 if (cfg->fc_nlflags & NLM_F_EXCL)
1217 * 1. Find exact match for type, scope, fib_info to avoid
1219 * 2. Find next 'fa' (or head), NLM_F_APPEND inserts before it
1223 fa = list_entry(fa->fa_list.prev, struct fib_alias, fa_list);
1224 list_for_each_entry_continue(fa, fa_head, fa_list) {
1225 if (fa->fa_tos != tos)
1227 if (fa->fa_info->fib_priority != fi->fib_priority)
1229 if (fa->fa_type == cfg->fc_type &&
1230 fa->fa_scope == cfg->fc_scope &&
1231 fa->fa_info == fi) {
1237 if (cfg->fc_nlflags & NLM_F_REPLACE) {
1238 struct fib_info *fi_drop;
1248 new_fa = kmem_cache_alloc(fn_alias_kmem, GFP_KERNEL);
1252 fi_drop = fa->fa_info;
1253 new_fa->fa_tos = fa->fa_tos;
1254 new_fa->fa_info = fi;
1255 new_fa->fa_type = cfg->fc_type;
1256 new_fa->fa_scope = cfg->fc_scope;
1257 state = fa->fa_state;
1258 new_fa->fa_state = state & ~FA_S_ACCESSED;
1260 list_replace_rcu(&fa->fa_list, &new_fa->fa_list);
1261 alias_free_mem_rcu(fa);
1263 fib_release_info(fi_drop);
1264 if (state & FA_S_ACCESSED)
1266 rtmsg_fib(RTM_NEWROUTE, htonl(key), new_fa, plen,
1267 tb->tb_id, &cfg->fc_nlinfo, NLM_F_REPLACE);
1271 /* Error if we find a perfect match which
1272 * uses the same scope, type, and nexthop
1278 if (!(cfg->fc_nlflags & NLM_F_APPEND))
1282 if (!(cfg->fc_nlflags & NLM_F_CREATE))
1286 new_fa = kmem_cache_alloc(fn_alias_kmem, GFP_KERNEL);
1290 new_fa->fa_info = fi;
1291 new_fa->fa_tos = tos;
1292 new_fa->fa_type = cfg->fc_type;
1293 new_fa->fa_scope = cfg->fc_scope;
1294 new_fa->fa_state = 0;
1296 * Insert new entry to the list.
1300 fa_head = fib_insert_node(t, key, plen);
1301 if (unlikely(!fa_head)) {
1303 goto out_free_new_fa;
1307 list_add_tail_rcu(&new_fa->fa_list,
1308 (fa ? &fa->fa_list : fa_head));
1311 rtmsg_fib(RTM_NEWROUTE, htonl(key), new_fa, plen, tb->tb_id,
1312 &cfg->fc_nlinfo, 0);
1317 kmem_cache_free(fn_alias_kmem, new_fa);
1319 fib_release_info(fi);
1324 /* should be called with rcu_read_lock */
1325 static int check_leaf(struct trie *t, struct leaf *l,
1326 t_key key, const struct flowi *flp,
1327 struct fib_result *res)
1329 struct leaf_info *li;
1330 struct hlist_head *hhead = &l->list;
1331 struct hlist_node *node;
1333 hlist_for_each_entry_rcu(li, node, hhead, hlist) {
1335 int plen = li->plen;
1336 __be32 mask = inet_make_mask(plen);
1338 if (l->key != (key & ntohl(mask)))
1341 err = fib_semantic_match(&li->falh, flp, res,
1342 htonl(l->key), mask, plen);
1344 #ifdef CONFIG_IP_FIB_TRIE_STATS
1346 t->stats.semantic_match_passed++;
1348 t->stats.semantic_match_miss++;
1357 static int fn_trie_lookup(struct fib_table *tb, const struct flowi *flp,
1358 struct fib_result *res)
1360 struct trie *t = (struct trie *) tb->tb_data;
1365 t_key key = ntohl(flp->fl4_dst);
1368 int current_prefix_length = KEYLENGTH;
1370 t_key node_prefix, key_prefix, pref_mismatch;
1375 n = rcu_dereference(t->trie);
1379 #ifdef CONFIG_IP_FIB_TRIE_STATS
1385 plen = check_leaf(t, (struct leaf *)n, key, flp, res);
1392 pn = (struct tnode *) n;
1400 cindex = tkey_extract_bits(mask_pfx(key, current_prefix_length),
1403 n = tnode_get_child(pn, cindex);
1406 #ifdef CONFIG_IP_FIB_TRIE_STATS
1407 t->stats.null_node_hit++;
1413 plen = check_leaf(t, (struct leaf *)n, key, flp, res);
1421 cn = (struct tnode *)n;
1424 * It's a tnode, and we can do some extra checks here if we
1425 * like, to avoid descending into a dead-end branch.
1426 * This tnode is in the parent's child array at index
1427 * key[p_pos..p_pos+p_bits] but potentially with some bits
1428 * chopped off, so in reality the index may be just a
1429 * subprefix, padded with zero at the end.
1430 * We can also take a look at any skipped bits in this
1431 * tnode - everything up to p_pos is supposed to be ok,
1432 * and the non-chopped bits of the index (se previous
1433 * paragraph) are also guaranteed ok, but the rest is
1434 * considered unknown.
1436 * The skipped bits are key[pos+bits..cn->pos].
1439 /* If current_prefix_length < pos+bits, we are already doing
1440 * actual prefix matching, which means everything from
1441 * pos+(bits-chopped_off) onward must be zero along some
1442 * branch of this subtree - otherwise there is *no* valid
1443 * prefix present. Here we can only check the skipped
1444 * bits. Remember, since we have already indexed into the
1445 * parent's child array, we know that the bits we chopped of
1449 /* NOTA BENE: Checking only skipped bits
1450 for the new node here */
1452 if (current_prefix_length < pos+bits) {
1453 if (tkey_extract_bits(cn->key, current_prefix_length,
1454 cn->pos - current_prefix_length)
1460 * If chopped_off=0, the index is fully validated and we
1461 * only need to look at the skipped bits for this, the new,
1462 * tnode. What we actually want to do is to find out if
1463 * these skipped bits match our key perfectly, or if we will
1464 * have to count on finding a matching prefix further down,
1465 * because if we do, we would like to have some way of
1466 * verifying the existence of such a prefix at this point.
1469 /* The only thing we can do at this point is to verify that
1470 * any such matching prefix can indeed be a prefix to our
1471 * key, and if the bits in the node we are inspecting that
1472 * do not match our key are not ZERO, this cannot be true.
1473 * Thus, find out where there is a mismatch (before cn->pos)
1474 * and verify that all the mismatching bits are zero in the
1479 * Note: We aren't very concerned about the piece of
1480 * the key that precede pn->pos+pn->bits, since these
1481 * have already been checked. The bits after cn->pos
1482 * aren't checked since these are by definition
1483 * "unknown" at this point. Thus, what we want to see
1484 * is if we are about to enter the "prefix matching"
1485 * state, and in that case verify that the skipped
1486 * bits that will prevail throughout this subtree are
1487 * zero, as they have to be if we are to find a
1491 node_prefix = mask_pfx(cn->key, cn->pos);
1492 key_prefix = mask_pfx(key, cn->pos);
1493 pref_mismatch = key_prefix^node_prefix;
1497 * In short: If skipped bits in this node do not match
1498 * the search key, enter the "prefix matching"
1501 if (pref_mismatch) {
1502 while (!(pref_mismatch & (1<<(KEYLENGTH-1)))) {
1504 pref_mismatch = pref_mismatch << 1;
1506 key_prefix = tkey_extract_bits(cn->key, mp, cn->pos-mp);
1508 if (key_prefix != 0)
1511 if (current_prefix_length >= cn->pos)
1512 current_prefix_length = mp;
1515 pn = (struct tnode *)n; /* Descend */
1522 /* As zero don't change the child key (cindex) */
1523 while ((chopped_off <= pn->bits)
1524 && !(cindex & (1<<(chopped_off-1))))
1527 /* Decrease current_... with bits chopped off */
1528 if (current_prefix_length > pn->pos + pn->bits - chopped_off)
1529 current_prefix_length = pn->pos + pn->bits
1533 * Either we do the actual chop off according or if we have
1534 * chopped off all bits in this tnode walk up to our parent.
1537 if (chopped_off <= pn->bits) {
1538 cindex &= ~(1 << (chopped_off-1));
1540 struct tnode *parent = node_parent((struct node *) pn);
1544 /* Get Child's index */
1545 cindex = tkey_extract_bits(pn->key, parent->pos, parent->bits);
1549 #ifdef CONFIG_IP_FIB_TRIE_STATS
1550 t->stats.backtrack++;
1563 * Remove the leaf and return parent.
1565 static void trie_leaf_remove(struct trie *t, struct leaf *l)
1567 struct tnode *tp = node_parent((struct node *) l);
1569 pr_debug("entering trie_leaf_remove(%p)\n", l);
1572 t_key cindex = tkey_extract_bits(l->key, tp->pos, tp->bits);
1573 put_child(t, (struct tnode *)tp, cindex, NULL);
1574 rcu_assign_pointer(t->trie, trie_rebalance(t, tp));
1576 rcu_assign_pointer(t->trie, NULL);
1578 tnode_free((struct tnode *) l);
1582 * Caller must hold RTNL.
1584 static int fn_trie_delete(struct fib_table *tb, struct fib_config *cfg)
1586 struct trie *t = (struct trie *) tb->tb_data;
1588 int plen = cfg->fc_dst_len;
1589 u8 tos = cfg->fc_tos;
1590 struct fib_alias *fa, *fa_to_delete;
1591 struct list_head *fa_head;
1593 struct leaf_info *li;
1598 key = ntohl(cfg->fc_dst);
1599 mask = ntohl(inet_make_mask(plen));
1605 l = fib_find_node(t, key);
1610 fa_head = get_fa_head(l, plen);
1611 fa = fib_find_alias(fa_head, tos, 0);
1616 pr_debug("Deleting %08x/%d tos=%d t=%p\n", key, plen, tos, t);
1618 fa_to_delete = NULL;
1619 fa = list_entry(fa->fa_list.prev, struct fib_alias, fa_list);
1620 list_for_each_entry_continue(fa, fa_head, fa_list) {
1621 struct fib_info *fi = fa->fa_info;
1623 if (fa->fa_tos != tos)
1626 if ((!cfg->fc_type || fa->fa_type == cfg->fc_type) &&
1627 (cfg->fc_scope == RT_SCOPE_NOWHERE ||
1628 fa->fa_scope == cfg->fc_scope) &&
1629 (!cfg->fc_protocol ||
1630 fi->fib_protocol == cfg->fc_protocol) &&
1631 fib_nh_match(cfg, fi) == 0) {
1641 rtmsg_fib(RTM_DELROUTE, htonl(key), fa, plen, tb->tb_id,
1642 &cfg->fc_nlinfo, 0);
1644 l = fib_find_node(t, key);
1645 li = find_leaf_info(l, plen);
1647 list_del_rcu(&fa->fa_list);
1649 if (list_empty(fa_head)) {
1650 hlist_del_rcu(&li->hlist);
1654 if (hlist_empty(&l->list))
1655 trie_leaf_remove(t, l);
1657 if (fa->fa_state & FA_S_ACCESSED)
1660 fib_release_info(fa->fa_info);
1661 alias_free_mem_rcu(fa);
1665 static int trie_flush_list(struct trie *t, struct list_head *head)
1667 struct fib_alias *fa, *fa_node;
1670 list_for_each_entry_safe(fa, fa_node, head, fa_list) {
1671 struct fib_info *fi = fa->fa_info;
1673 if (fi && (fi->fib_flags & RTNH_F_DEAD)) {
1674 list_del_rcu(&fa->fa_list);
1675 fib_release_info(fa->fa_info);
1676 alias_free_mem_rcu(fa);
1683 static int trie_flush_leaf(struct trie *t, struct leaf *l)
1686 struct hlist_head *lih = &l->list;
1687 struct hlist_node *node, *tmp;
1688 struct leaf_info *li = NULL;
1690 hlist_for_each_entry_safe(li, node, tmp, lih, hlist) {
1691 found += trie_flush_list(t, &li->falh);
1693 if (list_empty(&li->falh)) {
1694 hlist_del_rcu(&li->hlist);
1702 * Scan for the next right leaf starting at node p->child[idx]
1703 * Since we have back pointer, no recursion necessary.
1705 static struct leaf *leaf_walk_rcu(struct tnode *p, struct node *c)
1711 idx = tkey_extract_bits(c->key, p->pos, p->bits) + 1;
1715 while (idx < 1u << p->bits) {
1716 c = tnode_get_child_rcu(p, idx++);
1721 prefetch(p->child[idx]);
1722 return (struct leaf *) c;
1725 /* Rescan start scanning in new node */
1726 p = (struct tnode *) c;
1730 /* Node empty, walk back up to parent */
1731 c = (struct node *) p;
1732 } while ( (p = node_parent_rcu(c)) != NULL);
1734 return NULL; /* Root of trie */
1737 static struct leaf *trie_firstleaf(struct trie *t)
1739 struct tnode *n = (struct tnode *) rcu_dereference(t->trie);
1744 if (IS_LEAF(n)) /* trie is just a leaf */
1745 return (struct leaf *) n;
1747 return leaf_walk_rcu(n, NULL);
1750 static struct leaf *trie_nextleaf(struct leaf *l)
1752 struct node *c = (struct node *) l;
1753 struct tnode *p = node_parent(c);
1756 return NULL; /* trie with just one leaf */
1758 return leaf_walk_rcu(p, c);
1761 static struct leaf *trie_leafindex(struct trie *t, int index)
1763 struct leaf *l = trie_firstleaf(t);
1765 while (l && index-- > 0)
1766 l = trie_nextleaf(l);
1773 * Caller must hold RTNL.
1775 static int fn_trie_flush(struct fib_table *tb)
1777 struct trie *t = (struct trie *) tb->tb_data;
1778 struct leaf *l, *ll = NULL;
1781 for (l = trie_firstleaf(t); l; l = trie_nextleaf(l)) {
1782 found += trie_flush_leaf(t, l);
1784 if (ll && hlist_empty(&ll->list))
1785 trie_leaf_remove(t, ll);
1789 if (ll && hlist_empty(&ll->list))
1790 trie_leaf_remove(t, ll);
1792 pr_debug("trie_flush found=%d\n", found);
1796 static void fn_trie_select_default(struct fib_table *tb,
1797 const struct flowi *flp,
1798 struct fib_result *res)
1800 struct trie *t = (struct trie *) tb->tb_data;
1801 int order, last_idx;
1802 struct fib_info *fi = NULL;
1803 struct fib_info *last_resort;
1804 struct fib_alias *fa = NULL;
1805 struct list_head *fa_head;
1814 l = fib_find_node(t, 0);
1818 fa_head = get_fa_head(l, 0);
1822 if (list_empty(fa_head))
1825 list_for_each_entry_rcu(fa, fa_head, fa_list) {
1826 struct fib_info *next_fi = fa->fa_info;
1828 if (fa->fa_scope != res->scope ||
1829 fa->fa_type != RTN_UNICAST)
1832 if (next_fi->fib_priority > res->fi->fib_priority)
1834 if (!next_fi->fib_nh[0].nh_gw ||
1835 next_fi->fib_nh[0].nh_scope != RT_SCOPE_LINK)
1837 fa->fa_state |= FA_S_ACCESSED;
1840 if (next_fi != res->fi)
1842 } else if (!fib_detect_death(fi, order, &last_resort,
1843 &last_idx, tb->tb_default)) {
1844 fib_result_assign(res, fi);
1845 tb->tb_default = order;
1851 if (order <= 0 || fi == NULL) {
1852 tb->tb_default = -1;
1856 if (!fib_detect_death(fi, order, &last_resort, &last_idx,
1858 fib_result_assign(res, fi);
1859 tb->tb_default = order;
1863 fib_result_assign(res, last_resort);
1864 tb->tb_default = last_idx;
1869 static int fn_trie_dump_fa(t_key key, int plen, struct list_head *fah,
1870 struct fib_table *tb,
1871 struct sk_buff *skb, struct netlink_callback *cb)
1874 struct fib_alias *fa;
1875 __be32 xkey = htonl(key);
1880 /* rcu_read_lock is hold by caller */
1882 list_for_each_entry_rcu(fa, fah, fa_list) {
1888 if (fib_dump_info(skb, NETLINK_CB(cb->skb).pid,
1897 fa->fa_info, NLM_F_MULTI) < 0) {
1907 static int fn_trie_dump_leaf(struct leaf *l, struct fib_table *tb,
1908 struct sk_buff *skb, struct netlink_callback *cb)
1910 struct leaf_info *li;
1911 struct hlist_node *node;
1917 /* rcu_read_lock is hold by caller */
1918 hlist_for_each_entry_rcu(li, node, &l->list, hlist) {
1927 if (list_empty(&li->falh))
1930 if (fn_trie_dump_fa(l->key, li->plen, &li->falh, tb, skb, cb) < 0) {
1941 static int fn_trie_dump(struct fib_table *tb, struct sk_buff *skb,
1942 struct netlink_callback *cb)
1945 struct trie *t = (struct trie *) tb->tb_data;
1946 t_key key = cb->args[2];
1947 int count = cb->args[3];
1950 /* Dump starting at last key.
1951 * Note: 0.0.0.0/0 (ie default) is first key.
1954 l = trie_firstleaf(t);
1956 /* Normally, continue from last key, but if that is missing
1957 * fallback to using slow rescan
1959 l = fib_find_node(t, key);
1961 l = trie_leafindex(t, count);
1965 cb->args[2] = l->key;
1966 if (fn_trie_dump_leaf(l, tb, skb, cb) < 0) {
1967 cb->args[3] = count;
1973 l = trie_nextleaf(l);
1974 memset(&cb->args[4], 0,
1975 sizeof(cb->args) - 4*sizeof(cb->args[0]));
1977 cb->args[3] = count;
1983 void __init fib_hash_init(void)
1985 fn_alias_kmem = kmem_cache_create("ip_fib_alias",
1986 sizeof(struct fib_alias),
1987 0, SLAB_PANIC, NULL);
1989 trie_leaf_kmem = kmem_cache_create("ip_fib_trie",
1990 max(sizeof(struct leaf),
1991 sizeof(struct leaf_info)),
1992 0, SLAB_PANIC, NULL);
1996 /* Fix more generic FIB names for init later */
1997 struct fib_table *fib_hash_table(u32 id)
1999 struct fib_table *tb;
2002 tb = kmalloc(sizeof(struct fib_table) + sizeof(struct trie),
2008 tb->tb_default = -1;
2009 tb->tb_lookup = fn_trie_lookup;
2010 tb->tb_insert = fn_trie_insert;
2011 tb->tb_delete = fn_trie_delete;
2012 tb->tb_flush = fn_trie_flush;
2013 tb->tb_select_default = fn_trie_select_default;
2014 tb->tb_dump = fn_trie_dump;
2016 t = (struct trie *) tb->tb_data;
2017 memset(t, 0, sizeof(*t));
2019 if (id == RT_TABLE_LOCAL)
2020 pr_info("IPv4 FIB: Using LC-trie version %s\n", VERSION);
2025 #ifdef CONFIG_PROC_FS
2026 /* Depth first Trie walk iterator */
2027 struct fib_trie_iter {
2028 struct seq_net_private p;
2029 struct fib_table *tb;
2030 struct tnode *tnode;
2035 static struct node *fib_trie_get_next(struct fib_trie_iter *iter)
2037 struct tnode *tn = iter->tnode;
2038 unsigned cindex = iter->index;
2041 /* A single entry routing table */
2045 pr_debug("get_next iter={node=%p index=%d depth=%d}\n",
2046 iter->tnode, iter->index, iter->depth);
2048 while (cindex < (1<<tn->bits)) {
2049 struct node *n = tnode_get_child_rcu(tn, cindex);
2054 iter->index = cindex + 1;
2056 /* push down one level */
2057 iter->tnode = (struct tnode *) n;
2067 /* Current node exhausted, pop back up */
2068 p = node_parent_rcu((struct node *)tn);
2070 cindex = tkey_extract_bits(tn->key, p->pos, p->bits)+1;
2080 static struct node *fib_trie_get_first(struct fib_trie_iter *iter,
2088 n = rcu_dereference(t->trie);
2093 iter->tnode = (struct tnode *) n;
2105 static void trie_collect_stats(struct trie *t, struct trie_stat *s)
2108 struct fib_trie_iter iter;
2110 memset(s, 0, sizeof(*s));
2113 for (n = fib_trie_get_first(&iter, t); n; n = fib_trie_get_next(&iter)) {
2115 struct leaf *l = (struct leaf *)n;
2116 struct leaf_info *li;
2117 struct hlist_node *tmp;
2120 s->totdepth += iter.depth;
2121 if (iter.depth > s->maxdepth)
2122 s->maxdepth = iter.depth;
2124 hlist_for_each_entry_rcu(li, tmp, &l->list, hlist)
2127 const struct tnode *tn = (const struct tnode *) n;
2131 if (tn->bits < MAX_STAT_DEPTH)
2132 s->nodesizes[tn->bits]++;
2134 for (i = 0; i < (1<<tn->bits); i++)
2143 * This outputs /proc/net/fib_triestats
2145 static void trie_show_stats(struct seq_file *seq, struct trie_stat *stat)
2147 unsigned i, max, pointers, bytes, avdepth;
2150 avdepth = stat->totdepth*100 / stat->leaves;
2154 seq_printf(seq, "\tAver depth: %u.%02d\n",
2155 avdepth / 100, avdepth % 100);
2156 seq_printf(seq, "\tMax depth: %u\n", stat->maxdepth);
2158 seq_printf(seq, "\tLeaves: %u\n", stat->leaves);
2159 bytes = sizeof(struct leaf) * stat->leaves;
2161 seq_printf(seq, "\tPrefixes: %u\n", stat->prefixes);
2162 bytes += sizeof(struct leaf_info) * stat->prefixes;
2164 seq_printf(seq, "\tInternal nodes: %u\n\t", stat->tnodes);
2165 bytes += sizeof(struct tnode) * stat->tnodes;
2167 max = MAX_STAT_DEPTH;
2168 while (max > 0 && stat->nodesizes[max-1] == 0)
2172 for (i = 1; i <= max; i++)
2173 if (stat->nodesizes[i] != 0) {
2174 seq_printf(seq, " %u: %u", i, stat->nodesizes[i]);
2175 pointers += (1<<i) * stat->nodesizes[i];
2177 seq_putc(seq, '\n');
2178 seq_printf(seq, "\tPointers: %u\n", pointers);
2180 bytes += sizeof(struct node *) * pointers;
2181 seq_printf(seq, "Null ptrs: %u\n", stat->nullpointers);
2182 seq_printf(seq, "Total size: %u kB\n", (bytes + 1023) / 1024);
2185 #ifdef CONFIG_IP_FIB_TRIE_STATS
2186 static void trie_show_usage(struct seq_file *seq,
2187 const struct trie_use_stats *stats)
2189 seq_printf(seq, "\nCounters:\n---------\n");
2190 seq_printf(seq, "gets = %u\n", stats->gets);
2191 seq_printf(seq, "backtracks = %u\n", stats->backtrack);
2192 seq_printf(seq, "semantic match passed = %u\n",
2193 stats->semantic_match_passed);
2194 seq_printf(seq, "semantic match miss = %u\n",
2195 stats->semantic_match_miss);
2196 seq_printf(seq, "null node hit= %u\n", stats->null_node_hit);
2197 seq_printf(seq, "skipped node resize = %u\n\n",
2198 stats->resize_node_skipped);
2200 #endif /* CONFIG_IP_FIB_TRIE_STATS */
2202 static void fib_table_print(struct seq_file *seq, struct fib_table *tb)
2204 if (tb->tb_id == RT_TABLE_LOCAL)
2205 seq_puts(seq, "Local:\n");
2206 else if (tb->tb_id == RT_TABLE_MAIN)
2207 seq_puts(seq, "Main:\n");
2209 seq_printf(seq, "Id %d:\n", tb->tb_id);
2213 static int fib_triestat_seq_show(struct seq_file *seq, void *v)
2215 struct net *net = (struct net *)seq->private;
2219 "Basic info: size of leaf:"
2220 " %Zd bytes, size of tnode: %Zd bytes.\n",
2221 sizeof(struct leaf), sizeof(struct tnode));
2223 for (h = 0; h < FIB_TABLE_HASHSZ; h++) {
2224 struct hlist_head *head = &net->ipv4.fib_table_hash[h];
2225 struct hlist_node *node;
2226 struct fib_table *tb;
2228 hlist_for_each_entry_rcu(tb, node, head, tb_hlist) {
2229 struct trie *t = (struct trie *) tb->tb_data;
2230 struct trie_stat stat;
2235 fib_table_print(seq, tb);
2237 trie_collect_stats(t, &stat);
2238 trie_show_stats(seq, &stat);
2239 #ifdef CONFIG_IP_FIB_TRIE_STATS
2240 trie_show_usage(seq, &t->stats);
2248 static int fib_triestat_seq_open(struct inode *inode, struct file *file)
2253 net = get_proc_net(inode);
2256 err = single_open(file, fib_triestat_seq_show, net);
2264 static int fib_triestat_seq_release(struct inode *ino, struct file *f)
2266 struct seq_file *seq = f->private_data;
2267 put_net(seq->private);
2268 return single_release(ino, f);
2271 static const struct file_operations fib_triestat_fops = {
2272 .owner = THIS_MODULE,
2273 .open = fib_triestat_seq_open,
2275 .llseek = seq_lseek,
2276 .release = fib_triestat_seq_release,
2279 static struct node *fib_trie_get_idx(struct fib_trie_iter *iter, loff_t pos)
2281 struct net *net = iter->p.net;
2285 for (h = 0; h < FIB_TABLE_HASHSZ; h++) {
2286 struct hlist_head *head = &net->ipv4.fib_table_hash[h];
2287 struct hlist_node *node;
2288 struct fib_table *tb;
2290 hlist_for_each_entry_rcu(tb, node, head, tb_hlist) {
2293 for (n = fib_trie_get_first(iter,
2294 (struct trie *) tb->tb_data);
2295 n; n = fib_trie_get_next(iter))
2306 static void *fib_trie_seq_start(struct seq_file *seq, loff_t *pos)
2309 struct fib_trie_iter *iter = seq->private;
2312 return fib_trie_get_idx(iter, *pos);
2315 static void *fib_trie_seq_next(struct seq_file *seq, void *v, loff_t *pos)
2317 struct fib_trie_iter *iter = seq->private;
2318 struct net *net = iter->p.net;
2319 struct fib_table *tb = iter->tb;
2320 struct hlist_node *tb_node;
2325 /* next node in same table */
2326 n = fib_trie_get_next(iter);
2330 /* walk rest of this hash chain */
2331 h = tb->tb_id & (FIB_TABLE_HASHSZ - 1);
2332 while ( (tb_node = rcu_dereference(tb->tb_hlist.next)) ) {
2333 tb = hlist_entry(tb_node, struct fib_table, tb_hlist);
2334 n = fib_trie_get_first(iter, (struct trie *) tb->tb_data);
2339 /* new hash chain */
2340 while (++h < FIB_TABLE_HASHSZ) {
2341 struct hlist_head *head = &net->ipv4.fib_table_hash[h];
2342 hlist_for_each_entry_rcu(tb, tb_node, head, tb_hlist) {
2343 n = fib_trie_get_first(iter, (struct trie *) tb->tb_data);
2355 static void fib_trie_seq_stop(struct seq_file *seq, void *v)
2361 static void seq_indent(struct seq_file *seq, int n)
2363 while (n-- > 0) seq_puts(seq, " ");
2366 static inline const char *rtn_scope(char *buf, size_t len, enum rt_scope_t s)
2369 case RT_SCOPE_UNIVERSE: return "universe";
2370 case RT_SCOPE_SITE: return "site";
2371 case RT_SCOPE_LINK: return "link";
2372 case RT_SCOPE_HOST: return "host";
2373 case RT_SCOPE_NOWHERE: return "nowhere";
2375 snprintf(buf, len, "scope=%d", s);
2380 static const char *rtn_type_names[__RTN_MAX] = {
2381 [RTN_UNSPEC] = "UNSPEC",
2382 [RTN_UNICAST] = "UNICAST",
2383 [RTN_LOCAL] = "LOCAL",
2384 [RTN_BROADCAST] = "BROADCAST",
2385 [RTN_ANYCAST] = "ANYCAST",
2386 [RTN_MULTICAST] = "MULTICAST",
2387 [RTN_BLACKHOLE] = "BLACKHOLE",
2388 [RTN_UNREACHABLE] = "UNREACHABLE",
2389 [RTN_PROHIBIT] = "PROHIBIT",
2390 [RTN_THROW] = "THROW",
2392 [RTN_XRESOLVE] = "XRESOLVE",
2395 static inline const char *rtn_type(char *buf, size_t len, unsigned t)
2397 if (t < __RTN_MAX && rtn_type_names[t])
2398 return rtn_type_names[t];
2399 snprintf(buf, len, "type %u", t);
2403 /* Pretty print the trie */
2404 static int fib_trie_seq_show(struct seq_file *seq, void *v)
2406 const struct fib_trie_iter *iter = seq->private;
2409 if (!node_parent_rcu(n))
2410 fib_table_print(seq, iter->tb);
2413 struct tnode *tn = (struct tnode *) n;
2414 __be32 prf = htonl(mask_pfx(tn->key, tn->pos));
2416 seq_indent(seq, iter->depth-1);
2417 seq_printf(seq, " +-- %d.%d.%d.%d/%d %d %d %d\n",
2418 NIPQUAD(prf), tn->pos, tn->bits, tn->full_children,
2419 tn->empty_children);
2422 struct leaf *l = (struct leaf *) n;
2423 struct leaf_info *li;
2424 struct hlist_node *node;
2425 __be32 val = htonl(l->key);
2427 seq_indent(seq, iter->depth);
2428 seq_printf(seq, " |-- %d.%d.%d.%d\n", NIPQUAD(val));
2430 hlist_for_each_entry_rcu(li, node, &l->list, hlist) {
2431 struct fib_alias *fa;
2433 list_for_each_entry_rcu(fa, &li->falh, fa_list) {
2434 char buf1[32], buf2[32];
2436 seq_indent(seq, iter->depth+1);
2437 seq_printf(seq, " /%d %s %s", li->plen,
2438 rtn_scope(buf1, sizeof(buf1),
2440 rtn_type(buf2, sizeof(buf2),
2443 seq_printf(seq, " tos=%d", fa->fa_tos);
2444 seq_putc(seq, '\n');
2452 static const struct seq_operations fib_trie_seq_ops = {
2453 .start = fib_trie_seq_start,
2454 .next = fib_trie_seq_next,
2455 .stop = fib_trie_seq_stop,
2456 .show = fib_trie_seq_show,
2459 static int fib_trie_seq_open(struct inode *inode, struct file *file)
2461 return seq_open_net(inode, file, &fib_trie_seq_ops,
2462 sizeof(struct fib_trie_iter));
2465 static const struct file_operations fib_trie_fops = {
2466 .owner = THIS_MODULE,
2467 .open = fib_trie_seq_open,
2469 .llseek = seq_lseek,
2470 .release = seq_release_net,
2473 struct fib_route_iter {
2474 struct seq_net_private p;
2475 struct trie *main_trie;
2480 static struct leaf *fib_route_get_idx(struct fib_route_iter *iter, loff_t pos)
2482 struct leaf *l = NULL;
2483 struct trie *t = iter->main_trie;
2485 /* use cache location of last found key */
2486 if (iter->pos > 0 && pos >= iter->pos && (l = fib_find_node(t, iter->key)))
2490 l = trie_firstleaf(t);
2493 while (l && pos-- > 0) {
2495 l = trie_nextleaf(l);
2499 iter->key = pos; /* remember it */
2501 iter->pos = 0; /* forget it */
2506 static void *fib_route_seq_start(struct seq_file *seq, loff_t *pos)
2509 struct fib_route_iter *iter = seq->private;
2510 struct fib_table *tb;
2513 tb = fib_get_table(iter->p.net, RT_TABLE_MAIN);
2517 iter->main_trie = (struct trie *) tb->tb_data;
2519 return SEQ_START_TOKEN;
2521 return fib_route_get_idx(iter, *pos - 1);
2524 static void *fib_route_seq_next(struct seq_file *seq, void *v, loff_t *pos)
2526 struct fib_route_iter *iter = seq->private;
2530 if (v == SEQ_START_TOKEN) {
2532 l = trie_firstleaf(iter->main_trie);
2535 l = trie_nextleaf(l);
2545 static void fib_route_seq_stop(struct seq_file *seq, void *v)
2551 static unsigned fib_flag_trans(int type, __be32 mask, const struct fib_info *fi)
2553 static unsigned type2flags[RTN_MAX + 1] = {
2554 [7] = RTF_REJECT, [8] = RTF_REJECT,
2556 unsigned flags = type2flags[type];
2558 if (fi && fi->fib_nh->nh_gw)
2559 flags |= RTF_GATEWAY;
2560 if (mask == htonl(0xFFFFFFFF))
2567 * This outputs /proc/net/route.
2568 * The format of the file is not supposed to be changed
2569 * and needs to be same as fib_hash output to avoid breaking
2572 static int fib_route_seq_show(struct seq_file *seq, void *v)
2575 struct leaf_info *li;
2576 struct hlist_node *node;
2578 if (v == SEQ_START_TOKEN) {
2579 seq_printf(seq, "%-127s\n", "Iface\tDestination\tGateway "
2580 "\tFlags\tRefCnt\tUse\tMetric\tMask\t\tMTU"
2585 hlist_for_each_entry_rcu(li, node, &l->list, hlist) {
2586 struct fib_alias *fa;
2587 __be32 mask, prefix;
2589 mask = inet_make_mask(li->plen);
2590 prefix = htonl(l->key);
2592 list_for_each_entry_rcu(fa, &li->falh, fa_list) {
2593 const struct fib_info *fi = fa->fa_info;
2594 unsigned flags = fib_flag_trans(fa->fa_type, mask, fi);
2597 if (fa->fa_type == RTN_BROADCAST
2598 || fa->fa_type == RTN_MULTICAST)
2602 snprintf(bf, sizeof(bf),
2603 "%s\t%08X\t%08X\t%04X\t%d\t%u\t%d\t%08X\t%d\t%u\t%u",
2604 fi->fib_dev ? fi->fib_dev->name : "*",
2606 fi->fib_nh->nh_gw, flags, 0, 0,
2610 fi->fib_advmss + 40 : 0),
2614 snprintf(bf, sizeof(bf),
2615 "*\t%08X\t%08X\t%04X\t%d\t%u\t%d\t%08X\t%d\t%u\t%u",
2616 prefix, 0, flags, 0, 0, 0,
2619 seq_printf(seq, "%-127s\n", bf);
2626 static const struct seq_operations fib_route_seq_ops = {
2627 .start = fib_route_seq_start,
2628 .next = fib_route_seq_next,
2629 .stop = fib_route_seq_stop,
2630 .show = fib_route_seq_show,
2633 static int fib_route_seq_open(struct inode *inode, struct file *file)
2635 return seq_open_net(inode, file, &fib_route_seq_ops,
2636 sizeof(struct fib_route_iter));
2639 static const struct file_operations fib_route_fops = {
2640 .owner = THIS_MODULE,
2641 .open = fib_route_seq_open,
2643 .llseek = seq_lseek,
2644 .release = seq_release_net,
2647 int __net_init fib_proc_init(struct net *net)
2649 if (!proc_net_fops_create(net, "fib_trie", S_IRUGO, &fib_trie_fops))
2652 if (!proc_net_fops_create(net, "fib_triestat", S_IRUGO,
2653 &fib_triestat_fops))
2656 if (!proc_net_fops_create(net, "route", S_IRUGO, &fib_route_fops))
2662 proc_net_remove(net, "fib_triestat");
2664 proc_net_remove(net, "fib_trie");
2669 void __net_exit fib_proc_exit(struct net *net)
2671 proc_net_remove(net, "fib_trie");
2672 proc_net_remove(net, "fib_triestat");
2673 proc_net_remove(net, "route");
2676 #endif /* CONFIG_PROC_FS */