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 /* Feature graph node names */
31 static char *l2output_feat_names[] = {
32 #define _(sym,name) name,
38 l2output_get_feat_names (void)
40 return l2output_feat_names;
43 l2output_main_t l2output_main;
47 /* per-pkt trace data */
51 u8 raw[12]; /* raw data */
54 /* packet trace format function */
56 format_l2output_trace (u8 * s, va_list * args)
58 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
59 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
60 l2output_trace_t *t = va_arg (*args, l2output_trace_t *);
62 s = format (s, "l2-output: sw_if_index %d dst %U src %U data "
63 "%02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x",
65 format_ethernet_address, t->dst,
66 format_ethernet_address, t->src,
67 t->raw[0], t->raw[1], t->raw[2], t->raw[3], t->raw[4],
68 t->raw[5], t->raw[6], t->raw[7], t->raw[8], t->raw[9],
69 t->raw[10], t->raw[11]);
75 static char *l2output_error_strings[] = {
76 #define _(sym,string) string,
77 foreach_l2output_error
82 * Check for split horizon violations.
83 * Return 0 if split horizon check passes, otherwise return non-zero.
84 * Packets should not be transmitted out an interface with the same
85 * split-horizon group as the input interface, except if the @c shg is 0
86 * in which case the check always passes.
88 static_always_inline u32
89 split_horizon_violation (u8 shg1, u8 shg2)
91 if (PREDICT_TRUE (shg1 == 0))
101 static_always_inline void
102 l2output_vtr (vlib_node_runtime_t * node, l2_output_config_t * config,
103 u32 feature_bitmap, vlib_buffer_t * b, u32 * next)
105 if (PREDICT_FALSE (config->out_vtr_flag))
107 /* Perform pre-vtr EFP filter check if configured */
108 if (config->output_vtr.push_and_pop_bytes)
111 * Perform output vlan tag rewrite and the pre-vtr EFP filter check.
112 * The EFP Filter only needs to be run if there is an output VTR
113 * configured. The flag for the post-vtr EFP Filter node is used
114 * to trigger the pre-vtr check as well.
116 u32 failed1 = (feature_bitmap & L2OUTPUT_FEAT_EFP_FILTER)
117 && (l2_efp_filter_process (b, &(config->input_vtr)));
118 u32 failed2 = l2_vtr_process (b, &(config->output_vtr));
120 if (PREDICT_FALSE (failed1 | failed2))
122 *next = L2OUTPUT_NEXT_DROP;
125 b->error = node->errors[L2OUTPUT_ERROR_VTR_DROP];
129 b->error = node->errors[L2OUTPUT_ERROR_EFP_DROP];
133 // perform the PBB rewrite
134 else if (config->output_pbb_vtr.push_and_pop_bytes)
136 u32 failed = l2_pbb_process (b, &(config->output_pbb_vtr));
137 if (PREDICT_FALSE (failed))
139 *next = L2OUTPUT_NEXT_DROP;
140 b->error = node->errors[L2OUTPUT_ERROR_VTR_DROP];
147 static vlib_node_registration_t l2output_node;
149 static_always_inline uword
150 l2output_node_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
151 vlib_frame_t * frame, int do_trace)
153 u32 n_left_from, *from, *to_next;
154 l2output_next_t next_index;
155 l2output_main_t *msm = &l2output_main;
156 u32 cached_sw_if_index;
157 u32 cached_next_index;
159 /* Invalidate cache */
160 cached_sw_if_index = ~0;
161 cached_next_index = ~0; /* warning be gone */
163 from = vlib_frame_vector_args (frame);
164 n_left_from = frame->n_vectors; /* number of packets to process */
165 next_index = node->cached_next_index;
167 while (n_left_from > 0)
171 /* get space to enqueue frame to graph node "next_index" */
172 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
174 while (n_left_from >= 8 && n_left_to_next >= 4)
176 u32 bi0, bi1, bi2, bi3;
177 vlib_buffer_t *b0, *b1, *b2, *b3;
178 u32 next0, next1, next2, next3;
179 u32 sw_if_index0, sw_if_index1, sw_if_index2, sw_if_index3;
180 ethernet_header_t *h0, *h1, *h2, *h3;
181 l2_output_config_t *config0, *config1, *config2, *config3;
182 u32 feature_bitmap0, feature_bitmap1;
183 u32 feature_bitmap2, feature_bitmap3;
185 /* Prefetch next iteration. */
187 vlib_buffer_t *p4, *p5, *p6, *p7;
189 p4 = vlib_get_buffer (vm, from[4]);
190 p5 = vlib_get_buffer (vm, from[5]);
191 p6 = vlib_get_buffer (vm, from[6]);
192 p7 = vlib_get_buffer (vm, from[7]);
194 /* Prefetch the buffer header for the N+2 loop iteration */
195 vlib_prefetch_buffer_header (p4, LOAD);
196 vlib_prefetch_buffer_header (p5, LOAD);
197 vlib_prefetch_buffer_header (p6, LOAD);
198 vlib_prefetch_buffer_header (p7, LOAD);
201 /* speculatively enqueue b0 and b1 to the current next frame */
202 /* bi is "buffer index", b is pointer to the buffer */
203 to_next[0] = bi0 = from[0];
204 to_next[1] = bi1 = from[1];
205 to_next[2] = bi2 = from[2];
206 to_next[3] = bi3 = from[3];
212 b0 = vlib_get_buffer (vm, bi0);
213 b1 = vlib_get_buffer (vm, bi1);
214 b2 = vlib_get_buffer (vm, bi2);
215 b3 = vlib_get_buffer (vm, bi3);
217 /* TX interface handles */
218 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
219 sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_TX];
220 sw_if_index2 = vnet_buffer (b2)->sw_if_index[VLIB_TX];
221 sw_if_index3 = vnet_buffer (b3)->sw_if_index[VLIB_TX];
223 vlib_node_increment_counter (vm, l2output_node.index,
224 L2OUTPUT_ERROR_L2OUTPUT, 4);
226 /* Get config for the output interface */
227 config0 = vec_elt_at_index (msm->configs, sw_if_index0);
228 config1 = vec_elt_at_index (msm->configs, sw_if_index1);
229 config2 = vec_elt_at_index (msm->configs, sw_if_index2);
230 config3 = vec_elt_at_index (msm->configs, sw_if_index3);
233 * Get features from the config
234 * TODO: mask out any non-applicable features
236 feature_bitmap0 = config0->feature_bitmap;
237 feature_bitmap1 = config1->feature_bitmap;
238 feature_bitmap2 = config2->feature_bitmap;
239 feature_bitmap3 = config3->feature_bitmap;
241 /* Determine next node */
242 l2_output_dispatch (msm->vlib_main,
249 b0, sw_if_index0, feature_bitmap0, &next0);
251 l2_output_dispatch (msm->vlib_main,
258 b1, sw_if_index1, feature_bitmap1, &next1);
260 l2_output_dispatch (msm->vlib_main,
267 b2, sw_if_index2, feature_bitmap2, &next2);
269 l2_output_dispatch (msm->vlib_main,
276 b3, sw_if_index3, feature_bitmap3, &next3);
278 l2output_vtr (node, config0, feature_bitmap0, b0, &next0);
279 l2output_vtr (node, config1, feature_bitmap1, b1, &next1);
280 l2output_vtr (node, config2, feature_bitmap2, b2, &next2);
281 l2output_vtr (node, config3, feature_bitmap3, b3, &next3);
285 h0 = vlib_buffer_get_current (b0);
286 h1 = vlib_buffer_get_current (b1);
287 h2 = vlib_buffer_get_current (b2);
288 h3 = vlib_buffer_get_current (b3);
289 if (b0->flags & VLIB_BUFFER_IS_TRACED)
291 l2output_trace_t *t =
292 vlib_add_trace (vm, node, b0, sizeof (*t));
293 t->sw_if_index = sw_if_index0;
294 clib_memcpy (t->src, h0->src_address, 6);
295 clib_memcpy (t->dst, h0->dst_address, 6);
296 clib_memcpy (t->raw, &h0->type, sizeof (t->raw));
298 if (b1->flags & VLIB_BUFFER_IS_TRACED)
300 l2output_trace_t *t =
301 vlib_add_trace (vm, node, b1, sizeof (*t));
302 t->sw_if_index = sw_if_index1;
303 clib_memcpy (t->src, h1->src_address, 6);
304 clib_memcpy (t->dst, h1->dst_address, 6);
305 clib_memcpy (t->raw, &h1->type, sizeof (t->raw));
307 if (b2->flags & VLIB_BUFFER_IS_TRACED)
309 l2output_trace_t *t =
310 vlib_add_trace (vm, node, b2, sizeof (*t));
311 t->sw_if_index = sw_if_index2;
312 clib_memcpy (t->src, h2->src_address, 6);
313 clib_memcpy (t->dst, h2->dst_address, 6);
314 clib_memcpy (t->raw, &h2->type, sizeof (t->raw));
316 if (b3->flags & VLIB_BUFFER_IS_TRACED)
318 l2output_trace_t *t =
319 vlib_add_trace (vm, node, b3, sizeof (*t));
320 t->sw_if_index = sw_if_index3;
321 clib_memcpy (t->src, h3->src_address, 6);
322 clib_memcpy (t->dst, h3->dst_address, 6);
323 clib_memcpy (t->raw, &h3->type, sizeof (t->raw));
328 * Perform the split horizon check
329 * The check can only fail for non-zero shg's
331 if (PREDICT_FALSE (config0->shg + config1->shg +
332 config2->shg + config3->shg))
334 /* one of the checks might fail, check both */
335 if (split_horizon_violation
336 (config0->shg, vnet_buffer (b0)->l2.shg))
338 next0 = L2OUTPUT_NEXT_DROP;
339 b0->error = node->errors[L2OUTPUT_ERROR_SHG_DROP];
341 if (split_horizon_violation
342 (config1->shg, vnet_buffer (b1)->l2.shg))
344 next1 = L2OUTPUT_NEXT_DROP;
345 b1->error = node->errors[L2OUTPUT_ERROR_SHG_DROP];
347 if (split_horizon_violation
348 (config2->shg, vnet_buffer (b2)->l2.shg))
350 next2 = L2OUTPUT_NEXT_DROP;
351 b2->error = node->errors[L2OUTPUT_ERROR_SHG_DROP];
353 if (split_horizon_violation
354 (config3->shg, vnet_buffer (b3)->l2.shg))
356 next3 = L2OUTPUT_NEXT_DROP;
357 b3->error = node->errors[L2OUTPUT_ERROR_SHG_DROP];
361 /* verify speculative enqueues, maybe switch current next frame */
362 /* if next0==next1==next_index then nothing special needs to be done */
363 vlib_validate_buffer_enqueue_x4 (vm, node, next_index,
364 to_next, n_left_to_next,
366 next0, next1, next2, next3);
369 while (n_left_from > 0 && n_left_to_next > 0)
375 ethernet_header_t *h0;
376 l2_output_config_t *config0;
379 /* speculatively enqueue b0 to the current next frame */
387 b0 = vlib_get_buffer (vm, bi0);
389 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
391 vlib_node_increment_counter (vm, l2output_node.index,
392 L2OUTPUT_ERROR_L2OUTPUT, 1);
394 /* Get config for the output interface */
395 config0 = vec_elt_at_index (msm->configs, sw_if_index0);
398 * Get features from the config
399 * TODO: mask out any non-applicable features
401 feature_bitmap0 = config0->feature_bitmap;
403 /* Determine next node */
404 l2_output_dispatch (msm->vlib_main,
411 b0, sw_if_index0, feature_bitmap0, &next0);
413 l2output_vtr (node, config0, feature_bitmap0, b0, &next0);
415 if (do_trace && PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
417 l2output_trace_t *t =
418 vlib_add_trace (vm, node, b0, sizeof (*t));
419 t->sw_if_index = sw_if_index0;
420 h0 = vlib_buffer_get_current (b0);
421 clib_memcpy (t->src, h0->src_address, 6);
422 clib_memcpy (t->dst, h0->dst_address, 6);
423 clib_memcpy (t->raw, &h0->type, sizeof (t->raw));
426 /* Perform the split horizon check */
428 (split_horizon_violation
429 (config0->shg, vnet_buffer (b0)->l2.shg)))
431 next0 = L2OUTPUT_NEXT_DROP;
432 b0->error = node->errors[L2OUTPUT_ERROR_SHG_DROP];
435 /* verify speculative enqueue, maybe switch current next frame */
436 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
437 to_next, n_left_to_next,
441 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
444 return frame->n_vectors;
448 l2output_node_fn (vlib_main_t * vm,
449 vlib_node_runtime_t * node, vlib_frame_t * frame)
451 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
452 return l2output_node_inline (vm, node, frame, 1 /* do_trace */ );
453 return l2output_node_inline (vm, node, frame, 0 /* do_trace */ );
457 VLIB_REGISTER_NODE (l2output_node,static) = {
458 .function = l2output_node_fn,
460 .vector_size = sizeof (u32),
461 .format_trace = format_l2output_trace,
462 .type = VLIB_NODE_TYPE_INTERNAL,
464 .n_errors = ARRAY_LEN(l2output_error_strings),
465 .error_strings = l2output_error_strings,
467 .n_next_nodes = L2OUTPUT_N_NEXT,
469 /* edit / add dispositions here */
471 [L2OUTPUT_NEXT_DROP] = "error-drop",
472 [L2OUTPUT_NEXT_BAD_INTF] = "l2-output-bad-intf",
478 #define foreach_l2output_bad_intf_error \
479 _(DROP, "L2 output to interface not in L2 mode or deleted")
481 static char *l2output_bad_intf_error_strings[] = {
482 #define _(sym,string) string,
483 foreach_l2output_bad_intf_error
489 #define _(sym,str) L2OUTPUT_BAD_INTF_ERROR_##sym,
490 foreach_l2output_bad_intf_error
492 L2OUTPUT_BAD_INTF_N_ERROR,
493 } l2output_bad_intf_error_t;
497 * Output node for interfaces/tunnels which was in L2 mode but were changed
498 * to L3 mode or possibly deleted thereafter. On changing forwarding mode
499 * of any tunnel/interface from L2 to L3, its entry in l2_output_main table
500 * next_nodes.output_node_index_vec[sw_if_index] MUST be set to the value of
501 * L2OUTPUT_NEXT_BAD_INTF. Thus, if there are stale entries in the L2FIB for
502 * this sw_if_index, l2-output will send packets for this sw_if_index to the
503 * l2-output-bad-intf node which just setup the proper drop reason before
504 * sending packets to the error-drop node to drop the packet. Then, stale L2FIB
505 * entries for delted tunnels won't cause possible packet or memory corrpution.
507 static vlib_node_registration_t l2output_bad_intf_node;
510 l2output_bad_intf_node_fn (vlib_main_t * vm,
511 vlib_node_runtime_t * node, vlib_frame_t * frame)
513 u32 n_left_from, *from, *to_next;
514 l2output_next_t next_index = 0;
516 from = vlib_frame_vector_args (frame);
517 n_left_from = frame->n_vectors; /* number of packets to process */
519 while (n_left_from > 0)
523 /* get space to enqueue frame to graph node "next_index" */
524 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
526 while (n_left_from >= 4 && n_left_to_next >= 2)
529 vlib_buffer_t *b0, *b1;
531 to_next[0] = bi0 = from[0];
532 to_next[1] = bi1 = from[1];
537 b0 = vlib_get_buffer (vm, bi0);
538 b1 = vlib_get_buffer (vm, bi1);
539 b0->error = node->errors[L2OUTPUT_BAD_INTF_ERROR_DROP];
540 b1->error = node->errors[L2OUTPUT_BAD_INTF_ERROR_DROP];
543 while (n_left_from > 0 && n_left_to_next > 0)
554 b0 = vlib_get_buffer (vm, bi0);
555 b0->error = node->errors[L2OUTPUT_BAD_INTF_ERROR_DROP];
558 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
561 return frame->n_vectors;
565 VLIB_REGISTER_NODE (l2output_bad_intf_node,static) = {
566 .function = l2output_bad_intf_node_fn,
567 .name = "l2-output-bad-intf",
568 .vector_size = sizeof (u32),
569 .type = VLIB_NODE_TYPE_INTERNAL,
571 .n_errors = ARRAY_LEN(l2output_bad_intf_error_strings),
572 .error_strings = l2output_bad_intf_error_strings,
576 /* edit / add dispositions here */
584 VLIB_NODE_FUNCTION_MULTIARCH (l2output_node, l2output_node_fn)
585 clib_error_t *l2output_init (vlib_main_t * vm)
587 l2output_main_t *mp = &l2output_main;
590 mp->vnet_main = vnet_get_main ();
592 /* Create the config vector */
593 vec_validate (mp->configs, 100);
594 /* Until we hook up the CLI config, just create 100 sw interface entries and zero them */
596 /* Initialize the feature next-node indexes */
597 feat_bitmap_init_next_nodes (vm,
600 l2output_get_feat_names (),
601 mp->next_nodes.feat_next_node_index);
603 /* Initialize the output node mapping table */
604 l2output_init_output_node_vec (&mp->next_nodes.output_node_index_vec);
609 VLIB_INIT_FUNCTION (l2output_init);
615 } output_node_mapping_rpc_args_t;
617 static void output_node_rpc_callback (output_node_mapping_rpc_args_t * a);
620 output_node_mapping_send_rpc (u32 node_index, u32 sw_if_index)
622 output_node_mapping_rpc_args_t args;
623 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
625 args.node_index = node_index;
626 args.sw_if_index = sw_if_index;
628 vl_api_rpc_call_main_thread (output_node_rpc_callback,
629 (u8 *) & args, sizeof (args));
633 /** Create a mapping in the next node mapping table for the given sw_if_index. */
635 l2output_create_output_node_mapping (vlib_main_t * vlib_main, vnet_main_t * vnet_main, u32 node_index, /* index of current node */
636 u32 * output_node_index_vec,
640 u32 next; /* index of next graph node */
641 vnet_hw_interface_t *hw0;
644 hw0 = vnet_get_sup_hw_interface (vnet_main, sw_if_index);
648 cpu_number = os_get_cpu_number ();
654 oldflags = __sync_fetch_and_or (&hw0->flags,
655 VNET_HW_INTERFACE_FLAG_L2OUTPUT_MAPPED);
657 if ((oldflags & VNET_HW_INTERFACE_FLAG_L2OUTPUT_MAPPED))
658 return L2OUTPUT_NEXT_DROP;
660 output_node_mapping_send_rpc (node_index, sw_if_index);
661 return L2OUTPUT_NEXT_DROP;
664 /* dynamically create graph node arc */
665 next = vlib_node_add_next (vlib_main, node_index, hw0->output_node_index);
667 /* Initialize vector with the mapping */
669 node = vec_elt_at_index (output_node_index_vec, sw_if_index);
672 /* reset mapping bit, includes memory barrier */
673 __sync_fetch_and_and (&hw0->flags, ~VNET_HW_INTERFACE_FLAG_L2OUTPUT_MAPPED);
679 output_node_rpc_callback (output_node_mapping_rpc_args_t * a)
681 vlib_main_t *vm = vlib_get_main ();
682 vnet_main_t *vnm = vnet_get_main ();
683 l2output_main_t *mp = &l2output_main;
685 (void) l2output_create_output_node_mapping
686 (vm, vnm, a->node_index, mp->next_nodes.output_node_index_vec,
690 /* Get a pointer to the config for the given interface */
692 l2output_intf_config (u32 sw_if_index)
694 l2output_main_t *mp = &l2output_main;
696 vec_validate (mp->configs, sw_if_index);
697 return vec_elt_at_index (mp->configs, sw_if_index);
700 /** Enable (or disable) the feature in the bitmap for the given interface. */
702 l2output_intf_bitmap_enable (u32 sw_if_index, u32 feature_bitmap, u32 enable)
704 l2output_main_t *mp = &l2output_main;
705 l2_output_config_t *config;
707 vec_validate (mp->configs, sw_if_index);
708 config = vec_elt_at_index (mp->configs, sw_if_index);
712 config->feature_bitmap |= feature_bitmap;
716 config->feature_bitmap &= ~feature_bitmap;
721 * fd.io coding-style-patch-verification: ON
724 * eval: (c-set-style "gnu")