blob: 71640defb21af96dc6187e0ba250f793158cdcfb [file] [log] [blame]
Ed Warnickecb9cada2015-12-08 15:45:58 -07001/*
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
Ed Warnickecb9cada2015-12-08 15:45:58 -070043#include <vnet/ip/ip4_packet.h>
44#include <vnet/ip/lookup.h>
Damjan Marion22311502016-10-28 20:30:15 +020045#include <vnet/feature/feature.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070046
Neale Ranns32e1c012016-11-22 17:07:28 +000047typedef struct ip4_mfib_t
48{
49 /* Hash table for each prefix length mapping. */
50 uword *fib_entry_by_dst_address[65];
51
52 /* Table ID (hash key) for this FIB. */
53 u32 table_id;
54
55 /* Index into FIB vector. */
56 u32 index;
57} ip4_mfib_t;
58
Ed Warnickecb9cada2015-12-08 15:45:58 -070059struct ip4_main_t;
60
Ed Warnickecb9cada2015-12-08 15:45:58 -070061typedef void (ip4_add_del_interface_address_function_t)
62 (struct ip4_main_t * im,
63 uword opaque,
64 u32 sw_if_index,
65 ip4_address_t * address,
Dave Barachd7cb1b52016-12-09 09:52:16 -050066 u32 address_length, u32 if_address_index, u32 is_del);
Ed Warnickecb9cada2015-12-08 15:45:58 -070067
Dave Barachd7cb1b52016-12-09 09:52:16 -050068typedef struct
69{
70 ip4_add_del_interface_address_function_t *function;
Ed Warnickecb9cada2015-12-08 15:45:58 -070071 uword function_opaque;
72} ip4_add_del_interface_address_callback_t;
73
Dave Barach6f9bca22016-04-30 10:25:32 -040074/**
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
Dave Barachd7cb1b52016-12-09 09:52:16 -050083typedef struct ip4_main_t
84{
Ed Warnickecb9cada2015-12-08 15:45:58 -070085 ip_lookup_main_t lookup_main;
86
Dave Barach6f9bca22016-04-30 10:25:32 -040087 /** Vector of FIBs. */
Dave Barachd7cb1b52016-12-09 09:52:16 -050088 struct fib_table_t_ *fibs;
Ed Warnickecb9cada2015-12-08 15:45:58 -070089
Neale Rannsa3af3372017-03-28 03:49:52 -070090 /** Vector of MTries. */
91 struct ip4_fib_t_ *v4_fibs;
92
Neale Ranns32e1c012016-11-22 17:07:28 +000093 /** Vector of MFIBs. */
94 struct mfib_table_t_ *mfibs;
95
Ed Warnickecb9cada2015-12-08 15:45:58 -070096 u32 fib_masks[33];
97
Dave Barach6f9bca22016-04-30 10:25:32 -040098 /** Table index indexed by software interface. */
Dave Barachd7cb1b52016-12-09 09:52:16 -050099 u32 *fib_index_by_sw_if_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700100
Neale Ranns32e1c012016-11-22 17:07:28 +0000101 /** Table index indexed by software interface. */
102 u32 *mfib_index_by_sw_if_index;
103
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100104 /* IP4 enabled count by software interface */
Dave Barachd7cb1b52016-12-09 09:52:16 -0500105 u8 *ip_enabled_by_sw_if_index;
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100106
Dave Barach6f9bca22016-04-30 10:25:32 -0400107 /** Hash table mapping table id to fib index.
Ed Warnickecb9cada2015-12-08 15:45:58 -0700108 ID space is not necessarily dense; index space is dense. */
Dave Barachd7cb1b52016-12-09 09:52:16 -0500109 uword *fib_index_by_table_id;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700110
Neale Ranns32e1c012016-11-22 17:07:28 +0000111 /** Hash table mapping table id to multicast fib index.
112 ID space is not necessarily dense; index space is dense. */
113 uword *mfib_index_by_table_id;
114
Dave Barach6f9bca22016-04-30 10:25:32 -0400115 /** Functions to call when interface address changes. */
Dave Barachd7cb1b52016-12-09 09:52:16 -0500116 ip4_add_del_interface_address_callback_t
117 * add_del_interface_address_callbacks;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700118
Dave Barach6f9bca22016-04-30 10:25:32 -0400119 /** Template used to generate IP4 ARP packets. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700120 vlib_packet_template_t ip4_arp_request_packet_template;
121
Dave Barach6f9bca22016-04-30 10:25:32 -0400122 /** Seed for Jenkins hash used to compute ip4 flow hash. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700123 u32 flow_hash_seed;
124
Dave Barach6f9bca22016-04-30 10:25:32 -0400125 /** @brief Template information for VPP generated packets */
Dave Barachd7cb1b52016-12-09 09:52:16 -0500126 struct
127 {
Dave Barach6f9bca22016-04-30 10:25:32 -0400128 /** TTL to use for host generated packets. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700129 u8 ttl;
130
Dave Barach6f9bca22016-04-30 10:25:32 -0400131 /** TOS byte to use for host generated packets. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700132 u8 tos;
133
134 u8 pad[2];
135 } host_config;
136} ip4_main_t;
137
Dave Barach6f9bca22016-04-30 10:25:32 -0400138/** Global ip4 main structure. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700139extern ip4_main_t ip4_main;
140
Keith Burns (alagalah)79b5f632016-08-02 05:40:20 -0700141/** Global ip4 input node. Errors get attached to ip4 input node. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700142extern vlib_node_registration_t ip4_input_node;
143extern vlib_node_registration_t ip4_lookup_node;
Neale Ranns32e1c012016-11-22 17:07:28 +0000144extern vlib_node_registration_t ip4_local_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700145extern vlib_node_registration_t ip4_rewrite_node;
Neale Ranns32e1c012016-11-22 17:07:28 +0000146extern vlib_node_registration_t ip4_rewrite_mcast_node;
Pierre Pfister0febaf12016-06-08 12:23:21 +0100147extern vlib_node_registration_t ip4_rewrite_local_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700148extern vlib_node_registration_t ip4_arp_node;
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100149extern vlib_node_registration_t ip4_glean_node;
150extern vlib_node_registration_t ip4_midchain_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700151
152always_inline uword
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100153ip4_destination_matches_route (const ip4_main_t * im,
154 const ip4_address_t * key,
Dave Barachd7cb1b52016-12-09 09:52:16 -0500155 const ip4_address_t * dest, uword dest_length)
156{
157 return 0 == ((key->data_u32 ^ dest->data_u32) & im->fib_masks[dest_length]);
158}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700159
160always_inline uword
161ip4_destination_matches_interface (ip4_main_t * im,
162 ip4_address_t * key,
163 ip_interface_address_t * ia)
164{
Dave Barachd7cb1b52016-12-09 09:52:16 -0500165 ip4_address_t *a = ip_interface_address_get_address (&im->lookup_main, ia);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700166 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). */
170always_inline uword
171ip4_unaligned_destination_matches_route (ip4_main_t * im,
172 ip4_address_t * key,
173 ip4_address_t * dest,
174 uword dest_length)
Dave Barachd7cb1b52016-12-09 09:52:16 -0500175{
176 return 0 ==
177 ((clib_mem_unaligned (&key->data_u32, u32) ^ dest->
178 data_u32) & im->fib_masks[dest_length]);
179}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700180
Pierre Pfisterd076f192016-06-22 12:58:30 +0100181always_inline int
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100182ip4_src_address_for_packet (ip_lookup_main_t * lm,
Dave Barachd7cb1b52016-12-09 09:52:16 -0500183 u32 sw_if_index, ip4_address_t * src)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700184{
Dave Barachd7cb1b52016-12-09 09:52:16 -0500185 u32 if_add_index = lm->if_address_pool_index_by_sw_if_index[sw_if_index];
186 if (PREDICT_TRUE (if_add_index != ~0))
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100187 {
Dave Barachd7cb1b52016-12-09 09:52:16 -0500188 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;
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100193 }
Dave Barachd7cb1b52016-12-09 09:52:16 -0500194 else
195 {
Dave Barachd7cb1b52016-12-09 09:52:16 -0500196 src->as_u32 = 0;
197 }
198 return (!0);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700199}
200
201/* Find interface address which matches destination. */
202always_inline ip4_address_t *
Dave Barachd7cb1b52016-12-09 09:52:16 -0500203ip4_interface_address_matching_destination (ip4_main_t * im,
204 ip4_address_t * dst,
205 u32 sw_if_index,
206 ip_interface_address_t **
207 result_ia)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700208{
Dave Barachd7cb1b52016-12-09 09:52:16 -0500209 ip_lookup_main_t *lm = &im->lookup_main;
210 ip_interface_address_t *ia;
211 ip4_address_t *result = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700212
Dave Barachd7cb1b52016-12-09 09:52:16 -0500213 /* *INDENT-OFF* */
Dave Barach75fc8542016-10-11 16:16:02 -0400214 foreach_ip_interface_address (lm, ia, sw_if_index,
Ed Warnickecb9cada2015-12-08 15:45:58 -0700215 1 /* honor unnumbered */,
216 ({
217 ip4_address_t * a = ip_interface_address_get_address (lm, ia);
218 if (ip4_destination_matches_route (im, dst, a, ia->address_length))
219 {
220 result = a;
221 break;
222 }
223 }));
Dave Barachd7cb1b52016-12-09 09:52:16 -0500224 /* *INDENT-ON* */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700225 if (result_ia)
226 *result_ia = result ? ia : 0;
227 return result;
228}
229
Dave Barachd7cb1b52016-12-09 09:52:16 -0500230ip4_address_t *ip4_interface_first_address (ip4_main_t * im, u32 sw_if_index,
231 ip_interface_address_t **
232 result_ia);
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100233
Dave Barachd7cb1b52016-12-09 09:52:16 -0500234clib_error_t *ip4_add_del_interface_address (vlib_main_t * vm,
235 u32 sw_if_index,
236 ip4_address_t * address,
237 u32 address_length, u32 is_del);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700238
Dave Barachd7cb1b52016-12-09 09:52:16 -0500239void ip4_sw_interface_enable_disable (u32 sw_if_index, u32 is_enable);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700240
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100241int ip4_address_compare (ip4_address_t * a1, ip4_address_t * a2);
Dave Barach203c6322016-06-26 10:29:03 -0400242
Ed Warnickecb9cada2015-12-08 15:45:58 -0700243/* Send an ARP request to see if given destination is reachable on given interface. */
Dave Barachd7cb1b52016-12-09 09:52:16 -0500244clib_error_t *ip4_probe_neighbor (vlib_main_t * vm, ip4_address_t * dst,
245 u32 sw_if_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700246
Dave Barachd7cb1b52016-12-09 09:52:16 -0500247clib_error_t *ip4_set_arp_limit (u32 arp_limit);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700248
249uword
Ed Warnickecb9cada2015-12-08 15:45:58 -0700250ip4_udp_register_listener (vlib_main_t * vm,
Dave Barachd7cb1b52016-12-09 09:52:16 -0500251 u16 dst_port, u32 next_node_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700252
Dave Barach75fc8542016-10-11 16:16:02 -0400253void
Dave Barachd7cb1b52016-12-09 09:52:16 -0500254ip4_icmp_register_type (vlib_main_t * vm, icmp4_type_t type, u32 node_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700255
Dave Barachd7cb1b52016-12-09 09:52:16 -0500256u16 ip4_tcp_udp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0,
257 ip4_header_t * ip0);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700258
259void ip4_register_protocol (u32 protocol, u32 node_index);
260
261serialize_function_t serialize_vnet_ip4_main, unserialize_vnet_ip4_main;
262
Dave Barachd7cb1b52016-12-09 09:52:16 -0500263int vnet_set_ip4_flow_hash (u32 table_id,
264 flow_hash_config_t flow_hash_config);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700265
Dave Barach75fc8542016-10-11 16:16:02 -0400266int vnet_set_ip4_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
Dave Barachd7cb1b52016-12-09 09:52:16 -0500267 u32 table_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700268
269/* Compute flow hash. We'll use it to select which adjacency to use for this
270 flow. And other things. */
271always_inline u32
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100272ip4_compute_flow_hash (const ip4_header_t * ip,
273 flow_hash_config_t flow_hash_config)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700274{
Dave Barachd7cb1b52016-12-09 09:52:16 -0500275 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);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700279
Dave Barachd7cb1b52016-12-09 09:52:16 -0500280 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;
Dave Barach75fc8542016-10-11 16:16:02 -0400284
Dave Barachd7cb1b52016-12-09 09:52:16 -0500285 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;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700288
Dave Barach68b0fb02017-02-28 15:15:56 -0500289 t1 = is_tcp_udp ? tcp->src : 0;
290 t2 = is_tcp_udp ? tcp->dst : 0;
Dave Barach75fc8542016-10-11 16:16:02 -0400291
Dave Barachd7cb1b52016-12-09 09:52:16 -0500292 t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
293 t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700294
Dave Barachd7cb1b52016-12-09 09:52:16 -0500295 c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
296 (t1 << 16) | t2 : (t2 << 16) | t1;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700297
Dave Barachd7cb1b52016-12-09 09:52:16 -0500298 hash_v3_mix32 (a, b, c);
299 hash_v3_finalize32 (a, b, c);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700300
Dave Barachd7cb1b52016-12-09 09:52:16 -0500301 return c;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700302}
303
John Lo37682e12016-11-30 12:51:39 -0500304void
305ip4_forward_next_trace (vlib_main_t * vm,
Dave Barachd7cb1b52016-12-09 09:52:16 -0500306 vlib_node_runtime_t * node,
307 vlib_frame_t * frame,
308 vlib_rx_or_tx_t which_adj_index);
John Lo37682e12016-11-30 12:51:39 -0500309
Dave Barachd7cb1b52016-12-09 09:52:16 -0500310u8 *format_ip4_forward_next_trace (u8 * s, va_list * args);
John Lo37682e12016-11-30 12:51:39 -0500311
312u32 ip4_tcp_udp_validate_checksum (vlib_main_t * vm, vlib_buffer_t * p0);
313
Dave Barach68b0fb02017-02-28 15:15:56 -0500314#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 */
329always_inline void *
330vlib_buffer_push_ip4 (vlib_main_t * vm, vlib_buffer_t * b,
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}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700352#endif /* included_ip_ip4_h */
Dave Barachd7cb1b52016-12-09 09:52:16 -0500353
354/*
355 * fd.io coding-style-patch-verification: ON
356 *
357 * Local Variables:
358 * eval: (c-set-style "gnu")
359 * End:
360 */