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           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);
 146         }
 147
 148       hash_set (gbp_endpoint_group_db.gg_hash_sclass,
 149                 gg->gg_sclass, gg - gbp_endpoint_group_pool);
 150     }
 151   else
 152     {
 153       gg = gbp_endpoint_group_get (ggi);
 154       gg->gg_locks++;
 155     }
 156
 157   GBP_EPG_DBG ("add: %U", format_gbp_endpoint_group, gg);
 158
 159   return (0);
 160 }
 161
 162 void
 163 gbp_endpoint_group_unlock (index_t ggi)
 164 {
 165   gbp_endpoint_group_t *gg;
 166
 167   if (INDEX_INVALID == ggi)
 168     return;
 169
 170   gg = gbp_endpoint_group_get (ggi);
 171
 172   gg->gg_locks--;
 173
 174   if (0 == gg->gg_locks)
 175     {
 176       fib_protocol_t fproto;
 177
 178       gg = pool_elt_at_index (gbp_endpoint_group_pool, ggi);
 179
 180       if (~0 != gg->gg_uplink_sw_if_index)
 181         {
 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);
 185
 186           l2input_intf_bitmap_enable (gg->gg_uplink_sw_if_index,
 187                                       L2INPUT_FEAT_GBP_NULL_CLASSIFY, 0);
 188         }
 189       FOR_EACH_FIB_IP_PROTOCOL (fproto)
 190       {
 191         dpo_reset (&gg->gg_dpo[fproto]);
 192       }
 193       gbp_bridge_domain_unlock (gg->gg_gbd);
 194       gbp_route_domain_unlock (gg->gg_rd);
 195
 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);
 199
 200       pool_put (gbp_endpoint_group_pool, gg);
 201     }
 202 }
 203
 204 int
 205 gbp_endpoint_group_delete (sclass_t sclass)
 206 {
 207   index_t ggi;
 208
 209   ggi = gbp_endpoint_group_find (sclass);
 210
 211   if (INDEX_INVALID != ggi)
 212     {
 213       GBP_EPG_DBG ("del: %U", format_gbp_endpoint_group,
 214                    gbp_endpoint_group_get (ggi));
 215       gbp_endpoint_group_unlock (ggi);
 216
 217       return (0);
 218     }
 219
 220   return (VNET_API_ERROR_NO_SUCH_ENTRY);
 221 }
 222
 223 u32
 224 gbp_endpoint_group_get_bd_id (const gbp_endpoint_group_t * gg)
 225 {
 226   const gbp_bridge_domain_t *gb;
 227
 228   gb = gbp_bridge_domain_get (gg->gg_gbd);
 229
 230   return (gb->gb_bd_id);
 231 }
 232
 233 index_t
 234 gbp_endpoint_group_get_fib_index (const gbp_endpoint_group_t * gg,
 235                                   fib_protocol_t fproto)
 236 {
 237   const gbp_route_domain_t *grd;
 238
 239   grd = gbp_route_domain_get (gg->gg_rd);
 240
 241   return (grd->grd_fib_index[fproto]);
 242 }
 243
 244 void
 245 gbp_endpoint_group_walk (gbp_endpoint_group_cb_t cb, void *ctx)
 246 {
 247   gbp_endpoint_group_t *gbpe;
 248
 249   /* *INDENT-OFF* */
 250   pool_foreach(gbpe, gbp_endpoint_group_pool,
 251   {
 252     if (!cb(gbpe, ctx))
 253       break;
 254   });
 255   /* *INDENT-ON* */
 256 }
 257
 258 static clib_error_t *
 259 gbp_endpoint_group_cli (vlib_main_t * vm,
 260                         unformat_input_t * input, vlib_cli_command_t * cmd)
 261 {
 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;
 266   u32 bd_id = ~0;
 267   u32 rd_id = ~0;
 268   u8 add = 1;
 269
 270   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 271     {
 272       if (unformat (input, "%U", unformat_vnet_sw_interface,
 273                     vnm, &uplink_sw_if_index))
 274         ;
 275       else if (unformat (input, "add"))
 276         add = 1;
 277       else if (unformat (input, "del"))
 278         add = 0;
 279       else if (unformat (input, "epg %d", &vnid))
 280         ;
 281       else if (unformat (input, "sclass %d", &sclass))
 282         ;
 283       else if (unformat (input, "bd %d", &bd_id))
 284         ;
 285       else if (unformat (input, "rd %d", &rd_id))
 286         ;
 287       else
 288         break;
 289     }
 290
 291   if (VNID_INVALID == vnid)
 292     return clib_error_return (0, "EPG-ID must be specified");
 293
 294   if (add)
 295     {
 296       if (~0 == bd_id)
 297         return clib_error_return (0, "Bridge-domain must be specified");
 298       if (~0 == rd_id)
 299         return clib_error_return (0, "route-domain must be specified");
 300
 301       gbp_endpoint_group_add_and_lock (vnid, sclass, bd_id, rd_id,
 302                                        uplink_sw_if_index, &retention);
 303     }
 304   else
 305     gbp_endpoint_group_delete (vnid);
 306
 307   return (NULL);
 308 }
 309
 310 /*?
 311  * Configure a GBP Endpoint Group
 312  *
 313  * @cliexpar
 314  * @cliexstart{gbp endpoint-group [del] epg <ID> bd <ID> rd <ID> [sclass <ID>] [<interface>]}
 315  * @cliexend
 316  ?*/
 317 /* *INDENT-OFF* */
 318 VLIB_CLI_COMMAND (gbp_endpoint_group_cli_node, static) = {
 319   .path = "gbp endpoint-group",
 320   .short_help = "gbp endpoint-group [del] epg <ID> bd <ID> rd <ID> [sclass <ID>] [<interface>]",
 321   .function = gbp_endpoint_group_cli,
 322 };
 323
 324 static u8 *
 325 format_gbp_endpoint_retention (u8 * s, va_list * args)
 326 {
 327   gbp_endpoint_retention_t *rt = va_arg (*args, gbp_endpoint_retention_t*);
 328
 329   s = format (s, "[remote-EP-timeout:%d]", rt->remote_ep_timeout);
 330
 331   return (s);
 332 }
 333
 334 u8 *
 335 format_gbp_endpoint_group (u8 * s, va_list * args)
 336 {
 337   gbp_endpoint_group_t *gg = va_arg (*args, gbp_endpoint_group_t*);
 338   vnet_main_t *vnm = vnet_get_main ();
 339
 340   if (NULL != gg)
 341     s = format (s, "[%d] %d, sclass:%d bd:[%d,%d] rd:[%d] uplink:%U retention:%U locks:%d",
 342                 gg - gbp_endpoint_group_pool,
 343                 gg->gg_vnid,
 344                 gg->gg_sclass,
 345                 gbp_endpoint_group_get_bd_id(gg), gg->gg_bd_index,
 346                 gg->gg_rd,
 347                 format_vnet_sw_if_index_name, vnm, gg->gg_uplink_sw_if_index,
 348                 format_gbp_endpoint_retention, &gg->gg_retention,
 349                 gg->gg_locks);
 350   else
 351     s = format (s, "NULL");
 352
 353   return (s);
 354 }
 355
 356 static int
 357 gbp_endpoint_group_show_one (gbp_endpoint_group_t *gg, void *ctx)
 358 {
 359   vlib_main_t *vm;
 360
 361   vm = ctx;
 362   vlib_cli_output (vm, "  %U",format_gbp_endpoint_group, gg);
 363
 364   return (1);
 365 }
 366
 367 static clib_error_t *
 368 gbp_endpoint_group_show (vlib_main_t * vm,
 369                    unformat_input_t * input, vlib_cli_command_t * cmd)
 370 {
 371   vlib_cli_output (vm, "Endpoint-Groups:");
 372   gbp_endpoint_group_walk (gbp_endpoint_group_show_one, vm);
 373
 374   return (NULL);
 375 }
 376
 377
 378 /*?
 379  * Show Group Based Policy Endpoint_Groups and derived information
 380  *
 381  * @cliexpar
 382  * @cliexstart{show gbp endpoint_group}
 383  * @cliexend
 384  ?*/
 385 /* *INDENT-OFF* */
 386 VLIB_CLI_COMMAND (gbp_endpoint_group_show_node, static) = {
 387   .path = "show gbp endpoint-group",
 388   .short_help = "show gbp endpoint-group\n",
 389   .function = gbp_endpoint_group_show,
 390 };
 391 /* *INDENT-ON* */
 392
 393 static clib_error_t *
 394 gbp_endpoint_group_init (vlib_main_t * vm)
 395 {
 396   gg_logger = vlib_log_register_class ("gbp", "epg");
 397
 398   return (NULL);
 399 }
 400
 401 VLIB_INIT_FUNCTION (gbp_endpoint_group_init);
 402
 403 /*
 404  * fd.io coding-style-patch-verification: ON
 405  *
 406  * Local Variables:
 407  * eval: (c-set-style "gnu")
 408  * End:
 409  */