FD.io VPP  v19.08.3-2-gbabecb413
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 
89 typedef struct
90 {
92 
95 
96 typedef struct
97 {
98  /* key - prefix and sw_if_index */
100 
101  /* number of addresses in this prefix on the interface */
103 
104  /* index of the interface address used as a default source address */
107 
108 typedef struct
109 {
110  /* Key for mhash; in fact, just a byte offset into mhash key vector. */
112 
113  /* Interface which has this address. */
115 
116  /* Address (prefix) length for this interface. */
118 
119  /* Will be used for something eventually. Primary vs. secondary? */
121 
122  /* Next and previous pointers for doubly linked list of
123  addresses per software interface. */
127 
128 typedef enum
129 {
137 
138 struct ip_lookup_main_t;
139 
140 typedef struct ip_lookup_main_t
141 {
142  /** Pool of addresses that are assigned to interfaces. */
144 
145  /** Hash table mapping address to index in interface address pool. */
147 
148  /** Head of doubly linked list of interface addresses for each software interface.
149  ~0 means this interface has no address. */
151 
152  /** Pool of prefixes containing addresses assigned to interfaces */
154 
155  /** Hash table mapping prefix to index in interface prefix pool */
157 
158  /** First table index to use for this interface, ~0 => none */
160 
161  /** Feature arc indices */
165 
166  /** Number of bytes in a fib result. Must be at least
167  sizeof (uword). First word is always adjacency index. */
169 
170  /** 1 for ip6; 0 for ip4. */
172 
173  /** Either format_ip4_address_and_length or format_ip6_address_and_length. */
175 
176  /** Table mapping ip protocol to ip[46]-local node next index. */
178 
179  /** IP_BUILTIN_PROTOCOL_{TCP,UDP,ICMP,OTHER} by protocol in IP header. */
182 
185  void *address,
186  u32 address_length,
187  u32 is_del, u32 * result_index);
188 
189 u8 *format_ip_flow_hash_config (u8 * s, va_list * args);
190 
193 {
194  uword *p = mhash_get (&lm->address_to_if_address_index, addr_fib);
195  return p ? pool_elt_at_index (lm->if_address_pool, p[0]) : 0;
196 }
197 
198 always_inline void *
201 {
203 }
204 
207 {
209  return p ? pool_elt_at_index (lm->if_prefix_pool, p[0]) : 0;
210 }
211 
212 /* *INDENT-OFF* */
213 #define foreach_ip_interface_address(lm,a,sw_if_index,loop,body) \
214 do { \
215  vnet_main_t *_vnm = vnet_get_main(); \
216  u32 _sw_if_index = sw_if_index; \
217  vnet_sw_interface_t *_swif; \
218  _swif = vnet_get_sw_interface (_vnm, _sw_if_index); \
219  \
220  /* \
221  * Loop => honor unnumbered interface addressing. \
222  */ \
223  if (_swif->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED) \
224  { \
225  if (loop) \
226  _sw_if_index = _swif->unnumbered_sw_if_index; \
227  else \
228  /* the interface is unnumbered, by the caller does not want \
229  * unnumbered interfaces considered/honoured */ \
230  break; \
231  } \
232  u32 _ia = ((vec_len((lm)->if_address_pool_index_by_sw_if_index) \
233  > (_sw_if_index)) ? \
234  vec_elt ((lm)->if_address_pool_index_by_sw_if_index, \
235  (_sw_if_index)) : \
236  (u32)~0); \
237  ip_interface_address_t * _a; \
238  while (_ia != ~0) \
239  { \
240  _a = pool_elt_at_index ((lm)->if_address_pool, _ia); \
241  _ia = _a->next_this_sw_interface; \
242  (a) = _a; \
243  body; \
244  } \
245 } while (0)
246 /* *INDENT-ON* */
247 
248 always_inline void
249 ip_lookup_set_buffer_fib_index (u32 * fib_index_by_sw_if_index,
250  vlib_buffer_t * b)
251 {
252  /* *INDENT-OFF* */
253  vnet_buffer (b)->ip.fib_index =
254  vec_elt (fib_index_by_sw_if_index, vnet_buffer (b)->sw_if_index[VLIB_RX]);
255  vnet_buffer (b)->ip.fib_index =
256  ((vnet_buffer (b)->sw_if_index[VLIB_TX] == (u32) ~ 0) ?
257  vnet_buffer (b)->ip.fib_index :
258  vnet_buffer (b)->sw_if_index[VLIB_TX]);
259  /* *INDENT-ON* */
260 }
261 
262 typedef struct _vnet_ip_container_proxy_args
263 {
266  u8 is_add;
268 
270  * args);
271 
272 typedef int (*ip_container_proxy_cb_t) (const fib_prefix_t * pfx,
273  u32 sw_if_index, void *ctx);
275 
276 void ip_lookup_init (ip_lookup_main_t * lm, u32 ip_lookup_node_index);
277 
278 #endif /* included_ip_lookup_h */
279 /*
280  * fd.io coding-style-patch-verification: ON
281  *
282  * Local Variables:
283  * eval: (c-set-style "gnu")
284  * End:
285  */
Definition: mhash.h:46
typedef address
Definition: ip_types.api:83
void ip_container_proxy_walk(ip_container_proxy_cb_t cb, void *ctx)
Definition: lookup.c:1338
a
Definition: bitmap.h:538
clib_error_t * ip_interface_address_add_del(ip_lookup_main_t *lm, u32 sw_if_index, void *address, u32 address_length, u32 is_del, u32 *result_index)
Definition: lookup.c:63
ip_interface_address_t * if_address_pool
Pool of addresses that are assigned to interfaces.
Definition: lookup.h:143
vl_api_mprefix_t prefix
Definition: ip.api:456
mhash_t address_to_if_address_index
Hash table mapping address to index in interface address pool.
Definition: lookup.h:146
u8 mcast_feature_arc_index
Feature arc indices.
Definition: lookup.h:162
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:164
vl_api_interface_index_t sw_if_index
Definition: gre.api:50
#define always_inline
Definition: clib.h:99
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
int(* ip_container_proxy_cb_t)(const fib_prefix_t *pfx, u32 sw_if_index, void *ctx)
Definition: lookup.h:272
struct ip_lookup_main_t ip_lookup_main_t
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:514
u32 * classify_table_index_by_sw_if_index
First table index to use for this interface, ~0 => none.
Definition: lookup.h:159
static void ip_lookup_set_buffer_fib_index(u32 *fib_index_by_sw_if_index, vlib_buffer_t *b)
Definition: lookup.h:249
long ctx[MAX_CONNS]
Definition: main.c:144
unsigned short u16
Definition: types.h:57
fib_prefix_t prefix
Definition: lookup.h:91
u8 local_next_by_ip_protocol[256]
Table mapping ip protocol to ip[46]-local node next index.
Definition: lookup.h:177
u8 * format_ip_flow_hash_config(u8 *s, va_list *args)
Definition: lookup.c:247
const ip46_address_t zero_addr
Definition: lookup.c:326
static ip_interface_address_t * ip_get_interface_address(ip_lookup_main_t *lm, void *addr_fib)
Definition: lookup.h:192
u8 builtin_protocol_by_ip_protocol[256]
IP_BUILTIN_PROTOCOL_{TCP,UDP,ICMP,OTHER} by protocol in IP header.
Definition: lookup.h:180
u32 * if_address_pool_index_by_sw_if_index
Head of doubly linked list of interface addresses for each software interface.
Definition: lookup.h:150
vlib buffer structure definition and a few select access methods.
static uword * mhash_get(mhash_t *h, const void *key)
Definition: mhash.h:110
u32 fib_result_n_words
Definition: lookup.h:168
clib_error_t * vnet_ip_container_proxy_add_del(vnet_ip_container_proxy_args_t *args)
Definition: lookup.c:1252
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:163
Definition: defs.h:47
mhash_t prefix_to_if_prefix_index
Hash table mapping prefix to index in interface prefix pool.
Definition: lookup.h:156
ip_interface_prefix_key_t key
Definition: lookup.h:99
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
u32 is_ip6
1 for ip6; 0 for ip4.
Definition: lookup.h:171
static void * mhash_key_to_mem(mhash_t *h, uword key)
Definition: mhash.h:90
#define vnet_buffer(b)
Definition: buffer.h:365
ip_local_next_t
Definition: lookup.h:128
void ip_lookup_init(ip_lookup_main_t *lm, u32 ip_lookup_node_index)
Definition: lookup.c:204
static void * ip_interface_address_get_address(ip_lookup_main_t *lm, ip_interface_address_t *a)
Definition: lookup.h:199
ip_interface_prefix_t * if_prefix_pool
Pool of prefixes containing addresses assigned to interfaces.
Definition: lookup.h:153
static ip_interface_prefix_t * ip_get_interface_prefix(ip_lookup_main_t *lm, ip_interface_prefix_key_t *k)
Definition: lookup.h:206
Definition: defs.h:46
u32 fib_result_n_bytes
Number of bytes in a fib result.
Definition: lookup.h:168
format_function_t * format_address_and_length
Either format_ip4_address_and_length or format_ip6_address_and_length.
Definition: lookup.h:174