2 * gre_interface.c: gre interfaces
4 * Copyright (c) 2012 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 agreed 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.
18 #include <vnet/vnet.h>
19 #include <vnet/pg/pg.h>
20 #include <vnet/gre/gre.h>
21 #include <vnet/ip/format.h>
22 #include <vnet/fib/ip4_fib.h>
23 #include <vnet/fib/ip6_fib.h>
24 #include <vnet/adj/adj_midchain.h>
25 #include <vnet/adj/adj_nbr.h>
26 #include <vnet/mpls/mpls.h>
28 static const char *gre_tunnel_type_names[] = GRE_TUNNEL_TYPE_NAMES;
31 gre4_mk_key (const ip4_address_t * src,
32 const ip4_address_t * dst, u32 out_fib_index)
34 // FIXME. the fib index should be part of the key
35 return ((u64) src->as_u32 << 32 | (u64) dst->as_u32);
39 format_gre_tunnel_type (u8 * s, va_list * args)
41 gre_tunnel_type_t type = va_arg (*args, gre_tunnel_type_t);
43 return (format (s, "%s", gre_tunnel_type_names[type]));
47 format_gre_tunnel (u8 * s, va_list * args)
49 gre_tunnel_t *t = va_arg (*args, gre_tunnel_t *);
50 gre_main_t *gm = &gre_main;
51 u8 is_ipv6 = t->tunnel_dst.fp_proto == FIB_PROTOCOL_IP6 ? 1 : 0;
55 "[%d] %U (src) %U (dst) payload %U outer_fib_index %d",
57 format_ip4_address, &t->tunnel_src.ip4,
58 format_ip4_address, &t->tunnel_dst.fp_addr.ip4,
59 format_gre_tunnel_type, t->type, t->outer_fib_index);
62 "[%d] %U (src) %U (dst) payload %U outer_fib_index %d",
64 format_ip6_address, &t->tunnel_src.ip6,
65 format_ip6_address, &t->tunnel_dst.fp_addr.ip6,
66 format_gre_tunnel_type, t->type, t->outer_fib_index);
72 gre_tunnel_db_find (const ip46_address_t * src,
73 const ip46_address_t * dst, u32 out_fib_index, u8 is_ipv6)
75 gre_main_t *gm = &gre_main;
81 key4 = gre4_mk_key (&src->ip4, &dst->ip4, out_fib_index);
82 p = hash_get (gm->tunnel_by_key4, key4);
86 key6[0] = src->ip6.as_u64[0];
87 key6[1] = src->ip6.as_u64[1];
88 key6[2] = dst->ip6.as_u64[0];
89 key6[3] = dst->ip6.as_u64[1];
90 p = hash_get_mem (gm->tunnel_by_key6, key6);
96 return (pool_elt_at_index (gm->tunnels, p[0]));
100 gre_tunnel_db_add (const gre_tunnel_t * t)
102 gre_main_t *gm = &gre_main;
103 u64 key4, key6[4], *key6_copy;
104 u8 is_ipv6 = t->tunnel_dst.fp_proto == FIB_PROTOCOL_IP6 ? 1 : 0;
108 key4 = gre4_mk_key (&t->tunnel_src.ip4, &t->tunnel_dst.fp_addr.ip4,
110 hash_set (gm->tunnel_by_key4, key4, t - gm->tunnels);
114 key6[0] = t->tunnel_src.ip6.as_u64[0];
115 key6[1] = t->tunnel_src.ip6.as_u64[1];
116 key6[2] = t->tunnel_dst.fp_addr.ip6.as_u64[0];
117 key6[3] = t->tunnel_dst.fp_addr.ip6.as_u64[1];
118 key6_copy = clib_mem_alloc (sizeof (key6));
119 clib_memcpy (key6_copy, key6, sizeof (key6));
120 hash_set_mem (gm->tunnel_by_key6, key6_copy, t - gm->tunnels);
125 gre_tunnel_db_remove (const gre_tunnel_t * t)
127 gre_main_t *gm = &gre_main;
129 u8 is_ipv6 = t->tunnel_dst.fp_proto == FIB_PROTOCOL_IP6 ? 1 : 0;
133 key4 = gre4_mk_key (&t->tunnel_src.ip4, &t->tunnel_dst.fp_addr.ip4,
135 hash_unset (gm->tunnel_by_key4, key4);
139 key6[0] = t->tunnel_src.ip6.as_u64[0];
140 key6[1] = t->tunnel_src.ip6.as_u64[1];
141 key6[2] = t->tunnel_dst.fp_addr.ip6.as_u64[0];
142 key6[3] = t->tunnel_dst.fp_addr.ip6.as_u64[1];
143 hash_unset_mem (gm->tunnel_by_key6, key6);
148 static gre_tunnel_t *
149 gre_tunnel_from_fib_node (fib_node_t * node)
151 ASSERT (FIB_NODE_TYPE_GRE_TUNNEL == node->fn_type);
152 return ((gre_tunnel_t *) (((char *) node) -
153 STRUCT_OFFSET_OF (gre_tunnel_t, node)));
159 * 'stack' (resolve the recursion for) the tunnel's midchain adjacency
162 gre_tunnel_stack (adj_index_t ai)
164 gre_main_t *gm = &gre_main;
170 sw_if_index = adj->rewrite_header.sw_if_index;
172 if ((vec_len (gm->tunnel_index_by_sw_if_index) < sw_if_index) ||
173 (~0 == gm->tunnel_index_by_sw_if_index[sw_if_index]))
176 gt = pool_elt_at_index (gm->tunnels,
177 gm->tunnel_index_by_sw_if_index[sw_if_index]);
180 * find the adjacency that is contributed by the FIB entry
181 * that this tunnel resovles via, and use it as the next adj
184 if (vnet_hw_interface_get_flags (vnet_get_main (),
186 VNET_HW_INTERFACE_FLAG_LINK_UP)
188 adj_nbr_midchain_stack (ai,
189 fib_entry_contribute_ip_forwarding
190 (gt->fib_entry_index));
194 adj_nbr_midchain_unstack (ai);
199 * @brief Call back when restacking all adjacencies on a GRE interface
202 gre_adj_walk_cb (adj_index_t ai, void *ctx)
204 gre_tunnel_stack (ai);
206 return (ADJ_WALK_RC_CONTINUE);
210 gre_tunnel_restack (gre_tunnel_t * gt)
212 fib_protocol_t proto;
215 * walk all the adjacencies on th GRE interface and restack them
217 FOR_EACH_FIB_IP_PROTOCOL (proto)
219 adj_nbr_walk (gt->sw_if_index, proto, gre_adj_walk_cb, NULL);
224 * Function definition to backwalk a FIB node
226 static fib_node_back_walk_rc_t
227 gre_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
229 gre_tunnel_restack (gre_tunnel_from_fib_node (node));
231 return (FIB_NODE_BACK_WALK_CONTINUE);
235 * Function definition to get a FIB node from its index
238 gre_tunnel_fib_node_get (fib_node_index_t index)
244 gt = pool_elt_at_index (gm->tunnels, index);
250 * Function definition to inform the FIB node that its last lock has gone.
253 gre_tunnel_last_lock_gone (fib_node_t * node)
256 * The MPLS GRE tunnel is a root of the graph. As such
257 * it never has children and thus is never locked.
263 * Virtual function table registered by MPLS GRE tunnels
264 * for participation in the FIB object graph.
266 const static fib_node_vft_t gre_vft = {
267 .fnv_get = gre_tunnel_fib_node_get,
268 .fnv_last_lock = gre_tunnel_last_lock_gone,
269 .fnv_back_walk = gre_tunnel_back_walk,
273 vnet_gre_tunnel_add (vnet_gre_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
275 gre_main_t *gm = &gre_main;
276 vnet_main_t *vnm = gm->vnet_main;
277 ip4_main_t *im4 = &ip4_main;
278 ip6_main_t *im6 = &ip6_main;
280 vnet_hw_interface_t *hi;
281 u32 hw_if_index, sw_if_index;
285 u8 is_ipv6 = a->is_ipv6;
288 outer_fib_index = ip4_fib_index_from_table_id (a->outer_fib_id);
290 outer_fib_index = ip6_fib_index_from_table_id (a->outer_fib_id);
292 if (~0 == outer_fib_index)
293 return VNET_API_ERROR_NO_SUCH_FIB;
295 t = gre_tunnel_db_find (&a->src, &a->dst, a->outer_fib_id, a->is_ipv6);
298 return VNET_API_ERROR_INVALID_VALUE;
300 pool_get_aligned (gm->tunnels, t, CLIB_CACHE_LINE_BYTES);
301 memset (t, 0, sizeof (*t));
302 fib_node_init (&t->node, FIB_NODE_TYPE_GRE_TUNNEL);
305 t->type = GRE_TUNNEL_TYPE_TEB;
307 t->type = GRE_TUNNEL_TYPE_L3;
309 if (vec_len (gm->free_gre_tunnel_hw_if_indices[t->type]) > 0)
311 vnet_interface_main_t *im = &vnm->interface_main;
313 hw_if_index = gm->free_gre_tunnel_hw_if_indices[t->type]
314 [vec_len (gm->free_gre_tunnel_hw_if_indices[t->type]) - 1];
315 _vec_len (gm->free_gre_tunnel_hw_if_indices[t->type]) -= 1;
317 hi = vnet_get_hw_interface (vnm, hw_if_index);
318 hi->dev_instance = t - gm->tunnels;
319 hi->hw_instance = hi->dev_instance;
321 /* clear old stats of freed tunnel before reuse */
322 sw_if_index = hi->sw_if_index;
323 vnet_interface_counter_lock (im);
324 vlib_zero_combined_counter
325 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX],
327 vlib_zero_combined_counter (&im->combined_sw_if_counters
328 [VNET_INTERFACE_COUNTER_RX], sw_if_index);
329 vlib_zero_simple_counter (&im->sw_if_counters
330 [VNET_INTERFACE_COUNTER_DROP], sw_if_index);
331 vnet_interface_counter_unlock (im);
332 if (GRE_TUNNEL_TYPE_TEB == t->type)
334 t->l2_tx_arc = vlib_node_add_named_next (vlib_get_main (),
341 if (GRE_TUNNEL_TYPE_TEB == t->type)
343 /* Default MAC address (d00b:eed0:0000 + sw_if_index) */
344 memset (address, 0, sizeof (address));
349 address[4] = t - gm->tunnels;
351 error = ethernet_register_interface (vnm,
352 gre_device_teb_class.index,
353 t - gm->tunnels, address,
358 clib_error_report (error);
359 return VNET_API_ERROR_INVALID_REGISTRATION;
361 hi = vnet_get_hw_interface (vnm, hw_if_index);
363 t->l2_tx_arc = vlib_node_add_named_next (vlib_get_main (),
369 hw_if_index = vnet_register_interface (vnm,
370 gre_device_class.index,
372 gre_hw_interface_class.index,
375 hi = vnet_get_hw_interface (vnm, hw_if_index);
376 sw_if_index = hi->sw_if_index;
379 t->hw_if_index = hw_if_index;
380 t->outer_fib_index = outer_fib_index;
381 t->sw_if_index = sw_if_index;
382 t->l2_adj_index = ADJ_INDEX_INVALID;
384 vec_validate_init_empty (gm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
385 gm->tunnel_index_by_sw_if_index[sw_if_index] = t - gm->tunnels;
389 vec_validate (im4->fib_index_by_sw_if_index, sw_if_index);
390 hi->min_packet_bytes =
391 64 + sizeof (gre_header_t) + sizeof (ip4_header_t);
395 vec_validate (im6->fib_index_by_sw_if_index, sw_if_index);
396 hi->min_packet_bytes =
397 64 + sizeof (gre_header_t) + sizeof (ip6_header_t);
400 hi->per_packet_overhead_bytes =
401 /* preamble */ 8 + /* inter frame gap */ 12;
403 /* Standard default gre MTU. */
404 hi->max_l3_packet_bytes[VLIB_RX] = hi->max_l3_packet_bytes[VLIB_TX] = 9000;
407 * source the FIB entry for the tunnel's destination
408 * and become a child thereof. The tunnel will then get poked
409 * when the forwarding for the entry updates, and the tunnel can
410 * re-stack accordingly
413 clib_memcpy (&t->tunnel_src, &a->src, sizeof (t->tunnel_src));
414 t->tunnel_dst.fp_len = !is_ipv6 ? 32 : 128;
415 t->tunnel_dst.fp_proto = !is_ipv6 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
416 t->tunnel_dst.fp_addr = a->dst;
418 gre_tunnel_db_add (t);
421 fib_table_entry_special_add (outer_fib_index,
423 FIB_SOURCE_RR, FIB_ENTRY_FLAG_NONE);
425 fib_entry_child_add (t->fib_entry_index,
426 FIB_NODE_TYPE_GRE_TUNNEL, t - gm->tunnels);
428 if (GRE_TUNNEL_TYPE_TEB == t->type)
430 t->l2_adj_index = adj_nbr_add_or_lock (t->tunnel_dst.fp_proto,
432 &zero_addr, sw_if_index);
433 gre_update_adj (vnm, t->sw_if_index, t->l2_adj_index);
437 *sw_if_indexp = sw_if_index;
443 vnet_gre_tunnel_delete (vnet_gre_add_del_tunnel_args_t * a,
446 gre_main_t *gm = &gre_main;
447 vnet_main_t *vnm = gm->vnet_main;
451 t = gre_tunnel_db_find (&a->src, &a->dst, a->outer_fib_id, a->is_ipv6);
454 return VNET_API_ERROR_NO_SUCH_ENTRY;
456 sw_if_index = t->sw_if_index;
457 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
458 /* make sure tunnel is removed from l2 bd or xconnect */
459 set_int_l2_mode (gm->vlib_main, vnm, MODE_L3, sw_if_index, 0, 0, 0, 0);
460 vec_add1 (gm->free_gre_tunnel_hw_if_indices[t->type], t->hw_if_index);
461 gm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
463 if (GRE_TUNNEL_TYPE_TEB == t->type)
464 adj_unlock (t->l2_adj_index);
466 if (t->l2_adj_index != ADJ_INDEX_INVALID)
467 adj_unlock (t->l2_adj_index);
469 fib_entry_child_remove (t->fib_entry_index, t->sibling_index);
470 fib_table_entry_delete_index (t->fib_entry_index, FIB_SOURCE_RR);
472 gre_tunnel_db_remove (t);
473 fib_node_deinit (&t->node);
474 pool_put (gm->tunnels, t);
477 *sw_if_indexp = sw_if_index;
483 vnet_gre_add_del_tunnel (vnet_gre_add_del_tunnel_args_t * a,
487 return (vnet_gre_tunnel_add (a, sw_if_indexp));
489 return (vnet_gre_tunnel_delete (a, sw_if_indexp));
493 gre_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
495 gre_main_t *gm = &gre_main;
496 vnet_hw_interface_t *hi;
500 hi = vnet_get_hw_interface (vnm, hw_if_index);
502 if (NULL == gm->tunnel_index_by_sw_if_index ||
503 hi->sw_if_index >= vec_len (gm->tunnel_index_by_sw_if_index))
506 ti = gm->tunnel_index_by_sw_if_index[hi->sw_if_index];
509 /* not one of ours */
512 t = pool_elt_at_index (gm->tunnels, ti);
514 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
515 vnet_hw_interface_set_flags (vnm, hw_if_index,
516 VNET_HW_INTERFACE_FLAG_LINK_UP);
518 vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */ );
520 gre_tunnel_restack (t);
522 return /* no error */ 0;
525 static clib_error_t *
526 create_gre_tunnel_command_fn (vlib_main_t * vm,
527 unformat_input_t * input,
528 vlib_cli_command_t * cmd)
530 unformat_input_t _line_input, *line_input = &_line_input;
531 vnet_gre_add_del_tunnel_args_t _a, *a = &_a;
532 ip46_address_t src, dst;
533 u32 outer_fib_id = 0;
539 clib_error_t *error = NULL;
543 /* Get a line of input. */
544 if (!unformat_user (input, unformat_line_input, line_input))
547 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
549 if (unformat (line_input, "del"))
552 if (unformat (line_input, "src %U", unformat_ip4_address, &src.ip4))
558 if (unformat (line_input, "dst %U", unformat_ip4_address, &dst.ip4))
564 if (unformat (line_input, "src %U", unformat_ip6_address, &src.ip6))
570 if (unformat (line_input, "dst %U", unformat_ip6_address, &dst.ip6))
575 else if (unformat (line_input, "outer-fib-id %d", &outer_fib_id))
577 else if (unformat (line_input, "teb"))
581 error = clib_error_return (0, "unknown input `%U'",
582 format_unformat_error, line_input);
589 error = clib_error_return (0, "mandatory argument(s) missing");
593 if ((ipv4_set && memcmp (&src.ip4, &dst.ip4, sizeof (src.ip4)) == 0) ||
594 (ipv6_set && memcmp (&src.ip6, &dst.ip6, sizeof (src.ip6)) == 0))
596 error = clib_error_return (0, "src and dst are identical");
600 if (ipv4_set && ipv6_set)
601 return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
603 if ((ipv4_set && memcmp (&dst.ip4, &zero_addr.ip4, sizeof (dst.ip4)) == 0)
605 && memcmp (&dst.ip6, &zero_addr.ip6, sizeof (dst.ip6)) == 0))
607 error = clib_error_return (0, "dst address cannot be zero");
611 memset (a, 0, sizeof (*a));
612 a->outer_fib_id = outer_fib_id;
614 a->is_ipv6 = ipv6_set;
617 clib_memcpy (&a->src.ip4, &src.ip4, sizeof (src.ip4));
618 clib_memcpy (&a->dst.ip4, &dst.ip4, sizeof (dst.ip4));
622 clib_memcpy (&a->src.ip6, &src.ip6, sizeof (src.ip6));
623 clib_memcpy (&a->dst.ip6, &dst.ip6, sizeof (dst.ip6));
627 rv = vnet_gre_tunnel_add (a, &sw_if_index);
629 rv = vnet_gre_tunnel_delete (a, &sw_if_index);
634 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
635 vnet_get_main (), sw_if_index);
637 case VNET_API_ERROR_INVALID_VALUE:
638 error = clib_error_return (0, "GRE tunnel already exists...");
640 case VNET_API_ERROR_NO_SUCH_FIB:
641 error = clib_error_return (0, "outer fib ID %d doesn't exist\n",
646 clib_error_return (0, "vnet_gre_add_del_tunnel returned %d", rv);
651 unformat_free (line_input);
657 VLIB_CLI_COMMAND (create_gre_tunnel_command, static) = {
658 .path = "create gre tunnel",
659 .short_help = "create gre tunnel src <addr> dst <addr> "
660 "[outer-fib-id <fib>] [teb] [del]",
661 .function = create_gre_tunnel_command_fn,
665 static clib_error_t *
666 show_gre_tunnel_command_fn (vlib_main_t * vm,
667 unformat_input_t * input,
668 vlib_cli_command_t * cmd)
670 gre_main_t *gm = &gre_main;
674 if (pool_elts (gm->tunnels) == 0)
675 vlib_cli_output (vm, "No GRE tunnels configured...");
677 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
679 if (unformat (input, "%d", &ti))
688 pool_foreach (t, gm->tunnels,
690 vlib_cli_output (vm, "%U", format_gre_tunnel, t);
696 t = pool_elt_at_index (gm->tunnels, ti);
698 vlib_cli_output (vm, "%U", format_gre_tunnel, t);
705 VLIB_CLI_COMMAND (show_gre_tunnel_command, static) = {
706 .path = "show gre tunnel",
707 .function = show_gre_tunnel_command_fn,
711 /* force inclusion from application's main.c */
713 gre_interface_init (vlib_main_t * vm)
715 fib_node_register_type (FIB_NODE_TYPE_GRE_TUNNEL, &gre_vft);
720 VLIB_INIT_FUNCTION (gre_interface_init);
723 * fd.io coding-style-patch-verification: ON
726 * eval: (c-set-style "gnu")