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_mode (u8 * s, va_list * args)
50 gre_tunnel_mode_t mode = va_arg (*args, int);
54 #define _(n, v) case GRE_TUNNEL_MODE_##n: \
55 s = format (s, "%s", v); \
57 foreach_gre_tunnel_mode
65 format_gre_tunnel (u8 * s, va_list * args)
67 gre_tunnel_t *t = va_arg (*args, gre_tunnel_t *);
69 s = format (s, "[%d] instance %d src %U dst %U fib-idx %d sw-if-idx %d ",
70 t->dev_instance, t->user_instance,
71 format_ip46_address, &t->tunnel_src, IP46_TYPE_ANY,
72 format_ip46_address, &t->tunnel_dst.fp_addr, IP46_TYPE_ANY,
73 t->outer_fib_index, t->sw_if_index);
75 s = format (s, "payload %U ", format_gre_tunnel_type, t->type);
76 s = format (s, "%U ", format_gre_tunnel_mode, t->mode);
78 if (t->type == GRE_TUNNEL_TYPE_ERSPAN)
79 s = format (s, "session %d ", t->session_id);
81 if (t->type != GRE_TUNNEL_TYPE_L3)
82 s = format (s, "l2-adj-idx %d ", t->l2_adj_index);
88 gre_tunnel_db_find (const vnet_gre_tunnel_add_del_args_t * a,
89 u32 outer_fib_index, gre_tunnel_key_t * key)
91 gre_main_t *gm = &gre_main;
96 gre_mk_key4 (a->src.ip4, a->dst.ip4, outer_fib_index,
97 a->type, a->mode, a->session_id, &key->gtk_v4);
98 p = hash_get_mem (gm->tunnel_by_key4, &key->gtk_v4);
102 gre_mk_key6 (&a->src.ip6, &a->dst.ip6, outer_fib_index,
103 a->type, a->mode, a->session_id, &key->gtk_v6);
104 p = hash_get_mem (gm->tunnel_by_key6, &key->gtk_v6);
110 return (pool_elt_at_index (gm->tunnels, p[0]));
114 gre_tunnel_db_add (gre_tunnel_t * t, gre_tunnel_key_t * key)
116 gre_main_t *gm = &gre_main;
118 if (t->tunnel_dst.fp_proto == FIB_PROTOCOL_IP6)
120 hash_set_mem_alloc (&gm->tunnel_by_key6, &key->gtk_v6, t->dev_instance);
124 hash_set_mem_alloc (&gm->tunnel_by_key4, &key->gtk_v4, t->dev_instance);
129 gre_tunnel_db_remove (gre_tunnel_t * t, gre_tunnel_key_t * key)
131 gre_main_t *gm = &gre_main;
133 if (t->tunnel_dst.fp_proto == FIB_PROTOCOL_IP6)
135 hash_unset_mem_free (&gm->tunnel_by_key6, &key->gtk_v6);
139 hash_unset_mem_free (&gm->tunnel_by_key4, &key->gtk_v4);
146 * 'stack' (resolve the recursion for) the tunnel's midchain adjacency
149 gre_tunnel_stack (adj_index_t ai)
151 gre_main_t *gm = &gre_main;
157 sw_if_index = adj->rewrite_header.sw_if_index;
159 if ((vec_len (gm->tunnel_index_by_sw_if_index) <= sw_if_index) ||
160 (~0 == gm->tunnel_index_by_sw_if_index[sw_if_index]))
163 gt = pool_elt_at_index (gm->tunnels,
164 gm->tunnel_index_by_sw_if_index[sw_if_index]);
166 if ((vnet_hw_interface_get_flags (vnet_get_main (), gt->hw_if_index) &
167 VNET_HW_INTERFACE_FLAG_LINK_UP) == 0)
169 adj_midchain_delegate_unstack (ai);
173 adj_midchain_delegate_stack (ai, gt->outer_fib_index, >->tunnel_dst);
178 * @brief Call back when restacking all adjacencies on a GRE interface
181 gre_adj_walk_cb (adj_index_t ai, void *ctx)
183 gre_tunnel_stack (ai);
185 return (ADJ_WALK_RC_CONTINUE);
189 gre_tunnel_restack (gre_tunnel_t * gt)
191 fib_protocol_t proto;
194 * walk all the adjacencies on th GRE interface and restack them
196 FOR_EACH_FIB_IP_PROTOCOL (proto)
198 adj_nbr_walk (gt->sw_if_index, proto, gre_adj_walk_cb, NULL);
203 gre_nhrp_mk_key (const gre_tunnel_t * t,
204 const nhrp_entry_t * ne, gre_tunnel_key_t * key)
206 const fib_prefix_t *nh;
208 nh = nhrp_entry_get_nh (ne);
210 /* construct the key using mode P2P so it can be found in the DP */
211 if (FIB_PROTOCOL_IP4 == nh->fp_proto)
212 gre_mk_key4 (t->tunnel_src.ip4,
214 nhrp_entry_get_fib_index (ne),
215 t->type, GRE_TUNNEL_MODE_P2P, 0, &key->gtk_v4);
217 gre_mk_key6 (&t->tunnel_src.ip6,
219 nhrp_entry_get_fib_index (ne),
220 t->type, GRE_TUNNEL_MODE_P2P, 0, &key->gtk_v6);
224 gre_nhrp_entry_added (const nhrp_entry_t * ne)
226 gre_main_t *gm = &gre_main;
227 gre_tunnel_key_t key;
232 sw_if_index = nhrp_entry_get_sw_if_index (ne);
233 if (vec_len (gm->tunnel_index_by_sw_if_index) < sw_if_index)
236 t_idx = gm->tunnel_index_by_sw_if_index[sw_if_index];
238 if (INDEX_INVALID == t_idx)
241 t = pool_elt_at_index (gm->tunnels, t_idx);
243 gre_nhrp_mk_key (t, ne, &key);
244 gre_tunnel_db_add (t, &key);
248 gre_nhrp_entry_deleted (const nhrp_entry_t * ne)
250 gre_main_t *gm = &gre_main;
251 gre_tunnel_key_t key;
256 sw_if_index = nhrp_entry_get_sw_if_index (ne);
257 if (vec_len (gm->tunnel_index_by_sw_if_index) < sw_if_index)
260 t_idx = gm->tunnel_index_by_sw_if_index[sw_if_index];
262 if (INDEX_INVALID == t_idx)
265 t = pool_elt_at_index (gm->tunnels, t_idx);
267 gre_nhrp_mk_key (t, ne, &key);
268 gre_tunnel_db_remove (t, &key);
272 gre_tunnel_delete_nhrp_walk (index_t nei, void *ctx)
274 gre_tunnel_t *t = ctx;
275 gre_tunnel_key_t key;
277 gre_nhrp_mk_key (t, nhrp_entry_get (nei), &key);
278 gre_tunnel_db_remove (t, &key);
280 return (WALK_CONTINUE);
284 gre_tunnel_add_nhrp_walk (index_t nei, void *ctx)
286 gre_tunnel_t *t = ctx;
287 gre_tunnel_key_t key;
289 gre_nhrp_mk_key (t, nhrp_entry_get (nei), &key);
290 gre_tunnel_db_add (t, &key);
292 return (WALK_CONTINUE);
296 vnet_gre_tunnel_add (vnet_gre_tunnel_add_del_args_t * a,
297 u32 outer_fib_index, u32 * sw_if_indexp)
299 gre_main_t *gm = &gre_main;
300 vnet_main_t *vnm = gm->vnet_main;
301 ip4_main_t *im4 = &ip4_main;
302 ip6_main_t *im6 = &ip6_main;
304 vnet_hw_interface_t *hi;
305 u32 hw_if_index, sw_if_index;
307 u8 is_ipv6 = a->is_ipv6;
308 gre_tunnel_key_t key;
310 t = gre_tunnel_db_find (a, outer_fib_index, &key);
312 return VNET_API_ERROR_IF_ALREADY_EXISTS;
314 pool_get_aligned (gm->tunnels, t, CLIB_CACHE_LINE_BYTES);
315 clib_memset (t, 0, sizeof (*t));
317 /* Reconcile the real dev_instance and a possible requested instance */
318 u32 t_idx = t - gm->tunnels; /* tunnel index (or instance) */
319 u32 u_idx = a->instance; /* user specified instance */
322 if (hash_get (gm->instance_used, u_idx))
324 pool_put (gm->tunnels, t);
325 return VNET_API_ERROR_INSTANCE_IN_USE;
327 hash_set (gm->instance_used, u_idx, 1);
329 t->dev_instance = t_idx; /* actual */
330 t->user_instance = u_idx; /* name */
334 if (t->type == GRE_TUNNEL_TYPE_ERSPAN)
335 t->session_id = a->session_id;
337 if (t->type == GRE_TUNNEL_TYPE_L3)
339 if (t->mode == GRE_TUNNEL_MODE_P2P)
341 vnet_register_interface (vnm, gre_device_class.index, t_idx,
342 gre_hw_interface_class.index, t_idx);
345 vnet_register_interface (vnm, gre_device_class.index, t_idx,
346 mgre_hw_interface_class.index, t_idx);
350 /* Default MAC address (d00b:eed0:0000 + sw_if_index) */
352 { 0xd0, 0x0b, 0xee, 0xd0, (u8) (t_idx >> 8), (u8) t_idx };
354 ethernet_register_interface (vnm, gre_device_class.index, t_idx,
355 address, &hw_if_index, 0);
358 clib_error_report (error);
359 return VNET_API_ERROR_INVALID_REGISTRATION;
363 /* Set GRE tunnel interface output node (not used for L3 payload) */
364 vnet_set_interface_output_node (vnm, hw_if_index, gre_encap_node.index);
366 hi = vnet_get_hw_interface (vnm, hw_if_index);
367 sw_if_index = hi->sw_if_index;
369 t->hw_if_index = hw_if_index;
370 t->outer_fib_index = outer_fib_index;
371 t->sw_if_index = sw_if_index;
372 t->l2_adj_index = ADJ_INDEX_INVALID;
374 vec_validate_init_empty (gm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
375 gm->tunnel_index_by_sw_if_index[sw_if_index] = t_idx;
379 vec_validate (im4->fib_index_by_sw_if_index, sw_if_index);
380 hi->min_packet_bytes =
381 64 + sizeof (gre_header_t) + sizeof (ip4_header_t);
385 vec_validate (im6->fib_index_by_sw_if_index, sw_if_index);
386 hi->min_packet_bytes =
387 64 + sizeof (gre_header_t) + sizeof (ip6_header_t);
390 /* Standard default gre MTU. */
391 vnet_sw_interface_set_mtu (vnm, sw_if_index, 9000);
394 * source the FIB entry for the tunnel's destination
395 * and become a child thereof. The tunnel will then get poked
396 * when the forwarding for the entry updates, and the tunnel can
397 * re-stack accordingly
400 clib_memcpy (&t->tunnel_src, &a->src, sizeof (t->tunnel_src));
401 t->tunnel_dst.fp_len = !is_ipv6 ? 32 : 128;
402 t->tunnel_dst.fp_proto = !is_ipv6 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
403 t->tunnel_dst.fp_addr = a->dst;
405 gre_tunnel_db_add (t, &key);
407 if (t->mode == GRE_TUNNEL_MODE_MP)
408 nhrp_walk_itf (t->sw_if_index, gre_tunnel_add_nhrp_walk, t);
410 if (t->type == GRE_TUNNEL_TYPE_ERSPAN)
415 gre_mk_sn_key (t, &skey);
416 gre_sn = (gre_sn_t *) hash_get_mem (gm->seq_num_by_key, &skey);
424 gre_sn = clib_mem_alloc (sizeof (gre_sn_t));
426 gre_sn->ref_count = 1;
428 hash_set_mem_alloc (&gm->seq_num_by_key, &skey, (uword) gre_sn);
432 if (t->type != GRE_TUNNEL_TYPE_L3)
434 t->l2_adj_index = adj_nbr_add_or_lock
435 (t->tunnel_dst.fp_proto, VNET_LINK_ETHERNET, &zero_addr, sw_if_index);
436 gre_update_adj (vnm, t->sw_if_index, t->l2_adj_index);
440 *sw_if_indexp = sw_if_index;
442 /* register gre46-input nodes */
443 ip4_register_protocol (IP_PROTOCOL_GRE, gre4_input_node.index);
444 ip6_register_protocol (IP_PROTOCOL_GRE, gre6_input_node.index);
450 vnet_gre_tunnel_delete (vnet_gre_tunnel_add_del_args_t * a,
451 u32 outer_fib_index, u32 * sw_if_indexp)
453 gre_main_t *gm = &gre_main;
454 vnet_main_t *vnm = gm->vnet_main;
456 gre_tunnel_key_t key;
459 t = gre_tunnel_db_find (a, outer_fib_index, &key);
461 return VNET_API_ERROR_NO_SUCH_ENTRY;
463 if (t->mode == GRE_TUNNEL_MODE_MP)
464 nhrp_walk_itf (t->sw_if_index, gre_tunnel_delete_nhrp_walk, t);
466 sw_if_index = t->sw_if_index;
467 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
469 /* make sure tunnel is removed from l2 bd or xconnect */
470 set_int_l2_mode (gm->vlib_main, vnm, MODE_L3, sw_if_index, 0,
471 L2_BD_PORT_TYPE_NORMAL, 0, 0);
472 gm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
474 if (t->type == GRE_TUNNEL_TYPE_L3)
475 vnet_delete_hw_interface (vnm, t->hw_if_index);
477 ethernet_delete_interface (vnm, t->hw_if_index);
479 if (t->l2_adj_index != ADJ_INDEX_INVALID)
481 adj_midchain_delegate_unstack (t->l2_adj_index);
482 adj_unlock (t->l2_adj_index);
485 ASSERT ((t->type != GRE_TUNNEL_TYPE_ERSPAN) || (t->gre_sn != NULL));
486 if ((t->type == GRE_TUNNEL_TYPE_ERSPAN) && (t->gre_sn->ref_count-- == 1))
489 gre_mk_sn_key (t, &skey);
490 hash_unset_mem_free (&gm->seq_num_by_key, &skey);
491 clib_mem_free (t->gre_sn);
494 hash_unset (gm->instance_used, t->user_instance);
495 gre_tunnel_db_remove (t, &key);
496 pool_put (gm->tunnels, t);
499 *sw_if_indexp = sw_if_index;
505 vnet_gre_tunnel_add_del (vnet_gre_tunnel_add_del_args_t * a,
511 outer_fib_index = ip4_fib_index_from_table_id (a->outer_table_id);
513 outer_fib_index = ip6_fib_index_from_table_id (a->outer_table_id);
515 if (~0 == outer_fib_index)
516 return VNET_API_ERROR_NO_SUCH_FIB;
518 if (a->session_id > GTK_SESSION_ID_MAX)
519 return VNET_API_ERROR_INVALID_SESSION_ID;
521 if (a->mode == GRE_TUNNEL_MODE_MP && !ip46_address_is_zero (&a->dst))
522 return (VNET_API_ERROR_INVALID_DST_ADDRESS);
525 return (vnet_gre_tunnel_add (a, outer_fib_index, sw_if_indexp));
527 return (vnet_gre_tunnel_delete (a, outer_fib_index, sw_if_indexp));
531 gre_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
533 gre_main_t *gm = &gre_main;
534 vnet_hw_interface_t *hi;
538 hi = vnet_get_hw_interface (vnm, hw_if_index);
540 if (NULL == gm->tunnel_index_by_sw_if_index ||
541 hi->sw_if_index >= vec_len (gm->tunnel_index_by_sw_if_index))
544 ti = gm->tunnel_index_by_sw_if_index[hi->sw_if_index];
547 /* not one of ours */
550 t = pool_elt_at_index (gm->tunnels, ti);
552 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
553 vnet_hw_interface_set_flags (vnm, hw_if_index,
554 VNET_HW_INTERFACE_FLAG_LINK_UP);
556 vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */ );
558 gre_tunnel_restack (t);
560 return /* no error */ 0;
563 static clib_error_t *
564 create_gre_tunnel_command_fn (vlib_main_t * vm,
565 unformat_input_t * input,
566 vlib_cli_command_t * cmd)
568 unformat_input_t _line_input, *line_input = &_line_input;
569 vnet_gre_tunnel_add_del_args_t _a, *a = &_a;
570 ip46_address_t src = ip46_address_initializer, dst =
571 ip46_address_initializer;
573 u32 outer_table_id = 0;
574 gre_tunnel_type_t t_type = GRE_TUNNEL_TYPE_L3;
575 gre_tunnel_mode_t t_mode = GRE_TUNNEL_MODE_P2P;
580 clib_error_t *error = NULL;
582 /* Get a line of input. */
583 if (!unformat_user (input, unformat_line_input, line_input))
586 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
588 if (unformat (line_input, "del"))
590 else if (unformat (line_input, "instance %d", &instance))
592 else if (unformat (line_input, "src %U", unformat_ip46_address, &src))
594 else if (unformat (line_input, "dst %U", unformat_ip46_address, &dst))
596 else if (unformat (line_input, "outer-table-id %d", &outer_table_id))
598 else if (unformat (line_input, "multipoint"))
599 t_mode = GRE_TUNNEL_MODE_MP;
600 else if (unformat (line_input, "teb"))
601 t_type = GRE_TUNNEL_TYPE_TEB;
602 else if (unformat (line_input, "erspan %d", &session_id))
603 t_type = GRE_TUNNEL_TYPE_ERSPAN;
606 error = clib_error_return (0, "unknown input `%U'",
607 format_unformat_error, line_input);
612 if (ip46_address_is_equal (&src, &dst))
614 error = clib_error_return (0, "src and dst are identical");
618 if (t_mode != GRE_TUNNEL_MODE_MP && ip46_address_is_zero (&dst))
620 error = clib_error_return (0, "destination address not specified");
624 if (ip46_address_is_zero (&src))
626 error = clib_error_return (0, "source address not specified");
630 if (ip46_address_is_ip4 (&src) != ip46_address_is_ip4 (&dst))
633 clib_error_return (0, "src and dst address must be the same AF");
637 clib_memset (a, 0, sizeof (*a));
639 a->outer_table_id = outer_table_id;
642 a->session_id = session_id;
643 a->is_ipv6 = !ip46_address_is_ip4 (&src);
644 a->instance = instance;
645 clib_memcpy (&a->src, &src, sizeof (a->src));
646 clib_memcpy (&a->dst, &dst, sizeof (a->dst));
648 rv = vnet_gre_tunnel_add_del (a, &sw_if_index);
653 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
654 vnet_get_main (), sw_if_index);
656 case VNET_API_ERROR_IF_ALREADY_EXISTS:
657 error = clib_error_return (0, "GRE tunnel already exists...");
659 case VNET_API_ERROR_NO_SUCH_FIB:
660 error = clib_error_return (0, "outer table ID %d doesn't exist\n",
663 case VNET_API_ERROR_NO_SUCH_ENTRY:
664 error = clib_error_return (0, "GRE tunnel doesn't exist");
666 case VNET_API_ERROR_INVALID_SESSION_ID:
667 error = clib_error_return (0, "session ID %d out of range\n",
670 case VNET_API_ERROR_INSTANCE_IN_USE:
671 error = clib_error_return (0, "Instance is in use");
675 clib_error_return (0, "vnet_gre_tunnel_add_del returned %d", rv);
680 unformat_free (line_input);
686 VLIB_CLI_COMMAND (create_gre_tunnel_command, static) = {
687 .path = "create gre tunnel",
688 .short_help = "create gre tunnel src <addr> dst <addr> [instance <n>] "
689 "[outer-fib-id <fib>] [teb | erspan <session-id>] [del]",
690 .function = create_gre_tunnel_command_fn,
694 static clib_error_t *
695 show_gre_tunnel_command_fn (vlib_main_t * vm,
696 unformat_input_t * input,
697 vlib_cli_command_t * cmd)
699 gre_main_t *gm = &gre_main;
703 if (pool_elts (gm->tunnels) == 0)
704 vlib_cli_output (vm, "No GRE tunnels configured...");
706 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
708 if (unformat (input, "%d", &ti))
717 pool_foreach (t, gm->tunnels,
719 vlib_cli_output (vm, "%U", format_gre_tunnel, t);
725 t = pool_elt_at_index (gm->tunnels, ti);
727 vlib_cli_output (vm, "%U", format_gre_tunnel, t);
734 VLIB_CLI_COMMAND (show_gre_tunnel_command, static) = {
735 .path = "show gre tunnel",
736 .function = show_gre_tunnel_command_fn,
740 const static nhrp_vft_t gre_nhrp_vft = {
741 .nv_added = gre_nhrp_entry_added,
742 .nv_deleted = gre_nhrp_entry_deleted,
745 /* force inclusion from application's main.c */
747 gre_interface_init (vlib_main_t * vm)
749 nhrp_register (&gre_nhrp_vft);
754 VLIB_INIT_FUNCTION (gre_interface_init);
757 * fd.io coding-style-patch-verification: ON
760 * eval: (c-set-style "gnu")