vnet/vnet/l2/l2_output.c

   1 /*
   2  * l2_output.c : layer 2 output packet processing
   3  *
   4  * Copyright (c) 2013 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 <vlib/vlib.h>
  19 #include <vnet/vnet.h>
  20 #include <vnet/pg/pg.h>
  21 #include <vnet/ethernet/ethernet.h>
  22 #include <vlib/cli.h>
  23
  24 #include <vppinfra/error.h>
  25 #include <vppinfra/hash.h>
  26 #include <vnet/l2/feat_bitmap.h>
  27 #include <vnet/l2/l2_output.h>
  28
  29
  30 // Feature graph node names
  31 static char * l2output_feat_names[] = {
  32 #define _(sym,name) name,
  33   foreach_l2output_feat
  34 #undef _
  35 };
  36
  37 char **l2output_get_feat_names(void) {
  38   return l2output_feat_names;
  39 }
  40
  41 l2output_main_t l2output_main;
  42
  43 typedef struct {
  44   /* per-pkt trace data */
  45   u8 src[6];
  46   u8 dst[6];
  47   u32 sw_if_index;
  48 } l2output_trace_t;
  49
  50 /* packet trace format function */
  51 static u8 * format_l2output_trace (u8 * s, va_list * args)
  52 {
  53   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  54   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  55   l2output_trace_t * t = va_arg (*args, l2output_trace_t *);
  56
  57   s = format (s, "l2-output: sw_if_index %d dst %U src %U",
  58               t->sw_if_index,
  59               format_ethernet_address, t->dst,
  60               format_ethernet_address, t->src);
  61   return s;
  62 }
  63
  64
  65 #define foreach_l2output_error                          \
  66 _(L2OUTPUT,     "L2 output packets")                    \
  67 _(EFP_DROP,     "L2 EFP filter pre-rewrite drops")      \
  68 _(VTR_DROP,     "L2 output tag rewrite drops")          \
  69 _(SHG_DROP,     "L2 split horizon drops")               \
  70 _(DROP,         "L2 output drops")
  71
  72 typedef enum {
  73 #define _(sym,str) L2OUTPUT_ERROR_##sym,
  74   foreach_l2output_error
  75 #undef _
  76   L2OUTPUT_N_ERROR,
  77 } l2output_error_t;
  78
  79 static char * l2output_error_strings[] = {
  80 #define _(sym,string) string,
  81   foreach_l2output_error
  82 #undef _
  83 };
  84
  85 typedef enum {
  86   L2OUTPUT_NEXT_DROP,
  87   L2OUTPUT_N_NEXT,
  88 } l2output_next_t;
  89
  90 // Return 0 if split horizon check passes, otherwise return non-zero
  91 // Packets should not be transmitted out an interface with the same
  92 // split-horizon group as the input interface, except if the shg is 0
  93 // in which case the check always passes.
  94 static_always_inline u32
  95 split_horizon_violation (u8 shg1, u8 shg2)
  96 {
  97   if (PREDICT_TRUE (shg1 == 0)) {
  98     return 0;
  99   } else {
 100     return shg1 == shg2;
 101   }
 102 }
 103
 104
 105 static vlib_node_registration_t l2output_node;
 106
 107 static uword
 108 l2output_node_fn (vlib_main_t * vm,
 109                   vlib_node_runtime_t * node,
 110                   vlib_frame_t * frame)
 111 {
 112   u32 n_left_from, * from, * to_next;
 113   l2output_next_t next_index;
 114   l2output_main_t * msm = &l2output_main;
 115   vlib_node_t *n = vlib_get_node (vm, l2output_node.index);
 116   u32 node_counter_base_index = n->error_heap_index;
 117   vlib_error_main_t * em = &vm->error_main;
 118   u32 cached_sw_if_index;
 119   u32 cached_next_index;
 120
 121   /* Invalidate cache */
 122   cached_sw_if_index = ~0;
 123   cached_next_index = ~0;       /* warning be gone */
 124
 125   from = vlib_frame_vector_args (frame);
 126   n_left_from = frame->n_vectors; /* number of packets to process */
 127   next_index = node->cached_next_index;
 128
 129   while (n_left_from > 0)
 130     {
 131       u32 n_left_to_next;
 132
 133       /* get space to enqueue frame to graph node "next_index" */
 134       vlib_get_next_frame (vm, node, next_index,
 135                            to_next, n_left_to_next);
 136
 137       while (n_left_from >= 6 && n_left_to_next >= 2)
 138         {
 139           u32 bi0, bi1;
 140           vlib_buffer_t * b0, * b1;
 141           u32 next0, next1;
 142           u32 sw_if_index0, sw_if_index1;
 143           ethernet_header_t * h0, * h1;
 144           l2_output_config_t * config0, * config1;
 145           u32 feature_bitmap0, feature_bitmap1;
 146
 147           /* Prefetch next iteration. */
 148           {
 149             vlib_buffer_t * p2, * p3, * p4 , * p5;
 150             u32 sw_if_index2, sw_if_index3;
 151
 152             p2 = vlib_get_buffer (vm, from[2]);
 153             p3 = vlib_get_buffer (vm, from[3]);
 154             p4 = vlib_get_buffer (vm, from[4]);
 155             p5 = vlib_get_buffer (vm, from[5]);
 156
 157             // Prefetch the buffer header for the N+2 loop iteration
 158             vlib_prefetch_buffer_header (p4, LOAD);
 159             vlib_prefetch_buffer_header (p5, LOAD);
 160             // Note: no need to prefetch packet data. This node doesn't reference it.
 161
 162             // Prefetch the input config for the N+1 loop iteration
 163             // This depends on the buffer header above
 164             sw_if_index2 = vnet_buffer(p2)->sw_if_index[VLIB_TX];
 165             sw_if_index3 = vnet_buffer(p3)->sw_if_index[VLIB_TX];
 166             CLIB_PREFETCH (&msm->configs[sw_if_index2], CLIB_CACHE_LINE_BYTES, LOAD);
 167             CLIB_PREFETCH (&msm->configs[sw_if_index3], CLIB_CACHE_LINE_BYTES, LOAD);
 168           }
 169
 170           /* speculatively enqueue b0 and b1 to the current next frame */
 171           /* bi is "buffer index", b is pointer to the buffer */
 172           to_next[0] = bi0 = from[0];
 173           to_next[1] = bi1 = from[1];
 174           from += 2;
 175           to_next += 2;
 176           n_left_from -= 2;
 177           n_left_to_next -= 2;
 178
 179           b0 = vlib_get_buffer (vm, bi0);
 180           b1 = vlib_get_buffer (vm, bi1);
 181
 182           /* TX interface handles */
 183           sw_if_index0 = vnet_buffer(b0)->sw_if_index[VLIB_TX];
 184           sw_if_index1 = vnet_buffer(b1)->sw_if_index[VLIB_TX];
 185
 186           if (PREDICT_FALSE((node->flags & VLIB_NODE_FLAG_TRACE)))
 187             {
 188               h0 = vlib_buffer_get_current (b0);
 189               h1 = vlib_buffer_get_current (b1);
 190               if (b0->flags & VLIB_BUFFER_IS_TRACED)
 191                 {
 192                     l2output_trace_t *t =
 193                       vlib_add_trace (vm, node, b0, sizeof (*t));
 194                     t->sw_if_index = sw_if_index0;
 195                     clib_memcpy(t->src, h0->src_address, 6);
 196                     clib_memcpy(t->dst, h0->dst_address, 6);
 197                   }
 198                 if (b1->flags & VLIB_BUFFER_IS_TRACED)
 199                   {
 200                     l2output_trace_t *t =
 201                       vlib_add_trace (vm, node, b1, sizeof (*t));
 202                     t->sw_if_index = sw_if_index1;
 203                     clib_memcpy(t->src, h1->src_address, 6);
 204                     clib_memcpy(t->dst, h1->dst_address, 6);
 205                   }
 206               }
 207
 208             em->counters[node_counter_base_index + L2OUTPUT_ERROR_L2OUTPUT] += 2;
 209
 210             // Get config for the output interface
 211             config0 = vec_elt_at_index(msm->configs, sw_if_index0);
 212             config1 = vec_elt_at_index(msm->configs, sw_if_index1);
 213
 214             // Get features from the config
 215             // TODO: mask out any non-applicable features
 216             feature_bitmap0 = config0->feature_bitmap;
 217             feature_bitmap1 = config1->feature_bitmap;
 218
 219             // Determine next node
 220             l2_output_dispatch (msm->vlib_main,
 221                                 msm->vnet_main,
 222                                 node,
 223                                 l2output_node.index,
 224                                 &cached_sw_if_index,
 225                                 &cached_next_index,
 226                                 &msm->next_nodes,
 227                                 b0,
 228                                 sw_if_index0,
 229                                 feature_bitmap0,
 230                                 &next0);
 231
 232             l2_output_dispatch (msm->vlib_main,
 233                                 msm->vnet_main,
 234                                 node,
 235                                 l2output_node.index,
 236                                 &cached_sw_if_index,
 237                                 &cached_next_index,
 238                                 &msm->next_nodes,
 239                                 b1,
 240                                 sw_if_index1,
 241                                 feature_bitmap1,
 242                                 &next1);
 243
 244             // Perform output vlan tag rewrite and the pre-vtr EFP filter check.
 245             // The EFP Filter only needs to be run if there is an output VTR
 246             // configured. The flag for the post-vtr EFP Filter node is used
 247             // to trigger the pre-vtr check as well.
 248
 249             if (PREDICT_FALSE (config0->output_vtr.push_and_pop_bytes)) {
 250               // Perform pre-vtr EFP filter check if configured
 251               u32 failed1 = (feature_bitmap0 & L2OUTPUT_FEAT_EFP_FILTER) &&
 252                             (l2_efp_filter_process(b0, &(config0->input_vtr)));
 253               u32 failed2 = l2_vtr_process(b0, &(config0->output_vtr));
 254
 255               if (PREDICT_FALSE (failed1 | failed2)) {
 256                 next0 = L2OUTPUT_NEXT_DROP;
 257                 if (failed2) {
 258                   b0->error = node->errors[L2OUTPUT_ERROR_VTR_DROP];
 259                 }
 260                 if (failed1) {
 261                   b0->error = node->errors[L2OUTPUT_ERROR_EFP_DROP];
 262                 }
 263               }
 264             }
 265
 266             if (PREDICT_FALSE (config1->output_vtr.push_and_pop_bytes)) {
 267               // Perform pre-vtr EFP filter check if configured
 268               u32 failed1 = (feature_bitmap1 & L2OUTPUT_FEAT_EFP_FILTER) &&
 269                             (l2_efp_filter_process(b1, &(config1->input_vtr)));
 270               u32 failed2 = l2_vtr_process(b1, &(config1->output_vtr));
 271
 272               if (PREDICT_FALSE (failed1 | failed2)) {
 273                 next1 = L2OUTPUT_NEXT_DROP;
 274                 if (failed2) {
 275                   b1->error = node->errors[L2OUTPUT_ERROR_VTR_DROP];
 276                 }
 277                 if (failed1) {
 278                   b1->error = node->errors[L2OUTPUT_ERROR_EFP_DROP];
 279                 }
 280               }
 281             }
 282
 283             // Perform the split horizon check
 284             // The check can only fail for non-zero shg's
 285             if (PREDICT_FALSE (config0->shg + config1->shg)) {
 286               // one of the checks might fail, check both
 287               if (split_horizon_violation (config0->shg, vnet_buffer(b0)->l2.shg)) {
 288                 next0 = L2OUTPUT_NEXT_DROP;
 289                 b0->error = node->errors[L2OUTPUT_ERROR_SHG_DROP];
 290               }
 291               if (split_horizon_violation (config1->shg, vnet_buffer(b1)->l2.shg)) {
 292                 next1 = L2OUTPUT_NEXT_DROP;
 293                 b1->error = node->errors[L2OUTPUT_ERROR_SHG_DROP];
 294               }
 295             }
 296
 297             /* verify speculative enqueues, maybe switch current next frame */
 298             /* if next0==next1==next_index then nothing special needs to be done */
 299             vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
 300                                              to_next, n_left_to_next,
 301                                              bi0, bi1, next0, next1);
 302         }
 303
 304       while (n_left_from > 0 && n_left_to_next > 0)
 305         {
 306           u32 bi0;
 307           vlib_buffer_t * b0;
 308           u32 next0;
 309           u32 sw_if_index0;
 310           ethernet_header_t * h0;
 311           l2_output_config_t *config0;
 312           u32 feature_bitmap0;
 313
 314           /* speculatively enqueue b0 to the current next frame */
 315           bi0 = from[0];
 316           to_next[0] = bi0;
 317           from += 1;
 318           to_next += 1;
 319           n_left_from -= 1;
 320           n_left_to_next -= 1;
 321
 322           b0 = vlib_get_buffer (vm, bi0);
 323
 324           sw_if_index0 = vnet_buffer(b0)->sw_if_index[VLIB_TX];
 325
 326           if (PREDICT_FALSE((node->flags & VLIB_NODE_FLAG_TRACE)
 327                             && (b0->flags & VLIB_BUFFER_IS_TRACED))) {
 328             l2output_trace_t *t =
 329                vlib_add_trace (vm, node, b0, sizeof (*t));
 330             t->sw_if_index = sw_if_index0;
 331             h0 = vlib_buffer_get_current (b0);
 332             clib_memcpy(t->src, h0->src_address, 6);
 333             clib_memcpy(t->dst, h0->dst_address, 6);
 334             }
 335
 336           em->counters[node_counter_base_index + L2OUTPUT_ERROR_L2OUTPUT] += 1;
 337
 338           // Get config for the output interface
 339           config0 = vec_elt_at_index(msm->configs, sw_if_index0);
 340
 341           // Get features from the config
 342           // TODO: mask out any non-applicable features
 343           feature_bitmap0 = config0->feature_bitmap;
 344
 345           // Determine next node
 346           l2_output_dispatch (msm->vlib_main,
 347                               msm->vnet_main,
 348                               node,
 349                               l2output_node.index,
 350                               &cached_sw_if_index,
 351                               &cached_next_index,
 352                               &msm->next_nodes,
 353                               b0,
 354                               sw_if_index0,
 355                               feature_bitmap0,
 356                               &next0);
 357
 358           // Perform output vlan tag rewrite and the pre-vtr EFP filter check.
 359           // The EFP Filter only needs to be run if there is an output VTR
 360           // configured. The flag for the post-vtr EFP Filter node is used
 361           // to trigger the pre-vtr check as well.
 362
 363           if (config0->output_vtr.push_and_pop_bytes) {
 364             // Perform pre-vtr EFP filter check if configured
 365             u32 failed1 = (feature_bitmap0 & L2OUTPUT_FEAT_EFP_FILTER) &&
 366                           (l2_efp_filter_process(b0, &(config0->input_vtr)));
 367             u32 failed2 = l2_vtr_process(b0, &(config0->output_vtr));
 368
 369             if (PREDICT_FALSE (failed1 | failed2)) {
 370               next0 = L2OUTPUT_NEXT_DROP;
 371               if (failed2) {
 372                  b0->error = node->errors[L2OUTPUT_ERROR_VTR_DROP];
 373               }
 374               if (failed1) {
 375                 b0->error = node->errors[L2OUTPUT_ERROR_EFP_DROP];
 376               }
 377             }
 378           }
 379
 380           // Perform the split horizon check
 381           if (PREDICT_FALSE (split_horizon_violation (config0->shg, vnet_buffer(b0)->l2.shg))) {
 382             next0 = L2OUTPUT_NEXT_DROP;
 383             b0->error = node->errors[L2OUTPUT_ERROR_SHG_DROP];
 384           }
 385
 386           /* verify speculative enqueue, maybe switch current next frame */
 387           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 388                                            to_next, n_left_to_next,
 389                                            bi0, next0);
 390         }
 391
 392       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 393     }
 394
 395   return frame->n_vectors;
 396 }
 397
 398
 399 VLIB_REGISTER_NODE (l2output_node,static) = {
 400   .function = l2output_node_fn,
 401   .name = "l2-output",
 402   .vector_size = sizeof (u32),
 403   .format_trace = format_l2output_trace,
 404   .type = VLIB_NODE_TYPE_INTERNAL,
 405
 406   .n_errors = ARRAY_LEN(l2output_error_strings),
 407   .error_strings = l2output_error_strings,
 408
 409   .n_next_nodes = L2OUTPUT_N_NEXT,
 410
 411   /* edit / add dispositions here */
 412   .next_nodes = {
 413         [L2OUTPUT_NEXT_DROP] = "error-drop",
 414   },
 415 };
 416
 417 VLIB_NODE_FUNCTION_MULTIARCH (l2output_node, l2output_node_fn)
 418
 419 clib_error_t *l2output_init (vlib_main_t *vm)
 420 {
 421   l2output_main_t * mp = &l2output_main;
 422
 423   mp->vlib_main = vm;
 424   mp->vnet_main = vnet_get_main();
 425
 426   // Create the config vector
 427   vec_validate(mp->configs, 100);
 428   // Until we hook up the CLI config, just create 100 sw interface entries  and zero them
 429
 430   // Initialize the feature next-node indexes
 431   feat_bitmap_init_next_nodes(vm,
 432                               l2output_node.index,
 433                               L2OUTPUT_N_FEAT,
 434                               l2output_get_feat_names(),
 435                               mp->next_nodes.feat_next_node_index);
 436
 437   // Initialize the output node mapping table
 438   l2output_init_output_node_vec(&mp->next_nodes.output_node_index_vec);
 439
 440   return 0;
 441 }
 442
 443 VLIB_INIT_FUNCTION (l2output_init);
 444
 445 typedef struct {
 446   u32 node_index;
 447   u32 sw_if_index;
 448 } output_node_mapping_rpc_args_t;
 449
 450 #if DPDK > 0
 451 static void output_node_rpc_callback
 452 ( output_node_mapping_rpc_args_t * a);
 453
 454 static void output_node_mapping_send_rpc
 455 (u32  node_index,
 456  u32 sw_if_index)
 457 {
 458   output_node_mapping_rpc_args_t args;
 459   void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
 460
 461   args.node_index = node_index;
 462   args.sw_if_index = sw_if_index;
 463
 464   vl_api_rpc_call_main_thread (output_node_rpc_callback,
 465                                (u8 *) &args, sizeof (args));
 466 }
 467 #endif
 468
 469
 470 // Create a mapping in the next node mapping table for the given sw_if_index
 471 u32 l2output_create_output_node_mapping (
 472             vlib_main_t * vlib_main,
 473             vnet_main_t * vnet_main,
 474             u32           node_index,  // index of current node
 475             u32         * output_node_index_vec,
 476             u32           sw_if_index) {
 477
 478   u32                  next;  // index of next graph node
 479   vnet_hw_interface_t *hw0;
 480   u32                 *node;
 481
 482   hw0 = vnet_get_sup_hw_interface (vnet_main, sw_if_index);
 483
 484 #if DPDK > 0
 485   uword                cpu_number;
 486
 487   cpu_number = os_get_cpu_number();
 488
 489   if (cpu_number)
 490     {
 491       u32 oldflags;
 492
 493       oldflags = __sync_fetch_and_or(&hw0->flags,
 494                                      VNET_HW_INTERFACE_FLAG_L2OUTPUT_MAPPED);
 495
 496       if ((oldflags & VNET_HW_INTERFACE_FLAG_L2OUTPUT_MAPPED) )
 497         return L2OUTPUT_NEXT_DROP;
 498
 499       output_node_mapping_send_rpc (node_index, sw_if_index);
 500         return L2OUTPUT_NEXT_DROP;
 501     }
 502 #endif
 503
 504   // dynamically create graph node arc
 505   next = vlib_node_add_next (vlib_main,
 506                              node_index,
 507                              hw0->output_node_index);
 508
 509   // Initialize vector with the mapping
 510
 511   node = vec_elt_at_index(output_node_index_vec, sw_if_index);
 512   *node = next;
 513
 514   return next;
 515 }
 516
 517 #if DPDK > 0
 518 void output_node_rpc_callback (output_node_mapping_rpc_args_t *a)
 519 {
 520   vlib_main_t * vm = vlib_get_main();
 521   vnet_main_t * vnm = vnet_get_main();
 522   l2output_main_t * mp = &l2output_main;
 523
 524   (void) l2output_create_output_node_mapping
 525     (vm, vnm, a->node_index, mp->next_nodes.output_node_index_vec,
 526      a->sw_if_index);
 527 }
 528 #endif
 529
 530 // Get a pointer to the config for the given interface
 531 l2_output_config_t * l2output_intf_config (u32 sw_if_index)
 532 {
 533   l2output_main_t * mp = &l2output_main;
 534
 535   vec_validate(mp->configs, sw_if_index);
 536   return vec_elt_at_index(mp->configs, sw_if_index);
 537 }
 538
 539 // Enable (or disable) the feature in the bitmap for the given interface
 540 void l2output_intf_bitmap_enable (u32 sw_if_index,
 541                                   u32 feature_bitmap,
 542                                   u32 enable)
 543 {
 544   l2output_main_t * mp = &l2output_main;
 545   l2_output_config_t *config;
 546
 547   vec_validate(mp->configs, sw_if_index);
 548   config = vec_elt_at_index(mp->configs, sw_if_index);
 549
 550   if (enable) {
 551     config->feature_bitmap |= feature_bitmap;
 552   } else {
 553     config->feature_bitmap &= ~feature_bitmap;
 554   }
 555 }