2 * Copyright (c) 2015 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/l2/feat_bitmap.h>
18 #include <vnet/l2/l2_rw.h>
20 l2_rw_main_t l2_rw_main;
22 vlib_node_registration_t l2_rw_node;
27 u32 classify_table_index;
28 u32 rewrite_entry_index;
32 format_l2_rw_entry (u8 * s, va_list * args)
34 l2_rw_entry_t *e = va_arg (*args, l2_rw_entry_t *);
35 l2_rw_main_t *rw = &l2_rw_main;
36 s = format (s, "%d - mask:%U value:%U\n",
38 format_hex_bytes, e->mask,
39 e->rewrite_n_vectors * sizeof (u32x4), format_hex_bytes,
40 e->value, e->rewrite_n_vectors * sizeof (u32x4));
42 format (s, " hits:%d skip_bytes:%d", e->hit_count,
43 e->skip_n_vectors * sizeof (u32x4));
48 format_l2_rw_config (u8 * s, va_list * args)
50 l2_rw_config_t *c = va_arg (*args, l2_rw_config_t *);
51 return format (s, "table-index:%d miss-index:%d",
52 c->table_index, c->miss_index);
55 /* packet trace format function */
57 format_l2_rw_trace (u8 * s, va_list * args)
59 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
60 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
61 l2_rw_trace_t *t = va_arg (*args, l2_rw_trace_t *);
62 return format (s, "l2-rw: sw_if_index %d, table %d, entry %d",
63 t->sw_if_index, t->classify_table_index,
64 t->rewrite_entry_index);
67 always_inline l2_rw_config_t *
68 l2_rw_get_config (u32 sw_if_index)
70 l2_rw_main_t *rw = &l2_rw_main;
71 if (PREDICT_FALSE (!clib_bitmap_get (rw->configs_bitmap, sw_if_index)))
73 vec_validate (rw->configs, sw_if_index);
74 rw->configs[sw_if_index].table_index = ~0;
75 rw->configs[sw_if_index].miss_index = ~0;
77 clib_bitmap_set (rw->configs_bitmap, sw_if_index, 1);
79 return &rw->configs[sw_if_index];
82 static_always_inline void
83 l2_rw_rewrite (l2_rw_entry_t * rwe, u8 * h)
85 if (U32X4_ALIGNED (h))
87 u32x4 *d = ((u32x4 *) h) + rwe->skip_n_vectors;
88 switch (rwe->rewrite_n_vectors)
91 d[4] = (d[4] & ~rwe->mask[4]) | rwe->value[4];
94 d[3] = (d[3] & ~rwe->mask[3]) | rwe->value[3];
97 d[2] = (d[2] & ~rwe->mask[2]) | rwe->value[2];
100 d[1] = (d[1] & ~rwe->mask[1]) | rwe->value[1];
103 d[0] = (d[0] & ~rwe->mask[0]) | rwe->value[0];
111 u64 *d = ((u64 *) h) + rwe->skip_n_vectors * 2;
112 switch (rwe->rewrite_n_vectors)
116 (d[8] & ~(((u64 *) rwe->mask)[8])) | (((u64 *) rwe->value)[8]);
118 (d[9] & ~(((u64 *) rwe->mask)[9])) | (((u64 *) rwe->value)[9]);
122 (d[6] & ~(((u64 *) rwe->mask)[6])) | (((u64 *) rwe->value)[6]);
124 (d[7] & ~(((u64 *) rwe->mask)[7])) | (((u64 *) rwe->value)[7]);
128 (d[4] & ~(((u64 *) rwe->mask)[4])) | (((u64 *) rwe->value)[4]);
130 (d[5] & ~(((u64 *) rwe->mask)[5])) | (((u64 *) rwe->value)[5]);
134 (d[2] & ~(((u64 *) rwe->mask)[2])) | (((u64 *) rwe->value)[2]);
136 (d[3] & ~(((u64 *) rwe->mask)[3])) | (((u64 *) rwe->value)[3]);
140 (d[0] & ~(((u64 *) rwe->mask)[0])) | (((u64 *) rwe->value)[0]);
142 (d[1] & ~(((u64 *) rwe->mask)[1])) | (((u64 *) rwe->value)[1]);
151 l2_rw_node_fn (vlib_main_t * vm,
152 vlib_node_runtime_t * node, vlib_frame_t * frame)
154 l2_rw_main_t *rw = &l2_rw_main;
155 u32 n_left_from, *from, *to_next, next_index;
156 vnet_classify_main_t *vcm = &vnet_classify_main;
157 f64 now = vlib_time_now (vlib_get_main ());
158 u32 prefetch_size = 0;
160 from = vlib_frame_vector_args (frame);
161 n_left_from = frame->n_vectors; /* number of packets to process */
162 next_index = node->cached_next_index;
164 while (n_left_from > 0)
168 /* get space to enqueue frame to graph node "next_index" */
169 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
171 while (n_left_from >= 4 && n_left_to_next >= 2)
173 u32 bi0, next0, sw_if_index0, feature_bitmap0, rwe_index0;
174 u32 bi1, next1, sw_if_index1, feature_bitmap1, rwe_index1;
175 vlib_buffer_t *b0, *b1;
176 ethernet_header_t *h0, *h1;
177 l2_rw_config_t *config0, *config1;
179 vnet_classify_table_t *t0, *t1;
180 vnet_classify_entry_t *e0, *e1;
181 l2_rw_entry_t *rwe0, *rwe1;
184 vlib_buffer_t *p2, *p3;
185 p2 = vlib_get_buffer (vm, from[2]);
186 p3 = vlib_get_buffer (vm, from[3]);
188 vlib_prefetch_buffer_header (p2, LOAD);
189 vlib_prefetch_buffer_header (p3, LOAD);
190 CLIB_PREFETCH (vlib_buffer_get_current (p2), prefetch_size, LOAD);
191 CLIB_PREFETCH (vlib_buffer_get_current (p3), prefetch_size, LOAD);
203 b0 = vlib_get_buffer (vm, bi0);
204 b1 = vlib_get_buffer (vm, bi1);
205 h0 = vlib_buffer_get_current (b0);
206 h1 = vlib_buffer_get_current (b1);
208 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
209 sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
210 config0 = l2_rw_get_config (sw_if_index0); /*TODO: check sw_if_index0 value */
211 config1 = l2_rw_get_config (sw_if_index1); /*TODO: check sw_if_index0 value */
212 t0 = pool_elt_at_index (vcm->tables, config0->table_index);
213 t1 = pool_elt_at_index (vcm->tables, config1->table_index);
215 (t1->skip_n_vectors + t1->match_n_vectors) * sizeof (u32x4);
217 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
218 hash1 = vnet_classify_hash_packet (t1, (u8 *) h1);
219 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
220 e1 = vnet_classify_find_entry (t1, (u8 *) h1, hash1, now);
222 while (!e0 && (t0->next_table_index != ~0))
224 t0 = pool_elt_at_index (vcm->tables, t0->next_table_index);
225 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
226 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
229 while (!e1 && (t1->next_table_index != ~0))
231 t1 = pool_elt_at_index (vcm->tables, t1->next_table_index);
232 hash1 = vnet_classify_hash_packet (t1, (u8 *) h1);
233 e1 = vnet_classify_find_entry (t1, (u8 *) h1, hash1, now);
236 rwe_index0 = e0 ? e0->opaque_index : config0->miss_index;
237 rwe_index1 = e1 ? e1->opaque_index : config1->miss_index;
239 if (rwe_index0 != ~0)
241 rwe0 = pool_elt_at_index (rw->entries, rwe_index0);
242 l2_rw_rewrite (rwe0, (u8 *) h0);
244 if (rwe_index1 != ~0)
246 rwe1 = pool_elt_at_index (rw->entries, rwe_index1);
247 l2_rw_rewrite (rwe1, (u8 *) h1);
250 if (PREDICT_FALSE ((b0->flags & VLIB_BUFFER_IS_TRACED)))
252 l2_rw_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
253 t->sw_if_index = sw_if_index0;
254 t->classify_table_index = config0->table_index;
255 t->rewrite_entry_index = rwe_index0;
258 if (PREDICT_FALSE ((b1->flags & VLIB_BUFFER_IS_TRACED)))
260 l2_rw_trace_t *t = vlib_add_trace (vm, node, b1, sizeof (*t));
261 t->sw_if_index = sw_if_index1;
262 t->classify_table_index = config1->table_index;
263 t->rewrite_entry_index = rwe_index1;
266 /* Update feature bitmap and get next feature index */
268 vnet_buffer (b0)->l2.feature_bitmap & ~L2INPUT_FEAT_RW;
270 vnet_buffer (b1)->l2.feature_bitmap & ~L2INPUT_FEAT_RW;
271 vnet_buffer (b0)->l2.feature_bitmap = feature_bitmap0;
272 vnet_buffer (b1)->l2.feature_bitmap = feature_bitmap1;
273 next0 = feat_bitmap_get_next_node_index (rw->feat_next_node_index,
275 next1 = feat_bitmap_get_next_node_index (rw->feat_next_node_index,
278 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
279 to_next, n_left_to_next,
280 bi0, bi1, next0, next1);
283 while (n_left_from > 0 && n_left_to_next > 0)
285 u32 bi0, next0, sw_if_index0, feature_bitmap0, rwe_index0;
287 ethernet_header_t *h0;
288 l2_rw_config_t *config0;
290 vnet_classify_table_t *t0;
291 vnet_classify_entry_t *e0;
301 b0 = vlib_get_buffer (vm, bi0);
302 h0 = vlib_buffer_get_current (b0);
304 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
305 config0 = l2_rw_get_config (sw_if_index0); /*TODO: check sw_if_index0 value */
306 t0 = pool_elt_at_index (vcm->tables, config0->table_index);
308 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
309 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
311 while (!e0 && (t0->next_table_index != ~0))
313 t0 = pool_elt_at_index (vcm->tables, t0->next_table_index);
314 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
315 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
318 rwe_index0 = e0 ? e0->opaque_index : config0->miss_index;
320 if (rwe_index0 != ~0)
322 rwe0 = pool_elt_at_index (rw->entries, rwe_index0);
323 l2_rw_rewrite (rwe0, (u8 *) h0);
326 if (PREDICT_FALSE ((b0->flags & VLIB_BUFFER_IS_TRACED)))
328 l2_rw_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
329 t->sw_if_index = sw_if_index0;
330 t->classify_table_index = config0->table_index;
331 t->rewrite_entry_index = rwe_index0;
334 /* Update feature bitmap and get next feature index */
336 vnet_buffer (b0)->l2.feature_bitmap & ~L2INPUT_FEAT_RW;
337 vnet_buffer (b0)->l2.feature_bitmap = feature_bitmap0;
338 next0 = feat_bitmap_get_next_node_index (rw->feat_next_node_index,
341 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
342 to_next, n_left_to_next,
345 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
348 return frame->n_vectors;
352 l2_rw_mod_entry (u32 * index,
353 u8 * mask, u8 * value, u32 len, u32 skip, u8 is_del)
355 l2_rw_main_t *rw = &l2_rw_main;
356 l2_rw_entry_t *e = 0;
359 if (pool_is_free_index (rw->entries, *index))
363 e = pool_elt_at_index (rw->entries, *index);
367 pool_get (rw->entries, e);
368 *index = e - rw->entries;
376 pool_put (rw->entries, e);
380 e->skip_n_vectors = skip / sizeof (u32x4);
381 skip -= e->skip_n_vectors * sizeof (u32x4);
382 e->rewrite_n_vectors = (skip + len - 1) / sizeof (u32x4) + 1;
383 vec_alloc_aligned (e->mask, e->rewrite_n_vectors, sizeof (u32x4));
384 memset (e->mask, 0, e->rewrite_n_vectors * sizeof (u32x4));
385 vec_alloc_aligned (e->value, e->rewrite_n_vectors, sizeof (u32x4));
386 memset (e->value, 0, e->rewrite_n_vectors * sizeof (u32x4));
388 clib_memcpy (((u8 *) e->value) + skip, value, len);
389 clib_memcpy (((u8 *) e->mask) + skip, mask, len);
392 for (i = 0; i < e->rewrite_n_vectors; i++)
394 e->value[i] &= e->mask[i];
400 static clib_error_t *
401 l2_rw_entry_cli_fn (vlib_main_t * vm,
402 unformat_input_t * input, vlib_cli_command_t * cmd)
410 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
412 if (unformat (input, "index %d", &index))
414 else if (unformat (input, "mask %U", unformat_hex_string, &mask))
416 else if (unformat (input, "value %U", unformat_hex_string, &value))
418 else if (unformat (input, "skip %d", &skip))
420 else if (unformat (input, "del"))
427 return clib_error_return (0, "Unspecified mask or value");
429 if (vec_len (mask) != vec_len (value))
430 return clib_error_return (0, "Mask and value lengths must be identical");
434 l2_rw_mod_entry (&index, mask, value, vec_len (mask), skip, del)))
435 return clib_error_return (0, "Could not add entry");
441 VLIB_CLI_COMMAND (l2_rw_entry_cli, static) = {
442 .path = "l2 rewrite entry",
444 "l2 rewrite entry [index <index>] [mask <hex-mask>] [value <hex-value>] [skip <n_bytes>] [del]",
445 .function = l2_rw_entry_cli_fn,
450 l2_rw_interface_set_table (u32 sw_if_index, u32 table_index, u32 miss_index)
452 l2_rw_config_t *c = l2_rw_get_config (sw_if_index);
453 l2_rw_main_t *rw = &l2_rw_main;
455 c->table_index = table_index;
456 c->miss_index = miss_index;
457 u32 feature_bitmap = (table_index == ~0) ? 0 : L2INPUT_FEAT_RW;
459 l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_RW, feature_bitmap);
461 if (c->table_index == ~0)
462 clib_bitmap_set (rw->configs_bitmap, sw_if_index, 0);
467 static clib_error_t *
468 l2_rw_interface_cli_fn (vlib_main_t * vm,
469 unformat_input_t * input, vlib_cli_command_t * cmd)
471 vnet_main_t *vnm = vnet_get_main ();
472 u32 table_index = ~0;
473 u32 sw_if_index = ~0;
476 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
478 unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index);
481 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
483 if (unformat (input, "table %d", &table_index))
485 else if (unformat (input, "miss-index %d", &miss_index))
491 if (sw_if_index == ~0)
492 return clib_error_return (0,
493 "You must specify an interface 'iface <interface>'",
494 format_unformat_error, input);
497 l2_rw_interface_set_table (sw_if_index, table_index, miss_index)))
498 return clib_error_return (0, "l2_rw_interface_set_table returned %d",
505 VLIB_CLI_COMMAND (l2_rw_interface_cli, static) = {
506 .path = "set interface l2 rewrite",
508 "set interface l2 rewrite <interface> [table <table index>] [miss-index <entry-index>]",
509 .function = l2_rw_interface_cli_fn,
513 static clib_error_t *
514 l2_rw_show_interfaces_cli_fn (vlib_main_t * vm,
515 unformat_input_t * input,
516 vlib_cli_command_t * cmd)
518 l2_rw_main_t *rw = &l2_rw_main;
519 if (clib_bitmap_count_set_bits (rw->configs_bitmap) == 0)
520 vlib_cli_output (vm, "No interface is currently using l2 rewrite\n");
524 clib_bitmap_foreach(i, rw->configs_bitmap, {
525 vlib_cli_output (vm, "sw_if_index:%d %U\n", i, format_l2_rw_config, &rw->configs[i]);
532 VLIB_CLI_COMMAND (l2_rw_show_interfaces_cli, static) = {
533 .path = "show l2 rewrite interfaces",
535 "show l2 rewrite interfaces",
536 .function = l2_rw_show_interfaces_cli_fn,
540 static clib_error_t *
541 l2_rw_show_entries_cli_fn (vlib_main_t * vm,
542 unformat_input_t * input, vlib_cli_command_t * cmd)
544 l2_rw_main_t *rw = &l2_rw_main;
546 if (pool_elts (rw->entries) == 0)
547 vlib_cli_output (vm, "No entries\n");
550 pool_foreach(e, rw->entries, {
551 vlib_cli_output (vm, "%U\n", format_l2_rw_entry, e);
558 VLIB_CLI_COMMAND (l2_rw_show_entries_cli, static) = {
559 .path = "show l2 rewrite entries",
561 "show l2 rewrite entries",
562 .function = l2_rw_show_entries_cli_fn,
567 l2_rw_enable_disable (u32 bridge_domain, u8 disable)
569 u32 mask = L2INPUT_FEAT_RW;
570 l2input_set_bridge_features (bridge_domain, mask, disable ? 0 : mask);
574 static clib_error_t *
575 l2_rw_set_cli_fn (vlib_main_t * vm,
576 unformat_input_t * input, vlib_cli_command_t * cmd)
581 if (unformat_check_input (input) == UNFORMAT_END_OF_INPUT ||
582 !unformat (input, "%d", &bridge_domain))
584 return clib_error_return (0, "You must specify a bridge domain");
587 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT &&
588 unformat (input, "disable"))
593 if (l2_rw_enable_disable (bridge_domain, disable))
594 return clib_error_return (0, "Could not enable or disable rewrite");
600 VLIB_CLI_COMMAND (l2_rw_set_cli, static) = {
601 .path = "set bridge-domain rewrite",
603 "set bridge-domain rewrite <bridge-domain> [disable]",
604 .function = l2_rw_set_cli_fn,
608 static clib_error_t *
609 l2_rw_init (vlib_main_t * vm)
611 l2_rw_main_t *rw = &l2_rw_main;
614 clib_bitmap_alloc (rw->configs_bitmap, 1);
615 feat_bitmap_init_next_nodes (vm,
618 l2input_get_feat_names (),
619 rw->feat_next_node_index);
623 VLIB_INIT_FUNCTION (l2_rw_init);
631 #define foreach_l2_rw_error \
632 _(UNKNOWN, "Unknown error")
636 #define _(sym,str) L2_RW_ERROR_##sym,
642 static char *l2_rw_error_strings[] = {
643 #define _(sym,string) string,
649 VLIB_REGISTER_NODE (l2_rw_node) = {
650 .function = l2_rw_node_fn,
652 .vector_size = sizeof (u32),
653 .format_trace = format_l2_rw_trace,
654 .type = VLIB_NODE_TYPE_INTERNAL,
655 .n_errors = ARRAY_LEN(l2_rw_error_strings),
656 .error_strings = l2_rw_error_strings,
657 .runtime_data_bytes = 0,
658 .n_next_nodes = L2_RW_N_NEXT,
659 .next_nodes = { [L2_RW_NEXT_DROP] = "error-drop"},
663 VLIB_NODE_FUNCTION_MULTIARCH (l2_rw_node, l2_rw_node_fn)
665 * fd.io coding-style-patch-verification: ON
668 * eval: (c-set-style "gnu")