FD.io VPP  v18.07-rc0-415-g6c78436
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 
49 typedef struct ip4_mfib_t
50 {
51  /* Hash table for each prefix length mapping. */
53 
54  /* Table ID (hash key) for this FIB. */
56 
57  /* Index into FIB vector. */
59 } ip4_mfib_t;
60 
61 struct ip4_main_t;
62 
64  (struct ip4_main_t * im,
65  uword opaque,
66  u32 sw_if_index,
68  u32 address_length, u32 if_address_index, u32 is_del);
69 
70 typedef struct
71 {
75 
76 typedef void (ip4_table_bind_function_t)
77  (struct ip4_main_t * im,
78  uword opaque, u32 sw_if_index, u32 new_fib_index, u32 old_fib_index);
79 
80 typedef struct
81 {
85 
86 /**
87  * @brief IPv4 main type.
88  *
89  * State of IPv4 VPP processing including:
90  * - FIBs
91  * - Feature indices used in feature topological sort
92  * - Feature node run time references
93  */
94 
95 typedef struct ip4_main_t
96 {
98 
99  /** Vector of FIBs. */
101 
102  /** Vector of MTries. */
104 
105  /** Vector of MFIBs. */
107 
108  u32 fib_masks[33];
109 
110  /** Table index indexed by software interface. */
112 
113  /** Table index indexed by software interface. */
115 
116  /* IP4 enabled count by software interface */
118 
119  /** Hash table mapping table id to fib index.
120  ID space is not necessarily dense; index space is dense. */
122 
123  /** Hash table mapping table id to multicast fib index.
124  ID space is not necessarily dense; index space is dense. */
126 
127  /** Functions to call when interface address changes. */
130 
131  /** Functions to call when interface to table biding changes. */
133 
134  /** Template used to generate IP4 ARP packets. */
136 
137  /** Seed for Jenkins hash used to compute ip4 flow hash. */
139 
140  /** @brief Template information for VPP generated packets */
141  struct
142  {
143  /** TTL to use for host generated packets. */
145 
146  /** TOS byte to use for host generated packets. */
148 
149  u8 pad[2];
150  } host_config;
151 
152  /** Heapsize for the Mtries */
154 
155  /** The memory heap for the mtries */
156  void *mtrie_mheap;
157 } ip4_main_t;
158 
159 /** Global ip4 main structure. */
160 extern ip4_main_t ip4_main;
161 
162 /** Global ip4 input node. Errors get attached to ip4 input node. */
172 
175  const ip4_address_t * key,
176  const ip4_address_t * dest, uword dest_length)
177 {
178  return 0 == ((key->data_u32 ^ dest->data_u32) & im->fib_masks[dest_length]);
179 }
180 
183  ip4_address_t * key,
185 {
187  return ip4_destination_matches_route (im, key, a, ia->address_length);
188 }
189 
190 always_inline int
192  u32 sw_if_index, ip4_address_t * src)
193 {
194  u32 if_add_index = lm->if_address_pool_index_by_sw_if_index[sw_if_index];
195  if (PREDICT_TRUE (if_add_index != ~0))
196  {
197  ip_interface_address_t *if_add =
198  pool_elt_at_index (lm->if_address_pool, if_add_index);
199  ip4_address_t *if_ip = ip_interface_address_get_address (lm, if_add);
200  *src = *if_ip;
201  return 0;
202  }
203  else
204  {
205  src->as_u32 = 0;
206  }
207  return (!0);
208 }
209 
210 /* Find interface address which matches destination. */
213  ip4_address_t * dst,
214  u32 sw_if_index,
216  result_ia)
217 {
218  ip_lookup_main_t *lm = &im->lookup_main;
220  ip4_address_t *result = 0;
221 
222  /* *INDENT-OFF* */
223  foreach_ip_interface_address (lm, ia, sw_if_index,
224  1 /* honor unnumbered */,
225  ({
227  if (ip4_destination_matches_route (im, dst, a, ia->address_length))
228  {
229  result = a;
230  break;
231  }
232  }));
233  /* *INDENT-ON* */
234  if (result_ia)
235  *result_ia = result ? ia : 0;
236  return result;
237 }
238 
241  result_ia);
242 
244  u32 sw_if_index,
245  ip4_address_t * address,
246  u32 address_length, u32 is_del);
247 
248 void ip4_sw_interface_enable_disable (u32 sw_if_index, u32 is_enable);
249 
251 
252 /* Send an ARP request to see if given destination is reachable on given interface. */
254  u32 sw_if_index, u8 refresh);
255 
256 clib_error_t *ip4_set_arp_limit (u32 arp_limit);
257 
258 uword
260  u16 dst_port, u32 next_node_index);
261 
262 void
263 ip4_icmp_register_type (vlib_main_t * vm, icmp4_type_t type, u32 node_index);
264 
266  ip4_header_t * ip0);
267 
268 void ip4_register_protocol (u32 protocol, u32 node_index);
269 
271 
273  flow_hash_config_t flow_hash_config);
274 
275 int vnet_set_ip4_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
276  u32 table_index);
277 
278 void ip4_punt_policer_add_del (u8 is_add, u32 policer_index);
279 
280 void ip4_punt_redirect_add (u32 rx_sw_if_index,
281  u32 tx_sw_if_index, ip46_address_t * nh);
282 void ip4_punt_redirect_del (u32 rx_sw_if_index);
283 
284 /* Compute flow hash. We'll use it to select which adjacency to use for this
285  flow. And other things. */
288  flow_hash_config_t flow_hash_config)
289 {
290  tcp_header_t *tcp = (void *) (ip + 1);
291  u32 a, b, c, t1, t2;
292  uword is_tcp_udp = (ip->protocol == IP_PROTOCOL_TCP
293  || ip->protocol == IP_PROTOCOL_UDP);
294 
295  t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR)
296  ? ip->src_address.data_u32 : 0;
297  t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR)
298  ? ip->dst_address.data_u32 : 0;
299 
300  a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
301  b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
302  b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? ip->protocol : 0;
303 
304  t1 = is_tcp_udp ? tcp->src : 0;
305  t2 = is_tcp_udp ? tcp->dst : 0;
306 
307  t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
308  t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
309 
310  c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
311  (t1 << 16) | t2 : (t2 << 16) | t1;
312 
313  hash_v3_mix32 (a, b, c);
314  hash_v3_finalize32 (a, b, c);
315 
316  return c;
317 }
318 
319 void
321  vlib_node_runtime_t * node,
322  vlib_frame_t * frame,
323  vlib_rx_or_tx_t which_adj_index);
324 
325 u8 *format_ip4_forward_next_trace (u8 * s, va_list * args);
326 
328 
329 #define IP_DF 0x4000 /* don't fragment */
330 
331 /**
332  * Push IPv4 header to buffer
333  *
334  * This does not support fragmentation.
335  *
336  * @param vm - vlib_main
337  * @param b - buffer to write the header to
338  * @param src - source IP
339  * @param dst - destination IP
340  * @param prot - payload proto
341  *
342  * @return - pointer to start of IP header
343  */
344 always_inline void *
346  ip4_address_t * src, ip4_address_t * dst, int proto,
347  u8 csum_offload)
348 {
349  ip4_header_t *ih;
350 
351  /* make some room */
352  ih = vlib_buffer_push_uninit (b, sizeof (ip4_header_t));
353 
354  ih->ip_version_and_header_length = 0x45;
355  ih->tos = 0;
356  ih->length = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b));
357 
358  /* No fragments */
359  ih->flags_and_fragment_offset = clib_host_to_net_u16 (IP_DF);
360  ih->ttl = 255;
361  ih->protocol = proto;
362  ih->src_address.as_u32 = src->as_u32;
363  ih->dst_address.as_u32 = dst->as_u32;
364 
365  /* Offload ip4 header checksum generation */
366  if (csum_offload)
367  {
368  ih->checksum = 0;
369  b->flags |= VNET_BUFFER_F_OFFLOAD_IP_CKSUM | VNET_BUFFER_F_IS_IP4;
370  vnet_buffer (b)->l3_hdr_offset = (u8 *) ih - b->data;
371  vnet_buffer (b)->l4_hdr_offset = vnet_buffer (b)->l3_hdr_offset +
372  sizeof (*ih);
373  }
374  else
375  ih->checksum = ip4_header_checksum (ih);
376 
377  return ih;
378 }
379 #endif /* included_ip_ip4_h */
380 
381 /*
382  * fd.io coding-style-patch-verification: ON
383  *
384  * Local Variables:
385  * eval: (c-set-style "gnu")
386  * End:
387  */
#define foreach_ip_interface_address(lm, a, sw_if_index, loop, body)
Definition: lookup.h:179
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:34
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:2699
ip4_add_del_interface_address_callback_t * add_del_interface_address_callbacks
Functions to call when interface address changes.
Definition: ip4.h:129
a
Definition: bitmap.h:537
#define IP_FLOW_HASH_SRC_PORT
Definition: lookup.h:64
ip4_address_t src_address
Definition: ip4_packet.h:169
u32 index
Definition: ip4.h:58
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:270
#define PREDICT_TRUE(x)
Definition: clib.h:106
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:287
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:320
#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:2591
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:64
#define IP_FLOW_HASH_DST_PORT
Definition: lookup.h:65
ip_lookup_main_t lookup_main
Definition: ip4.h:97
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:174
u32 * fib_index_by_sw_if_index
Table index indexed by software interface.
Definition: ip4.h:111
u16 flags_and_fragment_offset
Definition: ip4_packet.h:150
#define IP_DF
Definition: ip4.h:329
void ip4_register_protocol(u32 protocol, u32 node_index)
Definition: ip4_forward.c:1584
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:250
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:2571
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:114
#define IP_FLOW_HASH_DST_ADDR
Definition: lookup.h:62
#define always_inline
Definition: clib.h:92
ip4_address_t dst_address
Definition: ip4_packet.h:169
unsigned int u32
Definition: types.h:88
struct mfib_table_t_ * mfibs
Vector of MFIBs.
Definition: ip4.h:106
int vnet_set_ip4_classify_intfc(vlib_main_t *vm, u32 sw_if_index, u32 table_index)
Definition: ip4_forward.c:2851
void ip4_icmp_register_type(vlib_main_t *vm, icmp4_type_t type, u32 node_index)
Definition: icmp4.c:733
vlib_node_registration_t ip4_arp_node
(constructor) VLIB_REGISTER_NODE (ip4_arp_node)
Definition: ip4_forward.c:1865
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:631
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:461
void ip4_sw_interface_enable_disable(u32 sw_if_index, u32 is_enable)
Definition: ip4_forward.c:496
uword * fib_index_by_table_id
Hash table mapping table id to fib index.
Definition: ip4.h:121
vlib_node_registration_t ip4_input_node
Global ip4 input node.
Definition: ip4_input.c:316
uword mtrie_heap_size
Heapsize for the Mtries.
Definition: ip4.h:153
unsigned short u16
Definition: types.h:57
u8 * ip_enabled_by_sw_if_index
Definition: ip4.h:117
Definition: ip4.h:49
u32 ip4_tcp_udp_validate_checksum(vlib_main_t *vm, vlib_buffer_t *p0)
Definition: ip4_forward.c:1113
void * mtrie_mheap
The memory heap for the mtries.
Definition: ip4.h:156
clib_error_t * ip4_probe_neighbor(vlib_main_t *vm, ip4_address_t *dst, u32 sw_if_index, u8 refresh)
Definition: ip4_forward.c:1921
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:2555
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:1519
serialize_function_t unserialize_vnet_ip4_main
Definition: ip4.h:270
icmp4_type_t
void ip4_punt_policer_add_del(u8 is_add, u32 policer_index)
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:135
uword * fib_entry_by_dst_address[65]
Definition: ip4.h:52
#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:1055
#define hash_v3_finalize32(a, b, c)
Definition: hash.h:564
IPv4 main type.
Definition: ip4.h:95
u32 flow_hash_config_t
A flow hash configuration is a mask of the flow hash options.
Definition: lookup.h:82
ip4_table_bind_callback_t * table_bind_callbacks
Functions to call when interface to table biding changes.
Definition: ip4.h:132
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:299
struct ip4_main_t ip4_main_t
IPv4 main type.
struct ip4_fib_t_ * v4_fibs
Vector of MTries.
Definition: ip4.h:103
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:967
vlib_node_registration_t ip4_rewrite_local_node
u64 uword
Definition: types.h:112
u8 * format_ip4_forward_next_trace(u8 *s, va_list *args)
Definition: ip4_forward.c:919
vlib_node_registration_t ip4_glean_node
(constructor) VLIB_REGISTER_NODE (ip4_glean_node)
Definition: ip4_forward.c:1880
static uword ip4_destination_matches_interface(ip4_main_t *im, ip4_address_t *key, ip_interface_address_t *ia)
Definition: ip4.h:182
#define vnet_buffer(b)
Definition: buffer.h:360
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:832
struct fib_table_t_ * fibs
Vector of FIBs.
Definition: ip4.h:100
u8 data[0]
Packet data.
Definition: buffer.h:172
#define IP_FLOW_HASH_PROTO
Definition: lookup.h:63
struct ip4_mfib_t ip4_mfib_t
u32 table_id
Definition: ip4.h:55
u32 flow_hash_seed
Seed for Jenkins hash used to compute ip4 flow hash.
Definition: ip4.h:138
uword * mfib_index_by_table_id
Hash table mapping table id to multicast fib index.
Definition: ip4.h:125
u8 ip_version_and_header_length
Definition: ip4_packet.h:137
static void * ip_interface_address_get_address(ip_lookup_main_t *lm, ip_interface_address_t *a)
Definition: lookup.h:172
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:111
vlib_node_registration_t ip4_local_node
(constructor) VLIB_REGISTER_NODE (ip4_local_node)
Definition: ip4_forward.c:1538
static int ip4_src_address_for_packet(ip_lookup_main_t *lm, u32 sw_if_index, ip4_address_t *src)
Definition: ip4.h:191
u8 ttl
TTL to use for host generated packets.
Definition: ip4.h:144
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:345
static u16 ip4_header_checksum(ip4_header_t *i)
Definition: ip4_packet.h:244
u8 tos
TOS byte to use for host generated packets.
Definition: ip4.h:147
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:77
A protocol Independent FIB table.
Definition: fib_table.h:69
u32 fib_masks[33]
Definition: ip4.h:108
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:212