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);
267 ge->ge_key.gek_grd = ge->ge_fwd.gef_fib_index = INDEX_INVALID;
268 gbp_itf_hdl_reset (&ge->ge_fwd.gef_itf);
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);
339 gbp_itf_unlock (&gel->gel_itf);
342 static gbp_endpoint_loc_t *
343 gbp_endpoint_loc_find_or_add (gbp_endpoint_t * ge, gbp_endpoint_src_t src)
345 gbp_endpoint_loc_t gel = {
347 .gel_epg = INDEX_INVALID,
348 .gel_itf = GBP_ITF_HDL_INVALID,
353 pos = vec_search_with_function (ge->ge_locs, &gel,
354 gbp_endpoint_loc_is_equal);
358 vec_add1 (ge->ge_locs, gel);
360 if (vec_len (ge->ge_locs) > 1)
362 vec_sort_with_function (ge->ge_locs, gbp_endpoint_loc_cmp_for_sort);
364 pos = vec_search_with_function (ge->ge_locs, &gel,
365 gbp_endpoint_loc_is_equal);
371 * it's the sources and children that lock the endpoints
373 fib_node_lock (&ge->ge_node);
376 return (&ge->ge_locs[pos]);
380 * Find an EP inthe DBs and check that if we find it in the L2 DB
381 * it has the same IPs as this update
384 gbp_endpoint_find_for_update (const ip46_address_t * ips,
385 const gbp_route_domain_t * grd,
386 const mac_address_t * mac,
387 const gbp_bridge_domain_t * gbd,
388 gbp_endpoint_t ** ge)
390 gbp_endpoint_t *l2_ge, *l3_ge, *tmp;
392 l2_ge = l3_ge = NULL;
394 if (NULL != mac && !mac_address_is_zero (mac))
397 l2_ge = gbp_endpoint_find_mac (mac->bytes, gbd->gb_bd_index);
399 if (NULL != ips && !ip46_address_is_zero (ips))
401 const ip46_address_t *ip;
402 fib_protocol_t fproto;
405 vec_foreach (ip, ips)
407 fproto = fib_proto_from_ip46 (ip46_address_get_type (ip));
409 tmp = gbp_endpoint_find_ip (ip, grd->grd_fib_index[fproto]);
414 else if (NULL == l3_ge)
415 /* first match against an IP address */
417 else if (tmp == l3_ge)
418 /* another match against IP address that is the same endpoint */
423 * a match agains a different endpoint.
424 * this means the KEY of the EP is changing which is not allowed
431 if (NULL == l2_ge && NULL == l3_ge)
434 else if (NULL == l2_ge)
437 else if (NULL == l3_ge)
442 /* found both L3 and L2 - they must be the same else the KEY
454 static gbp_endpoint_src_t
455 gbp_endpoint_get_best_src (const gbp_endpoint_t * ge)
457 if (0 == vec_len (ge->ge_locs))
458 return (GBP_ENDPOINT_SRC_MAX);
460 return (ge->ge_locs[0].gel_src);
464 gbp_endpoint_n_learned (int n)
466 gbp_n_learnt_endpoints += n;
468 if (n > 0 && 1 == gbp_n_learnt_endpoints)
470 vlib_process_signal_event (vlib_get_main (),
471 gbp_scanner_node.index,
472 GBP_ENDPOINT_SCAN_START, 0);
474 if (n < 0 && 0 == gbp_n_learnt_endpoints)
476 vlib_process_signal_event (vlib_get_main (),
477 gbp_scanner_node.index,
478 GBP_ENDPOINT_SCAN_STOP, 0);
483 gbp_endpoint_loc_update (const gbp_endpoint_t * ge,
484 gbp_endpoint_loc_t * gel,
485 const gbp_bridge_domain_t * gb,
488 gbp_endpoint_flags_t flags,
489 const ip46_address_t * tun_src,
490 const ip46_address_t * tun_dst)
492 int was_learnt, is_learnt;
495 was_learnt = ! !(gel->gel_flags & GBP_ENDPOINT_FLAG_REMOTE);
496 gel->gel_flags = flags;
497 is_learnt = ! !(gel->gel_flags & GBP_ENDPOINT_FLAG_REMOTE);
499 gbp_endpoint_n_learned (is_learnt - was_learnt);
504 gbp_endpoint_group_lock (ggi);
505 gbp_endpoint_group_unlock (gel->gel_epg);
508 if (gel->gel_flags & GBP_ENDPOINT_FLAG_REMOTE)
511 ip46_address_copy (&gel->tun.gel_src, tun_src);
513 ip46_address_copy (&gel->tun.gel_dst, tun_dst);
515 if (ip46_address_is_multicast (&gel->tun.gel_src))
518 * we learnt the EP from the multicast tunnel.
519 * Create a unicast TEP from the packet's source
520 * and the fixed address of the BD's parent tunnel
522 const gbp_vxlan_tunnel_t *gt;
524 gt = gbp_vxlan_tunnel_get (gb->gb_vni);
528 ip46_address_copy (&gel->tun.gel_src, >->gt_src);
529 sw_if_index = gt->gt_sw_if_index;
534 * the input interface may be the parent GBP-vxlan interface,
535 * create a child vlxan-gbp tunnel and use that as the endpoint's
538 gbp_itf_hdl_t old = gel->gel_itf;
540 switch (gbp_vxlan_tunnel_get_type (sw_if_index))
542 case GBP_VXLAN_TEMPLATE_TUNNEL:
543 gel->tun.gel_parent_sw_if_index = sw_if_index;
544 gel->gel_itf = gbp_vxlan_tunnel_clone_and_lock (sw_if_index,
548 case VXLAN_GBP_TUNNEL:
549 gel->tun.gel_parent_sw_if_index =
550 vxlan_gbp_tunnel_get_parent (sw_if_index);
551 gel->gel_itf = vxlan_gbp_tunnel_lock_itf (sw_if_index);
555 gbp_itf_unlock (&old);
559 gel->gel_itf = gbp_itf_l2_add_and_lock (sw_if_index,
565 gbb_endpoint_fwd_reset (gbp_endpoint_t * ge)
567 const gbp_route_domain_t *grd;
568 const gbp_bridge_domain_t *gbd;
569 gbp_endpoint_fwd_t *gef;
570 const fib_prefix_t *pfx;
573 gbd = gbp_bridge_domain_get (ge->ge_key.gek_gbd);
576 vec_foreach (pfx, ge->ge_key.gek_ips)
580 grd = gbp_route_domain_get (ge->ge_key.gek_grd);
581 fib_index = grd->grd_fib_index[pfx->fp_proto];
583 bd_add_del_ip_mac (gbd->gb_bd_index, fib_proto_to_ip46 (pfx->fp_proto),
584 &pfx->fp_addr, &ge->ge_key.gek_mac, 0);
587 * remove a host route
589 if (gbp_endpoint_is_remote (ge))
591 fib_table_entry_special_remove (fib_index, pfx, FIB_SOURCE_PLUGIN_HI);
594 fib_table_entry_delete (fib_index, pfx, FIB_SOURCE_PLUGIN_LOW);
596 vec_foreach (ai, gef->gef_adjs)
601 if (gbp_itf_hdl_is_valid (gef->gef_itf))
603 l2fib_del_entry (ge->ge_key.gek_mac.bytes,
605 gbp_itf_get_sw_if_index (gef->gef_itf));
608 gbp_itf_unlock (&gef->gef_itf);
609 vec_free (gef->gef_adjs);
613 gbb_endpoint_fwd_recalc (gbp_endpoint_t * ge)
615 const gbp_bridge_domain_t *gbd;
616 const gbp_endpoint_group_t *gg;
617 const gbp_route_domain_t *grd;
618 gbp_endpoint_loc_t *gel;
619 gbp_endpoint_fwd_t *gef;
620 const fib_prefix_t *pfx;
624 * locations are sort in source priority order
626 gei = gbp_endpoint_index (ge);
627 gel = &ge->ge_locs[0];
629 gbd = gbp_bridge_domain_get (ge->ge_key.gek_gbd);
631 gef->gef_flags = gel->gel_flags;
633 if (INDEX_INVALID != gel->gel_epg)
635 gg = gbp_endpoint_group_get (gel->gel_epg);
636 gef->gef_sclass = gg->gg_sclass;
643 gef->gef_itf = gbp_itf_clone_and_lock (gel->gel_itf);
645 if (!mac_address_is_zero (&ge->ge_key.gek_mac))
647 gbp_itf_l2_set_input_feature (gef->gef_itf, L2INPUT_FEAT_GBP_FWD);
649 if (gbp_endpoint_is_remote (ge) || gbp_endpoint_is_external (ge))
652 * bridged packets to external endpoints should be classifed
653 * based on the EP's/BD's EPG
655 gbp_itf_l2_set_output_feature (gef->gef_itf,
656 L2OUTPUT_FEAT_GBP_POLICY_MAC);
660 gbp_endpoint_add_itf (gbp_itf_get_sw_if_index (gef->gef_itf), gei);
661 gbp_itf_l2_set_output_feature (gef->gef_itf,
662 L2OUTPUT_FEAT_GBP_POLICY_PORT);
664 l2fib_add_entry (ge->ge_key.gek_mac.bytes,
666 gbp_itf_get_sw_if_index (gef->gef_itf),
667 L2FIB_ENTRY_RESULT_FLAG_STATIC);
670 vec_foreach (pfx, ge->ge_key.gek_ips)
672 ethernet_header_t *eth;
679 grd = gbp_route_domain_get (ge->ge_key.gek_grd);
680 fib_index = grd->grd_fib_index[pfx->fp_proto];
681 gef->gef_fib_index = fib_index;
683 bd_add_del_ip_mac (gbd->gb_bd_index, fib_proto_to_ip46 (pfx->fp_proto),
684 &pfx->fp_addr, &ge->ge_key.gek_mac, 1);
687 * add a host route via the EPG's BVI we need this because the
688 * adj fib does not install, due to cover refinement check, since
689 * the BVI's prefix is /32
691 vec_validate (rewrite, sizeof (*eth) - 1);
692 eth = (ethernet_header_t *) rewrite;
694 eth->type = clib_host_to_net_u16 ((pfx->fp_proto == FIB_PROTOCOL_IP4 ?
698 if (gbp_endpoint_is_remote (ge))
701 * for dynamic EPs we must add the IP adjacency via the learned
702 * tunnel since the BD will not contain the EP's MAC since it was
703 * L3 learned. The dst MAC address used is the 'BD's MAC'.
705 ip_sw_if_index = gbp_itf_get_sw_if_index (gef->gef_itf);
707 mac_address_to_bytes (gbp_route_domain_get_local_mac (),
709 mac_address_to_bytes (gbp_route_domain_get_remote_mac (),
715 * for the static EPs we add the IP adjacency via the BVI
716 * knowing that the BD has the MAC address to route to and
717 * that policy will be applied on egress to the EP's port
719 ip_sw_if_index = gbd->gb_bvi_sw_if_index;
721 clib_memcpy (eth->src_address,
722 vnet_sw_interface_get_hw_address (vnet_get_main (),
724 sizeof (eth->src_address));
725 mac_address_to_bytes (&ge->ge_key.gek_mac, eth->dst_address);
728 fib_table_entry_path_add (fib_index, pfx,
729 FIB_SOURCE_PLUGIN_LOW,
731 fib_proto_to_dpo (pfx->fp_proto),
732 &pfx->fp_addr, ip_sw_if_index,
733 ~0, 1, NULL, FIB_ROUTE_PATH_FLAG_NONE);
735 ai = adj_nbr_add_or_lock_w_rewrite (pfx->fp_proto,
736 fib_proto_to_link (pfx->fp_proto),
738 ip_sw_if_index, rewrite);
739 vec_add1 (gef->gef_adjs, ai);
742 * if the endpoint is external then routed packet to it must be
743 * classifed to the BD's EPG. but this will happen anyway with
744 * the GBP_MAC classification.
749 if (gbp_endpoint_is_remote (ge))
751 dpo_id_t policy_dpo = DPO_INVALID;
754 * interpose a policy DPO from the endpoint so that policy
757 gbp_policy_dpo_add_or_lock (fib_proto_to_dpo (pfx->fp_proto),
759 gg->gg_sclass, ~0, &policy_dpo);
761 fib_table_entry_special_dpo_add (fib_index, pfx,
762 FIB_SOURCE_PLUGIN_HI,
763 FIB_ENTRY_FLAG_INTERPOSE,
765 dpo_reset (&policy_dpo);
769 * send a gratuitous ARP on the EPG's uplink. this is done so
770 * that if this EP has moved from some other place in the
771 * 'fabric', upstream devices are informed
773 if (gbp_endpoint_is_local (ge) && ~0 != gg->gg_uplink_sw_if_index)
775 gbp_endpoint_add_itf (gbp_itf_get_sw_if_index (gef->gef_itf),
777 if (FIB_PROTOCOL_IP4 == pfx->fp_proto)
778 send_ip4_garp_w_addr (vlib_get_main (),
780 gg->gg_uplink_sw_if_index);
782 send_ip6_na_w_addr (vlib_get_main (),
784 gg->gg_uplink_sw_if_index);
789 if (gbp_endpoint_is_external (ge))
791 gbp_itf_l2_set_input_feature (gef->gef_itf,
792 L2INPUT_FEAT_GBP_LPM_CLASSIFY);
794 else if (gbp_endpoint_is_local (ge))
797 * non-remote endpoints (i.e. those not arriving on iVXLAN
798 * tunnels) need to be classifed based on the the input interface.
799 * We enable the GBP-FWD feature only if the group has an uplink
800 * interface (on which the GBP-FWD feature would send UU traffic).
801 * External endpoints get classified based on an LPM match
803 l2input_feat_masks_t feats = L2INPUT_FEAT_GBP_SRC_CLASSIFY;
805 if (NULL != gg && ~0 != gg->gg_uplink_sw_if_index)
806 feats |= L2INPUT_FEAT_GBP_FWD;
807 gbp_itf_l2_set_input_feature (gef->gef_itf, feats);
811 * update children with the new forwarding info
813 fib_node_back_walk_ctx_t bw_ctx = {
814 .fnbw_reason = FIB_NODE_BW_REASON_FLAG_EVALUATE,
815 .fnbw_flags = FIB_NODE_BW_FLAG_FORCE_SYNC,
818 fib_walk_sync (gbp_endpoint_fib_type, gei, &bw_ctx);
822 gbp_endpoint_update_and_lock (gbp_endpoint_src_t src,
824 const ip46_address_t * ips,
825 const mac_address_t * mac,
826 index_t gbdi, index_t grdi,
828 gbp_endpoint_flags_t flags,
829 const ip46_address_t * tun_src,
830 const ip46_address_t * tun_dst, u32 * handle)
832 gbp_bridge_domain_t *gbd;
833 gbp_endpoint_group_t *gg;
834 gbp_endpoint_src_t best;
835 gbp_route_domain_t *grd;
836 gbp_endpoint_loc_t *gel;
841 if (~0 == sw_if_index)
842 return (VNET_API_ERROR_INVALID_SW_IF_INDEX);
848 * we need to determine the bridge-domain, either from the EPG or
851 if (SCLASS_INVALID != sclass)
853 ggi = gbp_endpoint_group_find (sclass);
855 if (INDEX_INVALID == ggi)
856 return (VNET_API_ERROR_NO_SUCH_ENTRY);
858 gg = gbp_endpoint_group_get (ggi);
864 if (INDEX_INVALID == gbdi)
865 return (VNET_API_ERROR_NO_SUCH_ENTRY);
866 if (INDEX_INVALID == grdi)
867 return (VNET_API_ERROR_NO_SUCH_FIB);
871 gbd = gbp_bridge_domain_get (gbdi);
872 grd = gbp_route_domain_get (grdi);
873 rv = gbp_endpoint_find_for_update (ips, grd, mac, gbd, &ge);
880 ge = gbp_endpoint_alloc (ips, grd, mac, gbd);
884 gbp_endpoint_ips_update (ge, ips, grd);
887 best = gbp_endpoint_get_best_src (ge);
888 gei = gbp_endpoint_index (ge);
889 gel = gbp_endpoint_loc_find_or_add (ge, src);
891 gbp_endpoint_loc_update (ge, gel, gbd, sw_if_index, ggi, flags,
897 * either the best source has been updated or we have a new best source
899 gbb_endpoint_fwd_reset (ge);
900 gbb_endpoint_fwd_recalc (ge);
905 * an update to a lower priority source, so we need do nothing
912 GBP_ENDPOINT_INFO ("update: %U", format_gbp_endpoint, gei);
918 gbp_endpoint_unlock (gbp_endpoint_src_t src, index_t gei)
920 gbp_endpoint_loc_t *gel, gel_copy;
921 gbp_endpoint_src_t best;
925 if (pool_is_free_index (gbp_endpoint_pool, gei))
928 GBP_ENDPOINT_INFO ("delete: %U", format_gbp_endpoint, gei);
930 ge = gbp_endpoint_get (gei);
932 gel = gbp_endpoint_loc_find (ge, src);
938 * lock the EP so we can control when it is deleted
940 fib_node_lock (&ge->ge_node);
941 best = gbp_endpoint_get_best_src (ge);
944 * copy the location info since we'll lose it when it's removed from
947 clib_memcpy (&gel_copy, gel, sizeof (gel_copy));
950 * remove the source we no longer need
952 removed = gbp_endpoint_loc_unlock (ge, gel);
957 * we have removed the old best source => recalculate fwding
959 if (0 == vec_len (ge->ge_locs))
962 * if there are no more sources left, then we need only release
963 * the fwding resources held and then this EP is gawn.
965 gbb_endpoint_fwd_reset (ge);
970 * else there are more sources. release the old and get new
973 gbb_endpoint_fwd_reset (ge);
974 gbb_endpoint_fwd_recalc (ge);
979 * we removed a lower priority source so we need to do nothing
983 * clear up any resources held by the source
986 gbp_endpoint_loc_destroy (&gel_copy);
989 * remove the lock taken above
991 fib_node_unlock (&ge->ge_node);
993 * We may have removed the last source and so this EP is now TOAST
994 * DO NOTHING BELOW HERE
999 gbp_endpoint_child_add (index_t gei,
1000 fib_node_type_t type, fib_node_index_t index)
1002 return (fib_node_child_add (gbp_endpoint_fib_type, gei, type, index));
1006 gbp_endpoint_child_remove (index_t gei, u32 sibling)
1008 return (fib_node_child_remove (gbp_endpoint_fib_type, gei, sibling));
1011 typedef struct gbp_endpoint_flush_ctx_t_
1014 gbp_endpoint_src_t src;
1016 } gbp_endpoint_flush_ctx_t;
1019 gbp_endpoint_flush_cb (index_t gei, void *args)
1021 gbp_endpoint_flush_ctx_t *ctx = args;
1022 gbp_endpoint_loc_t *gel;
1025 ge = gbp_endpoint_get (gei);
1026 gel = gbp_endpoint_loc_find (ge, ctx->src);
1028 if ((NULL != gel) && ctx->sw_if_index == gel->tun.gel_parent_sw_if_index)
1030 vec_add1 (ctx->geis, gei);
1033 return (WALK_CONTINUE);
1037 * remove all learnt endpoints using the interface
1040 gbp_endpoint_flush (gbp_endpoint_src_t src, u32 sw_if_index)
1042 gbp_endpoint_flush_ctx_t ctx = {
1043 .sw_if_index = sw_if_index,
1048 GBP_ENDPOINT_INFO ("flush: %U %U",
1049 format_gbp_endpoint_src, src,
1050 format_vnet_sw_if_index_name, vnet_get_main (),
1052 gbp_endpoint_walk (gbp_endpoint_flush_cb, &ctx);
1054 vec_foreach (gei, ctx.geis)
1056 gbp_endpoint_unlock (src, *gei);
1059 vec_free (ctx.geis);
1063 gbp_endpoint_walk (gbp_endpoint_cb_t cb, void *ctx)
1068 pool_foreach_index(index, gbp_endpoint_pool,
1070 if (!cb(index, ctx))
1076 static clib_error_t *
1077 gbp_endpoint_cli (vlib_main_t * vm,
1078 unformat_input_t * input, vlib_cli_command_t * cmd)
1080 ip46_address_t ip = ip46_address_initializer, *ips = NULL;
1081 mac_address_t mac = ZERO_MAC_ADDRESS;
1082 vnet_main_t *vnm = vnet_get_main ();
1083 u32 sclass = SCLASS_INVALID;
1084 u32 handle = INDEX_INVALID;
1085 u32 sw_if_index = ~0;
1086 u32 flags = GBP_ENDPOINT_FLAG_NONE;
1090 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1092 ip46_address_reset (&ip);
1094 if (unformat (input, "%U", unformat_vnet_sw_interface,
1097 else if (unformat (input, "add"))
1099 else if (unformat (input, "del"))
1101 else if (unformat (input, "sclass %d", &sclass))
1103 else if (unformat (input, "handle %d", &handle))
1105 else if (unformat (input, "ip %U", unformat_ip4_address, &ip.ip4))
1107 else if (unformat (input, "ip %U", unformat_ip6_address, &ip.ip6))
1109 else if (unformat (input, "mac %U", unformat_mac_address, &mac))
1111 else if (unformat (input, "flags 0x%x", &flags))
1119 if (~0 == sw_if_index)
1120 return clib_error_return (0, "interface must be specified");
1121 if (SCLASS_INVALID == sclass)
1122 return clib_error_return (0, "SCLASS must be specified");
1125 gbp_endpoint_update_and_lock (GBP_ENDPOINT_SRC_CP,
1126 sw_if_index, ips, &mac,
1127 INDEX_INVALID, INDEX_INVALID,
1128 sclass, flags, NULL, NULL, &handle);
1131 return clib_error_return (0, "GBP Endpoint update returned %d", rv);
1133 vlib_cli_output (vm, "handle %d\n", handle);
1137 if (INDEX_INVALID == handle)
1138 return clib_error_return (0, "handle must be specified");
1140 gbp_endpoint_unlock (GBP_ENDPOINT_SRC_CP, handle);
1149 * Configure a GBP Endpoint
1152 * @cliexstart{gbp endpoint del <handle> | [add] <interface> sclass <SCLASS> ip <IP> mac <MAC> [flags <flags>]}
1156 VLIB_CLI_COMMAND (gbp_endpoint_cli_node, static) = {
1157 .path = "gbp endpoint",
1158 .short_help = "gbp endpoint del <handle> | [add] <interface> sclass <SCLASS> ip <IP> mac <MAC> [flags <flags>]",
1159 .function = gbp_endpoint_cli,
1164 format_gbp_endpoint_src (u8 * s, va_list * args)
1166 gbp_endpoint_src_t action = va_arg (*args, gbp_endpoint_src_t);
1170 #define _(v,a) case GBP_ENDPOINT_SRC_##v: return (format (s, "%s", a));
1171 foreach_gbp_endpoint_src
1175 return (format (s, "unknown"));
1179 format_gbp_endpoint_fwd (u8 * s, va_list * args)
1181 gbp_endpoint_fwd_t *gef = va_arg (*args, gbp_endpoint_fwd_t *);
1183 s = format (s, "fwd:");
1184 s = format (s, "\n itf:[%U]", format_gbp_itf_hdl, gef->gef_itf);
1185 if (GBP_ENDPOINT_FLAG_NONE != gef->gef_flags)
1187 s = format (s, " flags:%U", format_gbp_endpoint_flags, gef->gef_flags);
1194 format_gbp_endpoint_key (u8 * s, va_list * args)
1196 gbp_endpoint_key_t *gek = va_arg (*args, gbp_endpoint_key_t *);
1197 const fib_prefix_t *pfx;
1199 s = format (s, "ips:[");
1201 vec_foreach (pfx, gek->gek_ips)
1203 s = format (s, "%U, ", format_fib_prefix, pfx);
1205 s = format (s, "]");
1207 s = format (s, " mac:%U", format_mac_address_t, &gek->gek_mac);
1213 format_gbp_endpoint_loc (u8 * s, va_list * args)
1215 gbp_endpoint_loc_t *gel = va_arg (*args, gbp_endpoint_loc_t *);
1217 s = format (s, "%U", format_gbp_endpoint_src, gel->gel_src);
1218 s = format (s, "\n EPG:%d [%U]", gel->gel_epg,
1219 format_gbp_itf_hdl, gel->gel_itf);
1221 if (GBP_ENDPOINT_FLAG_NONE != gel->gel_flags)
1223 s = format (s, " flags:%U", format_gbp_endpoint_flags, gel->gel_flags);
1225 if (GBP_ENDPOINT_FLAG_REMOTE & gel->gel_flags)
1227 s = format (s, " tun:[");
1228 s = format (s, "parent:%U", format_vnet_sw_if_index_name,
1229 vnet_get_main (), gel->tun.gel_parent_sw_if_index);
1230 s = format (s, " {%U,%U}]",
1231 format_ip46_address, &gel->tun.gel_src, IP46_TYPE_ANY,
1232 format_ip46_address, &gel->tun.gel_dst, IP46_TYPE_ANY);
1239 format_gbp_endpoint (u8 * s, va_list * args)
1241 index_t gei = va_arg (*args, index_t);
1242 gbp_endpoint_loc_t *gel;
1245 ge = gbp_endpoint_get (gei);
1247 s = format (s, "[@%d] %U", gei, format_gbp_endpoint_key, &ge->ge_key);
1248 s = format (s, " last-time:[%f]", ge->ge_last_time);
1250 vec_foreach (gel, ge->ge_locs)
1252 s = format (s, "\n %U", format_gbp_endpoint_loc, gel);
1254 s = format (s, "\n %U", format_gbp_endpoint_fwd, &ge->ge_fwd);
1260 gbp_endpoint_show_one (index_t gei, void *ctx)
1265 vlib_cli_output (vm, " %U", format_gbp_endpoint, gei);
1267 return (WALK_CONTINUE);
1271 gbp_endpoint_walk_ip_itf (const clib_bihash_kv_24_8_t * kvp, void *arg)
1279 gbp_endpoint_extract_key_ip_itf (kvp, &ip, &sw_if_index);
1281 vlib_cli_output (vm, " {%U, %U} -> %d",
1282 format_ip46_address, &ip, IP46_TYPE_ANY,
1283 format_vnet_sw_if_index_name, vnet_get_main (),
1284 sw_if_index, kvp->value);
1288 gbp_endpoint_walk_mac_itf (const clib_bihash_kv_16_8_t * kvp, void *arg)
1296 gbp_endpoint_extract_key_mac_itf (kvp, &mac, &sw_if_index);
1298 vlib_cli_output (vm, " {%U, %U} -> %d",
1299 format_mac_address_t, &mac,
1300 format_vnet_sw_if_index_name, vnet_get_main (),
1301 sw_if_index, kvp->value);
1304 static clib_error_t *
1305 gbp_endpoint_show (vlib_main_t * vm,
1306 unformat_input_t * input, vlib_cli_command_t * cmd)
1308 u32 show_dbs, handle;
1310 handle = INDEX_INVALID;
1313 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1315 if (unformat (input, "%d", &handle))
1317 else if (unformat (input, "db"))
1323 if (INDEX_INVALID != handle)
1325 vlib_cli_output (vm, "%U", format_gbp_endpoint, handle);
1329 vlib_cli_output (vm, "\nDatabases:");
1330 clib_bihash_foreach_key_value_pair_24_8 (&gbp_ep_db.ged_by_ip_rd,
1331 gbp_endpoint_walk_ip_itf, vm);
1332 clib_bihash_foreach_key_value_pair_16_8
1333 (&gbp_ep_db.ged_by_mac_bd, gbp_endpoint_walk_mac_itf, vm);
1337 vlib_cli_output (vm, "Endpoints:");
1338 gbp_endpoint_walk (gbp_endpoint_show_one, vm);
1345 * Show Group Based Policy Endpoints and derived information
1348 * @cliexstart{show gbp endpoint}
1352 VLIB_CLI_COMMAND (gbp_endpoint_show_node, static) = {
1353 .path = "show gbp endpoint",
1354 .short_help = "show gbp endpoint\n",
1355 .function = gbp_endpoint_show,
1360 gbp_endpoint_check (index_t gei, f64 start_time)
1362 gbp_endpoint_group_t *gg;
1363 gbp_endpoint_loc_t *gel;
1366 ge = gbp_endpoint_get (gei);
1367 gel = gbp_endpoint_loc_find (ge, GBP_ENDPOINT_SRC_DP);
1371 gg = gbp_endpoint_group_get (gel->gel_epg);
1373 if ((start_time - ge->ge_last_time) >
1374 gg->gg_retention.remote_ep_timeout)
1376 gbp_endpoint_unlock (GBP_ENDPOINT_SRC_DP, gei);
1382 gbp_endpoint_scan_l2 (vlib_main_t * vm)
1384 clib_bihash_16_8_t *gte_table = &gbp_ep_db.ged_by_mac_bd;
1385 f64 last_start, start_time, delta_t;
1388 if (!gte_table->instantiated)
1392 last_start = start_time = vlib_time_now (vm);
1394 for (i = 0; i < gte_table->nbuckets; i++)
1396 clib_bihash_bucket_16_8_t *b;
1397 clib_bihash_value_16_8_t *v;
1399 /* allow no more than 20us without a pause */
1400 delta_t = vlib_time_now (vm) - last_start;
1401 if (delta_t > 20e-6)
1403 /* suspend for 100 us */
1404 vlib_process_suspend (vm, 100e-6);
1405 last_start = vlib_time_now (vm);
1408 b = >e_table->buckets[i];
1411 v = clib_bihash_get_value_16_8 (gte_table, b->offset);
1413 for (j = 0; j < (1 << b->log2_pages); j++)
1415 for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
1417 if (clib_bihash_is_free_16_8 (&v->kvp[k]))
1420 gbp_endpoint_check (v->kvp[k].value, start_time);
1423 * Note: we may have just freed the bucket's backing
1424 * storage, so check right here...
1437 gbp_endpoint_scan_l3 (vlib_main_t * vm)
1439 clib_bihash_24_8_t *gte_table = &gbp_ep_db.ged_by_ip_rd;
1440 f64 last_start, start_time, delta_t;
1443 if (!gte_table->instantiated)
1447 last_start = start_time = vlib_time_now (vm);
1449 for (i = 0; i < gte_table->nbuckets; i++)
1451 clib_bihash_bucket_24_8_t *b;
1452 clib_bihash_value_24_8_t *v;
1454 /* allow no more than 20us without a pause */
1455 delta_t = vlib_time_now (vm) - last_start;
1456 if (delta_t > 20e-6)
1458 /* suspend for 100 us */
1459 vlib_process_suspend (vm, 100e-6);
1460 last_start = vlib_time_now (vm);
1463 b = >e_table->buckets[i];
1466 v = clib_bihash_get_value_24_8 (gte_table, b->offset);
1468 for (j = 0; j < (1 << b->log2_pages); j++)
1470 for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
1472 if (clib_bihash_is_free_24_8 (&v->kvp[k]))
1475 gbp_endpoint_check (v->kvp[k].value, start_time);
1478 * Note: we may have just freed the bucket's backing
1479 * storage, so check right here...
1492 gbp_endpoint_scan (vlib_main_t * vm)
1494 gbp_endpoint_scan_l2 (vm);
1495 gbp_endpoint_scan_l3 (vm);
1499 gbp_endpoint_get_node (fib_node_index_t index)
1503 ge = gbp_endpoint_get (index);
1505 return (&ge->ge_node);
1508 static gbp_endpoint_t *
1509 gbp_endpoint_from_fib_node (fib_node_t * node)
1511 ASSERT (gbp_endpoint_fib_type == node->fn_type);
1512 return ((gbp_endpoint_t *) node);
1516 gbp_endpoint_last_lock_gone (fib_node_t * node)
1518 const gbp_bridge_domain_t *gbd;
1519 const gbp_route_domain_t *grd;
1520 const fib_prefix_t *pfx;
1523 ge = gbp_endpoint_from_fib_node (node);
1525 ASSERT (0 == vec_len (ge->ge_locs));
1527 gbd = gbp_bridge_domain_get (ge->ge_key.gek_gbd);
1530 * we have removed the last source. this EP is toast
1532 if (INDEX_INVALID != ge->ge_key.gek_gbd)
1534 gbp_endpoint_del_mac (&ge->ge_key.gek_mac, gbd->gb_bd_index);
1536 vec_foreach (pfx, ge->ge_key.gek_ips)
1538 grd = gbp_route_domain_get (ge->ge_key.gek_grd);
1539 gbp_endpoint_del_ip (&pfx->fp_addr, grd->grd_fib_index[pfx->fp_proto]);
1541 pool_put (gbp_endpoint_pool, ge);
1544 static fib_node_back_walk_rc_t
1545 gbp_endpoint_back_walk_notify (fib_node_t * node,
1546 fib_node_back_walk_ctx_t * ctx)
1550 return (FIB_NODE_BACK_WALK_CONTINUE);
1554 * The FIB path's graph node virtual function table
1556 static const fib_node_vft_t gbp_endpoint_vft = {
1557 .fnv_get = gbp_endpoint_get_node,
1558 .fnv_last_lock = gbp_endpoint_last_lock_gone,
1559 .fnv_back_walk = gbp_endpoint_back_walk_notify,
1560 // .fnv_mem_show = fib_path_memory_show,
1563 static clib_error_t *
1564 gbp_endpoint_init (vlib_main_t * vm)
1566 #define GBP_EP_HASH_NUM_BUCKETS (2 * 1024)
1567 #define GBP_EP_HASH_MEMORY_SIZE (1 << 20)
1569 clib_bihash_init_24_8 (&gbp_ep_db.ged_by_ip_rd,
1570 "GBP Endpoints - IP/RD",
1571 GBP_EP_HASH_NUM_BUCKETS, GBP_EP_HASH_MEMORY_SIZE);
1573 clib_bihash_init_16_8 (&gbp_ep_db.ged_by_mac_bd,
1574 "GBP Endpoints - MAC/BD",
1575 GBP_EP_HASH_NUM_BUCKETS, GBP_EP_HASH_MEMORY_SIZE);
1577 gbp_ep_logger = vlib_log_register_class ("gbp", "ep");
1578 gbp_endpoint_fib_type = fib_node_register_new_type (&gbp_endpoint_vft);
1583 VLIB_INIT_FUNCTION (gbp_endpoint_init);
1586 * fd.io coding-style-patch-verification: ON
1589 * eval: (c-set-style "gnu")