2 * Copyright (c) 2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #include <vlib/vlib.h>
17 #include <vnet/vnet.h>
18 #include <vppinfra/error.h>
20 #include <vnet/span/span.h>
21 #include <vnet/l2/l2_input.h>
22 #include <vnet/l2/l2_output.h>
23 #include <vnet/l2/feat_bitmap.h>
25 #include <vppinfra/error.h>
26 #include <vppinfra/elog.h>
28 vlib_node_registration_t span_node;
30 /* packet trace format function */
32 format_span_trace (u8 * s, va_list * args)
34 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
35 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
36 span_trace_t *t = va_arg (*args, span_trace_t *);
38 vnet_main_t *vnm = &vnet_main;
39 s = format (s, "SPAN: mirrored %U -> %U",
40 format_vnet_sw_if_index_name, vnm, t->src_sw_if_index,
41 format_vnet_sw_if_index_name, vnm, t->mirror_sw_if_index);
46 #define foreach_span_error \
47 _(HITS, "SPAN incomming packets processed")
51 #define _(sym,str) SPAN_ERROR_##sym,
57 static char *span_error_strings[] = {
58 #define _(sym,string) string,
63 static_always_inline void
64 span_mirror (vlib_main_t * vm, vlib_node_runtime_t * node, u32 sw_if_index0,
65 vlib_buffer_t * b0, vlib_frame_t ** mirror_frames,
66 vlib_rx_or_tx_t rxtx, span_feat_t sf)
69 span_main_t *sm = &span_main;
70 vnet_main_t *vnm = &vnet_main;
71 u32 *to_mirror_next = 0;
74 span_interface_t *si0 = vec_elt_at_index (sm->interfaces, sw_if_index0);
75 span_mirror_t *sm0 = &si0->mirror_rxtx[sf][rxtx];
77 if (sm0->num_mirror_ports == 0)
80 /* Don't do it again */
81 if (PREDICT_FALSE (b0->flags & VNET_BUFFER_F_SPAN_CLONE))
85 clib_bitmap_foreach (i, sm0->mirror_ports, (
87 if (mirror_frames[i] == 0)
89 if (sf == SPAN_FEAT_L2)
90 mirror_frames[i] = vlib_get_frame_to_node (vnm->vlib_main, l2output_node.index);
92 mirror_frames[i] = vnet_get_frame_to_sw_interface (vnm, i);
94 to_mirror_next = vlib_frame_vector_args (mirror_frames[i]);
95 to_mirror_next += mirror_frames[i]->n_vectors;
97 c0 = vlib_buffer_copy (vm, b0);
98 if (PREDICT_TRUE(c0 != 0))
100 vnet_buffer (c0)->sw_if_index[VLIB_TX] = i;
101 c0->flags |= VNET_BUFFER_F_SPAN_CLONE;
102 if (sf == SPAN_FEAT_L2)
103 vnet_buffer (c0)->l2.feature_bitmap = L2OUTPUT_FEAT_OUTPUT;
104 to_mirror_next[0] = vlib_get_buffer_index (vm, c0);
105 mirror_frames[i]->n_vectors++;
106 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
108 span_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
109 t->src_sw_if_index = sw_if_index0;
110 t->mirror_sw_if_index = i;
117 static_always_inline uword
118 span_node_inline_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
119 vlib_frame_t * frame, vlib_rx_or_tx_t rxtx,
122 span_main_t *sm = &span_main;
123 vnet_main_t *vnm = &vnet_main;
124 u32 n_left_from, *from, *to_next;
125 u32 n_span_packets = 0;
128 static __thread vlib_frame_t **mirror_frames = 0;
130 from = vlib_frame_vector_args (frame);
131 n_left_from = frame->n_vectors;
132 next_index = node->cached_next_index;
134 vec_validate_aligned (mirror_frames, sm->max_sw_if_index,
135 CLIB_CACHE_LINE_BYTES);
137 while (n_left_from > 0)
141 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
143 while (n_left_from >= 4 && n_left_to_next >= 2)
154 /* speculatively enqueue b0, b1 to the current next frame */
155 to_next[0] = bi0 = from[0];
156 to_next[1] = bi1 = from[1];
162 b0 = vlib_get_buffer (vm, bi0);
163 b1 = vlib_get_buffer (vm, bi1);
164 sw_if_index0 = vnet_buffer (b0)->sw_if_index[rxtx];
165 sw_if_index1 = vnet_buffer (b1)->sw_if_index[rxtx];
167 span_mirror (vm, node, sw_if_index0, b0, mirror_frames, rxtx, sf);
168 span_mirror (vm, node, sw_if_index1, b1, mirror_frames, rxtx, sf);
175 next0 = vnet_l2_feature_next (b0, sm->l2_input_next,
177 next1 = vnet_l2_feature_next (b1, sm->l2_input_next,
182 next0 = vnet_l2_feature_next (b0, sm->l2_output_next,
184 next1 = vnet_l2_feature_next (b1, sm->l2_output_next,
188 case SPAN_FEAT_DEVICE:
190 vnet_feature_next (sw_if_index0, &next0, b0);
191 vnet_feature_next (sw_if_index1, &next1, b1);
195 /* verify speculative enqueue, maybe switch current next frame */
196 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
197 to_next, n_left_to_next,
198 bi0, bi1, next0, next1);
200 while (n_left_from > 0 && n_left_to_next > 0)
207 /* speculatively enqueue b0 to the current next frame */
208 to_next[0] = bi0 = from[0];
214 b0 = vlib_get_buffer (vm, bi0);
215 sw_if_index0 = vnet_buffer (b0)->sw_if_index[rxtx];
217 span_mirror (vm, node, sw_if_index0, b0, mirror_frames, rxtx, sf);
223 next0 = vnet_l2_feature_next (b0, sm->l2_input_next,
226 next0 = vnet_l2_feature_next (b0, sm->l2_output_next,
229 case SPAN_FEAT_DEVICE:
231 vnet_feature_next (sw_if_index0, &next0, b0);
235 /* verify speculative enqueue, maybe switch current next frame */
236 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
237 n_left_to_next, bi0, next0);
240 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
244 for (sw_if_index = 0; sw_if_index < vec_len (mirror_frames); sw_if_index++)
246 vlib_frame_t *f = mirror_frames[sw_if_index];
250 if (sf == SPAN_FEAT_L2)
251 vlib_put_frame_to_node (vnm->vlib_main, l2output_node.index, f);
253 vnet_put_frame_to_sw_interface (vnm, sw_if_index, f);
254 mirror_frames[sw_if_index] = 0;
256 vlib_node_increment_counter (vm, span_node.index, SPAN_ERROR_HITS,
259 return frame->n_vectors;
263 span_device_input_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
264 vlib_frame_t * frame)
266 return span_node_inline_fn (vm, node, frame, VLIB_RX, SPAN_FEAT_DEVICE);
270 span_device_output_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
271 vlib_frame_t * frame)
273 return span_node_inline_fn (vm, node, frame, VLIB_TX, SPAN_FEAT_DEVICE);
277 span_l2_input_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
278 vlib_frame_t * frame)
280 return span_node_inline_fn (vm, node, frame, VLIB_RX, SPAN_FEAT_L2);
284 span_l2_output_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
285 vlib_frame_t * frame)
287 return span_node_inline_fn (vm, node, frame, VLIB_TX, SPAN_FEAT_L2);
290 #define span_node_defs \
291 .vector_size = sizeof (u32), \
292 .format_trace = format_span_trace, \
293 .type = VLIB_NODE_TYPE_INTERNAL, \
294 .n_errors = ARRAY_LEN(span_error_strings), \
295 .error_strings = span_error_strings, \
302 VLIB_REGISTER_NODE (span_input_node) = {
304 .function = span_device_input_node_fn,
305 .name = "span-input",
308 VLIB_NODE_FUNCTION_MULTIARCH (span_input_node, span_device_input_node_fn)
310 VLIB_REGISTER_NODE (span_output_node) = {
312 .function = span_device_output_node_fn,
313 .name = "span-output",
316 VLIB_NODE_FUNCTION_MULTIARCH (span_output_node, span_device_output_node_fn)
318 VLIB_REGISTER_NODE (span_l2_input_node) = {
320 .function = span_l2_input_node_fn,
321 .name = "span-l2-input",
324 VLIB_NODE_FUNCTION_MULTIARCH (span_l2_input_node, span_l2_input_node_fn)
326 VLIB_REGISTER_NODE (span_l2_output_node) = {
328 .function = span_l2_output_node_fn,
329 .name = "span-l2-output",
332 VLIB_NODE_FUNCTION_MULTIARCH (span_l2_output_node, span_l2_output_node_fn)
334 clib_error_t *span_init (vlib_main_t * vm)
336 span_main_t *sm = &span_main;
339 sm->vnet_main = vnet_get_main ();
341 /* Initialize the feature next-node indexes */
342 feat_bitmap_init_next_nodes (vm,
343 span_l2_input_node.index,
345 l2input_get_feat_names (),
348 feat_bitmap_init_next_nodes (vm,
349 span_l2_output_node.index,
351 l2output_get_feat_names (),
356 VLIB_INIT_FUNCTION (span_init);
359 #undef span_node_defs
361 * fd.io coding-style-patch-verification: ON
364 * eval: (c-set-style "gnu")