2 * Copyright (c) 2019 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.
16 #include <sys/socket.h>
19 //#include <vlib/vlib.h>
20 #include <vlib/unix/plugin.h>
21 #include <linux-cp/lcp_nl.h>
22 #include <linux-cp/lcp_interface.h>
24 #include <netlink/msg.h>
25 #include <netlink/netlink.h>
26 #include <netlink/socket.h>
27 #include <netlink/route/link.h>
28 #include <netlink/route/route.h>
29 #include <netlink/route/neighbour.h>
30 #include <netlink/route/addr.h>
31 #include <netlink/route/link/vlan.h>
33 #include <vnet/fib/fib_table.h>
34 #include <vnet/mfib/mfib_table.h>
35 #include <vnet/ip/ip6_ll_table.h>
36 #include <vnet/ip-neighbor/ip_neighbor.h>
37 #include <vnet/ip/ip6_link.h>
39 typedef struct lcp_router_table_t_
42 fib_protocol_t nlt_proto;
48 static uword *lcp_router_table_db[FIB_PROTOCOL_MAX];
49 static lcp_router_table_t *lcp_router_table_pool;
50 static vlib_log_class_t lcp_router_logger;
52 const static fib_prefix_t pfx_all1s = {
58 .fp_proto = FIB_PROTOCOL_IP4,
62 static fib_source_t lcp_rt_fib_src;
63 static fib_source_t lcp_rt_fib_src_dynamic;
65 #define LCP_ROUTER_DBG(...) vlib_log_debug (lcp_router_logger, __VA_ARGS__);
67 #define LCP_ROUTER_INFO(...) vlib_log_notice (lcp_router_logger, __VA_ARGS__);
69 #define LCP_ROUTER_ERROR(...) vlib_log_err (lcp_router_logger, __VA_ARGS__);
71 static const mfib_prefix_t ip4_specials[] = {
72 /* ALL prefixes are in network order */
74 /* (*,224.0.0.0)/24 - all local subnet */
76 .ip4.data_u32 = 0x000000e0,
79 .fp_proto = FIB_PROTOCOL_IP4,
83 static const mfib_prefix_t ip6_specials[] = {
84 /* ALL prefixes are in network order */
86 /* (*,ff00::)/8 - all local subnet */
88 .ip6.as_u64[0] = 0x00000000000000ff,
91 .fp_proto = FIB_PROTOCOL_IP6,
95 /* VIF to PHY DB of managed interfaces */
96 static uword *lcp_routing_itf_db;
99 lcp_router_intf_h2p (u32 host)
106 * first check the linux side created interface (i.e. vlans, tunnels etc)
108 p = hash_get (lcp_routing_itf_db, host);
114 * then check the paired phys
116 lipi = lcp_itf_pair_find_by_vif (host);
118 if (INDEX_INVALID == lipi)
121 lip = lcp_itf_pair_get (lipi);
123 return lip->lip_phy_sw_if_index;
127 * Check timestamps on netlink message and interface pair to decide whether
128 * the message should be applied. See the declaration of nl_msg_info_t for
129 * an explanation on why this is necessary.
130 * If timestamps are good (message ts is newer than intf pair ts), return 0.
134 lcp_router_lip_ts_check (nl_msg_info_t *msg_info, lcp_itf_pair_t *lip)
139 if (msg_info->ts > lip->lip_create_ts)
142 LCP_ROUTER_INFO ("Early message received for %U",
143 format_vnet_sw_if_index_name, vnet_get_main (),
144 lip->lip_phy_sw_if_index);
149 lcp_router_link_del (struct rtnl_link *rl, void *ctx)
153 if (!lcp_auto_subint ())
156 lipi = lcp_itf_pair_find_by_vif (rtnl_link_get_ifindex (rl));
158 if (INDEX_INVALID != lipi)
162 lip = lcp_itf_pair_get (lipi);
164 if (lcp_router_lip_ts_check ((nl_msg_info_t *) ctx, lip))
167 LCP_ROUTER_INFO ("delete link: %s - %U", rtnl_link_get_type (rl),
168 format_vnet_sw_if_index_name, vnet_get_main (),
169 lip->lip_phy_sw_if_index);
170 lcp_itf_pair_delete (lip->lip_phy_sw_if_index);
172 if (rtnl_link_is_vlan (rl))
174 LCP_ROUTER_INFO ("delete vlan: %s -> %U", rtnl_link_get_name (rl),
175 format_vnet_sw_if_index_name, vnet_get_main (),
176 lip->lip_phy_sw_if_index);
177 vnet_delete_sub_interface (lip->lip_phy_sw_if_index);
178 vnet_delete_sub_interface (lip->lip_host_sw_if_index);
182 LCP_ROUTER_INFO ("ignore link del: %s - %s", rtnl_link_get_type (rl),
183 rtnl_link_get_name (rl));
187 lcp_router_ip4_mroutes_add_del (u32 sw_if_index, u8 is_add)
189 const fib_route_path_t path = {
190 .frp_proto = DPO_PROTO_IP4,
191 .frp_addr = zero_addr,
192 .frp_sw_if_index = sw_if_index,
195 .frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT,
201 mfib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4, sw_if_index);
203 for (ii = 0; ii < ARRAY_LEN (ip4_specials); ii++)
207 mfib_table_entry_path_update (mfib_index, &ip4_specials[ii],
208 MFIB_SOURCE_PLUGIN_LOW,
209 MFIB_ENTRY_FLAG_NONE, &path);
213 mfib_table_entry_path_remove (mfib_index, &ip4_specials[ii],
214 MFIB_SOURCE_PLUGIN_LOW, &path);
220 lcp_router_ip6_mroutes_add_del (u32 sw_if_index, u8 is_add)
222 const fib_route_path_t path = {
223 .frp_proto = DPO_PROTO_IP6,
224 .frp_addr = zero_addr,
225 .frp_sw_if_index = sw_if_index,
228 .frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT,
234 mfib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP6, sw_if_index);
236 for (ii = 0; ii < ARRAY_LEN (ip6_specials); ii++)
240 mfib_table_entry_path_update (mfib_index, &ip6_specials[ii],
241 MFIB_SOURCE_PLUGIN_LOW,
242 MFIB_ENTRY_FLAG_NONE, &path);
246 mfib_table_entry_path_remove (mfib_index, &ip6_specials[ii],
247 MFIB_SOURCE_PLUGIN_LOW, &path);
253 lcp_router_link_mtu (struct rtnl_link *rl, u32 sw_if_index)
255 vnet_main_t *vnm = vnet_get_main ();
257 vnet_sw_interface_t *sw;
258 vnet_hw_interface_t *hw;
260 mtu = rtnl_link_get_mtu (rl);
264 sw = vnet_get_sw_interface (vnm, sw_if_index);
265 hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
267 /* If HW interface, try to change hw link */
268 if ((sw->type == sw->sup_sw_if_index) &&
269 (hw->hw_class_index == ethernet_hw_interface_class.index))
270 vnet_hw_interface_set_mtu (vnm, hw->hw_if_index, mtu);
272 vnet_sw_interface_set_mtu (vnm, sw->sw_if_index, mtu);
276 lcp_router_link_addr (struct rtnl_link *rl, lcp_itf_pair_t *lip)
278 vnet_main_t *vnm = vnet_get_main ();
279 struct nl_addr *mac_addr;
280 vnet_sw_interface_t *sw;
281 vnet_hw_interface_t *hw;
282 void *mac_addr_bytes;
284 mac_addr = rtnl_link_get_addr (rl);
285 if (!mac_addr || (nl_addr_get_family (mac_addr) != AF_LLC))
288 sw = vnet_get_sw_interface (vnm, lip->lip_phy_sw_if_index);
290 /* can only change address on hw interface */
291 if (sw->sw_if_index != sw->sup_sw_if_index)
294 hw = vnet_get_sup_hw_interface (vnm, lip->lip_phy_sw_if_index);
295 if (!vec_len (hw->hw_address))
298 mac_addr_bytes = nl_addr_get_binary_addr (mac_addr);
299 if (clib_memcmp (mac_addr_bytes, hw->hw_address, nl_addr_get_len (mac_addr)))
300 vnet_hw_interface_change_mac_address (vnm, hw->hw_if_index,
303 /* mcast adjacencies need to be updated */
304 vnet_update_adjacency_for_sw_interface (vnm, lip->lip_phy_sw_if_index,
305 lip->lip_phy_adjs.adj_index[AF_IP4]);
306 vnet_update_adjacency_for_sw_interface (vnm, lip->lip_phy_sw_if_index,
307 lip->lip_phy_adjs.adj_index[AF_IP6]);
310 static void lcp_router_table_flush (lcp_router_table_t *nlt,
311 u32 *sw_if_index_to_bool,
312 fib_source_t source);
315 lcp_router_link_add (struct rtnl_link *rl, void *ctx)
319 vnet_main_t *vnm = vnet_get_main ();
321 lipi = lcp_itf_pair_find_by_vif (rtnl_link_get_ifindex (rl));
322 up = IFF_UP & rtnl_link_get_flags (rl);
324 if (INDEX_INVALID != lipi)
330 lip = lcp_itf_pair_get (lipi);
331 if (!vnet_get_sw_interface (vnm, lip->lip_phy_sw_if_index))
334 if (lcp_router_lip_ts_check ((nl_msg_info_t *) ctx, lip))
338 vnet_sw_interface_get_flags (vnm, lip->lip_phy_sw_if_index);
339 sw_if_up = (sw_if_flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP);
343 vnet_sw_interface_admin_up (vnet_get_main (),
344 lip->lip_phy_sw_if_index);
346 else if (sw_if_up && !up)
348 vnet_sw_interface_admin_down (vnet_get_main (),
349 lip->lip_phy_sw_if_index);
351 /* When an interface is brought down administratively, the kernel
352 * removes routes which resolve through that interface. For IPv4
353 * routes, the kernel will not send any explicit RTM_DELROUTE
354 * messages about removing them. In order to synchronize with the
355 * kernel, affected IPv4 routes need to be manually removed from the
356 * FIB. The behavior is different for IPv6 routes. Explicit
357 * RTM_DELROUTE messages are sent about IPv6 routes being removed.
360 lcp_router_table_t *nlt;
362 fib_index = fib_table_get_index_for_sw_if_index (
363 FIB_PROTOCOL_IP4, lip->lip_phy_sw_if_index);
365 pool_foreach (nlt, lcp_router_table_pool)
367 if (fib_index == nlt->nlt_fib_index &&
368 FIB_PROTOCOL_IP4 == nlt->nlt_proto)
370 u32 *sw_if_index_to_bool = NULL;
372 vec_validate_init_empty (sw_if_index_to_bool,
373 lip->lip_phy_sw_if_index, false);
374 sw_if_index_to_bool[lip->lip_phy_sw_if_index] = true;
376 lcp_router_table_flush (nlt, sw_if_index_to_bool,
378 lcp_router_table_flush (nlt, sw_if_index_to_bool,
379 lcp_rt_fib_src_dynamic);
381 vec_free (sw_if_index_to_bool);
387 LCP_ROUTER_DBG ("link: %s (%d) -> %U/%U %s", rtnl_link_get_name (rl),
388 rtnl_link_get_ifindex (rl), format_vnet_sw_if_index_name,
389 vnm, lip->lip_phy_sw_if_index,
390 format_vnet_sw_if_index_name, vnm,
391 lip->lip_host_sw_if_index, (up ? "up" : "down"));
393 lcp_router_link_mtu (rl, lip->lip_phy_sw_if_index);
394 lcp_router_link_addr (rl, lip);
396 else if (lcp_auto_subint () && rtnl_link_is_vlan (rl))
398 /* Find the pair based on the parent VIF */
399 lipi = lcp_itf_pair_find_by_vif (rtnl_link_get_link (rl));
401 if (INDEX_INVALID != lipi)
403 u32 sub_phy_sw_if_index, sub_host_sw_if_index;
404 const lcp_itf_pair_t *lip;
406 u8 *ns = 0; /* FIXME */
408 lip = lcp_itf_pair_get (lipi);
410 vlan = rtnl_link_vlan_get_id (rl);
412 /* create the vlan interface on the parent phy */
413 if (vnet_create_sub_interface (lip->lip_phy_sw_if_index, vlan, 18, 0,
414 vlan, &sub_phy_sw_if_index))
416 LCP_ROUTER_INFO ("failed create phy vlan: %s on %U",
417 rtnl_link_get_name (rl),
418 format_vnet_sw_if_index_name, vnet_get_main (),
419 lip->lip_phy_sw_if_index);
422 /* create the vlan interface on the parent host */
423 if (vnet_create_sub_interface (lip->lip_host_sw_if_index, vlan, 18,
424 0, vlan, &sub_host_sw_if_index))
426 LCP_ROUTER_INFO ("failed create vlan: %s on %U",
427 rtnl_link_get_name (rl),
428 format_vnet_sw_if_index_name, vnet_get_main (),
429 lip->lip_host_sw_if_index);
437 "create vlan: %s -> (%U, %U) : (%U, %U)", rtnl_link_get_name (rl),
438 format_vnet_sw_if_index_name, vnet_get_main (),
439 lip->lip_phy_sw_if_index, format_vnet_sw_if_index_name,
440 vnet_get_main (), sub_phy_sw_if_index,
441 format_vnet_sw_if_index_name, vnet_get_main (),
442 lip->lip_host_sw_if_index, format_vnet_sw_if_index_name,
443 vnet_get_main (), sub_host_sw_if_index);
445 if ((if_name = rtnl_link_get_name (rl)) != NULL)
446 vec_validate_init_c_string (if_namev, if_name,
447 strnlen (if_name, IFNAMSIZ));
448 lcp_itf_pair_add (sub_host_sw_if_index, sub_phy_sw_if_index,
449 if_namev, rtnl_link_get_ifindex (rl),
450 lip->lip_host_type, ns);
452 vnet_sw_interface_admin_up (vnet_get_main (), sub_phy_sw_if_index);
453 vnet_sw_interface_admin_up (vnet_get_main (), sub_host_sw_if_index);
459 LCP_ROUTER_INFO ("ignore parent-link add: %s - %s",
460 rtnl_link_get_type (rl), rtnl_link_get_name (rl));
464 LCP_ROUTER_INFO ("ignore link add: %s - %s", rtnl_link_get_type (rl),
465 rtnl_link_get_name (rl));
469 lcp_router_link_sync_begin (void)
471 LCP_ROUTER_INFO ("Begin synchronization of interface configurations");
475 lcp_router_link_sync_end (void)
477 LCP_ROUTER_INFO ("End synchronization of interface configurations");
480 static clib_error_t *
481 lcp_router_link_up_down (vnet_main_t *vnm, u32 hw_if_index, u32 flags)
483 vnet_hw_interface_t *hi;
486 hi = vnet_get_hw_interface_or_null (vnm, hw_if_index);
490 lipi = lcp_itf_pair_find_by_phy (hi->sw_if_index);
491 if (lipi == INDEX_INVALID)
494 /* When the link goes down on an interface, the kernel processes routes which
495 * resolve through that interface depending on how they were created:
496 * - Legacy Route API: the kernel retains the routes and marks them as
498 * - Nexthop API: the kernel removes the next-hop objects and the routes
499 * which reference them.
501 * For IPv4 routes created with Nexthop API, the kernel will not send any
502 * explicit RTM_DELROUTE messages about removing them. In order to
503 * synchronize with the kernel, affected routes need to be manually removed
506 * The behavior is different for IPv6 routes created with Nexthop API. The
507 * kernel will send explicit RTM_DELROUTE messages about IPv6 routes being
510 if (!(flags & VNET_HW_INTERFACE_FLAG_LINK_UP) &&
511 (lcp_get_del_static_on_link_down () ||
512 lcp_get_del_dynamic_on_link_down ()))
515 u32 **fib_index_to_sw_if_index_to_bool = NULL;
517 lcp_router_table_t *nlt;
519 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
522 vec_validate_init_empty (fib_index_to_sw_if_index_to_bool, fib_index,
524 vec_validate_init_empty (fib_index_to_sw_if_index_to_bool[fib_index],
525 hi->sw_if_index, false);
526 fib_index_to_sw_if_index_to_bool[fib_index][hi->sw_if_index] = true;
528 /* clang-format off */
529 hash_foreach (id, sw_if_index, hi->sub_interface_sw_if_index_by_id,
531 fib_index = fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
533 vec_validate_init_empty (fib_index_to_sw_if_index_to_bool, fib_index,
535 vec_validate_init_empty (fib_index_to_sw_if_index_to_bool[fib_index],
537 fib_index_to_sw_if_index_to_bool[fib_index][sw_if_index] = true;
539 /* clang-format on */
541 vec_foreach_index (fib_index, fib_index_to_sw_if_index_to_bool)
543 u32 *sw_if_index_to_bool;
545 sw_if_index_to_bool = fib_index_to_sw_if_index_to_bool[fib_index];
546 if (NULL == sw_if_index_to_bool)
549 pool_foreach (nlt, lcp_router_table_pool)
551 if (fib_index == nlt->nlt_fib_index &&
552 FIB_PROTOCOL_IP4 == nlt->nlt_proto)
554 if (lcp_get_del_static_on_link_down ())
555 lcp_router_table_flush (nlt, sw_if_index_to_bool,
557 if (lcp_get_del_dynamic_on_link_down ())
558 lcp_router_table_flush (nlt, sw_if_index_to_bool,
559 lcp_rt_fib_src_dynamic);
564 vec_free (sw_if_index_to_bool);
567 vec_free (fib_index_to_sw_if_index_to_bool);
573 VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION (lcp_router_link_up_down);
575 static fib_protocol_t
576 lcp_router_proto_k2f (uint32_t k)
579 return (FIB_PROTOCOL_IP6);
580 return (FIB_PROTOCOL_IP4);
584 lcp_router_mk_addr (const struct nl_addr *rna, ip_address_t *ia)
586 fib_protocol_t fproto;
588 ip_address_reset (ia);
589 fproto = lcp_router_proto_k2f (nl_addr_get_family (rna));
591 ip_address_set (ia, nl_addr_get_binary_addr (rna),
592 FIB_PROTOCOL_IP4 == fproto ? AF_IP4 : AF_IP6);
595 static fib_protocol_t
596 lcp_router_mk_addr46 (const struct nl_addr *rna, ip46_address_t *ia)
598 fib_protocol_t fproto;
600 fproto = lcp_router_proto_k2f (nl_addr_get_family (rna));
601 ip46_address_reset (ia);
602 if (FIB_PROTOCOL_IP4 == fproto)
603 memcpy (&ia->ip4, nl_addr_get_binary_addr (rna), nl_addr_get_len (rna));
605 memcpy (&ia->ip6, nl_addr_get_binary_addr (rna), nl_addr_get_len (rna));
611 lcp_router_link_addr_add_del (struct rtnl_addr *rla, int is_del)
615 sw_if_index = lcp_router_intf_h2p (rtnl_addr_get_ifindex (rla));
617 if (~0 != sw_if_index)
621 lcp_router_mk_addr (rtnl_addr_get_local (rla), &nh);
623 if (AF_IP4 == ip_addr_version (&nh))
625 ip4_add_del_interface_address (
626 vlib_get_main (), sw_if_index, &ip_addr_v4 (&nh),
627 rtnl_addr_get_prefixlen (rla), is_del);
628 lcp_router_ip4_mroutes_add_del (sw_if_index, !is_del);
630 else if (AF_IP6 == ip_addr_version (&nh))
632 if (ip6_address_is_link_local_unicast (&ip_addr_v6 (&nh)))
634 ip6_link_disable (sw_if_index);
637 ip6_link_enable (sw_if_index, NULL);
638 ip6_link_set_local_address (sw_if_index, &ip_addr_v6 (&nh));
641 ip6_add_del_interface_address (
642 vlib_get_main (), sw_if_index, &ip_addr_v6 (&nh),
643 rtnl_addr_get_prefixlen (rla), is_del);
644 lcp_router_ip6_mroutes_add_del (sw_if_index, !is_del);
647 LCP_ROUTER_DBG ("link-addr: %U %U/%d", format_vnet_sw_if_index_name,
648 vnet_get_main (), sw_if_index, format_ip_address, &nh,
649 rtnl_addr_get_prefixlen (rla));
654 lcp_router_link_addr_del (struct rtnl_addr *la)
656 lcp_router_link_addr_add_del (la, 1);
660 lcp_router_link_addr_add (struct rtnl_addr *la)
662 lcp_router_link_addr_add_del (la, 0);
666 lcp_router_link_addr_sync_begin (void)
668 ip_interface_address_mark ();
670 LCP_ROUTER_INFO ("Begin synchronization of interface addresses");
674 lcp_router_link_addr_sync_end (void)
676 ip_interface_address_sweep ();
678 LCP_ROUTER_INFO ("End synchronization of interface addresses");
682 lcp_router_mk_mac_addr (const struct nl_addr *rna, mac_address_t *mac)
684 mac_address_from_bytes (mac, nl_addr_get_binary_addr (rna));
688 lcp_router_neigh_del (struct rtnl_neigh *rn)
692 sw_if_index = lcp_router_intf_h2p (rtnl_neigh_get_ifindex (rn));
694 if (~0 != sw_if_index)
699 lcp_router_mk_addr (rtnl_neigh_get_dst (rn), &nh);
701 if (ip46_address_is_multicast (&ip_addr_46 (&nh)))
703 LCP_ROUTER_DBG ("ignore neighbor del: %U %U", format_ip_address, &nh,
704 format_vnet_sw_if_index_name, vnet_get_main (),
709 rv = ip_neighbor_del (&nh, sw_if_index);
714 "Failed to delete neighbor: %U %U", format_ip_address, &nh,
715 format_vnet_sw_if_index_name, vnet_get_main (), sw_if_index);
719 LCP_ROUTER_DBG ("neighbor del: %U %U", format_ip_address, &nh,
720 format_vnet_sw_if_index_name, vnet_get_main (),
725 LCP_ROUTER_INFO ("ignore neighbour del on: %d",
726 rtnl_neigh_get_ifindex (rn));
731 (NUD_PERMANENT | NUD_NOARP | NUD_REACHABLE | NUD_PROBE | NUD_STALE | \
736 lcp_router_neigh_add (struct rtnl_neigh *rn)
740 sw_if_index = lcp_router_intf_h2p (rtnl_neigh_get_ifindex (rn));
742 if (~0 != sw_if_index)
748 lcp_router_mk_addr (rtnl_neigh_get_dst (rn), &nh);
750 if (ip46_address_is_multicast (&ip_addr_46 (&nh)))
752 LCP_ROUTER_DBG ("ignore neighbor add: %U %U", format_ip_address, &nh,
753 format_vnet_sw_if_index_name, vnet_get_main (),
758 ll = rtnl_neigh_get_lladdr (rn);
759 state = rtnl_neigh_get_state (rn);
761 if (ll && (state & NUD_VALID))
764 ip_neighbor_flags_t flags;
767 lcp_router_mk_mac_addr (ll, &mac);
769 if (state & (NUD_NOARP | NUD_PERMANENT))
770 flags = IP_NEIGHBOR_FLAG_STATIC;
772 flags = IP_NEIGHBOR_FLAG_DYNAMIC;
774 rv = ip_neighbor_add (&nh, &mac, sw_if_index, flags, NULL);
779 "Failed to create neighbor: %U %U", format_ip_address, &nh,
780 format_vnet_sw_if_index_name, vnet_get_main (), sw_if_index);
784 LCP_ROUTER_DBG ("neighbor add: %U %U", format_ip_address, &nh,
785 format_vnet_sw_if_index_name, vnet_get_main (),
791 lcp_router_neigh_del (rn);
794 LCP_ROUTER_INFO ("ignore neighbour add on: %d",
795 rtnl_neigh_get_ifindex (rn));
799 lcp_router_neigh_sync_begin (void)
801 ip_neighbor_mark (AF_IP4);
802 ip_neighbor_mark (AF_IP6);
804 LCP_ROUTER_INFO ("Begin synchronization of neighbors");
808 lcp_router_neigh_sync_end (void)
810 ip_neighbor_sweep (AF_IP4);
811 ip_neighbor_sweep (AF_IP6);
813 LCP_ROUTER_INFO ("End synchronization of neighbors");
816 static lcp_router_table_t *
817 lcp_router_table_find (uint32_t id, fib_protocol_t fproto)
821 p = hash_get (lcp_router_table_db[fproto], id);
824 return pool_elt_at_index (lcp_router_table_pool, p[0]);
830 lcp_router_table_k2f (uint32_t k)
832 // the kernel's table ID 255 is the default table
833 if (k == 255 || k == 254)
838 static lcp_router_table_t *
839 lcp_router_table_add_or_lock (uint32_t id, fib_protocol_t fproto)
841 lcp_router_table_t *nlt;
843 id = lcp_router_table_k2f (id);
844 nlt = lcp_router_table_find (id, fproto);
848 pool_get_zero (lcp_router_table_pool, nlt);
851 nlt->nlt_proto = fproto;
853 nlt->nlt_fib_index = fib_table_find_or_create_and_lock (
854 nlt->nlt_proto, nlt->nlt_id, lcp_rt_fib_src);
855 nlt->nlt_mfib_index = mfib_table_find_or_create_and_lock (
856 nlt->nlt_proto, nlt->nlt_id, MFIB_SOURCE_PLUGIN_LOW);
858 hash_set (lcp_router_table_db[fproto], nlt->nlt_id,
859 nlt - lcp_router_table_pool);
861 if (FIB_PROTOCOL_IP4 == fproto)
863 /* Set the all 1s address in this table to punt */
864 fib_table_entry_special_add (nlt->nlt_fib_index, &pfx_all1s,
865 lcp_rt_fib_src, FIB_ENTRY_FLAG_LOCAL);
867 const fib_route_path_t path = {
868 .frp_proto = DPO_PROTO_IP4,
869 .frp_addr = zero_addr,
870 .frp_sw_if_index = ~0,
873 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
874 .frp_flags = FIB_ROUTE_PATH_LOCAL,
878 for (ii = 0; ii < ARRAY_LEN (ip4_specials); ii++)
880 mfib_table_entry_path_update (
881 nlt->nlt_mfib_index, &ip4_specials[ii], MFIB_SOURCE_PLUGIN_LOW,
882 MFIB_ENTRY_FLAG_NONE, &path);
885 else if (FIB_PROTOCOL_IP6 == fproto)
887 const fib_route_path_t path = {
888 .frp_proto = DPO_PROTO_IP6,
889 .frp_addr = zero_addr,
890 .frp_sw_if_index = ~0,
893 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
894 .frp_flags = FIB_ROUTE_PATH_LOCAL,
898 for (ii = 0; ii < ARRAY_LEN (ip6_specials); ii++)
900 mfib_table_entry_path_update (
901 nlt->nlt_mfib_index, &ip6_specials[ii], MFIB_SOURCE_PLUGIN_LOW,
902 MFIB_ENTRY_FLAG_NONE, &path);
913 lcp_router_table_unlock (lcp_router_table_t *nlt)
917 if (0 == nlt->nlt_refs)
919 if (FIB_PROTOCOL_IP4 == nlt->nlt_proto)
921 /* Set the all 1s address in this table to punt */
922 fib_table_entry_special_remove (nlt->nlt_fib_index, &pfx_all1s,
926 fib_table_unlock (nlt->nlt_fib_index, nlt->nlt_proto, lcp_rt_fib_src);
928 hash_unset (lcp_router_table_db[nlt->nlt_proto], nlt->nlt_id);
929 pool_put (lcp_router_table_pool, nlt);
934 lcp_router_route_mk_prefix (struct rtnl_route *r, fib_prefix_t *p)
936 const struct nl_addr *addr = rtnl_route_get_dst (r);
938 p->fp_len = nl_addr_get_prefixlen (addr);
939 p->fp_proto = lcp_router_mk_addr46 (addr, &p->fp_addr);
943 lcp_router_route_mk_mprefix (struct rtnl_route *r, mfib_prefix_t *p)
945 const struct nl_addr *addr;
947 addr = rtnl_route_get_dst (r);
949 p->fp_len = nl_addr_get_prefixlen (addr);
950 p->fp_proto = lcp_router_mk_addr46 (addr, &p->fp_grp_addr);
952 addr = rtnl_route_get_src (r);
954 p->fp_proto = lcp_router_mk_addr46 (addr, &p->fp_src_addr);
957 typedef struct lcp_router_route_path_parse_t_
959 fib_route_path_t *paths;
960 fib_protocol_t route_proto;
962 fib_route_path_flags_t type_flags;
964 } lcp_router_route_path_parse_t;
967 lcp_router_route_path_parse (struct rtnl_nexthop *rnh, void *arg)
969 lcp_router_route_path_parse_t *ctx = arg;
970 fib_route_path_t *path;
973 sw_if_index = lcp_router_intf_h2p (rtnl_route_nh_get_ifindex (rnh));
975 if (~0 != sw_if_index)
977 fib_protocol_t fproto;
978 struct nl_addr *addr;
980 vec_add2 (ctx->paths, path, 1);
982 path->frp_flags = FIB_ROUTE_PATH_FLAG_NONE | ctx->type_flags;
983 path->frp_sw_if_index = sw_if_index;
984 path->frp_weight = rtnl_route_nh_get_weight (rnh);
985 path->frp_preference = ctx->preference;
987 addr = rtnl_route_nh_get_gateway (rnh);
990 fproto = lcp_router_mk_addr46 (rtnl_route_nh_get_gateway (rnh),
993 fproto = ctx->route_proto;
995 path->frp_proto = fib_proto_to_dpo (fproto);
998 path->frp_mitf_flags = MFIB_ITF_FLAG_FORWARD;
1000 LCP_ROUTER_DBG (" path:[%U]", format_fib_route_path, path);
1005 * blackhole, unreachable, prohibit will not have a next hop in an
1006 * RTM_NEWROUTE. Add a path for them.
1009 lcp_router_route_path_add_special (struct rtnl_route *rr,
1010 lcp_router_route_path_parse_t *ctx)
1012 fib_route_path_t *path;
1014 if (rtnl_route_get_type (rr) < RTN_BLACKHOLE)
1017 /* if it already has a path, it does not need us to add one */
1018 if (vec_len (ctx->paths) > 0)
1021 vec_add2 (ctx->paths, path, 1);
1023 path->frp_flags = FIB_ROUTE_PATH_FLAG_NONE | ctx->type_flags;
1024 path->frp_sw_if_index = ~0;
1025 path->frp_proto = fib_proto_to_dpo (ctx->route_proto);
1026 path->frp_preference = ctx->preference;
1028 LCP_ROUTER_DBG (" path:[%U]", format_fib_route_path, path);
1032 * Map of supported route types. Some types are omitted:
1033 * RTN_LOCAL - interface address addition creates these automatically
1034 * RTN_BROADCAST - same as RTN_LOCAL
1035 * RTN_UNSPEC, RTN_ANYCAST, RTN_THROW, RTN_NAT, RTN_XRESOLVE -
1036 * There's not a VPP equivalent for these currently.
1038 static const u8 lcp_router_route_type_valid[__RTN_MAX] = {
1039 [RTN_UNICAST] = 1, [RTN_MULTICAST] = 1, [RTN_BLACKHOLE] = 1,
1040 [RTN_UNREACHABLE] = 1, [RTN_PROHIBIT] = 1,
1043 /* Map of fib entry flags by route type */
1044 static const fib_entry_flag_t lcp_router_route_type_feflags[__RTN_MAX] = {
1045 [RTN_LOCAL] = FIB_ENTRY_FLAG_LOCAL | FIB_ENTRY_FLAG_CONNECTED,
1046 [RTN_BROADCAST] = FIB_ENTRY_FLAG_DROP | FIB_ENTRY_FLAG_LOOSE_URPF_EXEMPT,
1047 [RTN_BLACKHOLE] = FIB_ENTRY_FLAG_DROP,
1050 /* Map of fib route path flags by route type */
1051 static const fib_route_path_flags_t
1052 lcp_router_route_type_frpflags[__RTN_MAX] = {
1053 [RTN_UNREACHABLE] = FIB_ROUTE_PATH_ICMP_UNREACH,
1054 [RTN_PROHIBIT] = FIB_ROUTE_PATH_ICMP_PROHIBIT,
1055 [RTN_BLACKHOLE] = FIB_ROUTE_PATH_DROP,
1058 static inline fib_source_t
1059 lcp_router_proto_fib_source (u8 rt_proto)
1061 return (rt_proto <= RTPROT_STATIC) ? lcp_rt_fib_src : lcp_rt_fib_src_dynamic;
1064 static fib_entry_flag_t
1065 lcp_router_route_mk_entry_flags (uint8_t rtype, int table_id, uint8_t rproto)
1067 fib_entry_flag_t fef = FIB_ENTRY_FLAG_NONE;
1069 fef |= lcp_router_route_type_feflags[rtype];
1070 if ((rproto == RTPROT_KERNEL) || PREDICT_FALSE (255 == table_id))
1071 /* kernel proto is interface prefixes, 255 is linux's 'local' table */
1072 fef |= FIB_ENTRY_FLAG_ATTACHED | FIB_ENTRY_FLAG_CONNECTED;
1078 lcp_router_route_del (struct rtnl_route *rr)
1080 fib_entry_flag_t entry_flags;
1083 lcp_router_table_t *nlt;
1084 uint8_t rtype, rproto;
1086 rtype = rtnl_route_get_type (rr);
1087 table_id = rtnl_route_get_table (rr);
1088 rproto = rtnl_route_get_protocol (rr);
1090 /* skip unsupported route types and local table */
1091 if (!lcp_router_route_type_valid[rtype] || (table_id == 255))
1094 lcp_router_route_mk_prefix (rr, &pfx);
1095 entry_flags = lcp_router_route_mk_entry_flags (rtype, table_id, rproto);
1096 nlt = lcp_router_table_find (lcp_router_table_k2f (table_id), pfx.fp_proto);
1098 LCP_ROUTER_DBG ("route del: %d:%U %U", rtnl_route_get_table (rr),
1099 format_fib_prefix, &pfx, format_fib_entry_flags,
1105 lcp_router_route_path_parse_t np = {
1106 .route_proto = pfx.fp_proto,
1107 .type_flags = lcp_router_route_type_frpflags[rtype],
1110 rtnl_route_foreach_nexthop (rr, lcp_router_route_path_parse, &np);
1111 lcp_router_route_path_add_special (rr, &np);
1113 if (0 != vec_len (np.paths))
1115 fib_source_t fib_src;
1117 fib_src = lcp_router_proto_fib_source (rproto);
1119 if (pfx.fp_proto == FIB_PROTOCOL_IP6)
1120 fib_table_entry_delete (nlt->nlt_fib_index, &pfx, fib_src);
1122 fib_table_entry_path_remove2 (nlt->nlt_fib_index, &pfx, fib_src,
1126 vec_free (np.paths);
1128 lcp_router_table_unlock (nlt);
1132 lcp_router_route_add (struct rtnl_route *rr)
1134 fib_entry_flag_t entry_flags;
1137 lcp_router_table_t *nlt;
1138 uint8_t rtype, rproto;
1140 rtype = rtnl_route_get_type (rr);
1141 table_id = rtnl_route_get_table (rr);
1142 rproto = rtnl_route_get_protocol (rr);
1144 /* skip unsupported route types and local table */
1145 if (!lcp_router_route_type_valid[rtype] || (table_id == 255))
1148 lcp_router_route_mk_prefix (rr, &pfx);
1149 entry_flags = lcp_router_route_mk_entry_flags (rtype, table_id, rproto);
1151 nlt = lcp_router_table_add_or_lock (table_id, pfx.fp_proto);
1152 /* Skip any kernel routes and IPv6 LL or multicast routes */
1153 if (rproto == RTPROT_KERNEL ||
1154 (FIB_PROTOCOL_IP6 == pfx.fp_proto &&
1155 (ip6_address_is_multicast (&pfx.fp_addr.ip6) ||
1156 ip6_address_is_link_local_unicast (&pfx.fp_addr.ip6))))
1158 LCP_ROUTER_DBG ("route skip: %d:%U %U", rtnl_route_get_table (rr),
1159 format_fib_prefix, &pfx, format_fib_entry_flags,
1164 LCP_ROUTER_DBG ("route add: %d:%U %U", rtnl_route_get_table (rr),
1165 format_fib_prefix, &pfx, format_fib_entry_flags,
1168 lcp_router_route_path_parse_t np = {
1169 .route_proto = pfx.fp_proto,
1170 .is_mcast = (rtype == RTN_MULTICAST),
1171 .type_flags = lcp_router_route_type_frpflags[rtype],
1172 .preference = (u8) rtnl_route_get_priority (rr),
1175 rtnl_route_foreach_nexthop (rr, lcp_router_route_path_parse, &np);
1176 lcp_router_route_path_add_special (rr, &np);
1178 if (0 != vec_len (np.paths))
1180 if (rtype == RTN_MULTICAST)
1182 /* it's not clear to me how linux expresses the RPF paramters
1183 * so we'll allow from all interfaces and hope for the best */
1184 mfib_prefix_t mpfx = {};
1186 lcp_router_route_mk_mprefix (rr, &mpfx);
1188 mfib_table_entry_update (
1189 nlt->nlt_mfib_index, &mpfx, MFIB_SOURCE_PLUGIN_LOW,
1190 MFIB_RPF_ID_NONE, MFIB_ENTRY_FLAG_ACCEPT_ALL_ITF);
1192 mfib_table_entry_paths_update (nlt->nlt_mfib_index, &mpfx,
1193 MFIB_SOURCE_PLUGIN_LOW,
1194 MFIB_ENTRY_FLAG_NONE, np.paths);
1198 fib_source_t fib_src;
1200 fib_src = lcp_router_proto_fib_source (rproto);
1202 if (pfx.fp_proto == FIB_PROTOCOL_IP6)
1203 fib_table_entry_path_add2 (nlt->nlt_fib_index, &pfx, fib_src,
1204 entry_flags, np.paths);
1206 fib_table_entry_update (nlt->nlt_fib_index, &pfx, fib_src,
1207 entry_flags, np.paths);
1211 LCP_ROUTER_DBG ("no paths for route add: %d:%U %U",
1212 rtnl_route_get_table (rr), format_fib_prefix, &pfx,
1213 format_fib_entry_flags, entry_flags);
1214 vec_free (np.paths);
1219 lcp_router_route_sync_begin (void)
1221 lcp_router_table_t *nlt;
1223 pool_foreach (nlt, lcp_router_table_pool)
1225 fib_table_mark (nlt->nlt_fib_index, nlt->nlt_proto, lcp_rt_fib_src);
1226 fib_table_mark (nlt->nlt_fib_index, nlt->nlt_proto,
1227 lcp_rt_fib_src_dynamic);
1229 LCP_ROUTER_INFO ("Begin synchronization of %U routes in table %u",
1230 format_fib_protocol, nlt->nlt_proto,
1231 nlt->nlt_fib_index);
1236 lcp_router_route_sync_end (void)
1238 lcp_router_table_t *nlt;
1240 pool_foreach (nlt, lcp_router_table_pool)
1242 fib_table_sweep (nlt->nlt_fib_index, nlt->nlt_proto, lcp_rt_fib_src);
1243 fib_table_sweep (nlt->nlt_fib_index, nlt->nlt_proto,
1244 lcp_rt_fib_src_dynamic);
1246 LCP_ROUTER_INFO ("End synchronization of %U routes in table %u",
1247 format_fib_protocol, nlt->nlt_proto,
1248 nlt->nlt_fib_index);
1252 typedef struct lcp_router_table_flush_ctx_t_
1254 fib_node_index_t *lrtf_entries;
1255 u32 *lrtf_sw_if_index_to_bool;
1256 fib_source_t lrtf_source;
1257 } lcp_router_table_flush_ctx_t;
1259 static fib_table_walk_rc_t
1260 lcp_router_table_flush_cb (fib_node_index_t fib_entry_index, void *arg)
1262 lcp_router_table_flush_ctx_t *ctx = arg;
1265 sw_if_index = fib_entry_get_resolving_interface_for_source (
1266 fib_entry_index, ctx->lrtf_source);
1268 if (sw_if_index < vec_len (ctx->lrtf_sw_if_index_to_bool) &&
1269 ctx->lrtf_sw_if_index_to_bool[sw_if_index])
1271 vec_add1 (ctx->lrtf_entries, fib_entry_index);
1273 return (FIB_TABLE_WALK_CONTINUE);
1277 lcp_router_table_flush (lcp_router_table_t *nlt, u32 *sw_if_index_to_bool,
1278 fib_source_t source)
1280 fib_node_index_t *fib_entry_index;
1281 lcp_router_table_flush_ctx_t ctx = {
1282 .lrtf_entries = NULL,
1283 .lrtf_sw_if_index_to_bool = sw_if_index_to_bool,
1284 .lrtf_source = source,
1288 "Flush table: proto %U, fib-index %u, max sw_if_index %u, source %U",
1289 format_fib_protocol, nlt->nlt_proto, nlt->nlt_fib_index,
1290 vec_len (sw_if_index_to_bool) - 1, format_fib_source, source);
1292 fib_table_walk (nlt->nlt_fib_index, nlt->nlt_proto,
1293 lcp_router_table_flush_cb, &ctx);
1295 LCP_ROUTER_DBG ("Flush table: entries number to delete %u",
1296 vec_len (ctx.lrtf_entries));
1298 vec_foreach (fib_entry_index, ctx.lrtf_entries)
1300 fib_table_entry_delete_index (*fib_entry_index, source);
1301 lcp_router_table_unlock (nlt);
1304 vec_free (ctx.lrtf_entries);
1307 const nl_vft_t lcp_router_vft = {
1308 .nvl_rt_link_add = { .is_mp_safe = 0, .cb = lcp_router_link_add },
1309 .nvl_rt_link_del = { .is_mp_safe = 0, .cb = lcp_router_link_del },
1310 .nvl_rt_link_sync_begin = { .is_mp_safe = 0,
1311 .cb = lcp_router_link_sync_begin },
1312 .nvl_rt_link_sync_end = { .is_mp_safe = 0, .cb = lcp_router_link_sync_end },
1313 .nvl_rt_addr_add = { .is_mp_safe = 0, .cb = lcp_router_link_addr_add },
1314 .nvl_rt_addr_del = { .is_mp_safe = 0, .cb = lcp_router_link_addr_del },
1315 .nvl_rt_addr_sync_begin = { .is_mp_safe = 0,
1316 .cb = lcp_router_link_addr_sync_begin },
1317 .nvl_rt_addr_sync_end = { .is_mp_safe = 0,
1318 .cb = lcp_router_link_addr_sync_end },
1319 .nvl_rt_neigh_add = { .is_mp_safe = 0, .cb = lcp_router_neigh_add },
1320 .nvl_rt_neigh_del = { .is_mp_safe = 0, .cb = lcp_router_neigh_del },
1321 .nvl_rt_neigh_sync_begin = { .is_mp_safe = 0,
1322 .cb = lcp_router_neigh_sync_begin },
1323 .nvl_rt_neigh_sync_end = { .is_mp_safe = 0,
1324 .cb = lcp_router_neigh_sync_end },
1325 .nvl_rt_route_add = { .is_mp_safe = 1, .cb = lcp_router_route_add },
1326 .nvl_rt_route_del = { .is_mp_safe = 1, .cb = lcp_router_route_del },
1327 .nvl_rt_route_sync_begin = { .is_mp_safe = 0,
1328 .cb = lcp_router_route_sync_begin },
1329 .nvl_rt_route_sync_end = { .is_mp_safe = 0,
1330 .cb = lcp_router_route_sync_end },
1333 static clib_error_t *
1334 lcp_router_init (vlib_main_t *vm)
1336 lcp_router_logger = vlib_log_register_class ("linux-cp", "router");
1338 nl_register_vft (&lcp_router_vft);
1341 * allocate 2 route sources. The low priority source will be for
1342 * dynamic routes. If a dynamic route daemon (FRR) tries to remove its
1343 * route, it will use the low priority source to ensure it will not
1344 * remove static routes which were added with the higher priority source.
1347 fib_source_allocate ("lcp-rt", FIB_SOURCE_PRIORITY_HI, FIB_SOURCE_BH_API);
1349 lcp_rt_fib_src_dynamic = fib_source_allocate (
1350 "lcp-rt-dynamic", FIB_SOURCE_PRIORITY_HI + 1, FIB_SOURCE_BH_API);
1355 VLIB_INIT_FUNCTION (lcp_router_init) = {
1356 .runs_before = VLIB_INITS ("lcp_nl_init"),
1360 * fd.io coding-style-patch-verification: ON
1363 * eval: (c-set-style "gnu")