blob: 7921d0e4884e57c71f699f3cdd8000ee519eebe1 [file] [log] [blame]
Pierre Pfisterd6f5b962016-03-21 16:17:52 +00001/*
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:
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
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.
14 */
15
16#include <vlib/vlib.h>
17#include <vnet/l2/feat_bitmap.h>
18#include <vnet/l2/l2_rw.h>
Neale Rannsba4a5bf2020-01-09 06:43:14 +000019#include <vnet/classify/vnet_classify.h>
Pierre Pfisterd6f5b962016-03-21 16:17:52 +000020
Billy McFall22aa3e92016-09-09 08:46:40 -040021/**
22 * @file
23 * @brief Layer 2 Rewrite.
24 *
25 * Layer 2-Rewrite node uses classify tables to match packets. Then, using
Paul Vinciguerrabdc0e6b2018-09-22 05:32:50 -070026 * the provisioned mask and value, modifies the packet header.
Billy McFall22aa3e92016-09-09 08:46:40 -040027 */
28
29
Filip Tehlar44f0f712019-03-11 04:26:37 -070030#ifndef CLIB_MARCH_VARIANT
Pierre Pfisterd6f5b962016-03-21 16:17:52 +000031l2_rw_main_t l2_rw_main;
Filip Tehlar44f0f712019-03-11 04:26:37 -070032#endif /* CLIB_MARCH_VARIANT */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +000033
Dave Barach97d8dc22016-08-15 15:31:15 -040034typedef struct
35{
Pierre Pfisterd6f5b962016-03-21 16:17:52 +000036 u32 sw_if_index;
37 u32 classify_table_index;
38 u32 rewrite_entry_index;
39} l2_rw_trace_t;
40
Dave Barach97d8dc22016-08-15 15:31:15 -040041static u8 *
42format_l2_rw_entry (u8 * s, va_list * args)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +000043{
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",
Dave Barach97d8dc22016-08-15 15:31:15 -040047 e - rw->entries,
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));
51 s =
52 format (s, " hits:%d skip_bytes:%d", e->hit_count,
53 e->skip_n_vectors * sizeof (u32x4));
Pierre Pfisterd6f5b962016-03-21 16:17:52 +000054 return s;
55}
56
Dave Barach97d8dc22016-08-15 15:31:15 -040057static u8 *
58format_l2_rw_config (u8 * s, va_list * args)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +000059{
60 l2_rw_config_t *c = va_arg (*args, l2_rw_config_t *);
Dave Barach97d8dc22016-08-15 15:31:15 -040061 return format (s, "table-index:%d miss-index:%d",
62 c->table_index, c->miss_index);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +000063}
64
65/* packet trace format function */
Dave Barach97d8dc22016-08-15 15:31:15 -040066static u8 *
67format_l2_rw_trace (u8 * s, va_list * args)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +000068{
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 *);
Dave Barach97d8dc22016-08-15 15:31:15 -040071 l2_rw_trace_t *t = va_arg (*args, l2_rw_trace_t *);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +000072 return format (s, "l2-rw: sw_if_index %d, table %d, entry %d",
Dave Barach97d8dc22016-08-15 15:31:15 -040073 t->sw_if_index, t->classify_table_index,
74 t->rewrite_entry_index);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +000075}
76
Dave Barach97d8dc22016-08-15 15:31:15 -040077always_inline l2_rw_config_t *
78l2_rw_get_config (u32 sw_if_index)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +000079{
80 l2_rw_main_t *rw = &l2_rw_main;
Dave Barach97d8dc22016-08-15 15:31:15 -040081 if (PREDICT_FALSE (!clib_bitmap_get (rw->configs_bitmap, sw_if_index)))
82 {
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;
86 rw->configs_bitmap =
87 clib_bitmap_set (rw->configs_bitmap, sw_if_index, 1);
88 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +000089 return &rw->configs[sw_if_index];
90}
91
Dave Barach97d8dc22016-08-15 15:31:15 -040092static_always_inline void
93l2_rw_rewrite (l2_rw_entry_t * rwe, u8 * h)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +000094{
Damjan Marion83049332019-09-25 00:25:36 +020095 u32x4u *d = ((u32x4u *) h) + rwe->skip_n_vectors;
96 switch (rwe->rewrite_n_vectors)
Dave Barach97d8dc22016-08-15 15:31:15 -040097 {
Damjan Marion83049332019-09-25 00:25:36 +020098 case 5:
99 d[4] = (d[4] & ~rwe->mask[4]) | rwe->value[4];
100 /* FALLTHROUGH */
101 case 4:
102 d[3] = (d[3] & ~rwe->mask[3]) | rwe->value[3];
103 /* FALLTHROUGH */
104 case 3:
105 d[2] = (d[2] & ~rwe->mask[2]) | rwe->value[2];
106 /* FALLTHROUGH */
107 case 2:
108 d[1] = (d[1] & ~rwe->mask[1]) | rwe->value[1];
109 /* FALLTHROUGH */
110 case 1:
111 d[0] = (d[0] & ~rwe->mask[0]) | rwe->value[0];
yanlong7fa16742023-11-19 06:19:42 -0800112 rwe->hit_count++;
Damjan Marion83049332019-09-25 00:25:36 +0200113 break;
114 default:
115 abort ();
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000116 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000117}
118
Filip Tehlar44f0f712019-03-11 04:26:37 -0700119VLIB_NODE_FN (l2_rw_node) (vlib_main_t * vm,
120 vlib_node_runtime_t * node, vlib_frame_t * frame)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000121{
122 l2_rw_main_t *rw = &l2_rw_main;
Dave Barach97d8dc22016-08-15 15:31:15 -0400123 u32 n_left_from, *from, *to_next, next_index;
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000124 vnet_classify_main_t *vcm = &vnet_classify_main;
Dave Barach97d8dc22016-08-15 15:31:15 -0400125 f64 now = vlib_time_now (vlib_get_main ());
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000126
127 from = vlib_frame_vector_args (frame);
Dave Barach97d8dc22016-08-15 15:31:15 -0400128 n_left_from = frame->n_vectors; /* number of packets to process */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000129 next_index = node->cached_next_index;
130
131 while (n_left_from > 0)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000132 {
Dave Barach97d8dc22016-08-15 15:31:15 -0400133 u32 n_left_to_next;
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000134
Dave Barach97d8dc22016-08-15 15:31:15 -0400135 /* get space to enqueue frame to graph node "next_index" */
136 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000137
Damjan Mariond30bf012018-11-18 23:48:43 +0100138 while (n_left_from >= 6 && n_left_to_next >= 2)
Dave Barach97d8dc22016-08-15 15:31:15 -0400139 {
John Lobeb0b2e2017-07-22 00:21:36 -0400140 u32 bi0, next0, sw_if_index0, rwe_index0;
141 u32 bi1, next1, sw_if_index1, rwe_index1;
Dave Barach97d8dc22016-08-15 15:31:15 -0400142 vlib_buffer_t *b0, *b1;
143 ethernet_header_t *h0, *h1;
144 l2_rw_config_t *config0, *config1;
145 u64 hash0, hash1;
146 vnet_classify_table_t *t0, *t1;
147 vnet_classify_entry_t *e0, *e1;
148 l2_rw_entry_t *rwe0, *rwe1;
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000149
Dave Barach97d8dc22016-08-15 15:31:15 -0400150 {
Damjan Mariond30bf012018-11-18 23:48:43 +0100151 vlib_buffer_t *p2, *p3, *p4, *p5;
Dave Barach97d8dc22016-08-15 15:31:15 -0400152 p2 = vlib_get_buffer (vm, from[2]);
153 p3 = vlib_get_buffer (vm, from[3]);
Damjan Mariond30bf012018-11-18 23:48:43 +0100154 p4 = vlib_get_buffer (vm, from[4]);
155 p5 = vlib_get_buffer (vm, from[5]);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000156
Damjan Mariond30bf012018-11-18 23:48:43 +0100157 vlib_prefetch_buffer_header (p4, LOAD);
158 vlib_prefetch_buffer_header (p5, LOAD);
159 vlib_prefetch_buffer_data (p2, LOAD);
160 vlib_prefetch_buffer_data (p3, LOAD);
Dave Barach97d8dc22016-08-15 15:31:15 -0400161 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000162
Dave Barach97d8dc22016-08-15 15:31:15 -0400163 bi0 = from[0];
164 bi1 = from[1];
165 to_next[0] = bi0;
166 to_next[1] = bi1;
167 from += 2;
168 to_next += 2;
169 n_left_from -= 2;
170 n_left_to_next -= 2;
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000171
Dave Barach97d8dc22016-08-15 15:31:15 -0400172 b0 = vlib_get_buffer (vm, bi0);
173 b1 = vlib_get_buffer (vm, bi1);
174 h0 = vlib_buffer_get_current (b0);
175 h1 = vlib_buffer_get_current (b1);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000176
Dave Barach97d8dc22016-08-15 15:31:15 -0400177 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
178 sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
179 config0 = l2_rw_get_config (sw_if_index0); /*TODO: check sw_if_index0 value */
180 config1 = l2_rw_get_config (sw_if_index1); /*TODO: check sw_if_index0 value */
181 t0 = pool_elt_at_index (vcm->tables, config0->table_index);
182 t1 = pool_elt_at_index (vcm->tables, config1->table_index);
Pierre Pfister6b70c212016-05-13 07:47:06 +0100183
Dave Barach97d8dc22016-08-15 15:31:15 -0400184 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
185 hash1 = vnet_classify_hash_packet (t1, (u8 *) h1);
186 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
187 e1 = vnet_classify_find_entry (t1, (u8 *) h1, hash1, now);
Pierre Pfister6b70c212016-05-13 07:47:06 +0100188
Dave Barach97d8dc22016-08-15 15:31:15 -0400189 while (!e0 && (t0->next_table_index != ~0))
190 {
191 t0 = pool_elt_at_index (vcm->tables, t0->next_table_index);
192 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
193 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
194 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000195
Dave Barach97d8dc22016-08-15 15:31:15 -0400196 while (!e1 && (t1->next_table_index != ~0))
197 {
198 t1 = pool_elt_at_index (vcm->tables, t1->next_table_index);
199 hash1 = vnet_classify_hash_packet (t1, (u8 *) h1);
200 e1 = vnet_classify_find_entry (t1, (u8 *) h1, hash1, now);
201 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000202
Dave Barach97d8dc22016-08-15 15:31:15 -0400203 rwe_index0 = e0 ? e0->opaque_index : config0->miss_index;
204 rwe_index1 = e1 ? e1->opaque_index : config1->miss_index;
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000205
Dave Barach97d8dc22016-08-15 15:31:15 -0400206 if (rwe_index0 != ~0)
207 {
208 rwe0 = pool_elt_at_index (rw->entries, rwe_index0);
209 l2_rw_rewrite (rwe0, (u8 *) h0);
210 }
211 if (rwe_index1 != ~0)
212 {
213 rwe1 = pool_elt_at_index (rw->entries, rwe_index1);
214 l2_rw_rewrite (rwe1, (u8 *) h1);
215 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000216
Dave Barach97d8dc22016-08-15 15:31:15 -0400217 if (PREDICT_FALSE ((b0->flags & VLIB_BUFFER_IS_TRACED)))
218 {
219 l2_rw_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
220 t->sw_if_index = sw_if_index0;
221 t->classify_table_index = config0->table_index;
222 t->rewrite_entry_index = rwe_index0;
223 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000224
Dave Barach97d8dc22016-08-15 15:31:15 -0400225 if (PREDICT_FALSE ((b1->flags & VLIB_BUFFER_IS_TRACED)))
226 {
227 l2_rw_trace_t *t = vlib_add_trace (vm, node, b1, sizeof (*t));
228 t->sw_if_index = sw_if_index1;
229 t->classify_table_index = config1->table_index;
230 t->rewrite_entry_index = rwe_index1;
231 }
232
233 /* Update feature bitmap and get next feature index */
John Lobeb0b2e2017-07-22 00:21:36 -0400234 next0 = vnet_l2_feature_next (b0, rw->feat_next_node_index,
235 L2INPUT_FEAT_RW);
236 next1 = vnet_l2_feature_next (b1, rw->feat_next_node_index,
237 L2INPUT_FEAT_RW);
Dave Barach97d8dc22016-08-15 15:31:15 -0400238
239 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
240 to_next, n_left_to_next,
241 bi0, bi1, next0, next1);
242 }
243
244 while (n_left_from > 0 && n_left_to_next > 0)
245 {
John Lobeb0b2e2017-07-22 00:21:36 -0400246 u32 bi0, next0, sw_if_index0, rwe_index0;
Dave Barach97d8dc22016-08-15 15:31:15 -0400247 vlib_buffer_t *b0;
248 ethernet_header_t *h0;
249 l2_rw_config_t *config0;
250 u64 hash0;
251 vnet_classify_table_t *t0;
252 vnet_classify_entry_t *e0;
253 l2_rw_entry_t *rwe0;
254
255 bi0 = from[0];
256 to_next[0] = bi0;
257 from += 1;
258 to_next += 1;
259 n_left_from -= 1;
260 n_left_to_next -= 1;
261
262 b0 = vlib_get_buffer (vm, bi0);
263 h0 = vlib_buffer_get_current (b0);
264
265 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
266 config0 = l2_rw_get_config (sw_if_index0); /*TODO: check sw_if_index0 value */
267 t0 = pool_elt_at_index (vcm->tables, config0->table_index);
268
269 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
270 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
271
272 while (!e0 && (t0->next_table_index != ~0))
273 {
274 t0 = pool_elt_at_index (vcm->tables, t0->next_table_index);
275 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
276 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
277 }
278
279 rwe_index0 = e0 ? e0->opaque_index : config0->miss_index;
280
281 if (rwe_index0 != ~0)
282 {
283 rwe0 = pool_elt_at_index (rw->entries, rwe_index0);
284 l2_rw_rewrite (rwe0, (u8 *) h0);
285 }
286
287 if (PREDICT_FALSE ((b0->flags & VLIB_BUFFER_IS_TRACED)))
288 {
289 l2_rw_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
290 t->sw_if_index = sw_if_index0;
291 t->classify_table_index = config0->table_index;
292 t->rewrite_entry_index = rwe_index0;
293 }
294
295 /* Update feature bitmap and get next feature index */
John Lobeb0b2e2017-07-22 00:21:36 -0400296 next0 = vnet_l2_feature_next (b0, rw->feat_next_node_index,
297 L2INPUT_FEAT_RW);
Dave Barach97d8dc22016-08-15 15:31:15 -0400298
299 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
300 to_next, n_left_to_next,
301 bi0, next0);
302 }
303 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000304 }
305
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000306 return frame->n_vectors;
307}
308
Filip Tehlar44f0f712019-03-11 04:26:37 -0700309#ifndef CLIB_MARCH_VARIANT
Dave Barach97d8dc22016-08-15 15:31:15 -0400310int
311l2_rw_mod_entry (u32 * index,
312 u8 * mask, u8 * value, u32 len, u32 skip, u8 is_del)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000313{
314 l2_rw_main_t *rw = &l2_rw_main;
315 l2_rw_entry_t *e = 0;
Dave Barach97d8dc22016-08-15 15:31:15 -0400316 if (*index != ~0)
317 {
318 if (pool_is_free_index (rw->entries, *index))
319 {
320 return -1;
321 }
322 e = pool_elt_at_index (rw->entries, *index);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000323 }
Dave Barach97d8dc22016-08-15 15:31:15 -0400324 else
325 {
326 pool_get (rw->entries, e);
327 *index = e - rw->entries;
328 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000329
Dave Barach97d8dc22016-08-15 15:31:15 -0400330 if (is_del)
331 {
332 pool_put (rw->entries, e);
333 return 0;
334 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000335
yanlong7fa16742023-11-19 06:19:42 -0800336 e->hit_count = 0;
Dave Barach97d8dc22016-08-15 15:31:15 -0400337 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));
Dave Barachb7b92992018-10-17 10:38:51 -0400341 clib_memset (e->mask, 0, e->rewrite_n_vectors * sizeof (u32x4));
Dave Barach97d8dc22016-08-15 15:31:15 -0400342 vec_alloc_aligned (e->value, e->rewrite_n_vectors, sizeof (u32x4));
Dave Barachb7b92992018-10-17 10:38:51 -0400343 clib_memset (e->value, 0, e->rewrite_n_vectors * sizeof (u32x4));
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000344
Dave Barach97d8dc22016-08-15 15:31:15 -0400345 clib_memcpy (((u8 *) e->value) + skip, value, len);
346 clib_memcpy (((u8 *) e->mask) + skip, mask, len);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000347
348 int i;
Dave Barach97d8dc22016-08-15 15:31:15 -0400349 for (i = 0; i < e->rewrite_n_vectors; i++)
350 {
351 e->value[i] &= e->mask[i];
352 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000353
354 return 0;
355}
Filip Tehlar44f0f712019-03-11 04:26:37 -0700356#endif /* CLIB_MARCH_VARIANT */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000357
358static clib_error_t *
359l2_rw_entry_cli_fn (vlib_main_t * vm,
Dave Barach97d8dc22016-08-15 15:31:15 -0400360 unformat_input_t * input, vlib_cli_command_t * cmd)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000361{
362 u32 index = ~0;
363 u8 *mask = 0;
364 u8 *value = 0;
365 u32 skip = 0;
366 u8 del = 0;
367
Dave Barach97d8dc22016-08-15 15:31:15 -0400368 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
369 {
370 if (unformat (input, "index %d", &index))
371 ;
372 else if (unformat (input, "mask %U", unformat_hex_string, &mask))
373 ;
374 else if (unformat (input, "value %U", unformat_hex_string, &value))
375 ;
376 else if (unformat (input, "skip %d", &skip))
377 ;
378 else if (unformat (input, "del"))
379 del = 1;
380 else
381 break;
382 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000383
384 if (!mask || !value)
Dave Barach97d8dc22016-08-15 15:31:15 -0400385 return clib_error_return (0, "Unspecified mask or value");
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000386
Dave Barach97d8dc22016-08-15 15:31:15 -0400387 if (vec_len (mask) != vec_len (value))
388 return clib_error_return (0, "Mask and value lengths must be identical");
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000389
390 int ret;
Dave Barach97d8dc22016-08-15 15:31:15 -0400391 if ((ret =
392 l2_rw_mod_entry (&index, mask, value, vec_len (mask), skip, del)))
393 return clib_error_return (0, "Could not add entry");
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000394
395 return 0;
396}
397
Billy McFall22aa3e92016-09-09 08:46:40 -0400398/*?
399 * Layer 2-Rewrite node uses classify tables to match packets. Then, using
Paul Vinciguerrabdc0e6b2018-09-22 05:32:50 -0700400 * the provisioned mask and value, modifies the packet header.
Billy McFall22aa3e92016-09-09 08:46:40 -0400401 *
402 * @cliexpar
yanlongd826a602023-08-08 11:36:32 +0800403 * Example of how to add an l2 rewrite entry to change the destination mac of
404 * the packet to 00:8a:00:0d:0e:02 (where parameter mask is Ethernet header's
405mask,
406 * parameter value is Ethernet header's value):
407 * @cliexcmd{l2 rewrite entry mask ffffffffffff00000000000000000000 value
408008a000d0e0200000000000000000000}
Billy McFall22aa3e92016-09-09 08:46:40 -0400409?*/
Dave Barach97d8dc22016-08-15 15:31:15 -0400410/* *INDENT-OFF* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000411VLIB_CLI_COMMAND (l2_rw_entry_cli, static) = {
412 .path = "l2 rewrite entry",
413 .short_help =
414 "l2 rewrite entry [index <index>] [mask <hex-mask>] [value <hex-value>] [skip <n_bytes>] [del]",
415 .function = l2_rw_entry_cli_fn,
416};
Dave Barach97d8dc22016-08-15 15:31:15 -0400417/* *INDENT-ON* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000418
Filip Tehlar44f0f712019-03-11 04:26:37 -0700419#ifndef CLIB_MARCH_VARIANT
Dave Barach97d8dc22016-08-15 15:31:15 -0400420int
421l2_rw_interface_set_table (u32 sw_if_index, u32 table_index, u32 miss_index)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000422{
Dave Barach97d8dc22016-08-15 15:31:15 -0400423 l2_rw_config_t *c = l2_rw_get_config (sw_if_index);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000424 l2_rw_main_t *rw = &l2_rw_main;
425
426 c->table_index = table_index;
427 c->miss_index = miss_index;
Dave Barach97d8dc22016-08-15 15:31:15 -0400428 u32 feature_bitmap = (table_index == ~0) ? 0 : L2INPUT_FEAT_RW;
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000429
Dave Barach97d8dc22016-08-15 15:31:15 -0400430 l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_RW, feature_bitmap);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000431
432 if (c->table_index == ~0)
Dave Barach97d8dc22016-08-15 15:31:15 -0400433 clib_bitmap_set (rw->configs_bitmap, sw_if_index, 0);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000434
435 return 0;
436}
Filip Tehlar44f0f712019-03-11 04:26:37 -0700437#endif /* CLIB_MARCH_VARIANT */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000438
439static clib_error_t *
440l2_rw_interface_cli_fn (vlib_main_t * vm,
Dave Barach97d8dc22016-08-15 15:31:15 -0400441 unformat_input_t * input, vlib_cli_command_t * cmd)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000442{
Dave Barach97d8dc22016-08-15 15:31:15 -0400443 vnet_main_t *vnm = vnet_get_main ();
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000444 u32 table_index = ~0;
445 u32 sw_if_index = ~0;
446 u32 miss_index = ~0;
447
Dave Barach97d8dc22016-08-15 15:31:15 -0400448 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
449 {
450 unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index);
451 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000452
Dave Barach97d8dc22016-08-15 15:31:15 -0400453 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
454 {
455 if (unformat (input, "table %d", &table_index))
456 ;
457 else if (unformat (input, "miss-index %d", &miss_index))
458 ;
459 else
460 break;
461 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000462
463 if (sw_if_index == ~0)
Dave Barach97d8dc22016-08-15 15:31:15 -0400464 return clib_error_return (0,
465 "You must specify an interface 'iface <interface>'",
466 format_unformat_error, input);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000467 int ret;
Dave Barach97d8dc22016-08-15 15:31:15 -0400468 if ((ret =
469 l2_rw_interface_set_table (sw_if_index, table_index, miss_index)))
470 return clib_error_return (0, "l2_rw_interface_set_table returned %d",
471 ret);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000472
473 return 0;
474}
475
Billy McFall22aa3e92016-09-09 08:46:40 -0400476/*?
yanlongd826a602023-08-08 11:36:32 +0800477 * Apply the rule to the interface. The following example shows how to use
478classify
479 * entry and Layer 2-Rewrite entry to modify the packet ethernet header on the
480 * interface.
Billy McFall22aa3e92016-09-09 08:46:40 -0400481 *
482 * @cliexpar
yanlongd826a602023-08-08 11:36:32 +0800483 * Example use the classify to filter packets that do not need to be modified
484(where
485 * 192.168.68.34 is the destination ip of the data packet, 8080 is the
486destination port
487 * of the packet):
488 * @cliexcmd{classify table mask l3 ip4 dst l4 dst_port}
489 * @cliexcmd{classify session acl-hit-next permit table-index 0 match l3 ip4
490dst 192.168.68.34 l4 dst_port 8080}
491 *
492 * @cliexpar
493 * Example apply classify and l2 rewrite rules to the interface (where
494YusurK2Eth6/0/1/3
495 * is interface, \"table 0\" means Table Id is 0, \"miss 0\" means the packet
496that matches
497 * the classify. miss will be modified according to the l2 rewrite entry with
498index 0):
499 * @cliexcmd{set interface l2 rewrite YusurK2Eth6/0/1/3 table 0 miss-index 0}
Billy McFall22aa3e92016-09-09 08:46:40 -0400500?*/
Dave Barach97d8dc22016-08-15 15:31:15 -0400501/* *INDENT-OFF* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000502VLIB_CLI_COMMAND (l2_rw_interface_cli, static) = {
503 .path = "set interface l2 rewrite",
504 .short_help =
505 "set interface l2 rewrite <interface> [table <table index>] [miss-index <entry-index>]",
506 .function = l2_rw_interface_cli_fn,
507};
Dave Barach97d8dc22016-08-15 15:31:15 -0400508/* *INDENT-ON* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000509
510static clib_error_t *
511l2_rw_show_interfaces_cli_fn (vlib_main_t * vm,
Dave Barach97d8dc22016-08-15 15:31:15 -0400512 unformat_input_t * input,
513 vlib_cli_command_t * cmd)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000514{
515 l2_rw_main_t *rw = &l2_rw_main;
Dave Barach97d8dc22016-08-15 15:31:15 -0400516 if (clib_bitmap_count_set_bits (rw->configs_bitmap) == 0)
517 vlib_cli_output (vm, "No interface is currently using l2 rewrite\n");
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000518
519 uword i;
Dave Barach97d8dc22016-08-15 15:31:15 -0400520 /* *INDENT-OFF* */
Damjan Marionf0ca1e82020-12-13 23:26:56 +0100521 clib_bitmap_foreach (i, rw->configs_bitmap) {
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000522 vlib_cli_output (vm, "sw_if_index:%d %U\n", i, format_l2_rw_config, &rw->configs[i]);
Damjan Marionf0ca1e82020-12-13 23:26:56 +0100523 }
Dave Barach97d8dc22016-08-15 15:31:15 -0400524 /* *INDENT-ON* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000525 return 0;
526}
527
Billy McFall22aa3e92016-09-09 08:46:40 -0400528/*?
yanlongd826a602023-08-08 11:36:32 +0800529 * This command displays the l2 rewrite entries of the interfaces.
Billy McFall22aa3e92016-09-09 08:46:40 -0400530 *
531 * @cliexpar
yanlongd826a602023-08-08 11:36:32 +0800532 * Example of how to display the l2 rewrite rules on the interface:
533 * @cliexstart{show l2 rewrite interfaces}
534 * sw_if_index:4 table-index:0 miss-index:0
535 * @cliexend
Billy McFall22aa3e92016-09-09 08:46:40 -0400536?*/
Dave Barach97d8dc22016-08-15 15:31:15 -0400537/* *INDENT-OFF* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000538VLIB_CLI_COMMAND (l2_rw_show_interfaces_cli, static) = {
539 .path = "show l2 rewrite interfaces",
540 .short_help =
541 "show l2 rewrite interfaces",
542 .function = l2_rw_show_interfaces_cli_fn,
543};
Dave Barach97d8dc22016-08-15 15:31:15 -0400544/* *INDENT-ON* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000545
546static clib_error_t *
547l2_rw_show_entries_cli_fn (vlib_main_t * vm,
Dave Barach97d8dc22016-08-15 15:31:15 -0400548 unformat_input_t * input, vlib_cli_command_t * cmd)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000549{
550 l2_rw_main_t *rw = &l2_rw_main;
551 l2_rw_entry_t *e;
Dave Barach97d8dc22016-08-15 15:31:15 -0400552 if (pool_elts (rw->entries) == 0)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000553 vlib_cli_output (vm, "No entries\n");
554
Dave Barach97d8dc22016-08-15 15:31:15 -0400555 /* *INDENT-OFF* */
Damjan Marionb2c31b62020-12-13 21:47:40 +0100556 pool_foreach (e, rw->entries) {
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000557 vlib_cli_output (vm, "%U\n", format_l2_rw_entry, e);
Damjan Marionb2c31b62020-12-13 21:47:40 +0100558 }
Dave Barach97d8dc22016-08-15 15:31:15 -0400559 /* *INDENT-ON* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000560 return 0;
561}
562
Billy McFall22aa3e92016-09-09 08:46:40 -0400563/*?
yanlongd826a602023-08-08 11:36:32 +0800564 * This command displays all l2 rewrite entries.
Billy McFall22aa3e92016-09-09 08:46:40 -0400565 *
566 * @cliexpar
yanlongd826a602023-08-08 11:36:32 +0800567 * Example of how to display all l2 rewrite entries:
568 * @cliexstart{show l2 rewrite entries}
569 * 0 - mask:ffffffffffff00000000000000000000
570value:aabbccddeeff00000000000000000000
571 * hits:0 skip_bytes:0
572 * @cliexend
Billy McFall22aa3e92016-09-09 08:46:40 -0400573?*/
Dave Barach97d8dc22016-08-15 15:31:15 -0400574/* *INDENT-OFF* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000575VLIB_CLI_COMMAND (l2_rw_show_entries_cli, static) = {
576 .path = "show l2 rewrite entries",
577 .short_help =
578 "show l2 rewrite entries",
579 .function = l2_rw_show_entries_cli_fn,
580};
Dave Barach97d8dc22016-08-15 15:31:15 -0400581/* *INDENT-ON* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000582
Filip Tehlar44f0f712019-03-11 04:26:37 -0700583static int
Dave Barach97d8dc22016-08-15 15:31:15 -0400584l2_rw_enable_disable (u32 bridge_domain, u8 disable)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000585{
586 u32 mask = L2INPUT_FEAT_RW;
Dave Barach97d8dc22016-08-15 15:31:15 -0400587 l2input_set_bridge_features (bridge_domain, mask, disable ? 0 : mask);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000588 return 0;
589}
590
591static clib_error_t *
592l2_rw_set_cli_fn (vlib_main_t * vm,
Dave Barach97d8dc22016-08-15 15:31:15 -0400593 unformat_input_t * input, vlib_cli_command_t * cmd)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000594{
595 u32 bridge_domain;
596 u8 disable = 0;
597
Dave Barach97d8dc22016-08-15 15:31:15 -0400598 if (unformat_check_input (input) == UNFORMAT_END_OF_INPUT ||
599 !unformat (input, "%d", &bridge_domain))
600 {
601 return clib_error_return (0, "You must specify a bridge domain");
602 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000603
Dave Barach97d8dc22016-08-15 15:31:15 -0400604 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT &&
605 unformat (input, "disable"))
606 {
607 disable = 1;
608 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000609
Dave Barach97d8dc22016-08-15 15:31:15 -0400610 if (l2_rw_enable_disable (bridge_domain, disable))
611 return clib_error_return (0, "Could not enable or disable rewrite");
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000612
613 return 0;
614}
615
Billy McFall22aa3e92016-09-09 08:46:40 -0400616/*?
yanlongd826a602023-08-08 11:36:32 +0800617 * Layer 2 rewrite can be enabled and disabled on each interface and on each
618bridge-domain.
619 * Use this command to manage l2 rewrite on bridge-domain.
Billy McFall22aa3e92016-09-09 08:46:40 -0400620 *
621 * @cliexpar
yanlongd826a602023-08-08 11:36:32 +0800622 * Example of how to enable rewrite (where 100 is the bridge-domain-id):
623 * @cliexcmd{set bridge-domain rewrite 100}
624 * Example of how to disable rewrite (where 100 is the bridge-domain-id):
625 * @cliexcmd{set bridge-domain rewrite 100 disable}
Billy McFall22aa3e92016-09-09 08:46:40 -0400626?*/
Dave Barach97d8dc22016-08-15 15:31:15 -0400627/* *INDENT-OFF* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000628VLIB_CLI_COMMAND (l2_rw_set_cli, static) = {
629 .path = "set bridge-domain rewrite",
630 .short_help =
631 "set bridge-domain rewrite <bridge-domain> [disable]",
632 .function = l2_rw_set_cli_fn,
633};
Dave Barach97d8dc22016-08-15 15:31:15 -0400634/* *INDENT-ON* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000635
Dave Barach97d8dc22016-08-15 15:31:15 -0400636static clib_error_t *
637l2_rw_init (vlib_main_t * vm)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000638{
639 l2_rw_main_t *rw = &l2_rw_main;
640 rw->configs = 0;
641 rw->entries = 0;
Dave Barach97d8dc22016-08-15 15:31:15 -0400642 clib_bitmap_alloc (rw->configs_bitmap, 1);
643 feat_bitmap_init_next_nodes (vm,
644 l2_rw_node.index,
645 L2INPUT_N_FEAT,
646 l2input_get_feat_names (),
647 rw->feat_next_node_index);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000648 return 0;
649}
Dave Barach97d8dc22016-08-15 15:31:15 -0400650
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000651VLIB_INIT_FUNCTION (l2_rw_init);
652
Dave Barach97d8dc22016-08-15 15:31:15 -0400653enum
654{
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000655 L2_RW_NEXT_DROP,
656 L2_RW_N_NEXT,
657};
658
659#define foreach_l2_rw_error \
660_(UNKNOWN, "Unknown error")
661
Dave Barach97d8dc22016-08-15 15:31:15 -0400662typedef enum
663{
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000664#define _(sym,str) L2_RW_ERROR_##sym,
665 foreach_l2_rw_error
666#undef _
Dave Barach97d8dc22016-08-15 15:31:15 -0400667 L2_RW_N_ERROR,
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000668} l2_rw_error_t;
669
Dave Barach97d8dc22016-08-15 15:31:15 -0400670static char *l2_rw_error_strings[] = {
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000671#define _(sym,string) string,
Dave Barach97d8dc22016-08-15 15:31:15 -0400672 foreach_l2_rw_error
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000673#undef _
674};
675
Dave Barach97d8dc22016-08-15 15:31:15 -0400676/* *INDENT-OFF* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000677VLIB_REGISTER_NODE (l2_rw_node) = {
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000678 .name = "l2-rw",
679 .vector_size = sizeof (u32),
680 .format_trace = format_l2_rw_trace,
681 .type = VLIB_NODE_TYPE_INTERNAL,
682 .n_errors = ARRAY_LEN(l2_rw_error_strings),
683 .error_strings = l2_rw_error_strings,
684 .runtime_data_bytes = 0,
685 .n_next_nodes = L2_RW_N_NEXT,
686 .next_nodes = { [L2_RW_NEXT_DROP] = "error-drop"},
687};
Dave Barach97d8dc22016-08-15 15:31:15 -0400688/* *INDENT-ON* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000689
Dave Barach97d8dc22016-08-15 15:31:15 -0400690/*
691 * fd.io coding-style-patch-verification: ON
692 *
693 * Local Variables:
694 * eval: (c-set-style "gnu")
695 * End:
696 */