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/fib/ip4_fib.h>
24 #include <vnet/fib/ip6_fib.h>
25 #include <vnet/ip/format.h>
26 #include <vnet/ipip/ipip.h>
28 ipip_main_t ipip_main;
30 /* Packet trace structure */
40 format_ipip_tx_trace (u8 * s, va_list * args)
42 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
43 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
44 ipip_tx_trace_t *t = va_arg (*args, ipip_tx_trace_t *);
47 format (s, "IPIP: tunnel %d len %d src %U dst %U", t->tunnel_id,
48 t->length, format_ip46_address, &t->src, IP46_TYPE_ANY,
49 format_ip46_address, &t->dst, IP46_TYPE_ANY);
54 ipip_build_rewrite (vnet_main_t * vnm, u32 sw_if_index,
55 vnet_link_t link_type, const void *dst_address)
60 ipip_tunnel_t *t = ipip_tunnel_db_find_by_sw_if_index (sw_if_index);
68 case IPIP_TRANSPORT_IP4:
69 vec_validate (rewrite, sizeof (*ip4) - 1);
70 ip4 = (ip4_header_t *) rewrite;
71 ip4->ip_version_and_header_length = 0x45;
73 /* fixup ip4 header length, protocol and checksum after-the-fact */
74 ip4->src_address.as_u32 = t->tunnel_src.ip4.as_u32;
75 ip4->dst_address.as_u32 = t->tunnel_dst.ip4.as_u32;
76 ip4->checksum = ip4_header_checksum (ip4);
77 if (t->tc_tos != 0xFF)
81 case IPIP_TRANSPORT_IP6:
82 vec_validate (rewrite, sizeof (*ip6) - 1);
83 ip6 = (ip6_header_t *) rewrite;
84 ip6->ip_version_traffic_class_and_flow_label =
85 clib_host_to_net_u32 (6 << 28);
86 if (t->tc_tos != 0xFF)
87 ip6_set_traffic_class_network_order (ip6, t->tc_tos);
89 /* fixup ip6 header length and protocol after-the-fact */
90 ip6->src_address.as_u64[0] = t->tunnel_src.ip6.as_u64[0];
91 ip6->src_address.as_u64[1] = t->tunnel_src.ip6.as_u64[1];
92 ip6->dst_address.as_u64[0] = t->tunnel_dst.ip6.as_u64[0];
93 ip6->dst_address.as_u64[1] = t->tunnel_dst.ip6.as_u64[1];
104 ipip4_fixup (vlib_main_t * vm, ip_adjacency_t * adj, vlib_buffer_t * b,
108 const ipip_tunnel_t *t = data;
110 ip4 = vlib_buffer_get_current (b);
111 ip4->length = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b));
112 switch (adj->ia_link)
115 ip4->protocol = IP_PROTOCOL_IPV6;
116 if (t->tc_tos == 0xFF)
118 ip6_traffic_class_network_order ((const ip6_header_t *) (ip4 + 1));
122 ip4->protocol = IP_PROTOCOL_IP_IN_IP;
123 if (t->tc_tos == 0xFF)
124 ip4->tos = ((ip4_header_t *) (ip4 + 1))->tos;
131 ip4->checksum = ip4_header_checksum (ip4);
135 ipip6_fixup (vlib_main_t * vm, ip_adjacency_t * adj, vlib_buffer_t * b,
139 const ipip_tunnel_t *t = data;
141 /* Must set locally originated otherwise we're not allowed to
142 fragment the packet later */
143 b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
145 ip6 = vlib_buffer_get_current (b);
146 ip6->payload_length =
147 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b) -
149 switch (adj->ia_link)
152 ip6->protocol = IP_PROTOCOL_IPV6;
153 if (t->tc_tos == 0xFF)
154 ip6_set_traffic_class_network_order (ip6,
155 ip6_traffic_class_network_order ((const ip6_header_t *) (ip6 + 1)));
159 ip6->protocol = IP_PROTOCOL_IP_IN_IP;
160 if (t->tc_tos == 0xFF)
161 ip6_set_traffic_class_network_order (ip6,
162 ((ip4_header_t *) (ip6 +
172 ipip_tunnel_stack (adj_index_t ai)
179 sw_if_index = adj->rewrite_header.sw_if_index;
181 t = ipip_tunnel_db_find_by_sw_if_index (sw_if_index);
185 if ((vnet_hw_interface_get_flags (vnet_get_main (), t->hw_if_index) &
186 VNET_HW_INTERFACE_FLAG_LINK_UP) == 0)
188 adj_nbr_midchain_unstack (ai);
192 dpo_id_t tmp = DPO_INVALID;
193 fib_forward_chain_type_t fib_fwd =
195 IPIP_TRANSPORT_IP6 ? FIB_FORW_CHAIN_TYPE_UNICAST_IP6 :
196 FIB_FORW_CHAIN_TYPE_UNICAST_IP4;
198 fib_entry_contribute_forwarding (t->p2p.fib_entry_index, fib_fwd, &tmp);
199 if (DPO_LOAD_BALANCE == tmp.dpoi_type)
202 * post IPIP rewrite we will load-balance. However, the IPIP encap
203 * is always the same for this adjacency/tunnel and hence the IP/IPIP
204 * src,dst hash is always the same result too. So we do that hash now and
205 * stack on the choice.
206 * If the choice is an incomplete adj then we will need a poke when
207 * it becomes complete. This happens since the adj update walk propagates
208 * as far a recursive paths.
210 const dpo_id_t *choice;
214 lb = load_balance_get (tmp.dpoi_index);
216 if (fib_fwd == FIB_FORW_CHAIN_TYPE_UNICAST_IP4)
217 hash = ip4_compute_flow_hash ((ip4_header_t *) adj_get_rewrite (ai),
220 hash = ip6_compute_flow_hash ((ip6_header_t *) adj_get_rewrite (ai),
223 load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
224 dpo_copy (&tmp, choice);
227 adj_nbr_midchain_stack (ai, &tmp);
232 ipip_adj_walk_cb (adj_index_t ai, void *ctx)
234 ipip_tunnel_stack (ai);
236 return (ADJ_WALK_RC_CONTINUE);
240 ipip_tunnel_restack (ipip_tunnel_t * gt)
242 fib_protocol_t proto;
245 * walk all the adjacencies on th IPIP interface and restack them
247 FOR_EACH_FIB_IP_PROTOCOL (proto)
249 adj_nbr_walk (gt->sw_if_index, proto, ipip_adj_walk_cb, NULL);
254 ipip_update_adj (vnet_main_t * vnm, u32 sw_if_index, adj_index_t ai)
257 adj_midchain_fixup_t f;
259 t = ipip_tunnel_db_find_by_sw_if_index (sw_if_index);
263 f = t->transport == IPIP_TRANSPORT_IP6 ? ipip6_fixup : ipip4_fixup;
265 adj_nbr_midchain_update_rewrite (ai, f, t,
266 (VNET_LINK_ETHERNET ==
267 adj_get_link_type (ai) ?
268 ADJ_FLAG_MIDCHAIN_NO_COUNT :
269 ADJ_FLAG_NONE), ipip_build_rewrite (vnm,
274 ipip_tunnel_stack (ai);
278 format_ipip_tunnel_name (u8 * s, va_list * args)
280 u32 dev_instance = va_arg (*args, u32);
281 ipip_main_t *gm = &ipip_main;
284 if (dev_instance >= vec_len (gm->tunnels))
285 return format (s, "<improperly-referenced>");
287 t = pool_elt_at_index (gm->tunnels, dev_instance);
288 return format (s, "ipip%d", t->user_instance);
292 format_ipip_device (u8 * s, va_list * args)
294 u32 dev_instance = va_arg (*args, u32);
295 CLIB_UNUSED (int verbose) = va_arg (*args, int);
297 s = format (s, "IPIP tunnel: id %d\n", dev_instance);
301 static clib_error_t *
302 ipip_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
304 vnet_hw_interface_t *hi;
307 hi = vnet_get_hw_interface (vnm, hw_if_index);
309 t = ipip_tunnel_db_find_by_sw_if_index (hi->sw_if_index);
313 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
314 vnet_hw_interface_set_flags (vnm, hw_if_index,
315 VNET_HW_INTERFACE_FLAG_LINK_UP);
317 vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */ );
319 ipip_tunnel_restack (t);
321 return /* no error */ 0;
325 VNET_DEVICE_CLASS(ipip_device_class) = {
326 .name = "IPIP tunnel device",
327 .format_device_name = format_ipip_tunnel_name,
328 .format_device = format_ipip_device,
329 .format_tx_trace = format_ipip_tx_trace,
330 .admin_up_down_function = ipip_interface_admin_up_down,
336 VNET_HW_INTERFACE_CLASS(ipip_hw_interface_class) = {
338 //.format_header = format_ipip_header_with_length,
339 //.unformat_header = unformat_ipip_header,
340 .build_rewrite = ipip_build_rewrite,
341 .update_adjacency = ipip_update_adj,
342 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
347 ipip_tunnel_db_find (ipip_tunnel_key_t * key)
349 ipip_main_t *gm = &ipip_main;
352 p = hash_get_mem (gm->tunnel_by_key, key);
355 return (pool_elt_at_index (gm->tunnels, p[0]));
359 ipip_tunnel_db_find_by_sw_if_index (u32 sw_if_index)
361 ipip_main_t *gm = &ipip_main;
362 if (vec_len (gm->tunnel_index_by_sw_if_index) <= sw_if_index)
364 u32 ti = gm->tunnel_index_by_sw_if_index[sw_if_index];
367 return pool_elt_at_index (gm->tunnels, ti);
371 ipip_tunnel_db_add (ipip_tunnel_t * t, ipip_tunnel_key_t * key)
373 ipip_main_t *gm = &ipip_main;
375 t->key = clib_mem_alloc (sizeof (*t->key));
376 clib_memcpy (t->key, key, sizeof (*key));
377 hash_set_mem (gm->tunnel_by_key, t->key, t->dev_instance);
381 ipip_tunnel_db_remove (ipip_tunnel_t * t)
383 ipip_main_t *gm = &ipip_main;
385 hash_unset_mem (gm->tunnel_by_key, t->key);
386 clib_mem_free (t->key);
390 static ipip_tunnel_t *
391 ipip_tunnel_from_fib_node (fib_node_t * node)
393 ipip_main_t *gm = &ipip_main;
394 ASSERT (gm->fib_node_type == node->fn_type);
395 return ((ipip_tunnel_t *) (((char *) node) -
396 offsetof (ipip_tunnel_t, p2p.node)));
399 static fib_node_back_walk_rc_t
400 ipip_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
402 ipip_tunnel_restack (ipip_tunnel_from_fib_node (node));
404 return (FIB_NODE_BACK_WALK_CONTINUE);
408 ipip_tunnel_fib_node_get (fib_node_index_t index)
414 gt = pool_elt_at_index (gm->tunnels, index);
416 return (>->p2p.node);
420 ipip_tunnel_last_lock_gone (fib_node_t * node)
423 * The MPLS IPIP tunnel is a root of the graph. As such
424 * it never has children and thus is never locked.
430 * Virtual function table registered by IPIP tunnels
431 * for participation in the FIB object graph.
433 const static fib_node_vft_t ipip_vft = {
434 .fnv_get = ipip_tunnel_fib_node_get,
435 .fnv_last_lock = ipip_tunnel_last_lock_gone,
436 .fnv_back_walk = ipip_tunnel_back_walk,
440 ipip_fib_add (ipip_tunnel_t * t)
442 ipip_main_t *gm = &ipip_main;
443 fib_prefix_t dst = {.fp_len = t->transport == IPIP_TRANSPORT_IP6 ? 128 : 32,
446 IPIP_TRANSPORT_IP6 ? FIB_PROTOCOL_IP6 : FIB_PROTOCOL_IP4,
447 .fp_addr = t->tunnel_dst
450 t->p2p.fib_entry_index =
451 fib_table_entry_special_add (t->fib_index, &dst, FIB_SOURCE_RR,
452 FIB_ENTRY_FLAG_NONE);
453 t->p2p.sibling_index =
454 fib_entry_child_add (t->p2p.fib_entry_index, gm->fib_node_type,
459 ipip_fib_delete (ipip_tunnel_t * t)
461 fib_entry_child_remove (t->p2p.fib_entry_index, t->p2p.sibling_index);
462 fib_table_entry_delete_index (t->p2p.fib_entry_index, FIB_SOURCE_RR);
463 fib_node_deinit (&t->p2p.node);
467 ipip_add_tunnel (ipip_transport_t transport,
468 u32 instance, ip46_address_t * src, ip46_address_t * dst,
469 u32 fib_index, u8 tc_tos, u32 * sw_if_indexp)
471 ipip_main_t *gm = &ipip_main;
472 vnet_main_t *vnm = gm->vnet_main;
473 ip4_main_t *im4 = &ip4_main;
474 ip6_main_t *im6 = &ip6_main;
476 vnet_hw_interface_t *hi;
477 u32 hw_if_index, sw_if_index;
478 ipip_tunnel_key_t key = {.transport = transport,
479 .fib_index = fib_index,
483 t = ipip_tunnel_db_find (&key);
485 return VNET_API_ERROR_IF_ALREADY_EXISTS;
487 pool_get_aligned (gm->tunnels, t, CLIB_CACHE_LINE_BYTES);
488 memset (t, 0, sizeof (*t));
490 /* Reconcile the real dev_instance and a possible requested instance */
491 u32 t_idx = t - gm->tunnels; /* tunnel index (or instance) */
492 u32 u_idx = instance; /* user specified instance */
495 if (hash_get (gm->instance_used, u_idx))
497 pool_put (gm->tunnels, t);
498 return VNET_API_ERROR_INSTANCE_IN_USE;
500 hash_set (gm->instance_used, u_idx, 1);
502 t->dev_instance = t_idx; /* actual */
503 t->user_instance = u_idx; /* name */
504 fib_node_init (&t->p2p.node, gm->fib_node_type);
506 hw_if_index = vnet_register_interface (vnm, ipip_device_class.index, t_idx,
507 ipip_hw_interface_class.index,
510 hi = vnet_get_hw_interface (vnm, hw_if_index);
511 sw_if_index = hi->sw_if_index;
513 t->hw_if_index = hw_if_index;
514 t->fib_index = fib_index;
515 t->sw_if_index = sw_if_index;
518 t->transport = transport;
519 vec_validate_init_empty (gm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
520 gm->tunnel_index_by_sw_if_index[sw_if_index] = t_idx;
522 if (t->transport == IPIP_TRANSPORT_IP4)
524 vec_validate (im4->fib_index_by_sw_if_index, sw_if_index);
525 hi->min_packet_bytes = 64 + sizeof (ip4_header_t);
529 vec_validate (im6->fib_index_by_sw_if_index, sw_if_index);
530 hi->min_packet_bytes = 64 + sizeof (ip6_header_t);
533 /* Standard default ipip MTU. */
534 vnet_sw_interface_set_mtu (vnm, sw_if_index, 9000);
536 t->tunnel_src = *src;
537 t->tunnel_dst = *dst;
539 ipip_tunnel_db_add (t, &key);
542 * Source the FIB entry for the tunnel's destination and become a
543 * child thereof. The tunnel will then get poked when the forwarding
544 * for the entry updates, and the tunnel can re-stack accordingly
548 *sw_if_indexp = sw_if_index;
550 if (t->transport == IPIP_TRANSPORT_IP6 && !gm->ip6_protocol_registered)
552 ip6_register_protocol (IP_PROTOCOL_IP_IN_IP, ipip6_input_node.index);
553 ip6_register_protocol (IP_PROTOCOL_IPV6, ipip6_input_node.index);
554 gm->ip6_protocol_registered = true;
556 else if (t->transport == IPIP_TRANSPORT_IP4 && !gm->ip4_protocol_registered)
558 ip4_register_protocol (IP_PROTOCOL_IP_IN_IP, ipip4_input_node.index);
559 ip4_register_protocol (IP_PROTOCOL_IPV6, ipip4_input_node.index);
560 gm->ip4_protocol_registered = true;
566 ipip_del_tunnel (u32 sw_if_index)
568 ipip_main_t *gm = &ipip_main;
569 vnet_main_t *vnm = gm->vnet_main;
573 t = ipip_tunnel_db_find_by_sw_if_index (sw_if_index);
575 return VNET_API_ERROR_NO_SUCH_ENTRY;
577 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
578 gm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
579 vnet_delete_hw_interface (vnm, t->hw_if_index);
581 hash_unset (gm->instance_used, t->user_instance);
582 ipip_tunnel_db_remove (t);
583 pool_put (gm->tunnels, t);
588 static clib_error_t *
589 ipip_init (vlib_main_t * vm)
591 ipip_main_t *gm = &ipip_main;
593 memset (gm, 0, sizeof (gm[0]));
595 gm->vnet_main = vnet_get_main ();
597 hash_create_mem (0, sizeof (ipip_tunnel_key_t), sizeof (uword));
598 gm->fib_node_type = fib_node_register_new_type (&ipip_vft);
603 VLIB_INIT_FUNCTION (ipip_init);
606 * fd.io coding-style-patch-verification: ON
609 * eval: (c-set-style "gnu")