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/gre/gre.h>
20 #include <vnet/ip/format.h>
21 #include <vnet/fib/fib_table.h>
22 #include <vnet/adj/adj_midchain.h>
23 #include <vnet/adj/adj_nbr.h>
24 #include <vnet/mpls/mpls.h>
25 #include <vnet/l2/l2_input.h>
26 #include <vnet/teib/teib.h>
29 format_gre_tunnel_type (u8 * s, va_list * args)
31 gre_tunnel_type_t type = va_arg (*args, int);
35 #define _(n, v) case GRE_TUNNEL_TYPE_##n: \
36 s = format (s, "%s", v); \
38 foreach_gre_tunnel_type
46 format_gre_tunnel (u8 * s, va_list * args)
48 gre_tunnel_t *t = va_arg (*args, gre_tunnel_t *);
50 s = format (s, "[%d] instance %d src %U dst %U fib-idx %d sw-if-idx %d ",
51 t->dev_instance, t->user_instance,
52 format_ip46_address, &t->tunnel_src, IP46_TYPE_ANY,
53 format_ip46_address, &t->tunnel_dst.fp_addr, IP46_TYPE_ANY,
54 t->outer_fib_index, t->sw_if_index);
56 s = format (s, "payload %U ", format_gre_tunnel_type, t->type);
57 s = format (s, "%U ", format_tunnel_mode, t->mode);
59 if (t->type == GRE_TUNNEL_TYPE_ERSPAN)
60 s = format (s, "session %d ", t->session_id);
62 if (t->type != GRE_TUNNEL_TYPE_L3)
63 s = format (s, "l2-adj-idx %d ", t->l2_adj_index);
69 gre_tunnel_db_find (const vnet_gre_tunnel_add_del_args_t * a,
70 u32 outer_fib_index, gre_tunnel_key_t * key)
72 gre_main_t *gm = &gre_main;
77 gre_mk_key4 (a->src.ip4, a->dst.ip4, outer_fib_index,
78 a->type, a->mode, a->session_id, &key->gtk_v4);
79 p = hash_get_mem (gm->tunnel_by_key4, &key->gtk_v4);
83 gre_mk_key6 (&a->src.ip6, &a->dst.ip6, outer_fib_index,
84 a->type, a->mode, a->session_id, &key->gtk_v6);
85 p = hash_get_mem (gm->tunnel_by_key6, &key->gtk_v6);
91 return (pool_elt_at_index (gm->tunnels, p[0]));
95 gre_tunnel_db_add (gre_tunnel_t * t, gre_tunnel_key_t * key)
97 gre_main_t *gm = &gre_main;
99 if (t->tunnel_dst.fp_proto == FIB_PROTOCOL_IP6)
101 hash_set_mem_alloc (&gm->tunnel_by_key6, &key->gtk_v6, t->dev_instance);
105 hash_set_mem_alloc (&gm->tunnel_by_key4, &key->gtk_v4, t->dev_instance);
110 gre_tunnel_db_remove (gre_tunnel_t * t, gre_tunnel_key_t * key)
112 gre_main_t *gm = &gre_main;
114 if (t->tunnel_dst.fp_proto == FIB_PROTOCOL_IP6)
116 hash_unset_mem_free (&gm->tunnel_by_key6, &key->gtk_v6);
120 hash_unset_mem_free (&gm->tunnel_by_key4, &key->gtk_v4);
127 * 'stack' (resolve the recursion for) the tunnel's midchain adjacency
130 gre_tunnel_stack (adj_index_t ai)
132 gre_main_t *gm = &gre_main;
138 sw_if_index = adj->rewrite_header.sw_if_index;
140 if ((vec_len (gm->tunnel_index_by_sw_if_index) <= sw_if_index) ||
141 (~0 == gm->tunnel_index_by_sw_if_index[sw_if_index]))
144 gt = pool_elt_at_index (gm->tunnels,
145 gm->tunnel_index_by_sw_if_index[sw_if_index]);
147 if ((vnet_hw_interface_get_flags (vnet_get_main (), gt->hw_if_index) &
148 VNET_HW_INTERFACE_FLAG_LINK_UP) == 0)
150 adj_midchain_delegate_unstack (ai);
154 adj_midchain_delegate_stack (ai, gt->outer_fib_index, >->tunnel_dst);
159 * @brief Call back when restacking all adjacencies on a GRE interface
162 gre_adj_walk_cb (adj_index_t ai, void *ctx)
164 gre_tunnel_stack (ai);
166 return (ADJ_WALK_RC_CONTINUE);
170 gre_tunnel_restack (gre_tunnel_t * gt)
172 fib_protocol_t proto;
175 * walk all the adjacencies on th GRE interface and restack them
177 FOR_EACH_FIB_IP_PROTOCOL (proto)
179 adj_nbr_walk (gt->sw_if_index, proto, gre_adj_walk_cb, NULL);
184 gre_teib_mk_key (const gre_tunnel_t * t,
185 const teib_entry_t * ne, gre_tunnel_key_t * key)
187 const fib_prefix_t *nh;
189 nh = teib_entry_get_nh (ne);
191 /* construct the key using mode P2P so it can be found in the DP */
192 if (FIB_PROTOCOL_IP4 == nh->fp_proto)
193 gre_mk_key4 (t->tunnel_src.ip4,
195 teib_entry_get_fib_index (ne),
196 t->type, TUNNEL_MODE_P2P, 0, &key->gtk_v4);
198 gre_mk_key6 (&t->tunnel_src.ip6,
200 teib_entry_get_fib_index (ne),
201 t->type, TUNNEL_MODE_P2P, 0, &key->gtk_v6);
205 * An TEIB entry has been added
208 gre_teib_entry_added (const teib_entry_t * ne)
210 gre_main_t *gm = &gre_main;
211 const ip_address_t *nh;
212 gre_tunnel_key_t key;
217 sw_if_index = teib_entry_get_sw_if_index (ne);
218 if (vec_len (gm->tunnel_index_by_sw_if_index) < sw_if_index)
221 t_idx = gm->tunnel_index_by_sw_if_index[sw_if_index];
223 if (INDEX_INVALID == t_idx)
226 /* entry has been added on an interface for which there is a GRE tunnel */
227 t = pool_elt_at_index (gm->tunnels, t_idx);
229 if (t->mode != TUNNEL_MODE_MP)
232 /* the next-hop (underlay) of the NHRP entry will form part of the key for
233 * ingress lookup to match packets to this interface */
234 gre_teib_mk_key (t, ne, &key);
235 gre_tunnel_db_add (t, &key);
237 /* update the rewrites for each of the adjacencies for this peer (overlay)
238 * using the next-hop (underlay) */
239 mgre_walk_ctx_t ctx = {
243 nh = teib_entry_get_peer (ne);
244 adj_nbr_walk_nh (teib_entry_get_sw_if_index (ne),
245 (AF_IP4 == ip_addr_version (nh) ?
248 &ip_addr_46 (nh), mgre_mk_complete_walk, &ctx);
252 gre_teib_entry_deleted (const teib_entry_t * ne)
254 gre_main_t *gm = &gre_main;
255 const ip_address_t *nh;
256 gre_tunnel_key_t key;
261 sw_if_index = teib_entry_get_sw_if_index (ne);
262 if (vec_len (gm->tunnel_index_by_sw_if_index) < sw_if_index)
265 t_idx = gm->tunnel_index_by_sw_if_index[sw_if_index];
267 if (INDEX_INVALID == t_idx)
270 t = pool_elt_at_index (gm->tunnels, t_idx);
272 /* remove the next-hop as an ingress lookup key */
273 gre_teib_mk_key (t, ne, &key);
274 gre_tunnel_db_remove (t, &key);
276 nh = teib_entry_get_peer (ne);
278 /* make all the adjacencies incomplete */
279 adj_nbr_walk_nh (teib_entry_get_sw_if_index (ne),
280 (AF_IP4 == ip_addr_version (nh) ?
283 &ip_addr_46 (nh), mgre_mk_incomplete_walk, t);
287 gre_tunnel_delete_teib_walk (index_t nei, void *ctx)
289 gre_tunnel_t *t = ctx;
290 gre_tunnel_key_t key;
292 gre_teib_mk_key (t, teib_entry_get (nei), &key);
293 gre_tunnel_db_remove (t, &key);
295 return (WALK_CONTINUE);
299 gre_tunnel_add_teib_walk (index_t nei, void *ctx)
301 gre_tunnel_t *t = ctx;
302 gre_tunnel_key_t key;
304 gre_teib_mk_key (t, teib_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 */
350 if (t->type == GRE_TUNNEL_TYPE_ERSPAN)
351 t->session_id = a->session_id;
353 if (t->type == GRE_TUNNEL_TYPE_L3)
355 if (t->mode == TUNNEL_MODE_P2P)
357 vnet_register_interface (vnm, gre_device_class.index, t_idx,
358 gre_hw_interface_class.index, t_idx);
361 vnet_register_interface (vnm, gre_device_class.index, t_idx,
362 mgre_hw_interface_class.index, t_idx);
366 /* Default MAC address (d00b:eed0:0000 + sw_if_index) */
368 { 0xd0, 0x0b, 0xee, 0xd0, (u8) (t_idx >> 8), (u8) t_idx };
370 ethernet_register_interface (vnm, gre_device_class.index, t_idx,
371 address, &hw_if_index, 0);
374 clib_error_report (error);
375 return VNET_API_ERROR_INVALID_REGISTRATION;
379 /* Set GRE tunnel interface output node (not used for L3 payload) */
380 if (GRE_TUNNEL_TYPE_ERSPAN == t->type)
381 vnet_set_interface_output_node (vnm, hw_if_index,
382 gre_erspan_encap_node.index);
384 vnet_set_interface_output_node (vnm, hw_if_index,
385 gre_teb_encap_node.index);
387 hi = vnet_get_hw_interface (vnm, hw_if_index);
388 sw_if_index = hi->sw_if_index;
390 t->hw_if_index = hw_if_index;
391 t->outer_fib_index = outer_fib_index;
392 t->sw_if_index = sw_if_index;
393 t->l2_adj_index = ADJ_INDEX_INVALID;
395 vec_validate_init_empty (gm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
396 gm->tunnel_index_by_sw_if_index[sw_if_index] = t_idx;
400 vec_validate (im4->fib_index_by_sw_if_index, sw_if_index);
401 hi->min_packet_bytes =
402 64 + sizeof (gre_header_t) + sizeof (ip4_header_t);
406 vec_validate (im6->fib_index_by_sw_if_index, sw_if_index);
407 hi->min_packet_bytes =
408 64 + sizeof (gre_header_t) + sizeof (ip6_header_t);
411 /* Standard default gre MTU. */
412 vnet_sw_interface_set_mtu (vnm, sw_if_index, 9000);
415 * source the FIB entry for the tunnel's destination
416 * and become a child thereof. The tunnel will then get poked
417 * when the forwarding for the entry updates, and the tunnel can
418 * re-stack accordingly
421 clib_memcpy (&t->tunnel_src, &a->src, sizeof (t->tunnel_src));
422 t->tunnel_dst.fp_len = !is_ipv6 ? 32 : 128;
423 t->tunnel_dst.fp_proto = !is_ipv6 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
424 t->tunnel_dst.fp_addr = a->dst;
426 gre_tunnel_db_add (t, &key);
428 if (t->mode == TUNNEL_MODE_MP)
429 teib_walk_itf (t->sw_if_index, gre_tunnel_add_teib_walk, t);
431 if (t->type == GRE_TUNNEL_TYPE_ERSPAN)
436 gre_mk_sn_key (t, &skey);
437 gre_sn = (gre_sn_t *) hash_get_mem (gm->seq_num_by_key, &skey);
445 gre_sn = clib_mem_alloc (sizeof (gre_sn_t));
447 gre_sn->ref_count = 1;
449 hash_set_mem_alloc (&gm->seq_num_by_key, &skey, (uword) gre_sn);
453 if (t->type != GRE_TUNNEL_TYPE_L3)
455 t->l2_adj_index = adj_nbr_add_or_lock
456 (t->tunnel_dst.fp_proto, VNET_LINK_ETHERNET, &zero_addr, sw_if_index);
457 gre_update_adj (vnm, t->sw_if_index, t->l2_adj_index);
461 *sw_if_indexp = sw_if_index;
463 /* register gre46-input nodes */
464 ip4_register_protocol (IP_PROTOCOL_GRE, gre4_input_node.index);
465 ip6_register_protocol (IP_PROTOCOL_GRE, gre6_input_node.index);
471 vnet_gre_tunnel_delete (vnet_gre_tunnel_add_del_args_t * a,
472 u32 outer_fib_index, u32 * sw_if_indexp)
474 gre_main_t *gm = &gre_main;
475 vnet_main_t *vnm = gm->vnet_main;
477 gre_tunnel_key_t key;
480 t = gre_tunnel_db_find (a, outer_fib_index, &key);
482 return VNET_API_ERROR_NO_SUCH_ENTRY;
484 if (t->mode == TUNNEL_MODE_MP)
485 teib_walk_itf (t->sw_if_index, gre_tunnel_delete_teib_walk, t);
487 sw_if_index = t->sw_if_index;
488 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
490 /* make sure tunnel is removed from l2 bd or xconnect */
491 set_int_l2_mode (gm->vlib_main, vnm, MODE_L3, sw_if_index, 0,
492 L2_BD_PORT_TYPE_NORMAL, 0, 0);
493 gm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
495 if (t->type == GRE_TUNNEL_TYPE_L3)
496 vnet_delete_hw_interface (vnm, t->hw_if_index);
498 ethernet_delete_interface (vnm, t->hw_if_index);
500 if (t->l2_adj_index != ADJ_INDEX_INVALID)
502 adj_midchain_delegate_unstack (t->l2_adj_index);
503 adj_unlock (t->l2_adj_index);
506 ASSERT ((t->type != GRE_TUNNEL_TYPE_ERSPAN) || (t->gre_sn != NULL));
507 if ((t->type == GRE_TUNNEL_TYPE_ERSPAN) && (t->gre_sn->ref_count-- == 1))
510 gre_mk_sn_key (t, &skey);
511 hash_unset_mem_free (&gm->seq_num_by_key, &skey);
512 clib_mem_free (t->gre_sn);
515 hash_unset (gm->instance_used, t->user_instance);
516 gre_tunnel_db_remove (t, &key);
517 pool_put (gm->tunnels, t);
520 *sw_if_indexp = sw_if_index;
526 vnet_gre_tunnel_add_del (vnet_gre_tunnel_add_del_args_t * a,
531 outer_fib_index = fib_table_find ((a->is_ipv6 ?
533 FIB_PROTOCOL_IP4), a->outer_table_id);
535 if (~0 == outer_fib_index)
536 return VNET_API_ERROR_NO_SUCH_FIB;
538 if (a->session_id > GTK_SESSION_ID_MAX)
539 return VNET_API_ERROR_INVALID_SESSION_ID;
541 if (a->mode == TUNNEL_MODE_MP && !ip46_address_is_zero (&a->dst))
542 return (VNET_API_ERROR_INVALID_DST_ADDRESS);
545 return (vnet_gre_tunnel_add (a, outer_fib_index, sw_if_indexp));
547 return (vnet_gre_tunnel_delete (a, outer_fib_index, sw_if_indexp));
551 gre_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
553 gre_main_t *gm = &gre_main;
554 vnet_hw_interface_t *hi;
558 hi = vnet_get_hw_interface (vnm, hw_if_index);
560 if (NULL == gm->tunnel_index_by_sw_if_index ||
561 hi->sw_if_index >= vec_len (gm->tunnel_index_by_sw_if_index))
564 ti = gm->tunnel_index_by_sw_if_index[hi->sw_if_index];
567 /* not one of ours */
570 t = pool_elt_at_index (gm->tunnels, ti);
572 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
573 vnet_hw_interface_set_flags (vnm, hw_if_index,
574 VNET_HW_INTERFACE_FLAG_LINK_UP);
576 vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */ );
578 gre_tunnel_restack (t);
580 return /* no error */ 0;
583 static clib_error_t *
584 create_gre_tunnel_command_fn (vlib_main_t * vm,
585 unformat_input_t * input,
586 vlib_cli_command_t * cmd)
588 unformat_input_t _line_input, *line_input = &_line_input;
589 vnet_gre_tunnel_add_del_args_t _a, *a = &_a;
590 ip46_address_t src = ip46_address_initializer, dst =
591 ip46_address_initializer;
593 u32 outer_table_id = 0;
594 gre_tunnel_type_t t_type = GRE_TUNNEL_TYPE_L3;
595 tunnel_mode_t t_mode = TUNNEL_MODE_P2P;
596 tunnel_encap_decap_flags_t flags = TUNNEL_ENCAP_DECAP_FLAG_NONE;
601 clib_error_t *error = NULL;
603 /* Get a line of input. */
604 if (!unformat_user (input, unformat_line_input, line_input))
607 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
609 if (unformat (line_input, "del"))
611 else if (unformat (line_input, "instance %d", &instance))
613 else if (unformat (line_input, "src %U", unformat_ip46_address, &src))
615 else if (unformat (line_input, "dst %U", unformat_ip46_address, &dst))
617 else if (unformat (line_input, "outer-table-id %d", &outer_table_id))
619 else if (unformat (line_input, "multipoint"))
620 t_mode = TUNNEL_MODE_MP;
621 else if (unformat (line_input, "teb"))
622 t_type = GRE_TUNNEL_TYPE_TEB;
623 else if (unformat (line_input, "erspan %d", &session_id))
624 t_type = GRE_TUNNEL_TYPE_ERSPAN;
627 (line_input, "flags %U", unformat_tunnel_encap_decap_flags,
632 error = clib_error_return (0, "unknown input `%U'",
633 format_unformat_error, line_input);
638 if (ip46_address_is_equal (&src, &dst))
640 error = clib_error_return (0, "src and dst are identical");
644 if (t_mode != TUNNEL_MODE_MP && ip46_address_is_zero (&dst))
646 error = clib_error_return (0, "destination address not specified");
650 if (ip46_address_is_zero (&src))
652 error = clib_error_return (0, "source address not specified");
656 if (ip46_address_is_ip4 (&src) != ip46_address_is_ip4 (&dst))
659 clib_error_return (0, "src and dst address must be the same AF");
663 clib_memset (a, 0, sizeof (*a));
665 a->outer_table_id = outer_table_id;
668 a->session_id = session_id;
669 a->is_ipv6 = !ip46_address_is_ip4 (&src);
670 a->instance = instance;
672 clib_memcpy (&a->src, &src, sizeof (a->src));
673 clib_memcpy (&a->dst, &dst, sizeof (a->dst));
675 rv = vnet_gre_tunnel_add_del (a, &sw_if_index);
680 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
681 vnet_get_main (), sw_if_index);
683 case VNET_API_ERROR_IF_ALREADY_EXISTS:
684 error = clib_error_return (0, "GRE tunnel already exists...");
686 case VNET_API_ERROR_NO_SUCH_FIB:
687 error = clib_error_return (0, "outer table ID %d doesn't exist\n",
690 case VNET_API_ERROR_NO_SUCH_ENTRY:
691 error = clib_error_return (0, "GRE tunnel doesn't exist");
693 case VNET_API_ERROR_INVALID_SESSION_ID:
694 error = clib_error_return (0, "session ID %d out of range\n",
697 case VNET_API_ERROR_INSTANCE_IN_USE:
698 error = clib_error_return (0, "Instance is in use");
702 clib_error_return (0, "vnet_gre_tunnel_add_del returned %d", rv);
707 unformat_free (line_input);
713 VLIB_CLI_COMMAND (create_gre_tunnel_command, static) = {
714 .path = "create gre tunnel",
715 .short_help = "create gre tunnel src <addr> dst <addr> [instance <n>] "
716 "[outer-fib-id <fib>] [teb | erspan <session-id>] [del] "
718 .function = create_gre_tunnel_command_fn,
722 static clib_error_t *
723 show_gre_tunnel_command_fn (vlib_main_t * vm,
724 unformat_input_t * input,
725 vlib_cli_command_t * cmd)
727 gre_main_t *gm = &gre_main;
731 if (pool_elts (gm->tunnels) == 0)
732 vlib_cli_output (vm, "No GRE tunnels configured...");
734 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
736 if (unformat (input, "%d", &ti))
745 pool_foreach (t, gm->tunnels)
747 vlib_cli_output (vm, "%U", format_gre_tunnel, t);
753 t = pool_elt_at_index (gm->tunnels, ti);
755 vlib_cli_output (vm, "%U", format_gre_tunnel, t);
762 VLIB_CLI_COMMAND (show_gre_tunnel_command, static) = {
763 .path = "show gre tunnel",
764 .function = show_gre_tunnel_command_fn,
768 const static teib_vft_t gre_teib_vft = {
769 .nv_added = gre_teib_entry_added,
770 .nv_deleted = gre_teib_entry_deleted,
773 /* force inclusion from application's main.c */
775 gre_interface_init (vlib_main_t * vm)
777 teib_register (&gre_teib_vft);
782 VLIB_INIT_FUNCTION (gre_interface_init);
785 * fd.io coding-style-patch-verification: ON
788 * eval: (c-set-style "gnu")