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/ip4_fib.h>
22 #include <vnet/fib/ip6_fib.h>
23 #include <vnet/adj/adj_midchain.h>
24 #include <vnet/adj/adj_nbr.h>
25 #include <vnet/mpls/mpls.h>
26 #include <vnet/l2/l2_input.h>
27 #include <vnet/teib/teib.h>
30 format_gre_tunnel_type (u8 * s, va_list * args)
32 gre_tunnel_type_t type = va_arg (*args, int);
36 #define _(n, v) case GRE_TUNNEL_TYPE_##n: \
37 s = format (s, "%s", v); \
39 foreach_gre_tunnel_type
47 format_gre_tunnel (u8 * s, va_list * args)
49 gre_tunnel_t *t = va_arg (*args, gre_tunnel_t *);
51 s = format (s, "[%d] instance %d src %U dst %U fib-idx %d sw-if-idx %d ",
52 t->dev_instance, t->user_instance,
53 format_ip46_address, &t->tunnel_src, IP46_TYPE_ANY,
54 format_ip46_address, &t->tunnel_dst.fp_addr, IP46_TYPE_ANY,
55 t->outer_fib_index, t->sw_if_index);
57 s = format (s, "payload %U ", format_gre_tunnel_type, t->type);
58 s = format (s, "%U ", format_tunnel_mode, t->mode);
60 if (t->type == GRE_TUNNEL_TYPE_ERSPAN)
61 s = format (s, "session %d ", t->session_id);
63 if (t->type != GRE_TUNNEL_TYPE_L3)
64 s = format (s, "l2-adj-idx %d ", t->l2_adj_index);
70 gre_tunnel_db_find (const vnet_gre_tunnel_add_del_args_t * a,
71 u32 outer_fib_index, gre_tunnel_key_t * key)
73 gre_main_t *gm = &gre_main;
78 gre_mk_key4 (a->src.ip4, a->dst.ip4, outer_fib_index,
79 a->type, a->mode, a->session_id, &key->gtk_v4);
80 p = hash_get_mem (gm->tunnel_by_key4, &key->gtk_v4);
84 gre_mk_key6 (&a->src.ip6, &a->dst.ip6, outer_fib_index,
85 a->type, a->mode, a->session_id, &key->gtk_v6);
86 p = hash_get_mem (gm->tunnel_by_key6, &key->gtk_v6);
92 return (pool_elt_at_index (gm->tunnels, p[0]));
96 gre_tunnel_db_add (gre_tunnel_t * t, gre_tunnel_key_t * key)
98 gre_main_t *gm = &gre_main;
100 if (t->tunnel_dst.fp_proto == FIB_PROTOCOL_IP6)
102 hash_set_mem_alloc (&gm->tunnel_by_key6, &key->gtk_v6, t->dev_instance);
106 hash_set_mem_alloc (&gm->tunnel_by_key4, &key->gtk_v4, t->dev_instance);
111 gre_tunnel_db_remove (gre_tunnel_t * t, gre_tunnel_key_t * key)
113 gre_main_t *gm = &gre_main;
115 if (t->tunnel_dst.fp_proto == FIB_PROTOCOL_IP6)
117 hash_unset_mem_free (&gm->tunnel_by_key6, &key->gtk_v6);
121 hash_unset_mem_free (&gm->tunnel_by_key4, &key->gtk_v4);
128 * 'stack' (resolve the recursion for) the tunnel's midchain adjacency
131 gre_tunnel_stack (adj_index_t ai)
133 gre_main_t *gm = &gre_main;
139 sw_if_index = adj->rewrite_header.sw_if_index;
141 if ((vec_len (gm->tunnel_index_by_sw_if_index) <= sw_if_index) ||
142 (~0 == gm->tunnel_index_by_sw_if_index[sw_if_index]))
145 gt = pool_elt_at_index (gm->tunnels,
146 gm->tunnel_index_by_sw_if_index[sw_if_index]);
148 if ((vnet_hw_interface_get_flags (vnet_get_main (), gt->hw_if_index) &
149 VNET_HW_INTERFACE_FLAG_LINK_UP) == 0)
151 adj_midchain_delegate_unstack (ai);
155 adj_midchain_delegate_stack (ai, gt->outer_fib_index, >->tunnel_dst);
160 * @brief Call back when restacking all adjacencies on a GRE interface
163 gre_adj_walk_cb (adj_index_t ai, void *ctx)
165 gre_tunnel_stack (ai);
167 return (ADJ_WALK_RC_CONTINUE);
171 gre_tunnel_restack (gre_tunnel_t * gt)
173 fib_protocol_t proto;
176 * walk all the adjacencies on th GRE interface and restack them
178 FOR_EACH_FIB_IP_PROTOCOL (proto)
180 adj_nbr_walk (gt->sw_if_index, proto, gre_adj_walk_cb, NULL);
185 gre_teib_mk_key (const gre_tunnel_t * t,
186 const teib_entry_t * ne, gre_tunnel_key_t * key)
188 const fib_prefix_t *nh;
190 nh = teib_entry_get_nh (ne);
192 /* construct the key using mode P2P so it can be found in the DP */
193 if (FIB_PROTOCOL_IP4 == nh->fp_proto)
194 gre_mk_key4 (t->tunnel_src.ip4,
196 teib_entry_get_fib_index (ne),
197 t->type, TUNNEL_MODE_P2P, 0, &key->gtk_v4);
199 gre_mk_key6 (&t->tunnel_src.ip6,
201 teib_entry_get_fib_index (ne),
202 t->type, TUNNEL_MODE_P2P, 0, &key->gtk_v6);
206 * An NHRP entry has been added
209 gre_teib_entry_added (const teib_entry_t * ne)
211 gre_main_t *gm = &gre_main;
212 const ip_address_t *nh;
213 gre_tunnel_key_t key;
218 sw_if_index = teib_entry_get_sw_if_index (ne);
219 if (vec_len (gm->tunnel_index_by_sw_if_index) < sw_if_index)
222 t_idx = gm->tunnel_index_by_sw_if_index[sw_if_index];
224 if (INDEX_INVALID == t_idx)
227 /* entry has been added on an interface for which there is a GRE tunnel */
228 t = pool_elt_at_index (gm->tunnels, t_idx);
230 if (t->mode != TUNNEL_MODE_MP)
233 /* the next-hop (underlay) of the NHRP entry will form part of the key for
234 * ingress lookup to match packets to this interface */
235 gre_teib_mk_key (t, ne, &key);
236 gre_tunnel_db_add (t, &key);
238 /* update the rewrites for each of the adjacencies for this peer (overlay)
239 * using the next-hop (underlay) */
240 mgre_walk_ctx_t ctx = {
244 nh = teib_entry_get_peer (ne);
245 adj_nbr_walk_nh (teib_entry_get_sw_if_index (ne),
246 (AF_IP4 == ip_addr_version (nh) ?
249 &ip_addr_46 (nh), mgre_mk_complete_walk, &ctx);
253 gre_teib_entry_deleted (const teib_entry_t * ne)
255 gre_main_t *gm = &gre_main;
256 const ip_address_t *nh;
257 gre_tunnel_key_t key;
262 sw_if_index = teib_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_teib_mk_key (t, ne, &key);
275 gre_tunnel_db_remove (t, &key);
277 nh = teib_entry_get_peer (ne);
279 /* make all the adjacencies incomplete */
280 adj_nbr_walk_nh (teib_entry_get_sw_if_index (ne),
281 (AF_IP4 == ip_addr_version (nh) ?
284 &ip_addr_46 (nh), mgre_mk_incomplete_walk, t);
288 gre_tunnel_delete_teib_walk (index_t nei, void *ctx)
290 gre_tunnel_t *t = ctx;
291 gre_tunnel_key_t key;
293 gre_teib_mk_key (t, teib_entry_get (nei), &key);
294 gre_tunnel_db_remove (t, &key);
296 return (WALK_CONTINUE);
300 gre_tunnel_add_teib_walk (index_t nei, void *ctx)
302 gre_tunnel_t *t = ctx;
303 gre_tunnel_key_t key;
305 gre_teib_mk_key (t, teib_entry_get (nei), &key);
306 gre_tunnel_db_add (t, &key);
308 return (WALK_CONTINUE);
312 vnet_gre_tunnel_add (vnet_gre_tunnel_add_del_args_t * a,
313 u32 outer_fib_index, u32 * sw_if_indexp)
315 gre_main_t *gm = &gre_main;
316 vnet_main_t *vnm = gm->vnet_main;
317 ip4_main_t *im4 = &ip4_main;
318 ip6_main_t *im6 = &ip6_main;
320 vnet_hw_interface_t *hi;
321 u32 hw_if_index, sw_if_index;
323 u8 is_ipv6 = a->is_ipv6;
324 gre_tunnel_key_t key;
326 t = gre_tunnel_db_find (a, outer_fib_index, &key);
328 return VNET_API_ERROR_IF_ALREADY_EXISTS;
330 pool_get_aligned (gm->tunnels, t, CLIB_CACHE_LINE_BYTES);
331 clib_memset (t, 0, sizeof (*t));
333 /* Reconcile the real dev_instance and a possible requested instance */
334 u32 t_idx = t - gm->tunnels; /* tunnel index (or instance) */
335 u32 u_idx = a->instance; /* user specified instance */
338 if (hash_get (gm->instance_used, u_idx))
340 pool_put (gm->tunnels, t);
341 return VNET_API_ERROR_INSTANCE_IN_USE;
343 hash_set (gm->instance_used, u_idx, 1);
345 t->dev_instance = t_idx; /* actual */
346 t->user_instance = u_idx; /* name */
351 if (t->type == GRE_TUNNEL_TYPE_ERSPAN)
352 t->session_id = a->session_id;
354 if (t->type == GRE_TUNNEL_TYPE_L3)
356 if (t->mode == TUNNEL_MODE_P2P)
358 vnet_register_interface (vnm, gre_device_class.index, t_idx,
359 gre_hw_interface_class.index, t_idx);
362 vnet_register_interface (vnm, gre_device_class.index, t_idx,
363 mgre_hw_interface_class.index, t_idx);
367 /* Default MAC address (d00b:eed0:0000 + sw_if_index) */
369 { 0xd0, 0x0b, 0xee, 0xd0, (u8) (t_idx >> 8), (u8) t_idx };
371 ethernet_register_interface (vnm, gre_device_class.index, t_idx,
372 address, &hw_if_index, 0);
375 clib_error_report (error);
376 return VNET_API_ERROR_INVALID_REGISTRATION;
380 /* Set GRE tunnel interface output node (not used for L3 payload) */
381 if (GRE_TUNNEL_TYPE_ERSPAN == t->type)
382 vnet_set_interface_output_node (vnm, hw_if_index,
383 gre_erspan_encap_node.index);
385 vnet_set_interface_output_node (vnm, hw_if_index,
386 gre_teb_encap_node.index);
388 hi = vnet_get_hw_interface (vnm, hw_if_index);
389 sw_if_index = hi->sw_if_index;
391 t->hw_if_index = hw_if_index;
392 t->outer_fib_index = outer_fib_index;
393 t->sw_if_index = sw_if_index;
394 t->l2_adj_index = ADJ_INDEX_INVALID;
396 vec_validate_init_empty (gm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
397 gm->tunnel_index_by_sw_if_index[sw_if_index] = t_idx;
401 vec_validate (im4->fib_index_by_sw_if_index, sw_if_index);
402 hi->min_packet_bytes =
403 64 + sizeof (gre_header_t) + sizeof (ip4_header_t);
407 vec_validate (im6->fib_index_by_sw_if_index, sw_if_index);
408 hi->min_packet_bytes =
409 64 + sizeof (gre_header_t) + sizeof (ip6_header_t);
412 /* Standard default gre MTU. */
413 vnet_sw_interface_set_mtu (vnm, sw_if_index, 9000);
416 * source the FIB entry for the tunnel's destination
417 * and become a child thereof. The tunnel will then get poked
418 * when the forwarding for the entry updates, and the tunnel can
419 * re-stack accordingly
422 clib_memcpy (&t->tunnel_src, &a->src, sizeof (t->tunnel_src));
423 t->tunnel_dst.fp_len = !is_ipv6 ? 32 : 128;
424 t->tunnel_dst.fp_proto = !is_ipv6 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
425 t->tunnel_dst.fp_addr = a->dst;
427 gre_tunnel_db_add (t, &key);
429 if (t->mode == TUNNEL_MODE_MP)
430 teib_walk_itf (t->sw_if_index, gre_tunnel_add_teib_walk, t);
432 if (t->type == GRE_TUNNEL_TYPE_ERSPAN)
437 gre_mk_sn_key (t, &skey);
438 gre_sn = (gre_sn_t *) hash_get_mem (gm->seq_num_by_key, &skey);
446 gre_sn = clib_mem_alloc (sizeof (gre_sn_t));
448 gre_sn->ref_count = 1;
450 hash_set_mem_alloc (&gm->seq_num_by_key, &skey, (uword) gre_sn);
454 if (t->type != GRE_TUNNEL_TYPE_L3)
456 t->l2_adj_index = adj_nbr_add_or_lock
457 (t->tunnel_dst.fp_proto, VNET_LINK_ETHERNET, &zero_addr, sw_if_index);
458 gre_update_adj (vnm, t->sw_if_index, t->l2_adj_index);
462 *sw_if_indexp = sw_if_index;
464 /* register gre46-input nodes */
465 ip4_register_protocol (IP_PROTOCOL_GRE, gre4_input_node.index);
466 ip6_register_protocol (IP_PROTOCOL_GRE, gre6_input_node.index);
472 vnet_gre_tunnel_delete (vnet_gre_tunnel_add_del_args_t * a,
473 u32 outer_fib_index, u32 * sw_if_indexp)
475 gre_main_t *gm = &gre_main;
476 vnet_main_t *vnm = gm->vnet_main;
478 gre_tunnel_key_t key;
481 t = gre_tunnel_db_find (a, outer_fib_index, &key);
483 return VNET_API_ERROR_NO_SUCH_ENTRY;
485 if (t->mode == TUNNEL_MODE_MP)
486 teib_walk_itf (t->sw_if_index, gre_tunnel_delete_teib_walk, t);
488 sw_if_index = t->sw_if_index;
489 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
491 /* make sure tunnel is removed from l2 bd or xconnect */
492 set_int_l2_mode (gm->vlib_main, vnm, MODE_L3, sw_if_index, 0,
493 L2_BD_PORT_TYPE_NORMAL, 0, 0);
494 gm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
496 if (t->type == GRE_TUNNEL_TYPE_L3)
497 vnet_delete_hw_interface (vnm, t->hw_if_index);
499 ethernet_delete_interface (vnm, t->hw_if_index);
501 if (t->l2_adj_index != ADJ_INDEX_INVALID)
503 adj_midchain_delegate_unstack (t->l2_adj_index);
504 adj_unlock (t->l2_adj_index);
507 ASSERT ((t->type != GRE_TUNNEL_TYPE_ERSPAN) || (t->gre_sn != NULL));
508 if ((t->type == GRE_TUNNEL_TYPE_ERSPAN) && (t->gre_sn->ref_count-- == 1))
511 gre_mk_sn_key (t, &skey);
512 hash_unset_mem_free (&gm->seq_num_by_key, &skey);
513 clib_mem_free (t->gre_sn);
516 hash_unset (gm->instance_used, t->user_instance);
517 gre_tunnel_db_remove (t, &key);
518 pool_put (gm->tunnels, t);
521 *sw_if_indexp = sw_if_index;
527 vnet_gre_tunnel_add_del (vnet_gre_tunnel_add_del_args_t * a,
533 outer_fib_index = ip4_fib_index_from_table_id (a->outer_table_id);
535 outer_fib_index = ip6_fib_index_from_table_id (a->outer_table_id);
537 if (~0 == outer_fib_index)
538 return VNET_API_ERROR_NO_SUCH_FIB;
540 if (a->session_id > GTK_SESSION_ID_MAX)
541 return VNET_API_ERROR_INVALID_SESSION_ID;
543 if (a->mode == TUNNEL_MODE_MP && !ip46_address_is_zero (&a->dst))
544 return (VNET_API_ERROR_INVALID_DST_ADDRESS);
547 return (vnet_gre_tunnel_add (a, outer_fib_index, sw_if_indexp));
549 return (vnet_gre_tunnel_delete (a, outer_fib_index, sw_if_indexp));
553 gre_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
555 gre_main_t *gm = &gre_main;
556 vnet_hw_interface_t *hi;
560 hi = vnet_get_hw_interface (vnm, hw_if_index);
562 if (NULL == gm->tunnel_index_by_sw_if_index ||
563 hi->sw_if_index >= vec_len (gm->tunnel_index_by_sw_if_index))
566 ti = gm->tunnel_index_by_sw_if_index[hi->sw_if_index];
569 /* not one of ours */
572 t = pool_elt_at_index (gm->tunnels, ti);
574 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
575 vnet_hw_interface_set_flags (vnm, hw_if_index,
576 VNET_HW_INTERFACE_FLAG_LINK_UP);
578 vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */ );
580 gre_tunnel_restack (t);
582 return /* no error */ 0;
585 static clib_error_t *
586 create_gre_tunnel_command_fn (vlib_main_t * vm,
587 unformat_input_t * input,
588 vlib_cli_command_t * cmd)
590 unformat_input_t _line_input, *line_input = &_line_input;
591 vnet_gre_tunnel_add_del_args_t _a, *a = &_a;
592 ip46_address_t src = ip46_address_initializer, dst =
593 ip46_address_initializer;
595 u32 outer_table_id = 0;
596 gre_tunnel_type_t t_type = GRE_TUNNEL_TYPE_L3;
597 tunnel_mode_t t_mode = TUNNEL_MODE_P2P;
602 clib_error_t *error = NULL;
604 /* Get a line of input. */
605 if (!unformat_user (input, unformat_line_input, line_input))
608 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
610 if (unformat (line_input, "del"))
612 else if (unformat (line_input, "instance %d", &instance))
614 else if (unformat (line_input, "src %U", unformat_ip46_address, &src))
616 else if (unformat (line_input, "dst %U", unformat_ip46_address, &dst))
618 else if (unformat (line_input, "outer-table-id %d", &outer_table_id))
620 else if (unformat (line_input, "multipoint"))
621 t_mode = TUNNEL_MODE_MP;
622 else if (unformat (line_input, "teb"))
623 t_type = GRE_TUNNEL_TYPE_TEB;
624 else if (unformat (line_input, "erspan %d", &session_id))
625 t_type = GRE_TUNNEL_TYPE_ERSPAN;
628 error = clib_error_return (0, "unknown input `%U'",
629 format_unformat_error, line_input);
634 if (ip46_address_is_equal (&src, &dst))
636 error = clib_error_return (0, "src and dst are identical");
640 if (t_mode != TUNNEL_MODE_MP && ip46_address_is_zero (&dst))
642 error = clib_error_return (0, "destination address not specified");
646 if (ip46_address_is_zero (&src))
648 error = clib_error_return (0, "source address not specified");
652 if (ip46_address_is_ip4 (&src) != ip46_address_is_ip4 (&dst))
655 clib_error_return (0, "src and dst address must be the same AF");
659 clib_memset (a, 0, sizeof (*a));
661 a->outer_table_id = outer_table_id;
664 a->session_id = session_id;
665 a->is_ipv6 = !ip46_address_is_ip4 (&src);
666 a->instance = instance;
667 clib_memcpy (&a->src, &src, sizeof (a->src));
668 clib_memcpy (&a->dst, &dst, sizeof (a->dst));
670 rv = vnet_gre_tunnel_add_del (a, &sw_if_index);
675 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
676 vnet_get_main (), sw_if_index);
678 case VNET_API_ERROR_IF_ALREADY_EXISTS:
679 error = clib_error_return (0, "GRE tunnel already exists...");
681 case VNET_API_ERROR_NO_SUCH_FIB:
682 error = clib_error_return (0, "outer table ID %d doesn't exist\n",
685 case VNET_API_ERROR_NO_SUCH_ENTRY:
686 error = clib_error_return (0, "GRE tunnel doesn't exist");
688 case VNET_API_ERROR_INVALID_SESSION_ID:
689 error = clib_error_return (0, "session ID %d out of range\n",
692 case VNET_API_ERROR_INSTANCE_IN_USE:
693 error = clib_error_return (0, "Instance is in use");
697 clib_error_return (0, "vnet_gre_tunnel_add_del returned %d", rv);
702 unformat_free (line_input);
708 VLIB_CLI_COMMAND (create_gre_tunnel_command, static) = {
709 .path = "create gre tunnel",
710 .short_help = "create gre tunnel src <addr> dst <addr> [instance <n>] "
711 "[outer-fib-id <fib>] [teb | erspan <session-id>] [del] "
713 .function = create_gre_tunnel_command_fn,
717 static clib_error_t *
718 show_gre_tunnel_command_fn (vlib_main_t * vm,
719 unformat_input_t * input,
720 vlib_cli_command_t * cmd)
722 gre_main_t *gm = &gre_main;
726 if (pool_elts (gm->tunnels) == 0)
727 vlib_cli_output (vm, "No GRE tunnels configured...");
729 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
731 if (unformat (input, "%d", &ti))
740 pool_foreach (t, gm->tunnels,
742 vlib_cli_output (vm, "%U", format_gre_tunnel, t);
748 t = pool_elt_at_index (gm->tunnels, ti);
750 vlib_cli_output (vm, "%U", format_gre_tunnel, t);
757 VLIB_CLI_COMMAND (show_gre_tunnel_command, static) = {
758 .path = "show gre tunnel",
759 .function = show_gre_tunnel_command_fn,
763 const static teib_vft_t gre_teib_vft = {
764 .nv_added = gre_teib_entry_added,
765 .nv_deleted = gre_teib_entry_deleted,
768 /* force inclusion from application's main.c */
770 gre_interface_init (vlib_main_t * vm)
772 teib_register (&gre_teib_vft);
777 VLIB_INIT_FUNCTION (gre_interface_init);
780 * fd.io coding-style-patch-verification: ON
783 * eval: (c-set-style "gnu")