src/vnet/dpo/dpo.c

   1 /*
   2  * Copyright (c) 2016 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  * @brief
  17  * A Data-Path Object is an object that represents actions that are
  18  * applied to packets are they are switched through VPP.
  19  *
  20  * The DPO is a base class that is specialised by other objects to provide
  21  * concrete actions
  22  *
  23  * The VLIB graph nodes are graph of types, the DPO graph is a graph of instances.
  24  */
  25
  26 #include <vnet/dpo/dpo.h>
  27 #include <vnet/ip/lookup.h>
  28 #include <vnet/ip/format.h>
  29 #include <vnet/adj/adj.h>
  30
  31 #include <vnet/dpo/load_balance.h>
  32 #include <vnet/dpo/mpls_label_dpo.h>
  33 #include <vnet/dpo/lookup_dpo.h>
  34 #include <vnet/dpo/drop_dpo.h>
  35 #include <vnet/dpo/receive_dpo.h>
  36 #include <vnet/dpo/punt_dpo.h>
  37 #include <vnet/dpo/classify_dpo.h>
  38 #include <vnet/dpo/ip_null_dpo.h>
  39 #include <vnet/dpo/replicate_dpo.h>
  40 #include <vnet/dpo/interface_rx_dpo.h>
  41 #include <vnet/dpo/interface_tx_dpo.h>
  42 #include <vnet/dpo/mpls_disposition.h>
  43 #include <vnet/dpo/dvr_dpo.h>
  44 #include <vnet/dpo/l3_proxy_dpo.h>
  45 #include <vnet/dpo/ip6_ll_dpo.h>
  46 #include <vnet/dpo/pw_cw.h>
  47
  48 /**
  49  * Array of char* names for the DPO types and protos
  50  */
  51 static const char* dpo_type_names[] = DPO_TYPES;
  52 static const char* dpo_proto_names[] = DPO_PROTOS;
  53
  54 /**
  55  * @brief Vector of virtual function tables for the DPO types
  56  *
  57  * This is a vector so we can dynamically register new DPO types in plugins.
  58  */
  59 static dpo_vft_t *dpo_vfts;
  60
  61 /**
  62  * @brief vector of graph node names associated with each DPO type and protocol.
  63  *
  64  *   dpo_nodes[child_type][child_proto][node_X] = node_name;
  65  * i.e.
  66  *   dpo_node[DPO_LOAD_BALANCE][DPO_PROTO_IP4][0] = "ip4-lookup"
  67  *   dpo_node[DPO_LOAD_BALANCE][DPO_PROTO_IP4][1] = "ip4-load-balance"
  68  *
  69  * This is a vector so we can dynamically register new DPO types in plugins.
  70  */
  71 static const char* const * const ** dpo_nodes;
  72
  73 /**
  74  * @brief Vector of edge indicies from parent DPO nodes to child
  75  *
  76  * dpo_edges[child_type][child_proto][parent_type][parent_proto] = edge_index
  77  *
  78  * This array is derived at init time from the dpo_nodes above. Note that
  79  * the third dimension in dpo_nodes is lost, hence, the edge index from each
  80  * node MUST be the same.
  81  * Including both the child and parent protocol is required to support the
  82  * case where it changes as the graph is traversed, most notably when an
  83  * MPLS label is popped.
  84  *
  85  * Note that this array is child type specific, not child instance specific.
  86  */
  87 static u32 ****dpo_edges;
  88
  89 /**
  90  * @brief The DPO type value that can be assigned to the next dynamic
  91  *        type registration.
  92  */
  93 static dpo_type_t dpo_dynamic = DPO_LAST;
  94
  95 dpo_proto_t
  96 vnet_link_to_dpo_proto (vnet_link_t linkt)
  97 {
  98     switch (linkt)
  99     {
 100     case VNET_LINK_IP6:
 101         return (DPO_PROTO_IP6);
 102     case VNET_LINK_IP4:
 103         return (DPO_PROTO_IP4);
 104     case VNET_LINK_MPLS:
 105         return (DPO_PROTO_MPLS);
 106     case VNET_LINK_ETHERNET:
 107         return (DPO_PROTO_ETHERNET);
 108     case VNET_LINK_NSH:
 109         return (DPO_PROTO_NSH);
 110     case VNET_LINK_ARP:
 111         break;
 112     }
 113     ASSERT(0);
 114     return (0);
 115 }
 116
 117 vnet_link_t
 118 dpo_proto_to_link (dpo_proto_t dp)
 119 {
 120     switch (dp)
 121     {
 122     case DPO_PROTO_IP6:
 123         return (VNET_LINK_IP6);
 124     case DPO_PROTO_IP4:
 125         return (VNET_LINK_IP4);
 126     case DPO_PROTO_MPLS:
 127     case DPO_PROTO_BIER:
 128         return (VNET_LINK_MPLS);
 129     case DPO_PROTO_ETHERNET:
 130         return (VNET_LINK_ETHERNET);
 131     case DPO_PROTO_NSH:
 132         return (VNET_LINK_NSH);
 133     }
 134     return (~0);
 135 }
 136
 137 u8 *
 138 format_dpo_type (u8 * s, va_list * args)
 139 {
 140     dpo_type_t type = va_arg (*args, int);
 141
 142     s = format(s, "%s", dpo_type_names[type]);
 143
 144     return (s);
 145 }
 146
 147 u8 *
 148 format_dpo_id (u8 * s, va_list * args)
 149 {
 150     dpo_id_t *dpo = va_arg (*args, dpo_id_t*);
 151     u32 indent = va_arg (*args, u32);
 152
 153     s = format(s, "[@%d]: ", dpo->dpoi_next_node);
 154
 155     if (NULL != dpo_vfts[dpo->dpoi_type].dv_format)
 156     {
 157         s = format(s, "%U",
 158                    dpo_vfts[dpo->dpoi_type].dv_format,
 159                    dpo->dpoi_index,
 160                    indent);
 161     }
 162     else
 163     {
 164         switch (dpo->dpoi_type)
 165         {
 166         case DPO_FIRST:
 167             s = format(s, "unset");
 168             break;
 169         default:
 170             s = format(s, "unknown");
 171             break;
 172         }
 173     }
 174     return (s);
 175 }
 176
 177 u8 *
 178 format_dpo_proto (u8 * s, va_list * args)
 179 {
 180     dpo_proto_t proto = va_arg (*args, int);
 181
 182     return (format(s, "%s", dpo_proto_names[proto]));
 183 }
 184
 185 void
 186 dpo_set (dpo_id_t *dpo,
 187          dpo_type_t type,
 188          dpo_proto_t proto,
 189          index_t index)
 190 {
 191     dpo_id_t tmp = *dpo;
 192
 193     dpo->dpoi_type = type;
 194     dpo->dpoi_proto = proto,
 195     dpo->dpoi_index = index;
 196
 197     if (DPO_ADJACENCY == type)
 198     {
 199         /*
 200          * set the adj subtype
 201          */
 202         ip_adjacency_t *adj;
 203
 204         adj = adj_get(index);
 205
 206         switch (adj->lookup_next_index)
 207         {
 208         case IP_LOOKUP_NEXT_ARP:
 209             dpo->dpoi_type = DPO_ADJACENCY_INCOMPLETE;
 210             break;
 211         case IP_LOOKUP_NEXT_MIDCHAIN:
 212             dpo->dpoi_type = DPO_ADJACENCY_MIDCHAIN;
 213             break;
 214         case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
 215             dpo->dpoi_type = DPO_ADJACENCY_MCAST_MIDCHAIN;
 216             break;
 217         case IP_LOOKUP_NEXT_MCAST:
 218             dpo->dpoi_type = DPO_ADJACENCY_MCAST;
 219             break;
 220         case IP_LOOKUP_NEXT_GLEAN:
 221             dpo->dpoi_type = DPO_ADJACENCY_GLEAN;
 222             break;
 223         default:
 224             break;
 225         }
 226     }
 227     dpo_lock(dpo);
 228     dpo_unlock(&tmp);
 229 }
 230
 231 void
 232 dpo_reset (dpo_id_t *dpo)
 233 {
 234     dpo_id_t tmp = DPO_INVALID;
 235
 236     /*
 237      * use the atomic copy operation.
 238      */
 239     dpo_copy(dpo, &tmp);
 240 }
 241
 242 /**
 243  * \brief
 244  * Compare two Data-path objects
 245  *
 246  * like memcmp, return 0 is matching, !0 otherwise.
 247  */
 248 int
 249 dpo_cmp (const dpo_id_t *dpo1,
 250          const dpo_id_t *dpo2)
 251 {
 252     int res;
 253
 254     res = dpo1->dpoi_type - dpo2->dpoi_type;
 255
 256     if (0 != res) return (res);
 257
 258     return (dpo1->dpoi_index - dpo2->dpoi_index);
 259 }
 260
 261 void
 262 dpo_copy (dpo_id_t *dst,
 263           const dpo_id_t *src)
 264 {
 265     dpo_id_t tmp = *dst;
 266
 267     /*
 268      * the destination is written in a single u64 write - hence atomically w.r.t
 269      * any packets inflight.
 270      */
 271     *((u64*)dst) = *(u64*)src;
 272
 273     dpo_lock(dst);
 274     dpo_unlock(&tmp);
 275 }
 276
 277 int
 278 dpo_is_adj (const dpo_id_t *dpo)
 279 {
 280     return ((dpo->dpoi_type == DPO_ADJACENCY) ||
 281             (dpo->dpoi_type == DPO_ADJACENCY_INCOMPLETE) ||
 282             (dpo->dpoi_type == DPO_ADJACENCY_MIDCHAIN) ||
 283             (dpo->dpoi_type == DPO_ADJACENCY_GLEAN));
 284 }
 285
 286 static u32 *
 287 dpo_default_get_next_node (const dpo_id_t *dpo)
 288 {
 289     u32 *node_indices = NULL;
 290     const char *node_name;
 291     u32 ii = 0;
 292
 293     node_name = dpo_nodes[dpo->dpoi_type][dpo->dpoi_proto][ii];
 294     while (NULL != node_name)
 295     {
 296         vlib_node_t *node;
 297
 298         node = vlib_get_node_by_name(vlib_get_main(), (u8*) node_name);
 299         ASSERT(NULL != node);
 300         vec_add1(node_indices, node->index);
 301
 302         ++ii;
 303         node_name = dpo_nodes[dpo->dpoi_type][dpo->dpoi_proto][ii];
 304     }
 305
 306     return (node_indices);
 307 }
 308
 309 /**
 310  * A default variant of the make interpose function that just returns
 311  * the original
 312  */
 313 static void
 314 dpo_default_mk_interpose (const dpo_id_t *original,
 315                           const dpo_id_t *parent,
 316                           dpo_id_t *clone)
 317 {
 318     dpo_copy(clone, original);
 319 }
 320
 321 void
 322 dpo_register (dpo_type_t type,
 323               const dpo_vft_t *vft,
 324               const char * const * const * nodes)
 325 {
 326     vec_validate(dpo_vfts, type);
 327     dpo_vfts[type] = *vft;
 328     if (NULL == dpo_vfts[type].dv_get_next_node)
 329     {
 330         dpo_vfts[type].dv_get_next_node = dpo_default_get_next_node;
 331     }
 332     if (NULL == dpo_vfts[type].dv_mk_interpose)
 333     {
 334         dpo_vfts[type].dv_mk_interpose = dpo_default_mk_interpose;
 335     }
 336
 337     vec_validate(dpo_nodes, type);
 338     dpo_nodes[type] = nodes;
 339 }
 340
 341 dpo_type_t
 342 dpo_register_new_type (const dpo_vft_t *vft,
 343                        const char * const * const * nodes)
 344 {
 345     dpo_type_t type = dpo_dynamic++;
 346
 347     dpo_register(type, vft, nodes);
 348
 349     return (type);
 350 }
 351
 352 void
 353 dpo_mk_interpose (const dpo_id_t *original,
 354                   const dpo_id_t *parent,
 355                   dpo_id_t *clone)
 356 {
 357     if (!dpo_id_is_valid(original))
 358         return;
 359
 360     dpo_vfts[original->dpoi_type].dv_mk_interpose(original, parent, clone);
 361 }
 362
 363 void
 364 dpo_lock (dpo_id_t *dpo)
 365 {
 366     if (!dpo_id_is_valid(dpo))
 367         return;
 368
 369     dpo_vfts[dpo->dpoi_type].dv_lock(dpo);
 370 }
 371
 372 void
 373 dpo_unlock (dpo_id_t *dpo)
 374 {
 375     if (!dpo_id_is_valid(dpo))
 376         return;
 377
 378     dpo_vfts[dpo->dpoi_type].dv_unlock(dpo);
 379 }
 380
 381 u32
 382 dpo_get_urpf(const dpo_id_t *dpo)
 383 {
 384     if (dpo_id_is_valid(dpo) &&
 385         (NULL != dpo_vfts[dpo->dpoi_type].dv_get_urpf))
 386     {
 387         return (dpo_vfts[dpo->dpoi_type].dv_get_urpf(dpo));
 388     }
 389
 390     return (~0);
 391 }
 392
 393 static u32
 394 dpo_get_next_node (dpo_type_t child_type,
 395                    dpo_proto_t child_proto,
 396                    const dpo_id_t *parent_dpo)
 397 {
 398     dpo_proto_t parent_proto;
 399     dpo_type_t parent_type;
 400
 401     parent_type = parent_dpo->dpoi_type;
 402     parent_proto = parent_dpo->dpoi_proto;
 403
 404     vec_validate(dpo_edges, child_type);
 405     vec_validate(dpo_edges[child_type], child_proto);
 406     vec_validate(dpo_edges[child_type][child_proto], parent_type);
 407     vec_validate_init_empty(
 408         dpo_edges[child_type][child_proto][parent_type],
 409         parent_proto, ~0);
 410
 411     /*
 412      * if the edge index has not yet been created for this node to node transition
 413      */
 414     if (~0 == dpo_edges[child_type][child_proto][parent_type][parent_proto])
 415     {
 416         vlib_node_t *child_node;
 417         u32 *parent_indices;
 418         vlib_main_t *vm;
 419         u32 edge, *pi, cc;
 420
 421         vm = vlib_get_main();
 422
 423         ASSERT(NULL != dpo_vfts[parent_type].dv_get_next_node);
 424         ASSERT(NULL != dpo_nodes[child_type]);
 425         ASSERT(NULL != dpo_nodes[child_type][child_proto]);
 426
 427         cc = 0;
 428         parent_indices = dpo_vfts[parent_type].dv_get_next_node(parent_dpo);
 429
 430         vlib_worker_thread_barrier_sync(vm);
 431
 432         /*
 433          * create a graph arc from each of the child's registered node types,
 434          * to each of the parent's.
 435          */
 436         while (NULL != dpo_nodes[child_type][child_proto][cc])
 437         {
 438             child_node =
 439                 vlib_get_node_by_name(vm,
 440                                       (u8*) dpo_nodes[child_type][child_proto][cc]);
 441
 442             vec_foreach(pi, parent_indices)
 443             {
 444                 edge = vlib_node_add_next(vm, child_node->index, *pi);
 445
 446                 if (~0 == dpo_edges[child_type][child_proto][parent_type][parent_proto])
 447                 {
 448                     dpo_edges[child_type][child_proto][parent_type][parent_proto] = edge;
 449                 }
 450                 else
 451                 {
 452                     ASSERT(dpo_edges[child_type][child_proto][parent_type][parent_proto] == edge);
 453                 }
 454             }
 455             cc++;
 456         }
 457
 458         vlib_worker_thread_barrier_release(vm);
 459         vec_free(parent_indices);
 460     }
 461
 462     return (dpo_edges[child_type][child_proto][parent_type][parent_proto]);
 463 }
 464
 465 /**
 466  * @brief return already stacked up next node index for a given
 467  * child_type/child_proto and parent_type/patent_proto.
 468  * The VLIB graph arc used is taken from the parent and child types
 469  * passed.
 470  */
 471 u32
 472 dpo_get_next_node_by_type_and_proto (dpo_type_t   child_type,
 473                                      dpo_proto_t  child_proto,
 474                                      dpo_type_t   parent_type,
 475                                      dpo_proto_t  parent_proto)
 476 {
 477    return (dpo_edges[child_type][child_proto][parent_type][parent_proto]);
 478 }
 479
 480 /**
 481  * @brief Stack one DPO object on another, and thus establish a child parent
 482  * relationship. The VLIB graph arc used is taken from the parent and child types
 483  * passed.
 484  */
 485 static void
 486 dpo_stack_i (u32 edge,
 487              dpo_id_t *dpo,
 488              const dpo_id_t *parent)
 489 {
 490     /*
 491      * in order to get an atomic update of the parent we create a temporary,
 492      * from a copy of the child, and add the next_node. then we copy to the parent
 493      */
 494     dpo_id_t tmp = DPO_INVALID;
 495     dpo_copy(&tmp, parent);
 496
 497     /*
 498      * get the edge index for the parent to child VLIB graph transition
 499      */
 500     tmp.dpoi_next_node = edge;
 501
 502     /*
 503      * this update is atomic.
 504      */
 505     dpo_copy(dpo, &tmp);
 506
 507     dpo_reset(&tmp);
 508 }
 509
 510 /**
 511  * @brief Stack one DPO object on another, and thus establish a child-parent
 512  * relationship. The VLIB graph arc used is taken from the parent and child types
 513  * passed.
 514  */
 515 void
 516 dpo_stack (dpo_type_t child_type,
 517            dpo_proto_t child_proto,
 518            dpo_id_t *dpo,
 519            const dpo_id_t *parent)
 520 {
 521     dpo_stack_i(dpo_get_next_node(child_type, child_proto, parent), dpo, parent);
 522 }
 523
 524 /**
 525  * @brief Stack one DPO object on another, and thus establish a child parent
 526  * relationship. A new VLIB graph arc is created from the child node passed
 527  * to the nodes registered by the parent. The VLIB infra will ensure this arc
 528  * is added only once.
 529  */
 530 void
 531 dpo_stack_from_node (u32 child_node_index,
 532                      dpo_id_t *dpo,
 533                      const dpo_id_t *parent)
 534 {
 535     dpo_type_t parent_type;
 536     u32 *parent_indices;
 537     vlib_main_t *vm;
 538     u32 edge, *pi;
 539
 540     edge = 0;
 541     parent_type = parent->dpoi_type;
 542     vm = vlib_get_main();
 543
 544     ASSERT(NULL != dpo_vfts[parent_type].dv_get_next_node);
 545     parent_indices = dpo_vfts[parent_type].dv_get_next_node(parent);
 546     ASSERT(parent_indices);
 547
 548     /*
 549      * This loop is purposefully written with the worker thread lock in the
 550      * inner loop because;
 551      *  1) the likelihood that the edge does not exist is smaller
 552      *  2) the likelihood there is more than one node is even smaller
 553      * so we are optimising for not need to take the lock
 554      */
 555     vec_foreach(pi, parent_indices)
 556     {
 557         edge = vlib_node_get_next(vm, child_node_index, *pi);
 558
 559         if (~0 == edge)
 560         {
 561             vlib_worker_thread_barrier_sync(vm);
 562
 563             edge = vlib_node_add_next(vm, child_node_index, *pi);
 564
 565             vlib_worker_thread_barrier_release(vm);
 566         }
 567     }
 568     dpo_stack_i(edge, dpo, parent);
 569
 570     /* should free this local vector to avoid memory leak */
 571     vec_free(parent_indices);
 572 }
 573
 574 static clib_error_t *
 575 dpo_module_init (vlib_main_t * vm)
 576 {
 577     drop_dpo_module_init();
 578     punt_dpo_module_init();
 579     receive_dpo_module_init();
 580     load_balance_module_init();
 581     mpls_label_dpo_module_init();
 582     classify_dpo_module_init();
 583     lookup_dpo_module_init();
 584     ip_null_dpo_module_init();
 585     ip6_ll_dpo_module_init();
 586     replicate_module_init();
 587     interface_rx_dpo_module_init();
 588     interface_tx_dpo_module_init();
 589     mpls_disp_dpo_module_init();
 590     dvr_dpo_module_init();
 591     l3_proxy_dpo_module_init();
 592     pw_cw_dpo_module_init();
 593
 594     return (NULL);
 595 }
 596
 597 /* *INDENT-OFF* */
 598 VLIB_INIT_FUNCTION(dpo_module_init) =
 599 {
 600     .runs_before = VLIB_INITS ("ip_main_init"),
 601 };
 602 /* *INDENT-ON* */
 603
 604 static clib_error_t *
 605 dpo_memory_show (vlib_main_t * vm,
 606                  unformat_input_t * input,
 607                  vlib_cli_command_t * cmd)
 608 {
 609     dpo_vft_t *vft;
 610
 611     vlib_cli_output (vm, "DPO memory");
 612     vlib_cli_output (vm, "%=30s %=5s %=8s/%=9s   totals",
 613                      "Name","Size", "in-use", "allocated");
 614
 615     vec_foreach(vft, dpo_vfts)
 616     {
 617         if (NULL != vft->dv_mem_show)
 618             vft->dv_mem_show();
 619     }
 620
 621     return (NULL);
 622 }
 623
 624 /* *INDENT-OFF* */
 625 /*?
 626  * The '<em>sh dpo memory </em>' command displays the memory usage for each
 627  * data-plane object type.
 628  *
 629  * @cliexpar
 630  * @cliexstart{show dpo memory}
 631  * DPO memory
 632  *             Name               Size  in-use /allocated   totals
 633  *         load-balance            64     12   /    12      768/768
 634  *           Adjacency            256      1   /    1       256/256
 635  *            Receive              24      5   /    5       120/120
 636  *            Lookup               12      0   /    0       0/0
 637  *           Classify              12      0   /    0       0/0
 638  *          MPLS label             24      0   /    0       0/0
 639  * @cliexend
 640 ?*/
 641 VLIB_CLI_COMMAND (show_fib_memory, static) = {
 642     .path = "show dpo memory",
 643     .function = dpo_memory_show,
 644     .short_help = "show dpo memory",
 645 };
 646 /* *INDENT-ON* */