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;
26 u32 classify_table_index;
27 u32 rewrite_entry_index;
30 static u8 *format_l2_rw_entry (u8 * s, va_list *args)
32 l2_rw_entry_t *e = va_arg (*args, l2_rw_entry_t *);
33 l2_rw_main_t *rw = &l2_rw_main;
34 s = format (s, "%d - mask:%U value:%U\n",
36 format_hex_bytes, e->mask, e->rewrite_n_vectors * sizeof(u32x4),
37 format_hex_bytes, e->value, e->rewrite_n_vectors * sizeof(u32x4));
38 s = format (s, " hits:%d skip_bytes:%d",
39 e->hit_count, e->skip_n_vectors * sizeof(u32x4));
43 static u8 *format_l2_rw_config (u8 * s, va_list *args)
45 l2_rw_config_t *c = va_arg (*args, l2_rw_config_t *);
46 return format(s, "table-index:%d miss-index:%d",
51 /* packet trace format function */
52 static u8 *format_l2_rw_trace (u8 * s, va_list * args)
54 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
55 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
56 l2_rw_trace_t * t = va_arg (*args, l2_rw_trace_t *);
57 return format (s, "l2-rw: sw_if_index %d, table %d, entry %d",
58 t->sw_if_index, t->classify_table_index,
59 t->rewrite_entry_index);
62 always_inline l2_rw_config_t *l2_rw_get_config(u32 sw_if_index)
64 l2_rw_main_t *rw = &l2_rw_main;
65 if (PREDICT_FALSE(!clib_bitmap_get(rw->configs_bitmap, sw_if_index))) {
66 vec_validate(rw->configs, sw_if_index);
67 rw->configs[sw_if_index].table_index = ~0;
68 rw->configs[sw_if_index].miss_index = ~0;
69 rw->configs_bitmap = clib_bitmap_set(rw->configs_bitmap, sw_if_index, 1);
71 return &rw->configs[sw_if_index];
74 static_always_inline void l2_rw_rewrite(l2_rw_entry_t *rwe, u8 *h)
76 if (U32X4_ALIGNED(h)) {
77 u32x4 *d = ((u32x4 *) h) + rwe->skip_n_vectors;
78 switch(rwe->rewrite_n_vectors) {
80 d[4] = (d[4] & ~rwe->mask[4]) | rwe->value[4];
83 d[3] = (d[3] & ~rwe->mask[3]) | rwe->value[3];
86 d[2] = (d[2] & ~rwe->mask[2]) | rwe->value[2];
89 d[1] = (d[1] & ~rwe->mask[1]) | rwe->value[1];
92 d[0] = (d[0] & ~rwe->mask[0]) | rwe->value[0];
98 u64 *d = ((u64 *) h) + rwe->skip_n_vectors * 2;
99 switch(rwe->rewrite_n_vectors) {
101 d[8] = (d[8] & ~(((u64*)rwe->mask)[8])) | (((u64*)rwe->value)[8]);
102 d[9] = (d[9] & ~(((u64*)rwe->mask)[9])) | (((u64*)rwe->value)[9]);
105 d[6] = (d[6] & ~(((u64*)rwe->mask)[6])) | (((u64*)rwe->value)[6]);
106 d[7] = (d[7] & ~(((u64*)rwe->mask)[7])) | (((u64*)rwe->value)[7]);
109 d[4] = (d[4] & ~(((u64*)rwe->mask)[4])) | (((u64*)rwe->value)[4]);
110 d[5] = (d[5] & ~(((u64*)rwe->mask)[5])) | (((u64*)rwe->value)[5]);
113 d[2] = (d[2] & ~(((u64*)rwe->mask)[2])) | (((u64*)rwe->value)[2]);
114 d[3] = (d[3] & ~(((u64*)rwe->mask)[3])) | (((u64*)rwe->value)[3]);
117 d[0] = (d[0] & ~(((u64*)rwe->mask)[0])) | (((u64*)rwe->value)[0]);
118 d[1] = (d[1] & ~(((u64*)rwe->mask)[1])) | (((u64*)rwe->value)[1]);
127 l2_rw_node_fn(vlib_main_t * vm,
128 vlib_node_runtime_t * node,
129 vlib_frame_t * frame)
131 l2_rw_main_t *rw = &l2_rw_main;
132 u32 n_left_from, * from, * to_next, next_index;
133 //vlib_node_t *n = vlib_get_node(vm, node->node_index);
134 vnet_classify_main_t *vcm = &vnet_classify_main;
135 f64 now = vlib_time_now(vlib_get_main());
136 u32 prefetch_size = 0;
138 from = vlib_frame_vector_args (frame);
139 n_left_from = frame->n_vectors; /* number of packets to process */
140 next_index = node->cached_next_index;
142 while (n_left_from > 0)
146 /* get space to enqueue frame to graph node "next_index" */
147 vlib_get_next_frame (vm, node, next_index,
148 to_next, n_left_to_next);
150 while (n_left_from >= 4 && n_left_to_next >= 2)
152 u32 bi0, next0, sw_if_index0, feature_bitmap0, rwe_index0;
153 u32 bi1, next1, sw_if_index1, feature_bitmap1, rwe_index1;
154 vlib_buffer_t *b0, *b1;
155 ethernet_header_t *h0, *h1;
156 l2_rw_config_t *config0, *config1;
158 vnet_classify_table_t *t0, *t1;
159 vnet_classify_entry_t *e0, *e1;
160 l2_rw_entry_t *rwe0, *rwe1;
163 vlib_buffer_t * p2, * p3;
164 p2 = vlib_get_buffer (vm, from[2]);
165 p3 = vlib_get_buffer (vm, from[3]);
167 vlib_prefetch_buffer_header (p2, LOAD);
168 vlib_prefetch_buffer_header (p3, LOAD);
169 CLIB_PREFETCH (vlib_buffer_get_current(p2), prefetch_size, LOAD);
170 CLIB_PREFETCH (vlib_buffer_get_current(p3), prefetch_size, LOAD);
182 b0 = vlib_get_buffer(vm, bi0);
183 b1 = vlib_get_buffer(vm, bi1);
184 h0 = vlib_buffer_get_current(b0);
185 h1 = vlib_buffer_get_current(b1);
187 sw_if_index0 = vnet_buffer(b0)->sw_if_index[VLIB_RX];
188 sw_if_index1 = vnet_buffer(b1)->sw_if_index[VLIB_RX];
189 config0 = l2_rw_get_config(sw_if_index0); //TODO: check sw_if_index0 value
190 config1 = l2_rw_get_config(sw_if_index1); //TODO: check sw_if_index0 value
191 t0 = pool_elt_at_index(vcm->tables, config0->table_index);
192 t1 = pool_elt_at_index(vcm->tables, config1->table_index);
193 prefetch_size = (t1->skip_n_vectors + t1->match_n_vectors)*sizeof(u32x4);
195 hash0 = vnet_classify_hash_packet(t0, (u8 *)h0);
196 hash1 = vnet_classify_hash_packet(t1, (u8 *)h1);
197 e0 = vnet_classify_find_entry(t0, (u8 *) h0, hash0, now);
198 e1 = vnet_classify_find_entry(t1, (u8 *) h1, hash1, now);
200 while (!e0 && (t0->next_table_index != ~0)) {
201 t0 = pool_elt_at_index(vcm->tables, t0->next_table_index);
202 hash0 = vnet_classify_hash_packet(t0, (u8 *)h0);
203 e0 = vnet_classify_find_entry(t0, (u8 *) h0, hash0, now);
206 while (!e1 && (t1->next_table_index != ~0)) {
207 t1 = pool_elt_at_index(vcm->tables, t1->next_table_index);
208 hash1 = vnet_classify_hash_packet(t1, (u8 *)h1);
209 e1 = vnet_classify_find_entry(t1, (u8 *) h1, hash1, now);
212 rwe_index0 = e0?e0->opaque_index:config0->miss_index;
213 rwe_index1 = e1?e1->opaque_index:config1->miss_index;
215 if (rwe_index0 != ~0) {
216 rwe0 = pool_elt_at_index(rw->entries, rwe_index0);
217 l2_rw_rewrite(rwe0, (u8 *)h0);
219 if (rwe_index1 != ~0) {
220 rwe1 = pool_elt_at_index(rw->entries, rwe_index1);
221 l2_rw_rewrite(rwe1, (u8 *)h1);
224 if (PREDICT_FALSE((b0->flags & VLIB_BUFFER_IS_TRACED))) {
226 vlib_add_trace (vm, node, b0, sizeof (*t));
227 t->sw_if_index = sw_if_index0;
228 t->classify_table_index = config0->table_index;
229 t->rewrite_entry_index = rwe_index0;
232 if (PREDICT_FALSE((b1->flags & VLIB_BUFFER_IS_TRACED))) {
234 vlib_add_trace (vm, node, b1, sizeof (*t));
235 t->sw_if_index = sw_if_index1;
236 t->classify_table_index = config1->table_index;
237 t->rewrite_entry_index = rwe_index1;
240 // Update feature bitmap and get next feature index
241 feature_bitmap0 = vnet_buffer(b0)->l2.feature_bitmap & ~L2INPUT_FEAT_RW;
242 feature_bitmap1 = vnet_buffer(b1)->l2.feature_bitmap & ~L2INPUT_FEAT_RW;
243 vnet_buffer(b0)->l2.feature_bitmap = feature_bitmap0;
244 vnet_buffer(b1)->l2.feature_bitmap = feature_bitmap1;
245 next0 = feat_bitmap_get_next_node_index(rw->feat_next_node_index,
247 next1 = feat_bitmap_get_next_node_index(rw->feat_next_node_index,
250 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
251 to_next, n_left_to_next,
252 bi0, bi1, next0, next1);
255 while (n_left_from > 0 && n_left_to_next > 0)
257 u32 bi0, next0, sw_if_index0, feature_bitmap0, rwe_index0;
259 ethernet_header_t *h0;
260 l2_rw_config_t *config0;
262 vnet_classify_table_t *t0;
263 vnet_classify_entry_t *e0;
273 b0 = vlib_get_buffer(vm, bi0);
274 h0 = vlib_buffer_get_current(b0);
276 sw_if_index0 = vnet_buffer(b0)->sw_if_index[VLIB_RX];
277 config0 = l2_rw_get_config(sw_if_index0); //TODO: check sw_if_index0 value
278 t0 = pool_elt_at_index(vcm->tables, config0->table_index);
280 hash0 = vnet_classify_hash_packet(t0, (u8 *)h0);
281 e0 = vnet_classify_find_entry(t0, (u8 *) h0, hash0, now);
283 while (!e0 && (t0->next_table_index != ~0)) {
284 t0 = pool_elt_at_index(vcm->tables, t0->next_table_index);
285 hash0 = vnet_classify_hash_packet(t0, (u8 *)h0);
286 e0 = vnet_classify_find_entry(t0, (u8 *) h0, hash0, now);
289 rwe_index0 = e0?e0->opaque_index:config0->miss_index;
291 if (rwe_index0 != ~0) {
292 rwe0 = pool_elt_at_index(rw->entries, rwe_index0);
293 l2_rw_rewrite(rwe0, (u8 *)h0);
296 if (PREDICT_FALSE((b0->flags & VLIB_BUFFER_IS_TRACED))) {
298 vlib_add_trace (vm, node, b0, sizeof (*t));
299 t->sw_if_index = sw_if_index0;
300 t->classify_table_index = config0->table_index;
301 t->rewrite_entry_index = rwe_index0;
304 // Update feature bitmap and get next feature index
305 feature_bitmap0 = vnet_buffer(b0)->l2.feature_bitmap & ~L2INPUT_FEAT_RW;
306 vnet_buffer(b0)->l2.feature_bitmap = feature_bitmap0;
307 next0 = feat_bitmap_get_next_node_index(rw->feat_next_node_index,
310 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
311 to_next, n_left_to_next,
314 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
317 return frame->n_vectors;
320 int l2_rw_mod_entry(u32 *index,
321 u8 *mask, u8 *value, u32 len,
324 l2_rw_main_t *rw = &l2_rw_main;
325 l2_rw_entry_t *e = 0;
327 if (pool_is_free_index(rw->entries, *index)) {
330 e = pool_elt_at_index(rw->entries, *index);
332 pool_get(rw->entries, e);
333 *index = e - rw->entries;
340 pool_put(rw->entries, e);
344 e->skip_n_vectors = skip / sizeof(u32x4);
345 skip -= e->skip_n_vectors * sizeof(u32x4);
346 e->rewrite_n_vectors = (skip + len - 1) / sizeof(u32x4) + 1;
347 vec_alloc_aligned(e->mask, e->rewrite_n_vectors, sizeof(u32x4));
348 memset(e->mask, 0, e->rewrite_n_vectors * sizeof(u32x4));
349 vec_alloc_aligned(e->value, e->rewrite_n_vectors, sizeof(u32x4));
350 memset(e->value, 0, e->rewrite_n_vectors * sizeof(u32x4));
352 clib_memcpy(((u8 *)e->value) + skip, value, len);
353 clib_memcpy(((u8 *)e->mask) + skip, mask, len);
356 for (i = 0; i < e->rewrite_n_vectors; i++) {
357 e->value[i] &= e->mask[i];
363 static clib_error_t *
364 l2_rw_entry_cli_fn (vlib_main_t * vm,
365 unformat_input_t * input,
366 vlib_cli_command_t * cmd)
374 while (unformat_check_input(input) != UNFORMAT_END_OF_INPUT)
376 if (unformat (input, "index %d", &index))
378 else if (unformat (input, "mask %U", unformat_hex_string, &mask))
380 else if (unformat (input, "value %U", unformat_hex_string, &value))
382 else if (unformat (input, "skip %d", &skip))
384 else if (unformat (input, "del"))
391 return clib_error_return(0, "Unspecified mask or value");
393 if (vec_len(mask) != vec_len(value))
394 return clib_error_return(0, "Mask and value lengths must be identical");
397 if ((ret = l2_rw_mod_entry(&index, mask, value, vec_len(mask), skip, del)))
398 return clib_error_return(0, "Could not add entry");
403 VLIB_CLI_COMMAND (l2_rw_entry_cli, static) = {
404 .path = "l2 rewrite entry",
406 "l2 rewrite entry [index <index>] [mask <hex-mask>] [value <hex-value>] [skip <n_bytes>] [del]",
407 .function = l2_rw_entry_cli_fn,
410 int l2_rw_interface_set_table(u32 sw_if_index,
414 l2_rw_config_t *c = l2_rw_get_config(sw_if_index);
415 l2_rw_main_t *rw = &l2_rw_main;
417 c->table_index = table_index;
418 c->miss_index = miss_index;
419 u32 feature_bitmap = (table_index == ~0)?0:L2INPUT_FEAT_RW;
421 l2input_intf_bitmap_enable(sw_if_index, L2INPUT_FEAT_RW, feature_bitmap);
423 if (c->table_index == ~0)
424 clib_bitmap_set(rw->configs_bitmap, sw_if_index, 0);
429 static clib_error_t *
430 l2_rw_interface_cli_fn (vlib_main_t * vm,
431 unformat_input_t * input,
432 vlib_cli_command_t * cmd)
434 vnet_main_t * vnm = vnet_get_main();
435 u32 table_index = ~0;
436 u32 sw_if_index = ~0;
439 if (unformat_check_input(input) != UNFORMAT_END_OF_INPUT) {
440 unformat (input, "%U", unformat_vnet_sw_interface,
444 while (unformat_check_input(input) != UNFORMAT_END_OF_INPUT)
446 if (unformat (input, "table %d", &table_index))
448 else if (unformat (input, "miss-index %d", &miss_index))
454 if (sw_if_index == ~0)
455 return clib_error_return(0, "You must specify an interface 'iface <interface>'",
456 format_unformat_error, input);
458 if((ret = l2_rw_interface_set_table(sw_if_index, table_index, miss_index)))
459 return clib_error_return(0, "l2_rw_interface_set_table returned %d", ret);
464 VLIB_CLI_COMMAND (l2_rw_interface_cli, static) = {
465 .path = "set interface l2 rewrite",
467 "set interface l2 rewrite <interface> [table <table index>] [miss-index <entry-index>]",
468 .function = l2_rw_interface_cli_fn,
471 static clib_error_t *
472 l2_rw_show_interfaces_cli_fn (vlib_main_t * vm,
473 unformat_input_t * input,
474 vlib_cli_command_t * cmd)
476 l2_rw_main_t *rw = &l2_rw_main;
477 if (clib_bitmap_count_set_bits(rw->configs_bitmap) == 0)
478 vlib_cli_output (vm, "No interface is currently using l2 rewrite\n");
481 clib_bitmap_foreach(i, rw->configs_bitmap, {
482 vlib_cli_output (vm, "sw_if_index:%d %U\n", i, format_l2_rw_config, &rw->configs[i]);
487 VLIB_CLI_COMMAND (l2_rw_show_interfaces_cli, static) = {
488 .path = "show l2 rewrite interfaces",
490 "show l2 rewrite interfaces",
491 .function = l2_rw_show_interfaces_cli_fn,
494 static clib_error_t *
495 l2_rw_show_entries_cli_fn (vlib_main_t * vm,
496 unformat_input_t * input,
497 vlib_cli_command_t * cmd)
499 l2_rw_main_t *rw = &l2_rw_main;
501 if (pool_elts(rw->entries) == 0)
502 vlib_cli_output (vm, "No entries\n");
504 pool_foreach(e, rw->entries, {
505 vlib_cli_output (vm, "%U\n", format_l2_rw_entry, e);
510 VLIB_CLI_COMMAND (l2_rw_show_entries_cli, static) = {
511 .path = "show l2 rewrite entries",
513 "show l2 rewrite entries",
514 .function = l2_rw_show_entries_cli_fn,
518 l2_rw_enable_disable(u32 bridge_domain, u8 disable)
520 u32 mask = L2INPUT_FEAT_RW;
521 l2input_set_bridge_features(bridge_domain, mask,
526 static clib_error_t *
527 l2_rw_set_cli_fn (vlib_main_t * vm,
528 unformat_input_t * input,
529 vlib_cli_command_t * cmd)
534 if (unformat_check_input(input) == UNFORMAT_END_OF_INPUT ||
535 !unformat (input, "%d", &bridge_domain)) {
536 return clib_error_return(0, "You must specify a bridge domain");
539 if (unformat_check_input(input) != UNFORMAT_END_OF_INPUT &&
540 unformat (input, "disable")) {
544 if (l2_rw_enable_disable(bridge_domain, disable))
545 return clib_error_return(0, "Could not enable or disable rewrite");
550 VLIB_CLI_COMMAND (l2_rw_set_cli, static) = {
551 .path = "set bridge-domain rewrite",
553 "set bridge-domain rewrite <bridge-domain> [disable]",
554 .function = l2_rw_set_cli_fn,
558 clib_error_t *l2_rw_init (vlib_main_t *vm)
560 l2_rw_main_t *rw = &l2_rw_main;
563 clib_bitmap_alloc(rw->configs_bitmap, 1);
564 feat_bitmap_init_next_nodes(vm,
567 l2input_get_feat_names(),
568 rw->feat_next_node_index);
571 VLIB_INIT_FUNCTION (l2_rw_init);
578 #define foreach_l2_rw_error \
579 _(UNKNOWN, "Unknown error")
582 #define _(sym,str) L2_RW_ERROR_##sym,
588 static char * l2_rw_error_strings[] = {
589 #define _(sym,string) string,
594 VLIB_REGISTER_NODE (l2_rw_node) = {
595 .function = l2_rw_node_fn,
597 .vector_size = sizeof (u32),
598 .format_trace = format_l2_rw_trace,
599 .type = VLIB_NODE_TYPE_INTERNAL,
600 .n_errors = ARRAY_LEN(l2_rw_error_strings),
601 .error_strings = l2_rw_error_strings,
602 .runtime_data_bytes = 0,
603 .n_next_nodes = L2_RW_N_NEXT,
604 .next_nodes = { [L2_RW_NEXT_DROP] = "error-drop"},
607 VLIB_NODE_FUNCTION_MULTIARCH (l2_rw_node, l2_rw_node_fn)