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/lisp-gpe/lisp_gpe_adjacency.h>
32 #include <vnet/adj/adj.h>
33 #include <vnet/fib/fib_table.h>
34 #include <vnet/fib/ip4_fib.h>
35 #include <vnet/fib/ip6_fib.h>
36 #include <vnet/lisp-cp/lisp_cp_dpo.h>
39 * @brief The VLIB node arc/edge from the interface's TX node, to the L2
40 * load-balanceing node. Which is where all packets go
42 static uword l2_arc_to_lb;
44 #define foreach_lisp_gpe_tx_next \
45 _(DROP, "error-drop") \
46 _(IP4_LOOKUP, "ip4-lookup") \
47 _(IP6_LOOKUP, "ip6-lookup")
51 #define _(sym,str) LISP_GPE_TX_NEXT_##sym,
52 foreach_lisp_gpe_tx_next
60 } lisp_gpe_tx_trace_t;
63 format_lisp_gpe_tx_trace (u8 * s, va_list * args)
65 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
66 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
67 lisp_gpe_tx_trace_t *t = va_arg (*args, lisp_gpe_tx_trace_t *);
69 s = format (s, "LISP-GPE-TX: tunnel %d", t->tunnel_index);
73 #define is_v4_packet(_h) ((*(u8*) _h) & 0xF0) == 0x40
76 * @brief LISP-GPE interface TX (encap) function.
77 * @node lisp_gpe_interface_tx
79 * The LISP-GPE interface TX (encap) function.
81 * Looks up the associated tunnel based on the adjacency hit in the SD FIB
82 * and if the tunnel is multihomed it uses the flow hash to determine
83 * sub-tunnel, and rewrite string, to be used to encapsulate the packet.
85 * @param[in] vm vlib_main_t corresponding to the current thread.
86 * @param[in] node vlib_node_runtime_t data for this node.
87 * @param[in] frame vlib_frame_t whose contents should be dispatched.
89 * @return number of vectors in frame.
92 lisp_gpe_interface_tx (vlib_main_t * vm, vlib_node_runtime_t * node,
93 vlib_frame_t * from_frame)
95 u32 n_left_from, next_index, *from, *to_next;
96 lisp_gpe_main_t *lgm = &lisp_gpe_main;
98 from = vlib_frame_vector_args (from_frame);
99 n_left_from = from_frame->n_vectors;
101 next_index = node->cached_next_index;
103 while (n_left_from > 0)
107 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
109 while (n_left_from > 0 && n_left_to_next > 0)
111 u32 bi0, adj_index0, next0;
112 const ip_adjacency_t *adj0;
113 const dpo_id_t *dpo0;
124 b0 = vlib_get_buffer (vm, bi0);
126 /* Fixup the checksum and len fields in the LISP tunnel encap
127 * that was applied at the midchain node */
128 is_v4_0 = is_v4_packet (vlib_buffer_get_current (b0));
129 ip_udp_fixup_one (lgm->vlib_main, b0, is_v4_0);
131 /* Follow the DPO on which the midchain is stacked */
132 adj_index0 = vnet_buffer (b0)->ip.adj_index[VLIB_TX];
133 adj0 = adj_get (adj_index0);
134 dpo0 = &adj0->sub_type.midchain.next_dpo;
135 next0 = dpo0->dpoi_next_node;
136 vnet_buffer (b0)->ip.adj_index[VLIB_TX] = dpo0->dpoi_index;
138 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
140 lisp_gpe_tx_trace_t *tr = vlib_add_trace (vm, node, b0,
142 tr->tunnel_index = adj_index0;
144 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
145 n_left_to_next, bi0, next0);
148 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
151 return from_frame->n_vectors;
155 format_lisp_gpe_name (u8 * s, va_list * args)
157 u32 dev_instance = va_arg (*args, u32);
158 return format (s, "lisp_gpe%d", dev_instance);
162 VNET_DEVICE_CLASS (lisp_gpe_device_class) = {
164 .format_device_name = format_lisp_gpe_name,
165 .format_tx_trace = format_lisp_gpe_tx_trace,
166 .tx_function = lisp_gpe_interface_tx,
167 .no_flatten_output_chains = 1,
172 format_lisp_gpe_header_with_length (u8 * s, va_list * args)
174 lisp_gpe_header_t *h = va_arg (*args, lisp_gpe_header_t *);
175 u32 max_header_bytes = va_arg (*args, u32);
178 header_bytes = sizeof (h[0]);
179 if (max_header_bytes != 0 && header_bytes > max_header_bytes)
180 return format (s, "lisp-gpe header truncated");
182 s = format (s, "flags: ");
183 #define _(n,v) if (h->flags & v) s = format (s, "%s ", #n);
184 foreach_lisp_gpe_flag_bit;
187 s = format (s, "\n ver_res %d res %d next_protocol %d iid %d(%x)",
188 h->ver_res, h->res, h->next_protocol,
189 clib_net_to_host_u32 (h->iid), clib_net_to_host_u32 (h->iid));
194 VNET_HW_INTERFACE_CLASS (lisp_gpe_hw_class) = {
196 .format_header = format_lisp_gpe_header_with_length,
197 .build_rewrite = default_build_rewrite,
198 .build_rewrite = lisp_gpe_build_rewrite,
199 .update_adjacency = lisp_gpe_update_adjacency,
207 } l2_lisp_gpe_tx_trace_t;
210 format_l2_lisp_gpe_tx_trace (u8 * s, va_list * args)
212 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
213 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
214 l2_lisp_gpe_tx_trace_t *t = va_arg (*args, l2_lisp_gpe_tx_trace_t *);
216 s = format (s, "L2-LISP-GPE-TX: load-balance %d", t->lb_index);
221 * @brief LISP-GPE interface TX (encap) function for L2 overlays.
222 * @node l2_lisp_gpe_interface_tx
224 * The L2 LISP-GPE interface TX (encap) function.
226 * Uses bridge domain index, source and destination ethernet addresses to
227 * lookup tunnel. If the tunnel is multihomed a flow has is used to determine
228 * the sub-tunnel and therefore the rewrite string to be used to encapsulate
231 * @param[in] vm vlib_main_t corresponding to the current thread.
232 * @param[in] node vlib_node_runtime_t data for this node.
233 * @param[in] frame vlib_frame_t whose contents should be dispatched.
235 * @return number of vectors in frame.
238 l2_lisp_gpe_interface_tx (vlib_main_t * vm, vlib_node_runtime_t * node,
239 vlib_frame_t * from_frame)
241 u32 n_left_from, next_index, *from, *to_next;
242 lisp_gpe_main_t *lgm = &lisp_gpe_main;
244 from = vlib_frame_vector_args (from_frame);
245 n_left_from = from_frame->n_vectors;
247 next_index = node->cached_next_index;
249 while (n_left_from > 0)
253 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
255 while (n_left_from > 0 && n_left_to_next > 0)
259 ethernet_header_t *e0;
268 b0 = vlib_get_buffer (vm, bi0);
269 e0 = vlib_buffer_get_current (b0);
271 vnet_buffer (b0)->lisp.overlay_afi = LISP_AFI_MAC;
273 /* lookup dst + src mac */
274 lbi0 = lisp_l2_fib_lookup (lgm, vnet_buffer (b0)->l2.bd_index,
275 e0->src_address, e0->dst_address);
276 vnet_buffer (b0)->ip.adj_index[VLIB_TX] = lbi0;
279 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
281 l2_lisp_gpe_tx_trace_t *tr = vlib_add_trace (vm, node, b0,
285 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
286 n_left_to_next, bi0, l2_arc_to_lb);
289 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
292 return from_frame->n_vectors;
296 format_l2_lisp_gpe_name (u8 * s, va_list * args)
298 u32 dev_instance = va_arg (*args, u32);
299 return format (s, "l2_lisp_gpe%d", dev_instance);
303 VNET_DEVICE_CLASS (l2_lisp_gpe_device_class,static) = {
304 .name = "L2_LISP_GPE",
305 .format_device_name = format_l2_lisp_gpe_name,
306 .format_tx_trace = format_l2_lisp_gpe_tx_trace,
307 .tx_function = l2_lisp_gpe_interface_tx,
308 .no_flatten_output_chains = 1,
312 static vnet_hw_interface_t *
313 lisp_gpe_create_iface (lisp_gpe_main_t * lgm, u32 vni, u32 dp_table,
314 vnet_device_class_t * dev_class,
315 tunnel_lookup_t * tuns)
318 u32 hw_if_index = ~0;
320 vnet_hw_interface_t *hi;
321 vnet_main_t *vnm = lgm->vnet_main;
323 /* create hw lisp_gpeX iface if needed, otherwise reuse existing */
324 flen = vec_len (lgm->free_tunnel_hw_if_indices);
327 hw_if_index = lgm->free_tunnel_hw_if_indices[flen - 1];
328 _vec_len (lgm->free_tunnel_hw_if_indices) -= 1;
330 hi = vnet_get_hw_interface (vnm, hw_if_index);
332 /* rename interface */
333 new_name = format (0, "%U", dev_class->format_device_name, vni);
335 vec_add1 (new_name, 0);
336 vnet_rename_interface (vnm, hw_if_index, (char *) new_name);
339 /* clear old stats of freed interface before reuse */
340 vnet_interface_main_t *im = &vnm->interface_main;
341 vnet_interface_counter_lock (im);
342 vlib_zero_combined_counter (&im->combined_sw_if_counters
343 [VNET_INTERFACE_COUNTER_TX],
345 vlib_zero_combined_counter (&im->combined_sw_if_counters
346 [VNET_INTERFACE_COUNTER_RX],
348 vlib_zero_simple_counter (&im->sw_if_counters
349 [VNET_INTERFACE_COUNTER_DROP],
351 vnet_interface_counter_unlock (im);
355 hw_if_index = vnet_register_interface (vnm, dev_class->index, vni,
356 lisp_gpe_hw_class.index, 0);
357 hi = vnet_get_hw_interface (vnm, hw_if_index);
360 hash_set (tuns->hw_if_index_by_dp_table, dp_table, hw_if_index);
362 /* set tunnel termination: post decap, packets are tagged as having been
363 * originated by lisp-gpe interface */
364 hash_set (tuns->sw_if_index_by_vni, vni, hi->sw_if_index);
365 hash_set (tuns->vni_by_sw_if_index, hi->sw_if_index, vni);
371 lisp_gpe_remove_iface (lisp_gpe_main_t * lgm, u32 hi_index, u32 dp_table,
372 tunnel_lookup_t * tuns)
374 vnet_main_t *vnm = lgm->vnet_main;
375 vnet_hw_interface_t *hi;
378 hi = vnet_get_hw_interface (vnm, hi_index);
380 /* disable interface */
381 vnet_sw_interface_set_flags (vnm, hi->sw_if_index, 0 /* down */ );
382 vnet_hw_interface_set_flags (vnm, hi->hw_if_index, 0 /* down */ );
383 hash_unset (tuns->hw_if_index_by_dp_table, dp_table);
384 vec_add1 (lgm->free_tunnel_hw_if_indices, hi->hw_if_index);
386 /* clean tunnel termination and vni to sw_if_index binding */
387 vnip = hash_get (tuns->vni_by_sw_if_index, hi->sw_if_index);
390 clib_warning ("No vni associated to interface %d", hi->sw_if_index);
393 hash_unset (tuns->sw_if_index_by_vni, vnip[0]);
394 hash_unset (tuns->vni_by_sw_if_index, hi->sw_if_index);
398 lisp_gpe_iface_set_table (u32 sw_if_index, u32 table_id)
400 fib_node_index_t fib_index;
402 fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, table_id);
403 vec_validate (ip4_main.fib_index_by_sw_if_index, sw_if_index);
404 ip4_main.fib_index_by_sw_if_index[sw_if_index] = fib_index;
405 ip4_sw_interface_enable_disable (sw_if_index, 1);
407 fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP6, table_id);
408 vec_validate (ip6_main.fib_index_by_sw_if_index, sw_if_index);
409 ip6_main.fib_index_by_sw_if_index[sw_if_index] = fib_index;
410 ip6_sw_interface_enable_disable (sw_if_index, 1);
414 lisp_gpe_tenant_del_default_routes (u32 table_id)
416 fib_protocol_t proto;
418 FOR_EACH_FIB_IP_PROTOCOL (proto)
420 fib_prefix_t prefix = {
425 fib_index = fib_table_find (prefix.fp_proto, table_id);
426 fib_table_entry_special_remove (fib_index, &prefix, FIB_SOURCE_LISP);
427 fib_table_unlock (fib_index, prefix.fp_proto);
432 lisp_gpe_tenant_add_default_routes (u32 table_id)
434 fib_protocol_t proto;
436 FOR_EACH_FIB_IP_PROTOCOL (proto)
438 fib_prefix_t prefix = {
444 * Add a deafult route that results in a control plane punt DPO
446 fib_index = fib_table_find_or_create_and_lock (prefix.fp_proto, table_id);
447 fib_table_entry_special_dpo_add (fib_index, &prefix, FIB_SOURCE_LISP,
448 FIB_ENTRY_FLAG_EXCLUSIVE,
449 lisp_cp_dpo_get (fib_proto_to_dpo
456 * @brief Add/del LISP-GPE L3 interface.
458 * Creates LISP-GPE interface, sets ingress arcs from lisp_gpeX_lookup,
459 * installs default routes that attract all traffic with no more specific
460 * routes to lgpe-ipx-lookup, set egress arcs to ipx-lookup, sets
461 * the interface in the right vrf and enables it.
463 * @param[in] lgm Reference to @ref lisp_gpe_main_t.
464 * @param[in] a Parameters to create interface.
466 * @return number of vectors in frame.
469 lisp_gpe_add_l3_iface (lisp_gpe_main_t * lgm, u32 vni, u32 table_id)
471 vnet_main_t *vnm = lgm->vnet_main;
472 tunnel_lookup_t *l3_ifaces = &lgm->l3_ifaces;
473 vnet_hw_interface_t *hi;
476 hip = hash_get (l3_ifaces->hw_if_index_by_dp_table, table_id);
480 clib_warning ("vrf %d already mapped to a vni", table_id);
484 si = hash_get (l3_ifaces->sw_if_index_by_vni, vni);
488 clib_warning ("Interface for vni %d already exists", vni);
491 /* create lisp iface and populate tunnel tables */
492 hi = lisp_gpe_create_iface (lgm, vni, table_id,
493 &lisp_gpe_device_class, l3_ifaces);
495 /* insert default routes that point to lisp-cp lookup */
496 lisp_gpe_iface_set_table (hi->sw_if_index, table_id);
497 lisp_gpe_tenant_add_default_routes (table_id);
499 /* enable interface */
500 vnet_sw_interface_set_flags (vnm, hi->sw_if_index,
501 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
502 vnet_hw_interface_set_flags (vnm, hi->hw_if_index,
503 VNET_HW_INTERFACE_FLAG_LINK_UP);
505 return (hi->sw_if_index);
509 lisp_gpe_del_l3_iface (lisp_gpe_main_t * lgm, u32 vni, u32 table_id)
511 vnet_main_t *vnm = lgm->vnet_main;
512 tunnel_lookup_t *l3_ifaces = &lgm->l3_ifaces;
513 vnet_hw_interface_t *hi;
516 hip = hash_get (l3_ifaces->hw_if_index_by_dp_table, table_id);
520 clib_warning ("The interface for vrf %d doesn't exist", table_id);
524 hi = vnet_get_hw_interface (vnm, hip[0]);
526 lisp_gpe_remove_iface (lgm, hip[0], table_id, &lgm->l3_ifaces);
528 /* unset default routes */
529 ip4_sw_interface_enable_disable (hi->sw_if_index, 0);
530 ip6_sw_interface_enable_disable (hi->sw_if_index, 0);
531 lisp_gpe_tenant_del_default_routes (table_id);
535 * @brief Add/del LISP-GPE L2 interface.
537 * Creates LISP-GPE interface, sets it in L2 mode in the appropriate
538 * bridge domain, sets egress arcs and enables it.
540 * @param[in] lgm Reference to @ref lisp_gpe_main_t.
541 * @param[in] a Parameters to create interface.
543 * @return number of vectors in frame.
546 lisp_gpe_add_l2_iface (lisp_gpe_main_t * lgm, u32 vni, u32 bd_id)
548 vnet_main_t *vnm = lgm->vnet_main;
549 tunnel_lookup_t *l2_ifaces = &lgm->l2_ifaces;
550 vnet_hw_interface_t *hi;
554 bd_index = bd_find_or_add_bd_index (&bd_main, bd_id);
555 hip = hash_get (l2_ifaces->hw_if_index_by_dp_table, bd_index);
559 clib_warning ("bridge domain %d already mapped to a vni", bd_id);
563 si = hash_get (l2_ifaces->sw_if_index_by_vni, vni);
566 clib_warning ("Interface for vni %d already exists", vni);
570 /* create lisp iface and populate tunnel tables */
571 hi = lisp_gpe_create_iface (lgm, vni, bd_index,
572 &l2_lisp_gpe_device_class, &lgm->l2_ifaces);
574 /* enable interface */
575 vnet_sw_interface_set_flags (vnm, hi->sw_if_index,
576 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
577 vnet_hw_interface_set_flags (vnm, hi->hw_if_index,
578 VNET_HW_INTERFACE_FLAG_LINK_UP);
580 l2_arc_to_lb = vlib_node_add_named_next (vlib_get_main (),
584 /* we're ready. add iface to l2 bridge domain */
585 set_int_l2_mode (lgm->vlib_main, vnm, MODE_L2_BRIDGE, hi->sw_if_index,
588 return (hi->sw_if_index);
592 * @brief Add/del LISP-GPE L2 interface.
594 * Creates LISP-GPE interface, sets it in L2 mode in the appropriate
595 * bridge domain, sets egress arcs and enables it.
597 * @param[in] lgm Reference to @ref lisp_gpe_main_t.
598 * @param[in] a Parameters to create interface.
600 * @return number of vectors in frame.
603 lisp_gpe_del_l2_iface (lisp_gpe_main_t * lgm, u32 vni, u32 bd_id)
605 tunnel_lookup_t *l2_ifaces = &lgm->l2_ifaces;
609 bd_index = bd_find_or_add_bd_index (&bd_main, bd_id);
610 hip = hash_get (l2_ifaces->hw_if_index_by_dp_table, bd_index);
614 clib_warning ("The interface for bridge domain %d doesn't exist",
618 lisp_gpe_remove_iface (lgm, hip[0], bd_index, &lgm->l2_ifaces);
621 static clib_error_t *
622 lisp_gpe_add_del_iface_command_fn (vlib_main_t * vm, unformat_input_t * input,
623 vlib_cli_command_t * cmd)
625 unformat_input_t _line_input, *line_input = &_line_input;
627 u32 table_id, vni, bd_id;
628 u8 vni_is_set = 0, vrf_is_set = 0, bd_index_is_set = 0;
630 if (vnet_lisp_gpe_enable_disable_status () == 0)
632 return clib_error_return (0, "LISP is disabled");
635 /* Get a line of input. */
636 if (!unformat_user (input, unformat_line_input, line_input))
639 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
641 if (unformat (line_input, "add"))
643 else if (unformat (line_input, "del"))
645 else if (unformat (line_input, "vrf %d", &table_id))
649 else if (unformat (line_input, "vni %d", &vni))
653 else if (unformat (line_input, "bd %d", &bd_id))
659 return clib_error_return (0, "parse error: '%U'",
660 format_unformat_error, line_input);
664 if (vrf_is_set && bd_index_is_set)
665 return clib_error_return (0,
666 "Cannot set both vrf and brdige domain index!");
669 return clib_error_return (0, "vni must be set!");
671 if (!vrf_is_set && !bd_index_is_set)
672 return clib_error_return (0, "vrf or bridge domain index must be set!");
678 if (~0 == lisp_gpe_tenant_l2_iface_add_or_lock (vni, bd_id))
679 return clib_error_return (0, "L2 interface not created");
682 lisp_gpe_tenant_l2_iface_unlock (vni);
688 if (~0 == lisp_gpe_tenant_l3_iface_add_or_lock (vni, table_id))
689 return clib_error_return (0, "L3 interface not created");
692 lisp_gpe_tenant_l3_iface_unlock (vni);
699 VLIB_CLI_COMMAND (add_del_lisp_gpe_iface_command, static) = {
700 .path = "lisp gpe iface",
701 .short_help = "lisp gpe iface add/del vni <vni> vrf <vrf>",
702 .function = lisp_gpe_add_del_iface_command_fn,
707 * fd.io coding-style-patch-verification: ON
710 * eval: (c-set-style "gnu")