2 * gbp.h : Group Based Policy
4 * Copyright (c) 2018 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 <plugins/gbp/gbp_endpoint.h>
19 #include <plugins/gbp/gbp_endpoint_group.h>
20 #include <plugins/gbp/gbp_itf.h>
21 #include <plugins/gbp/gbp_scanner.h>
22 #include <plugins/gbp/gbp_bridge_domain.h>
23 #include <plugins/gbp/gbp_route_domain.h>
24 #include <plugins/gbp/gbp_policy_dpo.h>
25 #include <plugins/gbp/gbp_vxlan.h>
27 #include <vnet/ethernet/arp.h>
28 #include <vnet/l2/l2_input.h>
29 #include <vnet/l2/l2_output.h>
30 #include <vnet/l2/feat_bitmap.h>
31 #include <vnet/l2/l2_fib.h>
32 #include <vnet/fib/fib_table.h>
33 #include <vnet/ip/ip_neighbor.h>
34 #include <vnet/fib/fib_walk.h>
35 #include <vnet/vxlan-gbp/vxlan_gbp.h>
37 static const char *gbp_endpoint_attr_names[] = GBP_ENDPOINT_ATTR_NAMES;
42 gbp_ep_db_t gbp_ep_db;
44 fib_node_type_t gbp_endpoint_fib_type;
46 vlib_log_class_t gbp_ep_logger;
48 #define GBP_ENDPOINT_DBG(...) \
49 vlib_log_debug (gbp_ep_logger, __VA_ARGS__);
51 #define GBP_ENDPOINT_INFO(...) \
52 vlib_log_notice (gbp_ep_logger, __VA_ARGS__);
55 * Pool of GBP endpoints
57 gbp_endpoint_t *gbp_endpoint_pool;
60 * A count of the number of dynamic entries
62 static u32 gbp_n_learnt_endpoints;
64 #define FOR_EACH_GBP_ENDPOINT_ATTR(_item) \
65 for (_item = GBP_ENDPOINT_ATTR_FIRST; \
66 _item < GBP_ENDPOINT_ATTR_LAST; \
70 format_gbp_endpoint_flags (u8 * s, va_list * args)
72 gbp_endpoint_attr_t attr;
73 gbp_endpoint_flags_t flags = va_arg (*args, gbp_endpoint_flags_t);
75 FOR_EACH_GBP_ENDPOINT_ATTR (attr)
77 if ((1 << attr) & flags)
79 s = format (s, "%s,", gbp_endpoint_attr_names[attr]);
87 gbp_endpoint_is_remote (const gbp_endpoint_t * ge)
89 return (! !(ge->ge_fwd.gef_flags & GBP_ENDPOINT_FLAG_REMOTE));
93 gbp_endpoint_is_local (const gbp_endpoint_t * ge)
95 return (!(ge->ge_fwd.gef_flags & GBP_ENDPOINT_FLAG_REMOTE));
99 gbp_endpoint_is_external (const gbp_endpoint_t * ge)
101 return (! !(ge->ge_fwd.gef_flags & GBP_ENDPOINT_FLAG_EXTERNAL));
105 gbp_endpoint_is_learnt (const gbp_endpoint_t * ge)
107 if (0 == vec_len (ge->ge_locs))
110 /* DP is the highest source so if present it will be first */
111 return (ge->ge_locs[0].gel_src == GBP_ENDPOINT_SRC_DP);
115 gbp_endpoint_extract_key_mac_itf (const clib_bihash_kv_16_8_t * key,
116 mac_address_t * mac, u32 * sw_if_index)
118 mac_address_from_u64 (mac, key->key[0]);
119 *sw_if_index = key->key[1];
123 gbp_endpoint_extract_key_ip_itf (const clib_bihash_kv_24_8_t * key,
124 ip46_address_t * ip, u32 * sw_if_index)
126 ip->as_u64[0] = key->key[0];
127 ip->as_u64[1] = key->key[1];
128 *sw_if_index = key->key[2];
132 gbp_endpoint_find_ip (const ip46_address_t * ip, u32 fib_index)
134 clib_bihash_kv_24_8_t key, value;
137 gbp_endpoint_mk_key_ip (ip, fib_index, &key);
139 rv = clib_bihash_search_24_8 (&gbp_ep_db.ged_by_ip_rd, &key, &value);
144 return (gbp_endpoint_get (value.value));
148 gbp_endpoint_add_itf (u32 sw_if_index, index_t gei)
150 vec_validate_init_empty (gbp_ep_db.ged_by_sw_if_index, sw_if_index, ~0);
152 gbp_ep_db.ged_by_sw_if_index[sw_if_index] = gei;
156 gbp_endpoint_add_mac (const mac_address_t * mac, u32 bd_index, index_t gei)
158 clib_bihash_kv_16_8_t key;
161 gbp_endpoint_mk_key_mac (mac->bytes, bd_index, &key);
164 rv = clib_bihash_add_del_16_8 (&gbp_ep_db.ged_by_mac_bd, &key, 1);
171 gbp_endpoint_add_ip (const ip46_address_t * ip, u32 fib_index, index_t gei)
173 clib_bihash_kv_24_8_t key;
176 gbp_endpoint_mk_key_ip (ip, fib_index, &key);
179 rv = clib_bihash_add_del_24_8 (&gbp_ep_db.ged_by_ip_rd, &key, 1);
185 gbp_endpoint_del_mac (const mac_address_t * mac, u32 bd_index)
187 clib_bihash_kv_16_8_t key;
189 gbp_endpoint_mk_key_mac (mac->bytes, bd_index, &key);
191 clib_bihash_add_del_16_8 (&gbp_ep_db.ged_by_mac_bd, &key, 0);
195 gbp_endpoint_del_ip (const ip46_address_t * ip, u32 fib_index)
197 clib_bihash_kv_24_8_t key;
199 gbp_endpoint_mk_key_ip (ip, fib_index, &key);
201 clib_bihash_add_del_24_8 (&gbp_ep_db.ged_by_ip_rd, &key, 0);
205 gbp_endpoint_index (const gbp_endpoint_t * ge)
207 return (ge - gbp_endpoint_pool);
211 ip46_address_get_type (const ip46_address_t * a)
213 return (ip46_address_is_ip4 (a) ? IP46_TYPE_IP4 : IP46_TYPE_IP6);
217 gbp_endpoint_ip_is_equal (const fib_prefix_t * fp, const ip46_address_t * ip)
219 return (ip46_address_is_equal (ip, &fp->fp_addr));
223 gbp_endpoint_ips_update (gbp_endpoint_t * ge,
224 const ip46_address_t * ips,
225 const gbp_route_domain_t * grd)
227 const ip46_address_t *ip;
230 gei = gbp_endpoint_index (ge);
231 grdi = gbp_route_domain_index (grd);
233 ASSERT ((ge->ge_key.gek_grd == INDEX_INVALID) ||
234 (ge->ge_key.gek_grd == grdi));
236 vec_foreach (ip, ips)
238 if (~0 == vec_search_with_function (ge->ge_key.gek_ips, ip,
239 gbp_endpoint_ip_is_equal))
243 vec_add2 (ge->ge_key.gek_ips, pfx, 1);
244 fib_prefix_from_ip46_addr (ip, pfx);
246 gbp_endpoint_add_ip (&pfx->fp_addr,
247 grd->grd_fib_index[pfx->fp_proto], gei);
249 ge->ge_key.gek_grd = grdi;
253 static gbp_endpoint_t *
254 gbp_endpoint_alloc (const ip46_address_t * ips,
255 const gbp_route_domain_t * grd,
256 const mac_address_t * mac,
257 const gbp_bridge_domain_t * gbd)
262 pool_get_zero (gbp_endpoint_pool, ge);
264 fib_node_init (&ge->ge_node, gbp_endpoint_fib_type);
265 gei = gbp_endpoint_index (ge);
268 ge->ge_fwd.gef_itf = ge->ge_fwd.gef_fib_index = INDEX_INVALID;
269 ge->ge_last_time = vlib_time_now (vlib_get_main ());
270 ge->ge_key.gek_gbd = gbp_bridge_domain_index (gbd);
274 mac_address_copy (&ge->ge_key.gek_mac, mac);
275 gbp_endpoint_add_mac (mac, gbd->gb_bd_index, gei);
277 gbp_endpoint_ips_update (ge, ips, grd);
283 gbp_endpoint_loc_is_equal (gbp_endpoint_loc_t * a, gbp_endpoint_loc_t * b)
285 return (a->gel_src == b->gel_src);
289 gbp_endpoint_loc_cmp_for_sort (gbp_endpoint_loc_t * a, gbp_endpoint_loc_t * b)
291 return (a->gel_src - b->gel_src);
294 static gbp_endpoint_loc_t *
295 gbp_endpoint_loc_find (gbp_endpoint_t * ge, gbp_endpoint_src_t src)
297 gbp_endpoint_loc_t gel = {
302 pos = vec_search_with_function (ge->ge_locs, &gel,
303 gbp_endpoint_loc_is_equal);
306 return (&ge->ge_locs[pos]);
312 gbp_endpoint_loc_unlock (gbp_endpoint_t * ge, gbp_endpoint_loc_t * gel)
318 if (0 == gel->gel_locks)
320 pos = gel - ge->ge_locs;
322 vec_del1 (ge->ge_locs, pos);
323 if (vec_len (ge->ge_locs) > 1)
324 vec_sort_with_function (ge->ge_locs, gbp_endpoint_loc_cmp_for_sort);
326 /* This could be the last lock, so don't access the EP from
328 fib_node_unlock (&ge->ge_node);
336 gbp_endpoint_loc_destroy (gbp_endpoint_loc_t * gel)
338 gbp_endpoint_group_unlock (gel->gel_epg);
340 if (gel->gel_flags & GBP_ENDPOINT_FLAG_REMOTE)
342 vxlan_gbp_tunnel_unlock (gel->gel_sw_if_index);
346 static gbp_endpoint_loc_t *
347 gbp_endpoint_loc_find_or_add (gbp_endpoint_t * ge, gbp_endpoint_src_t src)
349 gbp_endpoint_loc_t gel = {
351 .gel_epg = INDEX_INVALID,
352 .gel_sw_if_index = INDEX_INVALID,
357 pos = vec_search_with_function (ge->ge_locs, &gel,
358 gbp_endpoint_loc_is_equal);
362 vec_add1 (ge->ge_locs, gel);
364 if (vec_len (ge->ge_locs) > 1)
366 vec_sort_with_function (ge->ge_locs, gbp_endpoint_loc_cmp_for_sort);
368 pos = vec_search_with_function (ge->ge_locs, &gel,
369 gbp_endpoint_loc_is_equal);
375 * it's the sources and children that lock the endpoints
377 fib_node_lock (&ge->ge_node);
380 return (&ge->ge_locs[pos]);
384 * Find an EP inthe DBs and check that if we find it in the L2 DB
385 * it has the same IPs as this update
388 gbp_endpoint_find_for_update (const ip46_address_t * ips,
389 const gbp_route_domain_t * grd,
390 const mac_address_t * mac,
391 const gbp_bridge_domain_t * gbd,
392 gbp_endpoint_t ** ge)
394 gbp_endpoint_t *l2_ge, *l3_ge, *tmp;
396 l2_ge = l3_ge = NULL;
398 if (NULL != mac && !mac_address_is_zero (mac))
401 l2_ge = gbp_endpoint_find_mac (mac->bytes, gbd->gb_bd_index);
403 if (NULL != ips && !ip46_address_is_zero (ips))
405 const ip46_address_t *ip;
406 fib_protocol_t fproto;
409 vec_foreach (ip, ips)
411 fproto = fib_proto_from_ip46 (ip46_address_get_type (ip));
413 tmp = gbp_endpoint_find_ip (ip, grd->grd_fib_index[fproto]);
418 else if (NULL == l3_ge)
419 /* first match against an IP address */
421 else if (tmp == l3_ge)
422 /* another match against IP address that is the same endpoint */
427 * a match agains a different endpoint.
428 * this means the KEY of the EP is changing which is not allowed
435 if (NULL == l2_ge && NULL == l3_ge)
438 else if (NULL == l2_ge)
441 else if (NULL == l3_ge)
446 /* found both L3 and L2 - they must be the same else the KEY
458 static gbp_endpoint_src_t
459 gbp_endpoint_get_best_src (const gbp_endpoint_t * ge)
461 if (0 == vec_len (ge->ge_locs))
462 return (GBP_ENDPOINT_SRC_MAX);
464 return (ge->ge_locs[0].gel_src);
468 gbp_endpoint_n_learned (int n)
470 gbp_n_learnt_endpoints += n;
472 if (n > 0 && 1 == gbp_n_learnt_endpoints)
474 vlib_process_signal_event (vlib_get_main (),
475 gbp_scanner_node.index,
476 GBP_ENDPOINT_SCAN_START, 0);
478 if (n < 0 && 0 == gbp_n_learnt_endpoints)
480 vlib_process_signal_event (vlib_get_main (),
481 gbp_scanner_node.index,
482 GBP_ENDPOINT_SCAN_STOP, 0);
487 gbp_endpoint_loc_update (gbp_endpoint_loc_t * gel,
488 const gbp_bridge_domain_t * gb,
491 gbp_endpoint_flags_t flags,
492 const ip46_address_t * tun_src,
493 const ip46_address_t * tun_dst)
495 int was_learnt, is_learnt;
498 was_learnt = ! !(gel->gel_flags & GBP_ENDPOINT_FLAG_REMOTE);
499 gel->gel_flags = flags;
500 is_learnt = ! !(gel->gel_flags & GBP_ENDPOINT_FLAG_REMOTE);
502 gbp_endpoint_n_learned (is_learnt - was_learnt);
504 if (INDEX_INVALID == gel->gel_epg)
507 if (INDEX_INVALID != gel->gel_epg)
509 gbp_endpoint_group_lock (gel->gel_epg);
514 ASSERT (gel->gel_epg == ggi);
517 if (gel->gel_flags & GBP_ENDPOINT_FLAG_REMOTE)
520 ip46_address_copy (&gel->tun.gel_src, tun_src);
522 ip46_address_copy (&gel->tun.gel_dst, tun_dst);
524 if (ip46_address_is_multicast (&gel->tun.gel_src))
527 * we learnt the EP from the multicast tunnel.
528 * Create a unicast TEP from the packet's source
529 * and the fixed address of the BD's parent tunnel
531 const gbp_vxlan_tunnel_t *gt;
533 gt = gbp_vxlan_tunnel_get (gb->gb_vni);
537 ip46_address_copy (&gel->tun.gel_src, >->gt_src);
538 sw_if_index = gt->gt_sw_if_index;
543 * the input interface may be the parent GBP-vxlan interface,
544 * create a child vlxan-gbp tunnel and use that as the endpoint's
547 if (~0 != gel->gel_sw_if_index)
548 vxlan_gbp_tunnel_unlock (gel->gel_sw_if_index);
550 switch (gbp_vxlan_tunnel_get_type (sw_if_index))
552 case GBP_VXLAN_TEMPLATE_TUNNEL:
553 gel->tun.gel_parent_sw_if_index = sw_if_index;
554 gel->gel_sw_if_index =
555 gbp_vxlan_tunnel_clone_and_lock (sw_if_index,
559 case VXLAN_GBP_TUNNEL:
560 gel->tun.gel_parent_sw_if_index =
561 vxlan_gbp_tunnel_get_parent (sw_if_index);
562 gel->gel_sw_if_index = sw_if_index;
563 vxlan_gbp_tunnel_lock (gel->gel_sw_if_index);
569 gel->gel_sw_if_index = sw_if_index;
574 gbb_endpoint_fwd_reset (gbp_endpoint_t * ge)
576 const gbp_route_domain_t *grd;
577 const gbp_bridge_domain_t *gbd;
578 gbp_endpoint_fwd_t *gef;
579 const fib_prefix_t *pfx;
583 gei = gbp_endpoint_index (ge);
584 gbd = gbp_bridge_domain_get (ge->ge_key.gek_gbd);
587 vec_foreach (pfx, ge->ge_key.gek_ips)
591 grd = gbp_route_domain_get (ge->ge_key.gek_grd);
592 fib_index = grd->grd_fib_index[pfx->fp_proto];
594 bd_add_del_ip_mac (gbd->gb_bd_index, fib_proto_to_ip46 (pfx->fp_proto),
595 &pfx->fp_addr, &ge->ge_key.gek_mac, 0);
598 * remove a host route
600 if (gbp_endpoint_is_remote (ge))
602 fib_table_entry_special_remove (fib_index, pfx, FIB_SOURCE_PLUGIN_HI);
605 fib_table_entry_delete (fib_index, pfx, FIB_SOURCE_PLUGIN_LOW);
607 vec_foreach (ai, gef->gef_adjs)
612 if (INDEX_INVALID != gef->gef_itf)
614 l2fib_del_entry (ge->ge_key.gek_mac.bytes,
615 gbd->gb_bd_index, gef->gef_itf);
616 gbp_itf_set_l2_input_feature (gef->gef_itf, gei, L2INPUT_FEAT_NONE);
617 gbp_itf_set_l2_output_feature (gef->gef_itf, gei, L2OUTPUT_FEAT_NONE);
619 gbp_itf_unlock (gef->gef_itf);
620 gef->gef_itf = INDEX_INVALID;
623 vec_free (gef->gef_adjs);
627 gbb_endpoint_fwd_recalc (gbp_endpoint_t * ge)
629 const gbp_route_domain_t *grd;
630 const gbp_bridge_domain_t *gbd;
631 const gbp_endpoint_group_t *gg;
632 gbp_endpoint_loc_t *gel;
633 gbp_endpoint_fwd_t *gef;
634 const fib_prefix_t *pfx;
638 * locations are sort in source priority order
640 gei = gbp_endpoint_index (ge);
641 gel = &ge->ge_locs[0];
643 gbd = gbp_bridge_domain_get (ge->ge_key.gek_gbd);
645 gef->gef_flags = gel->gel_flags;
647 if (INDEX_INVALID != gel->gel_epg)
649 gg = gbp_endpoint_group_get (gel->gel_epg);
650 gef->gef_sclass = gg->gg_sclass;
657 gef->gef_itf = gbp_itf_add_and_lock (gel->gel_sw_if_index,
660 if (!mac_address_is_zero (&ge->ge_key.gek_mac))
662 gbp_itf_set_l2_input_feature (gef->gef_itf, gei, L2INPUT_FEAT_GBP_FWD);
664 if (gbp_endpoint_is_remote (ge) || gbp_endpoint_is_external (ge))
667 * bridged packets to external endpoints should be classifed
668 * based on the EP's/BD's EPG
670 gbp_itf_set_l2_output_feature (gef->gef_itf, gei,
671 L2OUTPUT_FEAT_GBP_POLICY_MAC);
675 gbp_endpoint_add_itf (gef->gef_itf, gei);
676 gbp_itf_set_l2_output_feature (gef->gef_itf, gei,
677 L2OUTPUT_FEAT_GBP_POLICY_PORT);
679 l2fib_add_entry (ge->ge_key.gek_mac.bytes,
681 gef->gef_itf, L2FIB_ENTRY_RESULT_FLAG_STATIC);
684 vec_foreach (pfx, ge->ge_key.gek_ips)
686 ethernet_header_t *eth;
693 grd = gbp_route_domain_get (ge->ge_key.gek_grd);
694 fib_index = grd->grd_fib_index[pfx->fp_proto];
695 gef->gef_fib_index = fib_index;
697 bd_add_del_ip_mac (gbd->gb_bd_index, fib_proto_to_ip46 (pfx->fp_proto),
698 &pfx->fp_addr, &ge->ge_key.gek_mac, 1);
701 * add a host route via the EPG's BVI we need this because the
702 * adj fib does not install, due to cover refinement check, since
703 * the BVI's prefix is /32
705 vec_validate (rewrite, sizeof (*eth) - 1);
706 eth = (ethernet_header_t *) rewrite;
708 eth->type = clib_host_to_net_u16 ((pfx->fp_proto == FIB_PROTOCOL_IP4 ?
712 if (gbp_endpoint_is_remote (ge))
715 * for dynamic EPs we must add the IP adjacency via the learned
716 * tunnel since the BD will not contain the EP's MAC since it was
717 * L3 learned. The dst MAC address used is the 'BD's MAC'.
719 ip_sw_if_index = gef->gef_itf;
721 mac_address_to_bytes (gbp_route_domain_get_local_mac (),
723 mac_address_to_bytes (gbp_route_domain_get_remote_mac (),
729 * for the static EPs we add the IP adjacency via the BVI
730 * knowing that the BD has the MAC address to route to and
731 * that policy will be applied on egress to the EP's port
733 ip_sw_if_index = gbd->gb_bvi_sw_if_index;
735 clib_memcpy (eth->src_address,
736 vnet_sw_interface_get_hw_address (vnet_get_main (),
738 sizeof (eth->src_address));
739 mac_address_to_bytes (&ge->ge_key.gek_mac, eth->dst_address);
742 fib_table_entry_path_add (fib_index, pfx,
743 FIB_SOURCE_PLUGIN_LOW,
745 fib_proto_to_dpo (pfx->fp_proto),
746 &pfx->fp_addr, ip_sw_if_index,
747 ~0, 1, NULL, FIB_ROUTE_PATH_FLAG_NONE);
749 ai = adj_nbr_add_or_lock_w_rewrite (pfx->fp_proto,
750 fib_proto_to_link (pfx->fp_proto),
752 ip_sw_if_index, rewrite);
753 vec_add1 (gef->gef_adjs, ai);
756 * if the endpoint is external then routed packet to it must be
757 * classifed to the BD's EPG. but this will happen anyway with
758 * the GBP_MAC classification.
763 if (gbp_endpoint_is_remote (ge))
765 dpo_id_t policy_dpo = DPO_INVALID;
768 * interpose a policy DPO from the endpoint so that policy
771 gbp_policy_dpo_add_or_lock (fib_proto_to_dpo (pfx->fp_proto),
773 gg->gg_sclass, ~0, &policy_dpo);
775 fib_table_entry_special_dpo_add (fib_index, pfx,
776 FIB_SOURCE_PLUGIN_HI,
777 FIB_ENTRY_FLAG_INTERPOSE,
779 dpo_reset (&policy_dpo);
783 * send a gratuitous ARP on the EPG's uplink. this is done so
784 * that if this EP has moved from some other place in the
785 * 'fabric', upstream devices are informed
787 if (gbp_endpoint_is_local (ge) && ~0 != gg->gg_uplink_sw_if_index)
789 gbp_endpoint_add_itf (gef->gef_itf, gei);
790 if (FIB_PROTOCOL_IP4 == pfx->fp_proto)
791 send_ip4_garp_w_addr (vlib_get_main (),
793 gg->gg_uplink_sw_if_index);
795 send_ip6_na_w_addr (vlib_get_main (),
797 gg->gg_uplink_sw_if_index);
802 if (gbp_endpoint_is_external (ge))
804 gbp_itf_set_l2_input_feature (gef->gef_itf, gei,
805 L2INPUT_FEAT_GBP_LPM_CLASSIFY);
807 else if (gbp_endpoint_is_local (ge))
810 * non-remote endpoints (i.e. those not arriving on iVXLAN
811 * tunnels) need to be classifed based on the the input interface.
812 * We enable the GBP-FWD feature only if the group has an uplink
813 * interface (on which the GBP-FWD feature would send UU traffic).
814 * External endpoints get classified based on an LPM match
816 l2input_feat_masks_t feats = L2INPUT_FEAT_GBP_SRC_CLASSIFY;
818 if (NULL != gg && ~0 != gg->gg_uplink_sw_if_index)
819 feats |= L2INPUT_FEAT_GBP_FWD;
820 gbp_itf_set_l2_input_feature (gef->gef_itf, gei, feats);
824 * update children with the new forwarding info
826 fib_node_back_walk_ctx_t bw_ctx = {
827 .fnbw_reason = FIB_NODE_BW_REASON_FLAG_EVALUATE,
828 .fnbw_flags = FIB_NODE_BW_FLAG_FORCE_SYNC,
831 fib_walk_sync (gbp_endpoint_fib_type, gei, &bw_ctx);
835 gbp_endpoint_update_and_lock (gbp_endpoint_src_t src,
837 const ip46_address_t * ips,
838 const mac_address_t * mac,
839 index_t gbdi, index_t grdi,
841 gbp_endpoint_flags_t flags,
842 const ip46_address_t * tun_src,
843 const ip46_address_t * tun_dst, u32 * handle)
845 gbp_bridge_domain_t *gbd;
846 gbp_endpoint_group_t *gg;
847 gbp_endpoint_src_t best;
848 gbp_route_domain_t *grd;
849 gbp_endpoint_loc_t *gel;
854 if (~0 == sw_if_index)
855 return (VNET_API_ERROR_INVALID_SW_IF_INDEX);
861 * we need to determine the bridge-domain, either from the EPG or
864 if (SCLASS_INVALID != sclass)
866 ggi = gbp_endpoint_group_find (sclass);
868 if (INDEX_INVALID == ggi)
869 return (VNET_API_ERROR_NO_SUCH_ENTRY);
871 gg = gbp_endpoint_group_get (ggi);
877 if (INDEX_INVALID == gbdi)
878 return (VNET_API_ERROR_NO_SUCH_ENTRY);
879 if (INDEX_INVALID == grdi)
880 return (VNET_API_ERROR_NO_SUCH_FIB);
884 gbd = gbp_bridge_domain_get (gbdi);
885 grd = gbp_route_domain_get (grdi);
886 rv = gbp_endpoint_find_for_update (ips, grd, mac, gbd, &ge);
893 ge = gbp_endpoint_alloc (ips, grd, mac, gbd);
897 gbp_endpoint_ips_update (ge, ips, grd);
900 best = gbp_endpoint_get_best_src (ge);
901 gei = gbp_endpoint_index (ge);
902 gel = gbp_endpoint_loc_find_or_add (ge, src);
904 gbp_endpoint_loc_update (gel, gbd, sw_if_index, ggi, flags, tun_src,
910 * either the best source has been updated or we have a new best source
912 gbb_endpoint_fwd_reset (ge);
913 gbb_endpoint_fwd_recalc (ge);
918 * an update to a lower priority source, so we need do nothing
925 GBP_ENDPOINT_INFO ("update: %U", format_gbp_endpoint, gei);
931 gbp_endpoint_unlock (gbp_endpoint_src_t src, index_t gei)
933 gbp_endpoint_loc_t *gel, gel_copy;
934 gbp_endpoint_src_t best;
938 if (pool_is_free_index (gbp_endpoint_pool, gei))
941 GBP_ENDPOINT_INFO ("delete: %U", format_gbp_endpoint, gei);
943 ge = gbp_endpoint_get (gei);
945 gel = gbp_endpoint_loc_find (ge, src);
951 * lock the EP so we can control when it is deleted
953 fib_node_lock (&ge->ge_node);
954 best = gbp_endpoint_get_best_src (ge);
957 * copy the location info since we'll lose it when it's removed from
960 clib_memcpy (&gel_copy, gel, sizeof (gel_copy));
963 * remove the source we no longer need
965 removed = gbp_endpoint_loc_unlock (ge, gel);
970 * we have removed the old best source => recalculate fwding
972 if (0 == vec_len (ge->ge_locs))
975 * if there are no more sources left, then we need only release
976 * the fwding resources held and then this EP is gawn.
978 gbb_endpoint_fwd_reset (ge);
983 * else there are more sources. release the old and get new
986 gbb_endpoint_fwd_reset (ge);
987 gbb_endpoint_fwd_recalc (ge);
992 * we removed a lower priority source so we need to do nothing
996 * clear up any resources held by the source
999 gbp_endpoint_loc_destroy (&gel_copy);
1002 * remove the lock taken above
1004 fib_node_unlock (&ge->ge_node);
1006 * We may have removed the last source and so this EP is now TOAST
1007 * DO NOTHING BELOW HERE
1012 gbp_endpoint_child_add (index_t gei,
1013 fib_node_type_t type, fib_node_index_t index)
1015 return (fib_node_child_add (gbp_endpoint_fib_type, gei, type, index));
1019 gbp_endpoint_child_remove (index_t gei, u32 sibling)
1021 return (fib_node_child_remove (gbp_endpoint_fib_type, gei, sibling));
1024 typedef struct gbp_endpoint_flush_ctx_t_
1027 gbp_endpoint_src_t src;
1029 } gbp_endpoint_flush_ctx_t;
1032 gbp_endpoint_flush_cb (index_t gei, void *args)
1034 gbp_endpoint_flush_ctx_t *ctx = args;
1035 gbp_endpoint_loc_t *gel;
1038 ge = gbp_endpoint_get (gei);
1039 gel = gbp_endpoint_loc_find (ge, ctx->src);
1041 if ((NULL != gel) && ctx->sw_if_index == gel->tun.gel_parent_sw_if_index)
1043 vec_add1 (ctx->geis, gei);
1046 return (WALK_CONTINUE);
1050 * remove all learnt endpoints using the interface
1053 gbp_endpoint_flush (gbp_endpoint_src_t src, u32 sw_if_index)
1055 gbp_endpoint_flush_ctx_t ctx = {
1056 .sw_if_index = sw_if_index,
1061 GBP_ENDPOINT_INFO ("flush: %U %U",
1062 format_gbp_endpoint_src, src,
1063 format_vnet_sw_if_index_name, vnet_get_main (),
1065 gbp_endpoint_walk (gbp_endpoint_flush_cb, &ctx);
1067 vec_foreach (gei, ctx.geis)
1069 gbp_endpoint_unlock (src, *gei);
1072 vec_free (ctx.geis);
1076 gbp_endpoint_walk (gbp_endpoint_cb_t cb, void *ctx)
1081 pool_foreach_index(index, gbp_endpoint_pool,
1083 if (!cb(index, ctx))
1089 static clib_error_t *
1090 gbp_endpoint_cli (vlib_main_t * vm,
1091 unformat_input_t * input, vlib_cli_command_t * cmd)
1093 ip46_address_t ip = ip46_address_initializer, *ips = NULL;
1094 mac_address_t mac = ZERO_MAC_ADDRESS;
1095 vnet_main_t *vnm = vnet_get_main ();
1096 u32 sclass = SCLASS_INVALID;
1097 u32 handle = INDEX_INVALID;
1098 u32 sw_if_index = ~0;
1102 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1104 ip46_address_reset (&ip);
1106 if (unformat (input, "%U", unformat_vnet_sw_interface,
1109 else if (unformat (input, "add"))
1111 else if (unformat (input, "del"))
1113 else if (unformat (input, "sclass %d", &sclass))
1115 else if (unformat (input, "handle %d", &handle))
1117 else if (unformat (input, "ip %U", unformat_ip4_address, &ip.ip4))
1119 else if (unformat (input, "ip %U", unformat_ip6_address, &ip.ip6))
1121 else if (unformat (input, "mac %U", unformat_mac_address, &mac))
1129 if (~0 == sw_if_index)
1130 return clib_error_return (0, "interface must be specified");
1131 if (SCLASS_INVALID == sclass)
1132 return clib_error_return (0, "SCLASS must be specified");
1135 gbp_endpoint_update_and_lock (GBP_ENDPOINT_SRC_CP,
1136 sw_if_index, ips, &mac,
1137 INDEX_INVALID, INDEX_INVALID,
1139 GBP_ENDPOINT_FLAG_NONE,
1140 NULL, NULL, &handle);
1143 return clib_error_return (0, "GBP Endpoint update returned %d", rv);
1145 vlib_cli_output (vm, "handle %d\n", handle);
1149 if (INDEX_INVALID == handle)
1150 return clib_error_return (0, "handle must be specified");
1152 gbp_endpoint_unlock (GBP_ENDPOINT_SRC_CP, handle);
1161 * Configure a GBP Endpoint
1164 * @cliexstart{set gbp endpoint [del] <interface> epg <ID> ip <IP>}
1168 VLIB_CLI_COMMAND (gbp_endpoint_cli_node, static) = {
1169 .path = "gbp endpoint",
1170 .short_help = "gbp endpoint [del] <interface> epg <ID> ip <IP> mac <MAC>",
1171 .function = gbp_endpoint_cli,
1176 format_gbp_endpoint_src (u8 * s, va_list * args)
1178 gbp_endpoint_src_t action = va_arg (*args, gbp_endpoint_src_t);
1182 #define _(v,a) case GBP_ENDPOINT_SRC_##v: return (format (s, "%s", a));
1183 foreach_gbp_endpoint_src
1187 return (format (s, "unknown"));
1191 format_gbp_endpoint_fwd (u8 * s, va_list * args)
1193 gbp_endpoint_fwd_t *gef = va_arg (*args, gbp_endpoint_fwd_t *);
1195 s = format (s, "fwd:");
1196 s = format (s, "\n itf:[%U]", format_gbp_itf, gef->gef_itf);
1197 if (GBP_ENDPOINT_FLAG_NONE != gef->gef_flags)
1199 s = format (s, " flags:%U", format_gbp_endpoint_flags, gef->gef_flags);
1206 format_gbp_endpoint_key (u8 * s, va_list * args)
1208 gbp_endpoint_key_t *gek = va_arg (*args, gbp_endpoint_key_t *);
1209 const fib_prefix_t *pfx;
1211 s = format (s, "ips:[");
1213 vec_foreach (pfx, gek->gek_ips)
1215 s = format (s, "%U, ", format_fib_prefix, pfx);
1217 s = format (s, "]");
1219 s = format (s, " mac:%U", format_mac_address_t, &gek->gek_mac);
1225 format_gbp_endpoint_loc (u8 * s, va_list * args)
1227 gbp_endpoint_loc_t *gel = va_arg (*args, gbp_endpoint_loc_t *);
1229 s = format (s, "%U", format_gbp_endpoint_src, gel->gel_src);
1231 format (s, "\n %U", format_vnet_sw_if_index_name, vnet_get_main (),
1232 gel->gel_sw_if_index);
1233 s = format (s, " EPG:%d", gel->gel_epg);
1235 if (GBP_ENDPOINT_FLAG_NONE != gel->gel_flags)
1237 s = format (s, " flags:%U", format_gbp_endpoint_flags, gel->gel_flags);
1239 if (GBP_ENDPOINT_FLAG_REMOTE & gel->gel_flags)
1241 s = format (s, " tun:[");
1242 s = format (s, "parent:%U", format_vnet_sw_if_index_name,
1243 vnet_get_main (), gel->tun.gel_parent_sw_if_index);
1244 s = format (s, " {%U,%U}]",
1245 format_ip46_address, &gel->tun.gel_src, IP46_TYPE_ANY,
1246 format_ip46_address, &gel->tun.gel_dst, IP46_TYPE_ANY);
1253 format_gbp_endpoint (u8 * s, va_list * args)
1255 index_t gei = va_arg (*args, index_t);
1256 gbp_endpoint_loc_t *gel;
1259 ge = gbp_endpoint_get (gei);
1261 s = format (s, "[@%d] %U", gei, format_gbp_endpoint_key, &ge->ge_key);
1262 s = format (s, " last-time:[%f]", ge->ge_last_time);
1264 vec_foreach (gel, ge->ge_locs)
1266 s = format (s, "\n %U", format_gbp_endpoint_loc, gel);
1268 s = format (s, "\n %U", format_gbp_endpoint_fwd, &ge->ge_fwd);
1274 gbp_endpoint_show_one (index_t gei, void *ctx)
1279 vlib_cli_output (vm, " %U", format_gbp_endpoint, gei);
1281 return (WALK_CONTINUE);
1285 gbp_endpoint_walk_ip_itf (const clib_bihash_kv_24_8_t * kvp, void *arg)
1293 gbp_endpoint_extract_key_ip_itf (kvp, &ip, &sw_if_index);
1295 vlib_cli_output (vm, " {%U, %U} -> %d",
1296 format_ip46_address, &ip, IP46_TYPE_ANY,
1297 format_vnet_sw_if_index_name, vnet_get_main (),
1298 sw_if_index, kvp->value);
1302 gbp_endpoint_walk_mac_itf (const clib_bihash_kv_16_8_t * kvp, void *arg)
1310 gbp_endpoint_extract_key_mac_itf (kvp, &mac, &sw_if_index);
1312 vlib_cli_output (vm, " {%U, %U} -> %d",
1313 format_mac_address_t, &mac,
1314 format_vnet_sw_if_index_name, vnet_get_main (),
1315 sw_if_index, kvp->value);
1318 static clib_error_t *
1319 gbp_endpoint_show (vlib_main_t * vm,
1320 unformat_input_t * input, vlib_cli_command_t * cmd)
1322 u32 show_dbs, handle;
1324 handle = INDEX_INVALID;
1327 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1329 if (unformat (input, "%d", &handle))
1331 else if (unformat (input, "db"))
1337 if (INDEX_INVALID != handle)
1339 vlib_cli_output (vm, "%U", format_gbp_endpoint, handle);
1343 vlib_cli_output (vm, "\nDatabases:");
1344 clib_bihash_foreach_key_value_pair_24_8 (&gbp_ep_db.ged_by_ip_rd,
1345 gbp_endpoint_walk_ip_itf, vm);
1346 clib_bihash_foreach_key_value_pair_16_8
1347 (&gbp_ep_db.ged_by_mac_bd, gbp_endpoint_walk_mac_itf, vm);
1351 vlib_cli_output (vm, "Endpoints:");
1352 gbp_endpoint_walk (gbp_endpoint_show_one, vm);
1359 * Show Group Based Policy Endpoints and derived information
1362 * @cliexstart{show gbp endpoint}
1366 VLIB_CLI_COMMAND (gbp_endpoint_show_node, static) = {
1367 .path = "show gbp endpoint",
1368 .short_help = "show gbp endpoint\n",
1369 .function = gbp_endpoint_show,
1374 gbp_endpoint_check (index_t gei, f64 start_time)
1376 gbp_endpoint_group_t *gg;
1377 gbp_endpoint_loc_t *gel;
1380 ge = gbp_endpoint_get (gei);
1381 gel = gbp_endpoint_loc_find (ge, GBP_ENDPOINT_SRC_DP);
1385 gg = gbp_endpoint_group_get (gel->gel_epg);
1387 if ((start_time - ge->ge_last_time) >
1388 gg->gg_retention.remote_ep_timeout)
1390 gbp_endpoint_unlock (GBP_ENDPOINT_SRC_DP, gei);
1396 gbp_endpoint_scan_l2 (vlib_main_t * vm)
1398 clib_bihash_16_8_t *gte_table = &gbp_ep_db.ged_by_mac_bd;
1399 f64 last_start, start_time, delta_t;
1403 last_start = start_time = vlib_time_now (vm);
1405 for (i = 0; i < gte_table->nbuckets; i++)
1407 clib_bihash_bucket_16_8_t *b;
1408 clib_bihash_value_16_8_t *v;
1410 /* allow no more than 20us without a pause */
1411 delta_t = vlib_time_now (vm) - last_start;
1412 if (delta_t > 20e-6)
1414 /* suspend for 100 us */
1415 vlib_process_suspend (vm, 100e-6);
1416 last_start = vlib_time_now (vm);
1419 b = >e_table->buckets[i];
1422 v = clib_bihash_get_value_16_8 (gte_table, b->offset);
1424 for (j = 0; j < (1 << b->log2_pages); j++)
1426 for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
1428 if (clib_bihash_is_free_16_8 (&v->kvp[k]))
1431 gbp_endpoint_check (v->kvp[k].value, start_time);
1434 * Note: we may have just freed the bucket's backing
1435 * storage, so check right here...
1448 gbp_endpoint_scan_l3 (vlib_main_t * vm)
1450 clib_bihash_24_8_t *gte_table = &gbp_ep_db.ged_by_ip_rd;
1451 f64 last_start, start_time, delta_t;
1455 last_start = start_time = vlib_time_now (vm);
1457 for (i = 0; i < gte_table->nbuckets; i++)
1459 clib_bihash_bucket_24_8_t *b;
1460 clib_bihash_value_24_8_t *v;
1462 /* allow no more than 20us without a pause */
1463 delta_t = vlib_time_now (vm) - last_start;
1464 if (delta_t > 20e-6)
1466 /* suspend for 100 us */
1467 vlib_process_suspend (vm, 100e-6);
1468 last_start = vlib_time_now (vm);
1471 b = >e_table->buckets[i];
1474 v = clib_bihash_get_value_24_8 (gte_table, b->offset);
1476 for (j = 0; j < (1 << b->log2_pages); j++)
1478 for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
1480 if (clib_bihash_is_free_24_8 (&v->kvp[k]))
1483 gbp_endpoint_check (v->kvp[k].value, start_time);
1486 * Note: we may have just freed the bucket's backing
1487 * storage, so check right here...
1500 gbp_endpoint_scan (vlib_main_t * vm)
1502 gbp_endpoint_scan_l2 (vm);
1503 gbp_endpoint_scan_l3 (vm);
1507 gbp_endpoint_get_node (fib_node_index_t index)
1511 ge = gbp_endpoint_get (index);
1513 return (&ge->ge_node);
1516 static gbp_endpoint_t *
1517 gbp_endpoint_from_fib_node (fib_node_t * node)
1519 ASSERT (gbp_endpoint_fib_type == node->fn_type);
1520 return ((gbp_endpoint_t *) node);
1524 gbp_endpoint_last_lock_gone (fib_node_t * node)
1526 const gbp_bridge_domain_t *gbd;
1527 const gbp_route_domain_t *grd;
1528 const fib_prefix_t *pfx;
1531 ge = gbp_endpoint_from_fib_node (node);
1533 ASSERT (0 == vec_len (ge->ge_locs));
1535 gbd = gbp_bridge_domain_get (ge->ge_key.gek_gbd);
1538 * we have removed the last source. this EP is toast
1540 if (INDEX_INVALID != ge->ge_key.gek_gbd)
1542 gbp_endpoint_del_mac (&ge->ge_key.gek_mac, gbd->gb_bd_index);
1544 vec_foreach (pfx, ge->ge_key.gek_ips)
1546 grd = gbp_route_domain_get (ge->ge_key.gek_grd);
1547 gbp_endpoint_del_ip (&pfx->fp_addr, grd->grd_fib_index[pfx->fp_proto]);
1549 pool_put (gbp_endpoint_pool, ge);
1552 static fib_node_back_walk_rc_t
1553 gbp_endpoint_back_walk_notify (fib_node_t * node,
1554 fib_node_back_walk_ctx_t * ctx)
1558 return (FIB_NODE_BACK_WALK_CONTINUE);
1562 * The FIB path's graph node virtual function table
1564 static const fib_node_vft_t gbp_endpoint_vft = {
1565 .fnv_get = gbp_endpoint_get_node,
1566 .fnv_last_lock = gbp_endpoint_last_lock_gone,
1567 .fnv_back_walk = gbp_endpoint_back_walk_notify,
1568 // .fnv_mem_show = fib_path_memory_show,
1571 static clib_error_t *
1572 gbp_endpoint_init (vlib_main_t * vm)
1574 #define GBP_EP_HASH_NUM_BUCKETS (2 * 1024)
1575 #define GBP_EP_HASH_MEMORY_SIZE (1 << 20)
1577 clib_bihash_init_24_8 (&gbp_ep_db.ged_by_ip_rd,
1578 "GBP Endpoints - IP/RD",
1579 GBP_EP_HASH_NUM_BUCKETS, GBP_EP_HASH_MEMORY_SIZE);
1581 clib_bihash_init_16_8 (&gbp_ep_db.ged_by_mac_bd,
1582 "GBP Endpoints - MAC/BD",
1583 GBP_EP_HASH_NUM_BUCKETS, GBP_EP_HASH_MEMORY_SIZE);
1585 gbp_ep_logger = vlib_log_register_class ("gbp", "ep");
1586 gbp_endpoint_fib_type = fib_node_register_new_type (&gbp_endpoint_vft);
1591 VLIB_INIT_FUNCTION (gbp_endpoint_init);
1594 * fd.io coding-style-patch-verification: ON
1597 * eval: (c-set-style "gnu")