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_group.h>
19 #include <plugins/gbp/gbp_endpoint.h>
20 #include <plugins/gbp/gbp_bridge_domain.h>
21 #include <plugins/gbp/gbp_route_domain.h>
23 #include <vnet/dpo/dvr_dpo.h>
24 #include <vnet/fib/fib_table.h>
25 #include <vnet/l2/l2_input.h>
28 * Pool of GBP endpoint_groups
30 gbp_endpoint_group_t *gbp_endpoint_group_pool;
33 * DB of endpoint_groups
35 gbp_endpoint_group_db_t gbp_endpoint_group_db;
40 uword *gbp_epg_sclass_db;
42 vlib_log_class_t gg_logger;
44 #define GBP_EPG_DBG(...) \
45 vlib_log_debug (gg_logger, __VA_ARGS__);
47 gbp_endpoint_group_t *
48 gbp_endpoint_group_get (index_t i)
50 return (pool_elt_at_index (gbp_endpoint_group_pool, i));
54 gbp_endpoint_group_lock (index_t i)
56 gbp_endpoint_group_t *gg;
58 gg = gbp_endpoint_group_get (i);
63 gbp_endpoint_group_find (sclass_t sclass)
67 p = hash_get (gbp_endpoint_group_db.gg_hash_sclass, sclass);
72 return (INDEX_INVALID);
76 gbp_endpoint_group_add_and_lock (vnid_t vnid,
80 u32 uplink_sw_if_index,
81 const gbp_endpoint_retention_t * retention)
83 gbp_endpoint_group_t *gg;
86 ggi = gbp_endpoint_group_find (sclass);
88 if (INDEX_INVALID == ggi)
90 gbp_bridge_domain_t *gb;
91 fib_protocol_t fproto;
94 gbi = gbp_bridge_domain_find_and_lock (bd_id);
97 return (VNET_API_ERROR_BD_NOT_MODIFIABLE);
99 grdi = gbp_route_domain_find_and_lock (rd_id);
103 gbp_bridge_domain_unlock (gbi);
104 return (VNET_API_ERROR_NO_SUCH_FIB);
107 gb = gbp_bridge_domain_get (gbi);
109 pool_get_zero (gbp_endpoint_group_pool, gg);
114 gg->gg_bd_index = gb->gb_bd_index;
116 gg->gg_uplink_sw_if_index = uplink_sw_if_index;
118 gg->gg_sclass = sclass;
119 gg->gg_retention = *retention;
121 if (SCLASS_INVALID != gg->gg_sclass)
122 hash_set (gbp_epg_sclass_db, gg->gg_sclass, gg->gg_vnid);
125 * an egress DVR dpo for internal subnets to use when sending
126 * on the uplink interface
128 if (~0 != gg->gg_uplink_sw_if_index)
130 FOR_EACH_FIB_IP_PROTOCOL (fproto)
132 dvr_dpo_add_or_lock (uplink_sw_if_index,
133 fib_proto_to_dpo (fproto),
134 &gg->gg_dpo[fproto]);
138 * Add the uplink to the BD
139 * packets direct from the uplink have had policy applied
141 set_int_l2_mode (vlib_get_main (), vnet_get_main (),
142 MODE_L2_BRIDGE, gg->gg_uplink_sw_if_index,
143 gg->gg_bd_index, L2_BD_PORT_TYPE_NORMAL, 0, 0);
144 l2input_intf_bitmap_enable (gg->gg_uplink_sw_if_index,
145 L2INPUT_FEAT_GBP_NULL_CLASSIFY, 1);
148 hash_set (gbp_endpoint_group_db.gg_hash_sclass,
149 gg->gg_sclass, gg - gbp_endpoint_group_pool);
153 gg = gbp_endpoint_group_get (ggi);
157 GBP_EPG_DBG ("add: %U", format_gbp_endpoint_group, gg);
163 gbp_endpoint_group_unlock (index_t ggi)
165 gbp_endpoint_group_t *gg;
167 if (INDEX_INVALID == ggi)
170 gg = gbp_endpoint_group_get (ggi);
174 if (0 == gg->gg_locks)
176 fib_protocol_t fproto;
178 gg = pool_elt_at_index (gbp_endpoint_group_pool, ggi);
180 if (~0 != gg->gg_uplink_sw_if_index)
182 set_int_l2_mode (vlib_get_main (), vnet_get_main (),
183 MODE_L3, gg->gg_uplink_sw_if_index,
184 gg->gg_bd_index, L2_BD_PORT_TYPE_NORMAL, 0, 0);
186 l2input_intf_bitmap_enable (gg->gg_uplink_sw_if_index,
187 L2INPUT_FEAT_GBP_NULL_CLASSIFY, 0);
189 FOR_EACH_FIB_IP_PROTOCOL (fproto)
191 dpo_reset (&gg->gg_dpo[fproto]);
193 gbp_bridge_domain_unlock (gg->gg_gbd);
194 gbp_route_domain_unlock (gg->gg_rd);
196 if (SCLASS_INVALID != gg->gg_sclass)
197 hash_unset (gbp_epg_sclass_db, gg->gg_sclass);
198 hash_unset (gbp_endpoint_group_db.gg_hash_sclass, gg->gg_sclass);
200 pool_put (gbp_endpoint_group_pool, gg);
205 gbp_endpoint_group_delete (sclass_t sclass)
209 ggi = gbp_endpoint_group_find (sclass);
211 if (INDEX_INVALID != ggi)
213 GBP_EPG_DBG ("del: %U", format_gbp_endpoint_group,
214 gbp_endpoint_group_get (ggi));
215 gbp_endpoint_group_unlock (ggi);
220 return (VNET_API_ERROR_NO_SUCH_ENTRY);
224 gbp_endpoint_group_get_bd_id (const gbp_endpoint_group_t * gg)
226 const gbp_bridge_domain_t *gb;
228 gb = gbp_bridge_domain_get (gg->gg_gbd);
230 return (gb->gb_bd_id);
234 gbp_endpoint_group_get_fib_index (const gbp_endpoint_group_t * gg,
235 fib_protocol_t fproto)
237 const gbp_route_domain_t *grd;
239 grd = gbp_route_domain_get (gg->gg_rd);
241 return (grd->grd_fib_index[fproto]);
245 gbp_endpoint_group_walk (gbp_endpoint_group_cb_t cb, void *ctx)
247 gbp_endpoint_group_t *gbpe;
250 pool_foreach(gbpe, gbp_endpoint_group_pool,
258 static clib_error_t *
259 gbp_endpoint_group_cli (vlib_main_t * vm,
260 unformat_input_t * input, vlib_cli_command_t * cmd)
262 gbp_endpoint_retention_t retention = { 0 };
263 vnid_t vnid = VNID_INVALID, sclass;
264 vnet_main_t *vnm = vnet_get_main ();
265 u32 uplink_sw_if_index = ~0;
270 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
272 if (unformat (input, "%U", unformat_vnet_sw_interface,
273 vnm, &uplink_sw_if_index))
275 else if (unformat (input, "add"))
277 else if (unformat (input, "del"))
279 else if (unformat (input, "epg %d", &vnid))
281 else if (unformat (input, "sclass %d", &sclass))
283 else if (unformat (input, "bd %d", &bd_id))
285 else if (unformat (input, "rd %d", &rd_id))
291 if (VNID_INVALID == vnid)
292 return clib_error_return (0, "EPG-ID must be specified");
296 if (~0 == uplink_sw_if_index)
297 return clib_error_return (0, "interface must be specified");
299 return clib_error_return (0, "Bridge-domain must be specified");
301 return clib_error_return (0, "route-domain must be specified");
303 gbp_endpoint_group_add_and_lock (vnid, sclass, bd_id, rd_id,
304 uplink_sw_if_index, &retention);
307 gbp_endpoint_group_delete (vnid);
313 * Configure a GBP Endpoint Group
316 * @cliexstart{set gbp endpoint-group [del] epg <ID> bd <ID> <interface>}
320 VLIB_CLI_COMMAND (gbp_endpoint_group_cli_node, static) = {
321 .path = "gbp endpoint-group",
322 .short_help = "gbp endpoint-group [del] epg <ID> bd <ID> rd <ID> <interface>",
323 .function = gbp_endpoint_group_cli,
327 format_gbp_endpoint_retention (u8 * s, va_list * args)
329 gbp_endpoint_retention_t *rt = va_arg (*args, gbp_endpoint_retention_t*);
331 s = format (s, "[remote-EP-timeout:%d]", rt->remote_ep_timeout);
337 format_gbp_endpoint_group (u8 * s, va_list * args)
339 gbp_endpoint_group_t *gg = va_arg (*args, gbp_endpoint_group_t*);
340 vnet_main_t *vnm = vnet_get_main ();
343 s = format (s, "[%d] %d, sclass:%d bd:[%d,%d] rd:[%d] uplink:%U retnetion:%U locks:%d",
344 gg - gbp_endpoint_group_pool,
347 gbp_endpoint_group_get_bd_id(gg), gg->gg_bd_index,
349 format_vnet_sw_if_index_name, vnm, gg->gg_uplink_sw_if_index,
350 format_gbp_endpoint_retention, &gg->gg_retention,
353 s = format (s, "NULL");
359 gbp_endpoint_group_show_one (gbp_endpoint_group_t *gg, void *ctx)
364 vlib_cli_output (vm, " %U",format_gbp_endpoint_group, gg);
369 static clib_error_t *
370 gbp_endpoint_group_show (vlib_main_t * vm,
371 unformat_input_t * input, vlib_cli_command_t * cmd)
373 vlib_cli_output (vm, "Endpoint-Groups:");
374 gbp_endpoint_group_walk (gbp_endpoint_group_show_one, vm);
381 * Show Group Based Policy Endpoint_Groups and derived information
384 * @cliexstart{show gbp endpoint_group}
388 VLIB_CLI_COMMAND (gbp_endpoint_group_show_node, static) = {
389 .path = "show gbp endpoint-group",
390 .short_help = "show gbp endpoint-group\n",
391 .function = gbp_endpoint_group_show,
395 static clib_error_t *
396 gbp_endpoint_group_init (vlib_main_t * vm)
398 gg_logger = vlib_log_register_class ("gbp", "epg");
403 VLIB_INIT_FUNCTION (gbp_endpoint_group_init);
406 * fd.io coding-style-patch-verification: ON
409 * eval: (c-set-style "gnu")