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/ip_flow_hash.h>
46 #include <vnet/ip/lookup.h>
47 #include <vnet/ip/ip_interface.h>
48 #include <vnet/buffer.h>
49 #include <vnet/feature/feature.h>
50 #include <vnet/ip/icmp46_packet.h>
52 typedef struct ip4_mfib_t
54 /* Hash table for each prefix length mapping. */
55 uword *fib_entry_by_dst_address[65];
57 /* Table ID (hash key) for this FIB. */
60 /* Index into FIB vector. */
66 typedef void (ip4_add_del_interface_address_function_t)
67 (struct ip4_main_t * im,
70 ip4_address_t * address,
71 u32 address_length, u32 if_address_index, u32 is_del);
75 ip4_add_del_interface_address_function_t *function;
76 uword function_opaque;
77 } ip4_add_del_interface_address_callback_t;
79 typedef void (ip4_enable_disable_interface_function_t)
80 (struct ip4_main_t * im, uword opaque, u32 sw_if_index, u32 is_enable);
84 ip4_enable_disable_interface_function_t *function;
85 uword function_opaque;
86 } ip4_enable_disable_interface_callback_t;
88 typedef void (ip4_table_bind_function_t)
89 (struct ip4_main_t * im,
90 uword opaque, u32 sw_if_index, u32 new_fib_index, u32 old_fib_index);
94 ip4_table_bind_function_t *function;
95 uword function_opaque;
96 } ip4_table_bind_callback_t;
99 * @brief IPv4 main type.
101 * State of IPv4 VPP processing including:
103 * - Feature indices used in feature topological sort
104 * - Feature node run time references
107 typedef struct ip4_main_t
109 ip_lookup_main_t lookup_main;
111 /** Vector of FIBs. */
112 struct fib_table_t_ *fibs;
114 /** Vector of MTries. */
115 struct ip4_fib_t_ *v4_fibs;
117 /** Vector of MFIBs. */
118 struct mfib_table_t_ *mfibs;
122 /** Table index indexed by software interface. */
123 u32 *fib_index_by_sw_if_index;
125 /** Table index indexed by software interface. */
126 u32 *mfib_index_by_sw_if_index;
128 /* IP4 enabled count by software interface */
129 u8 *ip_enabled_by_sw_if_index;
131 /** Hash table mapping table id to fib index.
132 ID space is not necessarily dense; index space is dense. */
133 uword *fib_index_by_table_id;
135 /** Hash table mapping table id to multicast fib index.
136 ID space is not necessarily dense; index space is dense. */
137 uword *mfib_index_by_table_id;
139 /** Functions to call when interface address changes. */
140 ip4_add_del_interface_address_callback_t
141 * add_del_interface_address_callbacks;
143 /** Functions to call when interface becomes IPv4 enabled/disable. */
144 ip4_enable_disable_interface_callback_t
145 * enable_disable_interface_callbacks;
147 /** Functions to call when interface to table biding changes. */
148 ip4_table_bind_callback_t *table_bind_callbacks;
150 /** Template used to generate IP4 ARP packets. */
151 vlib_packet_template_t ip4_arp_request_packet_template;
153 /** Seed for Jenkins hash used to compute ip4 flow hash. */
156 /** @brief Template information for VPP generated packets */
159 /** TTL to use for host generated packets. */
162 /** TOS byte to use for host generated packets. */
169 #define ARP_THROTTLE_BITS (512)
171 /** Global ip4 main structure. */
172 extern ip4_main_t ip4_main;
173 extern char *ip4_error_strings[];
175 /** Global ip4 input node. Errors get attached to ip4 input node. */
176 extern vlib_node_registration_t ip4_input_node;
177 extern vlib_node_registration_t ip4_lookup_node;
178 extern vlib_node_registration_t ip4_local_node;
179 extern vlib_node_registration_t ip4_rewrite_node;
180 extern vlib_node_registration_t ip4_rewrite_mcast_node;
181 extern vlib_node_registration_t ip4_rewrite_local_node;
182 extern vlib_node_registration_t ip4_arp_node;
183 extern vlib_node_registration_t ip4_glean_node;
184 extern vlib_node_registration_t ip4_midchain_node;
185 extern vlib_node_registration_t ip4_punt_node;
188 ip4_destination_matches_route (const ip4_main_t * im,
189 const ip4_address_t * key,
190 const ip4_address_t * dest, uword dest_length)
192 return 0 == ((key->data_u32 ^ dest->data_u32) & im->fib_masks[dest_length]);
196 ip4_destination_matches_interface (ip4_main_t * im,
198 ip_interface_address_t * ia)
200 ip4_address_t *a = ip_interface_address_get_address (&im->lookup_main, ia);
201 return ip4_destination_matches_route (im, key, a, ia->address_length);
204 /* Find interface address which matches destination. */
205 always_inline ip4_address_t *
206 ip4_interface_address_matching_destination (ip4_main_t * im,
207 const ip4_address_t * dst,
209 ip_interface_address_t **
212 ip_lookup_main_t *lm = &im->lookup_main;
213 ip_interface_address_t *ia;
214 ip4_address_t *result = 0;
217 foreach_ip_interface_address (lm, ia, sw_if_index,
218 1 /* honor unnumbered */,
220 ip4_address_t * a = ip_interface_address_get_address (lm, ia);
221 if (ip4_destination_matches_route (im, dst, a, ia->address_length))
229 *result_ia = result ? ia : 0;
233 ip4_address_t *ip4_interface_first_address (ip4_main_t * im, u32 sw_if_index,
234 ip_interface_address_t **
237 clib_error_t *ip4_add_del_interface_address (vlib_main_t * vm,
239 ip4_address_t * address,
240 u32 address_length, u32 is_del);
242 void ip4_directed_broadcast (u32 sw_if_index, u8 enable);
244 void ip4_sw_interface_enable_disable (u32 sw_if_index, u32 is_enable);
246 int ip4_address_compare (ip4_address_t * a1, ip4_address_t * a2);
249 ip4_udp_register_listener (vlib_main_t * vm,
250 u16 dst_port, u32 next_node_index);
252 u16 ip4_tcp_udp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0,
255 void ip4_register_protocol (u32 protocol, u32 node_index);
256 void ip4_unregister_protocol (u32 protocolx);
258 serialize_function_t serialize_vnet_ip4_main, unserialize_vnet_ip4_main;
260 int vnet_set_ip4_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
263 void ip4_punt_policer_add_del (u8 is_add, u32 policer_index);
265 void ip4_punt_redirect_add (u32 rx_sw_if_index,
266 u32 tx_sw_if_index, ip46_address_t * nh);
267 void ip4_punt_redirect_add_paths (u32 rx_sw_if_index,
268 fib_route_path_t * paths);
270 void ip4_punt_redirect_del (u32 rx_sw_if_index);
274 ip4_forward_next_trace (vlib_main_t * vm,
275 vlib_node_runtime_t * node,
276 vlib_frame_t * frame,
277 vlib_rx_or_tx_t which_adj_index);
279 u8 *format_ip4_forward_next_trace (u8 * s, va_list * args);
281 u32 ip4_tcp_udp_validate_checksum (vlib_main_t * vm, vlib_buffer_t * p0);
284 vlib_buffer_get_ip4_fib_index (vlib_buffer_t * b)
286 u32 fib_index, sw_if_index;
287 sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_RX];
288 fib_index = vnet_buffer (b)->sw_if_index[VLIB_TX];
289 return (fib_index == (u32) ~ 0) ?
290 vec_elt (ip4_main.fib_index_by_sw_if_index, sw_if_index) : fib_index;
293 #endif /* included_ip_ip4_h */
296 * fd.io coding-style-patch-verification: ON
299 * eval: (c-set-style "gnu")