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>
27 #include <vnet/l2/l2_input.h>
29 static const char *gre_tunnel_type_names[] = GRE_TUNNEL_TYPE_NAMES;
32 format_gre_tunnel (u8 * s, va_list * args)
34 gre_tunnel_t *t = va_arg (*args, gre_tunnel_t *);
36 s = format (s, "[%d] instance %d src %U dst %U fib-idx %d sw-if-idx %d ",
37 t->dev_instance, t->user_instance,
38 format_ip46_address, &t->tunnel_src, IP46_TYPE_ANY,
39 format_ip46_address, &t->tunnel_dst.fp_addr, IP46_TYPE_ANY,
40 t->outer_fib_index, t->sw_if_index);
42 s = format (s, "payload %s ", gre_tunnel_type_names[t->type]);
44 if (t->type == GRE_TUNNEL_TYPE_ERSPAN)
45 s = format (s, "session %d ", t->session_id);
47 if (t->type != GRE_TUNNEL_TYPE_L3)
48 s = format (s, "l2-adj-idx %d ", t->l2_adj_index);
54 gre_tunnel_db_find (const vnet_gre_add_del_tunnel_args_t * a,
55 u32 outer_fib_index, gre_tunnel_key_t * key)
57 gre_main_t *gm = &gre_main;
62 gre_mk_key4 (a->src.ip4, a->dst.ip4, outer_fib_index,
63 a->tunnel_type, a->session_id, &key->gtk_v4);
64 p = hash_get_mem (gm->tunnel_by_key4, &key->gtk_v4);
68 gre_mk_key6 (&a->src.ip6, &a->dst.ip6, outer_fib_index,
69 a->tunnel_type, a->session_id, &key->gtk_v6);
70 p = hash_get_mem (gm->tunnel_by_key6, &key->gtk_v6);
76 return (pool_elt_at_index (gm->tunnels, p[0]));
80 gre_tunnel_db_add (gre_tunnel_t * t, gre_tunnel_key_t * key)
82 gre_main_t *gm = &gre_main;
84 t->key = clib_mem_alloc (sizeof (*t->key));
85 clib_memcpy (t->key, key, sizeof (*key));
87 if (t->tunnel_dst.fp_proto == FIB_PROTOCOL_IP6)
89 hash_set_mem (gm->tunnel_by_key6, &t->key->gtk_v6, t->dev_instance);
93 hash_set_mem (gm->tunnel_by_key4, &t->key->gtk_v4, t->dev_instance);
98 gre_tunnel_db_remove (gre_tunnel_t * t)
100 gre_main_t *gm = &gre_main;
102 if (t->tunnel_dst.fp_proto == FIB_PROTOCOL_IP6)
104 hash_unset_mem (gm->tunnel_by_key6, &t->key->gtk_v6);
108 hash_unset_mem (gm->tunnel_by_key4, &t->key->gtk_v4);
111 clib_mem_free (t->key);
115 static gre_tunnel_t *
116 gre_tunnel_from_fib_node (fib_node_t * node)
118 ASSERT (FIB_NODE_TYPE_GRE_TUNNEL == node->fn_type);
119 return ((gre_tunnel_t *) (((char *) node) -
120 STRUCT_OFFSET_OF (gre_tunnel_t, node)));
126 * 'stack' (resolve the recursion for) the tunnel's midchain adjacency
129 gre_tunnel_stack (adj_index_t ai)
131 gre_main_t *gm = &gre_main;
137 sw_if_index = adj->rewrite_header.sw_if_index;
139 if ((vec_len (gm->tunnel_index_by_sw_if_index) <= sw_if_index) ||
140 (~0 == gm->tunnel_index_by_sw_if_index[sw_if_index]))
143 gt = pool_elt_at_index (gm->tunnels,
144 gm->tunnel_index_by_sw_if_index[sw_if_index]);
146 if ((vnet_hw_interface_get_flags (vnet_get_main (), gt->hw_if_index) &
147 VNET_HW_INTERFACE_FLAG_LINK_UP) == 0)
149 adj_nbr_midchain_unstack (ai);
153 adj_nbr_midchain_stack_on_fib_entry (ai,
155 fib_forw_chain_type_from_fib_proto
156 (gt->tunnel_dst.fp_proto));
161 * @brief Call back when restacking all adjacencies on a GRE interface
164 gre_adj_walk_cb (adj_index_t ai, void *ctx)
166 gre_tunnel_stack (ai);
168 return (ADJ_WALK_RC_CONTINUE);
172 gre_tunnel_restack (gre_tunnel_t * gt)
174 fib_protocol_t proto;
177 * walk all the adjacencies on th GRE interface and restack them
179 FOR_EACH_FIB_IP_PROTOCOL (proto)
181 adj_nbr_walk (gt->sw_if_index, proto, gre_adj_walk_cb, NULL);
186 * Function definition to backwalk a FIB node
188 static fib_node_back_walk_rc_t
189 gre_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
191 gre_tunnel_restack (gre_tunnel_from_fib_node (node));
193 return (FIB_NODE_BACK_WALK_CONTINUE);
197 * Function definition to get a FIB node from its index
200 gre_tunnel_fib_node_get (fib_node_index_t index)
206 gt = pool_elt_at_index (gm->tunnels, index);
212 * Function definition to inform the FIB node that its last lock has gone.
215 gre_tunnel_last_lock_gone (fib_node_t * node)
218 * The MPLS GRE tunnel is a root of the graph. As such
219 * it never has children and thus is never locked.
225 * Virtual function table registered by MPLS GRE tunnels
226 * for participation in the FIB object graph.
228 const static fib_node_vft_t gre_vft = {
229 .fnv_get = gre_tunnel_fib_node_get,
230 .fnv_last_lock = gre_tunnel_last_lock_gone,
231 .fnv_back_walk = gre_tunnel_back_walk,
235 vnet_gre_tunnel_add (vnet_gre_add_del_tunnel_args_t * a,
236 u32 outer_fib_index, u32 * sw_if_indexp)
238 gre_main_t *gm = &gre_main;
239 vnet_main_t *vnm = gm->vnet_main;
240 ip4_main_t *im4 = &ip4_main;
241 ip6_main_t *im6 = &ip6_main;
243 vnet_hw_interface_t *hi;
244 u32 hw_if_index, sw_if_index;
246 u8 is_ipv6 = a->is_ipv6;
247 gre_tunnel_key_t key;
249 t = gre_tunnel_db_find (a, outer_fib_index, &key);
251 return VNET_API_ERROR_IF_ALREADY_EXISTS;
253 pool_get_aligned (gm->tunnels, t, CLIB_CACHE_LINE_BYTES);
254 clib_memset (t, 0, sizeof (*t));
256 /* Reconcile the real dev_instance and a possible requested instance */
257 u32 t_idx = t - gm->tunnels; /* tunnel index (or instance) */
258 u32 u_idx = a->instance; /* user specified instance */
261 if (hash_get (gm->instance_used, u_idx))
263 pool_put (gm->tunnels, t);
264 return VNET_API_ERROR_INSTANCE_IN_USE;
266 hash_set (gm->instance_used, u_idx, 1);
268 t->dev_instance = t_idx; /* actual */
269 t->user_instance = u_idx; /* name */
270 fib_node_init (&t->node, FIB_NODE_TYPE_GRE_TUNNEL);
272 t->type = a->tunnel_type;
273 if (t->type == GRE_TUNNEL_TYPE_ERSPAN)
274 t->session_id = a->session_id;
276 if (t->type == GRE_TUNNEL_TYPE_L3)
277 hw_if_index = vnet_register_interface (vnm, gre_device_class.index, t_idx,
278 gre_hw_interface_class.index,
282 /* Default MAC address (d00b:eed0:0000 + sw_if_index) */
284 { 0xd0, 0x0b, 0xee, 0xd0, (u8) (t_idx >> 8), (u8) t_idx };
286 ethernet_register_interface (vnm, gre_device_class.index, t_idx,
287 address, &hw_if_index, 0);
290 clib_error_report (error);
291 return VNET_API_ERROR_INVALID_REGISTRATION;
295 /* Set GRE tunnel interface output node (not used for L3 payload) */
296 vnet_set_interface_output_node (vnm, hw_if_index, gre_encap_node.index);
298 hi = vnet_get_hw_interface (vnm, hw_if_index);
299 sw_if_index = hi->sw_if_index;
301 t->hw_if_index = hw_if_index;
302 t->outer_fib_index = outer_fib_index;
303 t->sw_if_index = sw_if_index;
304 t->l2_adj_index = ADJ_INDEX_INVALID;
306 vec_validate_init_empty (gm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
307 gm->tunnel_index_by_sw_if_index[sw_if_index] = t_idx;
311 vec_validate (im4->fib_index_by_sw_if_index, sw_if_index);
312 hi->min_packet_bytes =
313 64 + sizeof (gre_header_t) + sizeof (ip4_header_t);
317 vec_validate (im6->fib_index_by_sw_if_index, sw_if_index);
318 hi->min_packet_bytes =
319 64 + sizeof (gre_header_t) + sizeof (ip6_header_t);
322 /* Standard default gre MTU. */
323 vnet_sw_interface_set_mtu (vnm, sw_if_index, 9000);
326 * source the FIB entry for the tunnel's destination
327 * and become a child thereof. The tunnel will then get poked
328 * when the forwarding for the entry updates, and the tunnel can
329 * re-stack accordingly
332 clib_memcpy (&t->tunnel_src, &a->src, sizeof (t->tunnel_src));
333 t->tunnel_dst.fp_len = !is_ipv6 ? 32 : 128;
334 t->tunnel_dst.fp_proto = !is_ipv6 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
335 t->tunnel_dst.fp_addr = a->dst;
337 gre_tunnel_db_add (t, &key);
338 if (t->type == GRE_TUNNEL_TYPE_ERSPAN)
343 gre_mk_sn_key (t, &skey);
344 gre_sn = (gre_sn_t *) hash_get_mem (gm->seq_num_by_key, &skey);
352 gre_sn = clib_mem_alloc (sizeof (gre_sn_t));
354 gre_sn->ref_count = 1;
356 hash_set_mem_alloc (&gm->seq_num_by_key, &skey, (uword) gre_sn);
360 t->fib_entry_index = fib_table_entry_special_add
361 (outer_fib_index, &t->tunnel_dst, FIB_SOURCE_RR, FIB_ENTRY_FLAG_NONE);
362 t->sibling_index = fib_entry_child_add
363 (t->fib_entry_index, FIB_NODE_TYPE_GRE_TUNNEL, t_idx);
365 if (t->type != GRE_TUNNEL_TYPE_L3)
367 t->l2_adj_index = adj_nbr_add_or_lock
368 (t->tunnel_dst.fp_proto, VNET_LINK_ETHERNET, &zero_addr, sw_if_index);
369 gre_update_adj (vnm, t->sw_if_index, t->l2_adj_index);
373 *sw_if_indexp = sw_if_index;
379 vnet_gre_tunnel_delete (vnet_gre_add_del_tunnel_args_t * a,
380 u32 outer_fib_index, u32 * sw_if_indexp)
382 gre_main_t *gm = &gre_main;
383 vnet_main_t *vnm = gm->vnet_main;
385 gre_tunnel_key_t key;
388 t = gre_tunnel_db_find (a, outer_fib_index, &key);
390 return VNET_API_ERROR_NO_SUCH_ENTRY;
392 sw_if_index = t->sw_if_index;
393 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
395 /* make sure tunnel is removed from l2 bd or xconnect */
396 set_int_l2_mode (gm->vlib_main, vnm, MODE_L3, sw_if_index, 0,
397 L2_BD_PORT_TYPE_NORMAL, 0, 0);
398 gm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
400 if (t->type == GRE_TUNNEL_TYPE_L3)
401 vnet_delete_hw_interface (vnm, t->hw_if_index);
403 ethernet_delete_interface (vnm, t->hw_if_index);
405 if (t->l2_adj_index != ADJ_INDEX_INVALID)
406 adj_unlock (t->l2_adj_index);
408 fib_entry_child_remove (t->fib_entry_index, t->sibling_index);
409 fib_table_entry_delete_index (t->fib_entry_index, FIB_SOURCE_RR);
411 ASSERT ((t->type != GRE_TUNNEL_TYPE_ERSPAN) || (t->gre_sn != NULL));
412 if ((t->type == GRE_TUNNEL_TYPE_ERSPAN) && (t->gre_sn->ref_count-- == 1))
415 gre_mk_sn_key (t, &skey);
416 hash_unset_mem_free (&gm->seq_num_by_key, &skey);
417 clib_mem_free (t->gre_sn);
420 hash_unset (gm->instance_used, t->user_instance);
421 gre_tunnel_db_remove (t);
422 fib_node_deinit (&t->node);
423 pool_put (gm->tunnels, t);
426 *sw_if_indexp = sw_if_index;
432 vnet_gre_add_del_tunnel (vnet_gre_add_del_tunnel_args_t * a,
438 outer_fib_index = ip4_fib_index_from_table_id (a->outer_fib_id);
440 outer_fib_index = ip6_fib_index_from_table_id (a->outer_fib_id);
442 if (~0 == outer_fib_index)
443 return VNET_API_ERROR_NO_SUCH_FIB;
445 if (a->session_id > GTK_SESSION_ID_MAX)
446 return VNET_API_ERROR_INVALID_SESSION_ID;
449 return (vnet_gre_tunnel_add (a, outer_fib_index, sw_if_indexp));
451 return (vnet_gre_tunnel_delete (a, outer_fib_index, sw_if_indexp));
455 gre_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
457 gre_main_t *gm = &gre_main;
458 vnet_hw_interface_t *hi;
462 hi = vnet_get_hw_interface (vnm, hw_if_index);
464 if (NULL == gm->tunnel_index_by_sw_if_index ||
465 hi->sw_if_index >= vec_len (gm->tunnel_index_by_sw_if_index))
468 ti = gm->tunnel_index_by_sw_if_index[hi->sw_if_index];
471 /* not one of ours */
474 t = pool_elt_at_index (gm->tunnels, ti);
476 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
477 vnet_hw_interface_set_flags (vnm, hw_if_index,
478 VNET_HW_INTERFACE_FLAG_LINK_UP);
480 vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */ );
482 gre_tunnel_restack (t);
484 return /* no error */ 0;
487 static clib_error_t *
488 create_gre_tunnel_command_fn (vlib_main_t * vm,
489 unformat_input_t * input,
490 vlib_cli_command_t * cmd)
492 unformat_input_t _line_input, *line_input = &_line_input;
493 vnet_gre_add_del_tunnel_args_t _a, *a = &_a;
494 ip46_address_t src, dst;
496 u32 outer_fib_id = 0;
497 gre_tunnel_type_t t_type = GRE_TUNNEL_TYPE_L3;
503 clib_error_t *error = NULL;
507 /* Get a line of input. */
508 if (!unformat_user (input, unformat_line_input, line_input))
511 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
513 if (unformat (line_input, "del"))
515 else if (unformat (line_input, "instance %d", &instance))
518 if (unformat (line_input, "src %U", unformat_ip4_address, &src.ip4))
524 if (unformat (line_input, "dst %U", unformat_ip4_address, &dst.ip4))
530 if (unformat (line_input, "src %U", unformat_ip6_address, &src.ip6))
536 if (unformat (line_input, "dst %U", unformat_ip6_address, &dst.ip6))
541 else if (unformat (line_input, "outer-fib-id %d", &outer_fib_id))
543 else if (unformat (line_input, "teb"))
544 t_type = GRE_TUNNEL_TYPE_TEB;
545 else if (unformat (line_input, "erspan %d", &session_id))
546 t_type = GRE_TUNNEL_TYPE_ERSPAN;
549 error = clib_error_return (0, "unknown input `%U'",
550 format_unformat_error, line_input);
557 error = clib_error_return (0, "mandatory argument(s) missing");
561 if ((ipv4_set && memcmp (&src.ip4, &dst.ip4, sizeof (src.ip4)) == 0) ||
562 (ipv6_set && memcmp (&src.ip6, &dst.ip6, sizeof (src.ip6)) == 0))
564 error = clib_error_return (0, "src and dst are identical");
568 if (ipv4_set && ipv6_set)
569 return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
571 if ((ipv4_set && memcmp (&dst.ip4, &zero_addr.ip4, sizeof (dst.ip4)) == 0)
573 && memcmp (&dst.ip6, &zero_addr.ip6, sizeof (dst.ip6)) == 0))
575 error = clib_error_return (0, "dst address cannot be zero");
579 clib_memset (a, 0, sizeof (*a));
581 a->outer_fib_id = outer_fib_id;
582 a->tunnel_type = t_type;
583 a->session_id = session_id;
584 a->is_ipv6 = ipv6_set;
585 a->instance = instance;
588 clib_memcpy (&a->src.ip4, &src.ip4, sizeof (src.ip4));
589 clib_memcpy (&a->dst.ip4, &dst.ip4, sizeof (dst.ip4));
593 clib_memcpy (&a->src.ip6, &src.ip6, sizeof (src.ip6));
594 clib_memcpy (&a->dst.ip6, &dst.ip6, sizeof (dst.ip6));
597 rv = vnet_gre_add_del_tunnel (a, &sw_if_index);
602 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
603 vnet_get_main (), sw_if_index);
605 case VNET_API_ERROR_IF_ALREADY_EXISTS:
606 error = clib_error_return (0, "GRE tunnel already exists...");
608 case VNET_API_ERROR_NO_SUCH_FIB:
609 error = clib_error_return (0, "outer fib ID %d doesn't exist\n",
612 case VNET_API_ERROR_NO_SUCH_ENTRY:
613 error = clib_error_return (0, "GRE tunnel doesn't exist");
615 case VNET_API_ERROR_INVALID_SESSION_ID:
616 error = clib_error_return (0, "session ID %d out of range\n",
619 case VNET_API_ERROR_INSTANCE_IN_USE:
620 error = clib_error_return (0, "Instance is in use");
624 clib_error_return (0, "vnet_gre_add_del_tunnel returned %d", rv);
629 unformat_free (line_input);
635 VLIB_CLI_COMMAND (create_gre_tunnel_command, static) = {
636 .path = "create gre tunnel",
637 .short_help = "create gre tunnel src <addr> dst <addr> [instance <n>] "
638 "[outer-fib-id <fib>] [teb | erspan <session-id>] [del]",
639 .function = create_gre_tunnel_command_fn,
643 static clib_error_t *
644 show_gre_tunnel_command_fn (vlib_main_t * vm,
645 unformat_input_t * input,
646 vlib_cli_command_t * cmd)
648 gre_main_t *gm = &gre_main;
652 if (pool_elts (gm->tunnels) == 0)
653 vlib_cli_output (vm, "No GRE tunnels configured...");
655 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
657 if (unformat (input, "%d", &ti))
666 pool_foreach (t, gm->tunnels,
668 vlib_cli_output (vm, "%U", format_gre_tunnel, t);
674 t = pool_elt_at_index (gm->tunnels, ti);
676 vlib_cli_output (vm, "%U", format_gre_tunnel, t);
683 VLIB_CLI_COMMAND (show_gre_tunnel_command, static) = {
684 .path = "show gre tunnel",
685 .function = show_gre_tunnel_command_fn,
689 /* force inclusion from application's main.c */
691 gre_interface_init (vlib_main_t * vm)
693 fib_node_register_type (FIB_NODE_TYPE_GRE_TUNNEL, &gre_vft);
698 VLIB_INIT_FUNCTION (gre_interface_init);
701 * fd.io coding-style-patch-verification: ON
704 * eval: (c-set-style "gnu")