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,
171 format_lisp_gpe_header_with_length (u8 * s, va_list * args)
173 lisp_gpe_header_t *h = va_arg (*args, lisp_gpe_header_t *);
174 u32 max_header_bytes = va_arg (*args, u32);
177 header_bytes = sizeof (h[0]);
178 if (max_header_bytes != 0 && header_bytes > max_header_bytes)
179 return format (s, "lisp-gpe header truncated");
181 s = format (s, "flags: ");
182 #define _(n,v) if (h->flags & v) s = format (s, "%s ", #n);
183 foreach_lisp_gpe_flag_bit;
186 s = format (s, "\n ver_res %d res %d next_protocol %d iid %d(%x)",
187 h->ver_res, h->res, h->next_protocol,
188 clib_net_to_host_u32 (h->iid), clib_net_to_host_u32 (h->iid));
193 VNET_HW_INTERFACE_CLASS (lisp_gpe_hw_class) = {
195 .format_header = format_lisp_gpe_header_with_length,
196 .build_rewrite = lisp_gpe_build_rewrite,
197 .update_adjacency = lisp_gpe_update_adjacency,
205 } l2_lisp_gpe_tx_trace_t;
208 format_l2_lisp_gpe_tx_trace (u8 * s, va_list * args)
210 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
211 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
212 l2_lisp_gpe_tx_trace_t *t = va_arg (*args, l2_lisp_gpe_tx_trace_t *);
214 s = format (s, "L2-LISP-GPE-TX: load-balance %d", t->lb_index);
219 * @brief LISP-GPE interface TX (encap) function for L2 overlays.
220 * @node l2_lisp_gpe_interface_tx
222 * The L2 LISP-GPE interface TX (encap) function.
224 * Uses bridge domain index, source and destination ethernet addresses to
225 * lookup tunnel. If the tunnel is multihomed a flow has is used to determine
226 * the sub-tunnel and therefore the rewrite string to be used to encapsulate
229 * @param[in] vm vlib_main_t corresponding to the current thread.
230 * @param[in] node vlib_node_runtime_t data for this node.
231 * @param[in] frame vlib_frame_t whose contents should be dispatched.
233 * @return number of vectors in frame.
236 l2_lisp_gpe_interface_tx (vlib_main_t * vm, vlib_node_runtime_t * node,
237 vlib_frame_t * from_frame)
239 u32 n_left_from, next_index, *from, *to_next;
240 lisp_gpe_main_t *lgm = &lisp_gpe_main;
242 from = vlib_frame_vector_args (from_frame);
243 n_left_from = from_frame->n_vectors;
245 next_index = node->cached_next_index;
247 while (n_left_from > 0)
251 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
253 while (n_left_from > 0 && n_left_to_next > 0)
257 ethernet_header_t *e0;
266 b0 = vlib_get_buffer (vm, bi0);
267 e0 = vlib_buffer_get_current (b0);
269 vnet_buffer (b0)->lisp.overlay_afi = LISP_AFI_MAC;
271 /* lookup dst + src mac */
272 lbi0 = lisp_l2_fib_lookup (lgm, vnet_buffer (b0)->l2.bd_index,
273 e0->src_address, e0->dst_address);
274 vnet_buffer (b0)->ip.adj_index[VLIB_TX] = lbi0;
277 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
279 l2_lisp_gpe_tx_trace_t *tr = vlib_add_trace (vm, node, b0,
283 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
284 n_left_to_next, bi0, l2_arc_to_lb);
287 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
290 return from_frame->n_vectors;
294 format_l2_lisp_gpe_name (u8 * s, va_list * args)
296 u32 dev_instance = va_arg (*args, u32);
297 return format (s, "l2_lisp_gpe%d", dev_instance);
301 VNET_DEVICE_CLASS (l2_lisp_gpe_device_class,static) = {
302 .name = "L2_LISP_GPE",
303 .format_device_name = format_l2_lisp_gpe_name,
304 .format_tx_trace = format_l2_lisp_gpe_tx_trace,
305 .tx_function = l2_lisp_gpe_interface_tx,
309 static vnet_hw_interface_t *
310 lisp_gpe_create_iface (lisp_gpe_main_t * lgm, u32 vni, u32 dp_table,
311 vnet_device_class_t * dev_class,
312 tunnel_lookup_t * tuns)
315 u32 hw_if_index = ~0;
317 vnet_hw_interface_t *hi;
318 vnet_main_t *vnm = lgm->vnet_main;
320 /* create hw lisp_gpeX iface if needed, otherwise reuse existing */
321 flen = vec_len (lgm->free_tunnel_hw_if_indices);
324 hw_if_index = lgm->free_tunnel_hw_if_indices[flen - 1];
325 _vec_len (lgm->free_tunnel_hw_if_indices) -= 1;
327 hi = vnet_get_hw_interface (vnm, hw_if_index);
329 /* rename interface */
330 new_name = format (0, "%U", dev_class->format_device_name, vni);
332 vec_add1 (new_name, 0);
333 vnet_rename_interface (vnm, hw_if_index, (char *) new_name);
336 /* clear old stats of freed interface before reuse */
337 vnet_interface_main_t *im = &vnm->interface_main;
338 vnet_interface_counter_lock (im);
339 vlib_zero_combined_counter (&im->combined_sw_if_counters
340 [VNET_INTERFACE_COUNTER_TX],
342 vlib_zero_combined_counter (&im->combined_sw_if_counters
343 [VNET_INTERFACE_COUNTER_RX],
345 vlib_zero_simple_counter (&im->sw_if_counters
346 [VNET_INTERFACE_COUNTER_DROP],
348 vnet_interface_counter_unlock (im);
352 hw_if_index = vnet_register_interface (vnm, dev_class->index, vni,
353 lisp_gpe_hw_class.index, 0);
354 hi = vnet_get_hw_interface (vnm, hw_if_index);
357 hash_set (tuns->hw_if_index_by_dp_table, dp_table, hw_if_index);
359 /* set tunnel termination: post decap, packets are tagged as having been
360 * originated by lisp-gpe interface */
361 hash_set (tuns->sw_if_index_by_vni, vni, hi->sw_if_index);
362 hash_set (tuns->vni_by_sw_if_index, hi->sw_if_index, vni);
368 lisp_gpe_remove_iface (lisp_gpe_main_t * lgm, u32 hi_index, u32 dp_table,
369 tunnel_lookup_t * tuns)
371 vnet_main_t *vnm = lgm->vnet_main;
372 vnet_hw_interface_t *hi;
375 hi = vnet_get_hw_interface (vnm, hi_index);
377 /* disable interface */
378 vnet_sw_interface_set_flags (vnm, hi->sw_if_index, 0 /* down */ );
379 vnet_hw_interface_set_flags (vnm, hi->hw_if_index, 0 /* down */ );
380 hash_unset (tuns->hw_if_index_by_dp_table, dp_table);
381 vec_add1 (lgm->free_tunnel_hw_if_indices, hi->hw_if_index);
383 /* clean tunnel termination and vni to sw_if_index binding */
384 vnip = hash_get (tuns->vni_by_sw_if_index, hi->sw_if_index);
387 clib_warning ("No vni associated to interface %d", hi->sw_if_index);
390 hash_unset (tuns->sw_if_index_by_vni, vnip[0]);
391 hash_unset (tuns->vni_by_sw_if_index, hi->sw_if_index);
395 lisp_gpe_iface_set_table (u32 sw_if_index, u32 table_id)
397 fib_node_index_t fib_index;
399 fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4, table_id);
400 vec_validate (ip4_main.fib_index_by_sw_if_index, sw_if_index);
401 ip4_main.fib_index_by_sw_if_index[sw_if_index] = fib_index;
402 ip4_sw_interface_enable_disable (sw_if_index, 1);
404 fib_index = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP6, table_id);
405 vec_validate (ip6_main.fib_index_by_sw_if_index, sw_if_index);
406 ip6_main.fib_index_by_sw_if_index[sw_if_index] = fib_index;
407 ip6_sw_interface_enable_disable (sw_if_index, 1);
411 lisp_gpe_tenant_del_default_routes (u32 table_id)
413 fib_protocol_t proto;
415 FOR_EACH_FIB_IP_PROTOCOL (proto)
417 fib_prefix_t prefix = {
422 fib_index = fib_table_find (prefix.fp_proto, table_id);
423 fib_table_entry_special_remove (fib_index, &prefix, FIB_SOURCE_LISP);
424 fib_table_unlock (fib_index, prefix.fp_proto);
429 lisp_gpe_tenant_add_default_routes (u32 table_id)
431 fib_protocol_t proto;
433 FOR_EACH_FIB_IP_PROTOCOL (proto)
435 fib_prefix_t prefix = {
441 * Add a deafult route that results in a control plane punt DPO
443 fib_index = fib_table_find_or_create_and_lock (prefix.fp_proto, table_id);
444 fib_table_entry_special_dpo_add (fib_index, &prefix, FIB_SOURCE_LISP,
445 FIB_ENTRY_FLAG_EXCLUSIVE,
446 lisp_cp_dpo_get (fib_proto_to_dpo
453 * @brief Add/del LISP-GPE L3 interface.
455 * Creates LISP-GPE interface, sets ingress arcs from lisp_gpeX_lookup,
456 * installs default routes that attract all traffic with no more specific
457 * routes to lgpe-ipx-lookup, set egress arcs to ipx-lookup, sets
458 * the interface in the right vrf and enables it.
460 * @param[in] lgm Reference to @ref lisp_gpe_main_t.
461 * @param[in] a Parameters to create interface.
463 * @return number of vectors in frame.
466 lisp_gpe_add_l3_iface (lisp_gpe_main_t * lgm, u32 vni, u32 table_id)
468 vnet_main_t *vnm = lgm->vnet_main;
469 tunnel_lookup_t *l3_ifaces = &lgm->l3_ifaces;
470 vnet_hw_interface_t *hi;
473 hip = hash_get (l3_ifaces->hw_if_index_by_dp_table, table_id);
477 clib_warning ("vrf %d already mapped to a vni", table_id);
481 si = hash_get (l3_ifaces->sw_if_index_by_vni, vni);
485 clib_warning ("Interface for vni %d already exists", vni);
488 /* create lisp iface and populate tunnel tables */
489 hi = lisp_gpe_create_iface (lgm, vni, table_id,
490 &lisp_gpe_device_class, l3_ifaces);
492 /* insert default routes that point to lisp-cp lookup */
493 lisp_gpe_iface_set_table (hi->sw_if_index, table_id);
494 lisp_gpe_tenant_add_default_routes (table_id);
496 /* enable interface */
497 vnet_sw_interface_set_flags (vnm, hi->sw_if_index,
498 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
499 vnet_hw_interface_set_flags (vnm, hi->hw_if_index,
500 VNET_HW_INTERFACE_FLAG_LINK_UP);
502 return (hi->sw_if_index);
506 lisp_gpe_del_l3_iface (lisp_gpe_main_t * lgm, u32 vni, u32 table_id)
508 vnet_main_t *vnm = lgm->vnet_main;
509 tunnel_lookup_t *l3_ifaces = &lgm->l3_ifaces;
510 vnet_hw_interface_t *hi;
513 hip = hash_get (l3_ifaces->hw_if_index_by_dp_table, table_id);
517 clib_warning ("The interface for vrf %d doesn't exist", table_id);
521 hi = vnet_get_hw_interface (vnm, hip[0]);
523 lisp_gpe_remove_iface (lgm, hip[0], table_id, &lgm->l3_ifaces);
525 /* unset default routes */
526 ip4_sw_interface_enable_disable (hi->sw_if_index, 0);
527 ip6_sw_interface_enable_disable (hi->sw_if_index, 0);
528 lisp_gpe_tenant_del_default_routes (table_id);
532 * @brief Add/del LISP-GPE L2 interface.
534 * Creates LISP-GPE interface, sets it in L2 mode in the appropriate
535 * bridge domain, sets egress arcs and enables it.
537 * @param[in] lgm Reference to @ref lisp_gpe_main_t.
538 * @param[in] a Parameters to create interface.
540 * @return number of vectors in frame.
543 lisp_gpe_add_l2_iface (lisp_gpe_main_t * lgm, u32 vni, u32 bd_id)
545 vnet_main_t *vnm = lgm->vnet_main;
546 tunnel_lookup_t *l2_ifaces = &lgm->l2_ifaces;
547 vnet_hw_interface_t *hi;
551 bd_index = bd_find_or_add_bd_index (&bd_main, bd_id);
552 hip = hash_get (l2_ifaces->hw_if_index_by_dp_table, bd_index);
556 clib_warning ("bridge domain %d already mapped to a vni", bd_id);
560 si = hash_get (l2_ifaces->sw_if_index_by_vni, vni);
563 clib_warning ("Interface for vni %d already exists", vni);
567 /* create lisp iface and populate tunnel tables */
568 hi = lisp_gpe_create_iface (lgm, vni, bd_index,
569 &l2_lisp_gpe_device_class, &lgm->l2_ifaces);
571 /* enable interface */
572 vnet_sw_interface_set_flags (vnm, hi->sw_if_index,
573 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
574 vnet_hw_interface_set_flags (vnm, hi->hw_if_index,
575 VNET_HW_INTERFACE_FLAG_LINK_UP);
577 l2_arc_to_lb = vlib_node_add_named_next (vlib_get_main (),
581 /* we're ready. add iface to l2 bridge domain */
582 set_int_l2_mode (lgm->vlib_main, vnm, MODE_L2_BRIDGE, hi->sw_if_index,
585 return (hi->sw_if_index);
589 * @brief Add/del LISP-GPE L2 interface.
591 * Creates LISP-GPE interface, sets it in L2 mode in the appropriate
592 * bridge domain, sets egress arcs and enables it.
594 * @param[in] lgm Reference to @ref lisp_gpe_main_t.
595 * @param[in] a Parameters to create interface.
597 * @return number of vectors in frame.
600 lisp_gpe_del_l2_iface (lisp_gpe_main_t * lgm, u32 vni, u32 bd_id)
602 tunnel_lookup_t *l2_ifaces = &lgm->l2_ifaces;
606 bd_index = bd_find_or_add_bd_index (&bd_main, bd_id);
607 hip = hash_get (l2_ifaces->hw_if_index_by_dp_table, bd_index);
611 clib_warning ("The interface for bridge domain %d doesn't exist",
615 lisp_gpe_remove_iface (lgm, hip[0], bd_index, &lgm->l2_ifaces);
618 static clib_error_t *
619 lisp_gpe_add_del_iface_command_fn (vlib_main_t * vm, unformat_input_t * input,
620 vlib_cli_command_t * cmd)
622 unformat_input_t _line_input, *line_input = &_line_input;
624 u32 table_id, vni, bd_id;
625 u8 vni_is_set = 0, vrf_is_set = 0, bd_index_is_set = 0;
627 if (vnet_lisp_gpe_enable_disable_status () == 0)
629 return clib_error_return (0, "LISP is disabled");
632 /* Get a line of input. */
633 if (!unformat_user (input, unformat_line_input, line_input))
636 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
638 if (unformat (line_input, "add"))
640 else if (unformat (line_input, "del"))
642 else if (unformat (line_input, "vrf %d", &table_id))
646 else if (unformat (line_input, "vni %d", &vni))
650 else if (unformat (line_input, "bd %d", &bd_id))
656 return clib_error_return (0, "parse error: '%U'",
657 format_unformat_error, line_input);
661 if (vrf_is_set && bd_index_is_set)
662 return clib_error_return (0,
663 "Cannot set both vrf and brdige domain index!");
666 return clib_error_return (0, "vni must be set!");
668 if (!vrf_is_set && !bd_index_is_set)
669 return clib_error_return (0, "vrf or bridge domain index must be set!");
675 if (~0 == lisp_gpe_tenant_l2_iface_add_or_lock (vni, bd_id))
676 return clib_error_return (0, "L2 interface not created");
679 lisp_gpe_tenant_l2_iface_unlock (vni);
685 if (~0 == lisp_gpe_tenant_l3_iface_add_or_lock (vni, table_id))
686 return clib_error_return (0, "L3 interface not created");
689 lisp_gpe_tenant_l3_iface_unlock (vni);
696 VLIB_CLI_COMMAND (add_del_lisp_gpe_iface_command, static) = {
697 .path = "lisp gpe iface",
698 .short_help = "lisp gpe iface add/del vni <vni> vrf <vrf>",
699 .function = lisp_gpe_add_del_iface_command_fn,
704 * fd.io coding-style-patch-verification: ON
707 * eval: (c-set-style "gnu")