2 * l2_output.c : layer 2 output packet processing
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:
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #include <vlib/vlib.h>
19 #include <vnet/vnet.h>
20 #include <vnet/pg/pg.h>
21 #include <vnet/ethernet/ethernet.h>
24 #include <vppinfra/error.h>
25 #include <vppinfra/hash.h>
26 #include <vnet/l2/feat_bitmap.h>
27 #include <vnet/l2/l2_output.h>
30 #ifndef CLIB_MARCH_VARIANT
31 /* Feature graph node names */
32 static char *l2output_feat_names[] = {
33 #define _(sym,name) name,
39 l2output_get_feat_names (void)
41 return l2output_feat_names;
45 format_l2_output_features (u8 * s, va_list * args)
47 static char *display_names[] = {
48 #define _(sym,name) #sym,
52 u32 feature_bitmap = va_arg (*args, u32);
54 if (feature_bitmap == 0)
56 s = format (s, " none configured");
61 for (i = L2OUTPUT_N_FEAT - 1; i >= 0; i--)
62 if (feature_bitmap & (1 << i))
63 s = format (s, "%10s (%s)\n", display_names[i], l2output_feat_names[i]);
67 l2output_main_t l2output_main;
72 /* per-pkt trace data */
76 u8 raw[12]; /* raw data */
79 /* packet trace format function */
81 format_l2output_trace (u8 * s, va_list * args)
83 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
84 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
85 l2output_trace_t *t = va_arg (*args, l2output_trace_t *);
87 s = format (s, "l2-output: sw_if_index %d dst %U src %U data "
88 "%02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x",
90 format_ethernet_address, t->dst,
91 format_ethernet_address, t->src,
92 t->raw[0], t->raw[1], t->raw[2], t->raw[3], t->raw[4],
93 t->raw[5], t->raw[6], t->raw[7], t->raw[8], t->raw[9],
94 t->raw[10], t->raw[11]);
100 static char *l2output_error_strings[] = {
101 #define _(sym,string) string,
102 foreach_l2output_error
107 * Check for split horizon violations.
108 * Return 0 if split horizon check passes, otherwise return non-zero.
109 * Packets should not be transmitted out an interface with the same
110 * split-horizon group as the input interface, except if the @c shg is 0
111 * in which case the check always passes.
113 static_always_inline void
114 split_horizon_violation (vlib_node_runtime_t * node, u8 shg,
115 vlib_buffer_t * b, u16 * next)
117 if (shg != vnet_buffer (b)->l2.shg)
119 next[0] = L2OUTPUT_NEXT_DROP;
120 b->error = node->errors[L2OUTPUT_ERROR_SHG_DROP];
123 static_always_inline void
124 l2output_process_batch_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
125 l2_output_config_t * config,
126 vlib_buffer_t ** b, i16 * cdo, u16 * next,
127 u32 n_left, int l2_efp, int l2_vtr, int l2_pbb,
128 int shg_set, int update_feature_bitmap)
132 vlib_prefetch_buffer_header (b[4], LOAD);
133 vlib_prefetch_buffer_header (b[5], LOAD);
134 vlib_prefetch_buffer_header (b[6], LOAD);
135 vlib_prefetch_buffer_header (b[7], LOAD);
137 /* prefetch eth headers only if we need to touch them */
138 if (l2_vtr || l2_pbb || shg_set)
140 CLIB_PREFETCH (b[4]->data + cdo[4], CLIB_CACHE_LINE_BYTES, LOAD);
141 CLIB_PREFETCH (b[5]->data + cdo[5], CLIB_CACHE_LINE_BYTES, LOAD);
142 CLIB_PREFETCH (b[6]->data + cdo[6], CLIB_CACHE_LINE_BYTES, LOAD);
143 CLIB_PREFETCH (b[7]->data + cdo[7], CLIB_CACHE_LINE_BYTES, LOAD);
146 if (update_feature_bitmap)
148 vnet_buffer (b[0])->l2.feature_bitmap = config->feature_bitmap;
149 vnet_buffer (b[1])->l2.feature_bitmap = config->feature_bitmap;
150 vnet_buffer (b[2])->l2.feature_bitmap = config->feature_bitmap;
151 vnet_buffer (b[3])->l2.feature_bitmap = config->feature_bitmap;
157 for (i = 0; i < 4; i++)
159 u32 failed1 = l2_efp &&
160 l2_efp_filter_process (b[i], &(config->input_vtr));
161 u32 failed2 = l2_vtr_process (b[i], &(config->output_vtr));
162 if (PREDICT_FALSE (failed1 | failed2))
164 next[i] = L2OUTPUT_NEXT_DROP;
166 b[i]->error = node->errors[L2OUTPUT_ERROR_VTR_DROP];
168 b[i]->error = node->errors[L2OUTPUT_ERROR_EFP_DROP];
176 for (i = 0; i < 4; i++)
177 if (l2_pbb_process (b[i], &(config->output_pbb_vtr)))
179 next[i] = L2OUTPUT_NEXT_DROP;
180 b[i]->error = node->errors[L2OUTPUT_ERROR_VTR_DROP];
186 split_horizon_violation (node, config->shg, b[0], next);
187 split_horizon_violation (node, config->shg, b[1], next + 1);
188 split_horizon_violation (node, config->shg, b[2], next + 2);
189 split_horizon_violation (node, config->shg, b[3], next + 3);
200 if (update_feature_bitmap)
201 vnet_buffer (b[0])->l2.feature_bitmap = config->feature_bitmap;
205 u32 failed1 = l2_efp &&
206 l2_efp_filter_process (b[0], &(config->input_vtr));
207 u32 failed2 = l2_vtr_process (b[0], &(config->output_vtr));
208 if (PREDICT_FALSE (failed1 | failed2))
210 *next = L2OUTPUT_NEXT_DROP;
212 b[0]->error = node->errors[L2OUTPUT_ERROR_VTR_DROP];
214 b[0]->error = node->errors[L2OUTPUT_ERROR_EFP_DROP];
218 if (l2_pbb && l2_pbb_process (b[0], &(config->output_pbb_vtr)))
220 next[0] = L2OUTPUT_NEXT_DROP;
221 b[0]->error = node->errors[L2OUTPUT_ERROR_VTR_DROP];
225 split_horizon_violation (node, config->shg, b[0], next);
234 static_always_inline void
235 l2output_set_buffer_error (vlib_buffer_t ** b, u32 n_left, vlib_error_t error)
239 vlib_prefetch_buffer_header (b[4], LOAD);
240 vlib_prefetch_buffer_header (b[5], LOAD);
241 vlib_prefetch_buffer_header (b[6], LOAD);
242 vlib_prefetch_buffer_header (b[7], LOAD);
243 b[0]->error = b[1]->error = b[2]->error = b[3]->error = error;
255 static_always_inline void
256 l2output_process_batch (vlib_main_t * vm, vlib_node_runtime_t * node,
257 l2_output_config_t * config, vlib_buffer_t ** b,
258 i16 * cdo, u16 * next, u32 n_left, int l2_efp,
259 int l2_vtr, int l2_pbb)
261 u32 feature_bitmap = config->feature_bitmap & ~L2OUTPUT_FEAT_OUTPUT;
262 if (config->shg == 0 && feature_bitmap == 0)
264 if ((l2_efp | l2_vtr | l2_pbb) == 0)
266 l2output_process_batch_inline (vm, node, config, b, cdo, next, n_left,
267 l2_efp, l2_vtr, l2_pbb, 0, 0);
269 else if (config->shg == 0)
270 l2output_process_batch_inline (vm, node, config, b, cdo, next, n_left,
271 l2_efp, l2_vtr, l2_pbb, 0, 1);
272 else if (feature_bitmap == 0)
273 l2output_process_batch_inline (vm, node, config, b, cdo, next, n_left,
274 l2_efp, l2_vtr, l2_pbb, 1, 0);
276 l2output_process_batch_inline (vm, node, config, b, cdo, next, n_left,
277 l2_efp, l2_vtr, l2_pbb, 1, 1);
280 VLIB_NODE_FN (l2output_node) (vlib_main_t * vm,
281 vlib_node_runtime_t * node,
282 vlib_frame_t * frame)
285 l2output_main_t *msm = &l2output_main;
286 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
287 u16 nexts[VLIB_FRAME_SIZE];
288 u32 sw_if_indices[VLIB_FRAME_SIZE], *sw_if_index;
289 i16 cur_data_offsets[VLIB_FRAME_SIZE], *cdo;
290 l2_output_config_t *config;
293 from = vlib_frame_vector_args (frame);
294 n_left = frame->n_vectors; /* number of packets to process */
296 vlib_get_buffers (vm, from, bufs, n_left);
298 sw_if_index = sw_if_indices;
299 cdo = cur_data_offsets;
301 /* extract data from buffer metadata */
304 /* Prefetch the buffer header for the N+2 loop iteration */
305 vlib_prefetch_buffer_header (b[4], LOAD);
306 vlib_prefetch_buffer_header (b[5], LOAD);
307 vlib_prefetch_buffer_header (b[6], LOAD);
308 vlib_prefetch_buffer_header (b[7], LOAD);
310 sw_if_index[0] = vnet_buffer (b[0])->sw_if_index[VLIB_TX];
311 cdo[0] = b[0]->current_data;
312 sw_if_index[1] = vnet_buffer (b[1])->sw_if_index[VLIB_TX];
313 cdo[1] = b[1]->current_data;
314 sw_if_index[2] = vnet_buffer (b[2])->sw_if_index[VLIB_TX];
315 cdo[2] = b[2]->current_data;
316 sw_if_index[3] = vnet_buffer (b[3])->sw_if_index[VLIB_TX];
317 cdo[3] = b[3]->current_data;
327 sw_if_index[0] = vnet_buffer (b[0])->sw_if_index[VLIB_TX];
328 cdo[0] = b[0]->current_data;
337 n_left = frame->n_vectors;
340 u16 count, new_next, *next;
341 u16 off = frame->n_vectors - n_left;
346 vlib_prefetch_buffer_header (b[0], LOAD);
347 vlib_prefetch_buffer_header (b[1], LOAD);
348 vlib_prefetch_buffer_header (b[2], LOAD);
349 vlib_prefetch_buffer_header (b[3], LOAD);
352 sw_if_index = sw_if_indices + off;
353 cdo = cur_data_offsets + off;
356 count = clib_count_equal_u32 (sw_if_index, n_left);
359 config = vec_elt_at_index (msm->configs, sw_if_index[0]);
360 feature_bitmap = config->feature_bitmap;
361 if (PREDICT_FALSE ((feature_bitmap & ~L2OUTPUT_FEAT_OUTPUT) != 0))
362 new_next = feat_bitmap_get_next_node_index
363 (l2output_main.l2_out_feat_next, feature_bitmap);
365 new_next = vec_elt (l2output_main.output_node_index_vec,
367 clib_memset_u16 (nexts + off, new_next, count);
369 if (new_next == L2OUTPUT_NEXT_DROP)
371 l2output_set_buffer_error
372 (b, count, node->errors[L2OUTPUT_ERROR_MAPPING_DROP]);
377 if (config->out_vtr_flag && config->output_vtr.push_and_pop_bytes)
379 if (feature_bitmap & L2OUTPUT_FEAT_EFP_FILTER)
380 l2output_process_batch (vm, node, config, b, cdo, next, count,
385 l2output_process_batch (vm, node, config, b, cdo, next, count,
390 else if (config->out_vtr_flag &&
391 config->output_pbb_vtr.push_and_pop_bytes)
392 l2output_process_batch (vm, node, config, b, cdo, next, count,
397 l2output_process_batch (vm, node, config, b, cdo, next, count,
404 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
406 n_left = frame->n_vectors; /* number of packets to process */
411 if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
413 ethernet_header_t *h;
414 l2output_trace_t *t =
415 vlib_add_trace (vm, node, b[0], sizeof (*t));
416 t->sw_if_index = vnet_buffer (b[0])->sw_if_index[VLIB_TX];
417 h = vlib_buffer_get_current (b[0]);
418 clib_memcpy (t->src, h->src_address, 6);
419 clib_memcpy (t->dst, h->dst_address, 6);
420 clib_memcpy (t->raw, &h->type, sizeof (t->raw));
428 vlib_buffer_enqueue_to_next (vm, node, from, nexts, frame->n_vectors);
429 vlib_node_increment_counter (vm, l2output_node.index,
430 L2OUTPUT_ERROR_L2OUTPUT, frame->n_vectors);
432 return frame->n_vectors;
436 VLIB_REGISTER_NODE (l2output_node) = {
438 .vector_size = sizeof (u32),
439 .format_trace = format_l2output_trace,
440 .type = VLIB_NODE_TYPE_INTERNAL,
442 .n_errors = ARRAY_LEN(l2output_error_strings),
443 .error_strings = l2output_error_strings,
445 .n_next_nodes = L2OUTPUT_N_NEXT,
447 /* edit / add dispositions here */
449 [L2OUTPUT_NEXT_DROP] = "error-drop",
450 [L2OUTPUT_NEXT_BAD_INTF] = "l2-output-bad-intf",
456 #define foreach_l2output_bad_intf_error \
457 _(DROP, "L2 output to interface not in L2 mode or deleted")
459 static char *l2output_bad_intf_error_strings[] = {
460 #define _(sym,string) string,
461 foreach_l2output_bad_intf_error
467 #define _(sym,str) L2OUTPUT_BAD_INTF_ERROR_##sym,
468 foreach_l2output_bad_intf_error
470 L2OUTPUT_BAD_INTF_N_ERROR,
471 } l2output_bad_intf_error_t;
475 * Output node for interfaces/tunnels which was in L2 mode but were changed
476 * to L3 mode or possibly deleted thereafter. On changing forwarding mode
477 * of any tunnel/interface from L2 to L3, its entry in l2_output_main table
478 * next_nodes.output_node_index_vec[sw_if_index] MUST be set to the value of
479 * L2OUTPUT_NEXT_BAD_INTF. Thus, if there are stale entries in the L2FIB for
480 * this sw_if_index, l2-output will send packets for this sw_if_index to the
481 * l2-output-bad-intf node which just setup the proper drop reason before
482 * sending packets to the error-drop node to drop the packet. Then, stale L2FIB
483 * entries for deleted tunnels won't cause possible packet or memory corruption.
486 VLIB_NODE_FN (l2output_bad_intf_node) (vlib_main_t * vm,
487 vlib_node_runtime_t * node,
488 vlib_frame_t * frame)
490 u32 n_left_from, *from, *to_next;
491 l2output_next_t next_index = 0;
493 from = vlib_frame_vector_args (frame);
494 n_left_from = frame->n_vectors; /* number of packets to process */
496 while (n_left_from > 0)
500 /* get space to enqueue frame to graph node "next_index" */
501 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
503 while (n_left_from >= 4 && n_left_to_next >= 2)
506 vlib_buffer_t *b0, *b1;
508 to_next[0] = bi0 = from[0];
509 to_next[1] = bi1 = from[1];
514 b0 = vlib_get_buffer (vm, bi0);
515 b1 = vlib_get_buffer (vm, bi1);
516 b0->error = node->errors[L2OUTPUT_BAD_INTF_ERROR_DROP];
517 b1->error = node->errors[L2OUTPUT_BAD_INTF_ERROR_DROP];
520 while (n_left_from > 0 && n_left_to_next > 0)
531 b0 = vlib_get_buffer (vm, bi0);
532 b0->error = node->errors[L2OUTPUT_BAD_INTF_ERROR_DROP];
535 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
538 return frame->n_vectors;
542 VLIB_REGISTER_NODE (l2output_bad_intf_node) = {
543 .name = "l2-output-bad-intf",
544 .vector_size = sizeof (u32),
545 .type = VLIB_NODE_TYPE_INTERNAL,
547 .n_errors = ARRAY_LEN(l2output_bad_intf_error_strings),
548 .error_strings = l2output_bad_intf_error_strings,
552 /* edit / add dispositions here */
559 static clib_error_t *
560 l2output_init (vlib_main_t * vm)
562 l2output_main_t *mp = &l2output_main;
565 mp->vnet_main = vnet_get_main ();
567 /* Create the config vector */
568 vec_validate (mp->configs, 100);
569 /* Until we hook up the CLI config, just create 100 sw interface entries and zero them */
571 /* Initialize the feature next-node indexes */
572 feat_bitmap_init_next_nodes (vm,
575 l2output_get_feat_names (),
576 mp->l2_out_feat_next);
578 /* Initialize the output node mapping table */
579 vec_validate_init_empty (mp->output_node_index_vec, 100,
585 VLIB_INIT_FUNCTION (l2output_init);
588 #ifndef CLIB_MARCH_VARIANT
589 /** Create a mapping in the next node mapping table for the given sw_if_index. */
591 l2output_create_output_node_mapping (vlib_main_t * vlib_main,
592 vnet_main_t * vnet_main, u32 sw_if_index)
594 vnet_hw_interface_t *hw0 =
595 vnet_get_sup_hw_interface (vnet_main, sw_if_index);
597 /* dynamically create graph node arc */
598 u32 next = vlib_node_add_next (vlib_main, l2output_node.index,
599 hw0->output_node_index);
600 l2output_main.output_node_index_vec[sw_if_index] = next;
603 /* Get a pointer to the config for the given interface */
605 l2output_intf_config (u32 sw_if_index)
607 l2output_main_t *mp = &l2output_main;
609 vec_validate (mp->configs, sw_if_index);
610 return vec_elt_at_index (mp->configs, sw_if_index);
613 /** Enable (or disable) the feature in the bitmap for the given interface. */
615 l2output_intf_bitmap_enable (u32 sw_if_index, u32 feature_bitmap, u32 enable)
617 l2output_main_t *mp = &l2output_main;
618 l2_output_config_t *config;
620 vec_validate (mp->configs, sw_if_index);
621 config = vec_elt_at_index (mp->configs, sw_if_index);
625 config->feature_bitmap |= feature_bitmap;
629 config->feature_bitmap &= ~feature_bitmap;
635 * fd.io coding-style-patch-verification: ON
638 * eval: (c-set-style "gnu")