FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
lookup.h
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 /*
16  * ip/ip_lookup.h: ip (4 or 6) lookup structures, adjacencies, ...
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
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:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
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.
38  */
39 
40 /**
41  * @file
42  * Definitions for all things IP (v4|v6) unicast and multicast lookup related.
43  *
44  * - Adjacency definitions and registration.
45  * - Callbacks on route add.
46  * - Callbacks on interface address change.
47  */
48 #ifndef included_ip_lookup_h
49 #define included_ip_lookup_h
50 
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/adj/adj.h>
57 #include <vnet/dpo/dpo.h>
58 #include <vnet/feature/feature.h>
59 
60 /** Flow hash configuration */
61 #define IP_FLOW_HASH_SRC_ADDR (1<<0)
62 #define IP_FLOW_HASH_DST_ADDR (1<<1)
63 #define IP_FLOW_HASH_PROTO (1<<2)
64 #define IP_FLOW_HASH_SRC_PORT (1<<3)
65 #define IP_FLOW_HASH_DST_PORT (1<<4)
66 #define IP_FLOW_HASH_REVERSE_SRC_DST (1<<5)
67 #define IP_FLOW_HASH_SYMMETRIC (1<<6)
68 
69 /** Default: 5-tuple without the "reverse" bit */
70 #define IP_FLOW_HASH_DEFAULT (0x1F)
71 
72 #define foreach_flow_hash_bit \
73 _(src, IP_FLOW_HASH_SRC_ADDR) \
74 _(dst, IP_FLOW_HASH_DST_ADDR) \
75 _(sport, IP_FLOW_HASH_SRC_PORT) \
76 _(dport, IP_FLOW_HASH_DST_PORT) \
77 _(proto, IP_FLOW_HASH_PROTO) \
78 _(reverse, IP_FLOW_HASH_REVERSE_SRC_DST) \
79 _(symmetric, IP_FLOW_HASH_SYMMETRIC)
80 
81 /**
82  * A flow hash configuration is a mask of the flow hash options
83  */
85 
86 /* An all zeros address */
87 extern const ip46_address_t zero_addr;
88 
90 {
92 } __clib_packed ip_interface_address_flags_t;
93 
94 typedef struct
95 {
97 
100 
101 typedef struct
102 {
103  /* key - prefix and sw_if_index */
105 
106  /* number of addresses in this prefix on the interface */
108 
109  /* index of the interface address used as a default source address */
112 
113 typedef struct
114 {
115  /* Key for mhash; in fact, just a byte offset into mhash key vector. */
117 
118  /* Interface which has this address. */
120 
121  /* Address (prefix) length for this interface. */
123 
124  /* flags relating to this prefix */
126 
127  /* Next and previous pointers for doubly linked list of
128  addresses per software interface. */
132 
133 typedef enum
134 {
142 
143 struct ip_lookup_main_t;
144 
145 typedef struct ip_lookup_main_t
146 {
147  /** Pool of addresses that are assigned to interfaces. */
149 
150  /** Hash table mapping address to index in interface address pool. */
152 
153  /** Head of doubly linked list of interface addresses for each software interface.
154  ~0 means this interface has no address. */
156 
157  /** Pool of prefixes containing addresses assigned to interfaces */
159 
160  /** Hash table mapping prefix to index in interface prefix pool */
162 
163  /** First table index to use for this interface, ~0 => none */
165 
166  /** Feature arc indices */
170 
171  /** Number of bytes in a fib result. Must be at least
172  sizeof (uword). First word is always adjacency index. */
174 
175  /** 1 for ip6; 0 for ip4. */
177 
178  /** Either format_ip4_address_and_length or format_ip6_address_and_length. */
180 
181  /** Table mapping ip protocol to ip[46]-local node next index. */
183 
184  /** IP_BUILTIN_PROTOCOL_{TCP,UDP,ICMP,OTHER} by protocol in IP header. */
187 
188 u8 *format_ip_flow_hash_config (u8 * s, va_list * args);
189 
190 
191 always_inline void
192 ip_lookup_set_buffer_fib_index (u32 * fib_index_by_sw_if_index,
193  vlib_buffer_t * b)
194 {
195  /* *INDENT-OFF* */
196  vnet_buffer (b)->ip.fib_index =
197  vec_elt (fib_index_by_sw_if_index, vnet_buffer (b)->sw_if_index[VLIB_RX]);
198  vnet_buffer (b)->ip.fib_index =
199  ((vnet_buffer (b)->sw_if_index[VLIB_TX] == (u32) ~ 0) ?
200  vnet_buffer (b)->ip.fib_index :
201  vnet_buffer (b)->sw_if_index[VLIB_TX]);
202  /* *INDENT-ON* */
203 }
204 
205 typedef struct _vnet_ip_container_proxy_args
206 {
209  u8 is_add;
211 
213  * args);
214 
215 typedef int (*ip_container_proxy_cb_t) (const fib_prefix_t * pfx,
216  u32 sw_if_index, void *ctx);
218 
219 void ip_lookup_init (ip_lookup_main_t * lm, u32 ip_lookup_node_index);
220 
221 #endif /* included_ip_lookup_h */
222 /*
223  * fd.io coding-style-patch-verification: ON
224  *
225  * Local Variables:
226  * eval: (c-set-style "gnu")
227  * End:
228  */
Definition: mhash.h:46
void ip_container_proxy_walk(ip_container_proxy_cb_t cb, void *ctx)
Definition: lookup.c:989
ip_interface_address_t * if_address_pool
Pool of addresses that are assigned to interfaces.
Definition: lookup.h:148
vl_api_prefix_t prefix
Definition: ip.api:144
mhash_t address_to_if_address_index
Hash table mapping address to index in interface address pool.
Definition: lookup.h:151
u8 mcast_feature_arc_index
Feature arc indices.
Definition: lookup.h:167
unsigned char u8
Definition: types.h:56
u8 *() format_function_t(u8 *s, va_list *args)
Definition: format.h:48
u8 output_feature_arc_index
Definition: lookup.h:169
struct _vnet_ip_container_proxy_args vnet_ip_container_proxy_args_t
Aggregate type for a prefix.
Definition: fib_types.h:203
unsigned int u32
Definition: types.h:88
enum ip_interface_address_flags_t_ ip_interface_address_flags_t
int(* ip_container_proxy_cb_t)(const fib_prefix_t *pfx, u32 sw_if_index, void *ctx)
Definition: lookup.h:215
struct ip_lookup_main_t ip_lookup_main_t
u32 * classify_table_index_by_sw_if_index
First table index to use for this interface, ~0 => none.
Definition: lookup.h:164
static void ip_lookup_set_buffer_fib_index(u32 *fib_index_by_sw_if_index, vlib_buffer_t *b)
Definition: lookup.h:192
long ctx[MAX_CONNS]
Definition: main.c:144
unsigned short u16
Definition: types.h:57
fib_prefix_t prefix
Definition: lookup.h:96
u8 local_next_by_ip_protocol[256]
Table mapping ip protocol to ip[46]-local node next index.
Definition: lookup.h:182
#define always_inline
Definition: ipsec.h:28
u8 * format_ip_flow_hash_config(u8 *s, va_list *args)
Definition: lookup.c:119
ip_interface_address_flags_t flags
Definition: lookup.h:125
const ip46_address_t zero_addr
Definition: lookup.c:181
ip_interface_address_flags_t_
Definition: lookup.h:89
u8 builtin_protocol_by_ip_protocol[256]
IP_BUILTIN_PROTOCOL_{TCP,UDP,ICMP,OTHER} by protocol in IP header.
Definition: lookup.h:185
u32 * if_address_pool_index_by_sw_if_index
Head of doubly linked list of interface addresses for each software interface.
Definition: lookup.h:155
vlib buffer structure definition and a few select access methods.
u32 fib_result_n_words
Definition: lookup.h:173
clib_error_t * vnet_ip_container_proxy_add_del(vnet_ip_container_proxy_args_t *args)
Definition: lookup.c:903
u32 flow_hash_config_t
A flow hash configuration is a mask of the flow hash options.
Definition: lookup.h:84
#define vec_elt(v, i)
Get vector value at index i.
u8 ucast_feature_arc_index
Definition: lookup.h:168
Definition: defs.h:47
mhash_t prefix_to_if_prefix_index
Hash table mapping prefix to index in interface prefix pool.
Definition: lookup.h:161
ip_interface_prefix_key_t key
Definition: lookup.h:104
VLIB buffer representation.
Definition: buffer.h:102
u32 is_ip6
1 for ip6; 0 for ip4.
Definition: lookup.h:176
#define vnet_buffer(b)
Definition: buffer.h:417
ip_local_next_t
Definition: lookup.h:133
void ip_lookup_init(ip_lookup_main_t *lm, u32 ip_lookup_node_index)
Definition: lookup.c:76
ip_interface_prefix_t * if_prefix_pool
Pool of prefixes containing addresses assigned to interfaces.
Definition: lookup.h:158
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:33
Definition: defs.h:46
u32 fib_result_n_bytes
Number of bytes in a fib result.
Definition: lookup.h:173
format_function_t * format_address_and_length
Either format_ip4_address_and_length or format_ip6_address_and_length.
Definition: lookup.h:179