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.h>
19 #include <plugins/gbp/gbp_bridge_domain.h>
20 #include <plugins/gbp/gbp_route_domain.h>
21 #include <plugins/gbp/gbp_policy_dpo.h>
23 #include <vnet/dpo/load_balance.h>
24 #include <vnet/dpo/drop_dpo.h>
27 * Single contract DB instance
29 gbp_contract_db_t gbp_contract_db;
31 gbp_contract_t *gbp_contract_pool;
33 vlib_log_class_t gc_logger;
35 fib_node_type_t gbp_next_hop_fib_type;
37 gbp_rule_t *gbp_rule_pool;
38 gbp_next_hop_t *gbp_next_hop_pool;
40 #define GBP_CONTRACT_DBG(...) \
41 vlib_log_notice (gc_logger, __VA_ARGS__);
43 /* Adjacency packet/byte counters indexed by adjacency index. */
44 vlib_combined_counter_main_t gbp_contract_permit_counters = {
45 .name = "gbp-contracts-permit",
46 .stat_segment_name = "/net/gbp/contract/permit",
49 vlib_combined_counter_main_t gbp_contract_drop_counters = {
50 .name = "gbp-contracts-drop",
51 .stat_segment_name = "/net/gbp/contract/drop",
55 gbp_rule_alloc (gbp_rule_action_t action,
56 gbp_hash_mode_t hash_mode, index_t * nhs)
60 pool_get_zero (gbp_rule_pool, gu);
62 gu->gu_hash_mode = hash_mode;
64 gu->gu_action = action;
66 return (gu - gbp_rule_pool);
70 gbp_next_hop_alloc (const ip46_address_t * ip,
71 index_t grd, const mac_address_t * mac, index_t gbd)
73 fib_protocol_t fproto;
76 pool_get_zero (gbp_next_hop_pool, gnh);
78 fib_node_init (&gnh->gnh_node, gbp_next_hop_fib_type);
80 ip46_address_copy (&gnh->gnh_ip, ip);
81 mac_address_copy (&gnh->gnh_mac, mac);
86 FOR_EACH_FIB_IP_PROTOCOL (fproto) gnh->gnh_ai[fproto] = INDEX_INVALID;
88 return (gnh - gbp_next_hop_pool);
91 static inline gbp_next_hop_t *
92 gbp_next_hop_get (index_t gui)
94 return (pool_elt_at_index (gbp_next_hop_pool, gui));
98 gbp_contract_rules_free (index_t * rules)
102 vec_foreach (gui, rules)
104 gbp_policy_node_t pnode;
105 fib_protocol_t fproto;
109 gu = gbp_rule_get (*gui);
111 FOR_EACH_GBP_POLICY_NODE (pnode)
113 FOR_EACH_FIB_IP_PROTOCOL (fproto)
115 dpo_reset (&gu->gu_dpo[pnode][fproto]);
116 dpo_reset (&gu->gu_dpo[pnode][fproto]);
120 vec_foreach (gnhi, gu->gu_nhs)
122 fib_protocol_t fproto;
124 gnh = gbp_next_hop_get (*gnhi);
125 gbp_bridge_domain_unlock (gnh->gnh_bd);
126 gbp_route_domain_unlock (gnh->gnh_rd);
127 gbp_endpoint_child_remove (gnh->gnh_ge, gnh->gnh_sibling);
128 gbp_endpoint_unlock (GBP_ENDPOINT_SRC_RR, gnh->gnh_ge);
130 FOR_EACH_FIB_IP_PROTOCOL (fproto)
132 adj_unlock (gnh->gnh_ai[fproto]);
140 format_gbp_next_hop (u8 * s, va_list * args)
142 index_t gnhi = va_arg (*args, index_t);
145 gnh = gbp_next_hop_get (gnhi);
147 s = format (s, "%U, %U, %U EP:%d",
148 format_mac_address_t, &gnh->gnh_mac,
149 format_gbp_bridge_domain, gnh->gnh_bd,
150 format_ip46_address, &gnh->gnh_ip, IP46_TYPE_ANY, gnh->gnh_ge);
156 format_gbp_rule_action (u8 * s, va_list * args)
158 gbp_rule_action_t action = va_arg (*args, gbp_rule_action_t);
162 #define _(v,a) case GBP_RULE_##v: return (format (s, "%s", a));
163 foreach_gbp_rule_action
167 return (format (s, "unknown"));
171 format_gbp_hash_mode (u8 * s, va_list * args)
173 gbp_hash_mode_t hash_mode = va_arg (*args, gbp_hash_mode_t);
177 #define _(v,a) case GBP_HASH_MODE_##v: return (format (s, "%s", a));
178 foreach_gbp_hash_mode
182 return (format (s, "unknown"));
186 format_gbp_policy_node (u8 * s, va_list * args)
188 gbp_policy_node_t action = va_arg (*args, gbp_policy_node_t);
192 #define _(v,a) case GBP_POLICY_NODE_##v: return (format (s, "%s", a));
193 foreach_gbp_policy_node
197 return (format (s, "unknown"));
201 format_gbp_rule (u8 * s, va_list * args)
203 index_t gui = va_arg (*args, index_t);
204 gbp_policy_node_t pnode;
205 fib_protocol_t fproto;
209 gu = gbp_rule_get (gui);
210 s = format (s, "%U", format_gbp_rule_action, gu->gu_action);
212 switch (gu->gu_action)
214 case GBP_RULE_PERMIT:
217 case GBP_RULE_REDIRECT:
218 s = format (s, ", %U", format_gbp_hash_mode, gu->gu_hash_mode);
222 vec_foreach (gnhi, gu->gu_nhs)
224 s = format (s, "\n [%U]", format_gbp_next_hop, *gnhi);
227 FOR_EACH_GBP_POLICY_NODE (pnode)
229 s = format (s, "\n policy-%U", format_gbp_policy_node, pnode);
231 FOR_EACH_FIB_IP_PROTOCOL (fproto)
233 if (dpo_id_is_valid (&gu->gu_dpo[pnode][fproto]))
236 format (s, "\n %U", format_dpo_id,
237 &gu->gu_dpo[pnode][fproto], 8);
246 gbp_contract_mk_adj (gbp_next_hop_t * gnh, fib_protocol_t fproto)
248 ethernet_header_t *eth;
253 old_ai = gnh->gnh_ai[fproto];
255 vec_validate (rewrite, sizeof (*eth) - 1);
256 eth = (ethernet_header_t *) rewrite;
258 GBP_CONTRACT_DBG ("...mk-adj: %U", format_gbp_next_hop,
259 gnh - gbp_next_hop_pool);
261 ge = gbp_endpoint_get (gnh->gnh_ge);
263 eth->type = clib_host_to_net_u16 ((fproto == FIB_PROTOCOL_IP4 ?
264 ETHERNET_TYPE_IP4 : ETHERNET_TYPE_IP6));
265 mac_address_to_bytes (gbp_route_domain_get_local_mac (), eth->src_address);
266 mac_address_to_bytes (&gnh->gnh_mac, eth->dst_address);
268 gnh->gnh_ai[fproto] =
269 adj_nbr_add_or_lock_w_rewrite (fproto,
270 fib_proto_to_link (fproto),
271 &gnh->gnh_ip, ge->ge_fwd.gef_itf, rewrite);
276 static flow_hash_config_t
277 gbp_contract_mk_lb_hp (gbp_hash_mode_t gu_hash_mode)
279 switch (gu_hash_mode)
281 case GBP_HASH_MODE_SRC_IP:
282 return IP_FLOW_HASH_SRC_ADDR;
283 case GBP_HASH_MODE_DST_IP:
284 return IP_FLOW_HASH_DST_ADDR;
285 case GBP_HASH_MODE_SYMMETRIC:
286 return (IP_FLOW_HASH_SRC_ADDR | IP_FLOW_HASH_DST_ADDR |
287 IP_FLOW_HASH_PROTO | IP_FLOW_HASH_SYMMETRIC);
294 gbp_contract_mk_lb (index_t gui, fib_protocol_t fproto)
296 load_balance_path_t *paths = NULL;
297 gbp_policy_node_t pnode;
303 u32 policy_nodes[] = {
304 [GBP_POLICY_NODE_L2] = gbp_policy_port_node.index,
305 [GBP_POLICY_NODE_IP4] = ip4_gbp_policy_dpo_node.index,
306 [GBP_POLICY_NODE_IP6] = ip6_gbp_policy_dpo_node.index,
309 GBP_CONTRACT_DBG ("..mk-lb: %U", format_gbp_rule, gui);
311 gu = gbp_rule_get (gui);
312 dproto = fib_proto_to_dpo (fproto);
314 if (GBP_RULE_REDIRECT != gu->gu_action)
317 vec_foreach_index (ii, gu->gu_nhs)
319 gnh = gbp_next_hop_get (gu->gu_nhs[ii]);
321 gbp_contract_mk_adj (gnh, FIB_PROTOCOL_IP4);
322 gbp_contract_mk_adj (gnh, FIB_PROTOCOL_IP6);
325 FOR_EACH_GBP_POLICY_NODE (pnode)
327 vec_validate (paths, vec_len (gu->gu_nhs) - 1);
329 vec_foreach_index (ii, gu->gu_nhs)
331 gnh = gbp_next_hop_get (gu->gu_nhs[ii]);
333 paths[ii].path_index = FIB_NODE_INDEX_INVALID;
334 paths[ii].path_weight = 1;
335 dpo_set (&paths[ii].path_dpo, DPO_ADJACENCY,
336 dproto, gnh->gnh_ai[fproto]);
339 if (!dpo_id_is_valid (&gu->gu_dpo[pnode][fproto]))
341 dpo_id_t dpo = DPO_INVALID;
343 dpo_set (&dpo, DPO_LOAD_BALANCE, dproto,
344 load_balance_create (vec_len (paths),
346 gbp_contract_mk_lb_hp
347 (gu->gu_hash_mode)));
348 dpo_stack_from_node (policy_nodes[pnode], &gu->gu_dpo[pnode][fproto],
353 load_balance_multipath_update (&gu->gu_dpo[pnode][fproto],
354 paths, LOAD_BALANCE_FLAG_NONE);
360 gbp_contract_mk_one_lb (index_t gui)
362 gbp_contract_mk_lb (gui, FIB_PROTOCOL_IP4);
363 gbp_contract_mk_lb (gui, FIB_PROTOCOL_IP6);
367 gbp_contract_next_hop_resolve (index_t gui, index_t gnhi)
369 gbp_bridge_domain_t *gbd;
375 gnh = gbp_next_hop_get (gnhi);
376 gbd = gbp_bridge_domain_get (gnh->gnh_bd);
379 vec_add1 (ips, gnh->gnh_ip);
382 * source the endpoint this contract needs to forward via.
383 * give ofrwarding details via the spine proxy. if this EP is known
384 * to us, then since we source here with a low priority, the learned
385 * info will take precedenc.
387 rv = gbp_endpoint_update_and_lock (GBP_ENDPOINT_SRC_RR,
388 gbd->gb_uu_fwd_sw_if_index,
391 gnh->gnh_bd, gnh->gnh_rd, SCLASS_INVALID,
392 GBP_ENDPOINT_FLAG_NONE, NULL, NULL,
397 gnh->gnh_sibling = gbp_endpoint_child_add (gnh->gnh_ge,
398 gbp_next_hop_fib_type, gnhi);
401 GBP_CONTRACT_DBG ("..resolve: %d: %d: %U", gui, gnhi, format_gbp_next_hop,
409 gbp_contract_rule_resolve (index_t gui)
414 gu = gbp_rule_get (gui);
416 GBP_CONTRACT_DBG ("..resolve: %U", format_gbp_rule, gui);
418 vec_foreach (gnhi, gu->gu_nhs)
420 gbp_contract_next_hop_resolve (gui, *gnhi);
425 gbp_contract_resolve (index_t * guis)
429 vec_foreach (gui, guis)
431 gbp_contract_rule_resolve (*gui);
436 gbp_contract_mk_lbs (index_t * guis)
440 vec_foreach (gui, guis)
442 gbp_contract_mk_one_lb (*gui);
447 gbp_contract_update (sclass_t sclass,
451 u16 * allowed_ethertypes, u32 * stats_index)
453 gbp_main_t *gm = &gbp_main;
459 gbp_contract_key_t key = {
464 if (~0 == gm->gbp_acl_user_id)
466 acl_plugin_exports_init (&gm->acl_plugin);
467 gm->gbp_acl_user_id =
468 gm->acl_plugin.register_user_module ("GBP ACL", "src-epg", "dst-epg");
471 p = hash_get (gbp_contract_db.gc_hash, key.as_u32);
475 gc = gbp_contract_get (gci);
476 gbp_contract_rules_free (gc->gc_rules);
477 gbp_main.acl_plugin.put_lookup_context_index (gc->gc_lc_index);
479 vec_free (gc->gc_allowed_ethertypes);
483 pool_get_zero (gbp_contract_pool, gc);
485 gci = gc - gbp_contract_pool;
486 hash_set (gbp_contract_db.gc_hash, key.as_u32, gci);
488 vlib_validate_combined_counter (&gbp_contract_drop_counters, gci);
489 vlib_zero_combined_counter (&gbp_contract_drop_counters, gci);
490 vlib_validate_combined_counter (&gbp_contract_permit_counters, gci);
491 vlib_zero_combined_counter (&gbp_contract_permit_counters, gci);
494 GBP_CONTRACT_DBG ("update: %U", format_gbp_contract, gci);
496 gc->gc_rules = rules;
497 gc->gc_allowed_ethertypes = allowed_ethertypes;
498 gbp_contract_resolve (gc->gc_rules);
499 gbp_contract_mk_lbs (gc->gc_rules);
501 gc->gc_acl_index = acl_index;
503 gm->acl_plugin.get_lookup_context_index (gm->gbp_acl_user_id,
506 vec_add1 (acl_vec, gc->gc_acl_index);
507 gm->acl_plugin.set_acl_vec_for_context (gc->gc_lc_index, acl_vec);
516 gbp_contract_delete (sclass_t sclass, sclass_t dclass)
518 gbp_contract_key_t key = {
525 p = hash_get (gbp_contract_db.gc_hash, key.as_u32);
528 gc = gbp_contract_get (p[0]);
530 gbp_contract_rules_free (gc->gc_rules);
531 gbp_main.acl_plugin.put_lookup_context_index (gc->gc_lc_index);
532 vec_free (gc->gc_allowed_ethertypes);
534 hash_unset (gbp_contract_db.gc_hash, key.as_u32);
535 pool_put (gbp_contract_pool, gc);
540 return (VNET_API_ERROR_NO_SUCH_ENTRY);
544 gbp_contract_walk (gbp_contract_cb_t cb, void *ctx)
549 pool_foreach(gc, gbp_contract_pool,
557 static clib_error_t *
558 gbp_contract_cli (vlib_main_t * vm,
559 unformat_input_t * input, vlib_cli_command_t * cmd)
561 sclass_t sclass = SCLASS_INVALID, dclass = SCLASS_INVALID;
562 u32 acl_index = ~0, stats_index;
565 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
567 if (unformat (input, "add"))
569 else if (unformat (input, "del"))
571 else if (unformat (input, "src-epg %d", &sclass))
573 else if (unformat (input, "dst-epg %d", &dclass))
575 else if (unformat (input, "acl-index %d", &acl_index))
581 if (SCLASS_INVALID == sclass)
582 return clib_error_return (0, "Source EPG-ID must be specified");
583 if (SCLASS_INVALID == dclass)
584 return clib_error_return (0, "Destination EPG-ID must be specified");
588 gbp_contract_update (sclass, dclass, acl_index,
589 NULL, NULL, &stats_index);
593 gbp_contract_delete (sclass, dclass);
600 * Configure a GBP Contract
603 * @cliexstart{set gbp contract [del] src-epg <ID> dst-epg <ID> acl-index <ACL>}
607 VLIB_CLI_COMMAND (gbp_contract_cli_node, static) =
609 .path = "gbp contract",
611 "gbp contract [del] src-epg <ID> dst-epg <ID> acl-index <ACL>",
612 .function = gbp_contract_cli,
617 format_gbp_contract_key (u8 * s, va_list * args)
619 gbp_contract_key_t *gck = va_arg (*args, gbp_contract_key_t *);
621 s = format (s, "{%d,%d}", gck->gck_src, gck->gck_dst);
627 format_gbp_contract (u8 * s, va_list * args)
629 index_t gci = va_arg (*args, index_t);
630 vlib_counter_t counts;
635 gc = gbp_contract_get (gci);
637 s = format (s, "[%d] %U: acl-index:%d",
638 gci, format_gbp_contract_key, &gc->gc_key, gc->gc_acl_index);
640 vec_foreach (gui, gc->gc_rules)
642 s = format (s, "\n %d: %U", *gui, format_gbp_rule, *gui);
645 s = format (s, "\n allowed-ethertypes:[");
646 vec_foreach (et, gc->gc_allowed_ethertypes)
648 int host_et = clib_net_to_host_u16 (*et);
650 s = format (s, "0x%x, ", host_et);
653 vlib_get_combined_counter (&gbp_contract_drop_counters, gci, &counts);
654 s = format (s, "\n drop:[%Ld:%Ld]", counts.packets, counts.bytes);
655 vlib_get_combined_counter (&gbp_contract_permit_counters, gci, &counts);
656 s = format (s, "\n permit:[%Ld:%Ld]", counts.packets, counts.bytes);
663 static clib_error_t *
664 gbp_contract_show (vlib_main_t * vm,
665 unformat_input_t * input, vlib_cli_command_t * cmd)
671 src = dst = SCLASS_INVALID;
673 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
675 if (unformat (input, "src %d", &src))
677 else if (unformat (input, "dst %d", &dst))
683 vlib_cli_output (vm, "Contracts:");
686 pool_foreach (gc, gbp_contract_pool,
688 gci = gc - gbp_contract_pool;
690 if (SCLASS_INVALID != src && SCLASS_INVALID != dst)
692 if (gc->gc_key.gck_src == src &&
693 gc->gc_key.gck_dst == dst)
694 vlib_cli_output (vm, " %U", format_gbp_contract, gci);
696 else if (SCLASS_INVALID != src)
698 if (gc->gc_key.gck_src == src)
699 vlib_cli_output (vm, " %U", format_gbp_contract, gci);
701 else if (SCLASS_INVALID != dst)
703 if (gc->gc_key.gck_dst == dst)
704 vlib_cli_output (vm, " %U", format_gbp_contract, gci);
707 vlib_cli_output (vm, " %U", format_gbp_contract, gci);
715 * Show Group Based Policy Contracts
718 * @cliexstart{show gbp contract}
722 VLIB_CLI_COMMAND (gbp_contract_show_node, static) = {
723 .path = "show gbp contract",
724 .short_help = "show gbp contract [src <SRC>] [dst <DST>]\n",
725 .function = gbp_contract_show,
730 gbp_next_hop_get_node (fib_node_index_t index)
734 gnh = gbp_next_hop_get (index);
736 return (&gnh->gnh_node);
740 gbp_next_hop_last_lock_gone (fib_node_t * node)
745 static gbp_next_hop_t *
746 gbp_next_hop_from_fib_node (fib_node_t * node)
748 ASSERT (gbp_next_hop_fib_type == node->fn_type);
749 return ((gbp_next_hop_t *) node);
752 static fib_node_back_walk_rc_t
753 gbp_next_hop_back_walk_notify (fib_node_t * node,
754 fib_node_back_walk_ctx_t * ctx)
758 gnh = gbp_next_hop_from_fib_node (node);
760 gbp_contract_mk_one_lb (gnh->gnh_gu);
762 return (FIB_NODE_BACK_WALK_CONTINUE);
766 * The FIB path's graph node virtual function table
768 static const fib_node_vft_t gbp_next_hop_vft = {
769 .fnv_get = gbp_next_hop_get_node,
770 .fnv_last_lock = gbp_next_hop_last_lock_gone,
771 .fnv_back_walk = gbp_next_hop_back_walk_notify,
772 // .fnv_mem_show = fib_path_memory_show,
775 static clib_error_t *
776 gbp_contract_init (vlib_main_t * vm)
778 gc_logger = vlib_log_register_class ("gbp", "con");
779 gbp_next_hop_fib_type = fib_node_register_new_type (&gbp_next_hop_vft);
784 VLIB_INIT_FUNCTION (gbp_contract_init);
787 * fd.io coding-style-patch-verification: ON
790 * eval: (c-set-style "gnu")