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>
19 #include <vnet/classify/vnet_classify.h>
23 * @brief Layer 2 Rewrite.
25 * Layer 2-Rewrite node uses classify tables to match packets. Then, using
26 * the provisioned mask and value, modifies the packet header.
30 #ifndef CLIB_MARCH_VARIANT
31 l2_rw_main_t l2_rw_main;
32 #endif /* CLIB_MARCH_VARIANT */
37 u32 classify_table_index;
38 u32 rewrite_entry_index;
42 format_l2_rw_entry (u8 * s, va_list * args)
44 l2_rw_entry_t *e = va_arg (*args, l2_rw_entry_t *);
45 l2_rw_main_t *rw = &l2_rw_main;
46 s = format (s, "%d - mask:%U value:%U\n",
48 format_hex_bytes, e->mask,
49 e->rewrite_n_vectors * sizeof (u32x4), format_hex_bytes,
50 e->value, e->rewrite_n_vectors * sizeof (u32x4));
52 format (s, " hits:%d skip_bytes:%d", e->hit_count,
53 e->skip_n_vectors * sizeof (u32x4));
58 format_l2_rw_config (u8 * s, va_list * args)
60 l2_rw_config_t *c = va_arg (*args, l2_rw_config_t *);
61 return format (s, "table-index:%d miss-index:%d",
62 c->table_index, c->miss_index);
65 /* packet trace format function */
67 format_l2_rw_trace (u8 * s, va_list * args)
69 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
70 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
71 l2_rw_trace_t *t = va_arg (*args, l2_rw_trace_t *);
72 return format (s, "l2-rw: sw_if_index %d, table %d, entry %d",
73 t->sw_if_index, t->classify_table_index,
74 t->rewrite_entry_index);
77 always_inline l2_rw_config_t *
78 l2_rw_get_config (u32 sw_if_index)
80 l2_rw_main_t *rw = &l2_rw_main;
81 if (PREDICT_FALSE (!clib_bitmap_get (rw->configs_bitmap, sw_if_index)))
83 vec_validate (rw->configs, sw_if_index);
84 rw->configs[sw_if_index].table_index = ~0;
85 rw->configs[sw_if_index].miss_index = ~0;
87 clib_bitmap_set (rw->configs_bitmap, sw_if_index, 1);
89 return &rw->configs[sw_if_index];
92 static_always_inline void
93 l2_rw_rewrite (l2_rw_entry_t * rwe, u8 * h)
95 u32x4u *d = ((u32x4u *) h) + rwe->skip_n_vectors;
96 switch (rwe->rewrite_n_vectors)
99 d[4] = (d[4] & ~rwe->mask[4]) | rwe->value[4];
102 d[3] = (d[3] & ~rwe->mask[3]) | rwe->value[3];
105 d[2] = (d[2] & ~rwe->mask[2]) | rwe->value[2];
108 d[1] = (d[1] & ~rwe->mask[1]) | rwe->value[1];
111 d[0] = (d[0] & ~rwe->mask[0]) | rwe->value[0];
118 VLIB_NODE_FN (l2_rw_node) (vlib_main_t * vm,
119 vlib_node_runtime_t * node, vlib_frame_t * frame)
121 l2_rw_main_t *rw = &l2_rw_main;
122 u32 n_left_from, *from, *to_next, next_index;
123 vnet_classify_main_t *vcm = &vnet_classify_main;
124 f64 now = vlib_time_now (vlib_get_main ());
126 from = vlib_frame_vector_args (frame);
127 n_left_from = frame->n_vectors; /* number of packets to process */
128 next_index = node->cached_next_index;
130 while (n_left_from > 0)
134 /* get space to enqueue frame to graph node "next_index" */
135 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
137 while (n_left_from >= 6 && n_left_to_next >= 2)
139 u32 bi0, next0, sw_if_index0, rwe_index0;
140 u32 bi1, next1, sw_if_index1, rwe_index1;
141 vlib_buffer_t *b0, *b1;
142 ethernet_header_t *h0, *h1;
143 l2_rw_config_t *config0, *config1;
145 vnet_classify_table_t *t0, *t1;
146 vnet_classify_entry_t *e0, *e1;
147 l2_rw_entry_t *rwe0, *rwe1;
150 vlib_buffer_t *p2, *p3, *p4, *p5;
151 p2 = vlib_get_buffer (vm, from[2]);
152 p3 = vlib_get_buffer (vm, from[3]);
153 p4 = vlib_get_buffer (vm, from[4]);
154 p5 = vlib_get_buffer (vm, from[5]);
156 vlib_prefetch_buffer_header (p4, LOAD);
157 vlib_prefetch_buffer_header (p5, LOAD);
158 vlib_prefetch_buffer_data (p2, LOAD);
159 vlib_prefetch_buffer_data (p3, LOAD);
171 b0 = vlib_get_buffer (vm, bi0);
172 b1 = vlib_get_buffer (vm, bi1);
173 h0 = vlib_buffer_get_current (b0);
174 h1 = vlib_buffer_get_current (b1);
176 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
177 sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
178 config0 = l2_rw_get_config (sw_if_index0); /*TODO: check sw_if_index0 value */
179 config1 = l2_rw_get_config (sw_if_index1); /*TODO: check sw_if_index0 value */
180 t0 = pool_elt_at_index (vcm->tables, config0->table_index);
181 t1 = pool_elt_at_index (vcm->tables, config1->table_index);
183 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
184 hash1 = vnet_classify_hash_packet (t1, (u8 *) h1);
185 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
186 e1 = vnet_classify_find_entry (t1, (u8 *) h1, hash1, now);
188 while (!e0 && (t0->next_table_index != ~0))
190 t0 = pool_elt_at_index (vcm->tables, t0->next_table_index);
191 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
192 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
195 while (!e1 && (t1->next_table_index != ~0))
197 t1 = pool_elt_at_index (vcm->tables, t1->next_table_index);
198 hash1 = vnet_classify_hash_packet (t1, (u8 *) h1);
199 e1 = vnet_classify_find_entry (t1, (u8 *) h1, hash1, now);
202 rwe_index0 = e0 ? e0->opaque_index : config0->miss_index;
203 rwe_index1 = e1 ? e1->opaque_index : config1->miss_index;
205 if (rwe_index0 != ~0)
207 rwe0 = pool_elt_at_index (rw->entries, rwe_index0);
208 l2_rw_rewrite (rwe0, (u8 *) h0);
210 if (rwe_index1 != ~0)
212 rwe1 = pool_elt_at_index (rw->entries, rwe_index1);
213 l2_rw_rewrite (rwe1, (u8 *) h1);
216 if (PREDICT_FALSE ((b0->flags & VLIB_BUFFER_IS_TRACED)))
218 l2_rw_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
219 t->sw_if_index = sw_if_index0;
220 t->classify_table_index = config0->table_index;
221 t->rewrite_entry_index = rwe_index0;
224 if (PREDICT_FALSE ((b1->flags & VLIB_BUFFER_IS_TRACED)))
226 l2_rw_trace_t *t = vlib_add_trace (vm, node, b1, sizeof (*t));
227 t->sw_if_index = sw_if_index1;
228 t->classify_table_index = config1->table_index;
229 t->rewrite_entry_index = rwe_index1;
232 /* Update feature bitmap and get next feature index */
233 next0 = vnet_l2_feature_next (b0, rw->feat_next_node_index,
235 next1 = vnet_l2_feature_next (b1, rw->feat_next_node_index,
238 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
239 to_next, n_left_to_next,
240 bi0, bi1, next0, next1);
243 while (n_left_from > 0 && n_left_to_next > 0)
245 u32 bi0, next0, sw_if_index0, rwe_index0;
247 ethernet_header_t *h0;
248 l2_rw_config_t *config0;
250 vnet_classify_table_t *t0;
251 vnet_classify_entry_t *e0;
261 b0 = vlib_get_buffer (vm, bi0);
262 h0 = vlib_buffer_get_current (b0);
264 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
265 config0 = l2_rw_get_config (sw_if_index0); /*TODO: check sw_if_index0 value */
266 t0 = pool_elt_at_index (vcm->tables, config0->table_index);
268 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
269 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
271 while (!e0 && (t0->next_table_index != ~0))
273 t0 = pool_elt_at_index (vcm->tables, t0->next_table_index);
274 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
275 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
278 rwe_index0 = e0 ? e0->opaque_index : config0->miss_index;
280 if (rwe_index0 != ~0)
282 rwe0 = pool_elt_at_index (rw->entries, rwe_index0);
283 l2_rw_rewrite (rwe0, (u8 *) h0);
286 if (PREDICT_FALSE ((b0->flags & VLIB_BUFFER_IS_TRACED)))
288 l2_rw_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
289 t->sw_if_index = sw_if_index0;
290 t->classify_table_index = config0->table_index;
291 t->rewrite_entry_index = rwe_index0;
294 /* Update feature bitmap and get next feature index */
295 next0 = vnet_l2_feature_next (b0, rw->feat_next_node_index,
298 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
299 to_next, n_left_to_next,
302 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
305 return frame->n_vectors;
308 #ifndef CLIB_MARCH_VARIANT
310 l2_rw_mod_entry (u32 * index,
311 u8 * mask, u8 * value, u32 len, u32 skip, u8 is_del)
313 l2_rw_main_t *rw = &l2_rw_main;
314 l2_rw_entry_t *e = 0;
317 if (pool_is_free_index (rw->entries, *index))
321 e = pool_elt_at_index (rw->entries, *index);
325 pool_get (rw->entries, e);
326 *index = e - rw->entries;
331 pool_put (rw->entries, e);
335 e->skip_n_vectors = skip / sizeof (u32x4);
336 skip -= e->skip_n_vectors * sizeof (u32x4);
337 e->rewrite_n_vectors = (skip + len - 1) / sizeof (u32x4) + 1;
338 vec_alloc_aligned (e->mask, e->rewrite_n_vectors, sizeof (u32x4));
339 clib_memset (e->mask, 0, e->rewrite_n_vectors * sizeof (u32x4));
340 vec_alloc_aligned (e->value, e->rewrite_n_vectors, sizeof (u32x4));
341 clib_memset (e->value, 0, e->rewrite_n_vectors * sizeof (u32x4));
343 clib_memcpy (((u8 *) e->value) + skip, value, len);
344 clib_memcpy (((u8 *) e->mask) + skip, mask, len);
347 for (i = 0; i < e->rewrite_n_vectors; i++)
349 e->value[i] &= e->mask[i];
354 #endif /* CLIB_MARCH_VARIANT */
356 static clib_error_t *
357 l2_rw_entry_cli_fn (vlib_main_t * vm,
358 unformat_input_t * input, vlib_cli_command_t * cmd)
366 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
368 if (unformat (input, "index %d", &index))
370 else if (unformat (input, "mask %U", unformat_hex_string, &mask))
372 else if (unformat (input, "value %U", unformat_hex_string, &value))
374 else if (unformat (input, "skip %d", &skip))
376 else if (unformat (input, "del"))
383 return clib_error_return (0, "Unspecified mask or value");
385 if (vec_len (mask) != vec_len (value))
386 return clib_error_return (0, "Mask and value lengths must be identical");
390 l2_rw_mod_entry (&index, mask, value, vec_len (mask), skip, del)))
391 return clib_error_return (0, "Could not add entry");
397 * Layer 2-Rewrite node uses classify tables to match packets. Then, using
398 * the provisioned mask and value, modifies the packet header.
401 * Example of how to add an l2 rewrite entry to change the destination mac of
402 * the packet to 00:8a:00:0d:0e:02 (where parameter mask is Ethernet header's
404 * parameter value is Ethernet header's value):
405 * @cliexcmd{l2 rewrite entry mask ffffffffffff00000000000000000000 value
406 008a000d0e0200000000000000000000}
409 VLIB_CLI_COMMAND (l2_rw_entry_cli, static) = {
410 .path = "l2 rewrite entry",
412 "l2 rewrite entry [index <index>] [mask <hex-mask>] [value <hex-value>] [skip <n_bytes>] [del]",
413 .function = l2_rw_entry_cli_fn,
417 #ifndef CLIB_MARCH_VARIANT
419 l2_rw_interface_set_table (u32 sw_if_index, u32 table_index, u32 miss_index)
421 l2_rw_config_t *c = l2_rw_get_config (sw_if_index);
422 l2_rw_main_t *rw = &l2_rw_main;
424 c->table_index = table_index;
425 c->miss_index = miss_index;
426 u32 feature_bitmap = (table_index == ~0) ? 0 : L2INPUT_FEAT_RW;
428 l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_RW, feature_bitmap);
430 if (c->table_index == ~0)
431 clib_bitmap_set (rw->configs_bitmap, sw_if_index, 0);
435 #endif /* CLIB_MARCH_VARIANT */
437 static clib_error_t *
438 l2_rw_interface_cli_fn (vlib_main_t * vm,
439 unformat_input_t * input, vlib_cli_command_t * cmd)
441 vnet_main_t *vnm = vnet_get_main ();
442 u32 table_index = ~0;
443 u32 sw_if_index = ~0;
446 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
448 unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index);
451 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
453 if (unformat (input, "table %d", &table_index))
455 else if (unformat (input, "miss-index %d", &miss_index))
461 if (sw_if_index == ~0)
462 return clib_error_return (0,
463 "You must specify an interface 'iface <interface>'",
464 format_unformat_error, input);
467 l2_rw_interface_set_table (sw_if_index, table_index, miss_index)))
468 return clib_error_return (0, "l2_rw_interface_set_table returned %d",
475 * Apply the rule to the interface. The following example shows how to use
477 * entry and Layer 2-Rewrite entry to modify the packet ethernet header on the
481 * Example use the classify to filter packets that do not need to be modified
483 * 192.168.68.34 is the destination ip of the data packet, 8080 is the
486 * @cliexcmd{classify table mask l3 ip4 dst l4 dst_port}
487 * @cliexcmd{classify session acl-hit-next permit table-index 0 match l3 ip4
488 dst 192.168.68.34 l4 dst_port 8080}
491 * Example apply classify and l2 rewrite rules to the interface (where
493 * is interface, \"table 0\" means Table Id is 0, \"miss 0\" means the packet
495 * the classify. miss will be modified according to the l2 rewrite entry with
497 * @cliexcmd{set interface l2 rewrite YusurK2Eth6/0/1/3 table 0 miss-index 0}
500 VLIB_CLI_COMMAND (l2_rw_interface_cli, static) = {
501 .path = "set interface l2 rewrite",
503 "set interface l2 rewrite <interface> [table <table index>] [miss-index <entry-index>]",
504 .function = l2_rw_interface_cli_fn,
508 static clib_error_t *
509 l2_rw_show_interfaces_cli_fn (vlib_main_t * vm,
510 unformat_input_t * input,
511 vlib_cli_command_t * cmd)
513 l2_rw_main_t *rw = &l2_rw_main;
514 if (clib_bitmap_count_set_bits (rw->configs_bitmap) == 0)
515 vlib_cli_output (vm, "No interface is currently using l2 rewrite\n");
519 clib_bitmap_foreach (i, rw->configs_bitmap) {
520 vlib_cli_output (vm, "sw_if_index:%d %U\n", i, format_l2_rw_config, &rw->configs[i]);
527 * This command displays the l2 rewrite entries of the interfaces.
530 * Example of how to display the l2 rewrite rules on the interface:
531 * @cliexstart{show l2 rewrite interfaces}
532 * sw_if_index:4 table-index:0 miss-index:0
536 VLIB_CLI_COMMAND (l2_rw_show_interfaces_cli, static) = {
537 .path = "show l2 rewrite interfaces",
539 "show l2 rewrite interfaces",
540 .function = l2_rw_show_interfaces_cli_fn,
544 static clib_error_t *
545 l2_rw_show_entries_cli_fn (vlib_main_t * vm,
546 unformat_input_t * input, vlib_cli_command_t * cmd)
548 l2_rw_main_t *rw = &l2_rw_main;
550 if (pool_elts (rw->entries) == 0)
551 vlib_cli_output (vm, "No entries\n");
554 pool_foreach (e, rw->entries) {
555 vlib_cli_output (vm, "%U\n", format_l2_rw_entry, e);
562 * This command displays all l2 rewrite entries.
565 * Example of how to display all l2 rewrite entries:
566 * @cliexstart{show l2 rewrite entries}
567 * 0 - mask:ffffffffffff00000000000000000000
568 value:aabbccddeeff00000000000000000000
569 * hits:0 skip_bytes:0
573 VLIB_CLI_COMMAND (l2_rw_show_entries_cli, static) = {
574 .path = "show l2 rewrite entries",
576 "show l2 rewrite entries",
577 .function = l2_rw_show_entries_cli_fn,
582 l2_rw_enable_disable (u32 bridge_domain, u8 disable)
584 u32 mask = L2INPUT_FEAT_RW;
585 l2input_set_bridge_features (bridge_domain, mask, disable ? 0 : mask);
589 static clib_error_t *
590 l2_rw_set_cli_fn (vlib_main_t * vm,
591 unformat_input_t * input, vlib_cli_command_t * cmd)
596 if (unformat_check_input (input) == UNFORMAT_END_OF_INPUT ||
597 !unformat (input, "%d", &bridge_domain))
599 return clib_error_return (0, "You must specify a bridge domain");
602 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT &&
603 unformat (input, "disable"))
608 if (l2_rw_enable_disable (bridge_domain, disable))
609 return clib_error_return (0, "Could not enable or disable rewrite");
615 * Layer 2 rewrite can be enabled and disabled on each interface and on each
617 * Use this command to manage l2 rewrite on bridge-domain.
620 * Example of how to enable rewrite (where 100 is the bridge-domain-id):
621 * @cliexcmd{set bridge-domain rewrite 100}
622 * Example of how to disable rewrite (where 100 is the bridge-domain-id):
623 * @cliexcmd{set bridge-domain rewrite 100 disable}
626 VLIB_CLI_COMMAND (l2_rw_set_cli, static) = {
627 .path = "set bridge-domain rewrite",
629 "set bridge-domain rewrite <bridge-domain> [disable]",
630 .function = l2_rw_set_cli_fn,
634 static clib_error_t *
635 l2_rw_init (vlib_main_t * vm)
637 l2_rw_main_t *rw = &l2_rw_main;
640 clib_bitmap_alloc (rw->configs_bitmap, 1);
641 feat_bitmap_init_next_nodes (vm,
644 l2input_get_feat_names (),
645 rw->feat_next_node_index);
649 VLIB_INIT_FUNCTION (l2_rw_init);
657 #define foreach_l2_rw_error \
658 _(UNKNOWN, "Unknown error")
662 #define _(sym,str) L2_RW_ERROR_##sym,
668 static char *l2_rw_error_strings[] = {
669 #define _(sym,string) string,
675 VLIB_REGISTER_NODE (l2_rw_node) = {
677 .vector_size = sizeof (u32),
678 .format_trace = format_l2_rw_trace,
679 .type = VLIB_NODE_TYPE_INTERNAL,
680 .n_errors = ARRAY_LEN(l2_rw_error_strings),
681 .error_strings = l2_rw_error_strings,
682 .runtime_data_bytes = 0,
683 .n_next_nodes = L2_RW_N_NEXT,
684 .next_nodes = { [L2_RW_NEXT_DROP] = "error-drop"},
689 * fd.io coding-style-patch-verification: ON
692 * eval: (c-set-style "gnu")