src/plugins/svs/svs.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/svs/svs.h>
  17
  18 #include <vlib/vlib.h>
  19 #include <vnet/plugin/plugin.h>
  20 #include <vnet/fib/fib_table.h>
  21 #include <vnet/fib/ip6_fib.h>
  22 #include <vnet/fib/ip4_fib.h>
  23 #include <vnet/dpo/lookup_dpo.h>
  24 #include <vnet/dpo/load_balance.h>
  25 #include <vnet/dpo/load_balance_map.h>
  26
  27 u32 *svs_itf_db[FIB_PROTOCOL_IP_MAX];
  28
  29 static fib_source_t svs_fib_src;
  30
  31 int
  32 svs_table_add (fib_protocol_t fproto, u32 table_id)
  33 {
  34   fib_table_find_or_create_and_lock (fproto, table_id, svs_fib_src);
  35
  36   return (0);
  37 }
  38
  39 int
  40 svs_table_delete (fib_protocol_t fproto, u32 table_id)
  41 {
  42   u32 fib_index, ii;
  43
  44   fib_index = fib_table_find (fproto, table_id);
  45
  46   vec_foreach_index (ii, svs_itf_db[fproto])
  47   {
  48     if (svs_itf_db[fproto][ii] == fib_index)
  49       return VNET_API_ERROR_INSTANCE_IN_USE;
  50   }
  51
  52   if (~0 == fib_index)
  53     return VNET_API_ERROR_NO_SUCH_FIB;
  54
  55   fib_table_unlock (fib_index, fproto, svs_fib_src);
  56
  57   return (0);
  58 }
  59
  60 static int
  61 svs_route_add_i (u32 fib_index, const fib_prefix_t * pfx, u32 src_fib_index)
  62 {
  63   dpo_id_t dpo = DPO_INVALID;
  64
  65
  66   lookup_dpo_add_or_lock_w_fib_index (src_fib_index,
  67                                       fib_proto_to_dpo (pfx->fp_proto),
  68                                       LOOKUP_UNICAST,
  69                                       LOOKUP_INPUT_SRC_ADDR,
  70                                       LOOKUP_TABLE_FROM_CONFIG, &dpo);
  71
  72   fib_table_entry_special_dpo_add (fib_index, pfx,
  73                                    svs_fib_src,
  74                                    FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
  75
  76   dpo_unlock (&dpo);
  77
  78   return (0);
  79 }
  80
  81 int
  82 svs_route_add (u32 table_id, const fib_prefix_t * pfx, u32 source_table_id)
  83 {
  84   u32 fib_index, src_fib_index;
  85   int rv;
  86
  87   fib_index = fib_table_find (pfx->fp_proto, table_id);
  88
  89   if (~0 == fib_index)
  90     return VNET_API_ERROR_NO_SUCH_FIB;
  91
  92   src_fib_index = fib_table_find (pfx->fp_proto, source_table_id);
  93
  94   if (~0 == src_fib_index)
  95     return (VNET_API_ERROR_NO_SUCH_FIB);
  96
  97   rv = svs_route_add_i (fib_index, pfx, src_fib_index);
  98
  99   return (rv);
 100 }
 101
 102 int
 103 svs_route_delete (u32 table_id, const fib_prefix_t * pfx)
 104 {
 105   u32 fib_index;
 106
 107   fib_index = fib_table_find (pfx->fp_proto, table_id);
 108
 109   if (~0 == fib_index)
 110     return VNET_API_ERROR_NO_SUCH_FIB;
 111
 112   fib_table_entry_special_remove (fib_index, pfx, svs_fib_src);
 113
 114   return (0);
 115 }
 116
 117 int
 118 svs_enable (fib_protocol_t fproto, u32 table_id, u32 sw_if_index)
 119 {
 120   fib_prefix_t pfx = {
 121     .fp_proto = fproto,
 122   };
 123   u32 fib_index;
 124
 125   fib_index = fib_table_find (fproto, table_id);
 126
 127   if (~0 == fib_index)
 128     return VNET_API_ERROR_NO_SUCH_FIB;
 129
 130   /*
 131    * now we know which interface the table will serve, we can add the default
 132    * route to use the table that the interface is bound to.
 133    */
 134   svs_route_add_i (fib_index, &pfx,
 135                    fib_table_get_index_for_sw_if_index (fproto, sw_if_index));
 136
 137   vec_validate_init_empty (svs_itf_db[fproto], sw_if_index, ~0);
 138
 139   svs_itf_db[fproto][sw_if_index] = fib_index;
 140
 141   vnet_feature_enable_disable ((FIB_PROTOCOL_IP4 == fproto ?
 142                                 "ip4-unicast" :
 143                                 "ip6-unicast"),
 144                                (FIB_PROTOCOL_IP4 == fproto ?
 145                                 "svs-ip4" :
 146                                 "svs-ip6"), sw_if_index, 1, NULL, 0);
 147
 148   return (0);
 149 }
 150
 151 static void
 152 svs_table_bind (fib_protocol_t fproto, u32 sw_if_index, u32 itf_fib_index)
 153 {
 154   /*
 155    * update the default route to use the interface's newly bound FIB
 156    */
 157   u32 svs_fib_index;
 158
 159   if (sw_if_index >= vec_len (svs_itf_db[FIB_PROTOCOL_IP6]))
 160     return;
 161
 162   svs_fib_index = svs_itf_db[FIB_PROTOCOL_IP6][sw_if_index];
 163
 164   if (~0 != svs_fib_index)
 165     {
 166       fib_prefix_t pfx = {
 167         .fp_proto = fproto,
 168       };
 169
 170       svs_route_add (svs_fib_index, &pfx, itf_fib_index);
 171     }
 172   /*
 173    * else
 174    *  no SVS enable on this interface
 175    */
 176 }
 177
 178 static void
 179 svs_ip6_table_bind (ip6_main_t * im,
 180                     uword opaque,
 181                     u32 sw_if_index, u32 new_fib_index, u32 old_fib_index)
 182 {
 183   svs_table_bind (FIB_PROTOCOL_IP6, sw_if_index, new_fib_index);
 184 }
 185
 186 static void
 187 svs_ip4_table_bind (ip4_main_t * im,
 188                     uword opaque,
 189                     u32 sw_if_index, u32 new_fib_index, u32 old_fib_index)
 190 {
 191   svs_table_bind (FIB_PROTOCOL_IP4, sw_if_index, new_fib_index);
 192 }
 193
 194 int
 195 svs_disable (fib_protocol_t fproto, u32 table_id, u32 sw_if_index)
 196 {
 197   fib_prefix_t pfx = {
 198     .fp_proto = fproto,
 199   };
 200   u32 fib_index;
 201
 202   fib_index = fib_table_find (fproto, table_id);
 203
 204   if (~0 == fib_index)
 205     return VNET_API_ERROR_NO_SUCH_FIB;
 206
 207   if (sw_if_index >= vec_len (svs_itf_db[fproto]))
 208     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
 209
 210   svs_itf_db[fproto][sw_if_index] = ~0;
 211
 212   vnet_feature_enable_disable ((FIB_PROTOCOL_IP4 == fproto ?
 213                                 "ip4-unicast" :
 214                                 "ip6-unicast"),
 215                                (FIB_PROTOCOL_IP4 == fproto ?
 216                                 "svs-ip4" :
 217                                 "svs-ip6"), sw_if_index, 0, NULL, 0);
 218
 219   fib_table_entry_special_remove (fib_index, &pfx, svs_fib_src);
 220
 221   return (0);
 222 }
 223
 224 void
 225 svs_walk (svs_walk_fn_t fn, void *ctx)
 226 {
 227   fib_protocol_t fproto;
 228   u32 ii, fib_index;
 229
 230   FOR_EACH_FIB_IP_PROTOCOL (fproto)
 231   {
 232     vec_foreach_index (ii, svs_itf_db[fproto])
 233     {
 234       fib_index = svs_itf_db[fproto][ii];
 235
 236       if (~0 != fib_index)
 237         {
 238           if (WALK_CONTINUE != fn (fproto,
 239                                    fib_table_get_table_id (fib_index, fproto),
 240                                    ii, ctx))
 241             return;
 242         }
 243     }
 244   }
 245 }
 246
 247 typedef enum svs_next_t_
 248 {
 249   SVS_NEXT_DROP,
 250   SVS_N_NEXT,
 251 } svs_next_t;
 252
 253 typedef struct svs_input_trace_t_
 254 {
 255   u32 fib_index;
 256 } svs_input_trace_t;
 257
 258 always_inline uword
 259 svs_input_inline (vlib_main_t * vm,
 260                   vlib_node_runtime_t * node,
 261                   vlib_frame_t * frame, fib_protocol_t fproto)
 262 {
 263   u32 n_left_from, *from, *to_next, next_index;
 264
 265   from = vlib_frame_vector_args (frame);
 266   n_left_from = frame->n_vectors;
 267   next_index = node->cached_next_index;
 268
 269   while (n_left_from > 0)
 270     {
 271       u32 n_left_to_next;
 272
 273       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 274
 275       while (n_left_from > 0 && n_left_to_next > 0)
 276         {
 277           const load_balance_t *lb0;
 278           const lookup_dpo_t *lk0;
 279           u32 bi0, sw_if_index0;
 280           const dpo_id_t *dpo0;
 281           vlib_buffer_t *b0;
 282           svs_next_t next0;
 283           index_t lbi0;
 284
 285           bi0 = from[0];
 286           to_next[0] = bi0;
 287           from += 1;
 288           to_next += 1;
 289           n_left_from -= 1;
 290           n_left_to_next -= 1;
 291
 292           b0 = vlib_get_buffer (vm, bi0);
 293           sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
 294
 295           if (FIB_PROTOCOL_IP4 == fproto)
 296             {
 297               ip4_header_t *ip0;
 298
 299               ip0 = vlib_buffer_get_current (b0);
 300               lbi0 =
 301                 ip4_fib_forwarding_lookup (svs_itf_db[fproto][sw_if_index0],
 302                                            &ip0->src_address);
 303             }
 304           else
 305             {
 306               ip6_header_t *ip0;
 307
 308               ip0 = vlib_buffer_get_current (b0);
 309               lbi0 = ip6_fib_table_fwding_lookup (svs_itf_db[fproto]
 310                                                   [sw_if_index0],
 311                                                   &ip0->src_address);
 312             }
 313           lb0 = load_balance_get (lbi0);
 314           dpo0 = load_balance_get_fwd_bucket (lb0, 0);
 315           lk0 = lookup_dpo_get (dpo0->dpoi_index);
 316
 317           vnet_buffer (b0)->sw_if_index[VLIB_TX] = lk0->lkd_fib_index;
 318
 319           vnet_feature_next (&next0, b0);
 320
 321           if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
 322             {
 323               svs_input_trace_t *tr;
 324
 325               tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
 326               tr->fib_index = vnet_buffer (b0)->sw_if_index[VLIB_TX];
 327             }
 328
 329           /* verify speculative enqueue, maybe switch current next frame */
 330           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 331                                            to_next, n_left_to_next, bi0,
 332                                            next0);
 333         }
 334
 335       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 336     }
 337
 338   return frame->n_vectors;
 339 }
 340
 341 static uword
 342 svs_input_ip4 (vlib_main_t * vm,
 343                vlib_node_runtime_t * node, vlib_frame_t * frame)
 344 {
 345   return svs_input_inline (vm, node, frame, FIB_PROTOCOL_IP4);
 346 }
 347
 348 static uword
 349 svs_input_ip6 (vlib_main_t * vm,
 350                vlib_node_runtime_t * node, vlib_frame_t * frame)
 351 {
 352   return svs_input_inline (vm, node, frame, FIB_PROTOCOL_IP6);
 353 }
 354
 355 static u8 *
 356 format_svs_input_trace (u8 * s, va_list * args)
 357 {
 358   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
 359   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
 360   svs_input_trace_t *t = va_arg (*args, svs_input_trace_t *);
 361
 362   s = format (s, " fib_index %d", t->fib_index);
 363   return s;
 364 }
 365
 366 VLIB_REGISTER_NODE (svs_ip4_node) =
 367 {
 368   .function = svs_input_ip4,
 369   .name = "svs-ip4",
 370   .vector_size = sizeof (u32),
 371   .format_trace = format_svs_input_trace,
 372   .type = VLIB_NODE_TYPE_INTERNAL,
 373   .n_next_nodes = SVS_N_NEXT,
 374   .next_nodes =
 375   {
 376     [SVS_NEXT_DROP] = "error-drop",
 377   }
 378 };
 379
 380 VLIB_REGISTER_NODE (svs_ip6_node) =
 381 {
 382   .function = svs_input_ip6,
 383   .name = "svs-ip6",
 384   .vector_size = sizeof (u32),
 385   .format_trace = format_svs_input_trace,
 386   .type = VLIB_NODE_TYPE_INTERNAL,
 387   .next_nodes =
 388   {
 389     [SVS_NEXT_DROP] = "error-drop",
 390   }
 391 };
 392
 393 VNET_FEATURE_INIT (svs_ip4_feat, static) =
 394 {
 395   .arc_name = "ip4-unicast",
 396   .node_name = "svs-ip4",
 397 };
 398
 399 VNET_FEATURE_INIT (svs_ip6_feat, static) =
 400 {
 401   .arc_name = "ip6-unicast",
 402   .node_name = "svs-ip6",
 403 };
 404
 405 static clib_error_t *
 406 svs_table_cli (vlib_main_t * vm,
 407                unformat_input_t * input, vlib_cli_command_t * cmd)
 408 {
 409   fib_protocol_t fproto;
 410   u32 table_id;
 411   u8 add;
 412
 413   fproto = FIB_PROTOCOL_IP4;
 414   table_id = ~0;
 415   add = 1;
 416
 417   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 418     {
 419       if (unformat (input, "add"))
 420         add = 1;
 421       else if (unformat (input, "del"))
 422         add = 0;
 423       else if (unformat (input, "ip4"))
 424         fproto = FIB_PROTOCOL_IP4;
 425       else if (unformat (input, "ip6"))
 426         fproto = FIB_PROTOCOL_IP6;
 427       else if (unformat (input, "table-id %d", &table_id))
 428         ;
 429       else
 430         break;
 431     }
 432
 433   if (~0 == table_id)
 434     return clib_error_return (0, "table-id must be specified");
 435
 436   if (add)
 437     svs_table_add (fproto, table_id);
 438   else
 439     svs_table_delete (fproto, table_id);
 440
 441   return (NULL);
 442 }
 443
 444 VLIB_CLI_COMMAND (svs_table_cmd_cli, static) = {
 445     .path = "svs table",
 446     .short_help = "Source VRF select table [add|delete] [ip4|ip6] table-id X",
 447     .function = svs_table_cli,
 448 };
 449
 450 static clib_error_t *
 451 svs_enable_cli (vlib_main_t * vm,
 452                 unformat_input_t * input, vlib_cli_command_t * cmd)
 453 {
 454   u32 sw_if_index, table_id;
 455   fib_protocol_t fproto;
 456   vnet_main_t *vnm;
 457   u8 enable;
 458
 459   vnm = vnet_get_main ();
 460   sw_if_index = table_id = ~0;
 461   fproto = FIB_PROTOCOL_IP4;
 462   enable = 1;
 463
 464   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 465     {
 466       if (unformat (input, "%U", unformat_vnet_sw_interface,
 467                     vnm, &sw_if_index))
 468         ;
 469       else if (unformat (input, "enable"))
 470         enable = 1;
 471       else if (unformat (input, "disable"))
 472         enable = 0;
 473       else if (unformat (input, "ip4"))
 474         fproto = FIB_PROTOCOL_IP4;
 475       else if (unformat (input, "ip6"))
 476         fproto = FIB_PROTOCOL_IP6;
 477       else if (unformat (input, "table-id %d", &table_id))
 478         ;
 479       else
 480         break;
 481     }
 482
 483   if (~0 == sw_if_index)
 484     return clib_error_return (0, "interface must be specified");
 485   if (~0 == table_id)
 486     return clib_error_return (0, "table-id must be specified");
 487
 488   if (enable)
 489     svs_enable (fproto, table_id, sw_if_index);
 490   else
 491     svs_disable (fproto, table_id, sw_if_index);
 492
 493   return (NULL);
 494 }
 495
 496 VLIB_CLI_COMMAND (svs_enable_cli_cmd, static) = {
 497     .path = "svs enable",
 498     .short_help = "Source VRF select [enable|disable] [ip4|ip6] <table-id> X <interface>",
 499     .function = svs_enable_cli,
 500 };
 501
 502 static clib_error_t *
 503 svs_route_cli (vlib_main_t * vm,
 504                unformat_input_t * input, vlib_cli_command_t * cmd)
 505 {
 506   u32 table_id, src_table_id;
 507   fib_prefix_t pfx;
 508   int rv;
 509   u8 add;
 510
 511   src_table_id = table_id = ~0;
 512   add = 1;
 513
 514   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 515     {
 516       if (unformat (input, "add"))
 517         add = 1;
 518       else if (unformat (input, "del"))
 519         add = 0;
 520       else if (unformat (input, "table-id %d", &table_id))
 521         ;
 522       else if (unformat (input, "src-table-id %d", &src_table_id))
 523         ;
 524       else if (unformat (input, "%U/%d",
 525                          unformat_ip4_address, &pfx.fp_addr.ip4, &pfx.fp_len))
 526         {
 527           pfx.fp_proto = FIB_PROTOCOL_IP4;
 528         }
 529       else if (unformat (input, "%U/%d",
 530                          unformat_ip6_address, &pfx.fp_addr.ip6, &pfx.fp_len))
 531         {
 532           pfx.fp_proto = FIB_PROTOCOL_IP6;
 533         }
 534       else
 535         break;
 536     }
 537
 538   if (~0 == table_id)
 539     return clib_error_return (0, "table-id must be specified");
 540   if (~0 == src_table_id)
 541     return clib_error_return (0, "src-table-id must be specified");
 542
 543   if (add)
 544     rv = svs_route_add (table_id, &pfx, src_table_id);
 545   else
 546     rv = svs_route_delete (table_id, &pfx);
 547
 548   if (rv != 0)
 549     return clib_error_return (0,
 550                               "failed, rv=%d:%U",
 551                               (int) rv, format_vnet_api_errno, rv);
 552
 553   return (NULL);
 554 }
 555
 556 VLIB_CLI_COMMAND (svs_route_cmd_cli, static) = {
 557     .path = "svs route",
 558     .short_help = "Source VRF select route [add|delete] <table-id> <prefix> <src-table-id>",
 559     .function = svs_route_cli,
 560 };
 561
 562 static clib_error_t *
 563 svs_show_cli (vlib_main_t * vm,
 564               unformat_input_t * input, vlib_cli_command_t * cmd)
 565 {
 566   fib_protocol_t fproto;
 567   u32 ii;
 568
 569   vlib_cli_output (vm, "Source VRF select interface to fib-index mappings:");
 570   FOR_EACH_FIB_IP_PROTOCOL (fproto)
 571   {
 572     vlib_cli_output (vm, " %U", format_fib_protocol, fproto);
 573     vec_foreach_index (ii, svs_itf_db[fproto])
 574     {
 575       if (~0 != svs_itf_db[fproto][ii])
 576         vlib_cli_output (vm, "  %U -> %d", format_vnet_sw_if_index_name,
 577                          vnet_get_main (), ii, svs_itf_db[fproto][ii]);
 578     }
 579   }
 580   return (NULL);
 581 }
 582
 583 VLIB_CLI_COMMAND (svs_show_cli_cmd, static) = {
 584   .path = "show svs",
 585   .short_help = "Source VRF select show",
 586   .function = svs_show_cli,
 587 };
 588
 589 static clib_error_t *
 590 svs_init (vlib_main_t * vm)
 591 {
 592   ip6_table_bind_callback_t cbt6 = {
 593     .function = svs_ip6_table_bind,
 594   };
 595   vec_add1 (ip6_main.table_bind_callbacks, cbt6);
 596
 597   ip4_table_bind_callback_t cbt4 = {
 598     .function = svs_ip4_table_bind,
 599   };
 600   vec_add1 (ip4_main.table_bind_callbacks, cbt4);
 601
 602   svs_fib_src = fib_source_allocate ("svs",
 603                                      FIB_SOURCE_PRIORITY_LOW,
 604                                      FIB_SOURCE_BH_SIMPLE);
 605
 606   return (NULL);
 607 }
 608
 609 VLIB_INIT_FUNCTION (svs_init);
 610
 611 /*
 612  * fd.io coding-style-patch-verification: ON
 613  *
 614  * Local Variables:
 615  * eval: (c-set-style "gnu")
 616  * End:
 617  */