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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * ip/ip4.h: ip4 main include file
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
40 #ifndef included_ip_ip4_h
41 #define included_ip_ip4_h
43 #include <vnet/ip/ip4_packet.h>
44 #include <vnet/ip/lookup.h>
45 #include <vnet/ip/ip_interface.h>
46 #include <vnet/buffer.h>
47 #include <vnet/feature/feature.h>
48 #include <vnet/ip/icmp46_packet.h>
49 #include <vnet/util/throttle.h>
51 typedef struct ip4_mfib_t
53 /* Hash table for each prefix length mapping. */
54 uword *fib_entry_by_dst_address[65];
56 /* Table ID (hash key) for this FIB. */
59 /* Index into FIB vector. */
65 typedef void (ip4_add_del_interface_address_function_t)
66 (struct ip4_main_t * im,
69 ip4_address_t * address,
70 u32 address_length, u32 if_address_index, u32 is_del);
74 ip4_add_del_interface_address_function_t *function;
75 uword function_opaque;
76 } ip4_add_del_interface_address_callback_t;
78 typedef void (ip4_enable_disable_interface_function_t)
79 (struct ip4_main_t * im, uword opaque, u32 sw_if_index, u32 is_enable);
83 ip4_enable_disable_interface_function_t *function;
84 uword function_opaque;
85 } ip4_enable_disable_interface_callback_t;
87 typedef void (ip4_table_bind_function_t)
88 (struct ip4_main_t * im,
89 uword opaque, u32 sw_if_index, u32 new_fib_index, u32 old_fib_index);
93 ip4_table_bind_function_t *function;
94 uword function_opaque;
95 } ip4_table_bind_callback_t;
98 * @brief IPv4 main type.
100 * State of IPv4 VPP processing including:
102 * - Feature indices used in feature topological sort
103 * - Feature node run time references
106 typedef struct ip4_main_t
108 ip_lookup_main_t lookup_main;
110 /** Vector of FIBs. */
111 struct fib_table_t_ *fibs;
113 /** Vector of MTries. */
114 struct ip4_fib_t_ *v4_fibs;
116 /** Vector of MFIBs. */
117 struct mfib_table_t_ *mfibs;
121 /** Table index indexed by software interface. */
122 u32 *fib_index_by_sw_if_index;
124 /** Table index indexed by software interface. */
125 u32 *mfib_index_by_sw_if_index;
127 /* IP4 enabled count by software interface */
128 u8 *ip_enabled_by_sw_if_index;
130 /** Hash table mapping table id to fib index.
131 ID space is not necessarily dense; index space is dense. */
132 uword *fib_index_by_table_id;
134 /** Hash table mapping table id to multicast fib index.
135 ID space is not necessarily dense; index space is dense. */
136 uword *mfib_index_by_table_id;
138 /** Functions to call when interface address changes. */
139 ip4_add_del_interface_address_callback_t
140 * add_del_interface_address_callbacks;
142 /** Functions to call when interface becomes IPv4 enabled/disable. */
143 ip4_enable_disable_interface_callback_t
144 * enable_disable_interface_callbacks;
146 /** Functions to call when interface to table biding changes. */
147 ip4_table_bind_callback_t *table_bind_callbacks;
149 /** Template used to generate IP4 ARP packets. */
150 vlib_packet_template_t ip4_arp_request_packet_template;
152 /** Seed for Jenkins hash used to compute ip4 flow hash. */
155 /** @brief Template information for VPP generated packets */
158 /** TTL to use for host generated packets. */
161 /** TOS byte to use for host generated packets. */
167 /** Heapsize for the Mtries */
168 uword mtrie_heap_size;
170 /** The memory heap for the mtries */
173 /** ARP throttling */
174 throttle_t arp_throttle;
178 #define ARP_THROTTLE_BITS (512)
180 /** Global ip4 main structure. */
181 extern ip4_main_t ip4_main;
182 extern char *ip4_error_strings[];
184 /** Global ip4 input node. Errors get attached to ip4 input node. */
185 extern vlib_node_registration_t ip4_input_node;
186 extern vlib_node_registration_t ip4_lookup_node;
187 extern vlib_node_registration_t ip4_local_node;
188 extern vlib_node_registration_t ip4_rewrite_node;
189 extern vlib_node_registration_t ip4_rewrite_mcast_node;
190 extern vlib_node_registration_t ip4_rewrite_local_node;
191 extern vlib_node_registration_t ip4_arp_node;
192 extern vlib_node_registration_t ip4_glean_node;
193 extern vlib_node_registration_t ip4_midchain_node;
194 extern vlib_node_registration_t ip4_punt_node;
197 ip4_destination_matches_route (const ip4_main_t * im,
198 const ip4_address_t * key,
199 const ip4_address_t * dest, uword dest_length)
201 return 0 == ((key->data_u32 ^ dest->data_u32) & im->fib_masks[dest_length]);
205 ip4_destination_matches_interface (ip4_main_t * im,
207 ip_interface_address_t * ia)
209 ip4_address_t *a = ip_interface_address_get_address (&im->lookup_main, ia);
210 return ip4_destination_matches_route (im, key, a, ia->address_length);
214 ip4_src_address_for_packet (ip_lookup_main_t * lm,
215 u32 sw_if_index, ip4_address_t * src)
217 u32 if_add_index = lm->if_address_pool_index_by_sw_if_index[sw_if_index];
218 if (PREDICT_TRUE (if_add_index != ~0))
220 ip_interface_address_t *if_add =
221 pool_elt_at_index (lm->if_address_pool, if_add_index);
222 ip4_address_t *if_ip = ip_interface_address_get_address (lm, if_add);
233 /* Find interface address which matches destination. */
234 always_inline ip4_address_t *
235 ip4_interface_address_matching_destination (ip4_main_t * im,
236 const ip4_address_t * dst,
238 ip_interface_address_t **
241 ip_lookup_main_t *lm = &im->lookup_main;
242 ip_interface_address_t *ia;
243 ip4_address_t *result = 0;
246 foreach_ip_interface_address (lm, ia, sw_if_index,
247 1 /* honor unnumbered */,
249 ip4_address_t * a = ip_interface_address_get_address (lm, ia);
250 if (ip4_destination_matches_route (im, dst, a, ia->address_length))
258 *result_ia = result ? ia : 0;
262 ip4_address_t *ip4_interface_first_address (ip4_main_t * im, u32 sw_if_index,
263 ip_interface_address_t **
266 clib_error_t *ip4_add_del_interface_address (vlib_main_t * vm,
268 ip4_address_t * address,
269 u32 address_length, u32 is_del);
271 void ip4_directed_broadcast (u32 sw_if_index, u8 enable);
273 void ip4_sw_interface_enable_disable (u32 sw_if_index, u32 is_enable);
275 int ip4_address_compare (ip4_address_t * a1, ip4_address_t * a2);
278 ip4_udp_register_listener (vlib_main_t * vm,
279 u16 dst_port, u32 next_node_index);
281 u16 ip4_tcp_udp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0,
284 void ip4_register_protocol (u32 protocol, u32 node_index);
285 void ip4_unregister_protocol (u32 protocolx);
287 serialize_function_t serialize_vnet_ip4_main, unserialize_vnet_ip4_main;
289 int vnet_set_ip4_flow_hash (u32 table_id,
290 flow_hash_config_t flow_hash_config);
292 int vnet_set_ip4_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
295 void ip4_punt_policer_add_del (u8 is_add, u32 policer_index);
297 void ip4_punt_redirect_add (u32 rx_sw_if_index,
298 u32 tx_sw_if_index, ip46_address_t * nh);
299 void ip4_punt_redirect_add_paths (u32 rx_sw_if_index,
300 fib_route_path_t * paths);
302 void ip4_punt_redirect_del (u32 rx_sw_if_index);
304 /* Compute flow hash. We'll use it to select which adjacency to use for this
305 flow. And other things. */
307 ip4_compute_flow_hash (const ip4_header_t * ip,
308 flow_hash_config_t flow_hash_config)
310 tcp_header_t *tcp = (void *) (ip + 1);
312 uword is_tcp_udp = (ip->protocol == IP_PROTOCOL_TCP
313 || ip->protocol == IP_PROTOCOL_UDP);
315 t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR)
316 ? ip->src_address.data_u32 : 0;
317 t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR)
318 ? ip->dst_address.data_u32 : 0;
320 a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
321 b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
323 t1 = is_tcp_udp ? tcp->src : 0;
324 t2 = is_tcp_udp ? tcp->dst : 0;
326 t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
327 t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
329 if (flow_hash_config & IP_FLOW_HASH_SYMMETRIC)
345 b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? ip->protocol : 0;
346 c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
347 (t1 << 16) | t2 : (t2 << 16) | t1;
349 hash_v3_mix32 (a, b, c);
350 hash_v3_finalize32 (a, b, c);
356 ip4_forward_next_trace (vlib_main_t * vm,
357 vlib_node_runtime_t * node,
358 vlib_frame_t * frame,
359 vlib_rx_or_tx_t which_adj_index);
361 u8 *format_ip4_forward_next_trace (u8 * s, va_list * args);
363 u32 ip4_tcp_udp_validate_checksum (vlib_main_t * vm, vlib_buffer_t * p0);
365 #define IP_DF 0x4000 /* don't fragment */
368 vlib_buffer_push_ip4_custom (vlib_main_t * vm, vlib_buffer_t * b,
369 ip4_address_t * src, ip4_address_t * dst,
370 int proto, u8 csum_offload, u8 is_df)
375 ih = vlib_buffer_push_uninit (b, sizeof (ip4_header_t));
377 ih->ip_version_and_header_length = 0x45;
379 ih->length = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b));
382 ih->flags_and_fragment_offset = is_df ? clib_host_to_net_u16 (IP_DF) : 0;
384 ih->protocol = proto;
385 ih->src_address.as_u32 = src->as_u32;
386 ih->dst_address.as_u32 = dst->as_u32;
388 vnet_buffer (b)->l3_hdr_offset = (u8 *) ih - b->data;
389 b->flags |= VNET_BUFFER_F_IS_IP4 | VNET_BUFFER_F_L3_HDR_OFFSET_VALID;
391 /* Offload ip4 header checksum generation */
395 b->flags |= VNET_BUFFER_F_OFFLOAD_IP_CKSUM;
398 ih->checksum = ip4_header_checksum (ih);
404 * Push IPv4 header to buffer
406 * This does not support fragmentation.
408 * @param vm - vlib_main
409 * @param b - buffer to write the header to
410 * @param src - source IP
411 * @param dst - destination IP
412 * @param prot - payload proto
414 * @return - pointer to start of IP header
417 vlib_buffer_push_ip4 (vlib_main_t * vm, vlib_buffer_t * b,
418 ip4_address_t * src, ip4_address_t * dst, int proto,
421 return vlib_buffer_push_ip4_custom (vm, b, src, dst, proto, csum_offload,
426 vlib_buffer_get_ip4_fib_index (vlib_buffer_t * b)
428 u32 fib_index, sw_if_index;
429 sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_RX];
430 fib_index = vnet_buffer (b)->sw_if_index[VLIB_TX];
431 return (fib_index == (u32) ~ 0) ?
432 vec_elt (ip4_main.fib_index_by_sw_if_index, sw_if_index) : fib_index;
434 #endif /* included_ip_ip4_h */
437 * fd.io coding-style-patch-verification: ON
440 * eval: (c-set-style "gnu")