2 * Copyright (c) 2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
18 * @brief Common utility functions for LISP-GPE interfaces.
22 #include <vppinfra/error.h>
23 #include <vppinfra/hash.h>
24 #include <vnet/vnet.h>
25 #include <vnet/ip/ip.h>
26 #include <vnet/ip/udp.h>
27 #include <vnet/ethernet/ethernet.h>
28 #include <vnet/lisp-gpe/lisp_gpe.h>
29 #include <vnet/lisp-gpe/lisp_gpe_fwd_entry.h>
30 #include <vnet/lisp-gpe/lisp_gpe_tenant.h>
31 #include <vnet/adj/adj.h>
32 #include <vnet/fib/fib_table.h>
33 #include <vnet/fib/ip4_fib.h>
34 #include <vnet/fib/ip6_fib.h>
35 #include <vnet/lisp-cp/lisp_cp_dpo.h>
38 * @brief The VLIB node arc/edge from the interface's TX node, to the L2
39 * load-balanceing node. Which is where all packets go
41 static uword l2_arc_to_lb;
43 #define foreach_lisp_gpe_tx_next \
44 _(DROP, "error-drop") \
45 _(IP4_LOOKUP, "ip4-lookup") \
46 _(IP6_LOOKUP, "ip6-lookup")
50 #define _(sym,str) LISP_GPE_TX_NEXT_##sym,
51 foreach_lisp_gpe_tx_next
59 } lisp_gpe_tx_trace_t;
62 format_lisp_gpe_tx_trace (u8 * s, va_list * args)
64 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
65 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
66 lisp_gpe_tx_trace_t *t = va_arg (*args, lisp_gpe_tx_trace_t *);
68 s = format (s, "LISP-GPE-TX: tunnel %d", t->tunnel_index);
72 #define is_v4_packet(_h) ((*(u8*) _h) & 0xF0) == 0x40
75 * @brief LISP-GPE interface TX (encap) function.
76 * @node lisp_gpe_interface_tx
78 * The LISP-GPE interface TX (encap) function.
80 * Looks up the associated tunnel based on the adjacency hit in the SD FIB
81 * and if the tunnel is multihomed it uses the flow hash to determine
82 * sub-tunnel, and rewrite string, to be used to encapsulate the packet.
84 * @param[in] vm vlib_main_t corresponding to the current thread.
85 * @param[in] node vlib_node_runtime_t data for this node.
86 * @param[in] frame vlib_frame_t whose contents should be dispatched.
88 * @return number of vectors in frame.
91 lisp_gpe_interface_tx (vlib_main_t * vm, vlib_node_runtime_t * node,
92 vlib_frame_t * from_frame)
94 u32 n_left_from, next_index, *from, *to_next;
95 lisp_gpe_main_t *lgm = &lisp_gpe_main;
97 from = vlib_frame_vector_args (from_frame);
98 n_left_from = from_frame->n_vectors;
100 next_index = node->cached_next_index;
102 while (n_left_from > 0)
106 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
108 while (n_left_from > 0 && n_left_to_next > 0)
110 u32 bi0, adj_index0, next0;
111 const ip_adjacency_t *adj0;
112 const dpo_id_t *dpo0;
123 b0 = vlib_get_buffer (vm, bi0);
125 /* Fixup the checksum and len fields in the LISP tunnel encap
126 * that was applied at the midchain node */
127 is_v4_0 = is_v4_packet (vlib_buffer_get_current (b0));
128 ip_udp_fixup_one (lgm->vlib_main, b0, is_v4_0);
130 /* Follow the DPO on which the midchain is stacked */
131 adj_index0 = vnet_buffer (b0)->ip.adj_index[VLIB_TX];
132 adj0 = adj_get (adj_index0);
133 dpo0 = &adj0->sub_type.midchain.next_dpo;
134 next0 = dpo0->dpoi_next_node;
135 vnet_buffer (b0)->ip.adj_index[VLIB_TX] = dpo0->dpoi_index;
137 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
139 lisp_gpe_tx_trace_t *tr = vlib_add_trace (vm, node, b0,
141 tr->tunnel_index = adj_index0;
143 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
144 n_left_to_next, bi0, next0);
147 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
150 return from_frame->n_vectors;
154 format_lisp_gpe_name (u8 * s, va_list * args)
156 u32 dev_instance = va_arg (*args, u32);
157 return format (s, "lisp_gpe%d", dev_instance);
161 VNET_DEVICE_CLASS (lisp_gpe_device_class) = {
163 .format_device_name = format_lisp_gpe_name,
164 .format_tx_trace = format_lisp_gpe_tx_trace,
165 .tx_function = lisp_gpe_interface_tx,
166 .no_flatten_output_chains = 1,
171 dummy_set_rewrite (vnet_main_t * vnm, u32 sw_if_index, u32 l3_type,
172 void *dst_address, void *rewrite, uword max_rewrite_bytes)
178 format_lisp_gpe_header_with_length (u8 * s, va_list * args)
180 lisp_gpe_header_t *h = va_arg (*args, lisp_gpe_header_t *);
181 u32 max_header_bytes = va_arg (*args, u32);
184 header_bytes = sizeof (h[0]);
185 if (max_header_bytes != 0 && header_bytes > max_header_bytes)
186 return format (s, "lisp-gpe header truncated");
188 s = format (s, "flags: ");
189 #define _(n,v) if (h->flags & v) s = format (s, "%s ", #n);
190 foreach_lisp_gpe_flag_bit;
193 s = format (s, "\n ver_res %d res %d next_protocol %d iid %d(%x)",
194 h->ver_res, h->res, h->next_protocol,
195 clib_net_to_host_u32 (h->iid), clib_net_to_host_u32 (h->iid));
200 VNET_HW_INTERFACE_CLASS (lisp_gpe_hw_class) = {
202 .format_header = format_lisp_gpe_header_with_length,
203 .set_rewrite = dummy_set_rewrite,
211 } l2_lisp_gpe_tx_trace_t;
214 format_l2_lisp_gpe_tx_trace (u8 * s, va_list * args)
216 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
217 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
218 l2_lisp_gpe_tx_trace_t *t = va_arg (*args, l2_lisp_gpe_tx_trace_t *);
220 s = format (s, "L2-LISP-GPE-TX: load-balance %d", t->lb_index);
225 * @brief LISP-GPE interface TX (encap) function for L2 overlays.
226 * @node l2_lisp_gpe_interface_tx
228 * The L2 LISP-GPE interface TX (encap) function.
230 * Uses bridge domain index, source and destination ethernet addresses to
231 * lookup tunnel. If the tunnel is multihomed a flow has is used to determine
232 * the sub-tunnel and therefore the rewrite string to be used to encapsulate
235 * @param[in] vm vlib_main_t corresponding to the current thread.
236 * @param[in] node vlib_node_runtime_t data for this node.
237 * @param[in] frame vlib_frame_t whose contents should be dispatched.
239 * @return number of vectors in frame.
242 l2_lisp_gpe_interface_tx (vlib_main_t * vm, vlib_node_runtime_t * node,
243 vlib_frame_t * from_frame)
245 u32 n_left_from, next_index, *from, *to_next;
246 lisp_gpe_main_t *lgm = &lisp_gpe_main;
248 from = vlib_frame_vector_args (from_frame);
249 n_left_from = from_frame->n_vectors;
251 next_index = node->cached_next_index;
253 while (n_left_from > 0)
257 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
259 while (n_left_from > 0 && n_left_to_next > 0)
263 ethernet_header_t *e0;
272 b0 = vlib_get_buffer (vm, bi0);
273 e0 = vlib_buffer_get_current (b0);
275 vnet_buffer (b0)->lisp.overlay_afi = LISP_AFI_MAC;
277 /* lookup dst + src mac */
278 lbi0 = lisp_l2_fib_lookup (lgm, vnet_buffer (b0)->l2.bd_index,
279 e0->src_address, e0->dst_address);
280 vnet_buffer (b0)->ip.adj_index[VLIB_TX] = lbi0;
283 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
285 l2_lisp_gpe_tx_trace_t *tr = vlib_add_trace (vm, node, b0,
289 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
290 n_left_to_next, bi0, l2_arc_to_lb);
293 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
296 return from_frame->n_vectors;
300 format_l2_lisp_gpe_name (u8 * s, va_list * args)
302 u32 dev_instance = va_arg (*args, u32);
303 return format (s, "l2_lisp_gpe%d", dev_instance);
307 VNET_DEVICE_CLASS (l2_lisp_gpe_device_class,static) = {
308 .name = "L2_LISP_GPE",
309 .format_device_name = format_l2_lisp_gpe_name,
310 .format_tx_trace = format_l2_lisp_gpe_tx_trace,
311 .tx_function = l2_lisp_gpe_interface_tx,
312 .no_flatten_output_chains = 1,
316 static vnet_hw_interface_t *
317 lisp_gpe_create_iface (lisp_gpe_main_t * lgm, u32 vni, u32 dp_table,
318 vnet_device_class_t * dev_class,
319 tunnel_lookup_t * tuns)
322 u32 hw_if_index = ~0;
324 vnet_hw_interface_t *hi;
325 vnet_main_t *vnm = lgm->vnet_main;
327 /* create hw lisp_gpeX iface if needed, otherwise reuse existing */
328 flen = vec_len (lgm->free_tunnel_hw_if_indices);
331 hw_if_index = lgm->free_tunnel_hw_if_indices[flen - 1];
332 _vec_len (lgm->free_tunnel_hw_if_indices) -= 1;
334 hi = vnet_get_hw_interface (vnm, hw_if_index);
336 /* rename interface */
337 new_name = format (0, "%U", dev_class->format_device_name, vni);
339 vec_add1 (new_name, 0);
340 vnet_rename_interface (vnm, hw_if_index, (char *) new_name);
343 /* clear old stats of freed interface before reuse */
344 vnet_interface_main_t *im = &vnm->interface_main;
345 vnet_interface_counter_lock (im);
346 vlib_zero_combined_counter (&im->combined_sw_if_counters
347 [VNET_INTERFACE_COUNTER_TX],
349 vlib_zero_combined_counter (&im->combined_sw_if_counters
350 [VNET_INTERFACE_COUNTER_RX],
352 vlib_zero_simple_counter (&im->sw_if_counters
353 [VNET_INTERFACE_COUNTER_DROP],
355 vnet_interface_counter_unlock (im);
359 hw_if_index = vnet_register_interface (vnm, dev_class->index, vni,
360 lisp_gpe_hw_class.index, 0);
361 hi = vnet_get_hw_interface (vnm, hw_if_index);
364 hash_set (tuns->hw_if_index_by_dp_table, dp_table, hw_if_index);
366 /* set tunnel termination: post decap, packets are tagged as having been
367 * originated by lisp-gpe interface */
368 hash_set (tuns->sw_if_index_by_vni, vni, hi->sw_if_index);
369 hash_set (tuns->vni_by_sw_if_index, hi->sw_if_index, vni);
375 lisp_gpe_remove_iface (lisp_gpe_main_t * lgm, u32 hi_index, u32 dp_table,
376 tunnel_lookup_t * tuns)
378 vnet_main_t *vnm = lgm->vnet_main;
379 vnet_hw_interface_t *hi;
382 hi = vnet_get_hw_interface (vnm, hi_index);
384 /* disable interface */
385 vnet_sw_interface_set_flags (vnm, hi->sw_if_index, 0 /* down */ );
386 vnet_hw_interface_set_flags (vnm, hi->hw_if_index, 0 /* down */ );
387 hash_unset (tuns->hw_if_index_by_dp_table, dp_table);
388 vec_add1 (lgm->free_tunnel_hw_if_indices, hi->hw_if_index);
390 /* clean tunnel termination and vni to sw_if_index binding */
391 vnip = hash_get (tuns->vni_by_sw_if_index, hi->sw_if_index);
394 clib_warning ("No vni associated to interface %d", hi->sw_if_index);
397 hash_unset (tuns->sw_if_index_by_vni, vnip[0]);
398 hash_unset (tuns->vni_by_sw_if_index, hi->sw_if_index);
402 lisp_gpe_iface_set_table (u32 sw_if_index, u32 table_id)
404 fib_node_index_t fib_index;
406 fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, table_id);
407 vec_validate (ip4_main.fib_index_by_sw_if_index, sw_if_index);
408 ip4_main.fib_index_by_sw_if_index[sw_if_index] = fib_index;
409 ip4_sw_interface_enable_disable (sw_if_index, 1);
411 fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP6, table_id);
412 vec_validate (ip6_main.fib_index_by_sw_if_index, sw_if_index);
413 ip6_main.fib_index_by_sw_if_index[sw_if_index] = fib_index;
414 ip6_sw_interface_enable_disable (sw_if_index, 1);
418 lisp_gpe_tenant_del_default_routes (u32 table_id)
420 fib_protocol_t proto;
422 FOR_EACH_FIB_IP_PROTOCOL (proto)
424 fib_prefix_t prefix = {
429 fib_index = fib_table_find (prefix.fp_proto, table_id);
430 fib_table_entry_special_remove (fib_index, &prefix, FIB_SOURCE_LISP);
431 fib_table_unlock (fib_index, prefix.fp_proto);
436 lisp_gpe_tenant_add_default_routes (u32 table_id)
438 fib_protocol_t proto;
440 FOR_EACH_FIB_IP_PROTOCOL (proto)
442 fib_prefix_t prefix = {
448 * Add a deafult route that results in a control plane punt DPO
450 fib_index = fib_table_find_or_create_and_lock (prefix.fp_proto, table_id);
451 fib_table_entry_special_dpo_add (fib_index, &prefix, FIB_SOURCE_LISP,
452 FIB_ENTRY_FLAG_EXCLUSIVE,
453 lisp_cp_dpo_get (fib_proto_to_dpo
460 * @brief Add/del LISP-GPE L3 interface.
462 * Creates LISP-GPE interface, sets ingress arcs from lisp_gpeX_lookup,
463 * installs default routes that attract all traffic with no more specific
464 * routes to lgpe-ipx-lookup, set egress arcs to ipx-lookup, sets
465 * the interface in the right vrf and enables it.
467 * @param[in] lgm Reference to @ref lisp_gpe_main_t.
468 * @param[in] a Parameters to create interface.
470 * @return number of vectors in frame.
473 lisp_gpe_add_l3_iface (lisp_gpe_main_t * lgm, u32 vni, u32 table_id)
475 vnet_main_t *vnm = lgm->vnet_main;
476 tunnel_lookup_t *l3_ifaces = &lgm->l3_ifaces;
477 vnet_hw_interface_t *hi;
480 hip = hash_get (l3_ifaces->hw_if_index_by_dp_table, table_id);
484 clib_warning ("vrf %d already mapped to a vni", table_id);
488 si = hash_get (l3_ifaces->sw_if_index_by_vni, vni);
492 clib_warning ("Interface for vni %d already exists", vni);
495 /* create lisp iface and populate tunnel tables */
496 hi = lisp_gpe_create_iface (lgm, vni, table_id,
497 &lisp_gpe_device_class, l3_ifaces);
499 /* insert default routes that point to lisp-cp lookup */
500 lisp_gpe_iface_set_table (hi->sw_if_index, table_id);
501 lisp_gpe_tenant_add_default_routes (table_id);
503 /* enable interface */
504 vnet_sw_interface_set_flags (vnm, hi->sw_if_index,
505 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
506 vnet_hw_interface_set_flags (vnm, hi->hw_if_index,
507 VNET_HW_INTERFACE_FLAG_LINK_UP);
509 return (hi->sw_if_index);
513 lisp_gpe_del_l3_iface (lisp_gpe_main_t * lgm, u32 vni, u32 table_id)
515 vnet_main_t *vnm = lgm->vnet_main;
516 tunnel_lookup_t *l3_ifaces = &lgm->l3_ifaces;
517 vnet_hw_interface_t *hi;
520 hip = hash_get (l3_ifaces->hw_if_index_by_dp_table, table_id);
524 clib_warning ("The interface for vrf %d doesn't exist", table_id);
528 hi = vnet_get_hw_interface (vnm, hip[0]);
530 lisp_gpe_remove_iface (lgm, hip[0], table_id, &lgm->l3_ifaces);
532 /* unset default routes */
533 ip4_sw_interface_enable_disable (hi->sw_if_index, 0);
534 ip6_sw_interface_enable_disable (hi->sw_if_index, 0);
535 lisp_gpe_tenant_del_default_routes (table_id);
539 * @brief Add/del LISP-GPE L2 interface.
541 * Creates LISP-GPE interface, sets it in L2 mode in the appropriate
542 * bridge domain, sets egress arcs and enables it.
544 * @param[in] lgm Reference to @ref lisp_gpe_main_t.
545 * @param[in] a Parameters to create interface.
547 * @return number of vectors in frame.
550 lisp_gpe_add_l2_iface (lisp_gpe_main_t * lgm, u32 vni, u32 bd_id)
552 vnet_main_t *vnm = lgm->vnet_main;
553 tunnel_lookup_t *l2_ifaces = &lgm->l2_ifaces;
554 vnet_hw_interface_t *hi;
558 bd_index = bd_find_or_add_bd_index (&bd_main, bd_id);
559 hip = hash_get (l2_ifaces->hw_if_index_by_dp_table, bd_index);
563 clib_warning ("bridge domain %d already mapped to a vni", bd_id);
567 si = hash_get (l2_ifaces->sw_if_index_by_vni, vni);
570 clib_warning ("Interface for vni %d already exists", vni);
574 /* create lisp iface and populate tunnel tables */
575 hi = lisp_gpe_create_iface (lgm, vni, bd_index,
576 &l2_lisp_gpe_device_class, &lgm->l2_ifaces);
578 /* enable interface */
579 vnet_sw_interface_set_flags (vnm, hi->sw_if_index,
580 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
581 vnet_hw_interface_set_flags (vnm, hi->hw_if_index,
582 VNET_HW_INTERFACE_FLAG_LINK_UP);
584 l2_arc_to_lb = vlib_node_add_named_next (vlib_get_main (),
588 /* we're ready. add iface to l2 bridge domain */
589 set_int_l2_mode (lgm->vlib_main, vnm, MODE_L2_BRIDGE, hi->sw_if_index,
592 return (hi->sw_if_index);
596 * @brief Add/del LISP-GPE L2 interface.
598 * Creates LISP-GPE interface, sets it in L2 mode in the appropriate
599 * bridge domain, sets egress arcs and enables it.
601 * @param[in] lgm Reference to @ref lisp_gpe_main_t.
602 * @param[in] a Parameters to create interface.
604 * @return number of vectors in frame.
607 lisp_gpe_del_l2_iface (lisp_gpe_main_t * lgm, u32 vni, u32 bd_id)
609 tunnel_lookup_t *l2_ifaces = &lgm->l2_ifaces;
613 bd_index = bd_find_or_add_bd_index (&bd_main, bd_id);
614 hip = hash_get (l2_ifaces->hw_if_index_by_dp_table, bd_index);
618 clib_warning ("The interface for bridge domain %d doesn't exist",
622 lisp_gpe_remove_iface (lgm, hip[0], bd_index, &lgm->l2_ifaces);
625 static clib_error_t *
626 lisp_gpe_add_del_iface_command_fn (vlib_main_t * vm, unformat_input_t * input,
627 vlib_cli_command_t * cmd)
629 unformat_input_t _line_input, *line_input = &_line_input;
631 u32 table_id, vni, bd_id;
632 u8 vni_is_set = 0, vrf_is_set = 0, bd_index_is_set = 0;
634 if (vnet_lisp_gpe_enable_disable_status () == 0)
636 return clib_error_return (0, "LISP is disabled");
639 /* Get a line of input. */
640 if (!unformat_user (input, unformat_line_input, line_input))
643 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
645 if (unformat (line_input, "add"))
647 else if (unformat (line_input, "del"))
649 else if (unformat (line_input, "vrf %d", &table_id))
653 else if (unformat (line_input, "vni %d", &vni))
657 else if (unformat (line_input, "bd %d", &bd_id))
663 return clib_error_return (0, "parse error: '%U'",
664 format_unformat_error, line_input);
668 if (vrf_is_set && bd_index_is_set)
669 return clib_error_return (0,
670 "Cannot set both vrf and brdige domain index!");
673 return clib_error_return (0, "vni must be set!");
675 if (!vrf_is_set && !bd_index_is_set)
676 return clib_error_return (0, "vrf or bridge domain index must be set!");
682 if (~0 == lisp_gpe_tenant_l2_iface_add_or_lock (vni, bd_id))
683 return clib_error_return (0, "L2 interface not created");
686 lisp_gpe_tenant_l2_iface_unlock (vni);
692 if (~0 == lisp_gpe_tenant_l3_iface_add_or_lock (vni, table_id))
693 return clib_error_return (0, "L3 interface not created");
696 lisp_gpe_tenant_l3_iface_unlock (vni);
703 VLIB_CLI_COMMAND (add_del_lisp_gpe_iface_command, static) = {
704 .path = "lisp gpe iface",
705 .short_help = "lisp gpe iface add/del vni <vni> vrf <vrf>",
706 .function = lisp_gpe_add_del_iface_command_fn,
711 * fd.io coding-style-patch-verification: ON
714 * eval: (c-set-style "gnu")