src/plugins/gbp/gbp_subnet.c

   1 /*
   2  * Copyright (c) 2018 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #include <plugins/gbp/gbp.h>
  17 #include <plugins/gbp/gbp_fwd_dpo.h>
  18 #include <plugins/gbp/gbp_policy_dpo.h>
  19 #include <plugins/gbp/gbp_route_domain.h>
  20
  21 #include <vnet/fib/fib_table.h>
  22 #include <vnet/dpo/load_balance.h>
  23
  24 /**
  25  * a key for the DB
  26  */
  27 typedef struct gbp_subnet_key_t_
  28 {
  29   fib_prefix_t gsk_pfx;
  30   u32 gsk_fib_index;
  31 } gbp_subnet_key_t;
  32
  33 /**
  34  * Subnet
  35  */
  36 typedef struct gbp_subnet_t_
  37 {
  38   gbp_subnet_key_t *gs_key;
  39   gbp_subnet_type_t gs_type;
  40   index_t gs_rd;
  41
  42   union
  43   {
  44     struct
  45     {
  46       sclass_t gs_sclass;
  47       u32 gs_sw_if_index;
  48     } gs_stitched_external;
  49     struct
  50     {
  51       sclass_t gs_sclass;
  52     } gs_l3_out;
  53   };
  54
  55   fib_node_index_t gs_fei;
  56 } gbp_subnet_t;
  57
  58 /**
  59  * A DB of the subnets; key={pfx,fib-index}
  60  */
  61 uword *gbp_subnet_db;
  62
  63 /**
  64  * pool of subnets
  65  */
  66 gbp_subnet_t *gbp_subnet_pool;
  67
  68 static index_t
  69 gbp_subnet_db_find (u32 fib_index, const fib_prefix_t * pfx)
  70 {
  71   gbp_subnet_key_t key = {
  72     .gsk_pfx = *pfx,
  73     .gsk_fib_index = fib_index,
  74   };
  75   uword *p;
  76
  77   p = hash_get_mem (gbp_subnet_db, &key);
  78
  79   if (NULL != p)
  80     return p[0];
  81
  82   return (INDEX_INVALID);
  83 }
  84
  85 static void
  86 gbp_subnet_db_add (u32 fib_index, const fib_prefix_t * pfx, gbp_subnet_t * gs)
  87 {
  88   gbp_subnet_key_t *key;
  89
  90   key = clib_mem_alloc (sizeof (*key));
  91
  92   clib_memcpy (&(key->gsk_pfx), pfx, sizeof (*pfx));
  93   key->gsk_fib_index = fib_index;
  94
  95   hash_set_mem (gbp_subnet_db, key, (gs - gbp_subnet_pool));
  96
  97   gs->gs_key = key;
  98 }
  99
 100 static void
 101 gbp_subnet_db_del (gbp_subnet_t * gs)
 102 {
 103   hash_unset_mem (gbp_subnet_db, gs->gs_key);
 104
 105   clib_mem_free (gs->gs_key);
 106   gs->gs_key = NULL;
 107 }
 108
 109
 110 static int
 111 gbp_subnet_transport_add (gbp_subnet_t * gs)
 112 {
 113   dpo_id_t gfd = DPO_INVALID;
 114   gbp_route_domain_t *grd;
 115   fib_protocol_t fproto;
 116
 117   fproto = gs->gs_key->gsk_pfx.fp_proto;
 118   grd = gbp_route_domain_get (gs->gs_rd);
 119
 120   if (~0 == grd->grd_uu_sw_if_index[fproto])
 121     return (VNET_API_ERROR_INVALID_SW_IF_INDEX);
 122
 123   gs->gs_fei = fib_table_entry_update_one_path (gs->gs_key->gsk_fib_index,
 124                                                 &gs->gs_key->gsk_pfx,
 125                                                 FIB_SOURCE_PLUGIN_HI,
 126                                                 FIB_ENTRY_FLAG_NONE,
 127                                                 fib_proto_to_dpo (fproto),
 128                                                 &ADJ_BCAST_ADDR,
 129                                                 grd->grd_uu_sw_if_index
 130                                                 [fproto], ~0, 1, NULL,
 131                                                 FIB_ROUTE_PATH_FLAG_NONE);
 132
 133   dpo_reset (&gfd);
 134
 135   return (0);
 136 }
 137
 138 static int
 139 gbp_subnet_internal_add (gbp_subnet_t * gs)
 140 {
 141   dpo_id_t gfd = DPO_INVALID;
 142
 143   gbp_fwd_dpo_add_or_lock (fib_proto_to_dpo (gs->gs_key->gsk_pfx.fp_proto),
 144                            &gfd);
 145
 146   gs->gs_fei = fib_table_entry_special_dpo_update (gs->gs_key->gsk_fib_index,
 147                                                    &gs->gs_key->gsk_pfx,
 148                                                    FIB_SOURCE_PLUGIN_HI,
 149                                                    FIB_ENTRY_FLAG_EXCLUSIVE,
 150                                                    &gfd);
 151
 152   dpo_reset (&gfd);
 153
 154   return (0);
 155 }
 156
 157 static int
 158 gbp_subnet_external_add (gbp_subnet_t * gs, u32 sw_if_index, sclass_t sclass)
 159 {
 160   dpo_id_t gpd = DPO_INVALID;
 161
 162   gs->gs_stitched_external.gs_sclass = sclass;
 163   gs->gs_stitched_external.gs_sw_if_index = sw_if_index;
 164
 165   gbp_policy_dpo_add_or_lock (fib_proto_to_dpo (gs->gs_key->gsk_pfx.fp_proto),
 166                               gs->gs_stitched_external.gs_sclass,
 167                               gs->gs_stitched_external.gs_sw_if_index, &gpd);
 168
 169   gs->gs_fei = fib_table_entry_special_dpo_update (gs->gs_key->gsk_fib_index,
 170                                                    &gs->gs_key->gsk_pfx,
 171                                                    FIB_SOURCE_PLUGIN_HI,
 172                                                    (FIB_ENTRY_FLAG_EXCLUSIVE |
 173                                                     FIB_ENTRY_FLAG_LOOSE_URPF_EXEMPT),
 174                                                    &gpd);
 175
 176   dpo_reset (&gpd);
 177
 178   return (0);
 179 }
 180
 181 static int
 182 gbp_subnet_l3_out_add (gbp_subnet_t * gs, sclass_t sclass)
 183 {
 184   dpo_id_t gpd = DPO_INVALID;
 185
 186   gs->gs_l3_out.gs_sclass = sclass;
 187
 188   gbp_policy_dpo_add_or_lock (fib_proto_to_dpo (gs->gs_key->gsk_pfx.fp_proto),
 189                               gs->gs_l3_out.gs_sclass, ~0, &gpd);
 190
 191   gs->gs_fei = fib_table_entry_special_dpo_add (gs->gs_key->gsk_fib_index,
 192                                                 &gs->gs_key->gsk_pfx,
 193                                                 FIB_SOURCE_SPECIAL,
 194                                                 FIB_ENTRY_FLAG_INTERPOSE,
 195                                                 &gpd);
 196
 197   dpo_reset (&gpd);
 198
 199   return (0);
 200 }
 201
 202 static void
 203 gbp_subnet_del_i (index_t gsi)
 204 {
 205   gbp_subnet_t *gs;
 206
 207   gs = pool_elt_at_index (gbp_subnet_pool, gsi);
 208
 209   if (GBP_SUBNET_L3_OUT == gs->gs_type)
 210     fib_table_entry_delete_index (gs->gs_fei, FIB_SOURCE_SPECIAL);
 211   else
 212     fib_table_entry_delete_index (gs->gs_fei, FIB_SOURCE_PLUGIN_HI);
 213
 214   gbp_subnet_db_del (gs);
 215   gbp_route_domain_unlock (gs->gs_rd);
 216
 217   pool_put (gbp_subnet_pool, gs);
 218 }
 219
 220 int
 221 gbp_subnet_del (u32 rd_id, const fib_prefix_t * pfx)
 222 {
 223   gbp_route_domain_t *grd;
 224   index_t gsi, grdi;
 225   u32 fib_index;
 226
 227   grdi = gbp_route_domain_find (rd_id);
 228
 229   if (~0 == grdi)
 230     return (VNET_API_ERROR_NO_SUCH_FIB);
 231
 232   grd = gbp_route_domain_get (grdi);
 233   fib_index = grd->grd_fib_index[pfx->fp_proto];
 234
 235   gsi = gbp_subnet_db_find (fib_index, pfx);
 236
 237   if (INDEX_INVALID == gsi)
 238     return (VNET_API_ERROR_NO_SUCH_ENTRY);
 239
 240   gbp_subnet_del_i (gsi);
 241
 242   return (0);
 243 }
 244
 245 int
 246 gbp_subnet_add (u32 rd_id,
 247                 const fib_prefix_t * pfx,
 248                 gbp_subnet_type_t type, u32 sw_if_index, sclass_t sclass)
 249 {
 250   gbp_route_domain_t *grd;
 251   index_t grdi, gsi;
 252   gbp_subnet_t *gs;
 253   u32 fib_index;
 254   int rv;
 255
 256   grdi = gbp_route_domain_find_and_lock (rd_id);
 257
 258   if (~0 == grdi)
 259     return (VNET_API_ERROR_NO_SUCH_FIB);
 260
 261   grd = gbp_route_domain_get (grdi);
 262   fib_index = grd->grd_fib_index[pfx->fp_proto];
 263
 264   gsi = gbp_subnet_db_find (fib_index, pfx);
 265
 266   /*
 267    * this is an update if the subnet already exists, so remove the old
 268    */
 269   if (INDEX_INVALID != gsi)
 270     gbp_subnet_del_i (gsi);
 271
 272   rv = -2;
 273
 274   pool_get (gbp_subnet_pool, gs);
 275
 276   gs->gs_type = type;
 277   gs->gs_rd = grdi;
 278   gbp_subnet_db_add (fib_index, pfx, gs);
 279
 280   switch (type)
 281     {
 282     case GBP_SUBNET_STITCHED_INTERNAL:
 283       rv = gbp_subnet_internal_add (gs);
 284       break;
 285     case GBP_SUBNET_STITCHED_EXTERNAL:
 286       rv = gbp_subnet_external_add (gs, sw_if_index, sclass);
 287       break;
 288     case GBP_SUBNET_TRANSPORT:
 289       rv = gbp_subnet_transport_add (gs);
 290       break;
 291     case GBP_SUBNET_L3_OUT:
 292       rv = gbp_subnet_l3_out_add (gs, sclass);
 293       break;
 294     }
 295
 296   return (rv);
 297 }
 298
 299 static clib_error_t *
 300 gbp_subnet_add_del_cli (vlib_main_t * vm,
 301                         unformat_input_t * input, vlib_cli_command_t * cmd)
 302 {
 303   vnet_main_t *vnm = vnet_get_main ();
 304   fib_prefix_t pfx = {.fp_addr = ip46_address_initializer };
 305   int length;
 306   u32 rd_id = ~0;
 307   u32 sw_if_index = ~0;
 308   gbp_subnet_type_t type = ~0;
 309   u32 sclass = ~0;
 310   int is_add = 1;
 311   int rv;
 312
 313   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 314     {
 315       if (unformat (input, "del"))
 316         is_add = 0;
 317       else if (unformat (input, "rd %d", &rd_id))
 318         ;
 319       else
 320         if (unformat
 321             (input, "prefix %U/%d", unformat_ip4_address, &pfx.fp_addr.ip4,
 322              &length))
 323         pfx.fp_proto = FIB_PROTOCOL_IP4;
 324       else
 325         if (unformat
 326             (input, "prefix %U/%d", unformat_ip6_address, &pfx.fp_addr.ip6,
 327              &length))
 328         pfx.fp_proto = FIB_PROTOCOL_IP6;
 329       else if (unformat (input, "type transport"))
 330         type = GBP_SUBNET_TRANSPORT;
 331       else if (unformat (input, "type internal"))
 332         type = GBP_SUBNET_STITCHED_INTERNAL;
 333       else if (unformat (input, "type external"))
 334         type = GBP_SUBNET_STITCHED_EXTERNAL;
 335       else if (unformat (input, "type l3out"))
 336         type = GBP_SUBNET_L3_OUT;
 337       else
 338         if (unformat_user
 339             (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
 340         ;
 341       else if (unformat (input, "sclass %u", &sclass))
 342         ;
 343       else
 344         break;
 345     }
 346
 347   pfx.fp_len = length;
 348
 349   if (is_add)
 350     rv = gbp_subnet_add (rd_id, &pfx, type, sw_if_index, sclass);
 351   else
 352     rv = gbp_subnet_del (rd_id, &pfx);
 353
 354   switch (rv)
 355     {
 356     case 0:
 357       return 0;
 358     case VNET_API_ERROR_NO_SUCH_FIB:
 359       return clib_error_return (0, "no such FIB");
 360     }
 361
 362   return clib_error_return (0, "unknown error %d", rv);
 363 }
 364
 365 /*?
 366  * Add Group Based Policy Subnets
 367  *
 368  * @cliexpar
 369  * @cliexstart{gbp subnet [del] rd <ID> prefix <prefix> type <type> [<interface>] [sclass <sclass>]}
 370  * @cliexend
 371  ?*/
 372 /* *INDENT-OFF* */
 373 VLIB_CLI_COMMAND (gbp_subnet_add_del, static) = {
 374   .path = "gbp subnet",
 375   .short_help = "gbp subnet [del] rd <ID> prefix <prefix> type <type> [<interface>] [sclass <sclass>]\n",
 376   .function = gbp_subnet_add_del_cli,
 377 };
 378 /* *INDENT-ON* */
 379
 380
 381
 382 void
 383 gbp_subnet_walk (gbp_subnet_cb_t cb, void *ctx)
 384 {
 385   gbp_route_domain_t *grd;
 386   gbp_subnet_t *gs;
 387   u32 sw_if_index;
 388   sclass_t sclass;
 389
 390   sclass = SCLASS_INVALID;
 391   sw_if_index = ~0;
 392
 393   /* *INDENT-OFF* */
 394   pool_foreach (gs, gbp_subnet_pool,
 395   ({
 396     grd = gbp_route_domain_get(gs->gs_rd);
 397
 398     switch (gs->gs_type)
 399       {
 400       case GBP_SUBNET_STITCHED_INTERNAL:
 401       case GBP_SUBNET_TRANSPORT:
 402         /* use defaults above */
 403         break;
 404       case GBP_SUBNET_STITCHED_EXTERNAL:
 405         sw_if_index = gs->gs_stitched_external.gs_sw_if_index;
 406         sclass = gs->gs_stitched_external.gs_sclass;
 407         break;
 408       case GBP_SUBNET_L3_OUT:
 409         sclass = gs->gs_l3_out.gs_sclass;
 410         break;
 411       }
 412
 413     if (WALK_STOP == cb (grd->grd_id, &gs->gs_key->gsk_pfx,
 414                          gs->gs_type, sw_if_index, sclass, ctx))
 415       break;
 416   }));
 417   /* *INDENT-ON* */
 418 }
 419
 420 typedef enum gsb_subnet_show_flags_t_
 421 {
 422   GBP_SUBNET_SHOW_BRIEF,
 423   GBP_SUBNET_SHOW_DETAILS,
 424 } gsb_subnet_show_flags_t;
 425
 426 static u8 *
 427 format_gbp_subnet_type (u8 * s, va_list * args)
 428 {
 429   gbp_subnet_type_t type = va_arg (*args, gbp_subnet_type_t);
 430
 431   switch (type)
 432     {
 433     case GBP_SUBNET_STITCHED_INTERNAL:
 434       return (format (s, "stitched-internal"));
 435     case GBP_SUBNET_STITCHED_EXTERNAL:
 436       return (format (s, "stitched-external"));
 437     case GBP_SUBNET_TRANSPORT:
 438       return (format (s, "transport"));
 439     case GBP_SUBNET_L3_OUT:
 440       return (format (s, "l3-out"));
 441     }
 442
 443   return (format (s, "unknown"));
 444 }
 445
 446 u8 *
 447 format_gbp_subnet (u8 * s, va_list * args)
 448 {
 449   index_t gsi = va_arg (*args, index_t);
 450   gsb_subnet_show_flags_t flags = va_arg (*args, gsb_subnet_show_flags_t);
 451   gbp_subnet_t *gs;
 452   u32 table_id;
 453
 454   gs = pool_elt_at_index (gbp_subnet_pool, gsi);
 455
 456   table_id = fib_table_get_table_id (gs->gs_key->gsk_fib_index,
 457                                      gs->gs_key->gsk_pfx.fp_proto);
 458
 459   s = format (s, "[%d] tbl:%d %U %U", gsi, table_id,
 460               format_fib_prefix, &gs->gs_key->gsk_pfx,
 461               format_gbp_subnet_type, gs->gs_type);
 462
 463   switch (gs->gs_type)
 464     {
 465     case GBP_SUBNET_STITCHED_INTERNAL:
 466     case GBP_SUBNET_TRANSPORT:
 467       break;
 468     case GBP_SUBNET_STITCHED_EXTERNAL:
 469       s = format (s, " {sclass:%d %U}", gs->gs_stitched_external.gs_sclass,
 470                   format_vnet_sw_if_index_name,
 471                   vnet_get_main (), gs->gs_stitched_external.gs_sw_if_index);
 472       break;
 473     case GBP_SUBNET_L3_OUT:
 474       s = format (s, " {sclass:%d}", gs->gs_l3_out.gs_sclass);
 475       break;
 476     }
 477
 478   switch (flags)
 479     {
 480     case GBP_SUBNET_SHOW_DETAILS:
 481       {
 482         s = format (s, "\n  %U", format_fib_entry, gs->gs_fei,
 483                     FIB_ENTRY_FORMAT_DETAIL);
 484       }
 485     case GBP_SUBNET_SHOW_BRIEF:
 486       break;
 487     }
 488   return (s);
 489 }
 490
 491 static clib_error_t *
 492 gbp_subnet_show (vlib_main_t * vm,
 493                  unformat_input_t * input, vlib_cli_command_t * cmd)
 494 {
 495   u32 gsi;
 496
 497   gsi = INDEX_INVALID;
 498
 499   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 500     {
 501       if (unformat (input, "%d", &gsi))
 502         ;
 503       else
 504         break;
 505     }
 506
 507   if (INDEX_INVALID != gsi)
 508     {
 509       vlib_cli_output (vm, "%U", format_gbp_subnet, gsi,
 510                        GBP_SUBNET_SHOW_DETAILS);
 511     }
 512   else
 513     {
 514       /* *INDENT-OFF* */
 515       pool_foreach_index(gsi, gbp_subnet_pool,
 516       ({
 517         vlib_cli_output (vm, "%U", format_gbp_subnet, gsi,
 518                          GBP_SUBNET_SHOW_BRIEF);
 519       }));
 520       /* *INDENT-ON* */
 521     }
 522
 523   return (NULL);
 524 }
 525
 526 /*?
 527  * Show Group Based Policy Subnets
 528  *
 529  * @cliexpar
 530  * @cliexstart{show gbp subnet}
 531  * @cliexend
 532  ?*/
 533 /* *INDENT-OFF* */
 534 VLIB_CLI_COMMAND (gbp_subnet_show_node, static) = {
 535   .path = "show gbp subnet",
 536   .short_help = "show gbp subnet\n",
 537   .function = gbp_subnet_show,
 538 };
 539 /* *INDENT-ON* */
 540
 541 static clib_error_t *
 542 gbp_subnet_init (vlib_main_t * vm)
 543 {
 544   gbp_subnet_db = hash_create_mem (0,
 545                                    sizeof (gbp_subnet_key_t), sizeof (u32));
 546
 547   return (NULL);
 548 }
 549
 550 VLIB_INIT_FUNCTION (gbp_subnet_init);
 551
 552 /*
 553  * fd.io coding-style-patch-verification: ON
 554  *
 555  * Local Variables:
 556  * eval: (c-set-style "gnu")
 557  * End:
 558  */