2 * l2_flood.c : layer 2 flooding
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>
23 #include <vnet/l2/l2_input.h>
24 #include <vnet/l2/feat_bitmap.h>
25 #include <vnet/l2/l2_bvi.h>
26 #include <vnet/replication.h>
27 #include <vnet/l2/l2_fib.h>
29 #include <vppinfra/error.h>
30 #include <vppinfra/hash.h>
34 * Flooding uses the packet replication infrastructure to send a copy of the
35 * packet to each member interface. Logically the replication infrastructure
36 * expects two graph nodes: a prep node that initiates replication and sends the
37 * packet to the first destination, and a recycle node that is passed the packet
38 * after it has been transmitted.
40 * To decrease the amount of code, l2 flooding implements both functions in
41 * the same graph node. This node can tell if is it being called as the "prep"
42 * or "recycle" using replication_is_recycled().
48 // Next nodes for each feature
49 u32 feat_next_node_index[32];
51 // next node index for the L3 input node of each ethertype
52 next_by_ethertype_t l3_next;
54 /* convenience variables */
55 vlib_main_t * vlib_main;
56 vnet_main_t * vnet_main;
67 /* packet trace format function */
68 static u8 * format_l2flood_trace (u8 * s, va_list * args)
70 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
71 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
72 l2flood_trace_t * t = va_arg (*args, l2flood_trace_t *);
74 s = format (s, "l2-flood: sw_if_index %d dst %U src %U bd_index %d",
76 format_ethernet_address, t->dst,
77 format_ethernet_address, t->src,
82 l2flood_main_t l2flood_main;
84 static vlib_node_registration_t l2flood_node;
86 #define foreach_l2flood_error \
87 _(L2FLOOD, "L2 flood packets") \
88 _(REPL_FAIL, "L2 replication failures") \
89 _(NO_MEMBERS, "L2 replication complete") \
90 _(BVI_TAGGED, "BVI packet with vlan tag") \
91 _(BVI_ETHERTYPE, "BVI packet with unhandled ethertype")
94 #define _(sym,str) L2FLOOD_ERROR_##sym,
100 static char * l2flood_error_strings[] = {
101 #define _(sym,string) string,
102 foreach_l2flood_error
107 L2FLOOD_NEXT_L2_OUTPUT,
113 * Perform flooding on one packet
115 * Due to the way BVI processing can modify the packet, the BVI interface
116 * (if present) must be processed last in the replication. The member vector
117 * is arranged so that the BVI interface is always the first element.
118 * Flooding walks the vector in reverse.
120 * BVI processing causes the packet to go to L3 processing. This strips the
121 * L2 header, which is fine because the replication infrastructure restores
122 * it. However L3 processing can trigger larger changes to the packet. For
123 * example, an ARP request could be turned into an ARP reply, an ICMP request
124 * could be turned into an ICMP reply. If BVI processing is not performed
125 * last, the modified packet would be replicated to the remaining members.
128 static_always_inline void
129 l2flood_process (vlib_main_t * vm,
130 vlib_node_runtime_t * node,
131 l2flood_main_t * msm,
135 l2fib_entry_key_t * key0,
137 l2fib_entry_result_t * result0,
141 l2_bridge_domain_t *bd_config;
142 l2_flood_member_t * members;
143 i32 current_member; // signed
144 replication_context_t * ctx;
145 u8 in_shg = vnet_buffer(b0)->l2.shg;
147 if (!replication_is_recycled(b0)) {
149 // Do flood "prep node" processing
151 // Get config for the bridge domain interface
152 bd_index0 = vnet_buffer(b0)->l2.bd_index;
153 bd_config = vec_elt_at_index(l2input_main.bd_configs, bd_index0);
154 members = bd_config->members;
156 // Find first member that passes the reflection and SHG checks
157 current_member = vec_len(members) - 1;
158 while ((current_member >= 0) &&
159 ((members[current_member].sw_if_index == *sw_if_index0) ||
160 (in_shg && members[current_member].shg == in_shg))) {
164 if (current_member < 0) {
165 // No members to flood to
166 *next0 = L2FLOOD_NEXT_DROP;
167 b0->error = node->errors[L2FLOOD_ERROR_NO_MEMBERS];
171 if ((current_member > 0) &&
172 ((current_member > 1) ||
173 ((members[0].sw_if_index != *sw_if_index0) &&
174 (!in_shg || members[0].shg != in_shg)))) {
175 // If more than one member then initiate replication
176 ctx = replication_prep (vm, b0, l2flood_node.index, 1 /* l2_packet */);
177 ctx->feature_replicas = (uword) members;
178 ctx->feature_counter = current_member;
182 vnet_buffer_opaque_t *vnet_buff_op;
184 // Do flood "recycle node" processing
186 if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_REPL_FAIL))
188 (void)replication_recycle (vm, b0, 1 /* is_last */);
189 *next0 = L2FLOOD_NEXT_DROP;
190 b0->error = node->errors[L2FLOOD_ERROR_REPL_FAIL];
194 ctx = replication_get_ctx (b0);
195 replication_clear_recycled (b0);
197 members = (l2_flood_member_t *)(intptr_t) ctx->feature_replicas;
198 current_member = (i32)ctx->feature_counter - 1;
200 // Need to update input index from saved packet context
201 vnet_buff_op = (vnet_buffer_opaque_t *)ctx->vnet_buffer;
202 *sw_if_index0 = vnet_buff_op->sw_if_index[VLIB_RX];
204 // Find next member that passes the reflection and SHG check
205 while ((current_member >= 0) &&
206 ((members[current_member].sw_if_index == *sw_if_index0) ||
207 (in_shg && members[current_member].shg == in_shg))) {
211 if (current_member < 0) {
212 // No more members to flood to.
213 // Terminate replication and drop packet.
215 replication_recycle (vm, b0, 1 /* is_last */);
217 *next0 = L2FLOOD_NEXT_DROP;
218 // Ideally we woudn't bump a counter here, just silently complete
219 b0->error = node->errors[L2FLOOD_ERROR_NO_MEMBERS];
223 // Restore packet and context and continue replication
224 ctx->feature_counter = current_member;
225 replication_recycle (vm, b0,
226 ((current_member == 0) || /*is_last */
227 ((current_member == 1) &&
228 ((members[0].sw_if_index == *sw_if_index0) ||
229 (in_shg && members[0].shg == in_shg)))));
232 // Forward packet to the current member
234 if (PREDICT_TRUE(members[current_member].flags == L2_FLOOD_MEMBER_NORMAL)) {
235 // Do normal L2 forwarding
236 vnet_buffer(b0)->sw_if_index[VLIB_TX] = members[current_member].sw_if_index;
237 *next0 = L2FLOOD_NEXT_L2_OUTPUT;
245 members[current_member].sw_if_index,
249 if (PREDICT_FALSE(rc)) {
250 if (rc == TO_BVI_ERR_TAGGED) {
251 b0->error = node->errors[L2FLOOD_ERROR_BVI_TAGGED];
252 *next0 = L2FLOOD_NEXT_DROP;
253 } else if (rc == TO_BVI_ERR_ETHERTYPE) {
254 b0->error = node->errors[L2FLOOD_ERROR_BVI_ETHERTYPE];
255 *next0 = L2FLOOD_NEXT_DROP;
264 l2flood_node_fn (vlib_main_t * vm,
265 vlib_node_runtime_t * node,
266 vlib_frame_t * frame)
268 u32 n_left_from, * from, * to_next;
269 l2flood_next_t next_index;
270 l2flood_main_t * msm = &l2flood_main;
271 vlib_node_t *n = vlib_get_node (vm, l2flood_node.index);
272 u32 node_counter_base_index = n->error_heap_index;
273 vlib_error_main_t * em = &vm->error_main;
275 from = vlib_frame_vector_args (frame);
276 n_left_from = frame->n_vectors; /* number of packets to process */
277 next_index = node->cached_next_index;
279 while (n_left_from > 0)
283 /* get space to enqueue frame to graph node "next_index" */
284 vlib_get_next_frame (vm, node, next_index,
285 to_next, n_left_to_next);
287 while (n_left_from >= 6 && n_left_to_next >= 2)
290 vlib_buffer_t * b0, * b1;
292 u32 sw_if_index0, sw_if_index1;
293 l2fib_entry_key_t key0, key1;
294 l2fib_entry_result_t result0, result1;
295 u32 bucket0, bucket1;
297 /* Prefetch next iteration. */
299 vlib_buffer_t * p2, * p3, * p4, * p5;
301 p2 = vlib_get_buffer (vm, from[2]);
302 p3 = vlib_get_buffer (vm, from[3]);
303 p4 = vlib_get_buffer (vm, from[4]);
304 p5 = vlib_get_buffer (vm, from[5]);
306 // Prefetch the buffer header for the N+2 loop iteration
307 vlib_prefetch_buffer_header (p4, LOAD);
308 vlib_prefetch_buffer_header (p5, LOAD);
310 // Prefetch the replication context for the N+1 loop iteration
311 // This depends on the buffer header above
312 replication_prefetch_ctx (p2);
313 replication_prefetch_ctx (p3);
315 // Prefetch the packet for the N+1 loop iteration
316 CLIB_PREFETCH (p2->data, CLIB_CACHE_LINE_BYTES, STORE);
317 CLIB_PREFETCH (p3->data, CLIB_CACHE_LINE_BYTES, STORE);
320 /* speculatively enqueue b0 and b1 to the current next frame */
321 /* bi is "buffer index", b is pointer to the buffer */
322 to_next[0] = bi0 = from[0];
323 to_next[1] = bi1 = from[1];
329 b0 = vlib_get_buffer (vm, bi0);
330 b1 = vlib_get_buffer (vm, bi1);
332 /* RX interface handles */
333 sw_if_index0 = vnet_buffer(b0)->sw_if_index[VLIB_RX];
334 sw_if_index1 = vnet_buffer(b1)->sw_if_index[VLIB_RX];
337 em->counters[node_counter_base_index + L2FLOOD_ERROR_L2FLOOD] += 2;
339 l2flood_process (vm, node, msm, &em->counters[node_counter_base_index],
340 b0, &sw_if_index0, &key0, &bucket0, &result0, &next0);
342 l2flood_process (vm, node, msm, &em->counters[node_counter_base_index],
343 b1, &sw_if_index1, &key1, &bucket1, &result1, &next1);
345 if (PREDICT_FALSE((node->flags & VLIB_NODE_FLAG_TRACE)))
347 if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
349 l2flood_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
350 ethernet_header_t * h0 = vlib_buffer_get_current (b0);
351 t->sw_if_index = sw_if_index0;
352 t->bd_index = vnet_buffer(b0)->l2.bd_index;
353 memcpy(t->src, h0->src_address, 6);
354 memcpy(t->dst, h0->dst_address, 6);
356 if (PREDICT_FALSE(b1->flags & VLIB_BUFFER_IS_TRACED))
358 l2flood_trace_t *t = vlib_add_trace (vm, node, b1, sizeof (*t));
359 ethernet_header_t * h1 = vlib_buffer_get_current (b1);
360 t->sw_if_index = sw_if_index1;
361 t->bd_index = vnet_buffer(b1)->l2.bd_index;
362 memcpy(t->src, h1->src_address, 6);
363 memcpy(t->dst, h1->dst_address, 6);
367 /* verify speculative enqueues, maybe switch current next frame */
368 /* if next0==next1==next_index then nothing special needs to be done */
369 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
370 to_next, n_left_to_next,
371 bi0, bi1, next0, next1);
374 while (n_left_from > 0 && n_left_to_next > 0)
380 l2fib_entry_key_t key0;
381 l2fib_entry_result_t result0;
384 /* speculatively enqueue b0 to the current next frame */
392 b0 = vlib_get_buffer (vm, bi0);
394 sw_if_index0 = vnet_buffer(b0)->sw_if_index[VLIB_RX];
397 em->counters[node_counter_base_index + L2FLOOD_ERROR_L2FLOOD] += 1;
399 l2flood_process (vm, node, msm, &em->counters[node_counter_base_index],
400 b0, &sw_if_index0, &key0, &bucket0, &result0, &next0);
402 if (PREDICT_FALSE((node->flags & VLIB_NODE_FLAG_TRACE) &&
403 (b0->flags & VLIB_BUFFER_IS_TRACED)))
405 l2flood_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
406 ethernet_header_t * h0 = vlib_buffer_get_current (b0);
407 t->sw_if_index = sw_if_index0;
408 t->bd_index = vnet_buffer(b0)->l2.bd_index;
409 memcpy(t->src, h0->src_address, 6);
410 memcpy(t->dst, h0->dst_address, 6);
413 /* verify speculative enqueue, maybe switch current next frame */
414 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
415 to_next, n_left_to_next,
419 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
422 return frame->n_vectors;
426 VLIB_REGISTER_NODE (l2flood_node,static) = {
427 .function = l2flood_node_fn,
429 .vector_size = sizeof (u32),
430 .format_trace = format_l2flood_trace,
431 .type = VLIB_NODE_TYPE_INTERNAL,
433 .n_errors = ARRAY_LEN(l2flood_error_strings),
434 .error_strings = l2flood_error_strings,
436 .n_next_nodes = L2FLOOD_N_NEXT,
438 /* edit / add dispositions here */
440 [L2FLOOD_NEXT_L2_OUTPUT] = "l2-output",
441 [L2FLOOD_NEXT_DROP] = "error-drop",
445 clib_error_t *l2flood_init (vlib_main_t *vm)
447 l2flood_main_t * mp = &l2flood_main;
450 mp->vnet_main = vnet_get_main();
452 // Initialize the feature next-node indexes
453 feat_bitmap_init_next_nodes(vm,
456 l2input_get_feat_names(),
457 mp->feat_next_node_index);
462 VLIB_INIT_FUNCTION (l2flood_init);
466 // Add the L3 input node for this ethertype to the next nodes structure
468 l2flood_register_input_type (vlib_main_t * vm,
469 ethernet_type_t type,
472 l2flood_main_t * mp = &l2flood_main;
475 next_index = vlib_node_add_next (vm,
479 next_by_ethertype_register (&mp->l3_next, type, next_index);
483 // set subinterface flood enable/disable
484 // The CLI format is:
485 // set interface l2 flood <interface> [disable]
486 static clib_error_t *
487 int_flood (vlib_main_t * vm,
488 unformat_input_t * input,
489 vlib_cli_command_t * cmd)
491 vnet_main_t * vnm = vnet_get_main();
492 clib_error_t * error = 0;
496 if (! unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
498 error = clib_error_return (0, "unknown interface `%U'",
499 format_unformat_error, input);
504 if (unformat (input, "disable")) {
508 // set the interface flag
509 l2input_intf_bitmap_enable(sw_if_index, L2INPUT_FEAT_FLOOD, enable);
515 VLIB_CLI_COMMAND (int_flood_cli, static) = {
516 .path = "set interface l2 flood",
517 .short_help = "set interface l2 flood <interface> [disable]",
518 .function = int_flood,