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, modifies 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 ());
168 from = vlib_frame_vector_args (frame);
169 n_left_from = frame->n_vectors; /* number of packets to process */
170 next_index = node->cached_next_index;
172 while (n_left_from > 0)
176 /* get space to enqueue frame to graph node "next_index" */
177 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
179 while (n_left_from >= 6 && n_left_to_next >= 2)
181 u32 bi0, next0, sw_if_index0, rwe_index0;
182 u32 bi1, next1, sw_if_index1, rwe_index1;
183 vlib_buffer_t *b0, *b1;
184 ethernet_header_t *h0, *h1;
185 l2_rw_config_t *config0, *config1;
187 vnet_classify_table_t *t0, *t1;
188 vnet_classify_entry_t *e0, *e1;
189 l2_rw_entry_t *rwe0, *rwe1;
192 vlib_buffer_t *p2, *p3, *p4, *p5;
193 p2 = vlib_get_buffer (vm, from[2]);
194 p3 = vlib_get_buffer (vm, from[3]);
195 p4 = vlib_get_buffer (vm, from[4]);
196 p5 = vlib_get_buffer (vm, from[5]);
198 vlib_prefetch_buffer_header (p4, LOAD);
199 vlib_prefetch_buffer_header (p5, LOAD);
200 vlib_prefetch_buffer_data (p2, LOAD);
201 vlib_prefetch_buffer_data (p3, LOAD);
213 b0 = vlib_get_buffer (vm, bi0);
214 b1 = vlib_get_buffer (vm, bi1);
215 h0 = vlib_buffer_get_current (b0);
216 h1 = vlib_buffer_get_current (b1);
218 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
219 sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
220 config0 = l2_rw_get_config (sw_if_index0); /*TODO: check sw_if_index0 value */
221 config1 = l2_rw_get_config (sw_if_index1); /*TODO: check sw_if_index0 value */
222 t0 = pool_elt_at_index (vcm->tables, config0->table_index);
223 t1 = pool_elt_at_index (vcm->tables, config1->table_index);
225 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
226 hash1 = vnet_classify_hash_packet (t1, (u8 *) h1);
227 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
228 e1 = vnet_classify_find_entry (t1, (u8 *) h1, hash1, now);
230 while (!e0 && (t0->next_table_index != ~0))
232 t0 = pool_elt_at_index (vcm->tables, t0->next_table_index);
233 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
234 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
237 while (!e1 && (t1->next_table_index != ~0))
239 t1 = pool_elt_at_index (vcm->tables, t1->next_table_index);
240 hash1 = vnet_classify_hash_packet (t1, (u8 *) h1);
241 e1 = vnet_classify_find_entry (t1, (u8 *) h1, hash1, now);
244 rwe_index0 = e0 ? e0->opaque_index : config0->miss_index;
245 rwe_index1 = e1 ? e1->opaque_index : config1->miss_index;
247 if (rwe_index0 != ~0)
249 rwe0 = pool_elt_at_index (rw->entries, rwe_index0);
250 l2_rw_rewrite (rwe0, (u8 *) h0);
252 if (rwe_index1 != ~0)
254 rwe1 = pool_elt_at_index (rw->entries, rwe_index1);
255 l2_rw_rewrite (rwe1, (u8 *) h1);
258 if (PREDICT_FALSE ((b0->flags & VLIB_BUFFER_IS_TRACED)))
260 l2_rw_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
261 t->sw_if_index = sw_if_index0;
262 t->classify_table_index = config0->table_index;
263 t->rewrite_entry_index = rwe_index0;
266 if (PREDICT_FALSE ((b1->flags & VLIB_BUFFER_IS_TRACED)))
268 l2_rw_trace_t *t = vlib_add_trace (vm, node, b1, sizeof (*t));
269 t->sw_if_index = sw_if_index1;
270 t->classify_table_index = config1->table_index;
271 t->rewrite_entry_index = rwe_index1;
274 /* Update feature bitmap and get next feature index */
275 next0 = vnet_l2_feature_next (b0, rw->feat_next_node_index,
277 next1 = vnet_l2_feature_next (b1, rw->feat_next_node_index,
280 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
281 to_next, n_left_to_next,
282 bi0, bi1, next0, next1);
285 while (n_left_from > 0 && n_left_to_next > 0)
287 u32 bi0, next0, sw_if_index0, rwe_index0;
289 ethernet_header_t *h0;
290 l2_rw_config_t *config0;
292 vnet_classify_table_t *t0;
293 vnet_classify_entry_t *e0;
303 b0 = vlib_get_buffer (vm, bi0);
304 h0 = vlib_buffer_get_current (b0);
306 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
307 config0 = l2_rw_get_config (sw_if_index0); /*TODO: check sw_if_index0 value */
308 t0 = pool_elt_at_index (vcm->tables, config0->table_index);
310 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
311 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
313 while (!e0 && (t0->next_table_index != ~0))
315 t0 = pool_elt_at_index (vcm->tables, t0->next_table_index);
316 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
317 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
320 rwe_index0 = e0 ? e0->opaque_index : config0->miss_index;
322 if (rwe_index0 != ~0)
324 rwe0 = pool_elt_at_index (rw->entries, rwe_index0);
325 l2_rw_rewrite (rwe0, (u8 *) h0);
328 if (PREDICT_FALSE ((b0->flags & VLIB_BUFFER_IS_TRACED)))
330 l2_rw_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
331 t->sw_if_index = sw_if_index0;
332 t->classify_table_index = config0->table_index;
333 t->rewrite_entry_index = rwe_index0;
336 /* Update feature bitmap and get next feature index */
337 next0 = vnet_l2_feature_next (b0, rw->feat_next_node_index,
340 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
341 to_next, n_left_to_next,
344 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
347 return frame->n_vectors;
351 l2_rw_mod_entry (u32 * index,
352 u8 * mask, u8 * value, u32 len, u32 skip, u8 is_del)
354 l2_rw_main_t *rw = &l2_rw_main;
355 l2_rw_entry_t *e = 0;
358 if (pool_is_free_index (rw->entries, *index))
362 e = pool_elt_at_index (rw->entries, *index);
366 pool_get (rw->entries, e);
367 *index = e - rw->entries;
375 pool_put (rw->entries, e);
379 e->skip_n_vectors = skip / sizeof (u32x4);
380 skip -= e->skip_n_vectors * sizeof (u32x4);
381 e->rewrite_n_vectors = (skip + len - 1) / sizeof (u32x4) + 1;
382 vec_alloc_aligned (e->mask, e->rewrite_n_vectors, sizeof (u32x4));
383 clib_memset (e->mask, 0, e->rewrite_n_vectors * sizeof (u32x4));
384 vec_alloc_aligned (e->value, e->rewrite_n_vectors, sizeof (u32x4));
385 clib_memset (e->value, 0, e->rewrite_n_vectors * sizeof (u32x4));
387 clib_memcpy (((u8 *) e->value) + skip, value, len);
388 clib_memcpy (((u8 *) e->mask) + skip, mask, len);
391 for (i = 0; i < e->rewrite_n_vectors; i++)
393 e->value[i] &= e->mask[i];
399 static clib_error_t *
400 l2_rw_entry_cli_fn (vlib_main_t * vm,
401 unformat_input_t * input, vlib_cli_command_t * cmd)
409 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
411 if (unformat (input, "index %d", &index))
413 else if (unformat (input, "mask %U", unformat_hex_string, &mask))
415 else if (unformat (input, "value %U", unformat_hex_string, &value))
417 else if (unformat (input, "skip %d", &skip))
419 else if (unformat (input, "del"))
426 return clib_error_return (0, "Unspecified mask or value");
428 if (vec_len (mask) != vec_len (value))
429 return clib_error_return (0, "Mask and value lengths must be identical");
433 l2_rw_mod_entry (&index, mask, value, vec_len (mask), skip, del)))
434 return clib_error_return (0, "Could not add entry");
440 * Layer 2-Rewrite node uses classify tables to match packets. Then, using
441 * the provisioned mask and value, modifies the packet header.
444 * @todo This is incomplete. This needs a detailed description and a
448 VLIB_CLI_COMMAND (l2_rw_entry_cli, static) = {
449 .path = "l2 rewrite entry",
451 "l2 rewrite entry [index <index>] [mask <hex-mask>] [value <hex-value>] [skip <n_bytes>] [del]",
452 .function = l2_rw_entry_cli_fn,
457 l2_rw_interface_set_table (u32 sw_if_index, u32 table_index, u32 miss_index)
459 l2_rw_config_t *c = l2_rw_get_config (sw_if_index);
460 l2_rw_main_t *rw = &l2_rw_main;
462 c->table_index = table_index;
463 c->miss_index = miss_index;
464 u32 feature_bitmap = (table_index == ~0) ? 0 : L2INPUT_FEAT_RW;
466 l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_RW, feature_bitmap);
468 if (c->table_index == ~0)
469 clib_bitmap_set (rw->configs_bitmap, sw_if_index, 0);
474 static clib_error_t *
475 l2_rw_interface_cli_fn (vlib_main_t * vm,
476 unformat_input_t * input, vlib_cli_command_t * cmd)
478 vnet_main_t *vnm = vnet_get_main ();
479 u32 table_index = ~0;
480 u32 sw_if_index = ~0;
483 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
485 unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index);
488 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
490 if (unformat (input, "table %d", &table_index))
492 else if (unformat (input, "miss-index %d", &miss_index))
498 if (sw_if_index == ~0)
499 return clib_error_return (0,
500 "You must specify an interface 'iface <interface>'",
501 format_unformat_error, input);
504 l2_rw_interface_set_table (sw_if_index, table_index, miss_index)))
505 return clib_error_return (0, "l2_rw_interface_set_table returned %d",
512 * Layer 2-Rewrite node uses classify tables to match packets. Then, using
513 * the provisioned mask and value, modifies the packet header.
516 * @todo This is incomplete. This needs a detailed description and a
520 VLIB_CLI_COMMAND (l2_rw_interface_cli, static) = {
521 .path = "set interface l2 rewrite",
523 "set interface l2 rewrite <interface> [table <table index>] [miss-index <entry-index>]",
524 .function = l2_rw_interface_cli_fn,
528 static clib_error_t *
529 l2_rw_show_interfaces_cli_fn (vlib_main_t * vm,
530 unformat_input_t * input,
531 vlib_cli_command_t * cmd)
533 l2_rw_main_t *rw = &l2_rw_main;
534 if (clib_bitmap_count_set_bits (rw->configs_bitmap) == 0)
535 vlib_cli_output (vm, "No interface is currently using l2 rewrite\n");
539 clib_bitmap_foreach(i, rw->configs_bitmap, {
540 vlib_cli_output (vm, "sw_if_index:%d %U\n", i, format_l2_rw_config, &rw->configs[i]);
547 * Layer 2-Rewrite node uses classify tables to match packets. Then, using
548 * the provisioned mask and value, modifies the packet header.
551 * @todo This is incomplete. This needs a detailed description and a
555 VLIB_CLI_COMMAND (l2_rw_show_interfaces_cli, static) = {
556 .path = "show l2 rewrite interfaces",
558 "show l2 rewrite interfaces",
559 .function = l2_rw_show_interfaces_cli_fn,
563 static clib_error_t *
564 l2_rw_show_entries_cli_fn (vlib_main_t * vm,
565 unformat_input_t * input, vlib_cli_command_t * cmd)
567 l2_rw_main_t *rw = &l2_rw_main;
569 if (pool_elts (rw->entries) == 0)
570 vlib_cli_output (vm, "No entries\n");
573 pool_foreach(e, rw->entries, {
574 vlib_cli_output (vm, "%U\n", format_l2_rw_entry, e);
581 * Layer 2-Rewrite node uses classify tables to match packets. Then, using
582 * the provisioned mask and value, modifies the packet header.
585 * @todo This is incomplete. This needs a detailed description and a
589 VLIB_CLI_COMMAND (l2_rw_show_entries_cli, static) = {
590 .path = "show l2 rewrite entries",
592 "show l2 rewrite entries",
593 .function = l2_rw_show_entries_cli_fn,
598 l2_rw_enable_disable (u32 bridge_domain, u8 disable)
600 u32 mask = L2INPUT_FEAT_RW;
601 l2input_set_bridge_features (bridge_domain, mask, disable ? 0 : mask);
605 static clib_error_t *
606 l2_rw_set_cli_fn (vlib_main_t * vm,
607 unformat_input_t * input, vlib_cli_command_t * cmd)
612 if (unformat_check_input (input) == UNFORMAT_END_OF_INPUT ||
613 !unformat (input, "%d", &bridge_domain))
615 return clib_error_return (0, "You must specify a bridge domain");
618 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT &&
619 unformat (input, "disable"))
624 if (l2_rw_enable_disable (bridge_domain, disable))
625 return clib_error_return (0, "Could not enable or disable rewrite");
631 * Layer 2-Rewrite node uses classify tables to match packets. Then, using
632 * the provisioned mask and value, modfies the packet header.
635 * @todo This is incomplete. This needs a detailed description and a
639 VLIB_CLI_COMMAND (l2_rw_set_cli, static) = {
640 .path = "set bridge-domain rewrite",
642 "set bridge-domain rewrite <bridge-domain> [disable]",
643 .function = l2_rw_set_cli_fn,
647 static clib_error_t *
648 l2_rw_init (vlib_main_t * vm)
650 l2_rw_main_t *rw = &l2_rw_main;
653 clib_bitmap_alloc (rw->configs_bitmap, 1);
654 feat_bitmap_init_next_nodes (vm,
657 l2input_get_feat_names (),
658 rw->feat_next_node_index);
662 VLIB_INIT_FUNCTION (l2_rw_init);
670 #define foreach_l2_rw_error \
671 _(UNKNOWN, "Unknown error")
675 #define _(sym,str) L2_RW_ERROR_##sym,
681 static char *l2_rw_error_strings[] = {
682 #define _(sym,string) string,
688 VLIB_REGISTER_NODE (l2_rw_node) = {
689 .function = l2_rw_node_fn,
691 .vector_size = sizeof (u32),
692 .format_trace = format_l2_rw_trace,
693 .type = VLIB_NODE_TYPE_INTERNAL,
694 .n_errors = ARRAY_LEN(l2_rw_error_strings),
695 .error_strings = l2_rw_error_strings,
696 .runtime_data_bytes = 0,
697 .n_next_nodes = L2_RW_N_NEXT,
698 .next_nodes = { [L2_RW_NEXT_DROP] = "error-drop"},
702 VLIB_NODE_FUNCTION_MULTIARCH (l2_rw_node, l2_rw_node_fn)
704 * fd.io coding-style-patch-verification: ON
707 * eval: (c-set-style "gnu")