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 format_gre_tunnel_type (u8 * s, va_list * args)
33 gre_tunnel_type_t type = va_arg (*args, gre_tunnel_type_t);
35 return (format (s, "%s", gre_tunnel_type_names[type]));
39 format_gre_tunnel (u8 * s, va_list * args)
41 gre_tunnel_t *t = va_arg (*args, gre_tunnel_t *);
42 gre_main_t *gm = &gre_main;
43 u8 is_ipv6 = t->tunnel_dst.fp_proto == FIB_PROTOCOL_IP6 ? 1 : 0;
47 "[%d] %U (src) %U (dst) payload %U outer_fib_index %d",
49 format_ip4_address, &t->tunnel_src.ip4,
50 format_ip4_address, &t->tunnel_dst.fp_addr.ip4,
51 format_gre_tunnel_type, t->type, t->outer_fib_index);
54 "[%d] %U (src) %U (dst) payload %U outer_fib_index %d",
56 format_ip6_address, &t->tunnel_src.ip6,
57 format_ip6_address, &t->tunnel_dst.fp_addr.ip6,
58 format_gre_tunnel_type, t->type, t->outer_fib_index);
64 gre_tunnel_db_find (const ip46_address_t * src,
65 const ip46_address_t * dst,
66 u32 out_fib_index, u8 is_ipv6, gre_tunnel_key_t * key)
68 gre_main_t *gm = &gre_main;
73 gre_mk_key4 (&src->ip4, &dst->ip4, out_fib_index, &key->gtk_v4);
74 p = hash_get_mem (gm->tunnel_by_key4, &key->gtk_v4);
78 gre_mk_key6 (&src->ip6, &dst->ip6, out_fib_index, &key->gtk_v6);
79 p = hash_get_mem (gm->tunnel_by_key6, &key->gtk_v6);
85 return (pool_elt_at_index (gm->tunnels, p[0]));
89 gre_tunnel_db_add (gre_tunnel_t * t, gre_tunnel_key_t * key)
91 gre_main_t *gm = &gre_main;
93 t->key = clib_mem_alloc (sizeof (*t->key));
94 clib_memcpy (t->key, key, sizeof (*key));
96 if (t->tunnel_dst.fp_proto == FIB_PROTOCOL_IP6)
98 hash_set_mem (gm->tunnel_by_key6, &t->key->gtk_v6, t - gm->tunnels);
102 hash_set_mem (gm->tunnel_by_key4, &t->key->gtk_v4, t - gm->tunnels);
107 gre_tunnel_db_remove (gre_tunnel_t * t)
109 gre_main_t *gm = &gre_main;
111 if (t->tunnel_dst.fp_proto == FIB_PROTOCOL_IP6)
113 hash_unset_mem (gm->tunnel_by_key6, &t->key->gtk_v6);
117 hash_unset_mem (gm->tunnel_by_key4, &t->key->gtk_v4);
120 clib_mem_free (t->key);
124 static gre_tunnel_t *
125 gre_tunnel_from_fib_node (fib_node_t * node)
127 ASSERT (FIB_NODE_TYPE_GRE_TUNNEL == node->fn_type);
128 return ((gre_tunnel_t *) (((char *) node) -
129 STRUCT_OFFSET_OF (gre_tunnel_t, node)));
135 * 'stack' (resolve the recursion for) the tunnel's midchain adjacency
138 gre_tunnel_stack (adj_index_t ai)
140 gre_main_t *gm = &gre_main;
146 sw_if_index = adj->rewrite_header.sw_if_index;
148 if ((vec_len (gm->tunnel_index_by_sw_if_index) < sw_if_index) ||
149 (~0 == gm->tunnel_index_by_sw_if_index[sw_if_index]))
152 gt = pool_elt_at_index (gm->tunnels,
153 gm->tunnel_index_by_sw_if_index[sw_if_index]);
156 * find the adjacency that is contributed by the FIB entry
157 * that this tunnel resovles via, and use it as the next adj
160 if (vnet_hw_interface_get_flags (vnet_get_main (),
162 VNET_HW_INTERFACE_FLAG_LINK_UP)
164 adj_nbr_midchain_stack (ai,
165 fib_entry_contribute_ip_forwarding
166 (gt->fib_entry_index));
170 adj_nbr_midchain_unstack (ai);
175 * @brief Call back when restacking all adjacencies on a GRE interface
178 gre_adj_walk_cb (adj_index_t ai, void *ctx)
180 gre_tunnel_stack (ai);
182 return (ADJ_WALK_RC_CONTINUE);
186 gre_tunnel_restack (gre_tunnel_t * gt)
188 fib_protocol_t proto;
191 * walk all the adjacencies on th GRE interface and restack them
193 FOR_EACH_FIB_IP_PROTOCOL (proto)
195 adj_nbr_walk (gt->sw_if_index, proto, gre_adj_walk_cb, NULL);
200 * Function definition to backwalk a FIB node
202 static fib_node_back_walk_rc_t
203 gre_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
205 gre_tunnel_restack (gre_tunnel_from_fib_node (node));
207 return (FIB_NODE_BACK_WALK_CONTINUE);
211 * Function definition to get a FIB node from its index
214 gre_tunnel_fib_node_get (fib_node_index_t index)
220 gt = pool_elt_at_index (gm->tunnels, index);
226 * Function definition to inform the FIB node that its last lock has gone.
229 gre_tunnel_last_lock_gone (fib_node_t * node)
232 * The MPLS GRE tunnel is a root of the graph. As such
233 * it never has children and thus is never locked.
239 * Virtual function table registered by MPLS GRE tunnels
240 * for participation in the FIB object graph.
242 const static fib_node_vft_t gre_vft = {
243 .fnv_get = gre_tunnel_fib_node_get,
244 .fnv_last_lock = gre_tunnel_last_lock_gone,
245 .fnv_back_walk = gre_tunnel_back_walk,
249 vnet_gre_tunnel_add (vnet_gre_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
251 gre_main_t *gm = &gre_main;
252 vnet_main_t *vnm = gm->vnet_main;
253 ip4_main_t *im4 = &ip4_main;
254 ip6_main_t *im6 = &ip6_main;
256 vnet_hw_interface_t *hi;
257 u32 hw_if_index, sw_if_index;
261 u8 is_ipv6 = a->is_ipv6;
262 gre_tunnel_key_t key;
265 outer_fib_index = ip4_fib_index_from_table_id (a->outer_fib_id);
267 outer_fib_index = ip6_fib_index_from_table_id (a->outer_fib_id);
269 if (~0 == outer_fib_index)
270 return VNET_API_ERROR_NO_SUCH_FIB;
273 gre_tunnel_db_find (&a->src, &a->dst, outer_fib_index, a->is_ipv6, &key);
276 return VNET_API_ERROR_INVALID_VALUE;
278 pool_get_aligned (gm->tunnels, t, CLIB_CACHE_LINE_BYTES);
279 memset (t, 0, sizeof (*t));
280 fib_node_init (&t->node, FIB_NODE_TYPE_GRE_TUNNEL);
283 t->type = GRE_TUNNEL_TYPE_TEB;
285 t->type = GRE_TUNNEL_TYPE_L3;
287 if (vec_len (gm->free_gre_tunnel_hw_if_indices[t->type]) > 0)
289 vnet_interface_main_t *im = &vnm->interface_main;
291 hw_if_index = gm->free_gre_tunnel_hw_if_indices[t->type]
292 [vec_len (gm->free_gre_tunnel_hw_if_indices[t->type]) - 1];
293 _vec_len (gm->free_gre_tunnel_hw_if_indices[t->type]) -= 1;
295 hi = vnet_get_hw_interface (vnm, hw_if_index);
296 hi->dev_instance = t - gm->tunnels;
297 hi->hw_instance = hi->dev_instance;
299 /* clear old stats of freed tunnel before reuse */
300 sw_if_index = hi->sw_if_index;
301 vnet_interface_counter_lock (im);
302 vlib_zero_combined_counter
303 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX],
305 vlib_zero_combined_counter (&im->combined_sw_if_counters
306 [VNET_INTERFACE_COUNTER_RX], sw_if_index);
307 vlib_zero_simple_counter (&im->sw_if_counters
308 [VNET_INTERFACE_COUNTER_DROP], sw_if_index);
309 vnet_interface_counter_unlock (im);
310 if (GRE_TUNNEL_TYPE_TEB == t->type)
312 t->l2_tx_arc = vlib_node_add_named_next (vlib_get_main (),
319 if (GRE_TUNNEL_TYPE_TEB == t->type)
321 /* Default MAC address (d00b:eed0:0000 + sw_if_index) */
322 memset (address, 0, sizeof (address));
327 address[4] = t - gm->tunnels;
329 error = ethernet_register_interface (vnm,
330 gre_device_teb_class.index,
331 t - gm->tunnels, address,
336 clib_error_report (error);
337 return VNET_API_ERROR_INVALID_REGISTRATION;
339 hi = vnet_get_hw_interface (vnm, hw_if_index);
341 t->l2_tx_arc = vlib_node_add_named_next (vlib_get_main (),
347 hw_if_index = vnet_register_interface (vnm,
348 gre_device_class.index,
350 gre_hw_interface_class.index,
353 hi = vnet_get_hw_interface (vnm, hw_if_index);
354 sw_if_index = hi->sw_if_index;
357 t->hw_if_index = hw_if_index;
358 t->outer_fib_index = outer_fib_index;
359 t->sw_if_index = sw_if_index;
360 t->l2_adj_index = ADJ_INDEX_INVALID;
362 vec_validate_init_empty (gm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
363 gm->tunnel_index_by_sw_if_index[sw_if_index] = t - gm->tunnels;
367 vec_validate (im4->fib_index_by_sw_if_index, sw_if_index);
368 hi->min_packet_bytes =
369 64 + sizeof (gre_header_t) + sizeof (ip4_header_t);
373 vec_validate (im6->fib_index_by_sw_if_index, sw_if_index);
374 hi->min_packet_bytes =
375 64 + sizeof (gre_header_t) + sizeof (ip6_header_t);
378 hi->per_packet_overhead_bytes =
379 /* preamble */ 8 + /* inter frame gap */ 12;
381 /* Standard default gre MTU. */
382 hi->max_l3_packet_bytes[VLIB_RX] = hi->max_l3_packet_bytes[VLIB_TX] = 9000;
385 * source the FIB entry for the tunnel's destination
386 * and become a child thereof. The tunnel will then get poked
387 * when the forwarding for the entry updates, and the tunnel can
388 * re-stack accordingly
391 clib_memcpy (&t->tunnel_src, &a->src, sizeof (t->tunnel_src));
392 t->tunnel_dst.fp_len = !is_ipv6 ? 32 : 128;
393 t->tunnel_dst.fp_proto = !is_ipv6 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
394 t->tunnel_dst.fp_addr = a->dst;
396 gre_tunnel_db_add (t, &key);
399 fib_table_entry_special_add (outer_fib_index,
401 FIB_SOURCE_RR, FIB_ENTRY_FLAG_NONE);
403 fib_entry_child_add (t->fib_entry_index,
404 FIB_NODE_TYPE_GRE_TUNNEL, t - gm->tunnels);
406 if (GRE_TUNNEL_TYPE_TEB == t->type)
408 t->l2_adj_index = adj_nbr_add_or_lock (t->tunnel_dst.fp_proto,
410 &zero_addr, sw_if_index);
411 gre_update_adj (vnm, t->sw_if_index, t->l2_adj_index);
415 *sw_if_indexp = sw_if_index;
421 vnet_gre_tunnel_delete (vnet_gre_add_del_tunnel_args_t * a,
424 gre_main_t *gm = &gre_main;
425 vnet_main_t *vnm = gm->vnet_main;
427 gre_tunnel_key_t key;
432 outer_fib_index = ip4_fib_index_from_table_id (a->outer_fib_id);
434 outer_fib_index = ip6_fib_index_from_table_id (a->outer_fib_id);
436 if (~0 == outer_fib_index)
437 return VNET_API_ERROR_NO_SUCH_FIB;
440 gre_tunnel_db_find (&a->src, &a->dst, outer_fib_index, a->is_ipv6, &key);
443 return VNET_API_ERROR_NO_SUCH_ENTRY;
445 sw_if_index = t->sw_if_index;
446 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
447 /* make sure tunnel is removed from l2 bd or xconnect */
448 set_int_l2_mode (gm->vlib_main, vnm, MODE_L3, sw_if_index, 0, 0, 0, 0);
449 vec_add1 (gm->free_gre_tunnel_hw_if_indices[t->type], t->hw_if_index);
450 gm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
452 if (GRE_TUNNEL_TYPE_TEB == t->type)
453 adj_unlock (t->l2_adj_index);
455 if (t->l2_adj_index != ADJ_INDEX_INVALID)
456 adj_unlock (t->l2_adj_index);
458 fib_entry_child_remove (t->fib_entry_index, t->sibling_index);
459 fib_table_entry_delete_index (t->fib_entry_index, FIB_SOURCE_RR);
461 gre_tunnel_db_remove (t);
462 fib_node_deinit (&t->node);
463 pool_put (gm->tunnels, t);
466 *sw_if_indexp = sw_if_index;
472 vnet_gre_add_del_tunnel (vnet_gre_add_del_tunnel_args_t * a,
476 return (vnet_gre_tunnel_add (a, sw_if_indexp));
478 return (vnet_gre_tunnel_delete (a, sw_if_indexp));
482 gre_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
484 gre_main_t *gm = &gre_main;
485 vnet_hw_interface_t *hi;
489 hi = vnet_get_hw_interface (vnm, hw_if_index);
491 if (NULL == gm->tunnel_index_by_sw_if_index ||
492 hi->sw_if_index >= vec_len (gm->tunnel_index_by_sw_if_index))
495 ti = gm->tunnel_index_by_sw_if_index[hi->sw_if_index];
498 /* not one of ours */
501 t = pool_elt_at_index (gm->tunnels, ti);
503 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
504 vnet_hw_interface_set_flags (vnm, hw_if_index,
505 VNET_HW_INTERFACE_FLAG_LINK_UP);
507 vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */ );
509 gre_tunnel_restack (t);
511 return /* no error */ 0;
514 static clib_error_t *
515 create_gre_tunnel_command_fn (vlib_main_t * vm,
516 unformat_input_t * input,
517 vlib_cli_command_t * cmd)
519 unformat_input_t _line_input, *line_input = &_line_input;
520 vnet_gre_add_del_tunnel_args_t _a, *a = &_a;
521 ip46_address_t src, dst;
522 u32 outer_fib_id = 0;
528 clib_error_t *error = NULL;
532 /* Get a line of input. */
533 if (!unformat_user (input, unformat_line_input, line_input))
536 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
538 if (unformat (line_input, "del"))
541 if (unformat (line_input, "src %U", unformat_ip4_address, &src.ip4))
547 if (unformat (line_input, "dst %U", unformat_ip4_address, &dst.ip4))
553 if (unformat (line_input, "src %U", unformat_ip6_address, &src.ip6))
559 if (unformat (line_input, "dst %U", unformat_ip6_address, &dst.ip6))
564 else if (unformat (line_input, "outer-fib-id %d", &outer_fib_id))
566 else if (unformat (line_input, "teb"))
570 error = clib_error_return (0, "unknown input `%U'",
571 format_unformat_error, line_input);
578 error = clib_error_return (0, "mandatory argument(s) missing");
582 if ((ipv4_set && memcmp (&src.ip4, &dst.ip4, sizeof (src.ip4)) == 0) ||
583 (ipv6_set && memcmp (&src.ip6, &dst.ip6, sizeof (src.ip6)) == 0))
585 error = clib_error_return (0, "src and dst are identical");
589 if (ipv4_set && ipv6_set)
590 return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
592 if ((ipv4_set && memcmp (&dst.ip4, &zero_addr.ip4, sizeof (dst.ip4)) == 0)
594 && memcmp (&dst.ip6, &zero_addr.ip6, sizeof (dst.ip6)) == 0))
596 error = clib_error_return (0, "dst address cannot be zero");
600 memset (a, 0, sizeof (*a));
601 a->outer_fib_id = outer_fib_id;
603 a->is_ipv6 = ipv6_set;
606 clib_memcpy (&a->src.ip4, &src.ip4, sizeof (src.ip4));
607 clib_memcpy (&a->dst.ip4, &dst.ip4, sizeof (dst.ip4));
611 clib_memcpy (&a->src.ip6, &src.ip6, sizeof (src.ip6));
612 clib_memcpy (&a->dst.ip6, &dst.ip6, sizeof (dst.ip6));
616 rv = vnet_gre_tunnel_add (a, &sw_if_index);
618 rv = vnet_gre_tunnel_delete (a, &sw_if_index);
623 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
624 vnet_get_main (), sw_if_index);
626 case VNET_API_ERROR_INVALID_VALUE:
627 error = clib_error_return (0, "GRE tunnel already exists...");
629 case VNET_API_ERROR_NO_SUCH_FIB:
630 error = clib_error_return (0, "outer fib ID %d doesn't exist\n",
635 clib_error_return (0, "vnet_gre_add_del_tunnel returned %d", rv);
640 unformat_free (line_input);
646 VLIB_CLI_COMMAND (create_gre_tunnel_command, static) = {
647 .path = "create gre tunnel",
648 .short_help = "create gre tunnel src <addr> dst <addr> "
649 "[outer-fib-id <fib>] [teb] [del]",
650 .function = create_gre_tunnel_command_fn,
654 static clib_error_t *
655 show_gre_tunnel_command_fn (vlib_main_t * vm,
656 unformat_input_t * input,
657 vlib_cli_command_t * cmd)
659 gre_main_t *gm = &gre_main;
663 if (pool_elts (gm->tunnels) == 0)
664 vlib_cli_output (vm, "No GRE tunnels configured...");
666 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
668 if (unformat (input, "%d", &ti))
677 pool_foreach (t, gm->tunnels,
679 vlib_cli_output (vm, "%U", format_gre_tunnel, t);
685 t = pool_elt_at_index (gm->tunnels, ti);
687 vlib_cli_output (vm, "%U", format_gre_tunnel, t);
694 VLIB_CLI_COMMAND (show_gre_tunnel_command, static) = {
695 .path = "show gre tunnel",
696 .function = show_gre_tunnel_command_fn,
700 /* force inclusion from application's main.c */
702 gre_interface_init (vlib_main_t * vm)
704 fib_node_register_type (FIB_NODE_TYPE_GRE_TUNNEL, &gre_vft);
709 VLIB_INIT_FUNCTION (gre_interface_init);
712 * fd.io coding-style-patch-verification: ON
715 * eval: (c-set-style "gnu")