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/adj/adj_midchain.h>
24 #include <vnet/adj/adj_nbr.h>
25 #include <vnet/mpls/mpls.h>
27 static const char *gre_tunnel_type_names[] = GRE_TUNNEL_TYPE_NAMES;
30 gre_mk_key (const ip4_address_t *src,
31 const ip4_address_t *dst,
34 // FIXME. the fib index should be part of the key
35 return ((u64)src->as_u32 << 32 | (u64)dst->as_u32);
39 format_gre_tunnel_type (u8 * s, va_list * args)
41 gre_tunnel_type_t type = va_arg (*args, gre_tunnel_type_t);
43 return (format(s, "%s", gre_tunnel_type_names[type]));
47 format_gre_tunnel (u8 * s, va_list * args)
49 gre_tunnel_t * t = va_arg (*args, gre_tunnel_t *);
50 gre_main_t * gm = &gre_main;
53 "[%d] %U (src) %U (dst) payload %U outer_fib_index %d",
55 format_ip4_address, &t->tunnel_src,
56 format_ip4_address, &t->tunnel_dst,
57 format_gre_tunnel_type, t->type,
64 gre_tunnel_db_find (const ip4_address_t *src,
65 const ip4_address_t *dst,
68 gre_main_t * gm = &gre_main;
72 key = gre_mk_key(src, dst, out_fib_index);
74 p = hash_get (gm->tunnel_by_key, key);
79 return (pool_elt_at_index (gm->tunnels, p[0]));
83 gre_tunnel_db_add (const gre_tunnel_t *t)
85 gre_main_t * gm = &gre_main;
88 key = gre_mk_key(&t->tunnel_src, &t->tunnel_dst, t->outer_fib_index);
89 hash_set (gm->tunnel_by_key, key, t - gm->tunnels);
93 gre_tunnel_db_remove (const gre_tunnel_t *t)
95 gre_main_t * gm = &gre_main;
98 key = gre_mk_key(&t->tunnel_src, &t->tunnel_dst, t->outer_fib_index);
99 hash_unset (gm->tunnel_by_key, key);
102 static gre_tunnel_t *
103 gre_tunnel_from_fib_node (fib_node_t *node)
106 ASSERT(FIB_NODE_TYPE_GRE_TUNNEL == node->fn_type);
108 return ((gre_tunnel_t*) (((char*)node) -
109 STRUCT_OFFSET_OF(gre_tunnel_t, node)));
115 * 'stack' (resolve the recursion for) the tunnel's midchain adjacency
118 gre_tunnel_stack (adj_index_t ai)
120 gre_main_t * gm = &gre_main;
126 sw_if_index = adj->rewrite_header.sw_if_index;
128 if ((vec_len(gm->tunnel_index_by_sw_if_index) < sw_if_index) ||
129 (~0 == gm->tunnel_index_by_sw_if_index[sw_if_index]))
132 gt = pool_elt_at_index(gm->tunnels,
133 gm->tunnel_index_by_sw_if_index[sw_if_index]);
136 * find the adjacency that is contributed by the FIB entry
137 * that this tunnel resovles via, and use it as the next adj
140 if (vnet_hw_interface_get_flags(vnet_get_main(),
142 VNET_HW_INTERFACE_FLAG_LINK_UP)
144 adj_nbr_midchain_stack(
146 fib_entry_contribute_ip_forwarding(gt->fib_entry_index));
150 adj_nbr_midchain_unstack(ai);
155 * @brief Call back when restacking all adjacencies on a GRE interface
158 gre_adj_walk_cb (adj_index_t ai,
161 gre_tunnel_stack(ai);
163 return (ADJ_WALK_RC_CONTINUE);
167 gre_tunnel_restack (gre_tunnel_t *gt)
169 fib_protocol_t proto;
172 * walk all the adjacencies on th GRE interface and restack them
174 FOR_EACH_FIB_IP_PROTOCOL(proto)
176 adj_nbr_walk(gt->sw_if_index,
184 * Function definition to backwalk a FIB node
186 static fib_node_back_walk_rc_t
187 gre_tunnel_back_walk (fib_node_t *node,
188 fib_node_back_walk_ctx_t *ctx)
190 gre_tunnel_restack(gre_tunnel_from_fib_node(node));
192 return (FIB_NODE_BACK_WALK_CONTINUE);
196 * Function definition to get a FIB node from its index
199 gre_tunnel_fib_node_get (fib_node_index_t index)
205 gt = pool_elt_at_index(gm->tunnels, index);
211 * Function definition to inform the FIB node that its last lock has gone.
214 gre_tunnel_last_lock_gone (fib_node_t *node)
217 * The MPLS GRE tunnel is a root of the graph. As such
218 * it never has children and thus is never locked.
224 * Virtual function table registered by MPLS GRE tunnels
225 * for participation in the FIB object graph.
227 const static fib_node_vft_t gre_vft = {
228 .fnv_get = gre_tunnel_fib_node_get,
229 .fnv_last_lock = gre_tunnel_last_lock_gone,
230 .fnv_back_walk = gre_tunnel_back_walk,
234 vnet_gre_tunnel_add (vnet_gre_add_del_tunnel_args_t *a,
237 gre_main_t * gm = &gre_main;
238 vnet_main_t * vnm = gm->vnet_main;
239 ip4_main_t * im = &ip4_main;
241 vnet_hw_interface_t * hi;
242 u32 hw_if_index, sw_if_index;
247 outer_fib_index = ip4_fib_index_from_table_id(a->outer_fib_id);
249 if (~0 == outer_fib_index)
250 return VNET_API_ERROR_NO_SUCH_FIB;
252 t = gre_tunnel_db_find(&a->src, &a->dst, a->outer_fib_id);
255 return VNET_API_ERROR_INVALID_VALUE;
257 pool_get_aligned (gm->tunnels, t, CLIB_CACHE_LINE_BYTES);
258 memset (t, 0, sizeof (*t));
259 fib_node_init(&t->node, FIB_NODE_TYPE_GRE_TUNNEL);
262 t->type = GRE_TUNNEL_TYPE_TEB;
264 t->type = GRE_TUNNEL_TYPE_L3;
266 if (vec_len (gm->free_gre_tunnel_hw_if_indices[t->type]) > 0) {
267 vnet_interface_main_t * im = &vnm->interface_main;
269 hw_if_index = gm->free_gre_tunnel_hw_if_indices[t->type]
270 [vec_len (gm->free_gre_tunnel_hw_if_indices[t->type])-1];
271 _vec_len (gm->free_gre_tunnel_hw_if_indices[t->type]) -= 1;
273 hi = vnet_get_hw_interface (vnm, hw_if_index);
274 hi->dev_instance = t - gm->tunnels;
275 hi->hw_instance = hi->dev_instance;
277 /* clear old stats of freed tunnel before reuse */
278 sw_if_index = hi->sw_if_index;
279 vnet_interface_counter_lock(im);
280 vlib_zero_combined_counter
281 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX], sw_if_index);
282 vlib_zero_combined_counter
283 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_RX], sw_if_index);
284 vlib_zero_simple_counter
285 (&im->sw_if_counters[VNET_INTERFACE_COUNTER_DROP], sw_if_index);
286 vnet_interface_counter_unlock(im);
287 if (GRE_TUNNEL_TYPE_TEB == t->type)
289 t->l2_tx_arc = vlib_node_add_named_next(vlib_get_main(),
294 if (GRE_TUNNEL_TYPE_TEB == t->type)
296 /* Default MAC address (d00b:eed0:0000 + sw_if_index) */
297 memset (address, 0, sizeof (address));
302 address[4] = t - gm->tunnels;
304 error = ethernet_register_interface(vnm,
305 gre_device_teb_class.index,
306 t - gm->tunnels, address,
312 clib_error_report (error);
313 return VNET_API_ERROR_INVALID_REGISTRATION;
315 hi = vnet_get_hw_interface (vnm, hw_if_index);
317 t->l2_tx_arc = vlib_node_add_named_next(vlib_get_main(),
321 hw_if_index = vnet_register_interface(vnm,
322 gre_device_class.index,
324 gre_hw_interface_class.index,
327 hi = vnet_get_hw_interface (vnm, hw_if_index);
328 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 - gm->tunnels;
339 vec_validate (im->fib_index_by_sw_if_index, sw_if_index);
341 hi->min_packet_bytes = 64 + sizeof (gre_header_t) + sizeof (ip4_header_t);
342 hi->per_packet_overhead_bytes =
343 /* preamble */ 8 + /* inter frame gap */ 12;
345 /* Standard default gre MTU. */
346 hi->max_l3_packet_bytes[VLIB_RX] = hi->max_l3_packet_bytes[VLIB_TX] = 9000;
348 clib_memcpy (&t->tunnel_src, &a->src, sizeof (t->tunnel_src));
349 clib_memcpy (&t->tunnel_dst, &a->dst, sizeof (t->tunnel_dst));
351 gre_tunnel_db_add(t);
354 * source the FIB entry for the tunnel's destination
355 * and become a child thereof. The tunnel will then get poked
356 * when the forwarding for the entry updates, and the tunnel can
357 * re-stack accordingly
359 const fib_prefix_t tun_dst_pfx = {
361 .fp_proto = FIB_PROTOCOL_IP4,
363 .ip4 = t->tunnel_dst,
368 fib_table_entry_special_add(outer_fib_index,
374 fib_entry_child_add(t->fib_entry_index,
375 FIB_NODE_TYPE_GRE_TUNNEL,
378 clib_memcpy (&t->tunnel_src, &a->src, sizeof (t->tunnel_src));
379 clib_memcpy (&t->tunnel_dst, &a->dst, sizeof (t->tunnel_dst));
381 if (GRE_TUNNEL_TYPE_TEB == t->type)
383 t->l2_adj_index = adj_nbr_add_or_lock(FIB_PROTOCOL_IP4,
387 gre_update_adj(vnm, t->sw_if_index, t->l2_adj_index);
391 *sw_if_indexp = sw_if_index;
397 vnet_gre_tunnel_delete (vnet_gre_add_del_tunnel_args_t *a,
400 gre_main_t * gm = &gre_main;
401 vnet_main_t * vnm = gm->vnet_main;
405 t = gre_tunnel_db_find(&a->src, &a->dst, a->outer_fib_id);
408 return VNET_API_ERROR_NO_SUCH_ENTRY;
410 sw_if_index = t->sw_if_index;
411 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */);
412 /* make sure tunnel is removed from l2 bd or xconnect */
413 set_int_l2_mode(gm->vlib_main, vnm, MODE_L3, sw_if_index, 0, 0, 0, 0);
414 vec_add1 (gm->free_gre_tunnel_hw_if_indices[t->type], t->hw_if_index);
415 gm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
417 if (GRE_TUNNEL_TYPE_TEB == t->type)
418 adj_unlock(t->l2_adj_index);
420 if (t->l2_adj_index != ADJ_INDEX_INVALID)
421 adj_unlock(t->l2_adj_index);
423 fib_entry_child_remove(t->fib_entry_index,
425 fib_table_entry_delete_index(t->fib_entry_index,
428 gre_tunnel_db_remove(t);
429 fib_node_deinit(&t->node);
430 pool_put (gm->tunnels, t);
433 *sw_if_indexp = sw_if_index;
439 vnet_gre_add_del_tunnel (vnet_gre_add_del_tunnel_args_t *a,
443 return (vnet_gre_tunnel_add(a, sw_if_indexp));
445 return (vnet_gre_tunnel_delete(a, sw_if_indexp));
449 gre_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
451 gre_main_t * gm = &gre_main;
452 vnet_hw_interface_t * hi;
456 hi = vnet_get_hw_interface (vnm, hw_if_index);
458 if (NULL == gm->tunnel_index_by_sw_if_index ||
459 hi->sw_if_index >= vec_len(gm->tunnel_index_by_sw_if_index))
462 ti = gm->tunnel_index_by_sw_if_index[hi->sw_if_index];
465 /* not one of ours */
468 t = pool_elt_at_index(gm->tunnels, ti);
470 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
471 vnet_hw_interface_set_flags (vnm, hw_if_index, VNET_HW_INTERFACE_FLAG_LINK_UP);
473 vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */);
475 gre_tunnel_restack(t);
477 return /* no error */ 0;
480 static clib_error_t *
481 create_gre_tunnel_command_fn (vlib_main_t * vm,
482 unformat_input_t * input,
483 vlib_cli_command_t * cmd)
485 unformat_input_t _line_input, * line_input = &_line_input;
486 vnet_gre_add_del_tunnel_args_t _a, * a = &_a;
487 ip4_address_t src, dst;
488 u32 outer_fib_id = 0;
494 clib_error_t *error = NULL;
496 /* Get a line of input. */
497 if (! unformat_user (input, unformat_line_input, line_input))
500 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) {
501 if (unformat (line_input, "del"))
503 else if (unformat (line_input, "src %U", unformat_ip4_address, &src))
505 else if (unformat (line_input, "dst %U", unformat_ip4_address, &dst))
507 else if (unformat (line_input, "outer-fib-id %d", &outer_fib_id))
509 else if (unformat (line_input, "teb"))
513 error = clib_error_return (0, "unknown input `%U'",
514 format_unformat_error, line_input);
521 error = clib_error_return (0, "mandatory argument(s) missing");
525 if (memcmp (&src, &dst, sizeof(src)) == 0)
527 error = clib_error_return (0, "src and dst are identical");
531 memset (a, 0, sizeof (*a));
532 a->outer_fib_id = outer_fib_id;
534 clib_memcpy(&a->src, &src, sizeof(src));
535 clib_memcpy(&a->dst, &dst, sizeof(dst));
538 rv = vnet_gre_tunnel_add(a, &sw_if_index);
540 rv = vnet_gre_tunnel_delete(a, &sw_if_index);
545 vlib_cli_output(vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main(), sw_if_index);
547 case VNET_API_ERROR_INVALID_VALUE:
548 error = clib_error_return (0, "GRE tunnel already exists...");
550 case VNET_API_ERROR_NO_SUCH_FIB:
551 error = clib_error_return (0, "outer fib ID %d doesn't exist\n",
555 error = clib_error_return (0, "vnet_gre_add_del_tunnel returned %d", rv);
560 unformat_free (line_input);
565 VLIB_CLI_COMMAND (create_gre_tunnel_command, static) = {
566 .path = "create gre tunnel",
567 .short_help = "create gre tunnel src <addr> dst <addr> "
568 "[outer-fib-id <fib>] [teb] [del]",
569 .function = create_gre_tunnel_command_fn,
572 static clib_error_t *
573 show_gre_tunnel_command_fn (vlib_main_t * vm,
574 unformat_input_t * input,
575 vlib_cli_command_t * cmd)
577 gre_main_t * gm = &gre_main;
581 if (pool_elts (gm->tunnels) == 0)
582 vlib_cli_output (vm, "No GRE tunnels configured...");
584 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
586 if (unformat (input, "%d", &ti))
594 pool_foreach (t, gm->tunnels,
596 vlib_cli_output (vm, "%U", format_gre_tunnel, t);
601 t = pool_elt_at_index(gm->tunnels, ti);
603 vlib_cli_output (vm, "%U", format_gre_tunnel, t);
609 VLIB_CLI_COMMAND (show_gre_tunnel_command, static) = {
610 .path = "show gre tunnel",
611 .function = show_gre_tunnel_command_fn,
614 /* force inclusion from application's main.c */
615 clib_error_t *gre_interface_init (vlib_main_t *vm)
617 fib_node_register_type(FIB_NODE_TYPE_GRE_TUNNEL, &gre_vft);
621 VLIB_INIT_FUNCTION(gre_interface_init);