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 */
53 /* packet trace format function */
55 format_l2output_trace (u8 * s, va_list * args)
57 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
58 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
59 l2output_trace_t *t = va_arg (*args, l2output_trace_t *);
61 s = format (s, "l2-output: sw_if_index %d dst %U src %U",
63 format_ethernet_address, t->dst,
64 format_ethernet_address, t->src);
69 static char *l2output_error_strings[] = {
70 #define _(sym,string) string,
71 foreach_l2output_error
76 * Check for split horizon violations.
77 * Return 0 if split horizon check passes, otherwise return non-zero.
78 * Packets should not be transmitted out an interface with the same
79 * split-horizon group as the input interface, except if the @c shg is 0
80 * in which case the check always passes.
82 static_always_inline u32
83 split_horizon_violation (u8 shg1, u8 shg2)
85 if (PREDICT_TRUE (shg1 == 0))
96 static vlib_node_registration_t l2output_node;
99 l2output_node_fn (vlib_main_t * vm,
100 vlib_node_runtime_t * node, vlib_frame_t * frame)
102 u32 n_left_from, *from, *to_next;
103 l2output_next_t next_index;
104 l2output_main_t *msm = &l2output_main;
105 vlib_node_t *n = vlib_get_node (vm, l2output_node.index);
106 u32 node_counter_base_index = n->error_heap_index;
107 vlib_error_main_t *em = &vm->error_main;
108 u32 cached_sw_if_index;
109 u32 cached_next_index;
111 /* Invalidate cache */
112 cached_sw_if_index = ~0;
113 cached_next_index = ~0; /* warning be gone */
115 from = vlib_frame_vector_args (frame);
116 n_left_from = frame->n_vectors; /* number of packets to process */
117 next_index = node->cached_next_index;
119 while (n_left_from > 0)
123 /* get space to enqueue frame to graph node "next_index" */
124 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
126 while (n_left_from >= 6 && n_left_to_next >= 2)
129 vlib_buffer_t *b0, *b1;
131 u32 sw_if_index0, sw_if_index1;
132 ethernet_header_t *h0, *h1;
133 l2_output_config_t *config0, *config1;
134 u32 feature_bitmap0, feature_bitmap1;
136 /* Prefetch next iteration. */
138 vlib_buffer_t *p2, *p3, *p4, *p5;
139 u32 sw_if_index2, sw_if_index3;
141 p2 = vlib_get_buffer (vm, from[2]);
142 p3 = vlib_get_buffer (vm, from[3]);
143 p4 = vlib_get_buffer (vm, from[4]);
144 p5 = vlib_get_buffer (vm, from[5]);
146 /* Prefetch the buffer header for the N+2 loop iteration */
147 vlib_prefetch_buffer_header (p4, LOAD);
148 vlib_prefetch_buffer_header (p5, LOAD);
150 * Note: no need to prefetch packet data.
151 * This node doesn't reference it.
153 * Prefetch the input config for the N+1 loop iteration
154 * This depends on the buffer header above
156 sw_if_index2 = vnet_buffer (p2)->sw_if_index[VLIB_TX];
157 sw_if_index3 = vnet_buffer (p3)->sw_if_index[VLIB_TX];
158 CLIB_PREFETCH (&msm->configs[sw_if_index2], CLIB_CACHE_LINE_BYTES,
160 CLIB_PREFETCH (&msm->configs[sw_if_index3], CLIB_CACHE_LINE_BYTES,
164 /* speculatively enqueue b0 and b1 to the current next frame */
165 /* bi is "buffer index", b is pointer to the buffer */
166 to_next[0] = bi0 = from[0];
167 to_next[1] = bi1 = from[1];
173 b0 = vlib_get_buffer (vm, bi0);
174 b1 = vlib_get_buffer (vm, bi1);
176 /* TX interface handles */
177 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
178 sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_TX];
180 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
182 h0 = vlib_buffer_get_current (b0);
183 h1 = vlib_buffer_get_current (b1);
184 if (b0->flags & VLIB_BUFFER_IS_TRACED)
186 l2output_trace_t *t =
187 vlib_add_trace (vm, node, b0, sizeof (*t));
188 t->sw_if_index = sw_if_index0;
189 clib_memcpy (t->src, h0->src_address, 6);
190 clib_memcpy (t->dst, h0->dst_address, 6);
192 if (b1->flags & VLIB_BUFFER_IS_TRACED)
194 l2output_trace_t *t =
195 vlib_add_trace (vm, node, b1, sizeof (*t));
196 t->sw_if_index = sw_if_index1;
197 clib_memcpy (t->src, h1->src_address, 6);
198 clib_memcpy (t->dst, h1->dst_address, 6);
202 em->counters[node_counter_base_index + L2OUTPUT_ERROR_L2OUTPUT] +=
205 /* Get config for the output interface */
206 config0 = vec_elt_at_index (msm->configs, sw_if_index0);
207 config1 = vec_elt_at_index (msm->configs, sw_if_index1);
210 * Get features from the config
211 * TODO: mask out any non-applicable features
213 feature_bitmap0 = config0->feature_bitmap;
214 feature_bitmap1 = config1->feature_bitmap;
216 /* Determine next node */
217 l2_output_dispatch (msm->vlib_main,
224 b0, sw_if_index0, feature_bitmap0, &next0);
226 l2_output_dispatch (msm->vlib_main,
233 b1, sw_if_index1, feature_bitmap1, &next1);
236 * Perform output vlan tag rewrite and the pre-vtr EFP filter check.
237 * The EFP Filter only needs to be run if there is an output VTR
238 * configured. The flag for the post-vtr EFP Filter node is used
239 * to trigger the pre-vtr check as well.
242 if (PREDICT_FALSE (config0->output_vtr.push_and_pop_bytes))
244 /* Perform pre-vtr EFP filter check if configured */
245 u32 failed1 = (feature_bitmap0 & L2OUTPUT_FEAT_EFP_FILTER) &&
246 (l2_efp_filter_process (b0, &(config0->input_vtr)));
247 u32 failed2 = l2_vtr_process (b0, &(config0->output_vtr));
249 if (PREDICT_FALSE (failed1 | failed2))
251 next0 = L2OUTPUT_NEXT_DROP;
254 b0->error = node->errors[L2OUTPUT_ERROR_VTR_DROP];
258 b0->error = node->errors[L2OUTPUT_ERROR_EFP_DROP];
263 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));
270 if (PREDICT_FALSE (failed1 | failed2))
272 next1 = L2OUTPUT_NEXT_DROP;
275 b1->error = node->errors[L2OUTPUT_ERROR_VTR_DROP];
279 b1->error = node->errors[L2OUTPUT_ERROR_EFP_DROP];
285 * Perform the split horizon check
286 * The check can only fail for non-zero shg's
288 if (PREDICT_FALSE (config0->shg + config1->shg))
290 /* one of the checks might fail, check both */
291 if (split_horizon_violation
292 (config0->shg, vnet_buffer (b0)->l2.shg))
294 next0 = L2OUTPUT_NEXT_DROP;
295 b0->error = node->errors[L2OUTPUT_ERROR_SHG_DROP];
297 if (split_horizon_violation
298 (config1->shg, vnet_buffer (b1)->l2.shg))
300 next1 = L2OUTPUT_NEXT_DROP;
301 b1->error = node->errors[L2OUTPUT_ERROR_SHG_DROP];
305 /* verify speculative enqueues, maybe switch current next frame */
306 /* if next0==next1==next_index then nothing special needs to be done */
307 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
308 to_next, n_left_to_next,
309 bi0, bi1, next0, next1);
312 while (n_left_from > 0 && n_left_to_next > 0)
318 ethernet_header_t *h0;
319 l2_output_config_t *config0;
322 /* speculatively enqueue b0 to the current next frame */
330 b0 = vlib_get_buffer (vm, bi0);
332 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
334 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
335 && (b0->flags & VLIB_BUFFER_IS_TRACED)))
337 l2output_trace_t *t =
338 vlib_add_trace (vm, node, b0, sizeof (*t));
339 t->sw_if_index = sw_if_index0;
340 h0 = vlib_buffer_get_current (b0);
341 clib_memcpy (t->src, h0->src_address, 6);
342 clib_memcpy (t->dst, h0->dst_address, 6);
345 em->counters[node_counter_base_index + L2OUTPUT_ERROR_L2OUTPUT] +=
348 /* Get config for the output interface */
349 config0 = vec_elt_at_index (msm->configs, sw_if_index0);
352 * Get features from the config
353 * TODO: mask out any non-applicable features
355 feature_bitmap0 = config0->feature_bitmap;
357 /* Determine next node */
358 l2_output_dispatch (msm->vlib_main,
365 b0, sw_if_index0, feature_bitmap0, &next0);
368 * Perform output vlan tag rewrite and the pre-vtr EFP filter check.
369 * The EFP Filter only needs to be run if there is an output VTR
370 * configured. The flag for the post-vtr EFP Filter node is used
371 * to trigger the pre-vtr check as well.
374 if (config0->output_vtr.push_and_pop_bytes)
376 /* Perform pre-vtr EFP filter check if configured */
377 u32 failed1 = (feature_bitmap0 & L2OUTPUT_FEAT_EFP_FILTER) &&
378 (l2_efp_filter_process (b0, &(config0->input_vtr)));
379 u32 failed2 = l2_vtr_process (b0, &(config0->output_vtr));
381 if (PREDICT_FALSE (failed1 | failed2))
383 next0 = L2OUTPUT_NEXT_DROP;
386 b0->error = node->errors[L2OUTPUT_ERROR_VTR_DROP];
390 b0->error = node->errors[L2OUTPUT_ERROR_EFP_DROP];
395 /* Perform the split horizon check */
397 (split_horizon_violation
398 (config0->shg, vnet_buffer (b0)->l2.shg)))
400 next0 = L2OUTPUT_NEXT_DROP;
401 b0->error = node->errors[L2OUTPUT_ERROR_SHG_DROP];
404 /* verify speculative enqueue, maybe switch current next frame */
405 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
406 to_next, n_left_to_next,
410 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
413 return frame->n_vectors;
418 VLIB_REGISTER_NODE (l2output_node,static) = {
419 .function = l2output_node_fn,
421 .vector_size = sizeof (u32),
422 .format_trace = format_l2output_trace,
423 .type = VLIB_NODE_TYPE_INTERNAL,
425 .n_errors = ARRAY_LEN(l2output_error_strings),
426 .error_strings = l2output_error_strings,
428 .n_next_nodes = L2OUTPUT_N_NEXT,
430 /* edit / add dispositions here */
432 [L2OUTPUT_NEXT_DROP] = "error-drop",
433 [L2OUTPUT_NEXT_DEL_TUNNEL] = "l2-output-del-tunnel",
439 #define foreach_l2output_del_tunnel_error \
440 _(DROP, "L2 output to deleted tunnel")
442 static char *l2output_del_tunnel_error_strings[] = {
443 #define _(sym,string) string,
444 foreach_l2output_del_tunnel_error
450 #define _(sym,str) L2OUTPUT_DEL_TUNNEL_ERROR_##sym,
451 foreach_l2output_del_tunnel_error
453 L2OUTPUT_DEL_TUNNEL_N_ERROR,
454 } l2output_del_tunnel_error_t;
458 * Output node for tunnels which was in L2 BD's but were deleted.
459 * On deletion of any tunnel which was on a L2 BD, its entry in
460 * l2_output_main table next_nodes.output_node_index_vec[sw_if_index]
461 * MUST be set to the value of L2OUTPUT_NEXT_DEL_TUNNEL. Thus, if there
462 * are stale entries in the L2FIB for this tunnel sw_if_index, l2-output
463 * will send packets for this sw_if_index to the l2-output-tunnel-del
464 * node which just setup the proper drop reason before sending packets
465 * to the error-drop node to drop the packet. Then, stale L2FIB entries
466 * for delted tunnels won't cause possible packet or memory corrpution.
468 static vlib_node_registration_t l2output_del_tunnel_node;
471 l2output_del_tunnel_node_fn (vlib_main_t * vm,
472 vlib_node_runtime_t * node, vlib_frame_t * frame)
474 u32 n_left_from, *from, *to_next;
475 l2output_next_t next_index = 0;
477 from = vlib_frame_vector_args (frame);
478 n_left_from = frame->n_vectors; /* number of packets to process */
480 while (n_left_from > 0)
484 /* get space to enqueue frame to graph node "next_index" */
485 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
487 while (n_left_from >= 4 && n_left_to_next >= 2)
490 vlib_buffer_t *b0, *b1;
492 to_next[0] = bi0 = from[0];
493 to_next[1] = bi1 = from[1];
498 b0 = vlib_get_buffer (vm, bi0);
499 b1 = vlib_get_buffer (vm, bi1);
500 b0->error = node->errors[L2OUTPUT_DEL_TUNNEL_ERROR_DROP];
501 b1->error = node->errors[L2OUTPUT_DEL_TUNNEL_ERROR_DROP];
504 while (n_left_from > 0 && n_left_to_next > 0)
515 b0 = vlib_get_buffer (vm, bi0);
516 b0->error = node->errors[L2OUTPUT_DEL_TUNNEL_ERROR_DROP];
519 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
522 return frame->n_vectors;
526 VLIB_REGISTER_NODE (l2output_del_tunnel_node,static) = {
527 .function = l2output_del_tunnel_node_fn,
528 .name = "l2-output-del-tunnel",
529 .vector_size = sizeof (u32),
530 .type = VLIB_NODE_TYPE_INTERNAL,
532 .n_errors = ARRAY_LEN(l2output_del_tunnel_error_strings),
533 .error_strings = l2output_del_tunnel_error_strings,
537 /* edit / add dispositions here */
545 VLIB_NODE_FUNCTION_MULTIARCH (l2output_node, l2output_node_fn)
546 clib_error_t *l2output_init (vlib_main_t * vm)
548 l2output_main_t *mp = &l2output_main;
551 mp->vnet_main = vnet_get_main ();
553 /* Create the config vector */
554 vec_validate (mp->configs, 100);
555 /* Until we hook up the CLI config, just create 100 sw interface entries and zero them */
557 /* Initialize the feature next-node indexes */
558 feat_bitmap_init_next_nodes (vm,
561 l2output_get_feat_names (),
562 mp->next_nodes.feat_next_node_index);
564 /* Initialize the output node mapping table */
565 l2output_init_output_node_vec (&mp->next_nodes.output_node_index_vec);
570 VLIB_INIT_FUNCTION (l2output_init);
576 } output_node_mapping_rpc_args_t;
579 static void output_node_rpc_callback (output_node_mapping_rpc_args_t * a);
582 output_node_mapping_send_rpc (u32 node_index, u32 sw_if_index)
584 output_node_mapping_rpc_args_t args;
585 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
587 args.node_index = node_index;
588 args.sw_if_index = sw_if_index;
590 vl_api_rpc_call_main_thread (output_node_rpc_callback,
591 (u8 *) & args, sizeof (args));
596 /** Create a mapping in the next node mapping table for the given sw_if_index. */
598 l2output_create_output_node_mapping (vlib_main_t * vlib_main, vnet_main_t * vnet_main, u32 node_index, /* index of current node */
599 u32 * output_node_index_vec,
603 u32 next; /* index of next graph node */
604 vnet_hw_interface_t *hw0;
607 hw0 = vnet_get_sup_hw_interface (vnet_main, sw_if_index);
612 cpu_number = os_get_cpu_number ();
618 oldflags = __sync_fetch_and_or (&hw0->flags,
619 VNET_HW_INTERFACE_FLAG_L2OUTPUT_MAPPED);
621 if ((oldflags & VNET_HW_INTERFACE_FLAG_L2OUTPUT_MAPPED))
622 return L2OUTPUT_NEXT_DROP;
624 output_node_mapping_send_rpc (node_index, sw_if_index);
625 return L2OUTPUT_NEXT_DROP;
629 /* dynamically create graph node arc */
630 next = vlib_node_add_next (vlib_main, node_index, hw0->output_node_index);
632 /* Initialize vector with the mapping */
634 node = vec_elt_at_index (output_node_index_vec, sw_if_index);
642 output_node_rpc_callback (output_node_mapping_rpc_args_t * a)
644 vlib_main_t *vm = vlib_get_main ();
645 vnet_main_t *vnm = vnet_get_main ();
646 l2output_main_t *mp = &l2output_main;
648 (void) l2output_create_output_node_mapping
649 (vm, vnm, a->node_index, mp->next_nodes.output_node_index_vec,
654 /* Get a pointer to the config for the given interface */
656 l2output_intf_config (u32 sw_if_index)
658 l2output_main_t *mp = &l2output_main;
660 vec_validate (mp->configs, sw_if_index);
661 return vec_elt_at_index (mp->configs, sw_if_index);
664 /** Enable (or disable) the feature in the bitmap for the given interface. */
666 l2output_intf_bitmap_enable (u32 sw_if_index, u32 feature_bitmap, u32 enable)
668 l2output_main_t *mp = &l2output_main;
669 l2_output_config_t *config;
671 vec_validate (mp->configs, sw_if_index);
672 config = vec_elt_at_index (mp->configs, sw_if_index);
676 config->feature_bitmap |= feature_bitmap;
680 config->feature_bitmap &= ~feature_bitmap;
685 * fd.io coding-style-patch-verification: ON
688 * eval: (c-set-style "gnu")