FD.io VPP  v19.04.1-1-ge4a0f9f
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/buffer.h>
46 #include <vnet/feature/feature.h>
47 #include <vnet/ip/icmp46_packet.h>
48 #include <vnet/util/throttle.h>
49 
50 typedef struct ip4_mfib_t
51 {
52  /* Hash table for each prefix length mapping. */
54 
55  /* Table ID (hash key) for this FIB. */
57 
58  /* Index into FIB vector. */
60 } ip4_mfib_t;
61 
62 struct ip4_main_t;
63 
65  (struct ip4_main_t * im,
66  uword opaque,
69  u32 address_length, u32 if_address_index, u32 is_del);
70 
71 typedef struct
72 {
76 
77 typedef void (ip4_table_bind_function_t)
78  (struct ip4_main_t * im,
79  uword opaque, u32 sw_if_index, u32 new_fib_index, u32 old_fib_index);
80 
81 typedef struct
82 {
86 
87 /**
88  * @brief IPv4 main type.
89  *
90  * State of IPv4 VPP processing including:
91  * - FIBs
92  * - Feature indices used in feature topological sort
93  * - Feature node run time references
94  */
95 
96 typedef struct ip4_main_t
97 {
99 
100  /** Vector of FIBs. */
102 
103  /** Vector of MTries. */
105 
106  /** Vector of MFIBs. */
108 
109  u32 fib_masks[33];
110 
111  /** Table index indexed by software interface. */
113 
114  /** Table index indexed by software interface. */
116 
117  /* IP4 enabled count by software interface */
119 
120  /** Hash table mapping table id to fib index.
121  ID space is not necessarily dense; index space is dense. */
123 
124  /** Hash table mapping table id to multicast fib index.
125  ID space is not necessarily dense; index space is dense. */
127 
128  /** Functions to call when interface address changes. */
131 
132  /** Functions to call when interface to table biding changes. */
134 
135  /** Template used to generate IP4 ARP packets. */
137 
138  /** Seed for Jenkins hash used to compute ip4 flow hash. */
140 
141  /** @brief Template information for VPP generated packets */
142  struct
143  {
144  /** TTL to use for host generated packets. */
146 
147  /** TOS byte to use for host generated packets. */
149 
150  u8 pad[2];
151  } host_config;
152 
153  /** Heapsize for the Mtries */
155 
156  /** The memory heap for the mtries */
157  void *mtrie_mheap;
158 
159  /** ARP throttling */
161 
162 } ip4_main_t;
163 
164 #define ARP_THROTTLE_BITS (512)
165 
166 /** Global ip4 main structure. */
167 extern ip4_main_t ip4_main;
168 
169 /** Global ip4 input node. Errors get attached to ip4 input node. */
179 
182  const ip4_address_t * key,
183  const ip4_address_t * dest, uword dest_length)
184 {
185  return 0 == ((key->data_u32 ^ dest->data_u32) & im->fib_masks[dest_length]);
186 }
187 
190  ip4_address_t * key,
192 {
194  return ip4_destination_matches_route (im, key, a, ia->address_length);
195 }
196 
197 always_inline int
200 {
202  if (PREDICT_TRUE (if_add_index != ~0))
203  {
204  ip_interface_address_t *if_add =
205  pool_elt_at_index (lm->if_address_pool, if_add_index);
206  ip4_address_t *if_ip = ip_interface_address_get_address (lm, if_add);
207  *src = *if_ip;
208  return 0;
209  }
210  else
211  {
212  src->as_u32 = 0;
213  }
214  return (!0);
215 }
216 
217 /* Find interface address which matches destination. */
220  ip4_address_t * dst,
223  result_ia)
224 {
225  ip_lookup_main_t *lm = &im->lookup_main;
227  ip4_address_t *result = 0;
228 
229  /* *INDENT-OFF* */
230  foreach_ip_interface_address (lm, ia, sw_if_index,
231  1 /* honor unnumbered */,
232  ({
234  if (ip4_destination_matches_route (im, dst, a, ia->address_length))
235  {
236  result = a;
237  break;
238  }
239  }));
240  /* *INDENT-ON* */
241  if (result_ia)
242  *result_ia = result ? ia : 0;
243  return result;
244 }
245 
248  result_ia);
249 
252  ip4_address_t * address,
253  u32 address_length, u32 is_del);
254 
256 
258 
260 
261 /* Send an ARP request to see if given destination is reachable on given interface. */
263  u32 sw_if_index, u8 refresh);
264 
265 clib_error_t *ip4_set_arp_limit (u32 arp_limit);
266 
267 uword
269  u16 dst_port, u32 next_node_index);
270 
271 void
272 ip4_icmp_register_type (vlib_main_t * vm, icmp4_type_t type, u32 node_index);
273 
275  ip4_header_t * ip0);
276 
277 void ip4_register_protocol (u32 protocol, u32 node_index);
278 
280 
282  flow_hash_config_t flow_hash_config);
283 
285  u32 table_index);
286 
287 void ip4_punt_policer_add_del (u8 is_add, u32 policer_index);
288 
289 void ip4_punt_redirect_add (u32 rx_sw_if_index,
290  u32 tx_sw_if_index, ip46_address_t * nh);
291 void ip4_punt_redirect_del (u32 rx_sw_if_index);
292 
293 /* Compute flow hash. We'll use it to select which adjacency to use for this
294  flow. And other things. */
297  flow_hash_config_t flow_hash_config)
298 {
299  tcp_header_t *tcp = (void *) (ip + 1);
300  u32 a, b, c, t1, t2;
301  uword is_tcp_udp = (ip->protocol == IP_PROTOCOL_TCP
302  || ip->protocol == IP_PROTOCOL_UDP);
303 
304  t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR)
305  ? ip->src_address.data_u32 : 0;
306  t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR)
307  ? ip->dst_address.data_u32 : 0;
308 
309  a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
310  b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
311 
312  t1 = is_tcp_udp ? tcp->src : 0;
313  t2 = is_tcp_udp ? tcp->dst : 0;
314 
315  t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
316  t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
317 
318  if (flow_hash_config & IP_FLOW_HASH_SYMMETRIC)
319  {
320  if (b < a)
321  {
322  c = a;
323  a = b;
324  b = c;
325  }
326  if (t2 < t1)
327  {
328  t2 += t1;
329  t1 = t2 - t1;
330  t2 = t2 - t1;
331  }
332  }
333 
334  b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? ip->protocol : 0;
335  c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
336  (t1 << 16) | t2 : (t2 << 16) | t1;
337 
338  hash_v3_mix32 (a, b, c);
339  hash_v3_finalize32 (a, b, c);
340 
341  return c;
342 }
343 
344 void
346  vlib_node_runtime_t * node,
347  vlib_frame_t * frame,
348  vlib_rx_or_tx_t which_adj_index);
349 
350 u8 *format_ip4_forward_next_trace (u8 * s, va_list * args);
351 
353 
354 #define IP_DF 0x4000 /* don't fragment */
355 
356 /**
357  * Push IPv4 header to buffer
358  *
359  * This does not support fragmentation.
360  *
361  * @param vm - vlib_main
362  * @param b - buffer to write the header to
363  * @param src - source IP
364  * @param dst - destination IP
365  * @param prot - payload proto
366  *
367  * @return - pointer to start of IP header
368  */
369 always_inline void *
371  ip4_address_t * src, ip4_address_t * dst, int proto,
372  u8 csum_offload)
373 {
374  ip4_header_t *ih;
375 
376  /* make some room */
377  ih = vlib_buffer_push_uninit (b, sizeof (ip4_header_t));
378 
379  ih->ip_version_and_header_length = 0x45;
380  ih->tos = 0;
381  ih->length = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b));
382 
383  /* No fragments */
384  ih->flags_and_fragment_offset = clib_host_to_net_u16 (IP_DF);
385  ih->ttl = 255;
386  ih->protocol = proto;
387  ih->src_address.as_u32 = src->as_u32;
388  ih->dst_address.as_u32 = dst->as_u32;
389 
390  /* Offload ip4 header checksum generation */
391  if (csum_offload)
392  {
393  ih->checksum = 0;
394  b->flags |= VNET_BUFFER_F_OFFLOAD_IP_CKSUM | VNET_BUFFER_F_IS_IP4;
395  vnet_buffer (b)->l3_hdr_offset = (u8 *) ih - b->data;
396  vnet_buffer (b)->l4_hdr_offset = vnet_buffer (b)->l3_hdr_offset +
397  sizeof (*ih);
398  }
399  else
400  ih->checksum = ip4_header_checksum (ih);
401 
402  return ih;
403 }
404 #endif /* included_ip_ip4_h */
405 
406 /*
407  * fd.io coding-style-patch-verification: ON
408  *
409  * Local Variables:
410  * eval: (c-set-style "gnu")
411  * End:
412  */
#define foreach_ip_interface_address(lm, a, sw_if_index, loop, body)
Definition: lookup.h:182
u32 sw_if_index
Definition: ipsec_gre.api:37
u32 flags
buffer flags: VLIB_BUFFER_FREE_LIST_INDEX_MASK: bits used to store free list index, VLIB_BUFFER_IS_TRACED: trace this buffer.
Definition: buffer.h:124
void ip4_punt_redirect_add(u32 rx_sw_if_index, u32 tx_sw_if_index, ip46_address_t *nh)
typedef address
Definition: ip_types.api:30
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:2746
ip4_add_del_interface_address_callback_t * add_del_interface_address_callbacks
Functions to call when interface address changes.
Definition: ip4.h:130
a
Definition: bitmap.h:538
#define IP_FLOW_HASH_SRC_PORT
Definition: lookup.h:64
ip4_address_t src_address
Definition: ip4_packet.h:170
u32 index
Definition: ip4.h:59
ip_interface_address_t * if_address_pool
Pool of addresses that are assigned to interfaces.
Definition: lookup.h:125
serialize_function_t serialize_vnet_ip4_main
Definition: ip4.h:279
#define PREDICT_TRUE(x)
Definition: clib.h:112
void ip4_punt_redirect_del(u32 rx_sw_if_index)
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:296
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:314
#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:2639
u8 data[0]
Packet data.
Definition: buffer.h:181
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:65
#define IP_FLOW_HASH_DST_PORT
Definition: lookup.h:65
ip_lookup_main_t lookup_main
Definition: ip4.h:98
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:181
u32 * fib_index_by_sw_if_index
Table index indexed by software interface.
Definition: ip4.h:112
u16 flags_and_fragment_offset
Definition: ip4_packet.h:151
#define IP_DF
Definition: ip4.h:354
void ip4_register_protocol(u32 protocol, u32 node_index)
Definition: ip4_forward.c:1699
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:366
struct _tcp_header tcp_header_t
#define hash_v3_mix32(a, b, c)
Definition: hash.h:554
unsigned char u8
Definition: types.h:56
vlib_node_registration_t ip4_lookup_node
(constructor) VLIB_REGISTER_NODE (ip4_lookup_node)
Definition: ip4_forward.c:104
vlib_node_registration_t ip4_rewrite_mcast_node
(constructor) VLIB_REGISTER_NODE (ip4_rewrite_mcast_node)
Definition: ip4_forward.c:2623
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:115
#define IP_FLOW_HASH_DST_ADDR
Definition: lookup.h:62
#define always_inline
Definition: clib.h:98
ip4_address_t dst_address
Definition: ip4_packet.h:170
unsigned int u32
Definition: types.h:88
struct mfib_table_t_ * mfibs
Vector of MFIBs.
Definition: ip4.h:107
int vnet_set_ip4_classify_intfc(vlib_main_t *vm, u32 sw_if_index, u32 table_index)
Definition: ip4_forward.c:2900
void ip4_directed_broadcast(u32 sw_if_index, u8 enable)
Definition: ip4_forward.c:670
void ip4_icmp_register_type(vlib_main_t *vm, icmp4_type_t type, u32 node_index)
Definition: icmp4.c:742
vlib_node_registration_t ip4_arp_node
(constructor) VLIB_REGISTER_NODE (ip4_arp_node)
Definition: ip4_forward.c:1936
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:660
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:514
void ip4_sw_interface_enable_disable(u32 sw_if_index, u32 is_enable)
Definition: ip4_forward.c:525
uword * fib_index_by_table_id
Hash table mapping table id to fib index.
Definition: ip4.h:122
vlib_node_registration_t ip4_input_node
Global ip4 input node.
Definition: ip4_input.c:317
u8 address_length
Definition: ip_types.api:37
uword mtrie_heap_size
Heapsize for the Mtries.
Definition: ip4.h:154
unsigned short u16
Definition: types.h:57
u8 * ip_enabled_by_sw_if_index
Definition: ip4.h:118
Definition: ip4.h:50
u32 ip4_tcp_udp_validate_checksum(vlib_main_t *vm, vlib_buffer_t *p0)
Definition: ip4_forward.c:1186
vl_api_ip4_address_t src
Definition: ipsec_gre.api:38
void * mtrie_mheap
The memory heap for the mtries.
Definition: ip4.h:157
A throttle Used in the data plane to decide if a given hash should be throttled, i.e.
Definition: throttle.h:28
clib_error_t * ip4_probe_neighbor(vlib_main_t *vm, ip4_address_t *dst, u32 sw_if_index, u8 refresh)
Definition: ip4_forward.c:1993
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:2601
int ip4_address_compare(ip4_address_t *a1, ip4_address_t *a2)
Definition: ip46_cli.c:53
clib_error_t * ip4_set_arp_limit(u32 arp_limit)
Definition: arp.c:1541
serialize_function_t unserialize_vnet_ip4_main
Definition: ip4.h:279
icmp4_type_t
void ip4_punt_policer_add_del(u8 is_add, u32 policer_index)
#define IP_FLOW_HASH_SYMMETRIC
Definition: lookup.h:67
u32 * if_address_pool_index_by_sw_if_index
Head of doubly linked list of interface addresses for each software interface.
Definition: lookup.h:132
vlib_packet_template_t ip4_arp_request_packet_template
Template used to generate IP4 ARP packets.
Definition: ip4.h:136
uword * fib_entry_by_dst_address[65]
Definition: ip4.h:53
#define IP_FLOW_HASH_SRC_ADDR
Flow hash configuration.
Definition: lookup.h:61
u16 ip4_tcp_udp_compute_checksum(vlib_main_t *vm, vlib_buffer_t *p0, ip4_header_t *ip0)
Definition: ip4_forward.c:1128
u8 is_add
Definition: ipsec_gre.api:36
#define hash_v3_finalize32(a, b, c)
Definition: hash.h:564
IPv4 main type.
Definition: ip4.h:96
throttle_t arp_throttle
ARP throttling.
Definition: ip4.h:160
u32 flow_hash_config_t
A flow hash configuration is a mask of the flow hash options.
Definition: lookup.h:84
ip4_table_bind_callback_t * table_bind_callbacks
Functions to call when interface to table biding changes.
Definition: ip4.h:133
struct _vlib_node_registration vlib_node_registration_t
static void * vlib_buffer_push_uninit(vlib_buffer_t *b, u8 size)
Prepend uninitialized data to buffer.
Definition: buffer.h:335
struct ip4_main_t ip4_main_t
IPv4 main type.
struct ip4_fib_t_ * v4_fibs
Vector of MTries.
Definition: ip4.h:104
void( serialize_function_t)(serialize_main_t *m, va_list *va)
Definition: serialize.h:168
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:1040
vlib_node_registration_t ip4_rewrite_local_node
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
typedef key
Definition: ipsec.api:244
u8 * format_ip4_forward_next_trace(u8 *s, va_list *args)
Definition: ip4_forward.c:990
vlib_node_registration_t ip4_glean_node
(constructor) VLIB_REGISTER_NODE (ip4_glean_node)
Definition: ip4_forward.c:1950
static uword ip4_destination_matches_interface(ip4_main_t *im, ip4_address_t *key, ip_interface_address_t *ia)
Definition: ip4.h:189
#define vnet_buffer(b)
Definition: buffer.h:369
A protocol Independent IP multicast FIB table.
Definition: mfib_table.h:35
ip4_main_t ip4_main
Global ip4 main structure.
Definition: ip4_forward.c:905
struct fib_table_t_ * fibs
Vector of FIBs.
Definition: ip4.h:101
#define IP_FLOW_HASH_PROTO
Definition: lookup.h:63
struct ip4_mfib_t ip4_mfib_t
u32 table_id
Definition: ip4.h:56
u32 flow_hash_seed
Seed for Jenkins hash used to compute ip4 flow hash.
Definition: ip4.h:139
u16 dst_port
Definition: udp.api:42
uword * mfib_index_by_table_id
Hash table mapping table id to multicast fib index.
Definition: ip4.h:126
u8 ip_version_and_header_length
Definition: ip4_packet.h:138
static void * ip_interface_address_get_address(ip_lookup_main_t *lm, ip_interface_address_t *a)
Definition: lookup.h:175
vlib_node_registration_t ip4_local_node
(constructor) VLIB_REGISTER_NODE (ip4_local_node)
Definition: ip4_forward.c:1656
static int ip4_src_address_for_packet(ip_lookup_main_t *lm, u32 sw_if_index, ip4_address_t *src)
Definition: ip4.h:198
u8 ttl
TTL to use for host generated packets.
Definition: ip4.h:145
static void * vlib_buffer_push_ip4(vlib_main_t *vm, vlib_buffer_t *b, ip4_address_t *src, ip4_address_t *dst, int proto, u8 csum_offload)
Push IPv4 header to buffer.
Definition: ip4.h:370
static u16 ip4_header_checksum(ip4_header_t *i)
Definition: ip4_packet.h:247
u8 tos
TOS byte to use for host generated packets.
Definition: ip4.h:148
void( ip4_table_bind_function_t)(struct ip4_main_t *im, uword opaque, u32 sw_if_index, u32 new_fib_index, u32 old_fib_index)
Definition: ip4.h:78
u8 protocol
Definition: ipsec.api:96
A protocol Independent FIB table.
Definition: fib_table.h:69
u32 fib_masks[33]
Definition: ip4.h:109
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:219