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>
28 #include <vnet/nhrp/nhrp.h>
31 format_gre_tunnel_type (u8 * s, va_list * args)
33 gre_tunnel_type_t type = va_arg (*args, int);
37 #define _(n, v) case GRE_TUNNEL_TYPE_##n: \
38 s = format (s, "%s", v); \
40 foreach_gre_tunnel_type
48 format_gre_tunnel (u8 * s, va_list * args)
50 gre_tunnel_t *t = va_arg (*args, gre_tunnel_t *);
52 s = format (s, "[%d] instance %d src %U dst %U fib-idx %d sw-if-idx %d ",
53 t->dev_instance, t->user_instance,
54 format_ip46_address, &t->tunnel_src, IP46_TYPE_ANY,
55 format_ip46_address, &t->tunnel_dst.fp_addr, IP46_TYPE_ANY,
56 t->outer_fib_index, t->sw_if_index);
58 s = format (s, "payload %U ", format_gre_tunnel_type, t->type);
59 s = format (s, "%U ", format_tunnel_mode, t->mode);
61 if (t->type == GRE_TUNNEL_TYPE_ERSPAN)
62 s = format (s, "session %d ", t->session_id);
64 if (t->type != GRE_TUNNEL_TYPE_L3)
65 s = format (s, "l2-adj-idx %d ", t->l2_adj_index);
71 gre_tunnel_db_find (const vnet_gre_tunnel_add_del_args_t * a,
72 u32 outer_fib_index, gre_tunnel_key_t * key)
74 gre_main_t *gm = &gre_main;
79 gre_mk_key4 (a->src.ip4, a->dst.ip4, outer_fib_index,
80 a->type, a->mode, a->session_id, &key->gtk_v4);
81 p = hash_get_mem (gm->tunnel_by_key4, &key->gtk_v4);
85 gre_mk_key6 (&a->src.ip6, &a->dst.ip6, outer_fib_index,
86 a->type, a->mode, a->session_id, &key->gtk_v6);
87 p = hash_get_mem (gm->tunnel_by_key6, &key->gtk_v6);
93 return (pool_elt_at_index (gm->tunnels, p[0]));
97 gre_tunnel_db_add (gre_tunnel_t * t, gre_tunnel_key_t * key)
99 gre_main_t *gm = &gre_main;
101 if (t->tunnel_dst.fp_proto == FIB_PROTOCOL_IP6)
103 hash_set_mem_alloc (&gm->tunnel_by_key6, &key->gtk_v6, t->dev_instance);
107 hash_set_mem_alloc (&gm->tunnel_by_key4, &key->gtk_v4, t->dev_instance);
112 gre_tunnel_db_remove (gre_tunnel_t * t, gre_tunnel_key_t * key)
114 gre_main_t *gm = &gre_main;
116 if (t->tunnel_dst.fp_proto == FIB_PROTOCOL_IP6)
118 hash_unset_mem_free (&gm->tunnel_by_key6, &key->gtk_v6);
122 hash_unset_mem_free (&gm->tunnel_by_key4, &key->gtk_v4);
129 * 'stack' (resolve the recursion for) the tunnel's midchain adjacency
132 gre_tunnel_stack (adj_index_t ai)
134 gre_main_t *gm = &gre_main;
140 sw_if_index = adj->rewrite_header.sw_if_index;
142 if ((vec_len (gm->tunnel_index_by_sw_if_index) <= sw_if_index) ||
143 (~0 == gm->tunnel_index_by_sw_if_index[sw_if_index]))
146 gt = pool_elt_at_index (gm->tunnels,
147 gm->tunnel_index_by_sw_if_index[sw_if_index]);
149 if ((vnet_hw_interface_get_flags (vnet_get_main (), gt->hw_if_index) &
150 VNET_HW_INTERFACE_FLAG_LINK_UP) == 0)
152 adj_midchain_delegate_unstack (ai);
156 adj_midchain_delegate_stack (ai, gt->outer_fib_index, >->tunnel_dst);
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 gre_nhrp_mk_key (const gre_tunnel_t * t,
187 const nhrp_entry_t * ne, gre_tunnel_key_t * key)
189 const fib_prefix_t *nh;
191 nh = nhrp_entry_get_nh (ne);
193 /* construct the key using mode P2P so it can be found in the DP */
194 if (FIB_PROTOCOL_IP4 == nh->fp_proto)
195 gre_mk_key4 (t->tunnel_src.ip4,
197 nhrp_entry_get_fib_index (ne),
198 t->type, TUNNEL_MODE_P2P, 0, &key->gtk_v4);
200 gre_mk_key6 (&t->tunnel_src.ip6,
202 nhrp_entry_get_fib_index (ne),
203 t->type, TUNNEL_MODE_P2P, 0, &key->gtk_v6);
207 * An NHRP entry has been added
210 gre_nhrp_entry_added (const nhrp_entry_t * ne)
212 gre_main_t *gm = &gre_main;
213 const ip46_address_t *nh;
214 gre_tunnel_key_t key;
219 sw_if_index = nhrp_entry_get_sw_if_index (ne);
220 if (vec_len (gm->tunnel_index_by_sw_if_index) < sw_if_index)
223 t_idx = gm->tunnel_index_by_sw_if_index[sw_if_index];
225 if (INDEX_INVALID == t_idx)
228 /* entry has been added on an interface for which there is a GRE tunnel */
229 t = pool_elt_at_index (gm->tunnels, t_idx);
231 if (t->mode != TUNNEL_MODE_MP)
234 /* the next-hop (underlay) of the NHRP entry will form part of the key for
235 * ingress lookup to match packets to this interface */
236 gre_nhrp_mk_key (t, ne, &key);
237 gre_tunnel_db_add (t, &key);
239 /* update the rewrites for each of the adjacencies for this peer (overlay)
240 * using the next-hop (underlay) */
241 mgre_walk_ctx_t ctx = {
245 nh = nhrp_entry_get_peer (ne);
246 adj_nbr_walk_nh (nhrp_entry_get_sw_if_index (ne),
247 (ip46_address_is_ip4 (nh) ?
249 FIB_PROTOCOL_IP6), nh, mgre_mk_complete_walk, &ctx);
253 gre_nhrp_entry_deleted (const nhrp_entry_t * ne)
255 gre_main_t *gm = &gre_main;
256 const ip46_address_t *nh;
257 gre_tunnel_key_t key;
262 sw_if_index = nhrp_entry_get_sw_if_index (ne);
263 if (vec_len (gm->tunnel_index_by_sw_if_index) < sw_if_index)
266 t_idx = gm->tunnel_index_by_sw_if_index[sw_if_index];
268 if (INDEX_INVALID == t_idx)
271 t = pool_elt_at_index (gm->tunnels, t_idx);
273 /* remove the next-hop as an ingress lookup key */
274 gre_nhrp_mk_key (t, ne, &key);
275 gre_tunnel_db_remove (t, &key);
277 nh = nhrp_entry_get_peer (ne);
279 /* make all the adjacencies incomplete */
280 adj_nbr_walk_nh (nhrp_entry_get_sw_if_index (ne),
281 (ip46_address_is_ip4 (nh) ?
283 FIB_PROTOCOL_IP6), nh, mgre_mk_incomplete_walk, t);
287 gre_tunnel_delete_nhrp_walk (index_t nei, void *ctx)
289 gre_tunnel_t *t = ctx;
290 gre_tunnel_key_t key;
292 gre_nhrp_mk_key (t, nhrp_entry_get (nei), &key);
293 gre_tunnel_db_remove (t, &key);
295 return (WALK_CONTINUE);
299 gre_tunnel_add_nhrp_walk (index_t nei, void *ctx)
301 gre_tunnel_t *t = ctx;
302 gre_tunnel_key_t key;
304 gre_nhrp_mk_key (t, nhrp_entry_get (nei), &key);
305 gre_tunnel_db_add (t, &key);
307 return (WALK_CONTINUE);
311 vnet_gre_tunnel_add (vnet_gre_tunnel_add_del_args_t * a,
312 u32 outer_fib_index, u32 * sw_if_indexp)
314 gre_main_t *gm = &gre_main;
315 vnet_main_t *vnm = gm->vnet_main;
316 ip4_main_t *im4 = &ip4_main;
317 ip6_main_t *im6 = &ip6_main;
319 vnet_hw_interface_t *hi;
320 u32 hw_if_index, sw_if_index;
322 u8 is_ipv6 = a->is_ipv6;
323 gre_tunnel_key_t key;
325 t = gre_tunnel_db_find (a, outer_fib_index, &key);
327 return VNET_API_ERROR_IF_ALREADY_EXISTS;
329 pool_get_aligned (gm->tunnels, t, CLIB_CACHE_LINE_BYTES);
330 clib_memset (t, 0, sizeof (*t));
332 /* Reconcile the real dev_instance and a possible requested instance */
333 u32 t_idx = t - gm->tunnels; /* tunnel index (or instance) */
334 u32 u_idx = a->instance; /* user specified instance */
337 if (hash_get (gm->instance_used, u_idx))
339 pool_put (gm->tunnels, t);
340 return VNET_API_ERROR_INSTANCE_IN_USE;
342 hash_set (gm->instance_used, u_idx, 1);
344 t->dev_instance = t_idx; /* actual */
345 t->user_instance = u_idx; /* name */
349 if (t->type == GRE_TUNNEL_TYPE_ERSPAN)
350 t->session_id = a->session_id;
352 if (t->type == GRE_TUNNEL_TYPE_L3)
354 if (t->mode == TUNNEL_MODE_P2P)
356 vnet_register_interface (vnm, gre_device_class.index, t_idx,
357 gre_hw_interface_class.index, t_idx);
360 vnet_register_interface (vnm, gre_device_class.index, t_idx,
361 mgre_hw_interface_class.index, t_idx);
365 /* Default MAC address (d00b:eed0:0000 + sw_if_index) */
367 { 0xd0, 0x0b, 0xee, 0xd0, (u8) (t_idx >> 8), (u8) t_idx };
369 ethernet_register_interface (vnm, gre_device_class.index, t_idx,
370 address, &hw_if_index, 0);
373 clib_error_report (error);
374 return VNET_API_ERROR_INVALID_REGISTRATION;
378 /* Set GRE tunnel interface output node (not used for L3 payload) */
379 vnet_set_interface_output_node (vnm, hw_if_index, gre_encap_node.index);
381 hi = vnet_get_hw_interface (vnm, hw_if_index);
382 sw_if_index = hi->sw_if_index;
384 t->hw_if_index = hw_if_index;
385 t->outer_fib_index = outer_fib_index;
386 t->sw_if_index = sw_if_index;
387 t->l2_adj_index = ADJ_INDEX_INVALID;
389 vec_validate_init_empty (gm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
390 gm->tunnel_index_by_sw_if_index[sw_if_index] = t_idx;
394 vec_validate (im4->fib_index_by_sw_if_index, sw_if_index);
395 hi->min_packet_bytes =
396 64 + sizeof (gre_header_t) + sizeof (ip4_header_t);
400 vec_validate (im6->fib_index_by_sw_if_index, sw_if_index);
401 hi->min_packet_bytes =
402 64 + sizeof (gre_header_t) + sizeof (ip6_header_t);
405 /* Standard default gre MTU. */
406 vnet_sw_interface_set_mtu (vnm, sw_if_index, 9000);
409 * source the FIB entry for the tunnel's destination
410 * and become a child thereof. The tunnel will then get poked
411 * when the forwarding for the entry updates, and the tunnel can
412 * re-stack accordingly
415 clib_memcpy (&t->tunnel_src, &a->src, sizeof (t->tunnel_src));
416 t->tunnel_dst.fp_len = !is_ipv6 ? 32 : 128;
417 t->tunnel_dst.fp_proto = !is_ipv6 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
418 t->tunnel_dst.fp_addr = a->dst;
420 gre_tunnel_db_add (t, &key);
422 if (t->mode == TUNNEL_MODE_MP)
423 nhrp_walk_itf (t->sw_if_index, gre_tunnel_add_nhrp_walk, t);
425 if (t->type == GRE_TUNNEL_TYPE_ERSPAN)
430 gre_mk_sn_key (t, &skey);
431 gre_sn = (gre_sn_t *) hash_get_mem (gm->seq_num_by_key, &skey);
439 gre_sn = clib_mem_alloc (sizeof (gre_sn_t));
441 gre_sn->ref_count = 1;
443 hash_set_mem_alloc (&gm->seq_num_by_key, &skey, (uword) gre_sn);
447 if (t->type != GRE_TUNNEL_TYPE_L3)
449 t->l2_adj_index = adj_nbr_add_or_lock
450 (t->tunnel_dst.fp_proto, VNET_LINK_ETHERNET, &zero_addr, sw_if_index);
451 gre_update_adj (vnm, t->sw_if_index, t->l2_adj_index);
455 *sw_if_indexp = sw_if_index;
457 /* register gre46-input nodes */
458 ip4_register_protocol (IP_PROTOCOL_GRE, gre4_input_node.index);
459 ip6_register_protocol (IP_PROTOCOL_GRE, gre6_input_node.index);
465 vnet_gre_tunnel_delete (vnet_gre_tunnel_add_del_args_t * a,
466 u32 outer_fib_index, u32 * sw_if_indexp)
468 gre_main_t *gm = &gre_main;
469 vnet_main_t *vnm = gm->vnet_main;
471 gre_tunnel_key_t key;
474 t = gre_tunnel_db_find (a, outer_fib_index, &key);
476 return VNET_API_ERROR_NO_SUCH_ENTRY;
478 if (t->mode == TUNNEL_MODE_MP)
479 nhrp_walk_itf (t->sw_if_index, gre_tunnel_delete_nhrp_walk, t);
481 sw_if_index = t->sw_if_index;
482 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
484 /* make sure tunnel is removed from l2 bd or xconnect */
485 set_int_l2_mode (gm->vlib_main, vnm, MODE_L3, sw_if_index, 0,
486 L2_BD_PORT_TYPE_NORMAL, 0, 0);
487 gm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
489 if (t->type == GRE_TUNNEL_TYPE_L3)
490 vnet_delete_hw_interface (vnm, t->hw_if_index);
492 ethernet_delete_interface (vnm, t->hw_if_index);
494 if (t->l2_adj_index != ADJ_INDEX_INVALID)
496 adj_midchain_delegate_unstack (t->l2_adj_index);
497 adj_unlock (t->l2_adj_index);
500 ASSERT ((t->type != GRE_TUNNEL_TYPE_ERSPAN) || (t->gre_sn != NULL));
501 if ((t->type == GRE_TUNNEL_TYPE_ERSPAN) && (t->gre_sn->ref_count-- == 1))
504 gre_mk_sn_key (t, &skey);
505 hash_unset_mem_free (&gm->seq_num_by_key, &skey);
506 clib_mem_free (t->gre_sn);
509 hash_unset (gm->instance_used, t->user_instance);
510 gre_tunnel_db_remove (t, &key);
511 pool_put (gm->tunnels, t);
514 *sw_if_indexp = sw_if_index;
520 vnet_gre_tunnel_add_del (vnet_gre_tunnel_add_del_args_t * a,
526 outer_fib_index = ip4_fib_index_from_table_id (a->outer_table_id);
528 outer_fib_index = ip6_fib_index_from_table_id (a->outer_table_id);
530 if (~0 == outer_fib_index)
531 return VNET_API_ERROR_NO_SUCH_FIB;
533 if (a->session_id > GTK_SESSION_ID_MAX)
534 return VNET_API_ERROR_INVALID_SESSION_ID;
536 if (a->mode == TUNNEL_MODE_MP && !ip46_address_is_zero (&a->dst))
537 return (VNET_API_ERROR_INVALID_DST_ADDRESS);
540 return (vnet_gre_tunnel_add (a, outer_fib_index, sw_if_indexp));
542 return (vnet_gre_tunnel_delete (a, outer_fib_index, sw_if_indexp));
546 gre_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
548 gre_main_t *gm = &gre_main;
549 vnet_hw_interface_t *hi;
553 hi = vnet_get_hw_interface (vnm, hw_if_index);
555 if (NULL == gm->tunnel_index_by_sw_if_index ||
556 hi->sw_if_index >= vec_len (gm->tunnel_index_by_sw_if_index))
559 ti = gm->tunnel_index_by_sw_if_index[hi->sw_if_index];
562 /* not one of ours */
565 t = pool_elt_at_index (gm->tunnels, ti);
567 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
568 vnet_hw_interface_set_flags (vnm, hw_if_index,
569 VNET_HW_INTERFACE_FLAG_LINK_UP);
571 vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */ );
573 gre_tunnel_restack (t);
575 return /* no error */ 0;
578 static clib_error_t *
579 create_gre_tunnel_command_fn (vlib_main_t * vm,
580 unformat_input_t * input,
581 vlib_cli_command_t * cmd)
583 unformat_input_t _line_input, *line_input = &_line_input;
584 vnet_gre_tunnel_add_del_args_t _a, *a = &_a;
585 ip46_address_t src = ip46_address_initializer, dst =
586 ip46_address_initializer;
588 u32 outer_table_id = 0;
589 gre_tunnel_type_t t_type = GRE_TUNNEL_TYPE_L3;
590 tunnel_mode_t t_mode = TUNNEL_MODE_P2P;
595 clib_error_t *error = NULL;
597 /* Get a line of input. */
598 if (!unformat_user (input, unformat_line_input, line_input))
601 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
603 if (unformat (line_input, "del"))
605 else if (unformat (line_input, "instance %d", &instance))
607 else if (unformat (line_input, "src %U", unformat_ip46_address, &src))
609 else if (unformat (line_input, "dst %U", unformat_ip46_address, &dst))
611 else if (unformat (line_input, "outer-table-id %d", &outer_table_id))
613 else if (unformat (line_input, "multipoint"))
614 t_mode = TUNNEL_MODE_MP;
615 else if (unformat (line_input, "teb"))
616 t_type = GRE_TUNNEL_TYPE_TEB;
617 else if (unformat (line_input, "erspan %d", &session_id))
618 t_type = GRE_TUNNEL_TYPE_ERSPAN;
621 error = clib_error_return (0, "unknown input `%U'",
622 format_unformat_error, line_input);
627 if (ip46_address_is_equal (&src, &dst))
629 error = clib_error_return (0, "src and dst are identical");
633 if (t_mode != TUNNEL_MODE_MP && ip46_address_is_zero (&dst))
635 error = clib_error_return (0, "destination address not specified");
639 if (ip46_address_is_zero (&src))
641 error = clib_error_return (0, "source address not specified");
645 if (ip46_address_is_ip4 (&src) != ip46_address_is_ip4 (&dst))
648 clib_error_return (0, "src and dst address must be the same AF");
652 clib_memset (a, 0, sizeof (*a));
654 a->outer_table_id = outer_table_id;
657 a->session_id = session_id;
658 a->is_ipv6 = !ip46_address_is_ip4 (&src);
659 a->instance = instance;
660 clib_memcpy (&a->src, &src, sizeof (a->src));
661 clib_memcpy (&a->dst, &dst, sizeof (a->dst));
663 rv = vnet_gre_tunnel_add_del (a, &sw_if_index);
668 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
669 vnet_get_main (), sw_if_index);
671 case VNET_API_ERROR_IF_ALREADY_EXISTS:
672 error = clib_error_return (0, "GRE tunnel already exists...");
674 case VNET_API_ERROR_NO_SUCH_FIB:
675 error = clib_error_return (0, "outer table ID %d doesn't exist\n",
678 case VNET_API_ERROR_NO_SUCH_ENTRY:
679 error = clib_error_return (0, "GRE tunnel doesn't exist");
681 case VNET_API_ERROR_INVALID_SESSION_ID:
682 error = clib_error_return (0, "session ID %d out of range\n",
685 case VNET_API_ERROR_INSTANCE_IN_USE:
686 error = clib_error_return (0, "Instance is in use");
690 clib_error_return (0, "vnet_gre_tunnel_add_del returned %d", rv);
695 unformat_free (line_input);
701 VLIB_CLI_COMMAND (create_gre_tunnel_command, static) = {
702 .path = "create gre tunnel",
703 .short_help = "create gre tunnel src <addr> dst <addr> [instance <n>] "
704 "[outer-fib-id <fib>] [teb | erspan <session-id>] [del]",
705 .function = create_gre_tunnel_command_fn,
709 static clib_error_t *
710 show_gre_tunnel_command_fn (vlib_main_t * vm,
711 unformat_input_t * input,
712 vlib_cli_command_t * cmd)
714 gre_main_t *gm = &gre_main;
718 if (pool_elts (gm->tunnels) == 0)
719 vlib_cli_output (vm, "No GRE tunnels configured...");
721 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
723 if (unformat (input, "%d", &ti))
732 pool_foreach (t, gm->tunnels,
734 vlib_cli_output (vm, "%U", format_gre_tunnel, t);
740 t = pool_elt_at_index (gm->tunnels, ti);
742 vlib_cli_output (vm, "%U", format_gre_tunnel, t);
749 VLIB_CLI_COMMAND (show_gre_tunnel_command, static) = {
750 .path = "show gre tunnel",
751 .function = show_gre_tunnel_command_fn,
755 const static nhrp_vft_t gre_nhrp_vft = {
756 .nv_added = gre_nhrp_entry_added,
757 .nv_deleted = gre_nhrp_entry_deleted,
760 /* force inclusion from application's main.c */
762 gre_interface_init (vlib_main_t * vm)
764 nhrp_register (&gre_nhrp_vft);
769 VLIB_INIT_FUNCTION (gre_interface_init);
772 * fd.io coding-style-patch-verification: ON
775 * eval: (c-set-style "gnu")