4 * Copyright (c) 2018 Cisco and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or aipiped to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
19 #include <vnet/adj/adj_midchain.h>
20 #include <vnet/ipip/ipip.h>
21 #include <vnet/vnet.h>
22 #include <vnet/adj/adj_nbr.h>
23 #include <vnet/adj/adj_midchain.h>
24 #include <vnet/fib/ip4_fib.h>
25 #include <vnet/fib/ip6_fib.h>
26 #include <vnet/ip/format.h>
27 #include <vnet/ipip/ipip.h>
29 ipip_main_t ipip_main;
31 /* Packet trace structure */
41 format_ipip_tx_trace (u8 * s, va_list * args)
43 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
44 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
45 ipip_tx_trace_t *t = va_arg (*args, ipip_tx_trace_t *);
48 format (s, "IPIP: tunnel %d len %d src %U dst %U", t->tunnel_id,
49 t->length, format_ip46_address, &t->src, IP46_TYPE_ANY,
50 format_ip46_address, &t->dst, IP46_TYPE_ANY);
55 ipip_build_rewrite (vnet_main_t * vnm, u32 sw_if_index,
56 vnet_link_t link_type, const void *dst_address)
61 ipip_tunnel_t *t = ipip_tunnel_db_find_by_sw_if_index (sw_if_index);
69 case IPIP_TRANSPORT_IP4:
70 vec_validate (rewrite, sizeof (*ip4) - 1);
71 ip4 = (ip4_header_t *) rewrite;
72 ip4->ip_version_and_header_length = 0x45;
74 /* fixup ip4 header length, protocol and checksum after-the-fact */
75 ip4->src_address.as_u32 = t->tunnel_src.ip4.as_u32;
76 ip4->dst_address.as_u32 = t->tunnel_dst.ip4.as_u32;
77 ip4->checksum = ip4_header_checksum (ip4);
78 if (!(t->flags & TUNNEL_ENCAP_DECAP_FLAG_ENCAP_COPY_DSCP))
79 ip4_header_set_dscp (ip4, t->dscp);
80 if (t->flags & TUNNEL_ENCAP_DECAP_FLAG_ENCAP_SET_DF)
81 ip4_header_set_df (ip4);
84 case IPIP_TRANSPORT_IP6:
85 vec_validate (rewrite, sizeof (*ip6) - 1);
86 ip6 = (ip6_header_t *) rewrite;
87 ip6->ip_version_traffic_class_and_flow_label =
88 clib_host_to_net_u32 (6 << 28);
90 /* fixup ip6 header length and protocol after-the-fact */
91 ip6->src_address.as_u64[0] = t->tunnel_src.ip6.as_u64[0];
92 ip6->src_address.as_u64[1] = t->tunnel_src.ip6.as_u64[1];
93 ip6->dst_address.as_u64[0] = t->tunnel_dst.ip6.as_u64[0];
94 ip6->dst_address.as_u64[1] = t->tunnel_dst.ip6.as_u64[1];
95 if (!(t->flags & TUNNEL_ENCAP_DECAP_FLAG_ENCAP_COPY_DSCP))
96 ip6_set_dscp_network_order (ip6, t->dscp);
107 ipip4_fixup (vlib_main_t * vm, const ip_adjacency_t * adj, vlib_buffer_t * b,
111 const ipip_tunnel_t *t = data;
113 ip4 = vlib_buffer_get_current (b);
114 ip4->length = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b));
115 switch (adj->ia_link)
118 ip4->protocol = IP_PROTOCOL_IPV6;
119 if (t->flags & TUNNEL_ENCAP_DECAP_FLAG_ENCAP_COPY_DSCP)
120 ip4_header_set_dscp (ip4,
121 ip6_dscp_network_order ((ip6_header_t *) (ip4 +
123 if (t->flags & TUNNEL_ENCAP_DECAP_FLAG_ENCAP_COPY_ECN)
124 ip4_header_set_ecn (ip4,
125 ip6_ecn_network_order ((ip6_header_t *) (ip4 +
130 ip4->protocol = IP_PROTOCOL_IP_IN_IP;
131 if (t->flags & TUNNEL_ENCAP_DECAP_FLAG_ENCAP_COPY_DSCP)
132 ip4_header_set_dscp (ip4, ip4_header_get_dscp (ip4 + 1));
133 if (t->flags & TUNNEL_ENCAP_DECAP_FLAG_ENCAP_COPY_ECN)
134 ip4_header_set_ecn (ip4, ip4_header_get_ecn (ip4 + 1));
135 if ((t->flags & TUNNEL_ENCAP_DECAP_FLAG_ENCAP_COPY_DF) &&
136 ip4_header_get_df (ip4 + 1))
137 ip4_header_set_df (ip4);
144 ip4->checksum = ip4_header_checksum (ip4);
148 ipip6_fixup (vlib_main_t * vm, const ip_adjacency_t * adj, vlib_buffer_t * b,
152 const ipip_tunnel_t *t = data;
154 /* Must set locally originated otherwise we're not allowed to
155 fragment the packet later */
156 b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
158 ip6 = vlib_buffer_get_current (b);
159 ip6->payload_length =
160 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b) -
162 switch (adj->ia_link)
165 ip6->protocol = IP_PROTOCOL_IPV6;
166 if (t->flags & TUNNEL_ENCAP_DECAP_FLAG_ENCAP_COPY_DSCP)
167 ip6_set_dscp_network_order (ip6, ip6_dscp_network_order (ip6 + 1));
168 if (t->flags & TUNNEL_ENCAP_DECAP_FLAG_ENCAP_COPY_ECN)
169 ip6_set_ecn_network_order (ip6, ip6_ecn_network_order (ip6 + 1));
173 ip6->protocol = IP_PROTOCOL_IP_IN_IP;
174 if (t->flags & TUNNEL_ENCAP_DECAP_FLAG_ENCAP_COPY_DSCP)
175 ip6_set_dscp_network_order
176 (ip6, ip4_header_get_dscp ((ip4_header_t *) (ip6 + 1)));
177 if (t->flags & TUNNEL_ENCAP_DECAP_FLAG_ENCAP_COPY_ECN)
178 ip6_set_ecn_network_order
179 (ip6, ip4_header_get_ecn ((ip4_header_t *) (ip6 + 1)));
188 ipip_tunnel_stack (adj_index_t ai)
195 sw_if_index = adj->rewrite_header.sw_if_index;
197 t = ipip_tunnel_db_find_by_sw_if_index (sw_if_index);
201 if ((vnet_hw_interface_get_flags (vnet_get_main (), t->hw_if_index) &
202 VNET_HW_INTERFACE_FLAG_LINK_UP) == 0)
204 adj_midchain_delegate_unstack (ai);
210 .fp_len = t->transport == IPIP_TRANSPORT_IP6 ? 128 : 32,
211 .fp_proto = (t->transport == IPIP_TRANSPORT_IP6 ?
214 .fp_addr = t->tunnel_dst
218 adj_midchain_delegate_stack (ai, t->fib_index, &dst);
223 ipip_adj_walk_cb (adj_index_t ai, void *ctx)
225 ipip_tunnel_stack (ai);
227 return (ADJ_WALK_RC_CONTINUE);
231 ipip_tunnel_restack (ipip_tunnel_t * gt)
233 fib_protocol_t proto;
236 * walk all the adjacencies on th IPIP interface and restack them
238 FOR_EACH_FIB_IP_PROTOCOL (proto)
240 adj_nbr_walk (gt->sw_if_index, proto, ipip_adj_walk_cb, NULL);
245 ipip_update_adj (vnet_main_t * vnm, u32 sw_if_index, adj_index_t ai)
247 adj_midchain_fixup_t f;
251 t = ipip_tunnel_db_find_by_sw_if_index (sw_if_index);
255 f = t->transport == IPIP_TRANSPORT_IP6 ? ipip6_fixup : ipip4_fixup;
256 af = ADJ_FLAG_MIDCHAIN_IP_STACK;
257 if (VNET_LINK_ETHERNET == adj_get_link_type (ai))
258 af |= ADJ_FLAG_MIDCHAIN_NO_COUNT;
260 adj_nbr_midchain_update_rewrite (ai, f, t, af,
261 ipip_build_rewrite (vnm,
265 ipip_tunnel_stack (ai);
269 format_ipip_tunnel_name (u8 * s, va_list * args)
271 u32 dev_instance = va_arg (*args, u32);
272 ipip_main_t *gm = &ipip_main;
275 if (dev_instance >= vec_len (gm->tunnels))
276 return format (s, "<improperly-referenced>");
278 t = pool_elt_at_index (gm->tunnels, dev_instance);
279 return format (s, "ipip%d", t->user_instance);
283 format_ipip_device (u8 * s, va_list * args)
285 u32 dev_instance = va_arg (*args, u32);
286 CLIB_UNUSED (int verbose) = va_arg (*args, int);
288 s = format (s, "IPIP tunnel: id %d\n", dev_instance);
292 static clib_error_t *
293 ipip_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
295 vnet_hw_interface_t *hi;
298 hi = vnet_get_hw_interface (vnm, hw_if_index);
300 t = ipip_tunnel_db_find_by_sw_if_index (hi->sw_if_index);
304 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
305 vnet_hw_interface_set_flags (vnm, hw_if_index,
306 VNET_HW_INTERFACE_FLAG_LINK_UP);
308 vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */ );
310 ipip_tunnel_restack (t);
312 return /* no error */ 0;
316 ipip_tunnel_desc (u32 sw_if_index,
317 ip46_address_t * src, ip46_address_t * dst, u8 * is_l2)
321 t = ipip_tunnel_db_find_by_sw_if_index (sw_if_index);
325 *src = t->tunnel_src;
326 *dst = t->tunnel_dst;
333 VNET_DEVICE_CLASS(ipip_device_class) = {
334 .name = "IPIP tunnel device",
335 .format_device_name = format_ipip_tunnel_name,
336 .format_device = format_ipip_device,
337 .format_tx_trace = format_ipip_tx_trace,
338 .admin_up_down_function = ipip_interface_admin_up_down,
339 .ip_tun_desc = ipip_tunnel_desc,
345 VNET_HW_INTERFACE_CLASS(ipip_hw_interface_class) = {
347 //.format_header = format_ipip_header_with_length,
348 //.unformat_header = unformat_ipip_header,
349 .build_rewrite = ipip_build_rewrite,
350 .update_adjacency = ipip_update_adj,
351 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
356 ipip_tunnel_db_find (ipip_tunnel_key_t * key)
358 ipip_main_t *gm = &ipip_main;
361 p = hash_get_mem (gm->tunnel_by_key, key);
364 return (pool_elt_at_index (gm->tunnels, p[0]));
368 ipip_tunnel_db_find_by_sw_if_index (u32 sw_if_index)
370 ipip_main_t *gm = &ipip_main;
371 if (vec_len (gm->tunnel_index_by_sw_if_index) <= sw_if_index)
373 u32 ti = gm->tunnel_index_by_sw_if_index[sw_if_index];
376 return pool_elt_at_index (gm->tunnels, ti);
380 ipip_tunnel_db_add (ipip_tunnel_t * t, ipip_tunnel_key_t * key)
382 ipip_main_t *gm = &ipip_main;
384 t->key = clib_mem_alloc (sizeof (*t->key));
385 clib_memcpy (t->key, key, sizeof (*key));
386 hash_set_mem (gm->tunnel_by_key, t->key, t->dev_instance);
390 ipip_tunnel_db_remove (ipip_tunnel_t * t)
392 ipip_main_t *gm = &ipip_main;
394 hash_unset_mem (gm->tunnel_by_key, t->key);
395 clib_mem_free (t->key);
400 ipip_add_tunnel (ipip_transport_t transport,
401 u32 instance, ip46_address_t * src, ip46_address_t * dst,
402 u32 fib_index, tunnel_encap_decap_flags_t flags,
403 ip_dscp_t dscp, u32 * sw_if_indexp)
405 ipip_main_t *gm = &ipip_main;
406 vnet_main_t *vnm = gm->vnet_main;
407 ip4_main_t *im4 = &ip4_main;
408 ip6_main_t *im6 = &ip6_main;
410 vnet_hw_interface_t *hi;
411 u32 hw_if_index, sw_if_index;
412 ipip_tunnel_key_t key = {.transport = transport,
413 .fib_index = fib_index,
417 t = ipip_tunnel_db_find (&key);
421 sw_if_indexp[0] = t->sw_if_index;
422 return VNET_API_ERROR_IF_ALREADY_EXISTS;
425 pool_get_aligned (gm->tunnels, t, CLIB_CACHE_LINE_BYTES);
426 clib_memset (t, 0, sizeof (*t));
428 /* Reconcile the real dev_instance and a possible requested instance */
429 u32 t_idx = t - gm->tunnels; /* tunnel index (or instance) */
430 u32 u_idx = instance; /* user specified instance */
433 if (hash_get (gm->instance_used, u_idx))
435 pool_put (gm->tunnels, t);
436 return VNET_API_ERROR_INSTANCE_IN_USE;
438 hash_set (gm->instance_used, u_idx, 1);
440 t->dev_instance = t_idx; /* actual */
441 t->user_instance = u_idx; /* name */
443 hw_if_index = vnet_register_interface (vnm, ipip_device_class.index, t_idx,
444 ipip_hw_interface_class.index,
447 hi = vnet_get_hw_interface (vnm, hw_if_index);
448 sw_if_index = hi->sw_if_index;
450 t->hw_if_index = hw_if_index;
451 t->fib_index = fib_index;
452 t->sw_if_index = sw_if_index;
455 t->transport = transport;
457 vec_validate_init_empty (gm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
458 gm->tunnel_index_by_sw_if_index[sw_if_index] = t_idx;
460 if (t->transport == IPIP_TRANSPORT_IP4)
462 vec_validate (im4->fib_index_by_sw_if_index, sw_if_index);
463 hi->min_packet_bytes = 64 + sizeof (ip4_header_t);
467 vec_validate (im6->fib_index_by_sw_if_index, sw_if_index);
468 hi->min_packet_bytes = 64 + sizeof (ip6_header_t);
471 /* Standard default ipip MTU. */
472 vnet_sw_interface_set_mtu (vnm, sw_if_index, 9000);
474 t->tunnel_src = *src;
475 t->tunnel_dst = *dst;
477 ipip_tunnel_db_add (t, &key);
480 *sw_if_indexp = sw_if_index;
482 if (t->transport == IPIP_TRANSPORT_IP6 && !gm->ip6_protocol_registered)
484 ip6_register_protocol (IP_PROTOCOL_IP_IN_IP, ipip6_input_node.index);
485 ip6_register_protocol (IP_PROTOCOL_IPV6, ipip6_input_node.index);
486 gm->ip6_protocol_registered = true;
488 else if (t->transport == IPIP_TRANSPORT_IP4 && !gm->ip4_protocol_registered)
490 ip4_register_protocol (IP_PROTOCOL_IP_IN_IP, ipip4_input_node.index);
491 ip4_register_protocol (IP_PROTOCOL_IPV6, ipip4_input_node.index);
492 gm->ip4_protocol_registered = true;
498 ipip_del_tunnel (u32 sw_if_index)
500 ipip_main_t *gm = &ipip_main;
501 vnet_main_t *vnm = gm->vnet_main;
505 t = ipip_tunnel_db_find_by_sw_if_index (sw_if_index);
507 return VNET_API_ERROR_NO_SUCH_ENTRY;
509 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
510 gm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
511 vnet_delete_hw_interface (vnm, t->hw_if_index);
512 hash_unset (gm->instance_used, t->user_instance);
513 ipip_tunnel_db_remove (t);
514 pool_put (gm->tunnels, t);
519 static clib_error_t *
520 ipip_init (vlib_main_t * vm)
522 ipip_main_t *gm = &ipip_main;
524 clib_memset (gm, 0, sizeof (gm[0]));
526 gm->vnet_main = vnet_get_main ();
528 hash_create_mem (0, sizeof (ipip_tunnel_key_t), sizeof (uword));
533 VLIB_INIT_FUNCTION (ipip_init);
536 * fd.io coding-style-patch-verification: ON
539 * eval: (c-set-style "gnu")