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>
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_mode (u8 * s, va_list * args)
49 gre_tunnel_mode_t mode = va_arg (*args, int);
53 #define _(n, v) case GRE_TUNNEL_MODE_##n: \
54 s = format (s, "%s", v); \
56 foreach_gre_tunnel_mode
64 format_gre_tunnel (u8 * s, va_list * args)
66 gre_tunnel_t *t = va_arg (*args, gre_tunnel_t *);
68 s = format (s, "[%d] instance %d src %U dst %U fib-idx %d sw-if-idx %d ",
69 t->dev_instance, t->user_instance,
70 format_ip46_address, &t->tunnel_src, IP46_TYPE_ANY,
71 format_ip46_address, &t->tunnel_dst.fp_addr, IP46_TYPE_ANY,
72 t->outer_fib_index, t->sw_if_index);
74 s = format (s, "payload %U ", format_gre_tunnel_type, t->type);
75 s = format (s, "%U ", format_gre_tunnel_mode, t->mode);
77 if (t->type == GRE_TUNNEL_TYPE_ERSPAN)
78 s = format (s, "session %d ", t->session_id);
80 if (t->type != GRE_TUNNEL_TYPE_L3)
81 s = format (s, "l2-adj-idx %d ", t->l2_adj_index);
87 gre_tunnel_db_find (const vnet_gre_tunnel_add_del_args_t * a,
88 u32 outer_fib_index, gre_tunnel_key_t * key)
90 gre_main_t *gm = &gre_main;
95 gre_mk_key4 (a->src.ip4, a->dst.ip4, outer_fib_index,
96 a->type, a->session_id, &key->gtk_v4);
97 p = hash_get_mem (gm->tunnel_by_key4, &key->gtk_v4);
101 gre_mk_key6 (&a->src.ip6, &a->dst.ip6, outer_fib_index,
102 a->type, a->session_id, &key->gtk_v6);
103 p = hash_get_mem (gm->tunnel_by_key6, &key->gtk_v6);
109 return (pool_elt_at_index (gm->tunnels, p[0]));
113 gre_tunnel_db_add (gre_tunnel_t * t, gre_tunnel_key_t * key)
115 gre_main_t *gm = &gre_main;
117 t->key = clib_mem_alloc (sizeof (*t->key));
118 clib_memcpy (t->key, key, sizeof (*key));
120 if (t->tunnel_dst.fp_proto == FIB_PROTOCOL_IP6)
122 hash_set_mem (gm->tunnel_by_key6, &t->key->gtk_v6, t->dev_instance);
126 hash_set_mem (gm->tunnel_by_key4, &t->key->gtk_v4, t->dev_instance);
131 gre_tunnel_db_remove (gre_tunnel_t * t)
133 gre_main_t *gm = &gre_main;
135 if (t->tunnel_dst.fp_proto == FIB_PROTOCOL_IP6)
137 hash_unset_mem (gm->tunnel_by_key6, &t->key->gtk_v6);
141 hash_unset_mem (gm->tunnel_by_key4, &t->key->gtk_v4);
144 clib_mem_free (t->key);
151 * 'stack' (resolve the recursion for) the tunnel's midchain adjacency
154 gre_tunnel_stack (adj_index_t ai)
156 gre_main_t *gm = &gre_main;
162 sw_if_index = adj->rewrite_header.sw_if_index;
164 if ((vec_len (gm->tunnel_index_by_sw_if_index) <= sw_if_index) ||
165 (~0 == gm->tunnel_index_by_sw_if_index[sw_if_index]))
168 gt = pool_elt_at_index (gm->tunnels,
169 gm->tunnel_index_by_sw_if_index[sw_if_index]);
171 if ((vnet_hw_interface_get_flags (vnet_get_main (), gt->hw_if_index) &
172 VNET_HW_INTERFACE_FLAG_LINK_UP) == 0)
174 adj_midchain_delegate_unstack (ai);
178 adj_midchain_delegate_stack (ai, gt->outer_fib_index, >->tunnel_dst);
183 * @brief Call back when restacking all adjacencies on a GRE interface
186 gre_adj_walk_cb (adj_index_t ai, void *ctx)
188 gre_tunnel_stack (ai);
190 return (ADJ_WALK_RC_CONTINUE);
194 gre_tunnel_restack (gre_tunnel_t * gt)
196 fib_protocol_t proto;
199 * walk all the adjacencies on th GRE interface and restack them
201 FOR_EACH_FIB_IP_PROTOCOL (proto)
203 adj_nbr_walk (gt->sw_if_index, proto, gre_adj_walk_cb, NULL);
208 vnet_gre_tunnel_add (vnet_gre_tunnel_add_del_args_t * a,
209 u32 outer_fib_index, u32 * sw_if_indexp)
211 gre_main_t *gm = &gre_main;
212 vnet_main_t *vnm = gm->vnet_main;
213 ip4_main_t *im4 = &ip4_main;
214 ip6_main_t *im6 = &ip6_main;
216 vnet_hw_interface_t *hi;
217 u32 hw_if_index, sw_if_index;
219 u8 is_ipv6 = a->is_ipv6;
220 gre_tunnel_key_t key;
222 t = gre_tunnel_db_find (a, outer_fib_index, &key);
224 return VNET_API_ERROR_IF_ALREADY_EXISTS;
226 pool_get_aligned (gm->tunnels, t, CLIB_CACHE_LINE_BYTES);
227 clib_memset (t, 0, sizeof (*t));
229 /* Reconcile the real dev_instance and a possible requested instance */
230 u32 t_idx = t - gm->tunnels; /* tunnel index (or instance) */
231 u32 u_idx = a->instance; /* user specified instance */
234 if (hash_get (gm->instance_used, u_idx))
236 pool_put (gm->tunnels, t);
237 return VNET_API_ERROR_INSTANCE_IN_USE;
239 hash_set (gm->instance_used, u_idx, 1);
241 t->dev_instance = t_idx; /* actual */
242 t->user_instance = u_idx; /* name */
246 if (t->type == GRE_TUNNEL_TYPE_ERSPAN)
247 t->session_id = a->session_id;
249 if (t->type == GRE_TUNNEL_TYPE_L3)
251 if (t->mode == GRE_TUNNEL_MODE_P2P)
253 vnet_register_interface (vnm, gre_device_class.index, t_idx,
254 gre_hw_interface_class.index, t_idx);
257 vnet_register_interface (vnm, gre_device_class.index, t_idx,
258 mgre_hw_interface_class.index, t_idx);
262 /* Default MAC address (d00b:eed0:0000 + sw_if_index) */
264 { 0xd0, 0x0b, 0xee, 0xd0, (u8) (t_idx >> 8), (u8) t_idx };
266 ethernet_register_interface (vnm, gre_device_class.index, t_idx,
267 address, &hw_if_index, 0);
270 clib_error_report (error);
271 return VNET_API_ERROR_INVALID_REGISTRATION;
275 /* Set GRE tunnel interface output node (not used for L3 payload) */
276 vnet_set_interface_output_node (vnm, hw_if_index, gre_encap_node.index);
278 hi = vnet_get_hw_interface (vnm, hw_if_index);
279 sw_if_index = hi->sw_if_index;
281 t->hw_if_index = hw_if_index;
282 t->outer_fib_index = outer_fib_index;
283 t->sw_if_index = sw_if_index;
284 t->l2_adj_index = ADJ_INDEX_INVALID;
286 vec_validate_init_empty (gm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
287 gm->tunnel_index_by_sw_if_index[sw_if_index] = t_idx;
291 vec_validate (im4->fib_index_by_sw_if_index, sw_if_index);
292 hi->min_packet_bytes =
293 64 + sizeof (gre_header_t) + sizeof (ip4_header_t);
297 vec_validate (im6->fib_index_by_sw_if_index, sw_if_index);
298 hi->min_packet_bytes =
299 64 + sizeof (gre_header_t) + sizeof (ip6_header_t);
302 /* Standard default gre MTU. */
303 vnet_sw_interface_set_mtu (vnm, sw_if_index, 9000);
306 * source the FIB entry for the tunnel's destination
307 * and become a child thereof. The tunnel will then get poked
308 * when the forwarding for the entry updates, and the tunnel can
309 * re-stack accordingly
312 clib_memcpy (&t->tunnel_src, &a->src, sizeof (t->tunnel_src));
313 t->tunnel_dst.fp_len = !is_ipv6 ? 32 : 128;
314 t->tunnel_dst.fp_proto = !is_ipv6 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
315 t->tunnel_dst.fp_addr = a->dst;
317 gre_tunnel_db_add (t, &key);
318 if (t->type == GRE_TUNNEL_TYPE_ERSPAN)
323 gre_mk_sn_key (t, &skey);
324 gre_sn = (gre_sn_t *) hash_get_mem (gm->seq_num_by_key, &skey);
332 gre_sn = clib_mem_alloc (sizeof (gre_sn_t));
334 gre_sn->ref_count = 1;
336 hash_set_mem_alloc (&gm->seq_num_by_key, &skey, (uword) gre_sn);
340 if (t->type != GRE_TUNNEL_TYPE_L3)
342 t->l2_adj_index = adj_nbr_add_or_lock
343 (t->tunnel_dst.fp_proto, VNET_LINK_ETHERNET, &zero_addr, sw_if_index);
344 gre_update_adj (vnm, t->sw_if_index, t->l2_adj_index);
348 *sw_if_indexp = sw_if_index;
350 /* register gre46-input nodes */
351 ip4_register_protocol (IP_PROTOCOL_GRE, gre4_input_node.index);
352 ip6_register_protocol (IP_PROTOCOL_GRE, gre6_input_node.index);
358 vnet_gre_tunnel_delete (vnet_gre_tunnel_add_del_args_t * a,
359 u32 outer_fib_index, u32 * sw_if_indexp)
361 gre_main_t *gm = &gre_main;
362 vnet_main_t *vnm = gm->vnet_main;
364 gre_tunnel_key_t key;
367 t = gre_tunnel_db_find (a, outer_fib_index, &key);
369 return VNET_API_ERROR_NO_SUCH_ENTRY;
371 sw_if_index = t->sw_if_index;
372 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
374 /* make sure tunnel is removed from l2 bd or xconnect */
375 set_int_l2_mode (gm->vlib_main, vnm, MODE_L3, sw_if_index, 0,
376 L2_BD_PORT_TYPE_NORMAL, 0, 0);
377 gm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
379 if (t->type == GRE_TUNNEL_TYPE_L3)
380 vnet_delete_hw_interface (vnm, t->hw_if_index);
382 ethernet_delete_interface (vnm, t->hw_if_index);
384 if (t->l2_adj_index != ADJ_INDEX_INVALID)
386 adj_midchain_delegate_unstack (t->l2_adj_index);
387 adj_unlock (t->l2_adj_index);
390 ASSERT ((t->type != GRE_TUNNEL_TYPE_ERSPAN) || (t->gre_sn != NULL));
391 if ((t->type == GRE_TUNNEL_TYPE_ERSPAN) && (t->gre_sn->ref_count-- == 1))
394 gre_mk_sn_key (t, &skey);
395 hash_unset_mem_free (&gm->seq_num_by_key, &skey);
396 clib_mem_free (t->gre_sn);
399 hash_unset (gm->instance_used, t->user_instance);
400 gre_tunnel_db_remove (t);
401 pool_put (gm->tunnels, t);
404 *sw_if_indexp = sw_if_index;
410 vnet_gre_tunnel_add_del (vnet_gre_tunnel_add_del_args_t * a,
416 outer_fib_index = ip4_fib_index_from_table_id (a->outer_table_id);
418 outer_fib_index = ip6_fib_index_from_table_id (a->outer_table_id);
420 if (~0 == outer_fib_index)
421 return VNET_API_ERROR_NO_SUCH_FIB;
423 if (a->session_id > GTK_SESSION_ID_MAX)
424 return VNET_API_ERROR_INVALID_SESSION_ID;
427 return (vnet_gre_tunnel_add (a, outer_fib_index, sw_if_indexp));
429 return (vnet_gre_tunnel_delete (a, outer_fib_index, sw_if_indexp));
433 gre_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
435 gre_main_t *gm = &gre_main;
436 vnet_hw_interface_t *hi;
440 hi = vnet_get_hw_interface (vnm, hw_if_index);
442 if (NULL == gm->tunnel_index_by_sw_if_index ||
443 hi->sw_if_index >= vec_len (gm->tunnel_index_by_sw_if_index))
446 ti = gm->tunnel_index_by_sw_if_index[hi->sw_if_index];
449 /* not one of ours */
452 t = pool_elt_at_index (gm->tunnels, ti);
454 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
455 vnet_hw_interface_set_flags (vnm, hw_if_index,
456 VNET_HW_INTERFACE_FLAG_LINK_UP);
458 vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */ );
460 gre_tunnel_restack (t);
462 return /* no error */ 0;
465 static clib_error_t *
466 create_gre_tunnel_command_fn (vlib_main_t * vm,
467 unformat_input_t * input,
468 vlib_cli_command_t * cmd)
470 unformat_input_t _line_input, *line_input = &_line_input;
471 vnet_gre_tunnel_add_del_args_t _a, *a = &_a;
472 ip46_address_t src = ip46_address_initializer, dst =
473 ip46_address_initializer;
475 u32 outer_table_id = 0;
476 gre_tunnel_type_t t_type = GRE_TUNNEL_TYPE_L3;
477 gre_tunnel_mode_t t_mode = GRE_TUNNEL_MODE_P2P;
482 clib_error_t *error = NULL;
484 /* Get a line of input. */
485 if (!unformat_user (input, unformat_line_input, line_input))
488 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
490 if (unformat (line_input, "del"))
492 else if (unformat (line_input, "instance %d", &instance))
494 else if (unformat (line_input, "src %U", unformat_ip46_address, &src))
496 else if (unformat (line_input, "dst %U", unformat_ip46_address, &dst))
498 else if (unformat (line_input, "outer-table-id %d", &outer_table_id))
500 else if (unformat (line_input, "multipoint"))
501 t_mode = GRE_TUNNEL_MODE_MP;
502 else if (unformat (line_input, "teb"))
503 t_type = GRE_TUNNEL_TYPE_TEB;
504 else if (unformat (line_input, "erspan %d", &session_id))
505 t_type = GRE_TUNNEL_TYPE_ERSPAN;
508 error = clib_error_return (0, "unknown input `%U'",
509 format_unformat_error, line_input);
514 if (ip46_address_is_equal (&src, &dst))
516 error = clib_error_return (0, "src and dst are identical");
520 if (t_mode != GRE_TUNNEL_MODE_MP && ip46_address_is_zero (&dst))
522 error = clib_error_return (0, "destination address not specified");
526 if (ip46_address_is_zero (&src))
528 error = clib_error_return (0, "source address not specified");
532 if (ip46_address_is_ip4 (&src) != ip46_address_is_ip4 (&dst))
535 clib_error_return (0, "src and dst address must be the same AF");
539 clib_memset (a, 0, sizeof (*a));
541 a->outer_table_id = outer_table_id;
544 a->session_id = session_id;
545 a->is_ipv6 = !ip46_address_is_ip4 (&src);
546 a->instance = instance;
547 clib_memcpy (&a->src, &src, sizeof (a->src));
548 clib_memcpy (&a->dst, &dst, sizeof (a->dst));
550 rv = vnet_gre_tunnel_add_del (a, &sw_if_index);
555 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
556 vnet_get_main (), sw_if_index);
558 case VNET_API_ERROR_IF_ALREADY_EXISTS:
559 error = clib_error_return (0, "GRE tunnel already exists...");
561 case VNET_API_ERROR_NO_SUCH_FIB:
562 error = clib_error_return (0, "outer table ID %d doesn't exist\n",
565 case VNET_API_ERROR_NO_SUCH_ENTRY:
566 error = clib_error_return (0, "GRE tunnel doesn't exist");
568 case VNET_API_ERROR_INVALID_SESSION_ID:
569 error = clib_error_return (0, "session ID %d out of range\n",
572 case VNET_API_ERROR_INSTANCE_IN_USE:
573 error = clib_error_return (0, "Instance is in use");
577 clib_error_return (0, "vnet_gre_tunnel_add_del returned %d", rv);
582 unformat_free (line_input);
588 VLIB_CLI_COMMAND (create_gre_tunnel_command, static) = {
589 .path = "create gre tunnel",
590 .short_help = "create gre tunnel src <addr> dst <addr> [instance <n>] "
591 "[outer-fib-id <fib>] [teb | erspan <session-id>] [del]",
592 .function = create_gre_tunnel_command_fn,
596 static clib_error_t *
597 show_gre_tunnel_command_fn (vlib_main_t * vm,
598 unformat_input_t * input,
599 vlib_cli_command_t * cmd)
601 gre_main_t *gm = &gre_main;
605 if (pool_elts (gm->tunnels) == 0)
606 vlib_cli_output (vm, "No GRE tunnels configured...");
608 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
610 if (unformat (input, "%d", &ti))
619 pool_foreach (t, gm->tunnels,
621 vlib_cli_output (vm, "%U", format_gre_tunnel, t);
627 t = pool_elt_at_index (gm->tunnels, ti);
629 vlib_cli_output (vm, "%U", format_gre_tunnel, t);
636 VLIB_CLI_COMMAND (show_gre_tunnel_command, static) = {
637 .path = "show gre tunnel",
638 .function = show_gre_tunnel_command_fn,
642 /* force inclusion from application's main.c */
644 gre_interface_init (vlib_main_t * vm)
649 VLIB_INIT_FUNCTION (gre_interface_init);
652 * fd.io coding-style-patch-verification: ON
655 * eval: (c-set-style "gnu")