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/ip_lookup.h: ip (4 or 6) lookup structures, adjacencies, ...
18 * Copyright (c) 2008 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.
42 * Definitions for all things IP (v4|v6) unicast and multicast lookup related.
44 * - Adjacency definitions and registration.
45 * - Callbacks on route add.
46 * - Callbacks on interface address change.
48 #ifndef included_ip_lookup_h
49 #define included_ip_lookup_h
51 #include <vnet/vnet.h>
52 #include <vlib/buffer.h>
53 #include <vnet/ip/ip4_packet.h>
54 #include <vnet/ip/ip6_packet.h>
55 #include <vnet/fib/fib_node.h>
56 #include <vnet/dpo/dpo.h>
57 #include <vnet/feature/feature.h>
59 /** @brief Common (IP4/IP6) next index stored in adjacency. */
62 /** Adjacency to drop this packet. */
64 /** Adjacency to punt this packet. */
67 /** This packet is for one of our own IP addresses. */
70 /** This packet matches an "incomplete adjacency" and packets
71 need to be passed to ARP to find rewrite string for
75 /** This packet matches an "interface route" and packets
76 need to be passed to ARP to find rewrite string for
80 /** This packet is to be rewritten and forwarded to the next
81 processing node. This is typically the output interface but
82 might be another node for further output processing. */
83 IP_LOOKUP_NEXT_REWRITE,
85 /** This packets follow a load-balance */
86 IP_LOOKUP_NEXT_LOAD_BALANCE,
88 /** This packets follow a mid-chain adjacency */
89 IP_LOOKUP_NEXT_MIDCHAIN,
91 /** This packets needs to go to ICMP error */
92 IP_LOOKUP_NEXT_ICMP_ERROR,
99 IP4_LOOKUP_N_NEXT = IP_LOOKUP_N_NEXT,
104 /* Hop-by-hop header handling */
105 IP6_LOOKUP_NEXT_HOP_BY_HOP = IP_LOOKUP_N_NEXT,
106 IP6_LOOKUP_NEXT_ADD_HOP_BY_HOP,
107 IP6_LOOKUP_NEXT_POP_HOP_BY_HOP,
111 #define IP4_LOOKUP_NEXT_NODES { \
112 [IP_LOOKUP_NEXT_DROP] = "ip4-drop", \
113 [IP_LOOKUP_NEXT_PUNT] = "ip4-punt", \
114 [IP_LOOKUP_NEXT_LOCAL] = "ip4-local", \
115 [IP_LOOKUP_NEXT_ARP] = "ip4-arp", \
116 [IP_LOOKUP_NEXT_GLEAN] = "ip4-glean", \
117 [IP_LOOKUP_NEXT_REWRITE] = "ip4-rewrite", \
118 [IP_LOOKUP_NEXT_MIDCHAIN] = "ip4-midchain", \
119 [IP_LOOKUP_NEXT_LOAD_BALANCE] = "ip4-load-balance", \
120 [IP_LOOKUP_NEXT_ICMP_ERROR] = "ip4-icmp-error", \
123 #define IP6_LOOKUP_NEXT_NODES { \
124 [IP_LOOKUP_NEXT_DROP] = "ip6-drop", \
125 [IP_LOOKUP_NEXT_PUNT] = "ip6-punt", \
126 [IP_LOOKUP_NEXT_LOCAL] = "ip6-local", \
127 [IP_LOOKUP_NEXT_ARP] = "ip6-discover-neighbor", \
128 [IP_LOOKUP_NEXT_GLEAN] = "ip6-glean", \
129 [IP_LOOKUP_NEXT_REWRITE] = "ip6-rewrite", \
130 [IP_LOOKUP_NEXT_MIDCHAIN] = "ip6-midchain", \
131 [IP_LOOKUP_NEXT_LOAD_BALANCE] = "ip6-load-balance", \
132 [IP_LOOKUP_NEXT_ICMP_ERROR] = "ip6-icmp-error", \
133 [IP6_LOOKUP_NEXT_HOP_BY_HOP] = "ip6-hop-by-hop", \
134 [IP6_LOOKUP_NEXT_ADD_HOP_BY_HOP] = "ip6-add-hop-by-hop", \
135 [IP6_LOOKUP_NEXT_POP_HOP_BY_HOP] = "ip6-pop-hop-by-hop", \
138 /** Flow hash configuration */
139 #define IP_FLOW_HASH_SRC_ADDR (1<<0)
140 #define IP_FLOW_HASH_DST_ADDR (1<<1)
141 #define IP_FLOW_HASH_PROTO (1<<2)
142 #define IP_FLOW_HASH_SRC_PORT (1<<3)
143 #define IP_FLOW_HASH_DST_PORT (1<<4)
144 #define IP_FLOW_HASH_REVERSE_SRC_DST (1<<5)
146 /** Default: 5-tuple without the "reverse" bit */
147 #define IP_FLOW_HASH_DEFAULT (0x1F)
149 #define foreach_flow_hash_bit \
150 _(src, IP_FLOW_HASH_SRC_ADDR) \
151 _(dst, IP_FLOW_HASH_DST_ADDR) \
152 _(sport, IP_FLOW_HASH_SRC_PORT) \
153 _(dport, IP_FLOW_HASH_DST_PORT) \
154 _(proto, IP_FLOW_HASH_PROTO) \
155 _(reverse, IP_FLOW_HASH_REVERSE_SRC_DST)
158 * A flow hash configuration is a mask of the flow hash options
160 typedef u32 flow_hash_config_t;
165 struct ip_adjacency_t_;
168 * @brief A function type for post-rewrite fixups on midchain adjacency
170 typedef void (*adj_midchain_fixup_t) (vlib_main_t * vm,
171 struct ip_adjacency_t_ * adj,
175 * @brief Flags on an IP adjacency
177 typedef enum ip_adjacency_flags_t_
180 * Currently a sync walk is active. Used to prevent re-entrant walking
182 IP_ADJ_SYNC_WALK_ACTIVE = (1 << 0),
183 } ip_adjacency_flags_t;
185 /** @brief IP unicast adjacency.
188 typedef struct ip_adjacency_t_
190 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
192 /** Number of adjecencies in block. Greater than 1 means multipath;
193 otherwise equal to 1. */
196 /** Next hop after ip4-lookup. */
199 ip_lookup_next_t lookup_next_index:16;
200 u16 lookup_next_index_as_int;
203 /** Interface address index for this local/arp adjacency. */
204 u32 if_address_index;
206 /** Force re-lookup in a different FIB. ~0 => normal behavior */
207 u16 mcast_group_index;
209 /** Highest possible perf subgraph arc interposition, e.g. for ip6 ioam */
210 u16 saved_lookup_next_index;
221 * IP_LOOKUP_NEXT_ARP/IP_LOOKUP_NEXT_REWRITE
223 * neighbour adjacency sub-type;
227 ip46_address_t next_hop;
230 * IP_LOOKUP_NEXT_MIDCHAIN
232 * A nbr adj that is also recursive. Think tunnels.
233 * A nbr adj can transition to be of type MDICHAIN
234 * so be sure to leave the two structs with the next_hop
240 * The recursive next-hop
242 ip46_address_t next_hop;
244 * The node index of the tunnel's post rewrite/TX function.
246 u32 tx_function_node;
248 * The next DPO to use
252 * A function to perform the post-rewrite fixup
254 adj_midchain_fixup_t fixup_func;
257 * IP_LOOKUP_NEXT_GLEAN
259 * Glean the address to ARP for from the packet's destination
263 ip46_address_t receive_addr;
267 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
269 /* Rewrite in second/third cache lines */
270 vnet_declare_rewrite (VLIB_BUFFER_PRE_DATA_SIZE);
273 * member not accessed in the data plane are relgated to the
274 * remaining cachelines
279 * Flags on the adjacency
281 ip_adjacency_flags_t ia_flags;
285 STATIC_ASSERT ((STRUCT_OFFSET_OF (ip_adjacency_t, cacheline0) == 0),
286 "IP adjacency cachline 0 is not offset");
287 STATIC_ASSERT ((STRUCT_OFFSET_OF (ip_adjacency_t, cacheline1) ==
288 CLIB_CACHE_LINE_BYTES),
289 "IP adjacency cachline 1 is more than one cachline size offset");
291 /* An all zeros address */
292 extern const ip46_address_t zero_addr;
294 /* IP multicast adjacency. */
297 /* Handle for this adjacency in adjacency heap. */
300 /* Number of adjecencies in block. */
303 /* Rewrite string. */
304 vnet_declare_rewrite (64 - 2 * sizeof (u32));
306 ip_multicast_rewrite_t;
310 /* ip4-multicast-rewrite next index. */
315 u8 rewrite_string[64 - 1 * sizeof (u32) - 1 * sizeof (u8)];
317 ip_multicast_rewrite_string_t;
321 ip_multicast_rewrite_t *rewrite_heap;
323 ip_multicast_rewrite_string_t *rewrite_strings;
325 /* Negative rewrite string index; >= 0 sw_if_index.
326 Sorted. Used to hash. */
327 i32 **adjacency_id_vector;
329 uword *adjacency_by_id_vector;
330 } ip_multicast_lookup_main_t;
334 /* Key for mhash; in fact, just a byte offset into mhash key vector. */
337 /* Interface which has this address. */
340 /* Adjacency for neighbor probe (ARP) for this interface address. */
341 u32 neighbor_probe_adj_index;
343 /* Address (prefix) length for this interface. */
346 /* Will be used for something eventually. Primary vs. secondary? */
349 /* Next and previous pointers for doubly linked list of
350 addresses per software interface. */
351 u32 next_this_sw_interface;
352 u32 prev_this_sw_interface;
353 } ip_interface_address_t;
359 IP_LOCAL_NEXT_UDP_LOOKUP,
364 struct ip_lookup_main_t;
366 typedef struct ip_lookup_main_t
368 /* Adjacency heap. */
369 ip_adjacency_t *adjacency_heap;
371 /** load-balance packet/byte counters indexed by LB index. */
372 vlib_combined_counter_main_t load_balance_counters;
374 /** Pool of addresses that are assigned to interfaces. */
375 ip_interface_address_t *if_address_pool;
377 /** Hash table mapping address to index in interface address pool. */
378 mhash_t address_to_if_address_index;
380 /** Head of doubly linked list of interface addresses for each software interface.
381 ~0 means this interface has no address. */
382 u32 *if_address_pool_index_by_sw_if_index;
384 /** First table index to use for this interface, ~0 => none */
385 u32 *classify_table_index_by_sw_if_index;
387 /** Feature arc indices */
388 u8 mcast_feature_arc_index;
389 u8 ucast_feature_arc_index;
390 u8 output_feature_arc_index;
392 /** Number of bytes in a fib result. Must be at least
393 sizeof (uword). First word is always adjacency index. */
394 u32 fib_result_n_bytes, fib_result_n_words;
396 format_function_t *format_fib_result;
398 /** 1 for ip6; 0 for ip4. */
401 /** Either format_ip4_address_and_length or format_ip6_address_and_length. */
402 format_function_t *format_address_and_length;
404 /** Special adjacency format functions */
405 format_function_t **special_adjacency_format_functions;
407 /** Table mapping ip protocol to ip[46]-local node next index. */
408 u8 local_next_by_ip_protocol[256];
410 /** IP_BUILTIN_PROTOCOL_{TCP,UDP,ICMP,OTHER} by protocol in IP header. */
411 u8 builtin_protocol_by_ip_protocol[256];
414 always_inline ip_adjacency_t *
415 ip_get_adjacency (ip_lookup_main_t * lm, u32 adj_index)
419 adj = vec_elt_at_index (lm->adjacency_heap, adj_index);
424 #define ip_prefetch_adjacency(lm,adj_index,type) \
426 ip_adjacency_t * _adj = (lm)->adjacency_heap + (adj_index); \
427 CLIB_PREFETCH (_adj, sizeof (_adj[0]), type); \
430 /* Create new block of given number of contiguous adjacencies. */
431 ip_adjacency_t *ip_add_adjacency (ip_lookup_main_t * lm,
432 ip_adjacency_t * adj,
433 u32 n_adj, u32 * adj_index_result);
435 clib_error_t *ip_interface_address_add_del (ip_lookup_main_t * lm,
439 u32 is_del, u32 * result_index);
441 u8 *format_ip_flow_hash_config (u8 * s, va_list * args);
443 always_inline ip_interface_address_t *
444 ip_get_interface_address (ip_lookup_main_t * lm, void *addr_fib)
446 uword *p = mhash_get (&lm->address_to_if_address_index, addr_fib);
447 return p ? pool_elt_at_index (lm->if_address_pool, p[0]) : 0;
450 u32 fib_table_id_find_fib_index (fib_protocol_t proto, u32 table_id);
453 ip_interface_address_get_address (ip_lookup_main_t * lm,
454 ip_interface_address_t * a)
456 return mhash_key_to_mem (&lm->address_to_if_address_index, a->address_key);
460 #define foreach_ip_interface_address(lm,a,sw_if_index,loop,body) \
462 vnet_main_t *_vnm = vnet_get_main(); \
463 u32 _sw_if_index = sw_if_index; \
464 vnet_sw_interface_t *_swif; \
465 _swif = vnet_get_sw_interface (_vnm, _sw_if_index); \
468 * Loop => honor unnumbered interface addressing. \
470 if (loop && _swif->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED) \
471 _sw_if_index = _swif->unnumbered_sw_if_index; \
473 (vec_len((lm)->if_address_pool_index_by_sw_if_index) \
475 ? vec_elt ((lm)->if_address_pool_index_by_sw_if_index, \
476 (_sw_if_index)) : (u32)~0; \
477 ip_interface_address_t * _a; \
480 _a = pool_elt_at_index ((lm)->if_address_pool, _ia); \
481 _ia = _a->next_this_sw_interface; \
488 void ip_lookup_init (ip_lookup_main_t * lm, u32 ip_lookup_node_index);
490 #endif /* included_ip_lookup_h */
493 * fd.io coding-style-patch-verification: ON
496 * eval: (c-set-style "gnu")