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 static fib_source_t gbp_fib_source_hi;
45 static fib_source_t gbp_fib_source_low;
46 static fib_node_type_t gbp_endpoint_fib_type;
47 static vlib_log_class_t gbp_ep_logger;
49 #define GBP_ENDPOINT_DBG(...) \
50 vlib_log_debug (gbp_ep_logger, __VA_ARGS__);
52 #define GBP_ENDPOINT_INFO(...) \
53 vlib_log_notice (gbp_ep_logger, __VA_ARGS__);
56 * Pool of GBP endpoints
58 gbp_endpoint_t *gbp_endpoint_pool;
61 * A count of the number of dynamic entries
63 static u32 gbp_n_learnt_endpoints;
65 #define FOR_EACH_GBP_ENDPOINT_ATTR(_item) \
66 for (_item = GBP_ENDPOINT_ATTR_FIRST; \
67 _item < GBP_ENDPOINT_ATTR_LAST; \
71 format_gbp_endpoint_flags (u8 * s, va_list * args)
73 gbp_endpoint_attr_t attr;
74 gbp_endpoint_flags_t flags = va_arg (*args, gbp_endpoint_flags_t);
76 FOR_EACH_GBP_ENDPOINT_ATTR (attr)
78 if ((1 << attr) & flags)
80 s = format (s, "%s,", gbp_endpoint_attr_names[attr]);
88 gbp_endpoint_is_remote (const gbp_endpoint_t * ge)
90 return (! !(ge->ge_fwd.gef_flags & GBP_ENDPOINT_FLAG_REMOTE));
94 gbp_endpoint_is_local (const gbp_endpoint_t * ge)
96 return (!(ge->ge_fwd.gef_flags & GBP_ENDPOINT_FLAG_REMOTE));
100 gbp_endpoint_is_external (const gbp_endpoint_t * ge)
102 return (! !(ge->ge_fwd.gef_flags & GBP_ENDPOINT_FLAG_EXTERNAL));
106 gbp_endpoint_is_learnt (const gbp_endpoint_t * ge)
108 if (0 == vec_len (ge->ge_locs))
111 /* DP is the highest source so if present it will be first */
112 return (ge->ge_locs[0].gel_src == GBP_ENDPOINT_SRC_DP);
116 gbp_endpoint_extract_key_mac_itf (const clib_bihash_kv_16_8_t * key,
117 mac_address_t * mac, u32 * sw_if_index)
119 mac_address_from_u64 (mac, key->key[0]);
120 *sw_if_index = key->key[1];
124 gbp_endpoint_extract_key_ip_itf (const clib_bihash_kv_24_8_t * key,
125 ip46_address_t * ip, u32 * sw_if_index)
127 ip->as_u64[0] = key->key[0];
128 ip->as_u64[1] = key->key[1];
129 *sw_if_index = key->key[2];
133 gbp_endpoint_find_ip (const ip46_address_t * ip, u32 fib_index)
135 clib_bihash_kv_24_8_t key, value;
138 gbp_endpoint_mk_key_ip (ip, fib_index, &key);
140 rv = clib_bihash_search_24_8 (&gbp_ep_db.ged_by_ip_rd, &key, &value);
145 return (gbp_endpoint_get (value.value));
149 gbp_endpoint_add_itf (u32 sw_if_index, index_t gei)
151 vec_validate_init_empty (gbp_ep_db.ged_by_sw_if_index, sw_if_index, ~0);
153 gbp_ep_db.ged_by_sw_if_index[sw_if_index] = gei;
157 gbp_endpoint_add_mac (const mac_address_t * mac, u32 bd_index, index_t gei)
159 clib_bihash_kv_16_8_t key;
162 gbp_endpoint_mk_key_mac (mac->bytes, bd_index, &key);
165 rv = clib_bihash_add_del_16_8 (&gbp_ep_db.ged_by_mac_bd, &key, 1);
172 gbp_endpoint_add_ip (const ip46_address_t * ip, u32 fib_index, index_t gei)
174 clib_bihash_kv_24_8_t key;
177 gbp_endpoint_mk_key_ip (ip, fib_index, &key);
180 rv = clib_bihash_add_del_24_8 (&gbp_ep_db.ged_by_ip_rd, &key, 1);
186 gbp_endpoint_del_mac (const mac_address_t * mac, u32 bd_index)
188 clib_bihash_kv_16_8_t key;
190 gbp_endpoint_mk_key_mac (mac->bytes, bd_index, &key);
192 clib_bihash_add_del_16_8 (&gbp_ep_db.ged_by_mac_bd, &key, 0);
196 gbp_endpoint_del_ip (const ip46_address_t * ip, u32 fib_index)
198 clib_bihash_kv_24_8_t key;
200 gbp_endpoint_mk_key_ip (ip, fib_index, &key);
202 clib_bihash_add_del_24_8 (&gbp_ep_db.ged_by_ip_rd, &key, 0);
206 gbp_endpoint_index (const gbp_endpoint_t * ge)
208 return (ge - gbp_endpoint_pool);
212 ip46_address_get_type (const ip46_address_t * a)
214 return (ip46_address_is_ip4 (a) ? IP46_TYPE_IP4 : IP46_TYPE_IP6);
218 gbp_endpoint_ip_is_equal (const fib_prefix_t * fp, const ip46_address_t * ip)
220 return (ip46_address_is_equal (ip, &fp->fp_addr));
224 gbp_endpoint_ips_update (gbp_endpoint_t * ge,
225 const ip46_address_t * ips,
226 const gbp_route_domain_t * grd)
228 const ip46_address_t *ip;
231 gei = gbp_endpoint_index (ge);
232 grdi = gbp_route_domain_index (grd);
234 ASSERT ((ge->ge_key.gek_grd == INDEX_INVALID) ||
235 (ge->ge_key.gek_grd == grdi));
237 vec_foreach (ip, ips)
239 if (~0 == vec_search_with_function (ge->ge_key.gek_ips, ip,
240 gbp_endpoint_ip_is_equal))
244 vec_add2 (ge->ge_key.gek_ips, pfx, 1);
245 fib_prefix_from_ip46_addr (ip, pfx);
247 gbp_endpoint_add_ip (&pfx->fp_addr,
248 grd->grd_fib_index[pfx->fp_proto], gei);
250 ge->ge_key.gek_grd = grdi;
254 static gbp_endpoint_t *
255 gbp_endpoint_alloc (const ip46_address_t * ips,
256 const gbp_route_domain_t * grd,
257 const mac_address_t * mac,
258 const gbp_bridge_domain_t * gbd)
263 pool_get_zero (gbp_endpoint_pool, ge);
265 fib_node_init (&ge->ge_node, gbp_endpoint_fib_type);
266 gei = gbp_endpoint_index (ge);
268 ge->ge_key.gek_grd = ge->ge_fwd.gef_fib_index = INDEX_INVALID;
269 gbp_itf_hdl_reset (&ge->ge_fwd.gef_itf);
270 ge->ge_last_time = vlib_time_now (vlib_get_main ());
271 ge->ge_key.gek_gbd = gbp_bridge_domain_index (gbd);
275 mac_address_copy (&ge->ge_key.gek_mac, mac);
276 gbp_endpoint_add_mac (mac, gbd->gb_bd_index, gei);
278 gbp_endpoint_ips_update (ge, ips, grd);
284 gbp_endpoint_loc_is_equal (gbp_endpoint_loc_t * a, gbp_endpoint_loc_t * b)
286 return (a->gel_src == b->gel_src);
290 gbp_endpoint_loc_cmp_for_sort (gbp_endpoint_loc_t * a, gbp_endpoint_loc_t * b)
292 return (a->gel_src - b->gel_src);
295 static gbp_endpoint_loc_t *
296 gbp_endpoint_loc_find (gbp_endpoint_t * ge, gbp_endpoint_src_t src)
298 gbp_endpoint_loc_t gel = {
303 pos = vec_search_with_function (ge->ge_locs, &gel,
304 gbp_endpoint_loc_is_equal);
307 return (&ge->ge_locs[pos]);
313 gbp_endpoint_loc_unlock (gbp_endpoint_t * ge, gbp_endpoint_loc_t * gel)
319 if (0 == gel->gel_locks)
321 pos = gel - ge->ge_locs;
323 vec_del1 (ge->ge_locs, pos);
324 if (vec_len (ge->ge_locs) > 1)
325 vec_sort_with_function (ge->ge_locs, gbp_endpoint_loc_cmp_for_sort);
327 /* This could be the last lock, so don't access the EP from
329 fib_node_unlock (&ge->ge_node);
337 gbp_endpoint_loc_destroy (gbp_endpoint_loc_t * gel)
339 gbp_endpoint_group_unlock (gel->gel_epg);
340 gbp_itf_unlock (&gel->gel_itf);
343 static gbp_endpoint_loc_t *
344 gbp_endpoint_loc_find_or_add (gbp_endpoint_t * ge, gbp_endpoint_src_t src)
346 gbp_endpoint_loc_t gel = {
348 .gel_epg = INDEX_INVALID,
349 .gel_itf = GBP_ITF_HDL_INVALID,
354 pos = vec_search_with_function (ge->ge_locs, &gel,
355 gbp_endpoint_loc_is_equal);
359 vec_add1 (ge->ge_locs, gel);
361 if (vec_len (ge->ge_locs) > 1)
363 vec_sort_with_function (ge->ge_locs, gbp_endpoint_loc_cmp_for_sort);
365 pos = vec_search_with_function (ge->ge_locs, &gel,
366 gbp_endpoint_loc_is_equal);
372 * it's the sources and children that lock the endpoints
374 fib_node_lock (&ge->ge_node);
377 return (&ge->ge_locs[pos]);
381 * Find an EP inthe DBs and check that if we find it in the L2 DB
382 * it has the same IPs as this update
385 gbp_endpoint_find_for_update (const ip46_address_t * ips,
386 const gbp_route_domain_t * grd,
387 const mac_address_t * mac,
388 const gbp_bridge_domain_t * gbd,
389 gbp_endpoint_t ** ge)
391 gbp_endpoint_t *l2_ge, *l3_ge, *tmp;
393 l2_ge = l3_ge = NULL;
395 if (NULL != mac && !mac_address_is_zero (mac))
398 l2_ge = gbp_endpoint_find_mac (mac->bytes, gbd->gb_bd_index);
400 if (NULL != ips && !ip46_address_is_zero (ips))
402 const ip46_address_t *ip;
403 fib_protocol_t fproto;
406 vec_foreach (ip, ips)
408 fproto = fib_proto_from_ip46 (ip46_address_get_type (ip));
410 tmp = gbp_endpoint_find_ip (ip, grd->grd_fib_index[fproto]);
415 else if (NULL == l3_ge)
416 /* first match against an IP address */
418 else if (tmp == l3_ge)
419 /* another match against IP address that is the same endpoint */
424 * a match agains a different endpoint.
425 * this means the KEY of the EP is changing which is not allowed
432 if (NULL == l2_ge && NULL == l3_ge)
435 else if (NULL == l2_ge)
438 else if (NULL == l3_ge)
443 /* found both L3 and L2 - they must be the same else the KEY
455 static gbp_endpoint_src_t
456 gbp_endpoint_get_best_src (const gbp_endpoint_t * ge)
458 if (0 == vec_len (ge->ge_locs))
459 return (GBP_ENDPOINT_SRC_MAX);
461 return (ge->ge_locs[0].gel_src);
465 gbp_endpoint_n_learned (int n)
467 gbp_n_learnt_endpoints += n;
469 if (n > 0 && 1 == gbp_n_learnt_endpoints)
471 vlib_process_signal_event (vlib_get_main (),
472 gbp_scanner_node.index,
473 GBP_ENDPOINT_SCAN_START, 0);
475 if (n < 0 && 0 == gbp_n_learnt_endpoints)
477 vlib_process_signal_event (vlib_get_main (),
478 gbp_scanner_node.index,
479 GBP_ENDPOINT_SCAN_STOP, 0);
484 gbp_endpoint_loc_update (const gbp_endpoint_t * ge,
485 gbp_endpoint_loc_t * gel,
486 const gbp_bridge_domain_t * gb,
489 gbp_endpoint_flags_t flags,
490 const ip46_address_t * tun_src,
491 const ip46_address_t * tun_dst)
493 int was_learnt, is_learnt;
496 was_learnt = ! !(gel->gel_flags & GBP_ENDPOINT_FLAG_REMOTE);
497 gel->gel_flags = flags;
498 is_learnt = ! !(gel->gel_flags & GBP_ENDPOINT_FLAG_REMOTE);
500 gbp_endpoint_n_learned (is_learnt - was_learnt);
505 gbp_endpoint_group_lock (ggi);
506 gbp_endpoint_group_unlock (gel->gel_epg);
509 if (gel->gel_flags & GBP_ENDPOINT_FLAG_REMOTE)
512 ip46_address_copy (&gel->tun.gel_src, tun_src);
514 ip46_address_copy (&gel->tun.gel_dst, tun_dst);
516 if (ip46_address_is_multicast (&gel->tun.gel_src))
519 * we learnt the EP from the multicast tunnel.
520 * Create a unicast TEP from the packet's source
521 * and the fixed address of the BD's parent tunnel
523 const gbp_vxlan_tunnel_t *gt;
525 gt = gbp_vxlan_tunnel_get (gb->gb_vni);
529 ip46_address_copy (&gel->tun.gel_src, >->gt_src);
530 sw_if_index = gt->gt_sw_if_index;
535 * the input interface may be the parent GBP-vxlan interface,
536 * create a child vlxan-gbp tunnel and use that as the endpoint's
539 gbp_itf_hdl_t old = gel->gel_itf;
541 switch (gbp_vxlan_tunnel_get_type (sw_if_index))
543 case GBP_VXLAN_TEMPLATE_TUNNEL:
544 gel->tun.gel_parent_sw_if_index = sw_if_index;
545 gel->gel_itf = gbp_vxlan_tunnel_clone_and_lock (sw_if_index,
549 case VXLAN_GBP_TUNNEL:
550 gel->tun.gel_parent_sw_if_index =
551 vxlan_gbp_tunnel_get_parent (sw_if_index);
552 gel->gel_itf = vxlan_gbp_tunnel_lock_itf (sw_if_index);
556 gbp_itf_unlock (&old);
560 gel->gel_itf = gbp_itf_l2_add_and_lock (sw_if_index,
566 gbb_endpoint_fwd_reset (gbp_endpoint_t * ge)
568 const gbp_route_domain_t *grd;
569 const gbp_bridge_domain_t *gbd;
570 gbp_endpoint_fwd_t *gef;
571 const fib_prefix_t *pfx;
574 gbd = gbp_bridge_domain_get (ge->ge_key.gek_gbd);
577 vec_foreach (pfx, ge->ge_key.gek_ips)
581 grd = gbp_route_domain_get (ge->ge_key.gek_grd);
582 fib_index = grd->grd_fib_index[pfx->fp_proto];
584 bd_add_del_ip_mac (gbd->gb_bd_index, fib_proto_to_ip46 (pfx->fp_proto),
585 &pfx->fp_addr, &ge->ge_key.gek_mac, 0);
588 * remove a host route
590 if (gbp_endpoint_is_remote (ge))
592 fib_table_entry_special_remove (fib_index, pfx, gbp_fib_source_hi);
595 fib_table_entry_delete (fib_index, pfx, gbp_fib_source_low);
597 vec_foreach (ai, gef->gef_adjs)
602 if (gbp_itf_hdl_is_valid (gef->gef_itf))
604 l2fib_del_entry (ge->ge_key.gek_mac.bytes,
606 gbp_itf_get_sw_if_index (gef->gef_itf));
609 gbp_itf_unlock (&gef->gef_itf);
610 vec_free (gef->gef_adjs);
614 gbb_endpoint_fwd_recalc (gbp_endpoint_t * ge)
616 const gbp_bridge_domain_t *gbd;
617 const gbp_endpoint_group_t *gg;
618 const gbp_route_domain_t *grd;
619 gbp_endpoint_loc_t *gel;
620 gbp_endpoint_fwd_t *gef;
621 const fib_prefix_t *pfx;
625 * locations are sort in source priority order
627 gei = gbp_endpoint_index (ge);
628 gel = &ge->ge_locs[0];
630 gbd = gbp_bridge_domain_get (ge->ge_key.gek_gbd);
632 gef->gef_flags = gel->gel_flags;
634 if (INDEX_INVALID != gel->gel_epg)
636 gg = gbp_endpoint_group_get (gel->gel_epg);
637 gef->gef_sclass = gg->gg_sclass;
644 gef->gef_itf = gbp_itf_clone_and_lock (gel->gel_itf);
646 if (!mac_address_is_zero (&ge->ge_key.gek_mac))
648 gbp_itf_l2_set_input_feature (gef->gef_itf, L2INPUT_FEAT_GBP_FWD);
650 if (gbp_endpoint_is_remote (ge) || gbp_endpoint_is_external (ge))
653 * bridged packets to external endpoints should be classifed
654 * based on the EP's/BD's EPG
656 gbp_itf_l2_set_output_feature (gef->gef_itf,
657 L2OUTPUT_FEAT_GBP_POLICY_MAC);
661 gbp_endpoint_add_itf (gbp_itf_get_sw_if_index (gef->gef_itf), gei);
662 gbp_itf_l2_set_output_feature (gef->gef_itf,
663 L2OUTPUT_FEAT_GBP_POLICY_PORT);
665 l2fib_add_entry (ge->ge_key.gek_mac.bytes,
667 gbp_itf_get_sw_if_index (gef->gef_itf),
668 L2FIB_ENTRY_RESULT_FLAG_STATIC);
671 vec_foreach (pfx, ge->ge_key.gek_ips)
673 ethernet_header_t *eth;
680 grd = gbp_route_domain_get (ge->ge_key.gek_grd);
681 fib_index = grd->grd_fib_index[pfx->fp_proto];
682 gef->gef_fib_index = fib_index;
684 bd_add_del_ip_mac (gbd->gb_bd_index, fib_proto_to_ip46 (pfx->fp_proto),
685 &pfx->fp_addr, &ge->ge_key.gek_mac, 1);
688 * add a host route via the EPG's BVI we need this because the
689 * adj fib does not install, due to cover refinement check, since
690 * the BVI's prefix is /32
692 vec_validate (rewrite, sizeof (*eth) - 1);
693 eth = (ethernet_header_t *) rewrite;
695 eth->type = clib_host_to_net_u16 ((pfx->fp_proto == FIB_PROTOCOL_IP4 ?
699 if (gbp_endpoint_is_remote (ge))
702 * for dynamic EPs we must add the IP adjacency via the learned
703 * tunnel since the BD will not contain the EP's MAC since it was
704 * L3 learned. The dst MAC address used is the 'BD's MAC'.
706 ip_sw_if_index = gbp_itf_get_sw_if_index (gef->gef_itf);
708 mac_address_to_bytes (gbp_route_domain_get_local_mac (),
710 mac_address_to_bytes (gbp_route_domain_get_remote_mac (),
716 * for the static EPs we add the IP adjacency via the BVI
717 * knowing that the BD has the MAC address to route to and
718 * that policy will be applied on egress to the EP's port
720 ip_sw_if_index = gbd->gb_bvi_sw_if_index;
722 clib_memcpy (eth->src_address,
723 vnet_sw_interface_get_hw_address (vnet_get_main (),
725 sizeof (eth->src_address));
726 mac_address_to_bytes (&ge->ge_key.gek_mac, eth->dst_address);
729 fib_table_entry_path_add (fib_index, pfx,
732 fib_proto_to_dpo (pfx->fp_proto),
733 &pfx->fp_addr, ip_sw_if_index,
734 ~0, 1, NULL, FIB_ROUTE_PATH_FLAG_NONE);
736 ai = adj_nbr_add_or_lock_w_rewrite (pfx->fp_proto,
737 fib_proto_to_link (pfx->fp_proto),
739 ip_sw_if_index, rewrite);
740 vec_add1 (gef->gef_adjs, ai);
743 * if the endpoint is external then routed packet to it must be
744 * classifed to the BD's EPG. but this will happen anyway with
745 * the GBP_MAC classification.
750 if (gbp_endpoint_is_remote (ge))
752 dpo_id_t policy_dpo = DPO_INVALID;
755 * interpose a policy DPO from the endpoint so that policy
758 gbp_policy_dpo_add_or_lock (fib_proto_to_dpo (pfx->fp_proto),
760 gg->gg_sclass, ~0, &policy_dpo);
762 fib_table_entry_special_dpo_add (fib_index, pfx,
764 FIB_ENTRY_FLAG_INTERPOSE,
766 dpo_reset (&policy_dpo);
770 * send a gratuitous ARP on the EPG's uplink. this is done so
771 * that if this EP has moved from some other place in the
772 * 'fabric', upstream devices are informed
774 if (gbp_endpoint_is_local (ge) && ~0 != gg->gg_uplink_sw_if_index)
776 gbp_endpoint_add_itf (gbp_itf_get_sw_if_index (gef->gef_itf),
778 if (FIB_PROTOCOL_IP4 == pfx->fp_proto)
779 send_ip4_garp_w_addr (vlib_get_main (),
781 gg->gg_uplink_sw_if_index);
783 send_ip6_na_w_addr (vlib_get_main (),
785 gg->gg_uplink_sw_if_index);
790 if (gbp_endpoint_is_external (ge))
792 gbp_itf_l2_set_input_feature (gef->gef_itf,
793 L2INPUT_FEAT_GBP_LPM_CLASSIFY);
795 else if (gbp_endpoint_is_local (ge))
798 * non-remote endpoints (i.e. those not arriving on iVXLAN
799 * tunnels) need to be classifed based on the the input interface.
800 * We enable the GBP-FWD feature only if the group has an uplink
801 * interface (on which the GBP-FWD feature would send UU traffic).
802 * External endpoints get classified based on an LPM match
804 l2input_feat_masks_t feats = L2INPUT_FEAT_GBP_SRC_CLASSIFY;
806 if (NULL != gg && ~0 != gg->gg_uplink_sw_if_index)
807 feats |= L2INPUT_FEAT_GBP_FWD;
808 gbp_itf_l2_set_input_feature (gef->gef_itf, feats);
812 * update children with the new forwarding info
814 fib_node_back_walk_ctx_t bw_ctx = {
815 .fnbw_reason = FIB_NODE_BW_REASON_FLAG_EVALUATE,
816 .fnbw_flags = FIB_NODE_BW_FLAG_FORCE_SYNC,
819 fib_walk_sync (gbp_endpoint_fib_type, gei, &bw_ctx);
823 gbp_endpoint_update_and_lock (gbp_endpoint_src_t src,
825 const ip46_address_t * ips,
826 const mac_address_t * mac,
827 index_t gbdi, index_t grdi,
829 gbp_endpoint_flags_t flags,
830 const ip46_address_t * tun_src,
831 const ip46_address_t * tun_dst, u32 * handle)
833 gbp_bridge_domain_t *gbd;
834 gbp_endpoint_group_t *gg;
835 gbp_endpoint_src_t best;
836 gbp_route_domain_t *grd;
837 gbp_endpoint_loc_t *gel;
842 if (~0 == sw_if_index)
843 return (VNET_API_ERROR_INVALID_SW_IF_INDEX);
849 * we need to determine the bridge-domain, either from the EPG or
852 if (SCLASS_INVALID != sclass)
854 ggi = gbp_endpoint_group_find (sclass);
856 if (INDEX_INVALID == ggi)
857 return (VNET_API_ERROR_NO_SUCH_ENTRY);
859 gg = gbp_endpoint_group_get (ggi);
865 if (INDEX_INVALID == gbdi)
866 return (VNET_API_ERROR_NO_SUCH_ENTRY);
867 if (INDEX_INVALID == grdi)
868 return (VNET_API_ERROR_NO_SUCH_FIB);
872 gbd = gbp_bridge_domain_get (gbdi);
873 grd = gbp_route_domain_get (grdi);
874 rv = gbp_endpoint_find_for_update (ips, grd, mac, gbd, &ge);
881 ge = gbp_endpoint_alloc (ips, grd, mac, gbd);
885 gbp_endpoint_ips_update (ge, ips, grd);
888 best = gbp_endpoint_get_best_src (ge);
889 gei = gbp_endpoint_index (ge);
890 gel = gbp_endpoint_loc_find_or_add (ge, src);
892 gbp_endpoint_loc_update (ge, gel, gbd, sw_if_index, ggi, flags,
898 * either the best source has been updated or we have a new best source
900 gbb_endpoint_fwd_reset (ge);
901 gbb_endpoint_fwd_recalc (ge);
906 * an update to a lower priority source, so we need do nothing
913 GBP_ENDPOINT_INFO ("update: %U", format_gbp_endpoint, gei);
919 gbp_endpoint_unlock (gbp_endpoint_src_t src, index_t gei)
921 gbp_endpoint_loc_t *gel, gel_copy;
922 gbp_endpoint_src_t best;
926 if (pool_is_free_index (gbp_endpoint_pool, gei))
929 GBP_ENDPOINT_INFO ("delete: %U", format_gbp_endpoint, gei);
931 ge = gbp_endpoint_get (gei);
933 gel = gbp_endpoint_loc_find (ge, src);
939 * lock the EP so we can control when it is deleted
941 fib_node_lock (&ge->ge_node);
942 best = gbp_endpoint_get_best_src (ge);
945 * copy the location info since we'll lose it when it's removed from
948 clib_memcpy (&gel_copy, gel, sizeof (gel_copy));
951 * remove the source we no longer need
953 removed = gbp_endpoint_loc_unlock (ge, gel);
958 * we have removed the old best source => recalculate fwding
960 if (0 == vec_len (ge->ge_locs))
963 * if there are no more sources left, then we need only release
964 * the fwding resources held and then this EP is gawn.
966 gbb_endpoint_fwd_reset (ge);
971 * else there are more sources. release the old and get new
974 gbb_endpoint_fwd_reset (ge);
975 gbb_endpoint_fwd_recalc (ge);
980 * we removed a lower priority source so we need to do nothing
984 * clear up any resources held by the source
987 gbp_endpoint_loc_destroy (&gel_copy);
990 * remove the lock taken above
992 fib_node_unlock (&ge->ge_node);
994 * We may have removed the last source and so this EP is now TOAST
995 * DO NOTHING BELOW HERE
1000 gbp_endpoint_child_add (index_t gei,
1001 fib_node_type_t type, fib_node_index_t index)
1003 return (fib_node_child_add (gbp_endpoint_fib_type, gei, type, index));
1007 gbp_endpoint_child_remove (index_t gei, u32 sibling)
1009 return (fib_node_child_remove (gbp_endpoint_fib_type, gei, sibling));
1012 typedef struct gbp_endpoint_flush_ctx_t_
1015 gbp_endpoint_src_t src;
1017 } gbp_endpoint_flush_ctx_t;
1020 gbp_endpoint_flush_cb (index_t gei, void *args)
1022 gbp_endpoint_flush_ctx_t *ctx = args;
1023 gbp_endpoint_loc_t *gel;
1026 ge = gbp_endpoint_get (gei);
1027 gel = gbp_endpoint_loc_find (ge, ctx->src);
1029 if ((NULL != gel) && ctx->sw_if_index == gel->tun.gel_parent_sw_if_index)
1031 vec_add1 (ctx->geis, gei);
1034 return (WALK_CONTINUE);
1038 * remove all learnt endpoints using the interface
1041 gbp_endpoint_flush (gbp_endpoint_src_t src, u32 sw_if_index)
1043 gbp_endpoint_flush_ctx_t ctx = {
1044 .sw_if_index = sw_if_index,
1049 GBP_ENDPOINT_INFO ("flush: %U %U",
1050 format_gbp_endpoint_src, src,
1051 format_vnet_sw_if_index_name, vnet_get_main (),
1053 gbp_endpoint_walk (gbp_endpoint_flush_cb, &ctx);
1055 vec_foreach (gei, ctx.geis)
1057 gbp_endpoint_unlock (src, *gei);
1060 vec_free (ctx.geis);
1064 gbp_endpoint_walk (gbp_endpoint_cb_t cb, void *ctx)
1069 pool_foreach_index(index, gbp_endpoint_pool,
1071 if (!cb(index, ctx))
1077 static clib_error_t *
1078 gbp_endpoint_cli (vlib_main_t * vm,
1079 unformat_input_t * input, vlib_cli_command_t * cmd)
1081 ip46_address_t ip = ip46_address_initializer, *ips = NULL;
1082 mac_address_t mac = ZERO_MAC_ADDRESS;
1083 vnet_main_t *vnm = vnet_get_main ();
1084 u32 sclass = SCLASS_INVALID;
1085 u32 handle = INDEX_INVALID;
1086 u32 sw_if_index = ~0;
1087 u32 flags = GBP_ENDPOINT_FLAG_NONE;
1091 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1093 ip46_address_reset (&ip);
1095 if (unformat (input, "%U", unformat_vnet_sw_interface,
1098 else if (unformat (input, "add"))
1100 else if (unformat (input, "del"))
1102 else if (unformat (input, "sclass %d", &sclass))
1104 else if (unformat (input, "handle %d", &handle))
1106 else if (unformat (input, "ip %U", unformat_ip4_address, &ip.ip4))
1108 else if (unformat (input, "ip %U", unformat_ip6_address, &ip.ip6))
1110 else if (unformat (input, "mac %U", unformat_mac_address, &mac))
1112 else if (unformat (input, "flags 0x%x", &flags))
1120 if (~0 == sw_if_index)
1121 return clib_error_return (0, "interface must be specified");
1122 if (SCLASS_INVALID == sclass)
1123 return clib_error_return (0, "SCLASS must be specified");
1126 gbp_endpoint_update_and_lock (GBP_ENDPOINT_SRC_CP,
1127 sw_if_index, ips, &mac,
1128 INDEX_INVALID, INDEX_INVALID,
1129 sclass, flags, NULL, NULL, &handle);
1132 return clib_error_return (0, "GBP Endpoint update returned %d", rv);
1134 vlib_cli_output (vm, "handle %d\n", handle);
1138 if (INDEX_INVALID == handle)
1139 return clib_error_return (0, "handle must be specified");
1141 gbp_endpoint_unlock (GBP_ENDPOINT_SRC_CP, handle);
1150 * Configure a GBP Endpoint
1153 * @cliexstart{gbp endpoint del <handle> | [add] <interface> sclass <SCLASS> ip <IP> mac <MAC> [flags <flags>]}
1157 VLIB_CLI_COMMAND (gbp_endpoint_cli_node, static) = {
1158 .path = "gbp endpoint",
1159 .short_help = "gbp endpoint del <handle> | [add] <interface> sclass <SCLASS> ip <IP> mac <MAC> [flags <flags>]",
1160 .function = gbp_endpoint_cli,
1165 format_gbp_endpoint_src (u8 * s, va_list * args)
1167 gbp_endpoint_src_t action = va_arg (*args, gbp_endpoint_src_t);
1171 #define _(v,a) case GBP_ENDPOINT_SRC_##v: return (format (s, "%s", a));
1172 foreach_gbp_endpoint_src
1176 return (format (s, "unknown"));
1180 format_gbp_endpoint_fwd (u8 * s, va_list * args)
1182 gbp_endpoint_fwd_t *gef = va_arg (*args, gbp_endpoint_fwd_t *);
1184 s = format (s, "fwd:");
1185 s = format (s, "\n itf:[%U]", format_gbp_itf_hdl, gef->gef_itf);
1186 if (GBP_ENDPOINT_FLAG_NONE != gef->gef_flags)
1188 s = format (s, " flags:%U", format_gbp_endpoint_flags, gef->gef_flags);
1195 format_gbp_endpoint_key (u8 * s, va_list * args)
1197 gbp_endpoint_key_t *gek = va_arg (*args, gbp_endpoint_key_t *);
1198 const fib_prefix_t *pfx;
1200 s = format (s, "ips:[");
1202 vec_foreach (pfx, gek->gek_ips)
1204 s = format (s, "%U, ", format_fib_prefix, pfx);
1206 s = format (s, "]");
1208 s = format (s, " mac:%U", format_mac_address_t, &gek->gek_mac);
1214 format_gbp_endpoint_loc (u8 * s, va_list * args)
1216 gbp_endpoint_loc_t *gel = va_arg (*args, gbp_endpoint_loc_t *);
1218 s = format (s, "%U", format_gbp_endpoint_src, gel->gel_src);
1219 s = format (s, "\n EPG:%d [%U]", gel->gel_epg,
1220 format_gbp_itf_hdl, gel->gel_itf);
1222 if (GBP_ENDPOINT_FLAG_NONE != gel->gel_flags)
1224 s = format (s, " flags:%U", format_gbp_endpoint_flags, gel->gel_flags);
1226 if (GBP_ENDPOINT_FLAG_REMOTE & gel->gel_flags)
1228 s = format (s, " tun:[");
1229 s = format (s, "parent:%U", format_vnet_sw_if_index_name,
1230 vnet_get_main (), gel->tun.gel_parent_sw_if_index);
1231 s = format (s, " {%U,%U}]",
1232 format_ip46_address, &gel->tun.gel_src, IP46_TYPE_ANY,
1233 format_ip46_address, &gel->tun.gel_dst, IP46_TYPE_ANY);
1240 format_gbp_endpoint (u8 * s, va_list * args)
1242 index_t gei = va_arg (*args, index_t);
1243 gbp_endpoint_loc_t *gel;
1246 ge = gbp_endpoint_get (gei);
1248 s = format (s, "[@%d] %U", gei, format_gbp_endpoint_key, &ge->ge_key);
1249 s = format (s, " last-time:[%f]", ge->ge_last_time);
1251 vec_foreach (gel, ge->ge_locs)
1253 s = format (s, "\n %U", format_gbp_endpoint_loc, gel);
1255 s = format (s, "\n %U", format_gbp_endpoint_fwd, &ge->ge_fwd);
1261 gbp_endpoint_show_one (index_t gei, void *ctx)
1266 vlib_cli_output (vm, " %U", format_gbp_endpoint, gei);
1268 return (WALK_CONTINUE);
1272 gbp_endpoint_walk_ip_itf (const clib_bihash_kv_24_8_t * kvp, void *arg)
1280 gbp_endpoint_extract_key_ip_itf (kvp, &ip, &sw_if_index);
1282 vlib_cli_output (vm, " {%U, %U} -> %d",
1283 format_ip46_address, &ip, IP46_TYPE_ANY,
1284 format_vnet_sw_if_index_name, vnet_get_main (),
1285 sw_if_index, kvp->value);
1289 gbp_endpoint_walk_mac_itf (const clib_bihash_kv_16_8_t * kvp, void *arg)
1297 gbp_endpoint_extract_key_mac_itf (kvp, &mac, &sw_if_index);
1299 vlib_cli_output (vm, " {%U, %U} -> %d",
1300 format_mac_address_t, &mac,
1301 format_vnet_sw_if_index_name, vnet_get_main (),
1302 sw_if_index, kvp->value);
1305 static clib_error_t *
1306 gbp_endpoint_show (vlib_main_t * vm,
1307 unformat_input_t * input, vlib_cli_command_t * cmd)
1309 u32 show_dbs, handle;
1311 handle = INDEX_INVALID;
1314 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1316 if (unformat (input, "%d", &handle))
1318 else if (unformat (input, "db"))
1324 if (INDEX_INVALID != handle)
1326 vlib_cli_output (vm, "%U", format_gbp_endpoint, handle);
1330 vlib_cli_output (vm, "\nDatabases:");
1331 clib_bihash_foreach_key_value_pair_24_8 (&gbp_ep_db.ged_by_ip_rd,
1332 gbp_endpoint_walk_ip_itf, vm);
1333 clib_bihash_foreach_key_value_pair_16_8
1334 (&gbp_ep_db.ged_by_mac_bd, gbp_endpoint_walk_mac_itf, vm);
1338 vlib_cli_output (vm, "Endpoints:");
1339 gbp_endpoint_walk (gbp_endpoint_show_one, vm);
1346 * Show Group Based Policy Endpoints and derived information
1349 * @cliexstart{show gbp endpoint}
1353 VLIB_CLI_COMMAND (gbp_endpoint_show_node, static) = {
1354 .path = "show gbp endpoint",
1355 .short_help = "show gbp endpoint\n",
1356 .function = gbp_endpoint_show,
1361 gbp_endpoint_check (index_t gei, f64 start_time)
1363 gbp_endpoint_group_t *gg;
1364 gbp_endpoint_loc_t *gel;
1367 ge = gbp_endpoint_get (gei);
1368 gel = gbp_endpoint_loc_find (ge, GBP_ENDPOINT_SRC_DP);
1372 gg = gbp_endpoint_group_get (gel->gel_epg);
1374 if ((start_time - ge->ge_last_time) >
1375 gg->gg_retention.remote_ep_timeout)
1377 gbp_endpoint_unlock (GBP_ENDPOINT_SRC_DP, gei);
1383 gbp_endpoint_scan_l2 (vlib_main_t * vm)
1385 clib_bihash_16_8_t *gte_table = &gbp_ep_db.ged_by_mac_bd;
1386 f64 last_start, start_time, delta_t;
1389 if (!gte_table->instantiated)
1393 last_start = start_time = vlib_time_now (vm);
1395 for (i = 0; i < gte_table->nbuckets; i++)
1397 clib_bihash_bucket_16_8_t *b;
1398 clib_bihash_value_16_8_t *v;
1400 /* allow no more than 20us without a pause */
1401 delta_t = vlib_time_now (vm) - last_start;
1402 if (delta_t > 20e-6)
1404 /* suspend for 100 us */
1405 vlib_process_suspend (vm, 100e-6);
1406 last_start = vlib_time_now (vm);
1409 b = >e_table->buckets[i];
1412 v = clib_bihash_get_value_16_8 (gte_table, b->offset);
1414 for (j = 0; j < (1 << b->log2_pages); j++)
1416 for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
1418 if (clib_bihash_is_free_16_8 (&v->kvp[k]))
1421 gbp_endpoint_check (v->kvp[k].value, start_time);
1424 * Note: we may have just freed the bucket's backing
1425 * storage, so check right here...
1438 gbp_endpoint_scan_l3 (vlib_main_t * vm)
1440 clib_bihash_24_8_t *gte_table = &gbp_ep_db.ged_by_ip_rd;
1441 f64 last_start, start_time, delta_t;
1444 if (!gte_table->instantiated)
1448 last_start = start_time = vlib_time_now (vm);
1450 for (i = 0; i < gte_table->nbuckets; i++)
1452 clib_bihash_bucket_24_8_t *b;
1453 clib_bihash_value_24_8_t *v;
1455 /* allow no more than 20us without a pause */
1456 delta_t = vlib_time_now (vm) - last_start;
1457 if (delta_t > 20e-6)
1459 /* suspend for 100 us */
1460 vlib_process_suspend (vm, 100e-6);
1461 last_start = vlib_time_now (vm);
1464 b = >e_table->buckets[i];
1467 v = clib_bihash_get_value_24_8 (gte_table, b->offset);
1469 for (j = 0; j < (1 << b->log2_pages); j++)
1471 for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
1473 if (clib_bihash_is_free_24_8 (&v->kvp[k]))
1476 gbp_endpoint_check (v->kvp[k].value, start_time);
1479 * Note: we may have just freed the bucket's backing
1480 * storage, so check right here...
1493 gbp_endpoint_scan (vlib_main_t * vm)
1495 gbp_endpoint_scan_l2 (vm);
1496 gbp_endpoint_scan_l3 (vm);
1500 gbp_endpoint_get_node (fib_node_index_t index)
1504 ge = gbp_endpoint_get (index);
1506 return (&ge->ge_node);
1509 static gbp_endpoint_t *
1510 gbp_endpoint_from_fib_node (fib_node_t * node)
1512 ASSERT (gbp_endpoint_fib_type == node->fn_type);
1513 return ((gbp_endpoint_t *) node);
1517 gbp_endpoint_last_lock_gone (fib_node_t * node)
1519 const gbp_bridge_domain_t *gbd;
1520 const gbp_route_domain_t *grd;
1521 const fib_prefix_t *pfx;
1524 ge = gbp_endpoint_from_fib_node (node);
1526 ASSERT (0 == vec_len (ge->ge_locs));
1528 gbd = gbp_bridge_domain_get (ge->ge_key.gek_gbd);
1531 * we have removed the last source. this EP is toast
1533 if (INDEX_INVALID != ge->ge_key.gek_gbd)
1535 gbp_endpoint_del_mac (&ge->ge_key.gek_mac, gbd->gb_bd_index);
1537 vec_foreach (pfx, ge->ge_key.gek_ips)
1539 grd = gbp_route_domain_get (ge->ge_key.gek_grd);
1540 gbp_endpoint_del_ip (&pfx->fp_addr, grd->grd_fib_index[pfx->fp_proto]);
1542 pool_put (gbp_endpoint_pool, ge);
1545 static fib_node_back_walk_rc_t
1546 gbp_endpoint_back_walk_notify (fib_node_t * node,
1547 fib_node_back_walk_ctx_t * ctx)
1551 return (FIB_NODE_BACK_WALK_CONTINUE);
1555 * The FIB path's graph node virtual function table
1557 static const fib_node_vft_t gbp_endpoint_vft = {
1558 .fnv_get = gbp_endpoint_get_node,
1559 .fnv_last_lock = gbp_endpoint_last_lock_gone,
1560 .fnv_back_walk = gbp_endpoint_back_walk_notify,
1561 // .fnv_mem_show = fib_path_memory_show,
1564 static clib_error_t *
1565 gbp_endpoint_init (vlib_main_t * vm)
1567 #define GBP_EP_HASH_NUM_BUCKETS (2 * 1024)
1568 #define GBP_EP_HASH_MEMORY_SIZE (1 << 20)
1570 clib_bihash_init_24_8 (&gbp_ep_db.ged_by_ip_rd,
1571 "GBP Endpoints - IP/RD",
1572 GBP_EP_HASH_NUM_BUCKETS, GBP_EP_HASH_MEMORY_SIZE);
1574 clib_bihash_init_16_8 (&gbp_ep_db.ged_by_mac_bd,
1575 "GBP Endpoints - MAC/BD",
1576 GBP_EP_HASH_NUM_BUCKETS, GBP_EP_HASH_MEMORY_SIZE);
1578 gbp_ep_logger = vlib_log_register_class ("gbp", "ep");
1579 gbp_endpoint_fib_type = fib_node_register_new_type (&gbp_endpoint_vft);
1580 gbp_fib_source_hi = fib_source_allocate ("gbp-endpoint-hi",
1581 FIB_SOURCE_PRIORITY_HI,
1582 FIB_SOURCE_BH_SIMPLE);
1583 gbp_fib_source_low = fib_source_allocate ("gbp-endpoint-low",
1584 FIB_SOURCE_PRIORITY_LOW,
1585 FIB_SOURCE_BH_SIMPLE);
1590 VLIB_INIT_FUNCTION (gbp_endpoint_init);
1593 * fd.io coding-style-patch-verification: ON
1596 * eval: (c-set-style "gnu")