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;
36 vlib_log_class_t gg_logger;
38 #define GBP_EPG_DBG(...) \
39 vlib_log_debug (gg_logger, __VA_ARGS__);
41 gbp_endpoint_group_t *
42 gbp_endpoint_group_get (index_t i)
44 return (pool_elt_at_index (gbp_endpoint_group_pool, i));
48 gbp_endpoint_group_lock (index_t i)
50 gbp_endpoint_group_t *gg;
52 gg = gbp_endpoint_group_get (i);
57 gbp_endpoint_group_find (epg_id_t epg_id)
61 p = hash_get (gbp_endpoint_group_db.gg_hash, epg_id);
66 return (INDEX_INVALID);
70 gbp_endpoint_group_add_and_lock (epg_id_t epg_id,
71 u32 bd_id, u32 rd_id, u32 uplink_sw_if_index)
73 gbp_endpoint_group_t *gg;
76 ggi = gbp_endpoint_group_find (epg_id);
78 if (INDEX_INVALID == ggi)
80 gbp_bridge_domain_t *gb;
81 fib_protocol_t fproto;
84 gbi = gbp_bridge_domain_find_and_lock (bd_id);
87 return (VNET_API_ERROR_BD_NOT_MODIFIABLE);
89 grdi = gbp_route_domain_find_and_lock (rd_id);
93 gbp_bridge_domain_unlock (gbi);
94 return (VNET_API_ERROR_NO_SUCH_FIB);
97 gb = gbp_bridge_domain_get (gbi);
99 pool_get_zero (gbp_endpoint_group_pool, gg);
104 gg->gg_bd_index = gb->gb_bd_index;
106 gg->gg_uplink_sw_if_index = uplink_sw_if_index;
110 * an egress DVR dpo for internal subnets to use when sending
111 * on the uplink interface
113 if (~0 != gg->gg_uplink_sw_if_index)
115 FOR_EACH_FIB_IP_PROTOCOL (fproto)
117 dvr_dpo_add_or_lock (uplink_sw_if_index,
118 fib_proto_to_dpo (fproto),
119 &gg->gg_dpo[fproto]);
123 * Add the uplink to the BD
124 * packets direct from the uplink have had policy applied
126 set_int_l2_mode (vlib_get_main (), vnet_get_main (),
127 MODE_L2_BRIDGE, gg->gg_uplink_sw_if_index,
128 gg->gg_bd_index, L2_BD_PORT_TYPE_NORMAL, 0, 0);
129 l2input_intf_bitmap_enable (gg->gg_uplink_sw_if_index,
130 L2INPUT_FEAT_GBP_NULL_CLASSIFY, 1);
133 hash_set (gbp_endpoint_group_db.gg_hash,
134 gg->gg_id, gg - gbp_endpoint_group_pool);
139 gg = gbp_endpoint_group_get (ggi);
143 GBP_EPG_DBG ("add: %U", format_gbp_endpoint_group, gg);
149 gbp_endpoint_group_unlock (index_t ggi)
151 gbp_endpoint_group_t *gg;
153 if (INDEX_INVALID == ggi)
156 gg = gbp_endpoint_group_get (ggi);
160 if (0 == gg->gg_locks)
162 fib_protocol_t fproto;
164 gg = pool_elt_at_index (gbp_endpoint_group_pool, ggi);
166 if (~0 != gg->gg_uplink_sw_if_index)
168 set_int_l2_mode (vlib_get_main (), vnet_get_main (),
169 MODE_L3, gg->gg_uplink_sw_if_index,
170 gg->gg_bd_index, L2_BD_PORT_TYPE_NORMAL, 0, 0);
172 l2input_intf_bitmap_enable (gg->gg_uplink_sw_if_index,
173 L2INPUT_FEAT_GBP_NULL_CLASSIFY, 0);
175 FOR_EACH_FIB_IP_PROTOCOL (fproto)
177 dpo_reset (&gg->gg_dpo[fproto]);
179 gbp_bridge_domain_unlock (gg->gg_gbd);
180 gbp_route_domain_unlock (gg->gg_rd);
182 hash_unset (gbp_endpoint_group_db.gg_hash, gg->gg_id);
184 pool_put (gbp_endpoint_group_pool, gg);
189 gbp_endpoint_group_delete (epg_id_t epg_id)
193 ggi = gbp_endpoint_group_find (epg_id);
195 if (INDEX_INVALID != ggi)
197 GBP_EPG_DBG ("del: %U", format_gbp_endpoint_group,
198 gbp_endpoint_group_get (ggi));
199 gbp_endpoint_group_unlock (ggi);
204 return (VNET_API_ERROR_NO_SUCH_ENTRY);
208 gbp_endpoint_group_get_bd_id (const gbp_endpoint_group_t * gg)
210 const gbp_bridge_domain_t *gb;
212 gb = gbp_bridge_domain_get (gg->gg_gbd);
214 return (gb->gb_bd_id);
218 gbp_endpoint_group_get_fib_index (const gbp_endpoint_group_t * gg,
219 fib_protocol_t fproto)
221 const gbp_route_domain_t *grd;
223 grd = gbp_route_domain_get (gg->gg_rd);
225 return (grd->grd_fib_index[fproto]);
229 gbp_endpoint_group_walk (gbp_endpoint_group_cb_t cb, void *ctx)
231 gbp_endpoint_group_t *gbpe;
234 pool_foreach(gbpe, gbp_endpoint_group_pool,
242 static clib_error_t *
243 gbp_endpoint_group_cli (vlib_main_t * vm,
244 unformat_input_t * input, vlib_cli_command_t * cmd)
246 vnet_main_t *vnm = vnet_get_main ();
247 epg_id_t epg_id = EPG_INVALID;
248 u32 uplink_sw_if_index = ~0;
253 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
255 if (unformat (input, "%U", unformat_vnet_sw_interface,
256 vnm, &uplink_sw_if_index))
258 else if (unformat (input, "add"))
260 else if (unformat (input, "del"))
262 else if (unformat (input, "epg %d", &epg_id))
264 else if (unformat (input, "bd %d", &bd_id))
266 else if (unformat (input, "rd %d", &rd_id))
272 if (EPG_INVALID == epg_id)
273 return clib_error_return (0, "EPG-ID must be specified");
277 if (~0 == uplink_sw_if_index)
278 return clib_error_return (0, "interface must be specified");
280 return clib_error_return (0, "Bridge-domain must be specified");
282 return clib_error_return (0, "route-domain must be specified");
284 gbp_endpoint_group_add_and_lock (epg_id, bd_id, rd_id,
288 gbp_endpoint_group_delete (epg_id);
294 * Configure a GBP Endpoint Group
297 * @cliexstart{set gbp endpoint-group [del] epg <ID> bd <ID> <interface>}
301 VLIB_CLI_COMMAND (gbp_endpoint_group_cli_node, static) = {
302 .path = "gbp endpoint-group",
303 .short_help = "gbp endpoint-group [del] epg <ID> bd <ID> rd <ID> <interface>",
304 .function = gbp_endpoint_group_cli,
308 format_gbp_endpoint_group (u8 * s, va_list * args)
310 gbp_endpoint_group_t *gg = va_arg (*args, gbp_endpoint_group_t*);
311 vnet_main_t *vnm = vnet_get_main ();
314 s = format (s, "%d, bd:[%d,%d], rd:[%d] uplink:%U locks:%d",
316 gbp_endpoint_group_get_bd_id(gg), gg->gg_bd_index,
318 format_vnet_sw_if_index_name, vnm, gg->gg_uplink_sw_if_index,
321 s = format (s, "NULL");
327 gbp_endpoint_group_show_one (gbp_endpoint_group_t *gg, void *ctx)
332 vlib_cli_output (vm, " %U",format_gbp_endpoint_group, gg);
337 static clib_error_t *
338 gbp_endpoint_group_show (vlib_main_t * vm,
339 unformat_input_t * input, vlib_cli_command_t * cmd)
341 vlib_cli_output (vm, "Endpoint-Groups:");
342 gbp_endpoint_group_walk (gbp_endpoint_group_show_one, vm);
349 * Show Group Based Policy Endpoint_Groups and derived information
352 * @cliexstart{show gbp endpoint_group}
356 VLIB_CLI_COMMAND (gbp_endpoint_group_show_node, static) = {
357 .path = "show gbp endpoint-group",
358 .short_help = "show gbp endpoint-group\n",
359 .function = gbp_endpoint_group_show,
363 static clib_error_t *
364 gbp_endpoint_group_init (vlib_main_t * vm)
366 gg_logger = vlib_log_register_class ("gbp", "epg");
371 VLIB_INIT_FUNCTION (gbp_endpoint_group_init);
374 * fd.io coding-style-patch-verification: ON
377 * eval: (c-set-style "gnu")