src/plugins/gbp/gbp_endpoint_group.c

   1 /*
   2  * gbp.h : Group Based Policy
   3  *
   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:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  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.
  16  */
  17
  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>
  22
  23 #include <vnet/dpo/dvr_dpo.h>
  24 #include <vnet/fib/fib_table.h>
  25 #include <vnet/l2/l2_input.h>
  26
  27 /**
  28  * Pool of GBP endpoint_groups
  29  */
  30 gbp_endpoint_group_t *gbp_endpoint_group_pool;
  31
  32 /**
  33  * DB of endpoint_groups
  34  */
  35 gbp_endpoint_group_db_t gbp_endpoint_group_db;
  36
  37 /**
  38  * Map sclass to EPG
  39  */
  40 uword *gbp_epg_sclass_db;
  41
  42 vlib_log_class_t gg_logger;
  43
  44 #define GBP_EPG_DBG(...)                           \
  45     vlib_log_debug (gg_logger, __VA_ARGS__);
  46
  47 gbp_endpoint_group_t *
  48 gbp_endpoint_group_get (index_t i)
  49 {
  50   return (pool_elt_at_index (gbp_endpoint_group_pool, i));
  51 }
  52
  53 void
  54 gbp_endpoint_group_lock (index_t i)
  55 {
  56   gbp_endpoint_group_t *gg;
  57
  58   gg = gbp_endpoint_group_get (i);
  59   gg->gg_locks++;
  60 }
  61
  62 index_t
  63 gbp_endpoint_group_find (sclass_t sclass)
  64 {
  65   uword *p;
  66
  67   p = hash_get (gbp_endpoint_group_db.gg_hash_sclass, sclass);
  68
  69   if (NULL != p)
  70     return p[0];
  71
  72   return (INDEX_INVALID);
  73 }
  74
  75 int
  76 gbp_endpoint_group_add_and_lock (vnid_t vnid,
  77                                  u16 sclass,
  78                                  u32 bd_id,
  79                                  u32 rd_id,
  80                                  u32 uplink_sw_if_index,
  81                                  const gbp_endpoint_retention_t * retention)
  82 {
  83   gbp_endpoint_group_t *gg;
  84   index_t ggi;
  85
  86   ggi = gbp_endpoint_group_find (sclass);
  87
  88   if (INDEX_INVALID == ggi)
  89     {
  90       gbp_bridge_domain_t *gb;
  91       fib_protocol_t fproto;
  92       index_t gbi, grdi;
  93
  94       gbi = gbp_bridge_domain_find_and_lock (bd_id);
  95
  96       if (~0 == gbi)
  97         return (VNET_API_ERROR_BD_NOT_MODIFIABLE);
  98
  99       grdi = gbp_route_domain_find_and_lock (rd_id);
 100
 101       if (~0 == grdi)
 102         {
 103           gbp_bridge_domain_unlock (gbi);
 104           return (VNET_API_ERROR_NO_SUCH_FIB);
 105         }
 106
 107       gb = gbp_bridge_domain_get (gbi);
 108
 109       pool_get_zero (gbp_endpoint_group_pool, gg);
 110
 111       gg->gg_vnid = vnid;
 112       gg->gg_rd = grdi;
 113       gg->gg_gbd = gbi;
 114       gg->gg_bd_index = gb->gb_bd_index;
 115
 116       gg->gg_uplink_sw_if_index = uplink_sw_if_index;
 117       gg->gg_locks = 1;
 118       gg->gg_sclass = sclass;
 119       gg->gg_retention = *retention;
 120
 121       if (SCLASS_INVALID != gg->gg_sclass)
 122         hash_set (gbp_epg_sclass_db, gg->gg_sclass, gg->gg_vnid);
 123
 124       /*
 125        * an egress DVR dpo for internal subnets to use when sending
 126        * on the uplink interface
 127        */
 128       if (~0 != gg->gg_uplink_sw_if_index)
 129         {
 130           FOR_EACH_FIB_IP_PROTOCOL (fproto)
 131           {
 132             dvr_dpo_add_or_lock (uplink_sw_if_index,
 133                                  fib_proto_to_dpo (fproto),
 134                                  &gg->gg_dpo[fproto]);
 135           }
 136
 137           /*
 138            * Add the uplink to the BD
 139            * packets direct from the uplink have had policy applied
 140            */
 141           gbp_bridge_domain_itf_add (gg->gg_uplink_sw_if_index,
 142                                      gg->gg_bd_index, L2_BD_PORT_TYPE_NORMAL);
 143           l2input_intf_bitmap_enable (gg->gg_uplink_sw_if_index,
 144                                       L2INPUT_FEAT_GBP_NULL_CLASSIFY, 1);
 145         }
 146
 147       hash_set (gbp_endpoint_group_db.gg_hash_sclass,
 148                 gg->gg_sclass, gg - gbp_endpoint_group_pool);
 149     }
 150   else
 151     {
 152       gg = gbp_endpoint_group_get (ggi);
 153       gg->gg_locks++;
 154     }
 155
 156   GBP_EPG_DBG ("add: %U", format_gbp_endpoint_group, gg);
 157
 158   return (0);
 159 }
 160
 161 void
 162 gbp_endpoint_group_unlock (index_t ggi)
 163 {
 164   gbp_endpoint_group_t *gg;
 165
 166   if (INDEX_INVALID == ggi)
 167     return;
 168
 169   gg = gbp_endpoint_group_get (ggi);
 170
 171   gg->gg_locks--;
 172
 173   if (0 == gg->gg_locks)
 174     {
 175       fib_protocol_t fproto;
 176
 177       gg = pool_elt_at_index (gbp_endpoint_group_pool, ggi);
 178
 179       if (~0 != gg->gg_uplink_sw_if_index)
 180         {
 181           gbp_bridge_domain_itf_del (gg->gg_uplink_sw_if_index,
 182                                      gg->gg_bd_index, L2_BD_PORT_TYPE_NORMAL);
 183           l2input_intf_bitmap_enable (gg->gg_uplink_sw_if_index,
 184                                       L2INPUT_FEAT_GBP_NULL_CLASSIFY, 0);
 185         }
 186       FOR_EACH_FIB_IP_PROTOCOL (fproto)
 187       {
 188         dpo_reset (&gg->gg_dpo[fproto]);
 189       }
 190       gbp_bridge_domain_unlock (gg->gg_gbd);
 191       gbp_route_domain_unlock (gg->gg_rd);
 192
 193       if (SCLASS_INVALID != gg->gg_sclass)
 194         hash_unset (gbp_epg_sclass_db, gg->gg_sclass);
 195       hash_unset (gbp_endpoint_group_db.gg_hash_sclass, gg->gg_sclass);
 196
 197       pool_put (gbp_endpoint_group_pool, gg);
 198     }
 199 }
 200
 201 int
 202 gbp_endpoint_group_delete (sclass_t sclass)
 203 {
 204   index_t ggi;
 205
 206   ggi = gbp_endpoint_group_find (sclass);
 207
 208   if (INDEX_INVALID != ggi)
 209     {
 210       GBP_EPG_DBG ("del: %U", format_gbp_endpoint_group,
 211                    gbp_endpoint_group_get (ggi));
 212       gbp_endpoint_group_unlock (ggi);
 213
 214       return (0);
 215     }
 216
 217   return (VNET_API_ERROR_NO_SUCH_ENTRY);
 218 }
 219
 220 u32
 221 gbp_endpoint_group_get_bd_id (const gbp_endpoint_group_t * gg)
 222 {
 223   const gbp_bridge_domain_t *gb;
 224
 225   gb = gbp_bridge_domain_get (gg->gg_gbd);
 226
 227   return (gb->gb_bd_id);
 228 }
 229
 230 index_t
 231 gbp_endpoint_group_get_fib_index (const gbp_endpoint_group_t * gg,
 232                                   fib_protocol_t fproto)
 233 {
 234   const gbp_route_domain_t *grd;
 235
 236   grd = gbp_route_domain_get (gg->gg_rd);
 237
 238   return (grd->grd_fib_index[fproto]);
 239 }
 240
 241 void
 242 gbp_endpoint_group_walk (gbp_endpoint_group_cb_t cb, void *ctx)
 243 {
 244   gbp_endpoint_group_t *gbpe;
 245
 246   /* *INDENT-OFF* */
 247   pool_foreach(gbpe, gbp_endpoint_group_pool,
 248   {
 249     if (!cb(gbpe, ctx))
 250       break;
 251   });
 252   /* *INDENT-ON* */
 253 }
 254
 255 static clib_error_t *
 256 gbp_endpoint_group_cli (vlib_main_t * vm,
 257                         unformat_input_t * input, vlib_cli_command_t * cmd)
 258 {
 259   gbp_endpoint_retention_t retention = { 0 };
 260   vnid_t vnid = VNID_INVALID, sclass;
 261   vnet_main_t *vnm = vnet_get_main ();
 262   u32 uplink_sw_if_index = ~0;
 263   u32 bd_id = ~0;
 264   u32 rd_id = ~0;
 265   u8 add = 1;
 266
 267   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 268     {
 269       if (unformat (input, "%U", unformat_vnet_sw_interface,
 270                     vnm, &uplink_sw_if_index))
 271         ;
 272       else if (unformat (input, "add"))
 273         add = 1;
 274       else if (unformat (input, "del"))
 275         add = 0;
 276       else if (unformat (input, "epg %d", &vnid))
 277         ;
 278       else if (unformat (input, "sclass %d", &sclass))
 279         ;
 280       else if (unformat (input, "bd %d", &bd_id))
 281         ;
 282       else if (unformat (input, "rd %d", &rd_id))
 283         ;
 284       else
 285         break;
 286     }
 287
 288   if (VNID_INVALID == vnid)
 289     return clib_error_return (0, "EPG-ID must be specified");
 290
 291   if (add)
 292     {
 293       if (~0 == bd_id)
 294         return clib_error_return (0, "Bridge-domain must be specified");
 295       if (~0 == rd_id)
 296         return clib_error_return (0, "route-domain must be specified");
 297
 298       gbp_endpoint_group_add_and_lock (vnid, sclass, bd_id, rd_id,
 299                                        uplink_sw_if_index, &retention);
 300     }
 301   else
 302     gbp_endpoint_group_delete (vnid);
 303
 304   return (NULL);
 305 }
 306
 307 /*?
 308  * Configure a GBP Endpoint Group
 309  *
 310  * @cliexpar
 311  * @cliexstart{gbp endpoint-group [del] epg <ID> bd <ID> rd <ID> [sclass <ID>] [<interface>]}
 312  * @cliexend
 313  ?*/
 314 /* *INDENT-OFF* */
 315 VLIB_CLI_COMMAND (gbp_endpoint_group_cli_node, static) = {
 316   .path = "gbp endpoint-group",
 317   .short_help = "gbp endpoint-group [del] epg <ID> bd <ID> rd <ID> [sclass <ID>] [<interface>]",
 318   .function = gbp_endpoint_group_cli,
 319 };
 320
 321 static u8 *
 322 format_gbp_endpoint_retention (u8 * s, va_list * args)
 323 {
 324   gbp_endpoint_retention_t *rt = va_arg (*args, gbp_endpoint_retention_t*);
 325
 326   s = format (s, "[remote-EP-timeout:%d]", rt->remote_ep_timeout);
 327
 328   return (s);
 329 }
 330
 331 u8 *
 332 format_gbp_endpoint_group (u8 * s, va_list * args)
 333 {
 334   gbp_endpoint_group_t *gg = va_arg (*args, gbp_endpoint_group_t*);
 335   vnet_main_t *vnm = vnet_get_main ();
 336
 337   if (NULL != gg)
 338     s = format (s, "[%d] %d, sclass:%d bd:[%d,%d] rd:[%d] uplink:%U retention:%U locks:%d",
 339                 gg - gbp_endpoint_group_pool,
 340                 gg->gg_vnid,
 341                 gg->gg_sclass,
 342                 gbp_endpoint_group_get_bd_id(gg), gg->gg_bd_index,
 343                 gg->gg_rd,
 344                 format_vnet_sw_if_index_name, vnm, gg->gg_uplink_sw_if_index,
 345                 format_gbp_endpoint_retention, &gg->gg_retention,
 346                 gg->gg_locks);
 347   else
 348     s = format (s, "NULL");
 349
 350   return (s);
 351 }
 352
 353 static int
 354 gbp_endpoint_group_show_one (gbp_endpoint_group_t *gg, void *ctx)
 355 {
 356   vlib_main_t *vm;
 357
 358   vm = ctx;
 359   vlib_cli_output (vm, "  %U",format_gbp_endpoint_group, gg);
 360
 361   return (1);
 362 }
 363
 364 static clib_error_t *
 365 gbp_endpoint_group_show (vlib_main_t * vm,
 366                    unformat_input_t * input, vlib_cli_command_t * cmd)
 367 {
 368   vlib_cli_output (vm, "Endpoint-Groups:");
 369   gbp_endpoint_group_walk (gbp_endpoint_group_show_one, vm);
 370
 371   return (NULL);
 372 }
 373
 374
 375 /*?
 376  * Show Group Based Policy Endpoint_Groups and derived information
 377  *
 378  * @cliexpar
 379  * @cliexstart{show gbp endpoint_group}
 380  * @cliexend
 381  ?*/
 382 /* *INDENT-OFF* */
 383 VLIB_CLI_COMMAND (gbp_endpoint_group_show_node, static) = {
 384   .path = "show gbp endpoint-group",
 385   .short_help = "show gbp endpoint-group\n",
 386   .function = gbp_endpoint_group_show,
 387 };
 388 /* *INDENT-ON* */
 389
 390 static clib_error_t *
 391 gbp_endpoint_group_init (vlib_main_t * vm)
 392 {
 393   gg_logger = vlib_log_register_class ("gbp", "epg");
 394
 395   return (NULL);
 396 }
 397
 398 VLIB_INIT_FUNCTION (gbp_endpoint_group_init);
 399
 400 /*
 401  * fd.io coding-style-patch-verification: ON
 402  *
 403  * Local Variables:
 404  * eval: (c-set-style "gnu")
 405  * End:
 406  */