FD.io VPP  v17.07.01-10-g3be13f0
Vector Packet Processing
ip4.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/ip4.h: ip4 main include file
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 #ifndef included_ip_ip4_h
41 #define included_ip_ip4_h
42 
43 #include <vnet/ip/ip4_packet.h>
44 #include <vnet/ip/lookup.h>
45 #include <vnet/feature/feature.h>
46 
47 typedef struct ip4_mfib_t
48 {
49  /* Hash table for each prefix length mapping. */
51 
52  /* Table ID (hash key) for this FIB. */
54 
55  /* Index into FIB vector. */
57 } ip4_mfib_t;
58 
59 struct ip4_main_t;
60 
62  (struct ip4_main_t * im,
63  uword opaque,
64  u32 sw_if_index,
65  ip4_address_t * address,
66  u32 address_length, u32 if_address_index, u32 is_del);
67 
68 typedef struct
69 {
73 
74 /**
75  * @brief IPv4 main type.
76  *
77  * State of IPv4 VPP processing including:
78  * - FIBs
79  * - Feature indices used in feature topological sort
80  * - Feature node run time references
81  */
82 
83 typedef struct ip4_main_t
84 {
86 
87  /** Vector of FIBs. */
88  struct fib_table_t_ *fibs;
89 
90  /** Vector of MTries. */
92 
93  /** Vector of MFIBs. */
95 
96  u32 fib_masks[33];
97 
98  /** Table index indexed by software interface. */
100 
101  /** Table index indexed by software interface. */
103 
104  /* IP4 enabled count by software interface */
106 
107  /** Hash table mapping table id to fib index.
108  ID space is not necessarily dense; index space is dense. */
110 
111  /** Hash table mapping table id to multicast fib index.
112  ID space is not necessarily dense; index space is dense. */
114 
115  /** Functions to call when interface address changes. */
118 
119  /** Template used to generate IP4 ARP packets. */
121 
122  /** Seed for Jenkins hash used to compute ip4 flow hash. */
124 
125  /** @brief Template information for VPP generated packets */
126  struct
127  {
128  /** TTL to use for host generated packets. */
130 
131  /** TOS byte to use for host generated packets. */
133 
134  u8 pad[2];
135  } host_config;
136 } ip4_main_t;
137 
138 /** Global ip4 main structure. */
139 extern ip4_main_t ip4_main;
140 
141 /** Global ip4 input node. Errors get attached to ip4 input node. */
151 
154  const ip4_address_t * key,
155  const ip4_address_t * dest, uword dest_length)
156 {
157  return 0 == ((key->data_u32 ^ dest->data_u32) & im->fib_masks[dest_length]);
158 }
159 
162  ip4_address_t * key,
164 {
166  return ip4_destination_matches_route (im, key, a, ia->address_length);
167 }
168 
169 /* As above but allows for unaligned destinations (e.g. works right from IP header of packet). */
172  ip4_address_t * key,
173  ip4_address_t * dest,
174  uword dest_length)
175 {
176  return 0 ==
177  ((clib_mem_unaligned (&key->data_u32, u32) ^ dest->
178  data_u32) & im->fib_masks[dest_length]);
179 }
180 
181 always_inline int
183  u32 sw_if_index, ip4_address_t * src)
184 {
185  u32 if_add_index = lm->if_address_pool_index_by_sw_if_index[sw_if_index];
186  if (PREDICT_TRUE (if_add_index != ~0))
187  {
188  ip_interface_address_t *if_add =
189  pool_elt_at_index (lm->if_address_pool, if_add_index);
190  ip4_address_t *if_ip = ip_interface_address_get_address (lm, if_add);
191  *src = *if_ip;
192  return 0;
193  }
194  else
195  {
196  src->as_u32 = 0;
197  }
198  return (!0);
199 }
200 
201 /* Find interface address which matches destination. */
204  ip4_address_t * dst,
205  u32 sw_if_index,
207  result_ia)
208 {
209  ip_lookup_main_t *lm = &im->lookup_main;
211  ip4_address_t *result = 0;
212 
213  /* *INDENT-OFF* */
214  foreach_ip_interface_address (lm, ia, sw_if_index,
215  1 /* honor unnumbered */,
216  ({
218  if (ip4_destination_matches_route (im, dst, a, ia->address_length))
219  {
220  result = a;
221  break;
222  }
223  }));
224  /* *INDENT-ON* */
225  if (result_ia)
226  *result_ia = result ? ia : 0;
227  return result;
228 }
229 
232  result_ia);
233 
235  u32 sw_if_index,
236  ip4_address_t * address,
237  u32 address_length, u32 is_del);
238 
239 void ip4_sw_interface_enable_disable (u32 sw_if_index, u32 is_enable);
240 
242 
243 /* Send an ARP request to see if given destination is reachable on given interface. */
245  u32 sw_if_index);
246 
247 clib_error_t *ip4_set_arp_limit (u32 arp_limit);
248 
249 uword
251  u16 dst_port, u32 next_node_index);
252 
253 void
254 ip4_icmp_register_type (vlib_main_t * vm, icmp4_type_t type, u32 node_index);
255 
257  ip4_header_t * ip0);
258 
259 void ip4_register_protocol (u32 protocol, u32 node_index);
260 
262 
264  flow_hash_config_t flow_hash_config);
265 
266 int vnet_set_ip4_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
267  u32 table_index);
268 
269 /* Compute flow hash. We'll use it to select which adjacency to use for this
270  flow. And other things. */
273  flow_hash_config_t flow_hash_config)
274 {
275  tcp_header_t *tcp = (void *) (ip + 1);
276  u32 a, b, c, t1, t2;
277  uword is_tcp_udp = (ip->protocol == IP_PROTOCOL_TCP
278  || ip->protocol == IP_PROTOCOL_UDP);
279 
280  t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR)
281  ? ip->src_address.data_u32 : 0;
282  t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR)
283  ? ip->dst_address.data_u32 : 0;
284 
285  a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
286  b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
287  b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? ip->protocol : 0;
288 
289  t1 = is_tcp_udp ? tcp->src : 0;
290  t2 = is_tcp_udp ? tcp->dst : 0;
291 
292  t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
293  t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
294 
295  c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
296  (t1 << 16) | t2 : (t2 << 16) | t1;
297 
298  hash_v3_mix32 (a, b, c);
299  hash_v3_finalize32 (a, b, c);
300 
301  return c;
302 }
303 
304 void
306  vlib_node_runtime_t * node,
307  vlib_frame_t * frame,
308  vlib_rx_or_tx_t which_adj_index);
309 
310 u8 *format_ip4_forward_next_trace (u8 * s, va_list * args);
311 
313 
314 #define IP_DF 0x4000 /* don't fragment */
315 
316 /**
317  * Push IPv4 header to buffer
318  *
319  * This does not support fragmentation.
320  *
321  * @param vm - vlib_main
322  * @param b - buffer to write the header to
323  * @param src - source IP
324  * @param dst - destination IP
325  * @param prot - payload proto
326  *
327  * @return - pointer to start of IP header
328  */
329 always_inline void *
331  ip4_address_t * src, ip4_address_t * dst, int proto)
332 {
333  ip4_header_t *ih;
334 
335  /* make some room */
336  ih = vlib_buffer_push_uninit (b, sizeof (ip4_header_t));
337 
338  ih->ip_version_and_header_length = 0x45;
339  ih->tos = 0;
340  ih->length = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b));
341 
342  /* No fragments */
343  ih->flags_and_fragment_offset = clib_host_to_net_u16 (IP_DF);
344  ih->ttl = 255;
345  ih->protocol = proto;
346  ih->src_address.as_u32 = src->as_u32;
347  ih->dst_address.as_u32 = dst->as_u32;
348 
349  ih->checksum = ip4_header_checksum (ih);
350  return ih;
351 }
352 #endif /* included_ip_ip4_h */
353 
354 /*
355  * fd.io coding-style-patch-verification: ON
356  *
357  * Local Variables:
358  * eval: (c-set-style "gnu")
359  * End:
360  */
#define foreach_ip_interface_address(lm, a, sw_if_index, loop, body)
Definition: lookup.h:179
u8 pad[3]
log2 (size of the packing page block)
Definition: bihash_doc.h:61
int vnet_set_ip4_flow_hash(u32 table_id, flow_hash_config_t flow_hash_config)
Definition: ip4_forward.c:3039
ip4_add_del_interface_address_callback_t * add_del_interface_address_callbacks
Functions to call when interface address changes.
Definition: ip4.h:117
a
Definition: bitmap.h:516
#define IP_FLOW_HASH_SRC_PORT
Definition: lookup.h:64
ip4_address_t src_address
Definition: ip4_packet.h:164
u32 index
Definition: ip4.h:56
ip_interface_address_t * if_address_pool
Pool of addresses that are assigned to interfaces.
Definition: lookup.h:122
serialize_function_t serialize_vnet_ip4_main
Definition: ip4.h:261
#define PREDICT_TRUE(x)
Definition: clib.h:98
Definitions for all things IP (v4|v6) unicast and multicast lookup related.
static u32 ip4_compute_flow_hash(const ip4_header_t *ip, flow_hash_config_t flow_hash_config)
Definition: ip4.h:272
ip4_address_t * ip4_interface_first_address(ip4_main_t *im, u32 sw_if_index, ip_interface_address_t **result_ia)
Definition: ip4_forward.c:684
#define IP_FLOW_HASH_REVERSE_SRC_DST
Definition: lookup.h:66
vlib_node_registration_t ip4_midchain_node
(constructor) VLIB_REGISTER_NODE (ip4_midchain_node)
Definition: ip4_forward.c:2836
void( ip4_add_del_interface_address_function_t)(struct ip4_main_t *im, uword opaque, u32 sw_if_index, ip4_address_t *address, u32 address_length, u32 if_address_index, u32 is_del)
Definition: ip4.h:62
struct _vlib_node_registration vlib_node_registration_t
#define IP_FLOW_HASH_DST_PORT
Definition: lookup.h:65
ip_lookup_main_t lookup_main
Definition: ip4.h:85
static uword ip4_destination_matches_route(const ip4_main_t *im, const ip4_address_t *key, const ip4_address_t *dest, uword dest_length)
Definition: ip4.h:153
u32 * fib_index_by_sw_if_index
Table index indexed by software interface.
Definition: ip4.h:99
u16 flags_and_fragment_offset
Definition: ip4_packet.h:145
static uword ip4_unaligned_destination_matches_route(ip4_main_t *im, ip4_address_t *key, ip4_address_t *dest, uword dest_length)
Definition: ip4.h:171
#define IP_DF
Definition: ip4.h:314
void ip4_register_protocol(u32 protocol, u32 node_index)
Definition: ip4_forward.c:1959
uword ip4_udp_register_listener(vlib_main_t *vm, u16 dst_port, u32 next_node_index)
static uword vlib_buffer_length_in_chain(vlib_main_t *vm, vlib_buffer_t *b)
Get length in bytes of the buffer chain.
Definition: buffer_funcs.h:100
struct _tcp_header tcp_header_t
#define hash_v3_mix32(a, b, c)
Definition: hash.h:530
vlib_node_registration_t ip4_lookup_node
(constructor) VLIB_REGISTER_NODE (ip4_lookup_node)
Definition: ip4_forward.c:479
vlib_node_registration_t ip4_rewrite_mcast_node
(constructor) VLIB_REGISTER_NODE (ip4_rewrite_mcast_node)
Definition: ip4_forward.c:2816
vlib_rx_or_tx_t
Definition: defs.h:44
u32 * mfib_index_by_sw_if_index
Table index indexed by software interface.
Definition: ip4.h:102
#define IP_FLOW_HASH_DST_ADDR
Definition: lookup.h:62
#define always_inline
Definition: clib.h:84
ip4_address_t dst_address
Definition: ip4_packet.h:164
struct mfib_table_t_ * mfibs
Vector of MFIBs.
Definition: ip4.h:94
int vnet_set_ip4_classify_intfc(vlib_main_t *vm, u32 sw_if_index, u32 table_index)
Definition: ip4_forward.c:3191
void ip4_icmp_register_type(vlib_main_t *vm, icmp4_type_t type, u32 node_index)
Definition: icmp4.c:731
vlib_node_registration_t ip4_arp_node
(constructor) VLIB_REGISTER_NODE (ip4_arp_node)
Definition: ip4_forward.c:2227
clib_error_t * ip4_add_del_interface_address(vlib_main_t *vm, u32 sw_if_index, ip4_address_t *address, u32 address_length, u32 is_del)
Definition: ip4_forward.c:975
clib_error_t * ip4_probe_neighbor(vlib_main_t *vm, ip4_address_t *dst, u32 sw_if_index)
Definition: ip4_forward.c:2273
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:397
void ip4_sw_interface_enable_disable(u32 sw_if_index, u32 is_enable)
Definition: ip4_forward.c:860
uword * fib_index_by_table_id
Hash table mapping table id to fib index.
Definition: ip4.h:109
vlib_node_registration_t ip4_input_node
Global ip4 input node.
Definition: ip4_input.c:416
u8 * ip_enabled_by_sw_if_index
Definition: ip4.h:105
Definition: ip4.h:47
static void * vlib_buffer_push_ip4(vlib_main_t *vm, vlib_buffer_t *b, ip4_address_t *src, ip4_address_t *dst, int proto)
Push IPv4 header to buffer.
Definition: ip4.h:330
u32 ip4_tcp_udp_validate_checksum(vlib_main_t *vm, vlib_buffer_t *p0)
Definition: ip4_forward.c:1500
The IPv4 FIB.
Definition: ip4_fib.h:39
svmdb_client_t * c
vlib_node_registration_t ip4_rewrite_node
(constructor) VLIB_REGISTER_NODE (ip4_rewrite_node)
Definition: ip4_forward.c:2801
int ip4_address_compare(ip4_address_t *a1, ip4_address_t *a2)
Definition: ip46_cli.c:51
clib_error_t * ip4_set_arp_limit(u32 arp_limit)
Definition: arp.c:1424
serialize_function_t unserialize_vnet_ip4_main
Definition: ip4.h:261
icmp4_type_t
u32 * if_address_pool_index_by_sw_if_index
Head of doubly linked list of interface addresses for each software interface.
Definition: lookup.h:129
vlib_packet_template_t ip4_arp_request_packet_template
Template used to generate IP4 ARP packets.
Definition: ip4.h:120
uword * fib_entry_by_dst_address[65]
Definition: ip4.h:50
#define IP_FLOW_HASH_SRC_ADDR
Flow hash configuration.
Definition: lookup.h:61
unsigned int u32
Definition: types.h:88
u16 ip4_tcp_udp_compute_checksum(vlib_main_t *vm, vlib_buffer_t *p0, ip4_header_t *ip0)
Definition: ip4_forward.c:1445
#define hash_v3_finalize32(a, b, c)
Definition: hash.h:540
IPv4 main type.
Definition: ip4.h:83
u32 flow_hash_config_t
A flow hash configuration is a mask of the flow hash options.
Definition: lookup.h:82
u64 uword
Definition: types.h:112
static void * vlib_buffer_push_uninit(vlib_buffer_t *b, u8 size)
Prepend uninitialized data to buffer.
Definition: buffer.h:285
unsigned short u16
Definition: types.h:57
struct ip4_main_t ip4_main_t
IPv4 main type.
struct ip4_fib_t_ * v4_fibs
Vector of MTries.
Definition: ip4.h:91
void( serialize_function_t)(serialize_main_t *m, va_list *va)
Definition: serialize.h:168
unsigned char u8
Definition: types.h:56
void ip4_forward_next_trace(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame, vlib_rx_or_tx_t which_adj_index)
Definition: ip4_forward.c:1295
vlib_node_registration_t ip4_rewrite_local_node
u8 * format_ip4_forward_next_trace(u8 *s, va_list *args)
Definition: ip4_forward.c:1247
#define clib_mem_unaligned(pointer, type)
Definition: types.h:155
vlib_node_registration_t ip4_glean_node
(constructor) VLIB_REGISTER_NODE (ip4_glean_node)
Definition: ip4_forward.c:2237
static uword ip4_destination_matches_interface(ip4_main_t *im, ip4_address_t *key, ip_interface_address_t *ia)
Definition: ip4.h:161
A protocol Independent IP multicast FIB table.
Definition: mfib_table.h:29
ip4_main_t ip4_main
Global ip4 main structure.
Definition: ip4_forward.c:1168
struct fib_table_t_ * fibs
Vector of FIBs.
Definition: ip4.h:88
#define IP_FLOW_HASH_PROTO
Definition: lookup.h:63
struct ip4_mfib_t ip4_mfib_t
u32 table_id
Definition: ip4.h:53
u32 flow_hash_seed
Seed for Jenkins hash used to compute ip4 flow hash.
Definition: ip4.h:123
uword * mfib_index_by_table_id
Hash table mapping table id to multicast fib index.
Definition: ip4.h:113
u8 ip_version_and_header_length
Definition: ip4_packet.h:132
static void * ip_interface_address_get_address(ip_lookup_main_t *lm, ip_interface_address_t *a)
Definition: lookup.h:172
vlib_node_registration_t ip4_local_node
(constructor) VLIB_REGISTER_NODE (ip4_local_node)
Definition: ip4_forward.c:1914
static int ip4_src_address_for_packet(ip_lookup_main_t *lm, u32 sw_if_index, ip4_address_t *src)
Definition: ip4.h:182
u8 ttl
TTL to use for host generated packets.
Definition: ip4.h:129
static u16 ip4_header_checksum(ip4_header_t *i)
Definition: ip4_packet.h:239
u8 tos
TOS byte to use for host generated packets.
Definition: ip4.h:132
A protocol Independent FIB table.
Definition: fib_table.h:29
u32 fib_masks[33]
Definition: ip4.h:96
static ip4_address_t * ip4_interface_address_matching_destination(ip4_main_t *im, ip4_address_t *dst, u32 sw_if_index, ip_interface_address_t **result_ia)
Definition: ip4.h:203