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 #ifndef CLIB_MARCH_VARIANT
30 l2_rw_main_t l2_rw_main;
31 #endif /* CLIB_MARCH_VARIANT */
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 u32x4u *d = ((u32x4u *) h) + rwe->skip_n_vectors;
95 switch (rwe->rewrite_n_vectors)
98 d[4] = (d[4] & ~rwe->mask[4]) | rwe->value[4];
101 d[3] = (d[3] & ~rwe->mask[3]) | rwe->value[3];
104 d[2] = (d[2] & ~rwe->mask[2]) | rwe->value[2];
107 d[1] = (d[1] & ~rwe->mask[1]) | rwe->value[1];
110 d[0] = (d[0] & ~rwe->mask[0]) | rwe->value[0];
117 VLIB_NODE_FN (l2_rw_node) (vlib_main_t * vm,
118 vlib_node_runtime_t * node, vlib_frame_t * frame)
120 l2_rw_main_t *rw = &l2_rw_main;
121 u32 n_left_from, *from, *to_next, next_index;
122 vnet_classify_main_t *vcm = &vnet_classify_main;
123 f64 now = vlib_time_now (vlib_get_main ());
125 from = vlib_frame_vector_args (frame);
126 n_left_from = frame->n_vectors; /* number of packets to process */
127 next_index = node->cached_next_index;
129 while (n_left_from > 0)
133 /* get space to enqueue frame to graph node "next_index" */
134 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
136 while (n_left_from >= 6 && n_left_to_next >= 2)
138 u32 bi0, next0, sw_if_index0, rwe_index0;
139 u32 bi1, next1, sw_if_index1, rwe_index1;
140 vlib_buffer_t *b0, *b1;
141 ethernet_header_t *h0, *h1;
142 l2_rw_config_t *config0, *config1;
144 vnet_classify_table_t *t0, *t1;
145 vnet_classify_entry_t *e0, *e1;
146 l2_rw_entry_t *rwe0, *rwe1;
149 vlib_buffer_t *p2, *p3, *p4, *p5;
150 p2 = vlib_get_buffer (vm, from[2]);
151 p3 = vlib_get_buffer (vm, from[3]);
152 p4 = vlib_get_buffer (vm, from[4]);
153 p5 = vlib_get_buffer (vm, from[5]);
155 vlib_prefetch_buffer_header (p4, LOAD);
156 vlib_prefetch_buffer_header (p5, LOAD);
157 vlib_prefetch_buffer_data (p2, LOAD);
158 vlib_prefetch_buffer_data (p3, LOAD);
170 b0 = vlib_get_buffer (vm, bi0);
171 b1 = vlib_get_buffer (vm, bi1);
172 h0 = vlib_buffer_get_current (b0);
173 h1 = vlib_buffer_get_current (b1);
175 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
176 sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
177 config0 = l2_rw_get_config (sw_if_index0); /*TODO: check sw_if_index0 value */
178 config1 = l2_rw_get_config (sw_if_index1); /*TODO: check sw_if_index0 value */
179 t0 = pool_elt_at_index (vcm->tables, config0->table_index);
180 t1 = pool_elt_at_index (vcm->tables, config1->table_index);
182 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
183 hash1 = vnet_classify_hash_packet (t1, (u8 *) h1);
184 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
185 e1 = vnet_classify_find_entry (t1, (u8 *) h1, hash1, now);
187 while (!e0 && (t0->next_table_index != ~0))
189 t0 = pool_elt_at_index (vcm->tables, t0->next_table_index);
190 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
191 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
194 while (!e1 && (t1->next_table_index != ~0))
196 t1 = pool_elt_at_index (vcm->tables, t1->next_table_index);
197 hash1 = vnet_classify_hash_packet (t1, (u8 *) h1);
198 e1 = vnet_classify_find_entry (t1, (u8 *) h1, hash1, now);
201 rwe_index0 = e0 ? e0->opaque_index : config0->miss_index;
202 rwe_index1 = e1 ? e1->opaque_index : config1->miss_index;
204 if (rwe_index0 != ~0)
206 rwe0 = pool_elt_at_index (rw->entries, rwe_index0);
207 l2_rw_rewrite (rwe0, (u8 *) h0);
209 if (rwe_index1 != ~0)
211 rwe1 = pool_elt_at_index (rw->entries, rwe_index1);
212 l2_rw_rewrite (rwe1, (u8 *) h1);
215 if (PREDICT_FALSE ((b0->flags & VLIB_BUFFER_IS_TRACED)))
217 l2_rw_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
218 t->sw_if_index = sw_if_index0;
219 t->classify_table_index = config0->table_index;
220 t->rewrite_entry_index = rwe_index0;
223 if (PREDICT_FALSE ((b1->flags & VLIB_BUFFER_IS_TRACED)))
225 l2_rw_trace_t *t = vlib_add_trace (vm, node, b1, sizeof (*t));
226 t->sw_if_index = sw_if_index1;
227 t->classify_table_index = config1->table_index;
228 t->rewrite_entry_index = rwe_index1;
231 /* Update feature bitmap and get next feature index */
232 next0 = vnet_l2_feature_next (b0, rw->feat_next_node_index,
234 next1 = vnet_l2_feature_next (b1, rw->feat_next_node_index,
237 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
238 to_next, n_left_to_next,
239 bi0, bi1, next0, next1);
242 while (n_left_from > 0 && n_left_to_next > 0)
244 u32 bi0, next0, sw_if_index0, rwe_index0;
246 ethernet_header_t *h0;
247 l2_rw_config_t *config0;
249 vnet_classify_table_t *t0;
250 vnet_classify_entry_t *e0;
260 b0 = vlib_get_buffer (vm, bi0);
261 h0 = vlib_buffer_get_current (b0);
263 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
264 config0 = l2_rw_get_config (sw_if_index0); /*TODO: check sw_if_index0 value */
265 t0 = pool_elt_at_index (vcm->tables, config0->table_index);
267 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
268 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
270 while (!e0 && (t0->next_table_index != ~0))
272 t0 = pool_elt_at_index (vcm->tables, t0->next_table_index);
273 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
274 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
277 rwe_index0 = e0 ? e0->opaque_index : config0->miss_index;
279 if (rwe_index0 != ~0)
281 rwe0 = pool_elt_at_index (rw->entries, rwe_index0);
282 l2_rw_rewrite (rwe0, (u8 *) h0);
285 if (PREDICT_FALSE ((b0->flags & VLIB_BUFFER_IS_TRACED)))
287 l2_rw_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
288 t->sw_if_index = sw_if_index0;
289 t->classify_table_index = config0->table_index;
290 t->rewrite_entry_index = rwe_index0;
293 /* Update feature bitmap and get next feature index */
294 next0 = vnet_l2_feature_next (b0, rw->feat_next_node_index,
297 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
298 to_next, n_left_to_next,
301 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
304 return frame->n_vectors;
307 #ifndef CLIB_MARCH_VARIANT
309 l2_rw_mod_entry (u32 * index,
310 u8 * mask, u8 * value, u32 len, u32 skip, u8 is_del)
312 l2_rw_main_t *rw = &l2_rw_main;
313 l2_rw_entry_t *e = 0;
316 if (pool_is_free_index (rw->entries, *index))
320 e = pool_elt_at_index (rw->entries, *index);
324 pool_get (rw->entries, e);
325 *index = e - rw->entries;
333 pool_put (rw->entries, e);
337 e->skip_n_vectors = skip / sizeof (u32x4);
338 skip -= e->skip_n_vectors * sizeof (u32x4);
339 e->rewrite_n_vectors = (skip + len - 1) / sizeof (u32x4) + 1;
340 vec_alloc_aligned (e->mask, e->rewrite_n_vectors, sizeof (u32x4));
341 clib_memset (e->mask, 0, e->rewrite_n_vectors * sizeof (u32x4));
342 vec_alloc_aligned (e->value, e->rewrite_n_vectors, sizeof (u32x4));
343 clib_memset (e->value, 0, e->rewrite_n_vectors * sizeof (u32x4));
345 clib_memcpy (((u8 *) e->value) + skip, value, len);
346 clib_memcpy (((u8 *) e->mask) + skip, mask, len);
349 for (i = 0; i < e->rewrite_n_vectors; i++)
351 e->value[i] &= e->mask[i];
356 #endif /* CLIB_MARCH_VARIANT */
358 static clib_error_t *
359 l2_rw_entry_cli_fn (vlib_main_t * vm,
360 unformat_input_t * input, vlib_cli_command_t * cmd)
368 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
370 if (unformat (input, "index %d", &index))
372 else if (unformat (input, "mask %U", unformat_hex_string, &mask))
374 else if (unformat (input, "value %U", unformat_hex_string, &value))
376 else if (unformat (input, "skip %d", &skip))
378 else if (unformat (input, "del"))
385 return clib_error_return (0, "Unspecified mask or value");
387 if (vec_len (mask) != vec_len (value))
388 return clib_error_return (0, "Mask and value lengths must be identical");
392 l2_rw_mod_entry (&index, mask, value, vec_len (mask), skip, del)))
393 return clib_error_return (0, "Could not add entry");
399 * Layer 2-Rewrite node uses classify tables to match packets. Then, using
400 * the provisioned mask and value, modifies the packet header.
403 * @todo This is incomplete. This needs a detailed description and a
407 VLIB_CLI_COMMAND (l2_rw_entry_cli, static) = {
408 .path = "l2 rewrite entry",
410 "l2 rewrite entry [index <index>] [mask <hex-mask>] [value <hex-value>] [skip <n_bytes>] [del]",
411 .function = l2_rw_entry_cli_fn,
415 #ifndef CLIB_MARCH_VARIANT
417 l2_rw_interface_set_table (u32 sw_if_index, u32 table_index, u32 miss_index)
419 l2_rw_config_t *c = l2_rw_get_config (sw_if_index);
420 l2_rw_main_t *rw = &l2_rw_main;
422 c->table_index = table_index;
423 c->miss_index = miss_index;
424 u32 feature_bitmap = (table_index == ~0) ? 0 : L2INPUT_FEAT_RW;
426 l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_RW, feature_bitmap);
428 if (c->table_index == ~0)
429 clib_bitmap_set (rw->configs_bitmap, sw_if_index, 0);
433 #endif /* CLIB_MARCH_VARIANT */
435 static clib_error_t *
436 l2_rw_interface_cli_fn (vlib_main_t * vm,
437 unformat_input_t * input, vlib_cli_command_t * cmd)
439 vnet_main_t *vnm = vnet_get_main ();
440 u32 table_index = ~0;
441 u32 sw_if_index = ~0;
444 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
446 unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index);
449 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
451 if (unformat (input, "table %d", &table_index))
453 else if (unformat (input, "miss-index %d", &miss_index))
459 if (sw_if_index == ~0)
460 return clib_error_return (0,
461 "You must specify an interface 'iface <interface>'",
462 format_unformat_error, input);
465 l2_rw_interface_set_table (sw_if_index, table_index, miss_index)))
466 return clib_error_return (0, "l2_rw_interface_set_table returned %d",
473 * Layer 2-Rewrite node uses classify tables to match packets. Then, using
474 * the provisioned mask and value, modifies the packet header.
477 * @todo This is incomplete. This needs a detailed description and a
481 VLIB_CLI_COMMAND (l2_rw_interface_cli, static) = {
482 .path = "set interface l2 rewrite",
484 "set interface l2 rewrite <interface> [table <table index>] [miss-index <entry-index>]",
485 .function = l2_rw_interface_cli_fn,
489 static clib_error_t *
490 l2_rw_show_interfaces_cli_fn (vlib_main_t * vm,
491 unformat_input_t * input,
492 vlib_cli_command_t * cmd)
494 l2_rw_main_t *rw = &l2_rw_main;
495 if (clib_bitmap_count_set_bits (rw->configs_bitmap) == 0)
496 vlib_cli_output (vm, "No interface is currently using l2 rewrite\n");
500 clib_bitmap_foreach(i, rw->configs_bitmap, {
501 vlib_cli_output (vm, "sw_if_index:%d %U\n", i, format_l2_rw_config, &rw->configs[i]);
508 * Layer 2-Rewrite node uses classify tables to match packets. Then, using
509 * the provisioned mask and value, modifies the packet header.
512 * @todo This is incomplete. This needs a detailed description and a
516 VLIB_CLI_COMMAND (l2_rw_show_interfaces_cli, static) = {
517 .path = "show l2 rewrite interfaces",
519 "show l2 rewrite interfaces",
520 .function = l2_rw_show_interfaces_cli_fn,
524 static clib_error_t *
525 l2_rw_show_entries_cli_fn (vlib_main_t * vm,
526 unformat_input_t * input, vlib_cli_command_t * cmd)
528 l2_rw_main_t *rw = &l2_rw_main;
530 if (pool_elts (rw->entries) == 0)
531 vlib_cli_output (vm, "No entries\n");
534 pool_foreach(e, rw->entries, {
535 vlib_cli_output (vm, "%U\n", format_l2_rw_entry, e);
542 * Layer 2-Rewrite node uses classify tables to match packets. Then, using
543 * the provisioned mask and value, modifies the packet header.
546 * @todo This is incomplete. This needs a detailed description and a
550 VLIB_CLI_COMMAND (l2_rw_show_entries_cli, static) = {
551 .path = "show l2 rewrite entries",
553 "show l2 rewrite entries",
554 .function = l2_rw_show_entries_cli_fn,
559 l2_rw_enable_disable (u32 bridge_domain, u8 disable)
561 u32 mask = L2INPUT_FEAT_RW;
562 l2input_set_bridge_features (bridge_domain, mask, disable ? 0 : mask);
566 static clib_error_t *
567 l2_rw_set_cli_fn (vlib_main_t * vm,
568 unformat_input_t * input, vlib_cli_command_t * cmd)
573 if (unformat_check_input (input) == UNFORMAT_END_OF_INPUT ||
574 !unformat (input, "%d", &bridge_domain))
576 return clib_error_return (0, "You must specify a bridge domain");
579 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT &&
580 unformat (input, "disable"))
585 if (l2_rw_enable_disable (bridge_domain, disable))
586 return clib_error_return (0, "Could not enable or disable rewrite");
592 * Layer 2-Rewrite node uses classify tables to match packets. Then, using
593 * the provisioned mask and value, modfies the packet header.
596 * @todo This is incomplete. This needs a detailed description and a
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) = {
651 .vector_size = sizeof (u32),
652 .format_trace = format_l2_rw_trace,
653 .type = VLIB_NODE_TYPE_INTERNAL,
654 .n_errors = ARRAY_LEN(l2_rw_error_strings),
655 .error_strings = l2_rw_error_strings,
656 .runtime_data_bytes = 0,
657 .n_next_nodes = L2_RW_N_NEXT,
658 .next_nodes = { [L2_RW_NEXT_DROP] = "error-drop"},
663 * fd.io coding-style-patch-verification: ON
666 * eval: (c-set-style "gnu")