src/vnet/srv6/sr_steering.c

   1 /*
   2  * sr_steering.c: ipv6 segment routing steering into SR policy
   3  *
   4  * Copyright (c) 2016 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 /**
  19  * @file
  20  * @brief Packet steering into SR Policies
  21  *
  22  * This file is in charge of handling the FIB appropiatly to steer packets
  23  * through SR Policies as defined in 'sr_policy_rewrite.c'. Notice that here
  24  * we are only doing steering. SR policy application is done in
  25  * sr_policy_rewrite.c
  26  *
  27  * Supports:
  28  *  - Steering of IPv6 traffic Destination Address based
  29  *  - Steering of IPv4 traffic Destination Address based
  30  *  - Steering of L2 frames, interface based (sw interface)
  31  */
  32
  33 #include <vlib/vlib.h>
  34 #include <vnet/vnet.h>
  35 #include <vnet/srv6/sr.h>
  36 #include <vnet/ip/ip.h>
  37 #include <vnet/srv6/sr_packet.h>
  38 #include <vnet/ip/ip6_packet.h>
  39 #include <vnet/fib/ip6_fib.h>
  40 #include <vnet/dpo/dpo.h>
  41
  42 #include <vppinfra/error.h>
  43 #include <vppinfra/elog.h>
  44
  45 /**
  46  * @brief Steer traffic L2 and L3 traffic through a given SR policy
  47  *
  48  * @param is_del
  49  * @param bsid is the bindingSID of the SR Policy (alt to sr_policy_index)
  50  * @param sr_policy is the index of the SR Policy (alt to bsid)
  51  * @param table_id is the VRF where to install the FIB entry for the BSID
  52  * @param prefix is the IPv4/v6 address for L3 traffic type
  53  * @param mask_width is the mask for L3 traffic type
  54  * @param sw_if_index is the incoming interface for L2 traffic
  55  * @param traffic_type describes the type of traffic
  56  *
  57  * @return 0 if correct, else error
  58  */
  59 int
  60 sr_steering_policy (int is_del, ip6_address_t * bsid, u32 sr_policy_index,
  61                     u32 table_id, ip46_address_t * prefix, u32 mask_width,
  62                     u32 sw_if_index, u8 traffic_type)
  63 {
  64   ip6_sr_main_t *sm = &sr_main;
  65   sr_steering_key_t key;
  66   ip6_sr_steering_policy_t *steer_pl;
  67   fib_prefix_t pfx = { 0 };
  68
  69   ip6_sr_policy_t *sr_policy = 0;
  70   uword *p = 0;
  71
  72   memset (&key, 0, sizeof (sr_steering_key_t));
  73
  74   /* Compute the steer policy key */
  75   if (traffic_type == SR_STEER_IPV4 || traffic_type == SR_STEER_IPV6)
  76     {
  77       key.l3.prefix.as_u64[0] = prefix->as_u64[0];
  78       key.l3.prefix.as_u64[1] = prefix->as_u64[1];
  79       key.l3.mask_width = mask_width;
  80       key.l3.fib_table = (table_id != (u32) ~ 0 ? table_id : 0);
  81     }
  82   else if (traffic_type == SR_STEER_L2)
  83     {
  84       key.l2.sw_if_index = sw_if_index;
  85
  86       /* Sanitise the SW_IF_INDEX */
  87       if (pool_is_free_index (sm->vnet_main->interface_main.sw_interfaces,
  88                               sw_if_index))
  89         return -3;
  90
  91       vnet_sw_interface_t *sw =
  92         vnet_get_sw_interface (sm->vnet_main, sw_if_index);
  93       if (sw->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
  94         return -3;
  95     }
  96   else
  97     return -1;
  98
  99   key.traffic_type = traffic_type;
 100
 101   /* Search for the item */
 102   p = mhash_get (&sm->sr_steer_policies_hash, &key);
 103
 104   if (p)
 105     {
 106       /* Retrieve Steer Policy function */
 107       steer_pl = pool_elt_at_index (sm->steer_policies, p[0]);
 108
 109       if (is_del)
 110         {
 111           if (steer_pl->classify.traffic_type == SR_STEER_IPV6)
 112             {
 113               /* Remove FIB entry */
 114               pfx.fp_proto = FIB_PROTOCOL_IP6;
 115               pfx.fp_len = steer_pl->classify.l3.mask_width;
 116               pfx.fp_addr.ip6 = steer_pl->classify.l3.prefix.ip6;
 117
 118               fib_table_entry_delete (fib_table_find
 119                                       (FIB_PROTOCOL_IP6,
 120                                        steer_pl->classify.l3.fib_table),
 121                                       &pfx, FIB_SOURCE_SR);
 122             }
 123           else if (steer_pl->classify.traffic_type == SR_STEER_IPV4)
 124             {
 125               /* Remove FIB entry */
 126               pfx.fp_proto = FIB_PROTOCOL_IP4;
 127               pfx.fp_len = steer_pl->classify.l3.mask_width;
 128               pfx.fp_addr.ip4 = steer_pl->classify.l3.prefix.ip4;
 129
 130               fib_table_entry_delete (fib_table_find
 131                                       (FIB_PROTOCOL_IP4,
 132                                        steer_pl->classify.l3.fib_table), &pfx,
 133                                       FIB_SOURCE_SR);
 134             }
 135           else if (steer_pl->classify.traffic_type == SR_STEER_L2)
 136             {
 137               /* Remove HW redirection */
 138               vnet_feature_enable_disable ("device-input",
 139                                            "sr-policy-rewrite-encaps-l2",
 140                                            sw_if_index, 0, 0, 0);
 141               sm->sw_iface_sr_policies[sw_if_index] = ~(u32) 0;
 142
 143               /* Remove promiscous mode from interface */
 144               vnet_main_t *vnm = vnet_get_main ();
 145               ethernet_main_t *em = &ethernet_main;
 146               ethernet_interface_t *eif =
 147                 ethernet_get_interface (em, sw_if_index);
 148
 149               if (!eif)
 150                 goto cleanup_error_redirection;
 151
 152               ethernet_set_flags (vnm, sw_if_index, 0);
 153             }
 154
 155           /* Delete SR steering policy entry */
 156           pool_put (sm->steer_policies, steer_pl);
 157           mhash_unset (&sm->sr_steer_policies_hash, &key, NULL);
 158
 159           /* If no more SR policies or steering policies */
 160           if (!pool_elts (sm->sr_policies) && !pool_elts (sm->steer_policies))
 161             {
 162               fib_table_unlock (sm->fib_table_ip6,
 163                                 FIB_PROTOCOL_IP6, FIB_SOURCE_SR);
 164               fib_table_unlock (sm->fib_table_ip4,
 165                                 FIB_PROTOCOL_IP6, FIB_SOURCE_SR);
 166               sm->fib_table_ip6 = (u32) ~ 0;
 167               sm->fib_table_ip4 = (u32) ~ 0;
 168             }
 169
 170           return 0;
 171         }
 172       else                      /* It means user requested to update an existing SR steering policy */
 173         {
 174           /* Retrieve SR steering policy */
 175           if (bsid)
 176             {
 177               p = mhash_get (&sm->sr_policies_index_hash, bsid);
 178               if (p)
 179                 sr_policy = pool_elt_at_index (sm->sr_policies, p[0]);
 180               else
 181                 return -2;
 182             }
 183           else
 184             sr_policy = pool_elt_at_index (sm->sr_policies, sr_policy_index);
 185
 186           if (!sr_policy)
 187             return -2;
 188
 189           steer_pl->sr_policy = sr_policy - sm->sr_policies;
 190
 191           /* Remove old FIB/hw redirection and create a new one */
 192           if (steer_pl->classify.traffic_type == SR_STEER_IPV6)
 193             {
 194               /* Remove FIB entry */
 195               pfx.fp_proto = FIB_PROTOCOL_IP6;
 196               pfx.fp_len = steer_pl->classify.l3.mask_width;
 197               pfx.fp_addr.ip6 = steer_pl->classify.l3.prefix.ip6;
 198
 199               fib_table_entry_delete (fib_table_find
 200                                       (FIB_PROTOCOL_IP6,
 201                                        steer_pl->classify.l3.fib_table),
 202                                       &pfx, FIB_SOURCE_SR);
 203
 204               /* Create a new one */
 205               goto update_fib;
 206             }
 207           else if (steer_pl->classify.traffic_type == SR_STEER_IPV4)
 208             {
 209               /* Remove FIB entry */
 210               pfx.fp_proto = FIB_PROTOCOL_IP4;
 211               pfx.fp_len = steer_pl->classify.l3.mask_width;
 212               pfx.fp_addr.ip4 = steer_pl->classify.l3.prefix.ip4;
 213
 214               fib_table_entry_delete (fib_table_find
 215                                       (FIB_PROTOCOL_IP4,
 216                                        steer_pl->classify.l3.fib_table),
 217                                       &pfx, FIB_SOURCE_SR);
 218
 219               /* Create a new one */
 220               goto update_fib;
 221             }
 222           else if (steer_pl->classify.traffic_type == SR_STEER_L2)
 223             {
 224               /* Update L2-HW redirection */
 225               goto update_fib;
 226             }
 227         }
 228     }
 229   else
 230     /* delete; steering policy does not exist; complain */
 231   if (is_del)
 232     return -4;
 233
 234   /* Retrieve SR policy */
 235   if (bsid)
 236     {
 237       p = mhash_get (&sm->sr_policies_index_hash, bsid);
 238       if (p)
 239         sr_policy = pool_elt_at_index (sm->sr_policies, p[0]);
 240       else
 241         return -2;
 242     }
 243   else
 244     sr_policy = pool_elt_at_index (sm->sr_policies, sr_policy_index);
 245
 246   /* Create a new steering policy */
 247   pool_get (sm->steer_policies, steer_pl);
 248   memset (steer_pl, 0, sizeof (*steer_pl));
 249
 250   if (traffic_type == SR_STEER_IPV4 || traffic_type == SR_STEER_IPV6)
 251     {
 252       clib_memcpy (&steer_pl->classify.l3.prefix, prefix,
 253                    sizeof (ip46_address_t));
 254       steer_pl->classify.l3.mask_width = mask_width;
 255       steer_pl->classify.l3.fib_table =
 256         (table_id != (u32) ~ 0 ? table_id : 0);
 257       steer_pl->classify.traffic_type = traffic_type;
 258     }
 259   else if (traffic_type == SR_STEER_L2)
 260     {
 261       steer_pl->classify.l2.sw_if_index = sw_if_index;
 262       steer_pl->classify.traffic_type = traffic_type;
 263     }
 264   else
 265     {
 266       /* Incorrect API usage. Should never get here */
 267       pool_put (sm->steer_policies, steer_pl);
 268       mhash_unset (&sm->sr_steer_policies_hash, &key, NULL);
 269       return -1;
 270     }
 271   steer_pl->sr_policy = sr_policy - sm->sr_policies;
 272
 273   /* Create and store key */
 274   mhash_set (&sm->sr_steer_policies_hash, &key, steer_pl - sm->steer_policies,
 275              NULL);
 276
 277   if (traffic_type == SR_STEER_L2)
 278     {
 279       if (!sr_policy->is_encap)
 280         goto cleanup_error_encap;
 281
 282       if (vnet_feature_enable_disable
 283           ("device-input", "sr-pl-rewrite-encaps-l2", sw_if_index, 1, 0, 0))
 284         goto cleanup_error_redirection;
 285
 286       /* Set promiscous mode on interface */
 287       vnet_main_t *vnm = vnet_get_main ();
 288       ethernet_main_t *em = &ethernet_main;
 289       ethernet_interface_t *eif = ethernet_get_interface (em, sw_if_index);
 290
 291       if (!eif)
 292         goto cleanup_error_redirection;
 293
 294       ethernet_set_flags (vnm, sw_if_index,
 295                           ETHERNET_INTERFACE_FLAG_ACCEPT_ALL);
 296     }
 297   else if (traffic_type == SR_STEER_IPV4)
 298     if (!sr_policy->is_encap)
 299       goto cleanup_error_encap;
 300
 301 update_fib:
 302   /* FIB API calls - Recursive route through the BindingSID */
 303   if (traffic_type == SR_STEER_IPV6)
 304     {
 305       pfx.fp_proto = FIB_PROTOCOL_IP6;
 306       pfx.fp_len = steer_pl->classify.l3.mask_width;
 307       pfx.fp_addr.ip6 = steer_pl->classify.l3.prefix.ip6;
 308
 309       fib_table_entry_path_add (fib_table_find (FIB_PROTOCOL_IP6,
 310                                                 (table_id !=
 311                                                  (u32) ~ 0 ?
 312                                                  table_id : 0)),
 313                                 &pfx, FIB_SOURCE_SR,
 314                                 FIB_ENTRY_FLAG_LOOSE_URPF_EXEMPT,
 315                                 DPO_PROTO_IP6,
 316                                 (ip46_address_t *) & sr_policy->bsid, ~0,
 317                                 sm->fib_table_ip6, 1, NULL,
 318                                 FIB_ROUTE_PATH_FLAG_NONE);
 319     }
 320   else if (traffic_type == SR_STEER_IPV4)
 321     {
 322       pfx.fp_proto = FIB_PROTOCOL_IP4;
 323       pfx.fp_len = steer_pl->classify.l3.mask_width;
 324       pfx.fp_addr.ip4 = steer_pl->classify.l3.prefix.ip4;
 325
 326       fib_table_entry_path_add (fib_table_find (FIB_PROTOCOL_IP4,
 327                                                 (table_id !=
 328                                                  (u32) ~ 0 ?
 329                                                  table_id : 0)),
 330                                 &pfx, FIB_SOURCE_SR,
 331                                 FIB_ENTRY_FLAG_LOOSE_URPF_EXEMPT,
 332                                 DPO_PROTO_IP6,
 333                                 (ip46_address_t *) & sr_policy->bsid, ~0,
 334                                 sm->fib_table_ip4, 1, NULL,
 335                                 FIB_ROUTE_PATH_FLAG_NONE);
 336     }
 337   else if (traffic_type == SR_STEER_L2)
 338     {
 339       if (sw_if_index < vec_len (sm->sw_iface_sr_policies))
 340         sm->sw_iface_sr_policies[sw_if_index] = steer_pl->sr_policy;
 341       else
 342         {
 343           vec_resize (sm->sw_iface_sr_policies,
 344                       (pool_len (sm->vnet_main->interface_main.sw_interfaces)
 345                        - vec_len (sm->sw_iface_sr_policies)));
 346           sm->sw_iface_sr_policies[sw_if_index] = steer_pl->sr_policy;
 347         }
 348     }
 349
 350   return 0;
 351
 352 cleanup_error_encap:
 353   pool_put (sm->steer_policies, steer_pl);
 354   mhash_unset (&sm->sr_steer_policies_hash, &key, NULL);
 355   return -5;
 356
 357 cleanup_error_redirection:
 358   pool_put (sm->steer_policies, steer_pl);
 359   mhash_unset (&sm->sr_steer_policies_hash, &key, NULL);
 360   return -3;
 361 }
 362
 363 static clib_error_t *
 364 sr_steer_policy_command_fn (vlib_main_t * vm, unformat_input_t * input,
 365                             vlib_cli_command_t * cmd)
 366 {
 367   vnet_main_t *vnm = vnet_get_main ();
 368
 369   int is_del = 0;
 370
 371   ip46_address_t prefix;
 372   u32 dst_mask_width = 0;
 373   u32 sw_if_index = (u32) ~ 0;
 374   u8 traffic_type = 0;
 375   u32 fib_table = (u32) ~ 0;
 376
 377   ip6_address_t bsid;
 378   u32 sr_policy_index = (u32) ~ 0;
 379
 380   u8 sr_policy_set = 0;
 381
 382   memset (&prefix, 0, sizeof (ip46_address_t));
 383
 384   int rv;
 385   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 386     {
 387       if (unformat (input, "del"))
 388         is_del = 1;
 389       else if (!traffic_type
 390                && unformat (input, "l3 %U/%d", unformat_ip6_address,
 391                             &prefix.ip6, &dst_mask_width))
 392         traffic_type = SR_STEER_IPV6;
 393       else if (!traffic_type
 394                && unformat (input, "l3 %U/%d", unformat_ip4_address,
 395                             &prefix.ip4, &dst_mask_width))
 396         traffic_type = SR_STEER_IPV4;
 397       else if (!traffic_type
 398                && unformat (input, "l2 %U", unformat_vnet_sw_interface, vnm,
 399                             &sw_if_index))
 400         traffic_type = SR_STEER_L2;
 401       else if (!sr_policy_set
 402                && unformat (input, "via sr policy index %d",
 403                             &sr_policy_index))
 404         sr_policy_set = 1;
 405       else if (!sr_policy_set
 406                && unformat (input, "via sr policy bsid %U",
 407                             unformat_ip6_address, &bsid))
 408         sr_policy_set = 1;
 409       else if (fib_table == (u32) ~ 0
 410                && unformat (input, "fib-table %d", &fib_table));
 411       else
 412         break;
 413     }
 414
 415   if (!traffic_type)
 416     return clib_error_return (0, "No L2/L3 traffic specified");
 417   if (!sr_policy_set)
 418     return clib_error_return (0, "No SR policy specified");
 419
 420   /* Make sure that the prefixes are clean */
 421   if (traffic_type == SR_STEER_IPV4)
 422     {
 423       u32 mask =
 424         (dst_mask_width ? (0xFFFFFFFFu >> (32 - dst_mask_width)) : 0);
 425       prefix.ip4.as_u32 &= mask;
 426     }
 427   else if (traffic_type == SR_STEER_IPV6)
 428     {
 429       ip6_address_t mask;
 430       ip6_address_mask_from_width (&mask, dst_mask_width);
 431       ip6_address_mask (&prefix.ip6, &mask);
 432     }
 433
 434   rv =
 435     sr_steering_policy (is_del, (sr_policy_index == ~(u32) 0 ? &bsid : NULL),
 436                         sr_policy_index, fib_table, &prefix, dst_mask_width,
 437                         sw_if_index, traffic_type);
 438
 439   switch (rv)
 440     {
 441     case 0:
 442       break;
 443     case 1:
 444       return 0;
 445     case -1:
 446       return clib_error_return (0, "Incorrect API usage.");
 447     case -2:
 448       return clib_error_return (0,
 449                                 "The requested SR policy could not be located. Review the BSID/index.");
 450     case -3:
 451       return clib_error_return (0,
 452                                 "Unable to do SW redirect. Incorrect interface.");
 453     case -4:
 454       return clib_error_return (0,
 455                                 "The requested SR steering policy could not be deleted.");
 456     case -5:
 457       return clib_error_return (0,
 458                                 "The SR policy is not an encapsulation one.");
 459     default:
 460       return clib_error_return (0, "BUG: sr steer policy returns %d", rv);
 461     }
 462   return 0;
 463 }
 464
 465 /* *INDENT-OFF* */
 466 VLIB_CLI_COMMAND (sr_steer_policy_command, static) = {
 467   .path = "sr steer",
 468   .short_help = "sr steer (del) [l3 <ip_addr/mask>|l2 <sf_if>]"
 469     "via sr policy [index <sr_policy_index>|bsid <bsid_ip6_addr>]"
 470     "(fib-table <fib_table_index>)",
 471   .long_help =
 472     "\tSteer a L2 or L3 traffic through an existing SR policy.\n"
 473     "\tExamples:\n"
 474     "\t\tsr steer l3 2001::/64 via sr_policy index 5\n"
 475     "\t\tsr steer l3 2001::/64 via sr_policy bsid 2010::9999:1\n"
 476     "\t\tsr steer l2 GigabitEthernet0/5/0 via sr_policy index 5\n"
 477     "\t\tsr steer del l3 2001::/64 via sr_policy index 5\n",
 478   .function = sr_steer_policy_command_fn,
 479 };
 480 /* *INDENT-ON* */
 481
 482 static clib_error_t *
 483 show_sr_steering_policies_command_fn (vlib_main_t * vm,
 484                                       unformat_input_t * input,
 485                                       vlib_cli_command_t * cmd)
 486 {
 487   ip6_sr_main_t *sm = &sr_main;
 488   ip6_sr_steering_policy_t **steer_policies = 0;
 489   ip6_sr_steering_policy_t *steer_pl;
 490
 491   vnet_main_t *vnm = vnet_get_main ();
 492
 493   ip6_sr_policy_t *pl = 0;
 494   int i;
 495
 496   vlib_cli_output (vm, "SR steering policies:");
 497   /* *INDENT-OFF* */
 498   pool_foreach (steer_pl, sm->steer_policies, ({vec_add1(steer_policies, steer_pl);}));
 499   /* *INDENT-ON* */
 500   vlib_cli_output (vm, "Traffic\t\tSR policy BSID");
 501   for (i = 0; i < vec_len (steer_policies); i++)
 502     {
 503       steer_pl = steer_policies[i];
 504       pl = pool_elt_at_index (sm->sr_policies, steer_pl->sr_policy);
 505       if (steer_pl->classify.traffic_type == SR_STEER_L2)
 506         {
 507           vlib_cli_output (vm, "L2 %U\t%U",
 508                            format_vnet_sw_if_index_name, vnm,
 509                            steer_pl->classify.l2.sw_if_index,
 510                            format_ip6_address, &pl->bsid);
 511         }
 512       else if (steer_pl->classify.traffic_type == SR_STEER_IPV4)
 513         {
 514           vlib_cli_output (vm, "L3 %U/%d\t%U",
 515                            format_ip4_address,
 516                            &steer_pl->classify.l3.prefix.ip4,
 517                            steer_pl->classify.l3.mask_width,
 518                            format_ip6_address, &pl->bsid);
 519         }
 520       else if (steer_pl->classify.traffic_type == SR_STEER_IPV6)
 521         {
 522           vlib_cli_output (vm, "L3 %U/%d\t%U",
 523                            format_ip6_address,
 524                            &steer_pl->classify.l3.prefix.ip6,
 525                            steer_pl->classify.l3.mask_width,
 526                            format_ip6_address, &pl->bsid);
 527         }
 528     }
 529   return 0;
 530 }
 531
 532 /* *INDENT-OFF* */
 533 VLIB_CLI_COMMAND (show_sr_steering_policies_command, static) = {
 534   .path = "show sr steering policies",
 535   .short_help = "show sr steering policies",
 536   .function = show_sr_steering_policies_command_fn,
 537 };
 538 /* *INDENT-ON* */
 539
 540 clib_error_t *
 541 sr_steering_init (vlib_main_t * vm)
 542 {
 543   ip6_sr_main_t *sm = &sr_main;
 544
 545   /* Init memory for function keys */
 546   mhash_init (&sm->sr_steer_policies_hash, sizeof (uword),
 547               sizeof (sr_steering_key_t));
 548
 549   sm->sw_iface_sr_policies = 0;
 550
 551   sm->vnet_main = vnet_get_main ();
 552
 553   return 0;
 554 }
 555
 556 /* *INDENT-OFF* */
 557 VLIB_INIT_FUNCTION (sr_steering_init);
 558 /* *INDENT-ON* */
 559
 560 /* *INDENT-OFF* */
 561 VNET_FEATURE_INIT (sr_pl_rewrite_encaps_l2, static) =
 562 {
 563   .arc_name = "device-input",
 564   .node_name = "sr-pl-rewrite-encaps-l2",
 565   .runs_before = VNET_FEATURES ("ethernet-input"),
 566 };
 567 /* *INDENT-ON* */
 568
 569 /*
 570 * fd.io coding-style-patch-verification: ON
 571 *
 572 * Local Variables:
 573 * eval: (c-set-style "gnu")
 574 * End:
 575 */