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