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 * Return 0 if split horizon check passes, otherwise return non-zero
77 * Packets should not be transmitted out an interface with the same
78 * split-horizon group as the input interface, except if the shg is 0
79 * in which case the check always passes.
81 static_always_inline u32
82 split_horizon_violation (u8 shg1, u8 shg2)
84 if (PREDICT_TRUE (shg1 == 0))
95 static vlib_node_registration_t l2output_node;
98 l2output_node_fn (vlib_main_t * vm,
99 vlib_node_runtime_t * node, vlib_frame_t * frame)
101 u32 n_left_from, *from, *to_next;
102 l2output_next_t next_index;
103 l2output_main_t *msm = &l2output_main;
104 vlib_node_t *n = vlib_get_node (vm, l2output_node.index);
105 u32 node_counter_base_index = n->error_heap_index;
106 vlib_error_main_t *em = &vm->error_main;
107 u32 cached_sw_if_index;
108 u32 cached_next_index;
110 /* Invalidate cache */
111 cached_sw_if_index = ~0;
112 cached_next_index = ~0; /* warning be gone */
114 from = vlib_frame_vector_args (frame);
115 n_left_from = frame->n_vectors; /* number of packets to process */
116 next_index = node->cached_next_index;
118 while (n_left_from > 0)
122 /* get space to enqueue frame to graph node "next_index" */
123 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
125 while (n_left_from >= 6 && n_left_to_next >= 2)
128 vlib_buffer_t *b0, *b1;
130 u32 sw_if_index0, sw_if_index1;
131 ethernet_header_t *h0, *h1;
132 l2_output_config_t *config0, *config1;
133 u32 feature_bitmap0, feature_bitmap1;
135 /* Prefetch next iteration. */
137 vlib_buffer_t *p2, *p3, *p4, *p5;
138 u32 sw_if_index2, sw_if_index3;
140 p2 = vlib_get_buffer (vm, from[2]);
141 p3 = vlib_get_buffer (vm, from[3]);
142 p4 = vlib_get_buffer (vm, from[4]);
143 p5 = vlib_get_buffer (vm, from[5]);
145 /* Prefetch the buffer header for the N+2 loop iteration */
146 vlib_prefetch_buffer_header (p4, LOAD);
147 vlib_prefetch_buffer_header (p5, LOAD);
149 * Note: no need to prefetch packet data.
150 * This node doesn't reference it.
152 * Prefetch the input config for the N+1 loop iteration
153 * This depends on the buffer header above
155 sw_if_index2 = vnet_buffer (p2)->sw_if_index[VLIB_TX];
156 sw_if_index3 = vnet_buffer (p3)->sw_if_index[VLIB_TX];
157 CLIB_PREFETCH (&msm->configs[sw_if_index2], CLIB_CACHE_LINE_BYTES,
159 CLIB_PREFETCH (&msm->configs[sw_if_index3], CLIB_CACHE_LINE_BYTES,
163 /* speculatively enqueue b0 and b1 to the current next frame */
164 /* bi is "buffer index", b is pointer to the buffer */
165 to_next[0] = bi0 = from[0];
166 to_next[1] = bi1 = from[1];
172 b0 = vlib_get_buffer (vm, bi0);
173 b1 = vlib_get_buffer (vm, bi1);
175 /* TX interface handles */
176 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
177 sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_TX];
179 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
181 h0 = vlib_buffer_get_current (b0);
182 h1 = vlib_buffer_get_current (b1);
183 if (b0->flags & VLIB_BUFFER_IS_TRACED)
185 l2output_trace_t *t =
186 vlib_add_trace (vm, node, b0, sizeof (*t));
187 t->sw_if_index = sw_if_index0;
188 clib_memcpy (t->src, h0->src_address, 6);
189 clib_memcpy (t->dst, h0->dst_address, 6);
191 if (b1->flags & VLIB_BUFFER_IS_TRACED)
193 l2output_trace_t *t =
194 vlib_add_trace (vm, node, b1, sizeof (*t));
195 t->sw_if_index = sw_if_index1;
196 clib_memcpy (t->src, h1->src_address, 6);
197 clib_memcpy (t->dst, h1->dst_address, 6);
201 em->counters[node_counter_base_index + L2OUTPUT_ERROR_L2OUTPUT] +=
204 /* Get config for the output interface */
205 config0 = vec_elt_at_index (msm->configs, sw_if_index0);
206 config1 = vec_elt_at_index (msm->configs, sw_if_index1);
209 * Get features from the config
210 * TODO: mask out any non-applicable features
212 feature_bitmap0 = config0->feature_bitmap;
213 feature_bitmap1 = config1->feature_bitmap;
215 /* Determine next node */
216 l2_output_dispatch (msm->vlib_main,
223 b0, sw_if_index0, feature_bitmap0, &next0);
225 l2_output_dispatch (msm->vlib_main,
232 b1, sw_if_index1, feature_bitmap1, &next1);
235 * Perform output vlan tag rewrite and the pre-vtr EFP filter check.
236 * The EFP Filter only needs to be run if there is an output VTR
237 * configured. The flag for the post-vtr EFP Filter node is used
238 * to trigger the pre-vtr check as well.
241 if (PREDICT_FALSE (config0->output_vtr.push_and_pop_bytes))
243 /* Perform pre-vtr EFP filter check if configured */
244 u32 failed1 = (feature_bitmap0 & L2OUTPUT_FEAT_EFP_FILTER) &&
245 (l2_efp_filter_process (b0, &(config0->input_vtr)));
246 u32 failed2 = l2_vtr_process (b0, &(config0->output_vtr));
248 if (PREDICT_FALSE (failed1 | failed2))
250 next0 = L2OUTPUT_NEXT_DROP;
253 b0->error = node->errors[L2OUTPUT_ERROR_VTR_DROP];
257 b0->error = node->errors[L2OUTPUT_ERROR_EFP_DROP];
262 if (PREDICT_FALSE (config1->output_vtr.push_and_pop_bytes))
264 /* Perform pre-vtr EFP filter check if configured */
265 u32 failed1 = (feature_bitmap1 & L2OUTPUT_FEAT_EFP_FILTER) &&
266 (l2_efp_filter_process (b1, &(config1->input_vtr)));
267 u32 failed2 = l2_vtr_process (b1, &(config1->output_vtr));
269 if (PREDICT_FALSE (failed1 | failed2))
271 next1 = L2OUTPUT_NEXT_DROP;
274 b1->error = node->errors[L2OUTPUT_ERROR_VTR_DROP];
278 b1->error = node->errors[L2OUTPUT_ERROR_EFP_DROP];
284 * Perform the split horizon check
285 * The check can only fail for non-zero shg's
287 if (PREDICT_FALSE (config0->shg + config1->shg))
289 /* one of the checks might fail, check both */
290 if (split_horizon_violation
291 (config0->shg, vnet_buffer (b0)->l2.shg))
293 next0 = L2OUTPUT_NEXT_DROP;
294 b0->error = node->errors[L2OUTPUT_ERROR_SHG_DROP];
296 if (split_horizon_violation
297 (config1->shg, vnet_buffer (b1)->l2.shg))
299 next1 = L2OUTPUT_NEXT_DROP;
300 b1->error = node->errors[L2OUTPUT_ERROR_SHG_DROP];
304 /* verify speculative enqueues, maybe switch current next frame */
305 /* if next0==next1==next_index then nothing special needs to be done */
306 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
307 to_next, n_left_to_next,
308 bi0, bi1, next0, next1);
311 while (n_left_from > 0 && n_left_to_next > 0)
317 ethernet_header_t *h0;
318 l2_output_config_t *config0;
321 /* speculatively enqueue b0 to the current next frame */
329 b0 = vlib_get_buffer (vm, bi0);
331 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
333 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
334 && (b0->flags & VLIB_BUFFER_IS_TRACED)))
336 l2output_trace_t *t =
337 vlib_add_trace (vm, node, b0, sizeof (*t));
338 t->sw_if_index = sw_if_index0;
339 h0 = vlib_buffer_get_current (b0);
340 clib_memcpy (t->src, h0->src_address, 6);
341 clib_memcpy (t->dst, h0->dst_address, 6);
344 em->counters[node_counter_base_index + L2OUTPUT_ERROR_L2OUTPUT] +=
347 /* Get config for the output interface */
348 config0 = vec_elt_at_index (msm->configs, sw_if_index0);
351 * Get features from the config
352 * TODO: mask out any non-applicable features
354 feature_bitmap0 = config0->feature_bitmap;
356 /* Determine next node */
357 l2_output_dispatch (msm->vlib_main,
364 b0, sw_if_index0, feature_bitmap0, &next0);
367 * Perform output vlan tag rewrite and the pre-vtr EFP filter check.
368 * The EFP Filter only needs to be run if there is an output VTR
369 * configured. The flag for the post-vtr EFP Filter node is used
370 * to trigger the pre-vtr check as well.
373 if (config0->output_vtr.push_and_pop_bytes)
375 /* Perform pre-vtr EFP filter check if configured */
376 u32 failed1 = (feature_bitmap0 & L2OUTPUT_FEAT_EFP_FILTER) &&
377 (l2_efp_filter_process (b0, &(config0->input_vtr)));
378 u32 failed2 = l2_vtr_process (b0, &(config0->output_vtr));
380 if (PREDICT_FALSE (failed1 | failed2))
382 next0 = L2OUTPUT_NEXT_DROP;
385 b0->error = node->errors[L2OUTPUT_ERROR_VTR_DROP];
389 b0->error = node->errors[L2OUTPUT_ERROR_EFP_DROP];
394 /* Perform the split horizon check */
396 (split_horizon_violation
397 (config0->shg, vnet_buffer (b0)->l2.shg)))
399 next0 = L2OUTPUT_NEXT_DROP;
400 b0->error = node->errors[L2OUTPUT_ERROR_SHG_DROP];
403 /* verify speculative enqueue, maybe switch current next frame */
404 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
405 to_next, n_left_to_next,
409 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
412 return frame->n_vectors;
417 VLIB_REGISTER_NODE (l2output_node,static) = {
418 .function = l2output_node_fn,
420 .vector_size = sizeof (u32),
421 .format_trace = format_l2output_trace,
422 .type = VLIB_NODE_TYPE_INTERNAL,
424 .n_errors = ARRAY_LEN(l2output_error_strings),
425 .error_strings = l2output_error_strings,
427 .n_next_nodes = L2OUTPUT_N_NEXT,
429 /* edit / add dispositions here */
431 [L2OUTPUT_NEXT_DROP] = "error-drop",
432 [L2OUTPUT_NEXT_DEL_TUNNEL] = "l2-output-del-tunnel",
438 #define foreach_l2output_del_tunnel_error \
439 _(DROP, "L2 output to deleted tunnel")
441 static char *l2output_del_tunnel_error_strings[] = {
442 #define _(sym,string) string,
443 foreach_l2output_del_tunnel_error
449 #define _(sym,str) L2OUTPUT_DEL_TUNNEL_ERROR_##sym,
450 foreach_l2output_del_tunnel_error
452 L2OUTPUT_DEL_TUNNEL_N_ERROR,
453 } l2output_del_tunnel_error_t;
457 * Output node for tunnels which was in L2 BD's but were deleted.
458 * On deletion of any tunnel which was on a L2 BD, its entry in
459 * l2_output_main table next_nodes.output_node_index_vec[sw_if_index]
460 * MUST be set to the value of L2OUTPUT_NEXT_DEL_TUNNEL. Thus, if there
461 * are stale entries in the L2FIB for this tunnel sw_if_index, l2-output
462 * will send packets for this sw_if_index to the l2-output-tunnel-del
463 * node which just setup the proper drop reason before sending packets
464 * to the error-drop node to drop the packet. Then, stale L2FIB entries
465 * for delted tunnels won't cause possible packet or memory corrpution.
467 static vlib_node_registration_t l2output_del_tunnel_node;
470 l2output_del_tunnel_node_fn (vlib_main_t * vm,
471 vlib_node_runtime_t * node, vlib_frame_t * frame)
473 u32 n_left_from, *from, *to_next;
474 l2output_next_t next_index = 0;
476 from = vlib_frame_vector_args (frame);
477 n_left_from = frame->n_vectors; /* number of packets to process */
479 while (n_left_from > 0)
483 /* get space to enqueue frame to graph node "next_index" */
484 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
486 while (n_left_from >= 4 && n_left_to_next >= 2)
489 vlib_buffer_t *b0, *b1;
491 to_next[0] = bi0 = from[0];
492 to_next[1] = bi1 = from[1];
497 b0 = vlib_get_buffer (vm, bi0);
498 b1 = vlib_get_buffer (vm, bi1);
499 b0->error = node->errors[L2OUTPUT_DEL_TUNNEL_ERROR_DROP];
500 b1->error = node->errors[L2OUTPUT_DEL_TUNNEL_ERROR_DROP];
503 while (n_left_from > 0 && n_left_to_next > 0)
514 b0 = vlib_get_buffer (vm, bi0);
515 b0->error = node->errors[L2OUTPUT_DEL_TUNNEL_ERROR_DROP];
518 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
521 return frame->n_vectors;
525 VLIB_REGISTER_NODE (l2output_del_tunnel_node,static) = {
526 .function = l2output_del_tunnel_node_fn,
527 .name = "l2-output-del-tunnel",
528 .vector_size = sizeof (u32),
529 .type = VLIB_NODE_TYPE_INTERNAL,
531 .n_errors = ARRAY_LEN(l2output_del_tunnel_error_strings),
532 .error_strings = l2output_del_tunnel_error_strings,
536 /* edit / add dispositions here */
544 VLIB_NODE_FUNCTION_MULTIARCH (l2output_node, l2output_node_fn)
545 clib_error_t *l2output_init (vlib_main_t * vm)
547 l2output_main_t *mp = &l2output_main;
550 mp->vnet_main = vnet_get_main ();
552 /* Create the config vector */
553 vec_validate (mp->configs, 100);
554 /* Until we hook up the CLI config, just create 100 sw interface entries and zero them */
556 /* Initialize the feature next-node indexes */
557 feat_bitmap_init_next_nodes (vm,
560 l2output_get_feat_names (),
561 mp->next_nodes.feat_next_node_index);
563 /* Initialize the output node mapping table */
564 l2output_init_output_node_vec (&mp->next_nodes.output_node_index_vec);
569 VLIB_INIT_FUNCTION (l2output_init);
575 } output_node_mapping_rpc_args_t;
578 static void output_node_rpc_callback (output_node_mapping_rpc_args_t * a);
581 output_node_mapping_send_rpc (u32 node_index, u32 sw_if_index)
583 output_node_mapping_rpc_args_t args;
584 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
586 args.node_index = node_index;
587 args.sw_if_index = sw_if_index;
589 vl_api_rpc_call_main_thread (output_node_rpc_callback,
590 (u8 *) & args, sizeof (args));
595 /** Create a mapping in the next node mapping table for the given sw_if_index */
597 l2output_create_output_node_mapping (vlib_main_t * vlib_main, vnet_main_t * vnet_main, u32 node_index, /* index of current node */
598 u32 * output_node_index_vec,
602 u32 next; /* index of next graph node */
603 vnet_hw_interface_t *hw0;
606 hw0 = vnet_get_sup_hw_interface (vnet_main, sw_if_index);
611 cpu_number = os_get_cpu_number ();
617 oldflags = __sync_fetch_and_or (&hw0->flags,
618 VNET_HW_INTERFACE_FLAG_L2OUTPUT_MAPPED);
620 if ((oldflags & VNET_HW_INTERFACE_FLAG_L2OUTPUT_MAPPED))
621 return L2OUTPUT_NEXT_DROP;
623 output_node_mapping_send_rpc (node_index, sw_if_index);
624 return L2OUTPUT_NEXT_DROP;
628 /* dynamically create graph node arc */
629 next = vlib_node_add_next (vlib_main, node_index, hw0->output_node_index);
631 /* Initialize vector with the mapping */
633 node = vec_elt_at_index (output_node_index_vec, sw_if_index);
641 output_node_rpc_callback (output_node_mapping_rpc_args_t * a)
643 vlib_main_t *vm = vlib_get_main ();
644 vnet_main_t *vnm = vnet_get_main ();
645 l2output_main_t *mp = &l2output_main;
647 (void) l2output_create_output_node_mapping
648 (vm, vnm, a->node_index, mp->next_nodes.output_node_index_vec,
653 /* Get a pointer to the config for the given interface */
655 l2output_intf_config (u32 sw_if_index)
657 l2output_main_t *mp = &l2output_main;
659 vec_validate (mp->configs, sw_if_index);
660 return vec_elt_at_index (mp->configs, sw_if_index);
663 /** Enable (or disable) the feature in the bitmap for the given interface */
665 l2output_intf_bitmap_enable (u32 sw_if_index, u32 feature_bitmap, u32 enable)
667 l2output_main_t *mp = &l2output_main;
668 l2_output_config_t *config;
670 vec_validate (mp->configs, sw_if_index);
671 config = vec_elt_at_index (mp->configs, sw_if_index);
675 config->feature_bitmap |= feature_bitmap;
679 config->feature_bitmap &= ~feature_bitmap;
684 * fd.io coding-style-patch-verification: ON
687 * eval: (c-set-style "gnu")