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>
22 * @brief Layer 2 Rewrite.
24 * Layer 2-Rewrite node uses classify tables to match packets. Then, using
25 * the provisioned mask and value, modfies the packet header.
29 l2_rw_main_t l2_rw_main;
31 vlib_node_registration_t l2_rw_node;
36 u32 classify_table_index;
37 u32 rewrite_entry_index;
41 format_l2_rw_entry (u8 * s, va_list * args)
43 l2_rw_entry_t *e = va_arg (*args, l2_rw_entry_t *);
44 l2_rw_main_t *rw = &l2_rw_main;
45 s = format (s, "%d - mask:%U value:%U\n",
47 format_hex_bytes, e->mask,
48 e->rewrite_n_vectors * sizeof (u32x4), format_hex_bytes,
49 e->value, e->rewrite_n_vectors * sizeof (u32x4));
51 format (s, " hits:%d skip_bytes:%d", e->hit_count,
52 e->skip_n_vectors * sizeof (u32x4));
57 format_l2_rw_config (u8 * s, va_list * args)
59 l2_rw_config_t *c = va_arg (*args, l2_rw_config_t *);
60 return format (s, "table-index:%d miss-index:%d",
61 c->table_index, c->miss_index);
64 /* packet trace format function */
66 format_l2_rw_trace (u8 * s, va_list * args)
68 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
69 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
70 l2_rw_trace_t *t = va_arg (*args, l2_rw_trace_t *);
71 return format (s, "l2-rw: sw_if_index %d, table %d, entry %d",
72 t->sw_if_index, t->classify_table_index,
73 t->rewrite_entry_index);
76 always_inline l2_rw_config_t *
77 l2_rw_get_config (u32 sw_if_index)
79 l2_rw_main_t *rw = &l2_rw_main;
80 if (PREDICT_FALSE (!clib_bitmap_get (rw->configs_bitmap, sw_if_index)))
82 vec_validate (rw->configs, sw_if_index);
83 rw->configs[sw_if_index].table_index = ~0;
84 rw->configs[sw_if_index].miss_index = ~0;
86 clib_bitmap_set (rw->configs_bitmap, sw_if_index, 1);
88 return &rw->configs[sw_if_index];
91 static_always_inline void
92 l2_rw_rewrite (l2_rw_entry_t * rwe, u8 * h)
94 if (U32X4_ALIGNED (h))
96 u32x4 *d = ((u32x4 *) h) + rwe->skip_n_vectors;
97 switch (rwe->rewrite_n_vectors)
100 d[4] = (d[4] & ~rwe->mask[4]) | rwe->value[4];
103 d[3] = (d[3] & ~rwe->mask[3]) | rwe->value[3];
106 d[2] = (d[2] & ~rwe->mask[2]) | rwe->value[2];
109 d[1] = (d[1] & ~rwe->mask[1]) | rwe->value[1];
112 d[0] = (d[0] & ~rwe->mask[0]) | rwe->value[0];
120 u64 *d = ((u64 *) h) + rwe->skip_n_vectors * 2;
121 switch (rwe->rewrite_n_vectors)
125 (d[8] & ~(((u64 *) rwe->mask)[8])) | (((u64 *) rwe->value)[8]);
127 (d[9] & ~(((u64 *) rwe->mask)[9])) | (((u64 *) rwe->value)[9]);
131 (d[6] & ~(((u64 *) rwe->mask)[6])) | (((u64 *) rwe->value)[6]);
133 (d[7] & ~(((u64 *) rwe->mask)[7])) | (((u64 *) rwe->value)[7]);
137 (d[4] & ~(((u64 *) rwe->mask)[4])) | (((u64 *) rwe->value)[4]);
139 (d[5] & ~(((u64 *) rwe->mask)[5])) | (((u64 *) rwe->value)[5]);
143 (d[2] & ~(((u64 *) rwe->mask)[2])) | (((u64 *) rwe->value)[2]);
145 (d[3] & ~(((u64 *) rwe->mask)[3])) | (((u64 *) rwe->value)[3]);
149 (d[0] & ~(((u64 *) rwe->mask)[0])) | (((u64 *) rwe->value)[0]);
151 (d[1] & ~(((u64 *) rwe->mask)[1])) | (((u64 *) rwe->value)[1]);
160 l2_rw_node_fn (vlib_main_t * vm,
161 vlib_node_runtime_t * node, vlib_frame_t * frame)
163 l2_rw_main_t *rw = &l2_rw_main;
164 u32 n_left_from, *from, *to_next, next_index;
165 vnet_classify_main_t *vcm = &vnet_classify_main;
166 f64 now = vlib_time_now (vlib_get_main ());
167 u32 prefetch_size = 0;
169 from = vlib_frame_vector_args (frame);
170 n_left_from = frame->n_vectors; /* number of packets to process */
171 next_index = node->cached_next_index;
173 while (n_left_from > 0)
177 /* get space to enqueue frame to graph node "next_index" */
178 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
180 while (n_left_from >= 4 && n_left_to_next >= 2)
182 u32 bi0, next0, sw_if_index0, rwe_index0;
183 u32 bi1, next1, sw_if_index1, rwe_index1;
184 vlib_buffer_t *b0, *b1;
185 ethernet_header_t *h0, *h1;
186 l2_rw_config_t *config0, *config1;
188 vnet_classify_table_t *t0, *t1;
189 vnet_classify_entry_t *e0, *e1;
190 l2_rw_entry_t *rwe0, *rwe1;
193 vlib_buffer_t *p2, *p3;
194 p2 = vlib_get_buffer (vm, from[2]);
195 p3 = vlib_get_buffer (vm, from[3]);
197 vlib_prefetch_buffer_header (p2, LOAD);
198 vlib_prefetch_buffer_header (p3, LOAD);
199 CLIB_PREFETCH (vlib_buffer_get_current (p2), prefetch_size, LOAD);
200 CLIB_PREFETCH (vlib_buffer_get_current (p3), prefetch_size, LOAD);
212 b0 = vlib_get_buffer (vm, bi0);
213 b1 = vlib_get_buffer (vm, bi1);
214 h0 = vlib_buffer_get_current (b0);
215 h1 = vlib_buffer_get_current (b1);
217 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
218 sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
219 config0 = l2_rw_get_config (sw_if_index0); /*TODO: check sw_if_index0 value */
220 config1 = l2_rw_get_config (sw_if_index1); /*TODO: check sw_if_index0 value */
221 t0 = pool_elt_at_index (vcm->tables, config0->table_index);
222 t1 = pool_elt_at_index (vcm->tables, config1->table_index);
224 (t1->skip_n_vectors + t1->match_n_vectors) * sizeof (u32x4);
226 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
227 hash1 = vnet_classify_hash_packet (t1, (u8 *) h1);
228 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
229 e1 = vnet_classify_find_entry (t1, (u8 *) h1, hash1, now);
231 while (!e0 && (t0->next_table_index != ~0))
233 t0 = pool_elt_at_index (vcm->tables, t0->next_table_index);
234 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
235 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
238 while (!e1 && (t1->next_table_index != ~0))
240 t1 = pool_elt_at_index (vcm->tables, t1->next_table_index);
241 hash1 = vnet_classify_hash_packet (t1, (u8 *) h1);
242 e1 = vnet_classify_find_entry (t1, (u8 *) h1, hash1, now);
245 rwe_index0 = e0 ? e0->opaque_index : config0->miss_index;
246 rwe_index1 = e1 ? e1->opaque_index : config1->miss_index;
248 if (rwe_index0 != ~0)
250 rwe0 = pool_elt_at_index (rw->entries, rwe_index0);
251 l2_rw_rewrite (rwe0, (u8 *) h0);
253 if (rwe_index1 != ~0)
255 rwe1 = pool_elt_at_index (rw->entries, rwe_index1);
256 l2_rw_rewrite (rwe1, (u8 *) h1);
259 if (PREDICT_FALSE ((b0->flags & VLIB_BUFFER_IS_TRACED)))
261 l2_rw_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
262 t->sw_if_index = sw_if_index0;
263 t->classify_table_index = config0->table_index;
264 t->rewrite_entry_index = rwe_index0;
267 if (PREDICT_FALSE ((b1->flags & VLIB_BUFFER_IS_TRACED)))
269 l2_rw_trace_t *t = vlib_add_trace (vm, node, b1, sizeof (*t));
270 t->sw_if_index = sw_if_index1;
271 t->classify_table_index = config1->table_index;
272 t->rewrite_entry_index = rwe_index1;
275 /* Update feature bitmap and get next feature index */
276 next0 = vnet_l2_feature_next (b0, rw->feat_next_node_index,
278 next1 = vnet_l2_feature_next (b1, rw->feat_next_node_index,
281 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
282 to_next, n_left_to_next,
283 bi0, bi1, next0, next1);
286 while (n_left_from > 0 && n_left_to_next > 0)
288 u32 bi0, next0, sw_if_index0, rwe_index0;
290 ethernet_header_t *h0;
291 l2_rw_config_t *config0;
293 vnet_classify_table_t *t0;
294 vnet_classify_entry_t *e0;
304 b0 = vlib_get_buffer (vm, bi0);
305 h0 = vlib_buffer_get_current (b0);
307 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
308 config0 = l2_rw_get_config (sw_if_index0); /*TODO: check sw_if_index0 value */
309 t0 = pool_elt_at_index (vcm->tables, config0->table_index);
311 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
312 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
314 while (!e0 && (t0->next_table_index != ~0))
316 t0 = pool_elt_at_index (vcm->tables, t0->next_table_index);
317 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
318 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
321 rwe_index0 = e0 ? e0->opaque_index : config0->miss_index;
323 if (rwe_index0 != ~0)
325 rwe0 = pool_elt_at_index (rw->entries, rwe_index0);
326 l2_rw_rewrite (rwe0, (u8 *) h0);
329 if (PREDICT_FALSE ((b0->flags & VLIB_BUFFER_IS_TRACED)))
331 l2_rw_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
332 t->sw_if_index = sw_if_index0;
333 t->classify_table_index = config0->table_index;
334 t->rewrite_entry_index = rwe_index0;
337 /* Update feature bitmap and get next feature index */
338 next0 = vnet_l2_feature_next (b0, 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 * Layer 2-Rewrite node uses classify tables to match packets. Then, using
442 * the provisioned mask and value, modfies the packet header.
445 * @todo This is incomplete. This needs a detailed description and a
449 VLIB_CLI_COMMAND (l2_rw_entry_cli, static) = {
450 .path = "l2 rewrite entry",
452 "l2 rewrite entry [index <index>] [mask <hex-mask>] [value <hex-value>] [skip <n_bytes>] [del]",
453 .function = l2_rw_entry_cli_fn,
458 l2_rw_interface_set_table (u32 sw_if_index, u32 table_index, u32 miss_index)
460 l2_rw_config_t *c = l2_rw_get_config (sw_if_index);
461 l2_rw_main_t *rw = &l2_rw_main;
463 c->table_index = table_index;
464 c->miss_index = miss_index;
465 u32 feature_bitmap = (table_index == ~0) ? 0 : L2INPUT_FEAT_RW;
467 l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_RW, feature_bitmap);
469 if (c->table_index == ~0)
470 clib_bitmap_set (rw->configs_bitmap, sw_if_index, 0);
475 static clib_error_t *
476 l2_rw_interface_cli_fn (vlib_main_t * vm,
477 unformat_input_t * input, vlib_cli_command_t * cmd)
479 vnet_main_t *vnm = vnet_get_main ();
480 u32 table_index = ~0;
481 u32 sw_if_index = ~0;
484 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
486 unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index);
489 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
491 if (unformat (input, "table %d", &table_index))
493 else if (unformat (input, "miss-index %d", &miss_index))
499 if (sw_if_index == ~0)
500 return clib_error_return (0,
501 "You must specify an interface 'iface <interface>'",
502 format_unformat_error, input);
505 l2_rw_interface_set_table (sw_if_index, table_index, miss_index)))
506 return clib_error_return (0, "l2_rw_interface_set_table returned %d",
513 * Layer 2-Rewrite node uses classify tables to match packets. Then, using
514 * the provisioned mask and value, modfies the packet header.
517 * @todo This is incomplete. This needs a detailed description and a
521 VLIB_CLI_COMMAND (l2_rw_interface_cli, static) = {
522 .path = "set interface l2 rewrite",
524 "set interface l2 rewrite <interface> [table <table index>] [miss-index <entry-index>]",
525 .function = l2_rw_interface_cli_fn,
529 static clib_error_t *
530 l2_rw_show_interfaces_cli_fn (vlib_main_t * vm,
531 unformat_input_t * input,
532 vlib_cli_command_t * cmd)
534 l2_rw_main_t *rw = &l2_rw_main;
535 if (clib_bitmap_count_set_bits (rw->configs_bitmap) == 0)
536 vlib_cli_output (vm, "No interface is currently using l2 rewrite\n");
540 clib_bitmap_foreach(i, rw->configs_bitmap, {
541 vlib_cli_output (vm, "sw_if_index:%d %U\n", i, format_l2_rw_config, &rw->configs[i]);
548 * Layer 2-Rewrite node uses classify tables to match packets. Then, using
549 * the provisioned mask and value, modfies the packet header.
552 * @todo This is incomplete. This needs a detailed description and a
556 VLIB_CLI_COMMAND (l2_rw_show_interfaces_cli, static) = {
557 .path = "show l2 rewrite interfaces",
559 "show l2 rewrite interfaces",
560 .function = l2_rw_show_interfaces_cli_fn,
564 static clib_error_t *
565 l2_rw_show_entries_cli_fn (vlib_main_t * vm,
566 unformat_input_t * input, vlib_cli_command_t * cmd)
568 l2_rw_main_t *rw = &l2_rw_main;
570 if (pool_elts (rw->entries) == 0)
571 vlib_cli_output (vm, "No entries\n");
574 pool_foreach(e, rw->entries, {
575 vlib_cli_output (vm, "%U\n", format_l2_rw_entry, e);
582 * Layer 2-Rewrite node uses classify tables to match packets. Then, using
583 * the provisioned mask and value, modfies the packet header.
586 * @todo This is incomplete. This needs a detailed description and a
590 VLIB_CLI_COMMAND (l2_rw_show_entries_cli, static) = {
591 .path = "show l2 rewrite entries",
593 "show l2 rewrite entries",
594 .function = l2_rw_show_entries_cli_fn,
599 l2_rw_enable_disable (u32 bridge_domain, u8 disable)
601 u32 mask = L2INPUT_FEAT_RW;
602 l2input_set_bridge_features (bridge_domain, mask, disable ? 0 : mask);
606 static clib_error_t *
607 l2_rw_set_cli_fn (vlib_main_t * vm,
608 unformat_input_t * input, vlib_cli_command_t * cmd)
613 if (unformat_check_input (input) == UNFORMAT_END_OF_INPUT ||
614 !unformat (input, "%d", &bridge_domain))
616 return clib_error_return (0, "You must specify a bridge domain");
619 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT &&
620 unformat (input, "disable"))
625 if (l2_rw_enable_disable (bridge_domain, disable))
626 return clib_error_return (0, "Could not enable or disable rewrite");
632 * Layer 2-Rewrite node uses classify tables to match packets. Then, using
633 * the provisioned mask and value, modfies the packet header.
636 * @todo This is incomplete. This needs a detailed description and a
640 VLIB_CLI_COMMAND (l2_rw_set_cli, static) = {
641 .path = "set bridge-domain rewrite",
643 "set bridge-domain rewrite <bridge-domain> [disable]",
644 .function = l2_rw_set_cli_fn,
648 static clib_error_t *
649 l2_rw_init (vlib_main_t * vm)
651 l2_rw_main_t *rw = &l2_rw_main;
654 clib_bitmap_alloc (rw->configs_bitmap, 1);
655 feat_bitmap_init_next_nodes (vm,
658 l2input_get_feat_names (),
659 rw->feat_next_node_index);
663 VLIB_INIT_FUNCTION (l2_rw_init);
671 #define foreach_l2_rw_error \
672 _(UNKNOWN, "Unknown error")
676 #define _(sym,str) L2_RW_ERROR_##sym,
682 static char *l2_rw_error_strings[] = {
683 #define _(sym,string) string,
689 VLIB_REGISTER_NODE (l2_rw_node) = {
690 .function = l2_rw_node_fn,
692 .vector_size = sizeof (u32),
693 .format_trace = format_l2_rw_trace,
694 .type = VLIB_NODE_TYPE_INTERNAL,
695 .n_errors = ARRAY_LEN(l2_rw_error_strings),
696 .error_strings = l2_rw_error_strings,
697 .runtime_data_bytes = 0,
698 .n_next_nodes = L2_RW_N_NEXT,
699 .next_nodes = { [L2_RW_NEXT_DROP] = "error-drop"},
703 VLIB_NODE_FUNCTION_MULTIARCH (l2_rw_node, l2_rw_node_fn)
705 * fd.io coding-style-patch-verification: ON
708 * eval: (c-set-style "gnu")