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 fib_forward_chain_type_t fib_fwd;
132 gre_main_t *gm = &gre_main;
133 dpo_id_t tmp = DPO_INVALID;
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_nbr_midchain_unstack (ai);
155 fib_fwd = fib_forw_chain_type_from_fib_proto (gt->tunnel_dst.fp_proto);
157 fib_entry_contribute_forwarding (gt->fib_entry_index, fib_fwd, &tmp);
158 if (DPO_LOAD_BALANCE == tmp.dpoi_type)
161 * post GRE rewrite we will load-balance. However, the GRE encap
162 * is always the same for this adjacency/tunnel and hence the IP/GRE
163 * src,dst hash is always the same result too. So we do that hash now and
164 * stack on the choice.
165 * If the choice is an incomplete adj then we will need a poke when
166 * it becomes complete. This happens since the adj update walk propagates
167 * as far a recursive paths.
169 const dpo_id_t *choice;
173 lb = load_balance_get (tmp.dpoi_index);
175 if (fib_fwd == FIB_FORW_CHAIN_TYPE_UNICAST_IP4)
176 hash = ip4_compute_flow_hash ((ip4_header_t *) adj_get_rewrite (ai),
179 hash = ip6_compute_flow_hash ((ip6_header_t *) adj_get_rewrite (ai),
182 load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
183 dpo_copy (&tmp, choice);
186 adj_nbr_midchain_stack (ai, &tmp);
191 * @brief Call back when restacking all adjacencies on a GRE interface
194 gre_adj_walk_cb (adj_index_t ai, void *ctx)
196 gre_tunnel_stack (ai);
198 return (ADJ_WALK_RC_CONTINUE);
202 gre_tunnel_restack (gre_tunnel_t * gt)
204 fib_protocol_t proto;
207 * walk all the adjacencies on th GRE interface and restack them
209 FOR_EACH_FIB_IP_PROTOCOL (proto)
211 adj_nbr_walk (gt->sw_if_index, proto, gre_adj_walk_cb, NULL);
216 * Function definition to backwalk a FIB node
218 static fib_node_back_walk_rc_t
219 gre_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
221 gre_tunnel_restack (gre_tunnel_from_fib_node (node));
223 return (FIB_NODE_BACK_WALK_CONTINUE);
227 * Function definition to get a FIB node from its index
230 gre_tunnel_fib_node_get (fib_node_index_t index)
236 gt = pool_elt_at_index (gm->tunnels, index);
242 * Function definition to inform the FIB node that its last lock has gone.
245 gre_tunnel_last_lock_gone (fib_node_t * node)
248 * The MPLS GRE tunnel is a root of the graph. As such
249 * it never has children and thus is never locked.
255 * Virtual function table registered by MPLS GRE tunnels
256 * for participation in the FIB object graph.
258 const static fib_node_vft_t gre_vft = {
259 .fnv_get = gre_tunnel_fib_node_get,
260 .fnv_last_lock = gre_tunnel_last_lock_gone,
261 .fnv_back_walk = gre_tunnel_back_walk,
265 vnet_gre_tunnel_add (vnet_gre_add_del_tunnel_args_t * a,
266 u32 outer_fib_index, u32 * sw_if_indexp)
268 gre_main_t *gm = &gre_main;
269 vnet_main_t *vnm = gm->vnet_main;
270 ip4_main_t *im4 = &ip4_main;
271 ip6_main_t *im6 = &ip6_main;
273 vnet_hw_interface_t *hi;
274 u32 hw_if_index, sw_if_index;
276 u8 is_ipv6 = a->is_ipv6;
277 gre_tunnel_key_t key;
279 t = gre_tunnel_db_find (a, outer_fib_index, &key);
281 return VNET_API_ERROR_IF_ALREADY_EXISTS;
283 pool_get_aligned (gm->tunnels, t, CLIB_CACHE_LINE_BYTES);
284 clib_memset (t, 0, sizeof (*t));
286 /* Reconcile the real dev_instance and a possible requested instance */
287 u32 t_idx = t - gm->tunnels; /* tunnel index (or instance) */
288 u32 u_idx = a->instance; /* user specified instance */
291 if (hash_get (gm->instance_used, u_idx))
293 pool_put (gm->tunnels, t);
294 return VNET_API_ERROR_INSTANCE_IN_USE;
296 hash_set (gm->instance_used, u_idx, 1);
298 t->dev_instance = t_idx; /* actual */
299 t->user_instance = u_idx; /* name */
300 fib_node_init (&t->node, FIB_NODE_TYPE_GRE_TUNNEL);
302 t->type = a->tunnel_type;
303 if (t->type == GRE_TUNNEL_TYPE_ERSPAN)
304 t->session_id = a->session_id;
306 if (t->type == GRE_TUNNEL_TYPE_L3)
307 hw_if_index = vnet_register_interface (vnm, gre_device_class.index, t_idx,
308 gre_hw_interface_class.index,
312 /* Default MAC address (d00b:eed0:0000 + sw_if_index) */
314 { 0xd0, 0x0b, 0xee, 0xd0, (u8) (t_idx >> 8), (u8) t_idx };
316 ethernet_register_interface (vnm, gre_device_class.index, t_idx,
317 address, &hw_if_index, 0);
320 clib_error_report (error);
321 return VNET_API_ERROR_INVALID_REGISTRATION;
325 /* Set GRE tunnel interface output node (not used for L3 payload) */
326 vnet_set_interface_output_node (vnm, hw_if_index, gre_encap_node.index);
328 hi = vnet_get_hw_interface (vnm, hw_if_index);
329 sw_if_index = hi->sw_if_index;
331 t->hw_if_index = hw_if_index;
332 t->outer_fib_index = outer_fib_index;
333 t->sw_if_index = sw_if_index;
334 t->l2_adj_index = ADJ_INDEX_INVALID;
336 vec_validate_init_empty (gm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
337 gm->tunnel_index_by_sw_if_index[sw_if_index] = t_idx;
341 vec_validate (im4->fib_index_by_sw_if_index, sw_if_index);
342 hi->min_packet_bytes =
343 64 + sizeof (gre_header_t) + sizeof (ip4_header_t);
347 vec_validate (im6->fib_index_by_sw_if_index, sw_if_index);
348 hi->min_packet_bytes =
349 64 + sizeof (gre_header_t) + sizeof (ip6_header_t);
352 /* Standard default gre MTU. */
353 vnet_sw_interface_set_mtu (vnm, sw_if_index, 9000);
356 * source the FIB entry for the tunnel's destination
357 * and become a child thereof. The tunnel will then get poked
358 * when the forwarding for the entry updates, and the tunnel can
359 * re-stack accordingly
362 clib_memcpy (&t->tunnel_src, &a->src, sizeof (t->tunnel_src));
363 t->tunnel_dst.fp_len = !is_ipv6 ? 32 : 128;
364 t->tunnel_dst.fp_proto = !is_ipv6 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
365 t->tunnel_dst.fp_addr = a->dst;
367 gre_tunnel_db_add (t, &key);
368 if (t->type == GRE_TUNNEL_TYPE_ERSPAN)
373 gre_mk_sn_key (t, &skey);
374 gre_sn = (gre_sn_t *) hash_get_mem (gm->seq_num_by_key, &skey);
382 gre_sn = clib_mem_alloc (sizeof (gre_sn_t));
384 gre_sn->ref_count = 1;
386 hash_set_mem_alloc (&gm->seq_num_by_key, &skey, (uword) gre_sn);
390 t->fib_entry_index = fib_table_entry_special_add
391 (outer_fib_index, &t->tunnel_dst, FIB_SOURCE_RR, FIB_ENTRY_FLAG_NONE);
392 t->sibling_index = fib_entry_child_add
393 (t->fib_entry_index, FIB_NODE_TYPE_GRE_TUNNEL, t_idx);
395 if (t->type != GRE_TUNNEL_TYPE_L3)
397 t->l2_adj_index = adj_nbr_add_or_lock
398 (t->tunnel_dst.fp_proto, VNET_LINK_ETHERNET, &zero_addr, sw_if_index);
399 gre_update_adj (vnm, t->sw_if_index, t->l2_adj_index);
403 *sw_if_indexp = sw_if_index;
409 vnet_gre_tunnel_delete (vnet_gre_add_del_tunnel_args_t * a,
410 u32 outer_fib_index, u32 * sw_if_indexp)
412 gre_main_t *gm = &gre_main;
413 vnet_main_t *vnm = gm->vnet_main;
415 gre_tunnel_key_t key;
418 t = gre_tunnel_db_find (a, outer_fib_index, &key);
420 return VNET_API_ERROR_NO_SUCH_ENTRY;
422 sw_if_index = t->sw_if_index;
423 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
425 /* make sure tunnel is removed from l2 bd or xconnect */
426 set_int_l2_mode (gm->vlib_main, vnm, MODE_L3, sw_if_index, 0,
427 L2_BD_PORT_TYPE_NORMAL, 0, 0);
428 gm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
430 if (t->type == GRE_TUNNEL_TYPE_L3)
431 vnet_delete_hw_interface (vnm, t->hw_if_index);
433 ethernet_delete_interface (vnm, t->hw_if_index);
435 if (t->l2_adj_index != ADJ_INDEX_INVALID)
436 adj_unlock (t->l2_adj_index);
438 fib_entry_child_remove (t->fib_entry_index, t->sibling_index);
439 fib_table_entry_delete_index (t->fib_entry_index, FIB_SOURCE_RR);
441 ASSERT ((t->type != GRE_TUNNEL_TYPE_ERSPAN) || (t->gre_sn != NULL));
442 if ((t->type == GRE_TUNNEL_TYPE_ERSPAN) && (t->gre_sn->ref_count-- == 1))
445 gre_mk_sn_key (t, &skey);
446 hash_unset_mem_free (&gm->seq_num_by_key, &skey);
447 clib_mem_free (t->gre_sn);
450 hash_unset (gm->instance_used, t->user_instance);
451 gre_tunnel_db_remove (t);
452 fib_node_deinit (&t->node);
453 pool_put (gm->tunnels, t);
456 *sw_if_indexp = sw_if_index;
462 vnet_gre_add_del_tunnel (vnet_gre_add_del_tunnel_args_t * a,
468 outer_fib_index = ip4_fib_index_from_table_id (a->outer_fib_id);
470 outer_fib_index = ip6_fib_index_from_table_id (a->outer_fib_id);
472 if (~0 == outer_fib_index)
473 return VNET_API_ERROR_NO_SUCH_FIB;
475 if (a->session_id > GTK_SESSION_ID_MAX)
476 return VNET_API_ERROR_INVALID_SESSION_ID;
479 return (vnet_gre_tunnel_add (a, outer_fib_index, sw_if_indexp));
481 return (vnet_gre_tunnel_delete (a, outer_fib_index, sw_if_indexp));
485 gre_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
487 gre_main_t *gm = &gre_main;
488 vnet_hw_interface_t *hi;
492 hi = vnet_get_hw_interface (vnm, hw_if_index);
494 if (NULL == gm->tunnel_index_by_sw_if_index ||
495 hi->sw_if_index >= vec_len (gm->tunnel_index_by_sw_if_index))
498 ti = gm->tunnel_index_by_sw_if_index[hi->sw_if_index];
501 /* not one of ours */
504 t = pool_elt_at_index (gm->tunnels, ti);
506 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
507 vnet_hw_interface_set_flags (vnm, hw_if_index,
508 VNET_HW_INTERFACE_FLAG_LINK_UP);
510 vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */ );
512 gre_tunnel_restack (t);
514 return /* no error */ 0;
517 static clib_error_t *
518 create_gre_tunnel_command_fn (vlib_main_t * vm,
519 unformat_input_t * input,
520 vlib_cli_command_t * cmd)
522 unformat_input_t _line_input, *line_input = &_line_input;
523 vnet_gre_add_del_tunnel_args_t _a, *a = &_a;
524 ip46_address_t src, dst;
526 u32 outer_fib_id = 0;
527 gre_tunnel_type_t t_type = GRE_TUNNEL_TYPE_L3;
533 clib_error_t *error = NULL;
537 /* Get a line of input. */
538 if (!unformat_user (input, unformat_line_input, line_input))
541 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
543 if (unformat (line_input, "del"))
545 else if (unformat (line_input, "instance %d", &instance))
548 if (unformat (line_input, "src %U", unformat_ip4_address, &src.ip4))
554 if (unformat (line_input, "dst %U", unformat_ip4_address, &dst.ip4))
560 if (unformat (line_input, "src %U", unformat_ip6_address, &src.ip6))
566 if (unformat (line_input, "dst %U", unformat_ip6_address, &dst.ip6))
571 else if (unformat (line_input, "outer-fib-id %d", &outer_fib_id))
573 else if (unformat (line_input, "teb"))
574 t_type = GRE_TUNNEL_TYPE_TEB;
575 else if (unformat (line_input, "erspan %d", &session_id))
576 t_type = GRE_TUNNEL_TYPE_ERSPAN;
579 error = clib_error_return (0, "unknown input `%U'",
580 format_unformat_error, line_input);
587 error = clib_error_return (0, "mandatory argument(s) missing");
591 if ((ipv4_set && memcmp (&src.ip4, &dst.ip4, sizeof (src.ip4)) == 0) ||
592 (ipv6_set && memcmp (&src.ip6, &dst.ip6, sizeof (src.ip6)) == 0))
594 error = clib_error_return (0, "src and dst are identical");
598 if (ipv4_set && ipv6_set)
599 return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
601 if ((ipv4_set && memcmp (&dst.ip4, &zero_addr.ip4, sizeof (dst.ip4)) == 0)
603 && memcmp (&dst.ip6, &zero_addr.ip6, sizeof (dst.ip6)) == 0))
605 error = clib_error_return (0, "dst address cannot be zero");
609 clib_memset (a, 0, sizeof (*a));
611 a->outer_fib_id = outer_fib_id;
612 a->tunnel_type = t_type;
613 a->session_id = session_id;
614 a->is_ipv6 = ipv6_set;
615 a->instance = instance;
618 clib_memcpy (&a->src.ip4, &src.ip4, sizeof (src.ip4));
619 clib_memcpy (&a->dst.ip4, &dst.ip4, sizeof (dst.ip4));
623 clib_memcpy (&a->src.ip6, &src.ip6, sizeof (src.ip6));
624 clib_memcpy (&a->dst.ip6, &dst.ip6, sizeof (dst.ip6));
627 rv = vnet_gre_add_del_tunnel (a, &sw_if_index);
632 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
633 vnet_get_main (), sw_if_index);
635 case VNET_API_ERROR_IF_ALREADY_EXISTS:
636 error = clib_error_return (0, "GRE tunnel already exists...");
638 case VNET_API_ERROR_NO_SUCH_FIB:
639 error = clib_error_return (0, "outer fib ID %d doesn't exist\n",
642 case VNET_API_ERROR_NO_SUCH_ENTRY:
643 error = clib_error_return (0, "GRE tunnel doesn't exist");
645 case VNET_API_ERROR_INVALID_SESSION_ID:
646 error = clib_error_return (0, "session ID %d out of range\n",
649 case VNET_API_ERROR_INSTANCE_IN_USE:
650 error = clib_error_return (0, "Instance is in use");
654 clib_error_return (0, "vnet_gre_add_del_tunnel returned %d", rv);
659 unformat_free (line_input);
665 VLIB_CLI_COMMAND (create_gre_tunnel_command, static) = {
666 .path = "create gre tunnel",
667 .short_help = "create gre tunnel src <addr> dst <addr> [instance <n>] "
668 "[outer-fib-id <fib>] [teb | erspan <session-id>] [del]",
669 .function = create_gre_tunnel_command_fn,
673 static clib_error_t *
674 show_gre_tunnel_command_fn (vlib_main_t * vm,
675 unformat_input_t * input,
676 vlib_cli_command_t * cmd)
678 gre_main_t *gm = &gre_main;
682 if (pool_elts (gm->tunnels) == 0)
683 vlib_cli_output (vm, "No GRE tunnels configured...");
685 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
687 if (unformat (input, "%d", &ti))
696 pool_foreach (t, gm->tunnels,
698 vlib_cli_output (vm, "%U", format_gre_tunnel, t);
704 t = pool_elt_at_index (gm->tunnels, ti);
706 vlib_cli_output (vm, "%U", format_gre_tunnel, t);
713 VLIB_CLI_COMMAND (show_gre_tunnel_command, static) = {
714 .path = "show gre tunnel",
715 .function = show_gre_tunnel_command_fn,
719 /* force inclusion from application's main.c */
721 gre_interface_init (vlib_main_t * vm)
723 fib_node_register_type (FIB_NODE_TYPE_GRE_TUNNEL, &gre_vft);
728 VLIB_INIT_FUNCTION (gre_interface_init);
731 * fd.io coding-style-patch-verification: ON
734 * eval: (c-set-style "gnu")