2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 * ip/ip4_fib.h: ip4 mtrie fib
18 * Copyright (c) 2012 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
40 #ifndef included_ip_ip4_fib_h
41 #define included_ip_ip4_fib_h
43 #include <vppinfra/cache.h>
44 #include <vppinfra/vector.h>
45 #include <vnet/ip/lookup.h>
46 #include <vnet/ip/ip4_packet.h> /* for ip4_address_t */
48 /* ip4 fib leafs: 4 ply 8-8-8-8 mtrie.
49 1 + 2*adj_index for terminal leaves.
50 0 + 2*next_ply_index for non-terminals.
51 1 => empty (adjacency index of zero is special miss adjacency). */
52 typedef u32 ip4_fib_mtrie_leaf_t;
54 #define IP4_FIB_MTRIE_LEAF_EMPTY (1 + 2*IP_LOOKUP_MISS_ADJ_INDEX)
55 #define IP4_FIB_MTRIE_LEAF_ROOT (0 + 2*0)
57 always_inline u32 ip4_fib_mtrie_leaf_is_empty (ip4_fib_mtrie_leaf_t n)
58 { return n == IP4_FIB_MTRIE_LEAF_EMPTY; }
60 always_inline u32 ip4_fib_mtrie_leaf_is_non_empty (ip4_fib_mtrie_leaf_t n)
61 { return n != IP4_FIB_MTRIE_LEAF_EMPTY; }
63 always_inline u32 ip4_fib_mtrie_leaf_is_terminal (ip4_fib_mtrie_leaf_t n)
66 always_inline u32 ip4_fib_mtrie_leaf_get_adj_index (ip4_fib_mtrie_leaf_t n)
68 ASSERT (ip4_fib_mtrie_leaf_is_terminal (n));
72 always_inline ip4_fib_mtrie_leaf_t ip4_fib_mtrie_leaf_set_adj_index (u32 adj_index)
74 ip4_fib_mtrie_leaf_t l;
76 ASSERT (ip4_fib_mtrie_leaf_get_adj_index (l) == adj_index);
80 always_inline u32 ip4_fib_mtrie_leaf_is_next_ply (ip4_fib_mtrie_leaf_t n)
81 { return (n & 1) == 0; }
83 always_inline u32 ip4_fib_mtrie_leaf_get_next_ply_index (ip4_fib_mtrie_leaf_t n)
85 ASSERT (ip4_fib_mtrie_leaf_is_next_ply (n));
89 always_inline ip4_fib_mtrie_leaf_t ip4_fib_mtrie_leaf_set_next_ply_index (u32 i)
91 ip4_fib_mtrie_leaf_t l;
93 ASSERT (ip4_fib_mtrie_leaf_get_next_ply_index (l) == i);
97 /* One ply of the 4 ply mtrie fib. */
100 ip4_fib_mtrie_leaf_t leaves[256];
102 #ifdef CLIB_HAVE_VEC128
103 u32x4 leaves_as_u32x4[256 / 4];
107 /* Prefix length for terminal leaves. */
108 u8 dst_address_bits_of_leaves[256];
110 /* Number of non-empty leafs (whether terminal or not). */
111 i32 n_non_empty_leafs;
113 /* Pad to cache line boundary. */
114 u8 pad[CLIB_CACHE_LINE_BYTES
116 } ip4_fib_mtrie_ply_t;
119 /* Pool of plies. Index zero is root ply. */
120 ip4_fib_mtrie_ply_t * ply_pool;
122 /* Special case leaf for default route 0.0.0.0/0. */
123 ip4_fib_mtrie_leaf_t default_leaf;
126 void ip4_fib_mtrie_init (ip4_fib_mtrie_t * m);
130 void ip4_fib_mtrie_add_del_route (struct ip4_fib_t * f,
131 ip4_address_t dst_address,
132 u32 dst_address_length,
136 /* Returns adjacency index. */
137 u32 ip4_mtrie_lookup_address (ip4_fib_mtrie_t * m, ip4_address_t dst);
139 void ip4_mtrie_maybe_remap_adjacencies (ip_lookup_main_t * lm, ip4_fib_mtrie_t * m);
141 format_function_t format_ip4_fib_mtrie;
143 /* Lookup step. Processes 1 byte of 4 byte ip4 address. */
144 always_inline ip4_fib_mtrie_leaf_t
145 ip4_fib_mtrie_lookup_step (ip4_fib_mtrie_t * m,
146 ip4_fib_mtrie_leaf_t current_leaf,
147 ip4_address_t * dst_address,
148 u32 dst_address_byte_index)
150 ip4_fib_mtrie_leaf_t next_leaf;
151 ip4_fib_mtrie_ply_t * ply;
152 uword current_is_terminal = ip4_fib_mtrie_leaf_is_terminal (current_leaf);
154 ply = m->ply_pool + (current_is_terminal ? 0 : (current_leaf >> 1));
155 next_leaf = ply->leaves[dst_address->as_u8[dst_address_byte_index]];
156 next_leaf = current_is_terminal ? current_leaf : next_leaf;
161 #endif /* included_ip_ip4_fib_h */