blob: 2fb0e55bf39086a1344856287131eba7d818fcfd [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];
112 break;
113 default:
114 abort ();
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000115 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000116}
117
Filip Tehlar44f0f712019-03-11 04:26:37 -0700118VLIB_NODE_FN (l2_rw_node) (vlib_main_t * vm,
119 vlib_node_runtime_t * node, vlib_frame_t * frame)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000120{
121 l2_rw_main_t *rw = &l2_rw_main;
Dave Barach97d8dc22016-08-15 15:31:15 -0400122 u32 n_left_from, *from, *to_next, next_index;
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000123 vnet_classify_main_t *vcm = &vnet_classify_main;
Dave Barach97d8dc22016-08-15 15:31:15 -0400124 f64 now = vlib_time_now (vlib_get_main ());
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000125
126 from = vlib_frame_vector_args (frame);
Dave Barach97d8dc22016-08-15 15:31:15 -0400127 n_left_from = frame->n_vectors; /* number of packets to process */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000128 next_index = node->cached_next_index;
129
130 while (n_left_from > 0)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000131 {
Dave Barach97d8dc22016-08-15 15:31:15 -0400132 u32 n_left_to_next;
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000133
Dave Barach97d8dc22016-08-15 15:31:15 -0400134 /* 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);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000136
Damjan Mariond30bf012018-11-18 23:48:43 +0100137 while (n_left_from >= 6 && n_left_to_next >= 2)
Dave Barach97d8dc22016-08-15 15:31:15 -0400138 {
John Lobeb0b2e2017-07-22 00:21:36 -0400139 u32 bi0, next0, sw_if_index0, rwe_index0;
140 u32 bi1, next1, sw_if_index1, rwe_index1;
Dave Barach97d8dc22016-08-15 15:31:15 -0400141 vlib_buffer_t *b0, *b1;
142 ethernet_header_t *h0, *h1;
143 l2_rw_config_t *config0, *config1;
144 u64 hash0, hash1;
145 vnet_classify_table_t *t0, *t1;
146 vnet_classify_entry_t *e0, *e1;
147 l2_rw_entry_t *rwe0, *rwe1;
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000148
Dave Barach97d8dc22016-08-15 15:31:15 -0400149 {
Damjan Mariond30bf012018-11-18 23:48:43 +0100150 vlib_buffer_t *p2, *p3, *p4, *p5;
Dave Barach97d8dc22016-08-15 15:31:15 -0400151 p2 = vlib_get_buffer (vm, from[2]);
152 p3 = vlib_get_buffer (vm, from[3]);
Damjan Mariond30bf012018-11-18 23:48:43 +0100153 p4 = vlib_get_buffer (vm, from[4]);
154 p5 = vlib_get_buffer (vm, from[5]);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000155
Damjan Mariond30bf012018-11-18 23:48:43 +0100156 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);
Dave Barach97d8dc22016-08-15 15:31:15 -0400160 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000161
Dave Barach97d8dc22016-08-15 15:31:15 -0400162 bi0 = from[0];
163 bi1 = from[1];
164 to_next[0] = bi0;
165 to_next[1] = bi1;
166 from += 2;
167 to_next += 2;
168 n_left_from -= 2;
169 n_left_to_next -= 2;
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000170
Dave Barach97d8dc22016-08-15 15:31:15 -0400171 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);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000175
Dave Barach97d8dc22016-08-15 15:31:15 -0400176 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);
Pierre Pfister6b70c212016-05-13 07:47:06 +0100182
Dave Barach97d8dc22016-08-15 15:31:15 -0400183 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);
Pierre Pfister6b70c212016-05-13 07:47:06 +0100187
Dave Barach97d8dc22016-08-15 15:31:15 -0400188 while (!e0 && (t0->next_table_index != ~0))
189 {
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);
193 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000194
Dave Barach97d8dc22016-08-15 15:31:15 -0400195 while (!e1 && (t1->next_table_index != ~0))
196 {
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);
200 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000201
Dave Barach97d8dc22016-08-15 15:31:15 -0400202 rwe_index0 = e0 ? e0->opaque_index : config0->miss_index;
203 rwe_index1 = e1 ? e1->opaque_index : config1->miss_index;
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000204
Dave Barach97d8dc22016-08-15 15:31:15 -0400205 if (rwe_index0 != ~0)
206 {
207 rwe0 = pool_elt_at_index (rw->entries, rwe_index0);
208 l2_rw_rewrite (rwe0, (u8 *) h0);
209 }
210 if (rwe_index1 != ~0)
211 {
212 rwe1 = pool_elt_at_index (rw->entries, rwe_index1);
213 l2_rw_rewrite (rwe1, (u8 *) h1);
214 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000215
Dave Barach97d8dc22016-08-15 15:31:15 -0400216 if (PREDICT_FALSE ((b0->flags & VLIB_BUFFER_IS_TRACED)))
217 {
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;
222 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000223
Dave Barach97d8dc22016-08-15 15:31:15 -0400224 if (PREDICT_FALSE ((b1->flags & VLIB_BUFFER_IS_TRACED)))
225 {
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;
230 }
231
232 /* Update feature bitmap and get next feature index */
John Lobeb0b2e2017-07-22 00:21:36 -0400233 next0 = vnet_l2_feature_next (b0, rw->feat_next_node_index,
234 L2INPUT_FEAT_RW);
235 next1 = vnet_l2_feature_next (b1, rw->feat_next_node_index,
236 L2INPUT_FEAT_RW);
Dave Barach97d8dc22016-08-15 15:31:15 -0400237
238 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
239 to_next, n_left_to_next,
240 bi0, bi1, next0, next1);
241 }
242
243 while (n_left_from > 0 && n_left_to_next > 0)
244 {
John Lobeb0b2e2017-07-22 00:21:36 -0400245 u32 bi0, next0, sw_if_index0, rwe_index0;
Dave Barach97d8dc22016-08-15 15:31:15 -0400246 vlib_buffer_t *b0;
247 ethernet_header_t *h0;
248 l2_rw_config_t *config0;
249 u64 hash0;
250 vnet_classify_table_t *t0;
251 vnet_classify_entry_t *e0;
252 l2_rw_entry_t *rwe0;
253
254 bi0 = from[0];
255 to_next[0] = bi0;
256 from += 1;
257 to_next += 1;
258 n_left_from -= 1;
259 n_left_to_next -= 1;
260
261 b0 = vlib_get_buffer (vm, bi0);
262 h0 = vlib_buffer_get_current (b0);
263
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);
267
268 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
269 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
270
271 while (!e0 && (t0->next_table_index != ~0))
272 {
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);
276 }
277
278 rwe_index0 = e0 ? e0->opaque_index : config0->miss_index;
279
280 if (rwe_index0 != ~0)
281 {
282 rwe0 = pool_elt_at_index (rw->entries, rwe_index0);
283 l2_rw_rewrite (rwe0, (u8 *) h0);
284 }
285
286 if (PREDICT_FALSE ((b0->flags & VLIB_BUFFER_IS_TRACED)))
287 {
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;
292 }
293
294 /* Update feature bitmap and get next feature index */
John Lobeb0b2e2017-07-22 00:21:36 -0400295 next0 = vnet_l2_feature_next (b0, rw->feat_next_node_index,
296 L2INPUT_FEAT_RW);
Dave Barach97d8dc22016-08-15 15:31:15 -0400297
298 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
299 to_next, n_left_to_next,
300 bi0, next0);
301 }
302 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000303 }
304
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000305 return frame->n_vectors;
306}
307
Filip Tehlar44f0f712019-03-11 04:26:37 -0700308#ifndef CLIB_MARCH_VARIANT
Dave Barach97d8dc22016-08-15 15:31:15 -0400309int
310l2_rw_mod_entry (u32 * index,
311 u8 * mask, u8 * value, u32 len, u32 skip, u8 is_del)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000312{
313 l2_rw_main_t *rw = &l2_rw_main;
314 l2_rw_entry_t *e = 0;
Dave Barach97d8dc22016-08-15 15:31:15 -0400315 if (*index != ~0)
316 {
317 if (pool_is_free_index (rw->entries, *index))
318 {
319 return -1;
320 }
321 e = pool_elt_at_index (rw->entries, *index);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000322 }
Dave Barach97d8dc22016-08-15 15:31:15 -0400323 else
324 {
325 pool_get (rw->entries, e);
326 *index = e - rw->entries;
327 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000328
Dave Barach97d8dc22016-08-15 15:31:15 -0400329 if (is_del)
330 {
331 pool_put (rw->entries, e);
332 return 0;
333 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000334
Dave Barach97d8dc22016-08-15 15:31:15 -0400335 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));
Dave Barachb7b92992018-10-17 10:38:51 -0400339 clib_memset (e->mask, 0, e->rewrite_n_vectors * sizeof (u32x4));
Dave Barach97d8dc22016-08-15 15:31:15 -0400340 vec_alloc_aligned (e->value, e->rewrite_n_vectors, sizeof (u32x4));
Dave Barachb7b92992018-10-17 10:38:51 -0400341 clib_memset (e->value, 0, e->rewrite_n_vectors * sizeof (u32x4));
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000342
Dave Barach97d8dc22016-08-15 15:31:15 -0400343 clib_memcpy (((u8 *) e->value) + skip, value, len);
344 clib_memcpy (((u8 *) e->mask) + skip, mask, len);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000345
346 int i;
Dave Barach97d8dc22016-08-15 15:31:15 -0400347 for (i = 0; i < e->rewrite_n_vectors; i++)
348 {
349 e->value[i] &= e->mask[i];
350 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000351
352 return 0;
353}
Filip Tehlar44f0f712019-03-11 04:26:37 -0700354#endif /* CLIB_MARCH_VARIANT */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000355
356static clib_error_t *
357l2_rw_entry_cli_fn (vlib_main_t * vm,
Dave Barach97d8dc22016-08-15 15:31:15 -0400358 unformat_input_t * input, vlib_cli_command_t * cmd)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000359{
360 u32 index = ~0;
361 u8 *mask = 0;
362 u8 *value = 0;
363 u32 skip = 0;
364 u8 del = 0;
365
Dave Barach97d8dc22016-08-15 15:31:15 -0400366 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
367 {
368 if (unformat (input, "index %d", &index))
369 ;
370 else if (unformat (input, "mask %U", unformat_hex_string, &mask))
371 ;
372 else if (unformat (input, "value %U", unformat_hex_string, &value))
373 ;
374 else if (unformat (input, "skip %d", &skip))
375 ;
376 else if (unformat (input, "del"))
377 del = 1;
378 else
379 break;
380 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000381
382 if (!mask || !value)
Dave Barach97d8dc22016-08-15 15:31:15 -0400383 return clib_error_return (0, "Unspecified mask or value");
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000384
Dave Barach97d8dc22016-08-15 15:31:15 -0400385 if (vec_len (mask) != vec_len (value))
386 return clib_error_return (0, "Mask and value lengths must be identical");
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000387
388 int ret;
Dave Barach97d8dc22016-08-15 15:31:15 -0400389 if ((ret =
390 l2_rw_mod_entry (&index, mask, value, vec_len (mask), skip, del)))
391 return clib_error_return (0, "Could not add entry");
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000392
393 return 0;
394}
395
Billy McFall22aa3e92016-09-09 08:46:40 -0400396/*?
397 * Layer 2-Rewrite node uses classify tables to match packets. Then, using
Paul Vinciguerrabdc0e6b2018-09-22 05:32:50 -0700398 * the provisioned mask and value, modifies the packet header.
Billy McFall22aa3e92016-09-09 08:46:40 -0400399 *
400 * @cliexpar
yanlongd826a602023-08-08 11:36:32 +0800401 * 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
403mask,
404 * parameter value is Ethernet header's value):
405 * @cliexcmd{l2 rewrite entry mask ffffffffffff00000000000000000000 value
406008a000d0e0200000000000000000000}
Billy McFall22aa3e92016-09-09 08:46:40 -0400407?*/
Dave Barach97d8dc22016-08-15 15:31:15 -0400408/* *INDENT-OFF* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000409VLIB_CLI_COMMAND (l2_rw_entry_cli, static) = {
410 .path = "l2 rewrite entry",
411 .short_help =
412 "l2 rewrite entry [index <index>] [mask <hex-mask>] [value <hex-value>] [skip <n_bytes>] [del]",
413 .function = l2_rw_entry_cli_fn,
414};
Dave Barach97d8dc22016-08-15 15:31:15 -0400415/* *INDENT-ON* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000416
Filip Tehlar44f0f712019-03-11 04:26:37 -0700417#ifndef CLIB_MARCH_VARIANT
Dave Barach97d8dc22016-08-15 15:31:15 -0400418int
419l2_rw_interface_set_table (u32 sw_if_index, u32 table_index, u32 miss_index)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000420{
Dave Barach97d8dc22016-08-15 15:31:15 -0400421 l2_rw_config_t *c = l2_rw_get_config (sw_if_index);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000422 l2_rw_main_t *rw = &l2_rw_main;
423
424 c->table_index = table_index;
425 c->miss_index = miss_index;
Dave Barach97d8dc22016-08-15 15:31:15 -0400426 u32 feature_bitmap = (table_index == ~0) ? 0 : L2INPUT_FEAT_RW;
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000427
Dave Barach97d8dc22016-08-15 15:31:15 -0400428 l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_RW, feature_bitmap);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000429
430 if (c->table_index == ~0)
Dave Barach97d8dc22016-08-15 15:31:15 -0400431 clib_bitmap_set (rw->configs_bitmap, sw_if_index, 0);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000432
433 return 0;
434}
Filip Tehlar44f0f712019-03-11 04:26:37 -0700435#endif /* CLIB_MARCH_VARIANT */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000436
437static clib_error_t *
438l2_rw_interface_cli_fn (vlib_main_t * vm,
Dave Barach97d8dc22016-08-15 15:31:15 -0400439 unformat_input_t * input, vlib_cli_command_t * cmd)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000440{
Dave Barach97d8dc22016-08-15 15:31:15 -0400441 vnet_main_t *vnm = vnet_get_main ();
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000442 u32 table_index = ~0;
443 u32 sw_if_index = ~0;
444 u32 miss_index = ~0;
445
Dave Barach97d8dc22016-08-15 15:31:15 -0400446 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
447 {
448 unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index);
449 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000450
Dave Barach97d8dc22016-08-15 15:31:15 -0400451 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
452 {
453 if (unformat (input, "table %d", &table_index))
454 ;
455 else if (unformat (input, "miss-index %d", &miss_index))
456 ;
457 else
458 break;
459 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000460
461 if (sw_if_index == ~0)
Dave Barach97d8dc22016-08-15 15:31:15 -0400462 return clib_error_return (0,
463 "You must specify an interface 'iface <interface>'",
464 format_unformat_error, input);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000465 int ret;
Dave Barach97d8dc22016-08-15 15:31:15 -0400466 if ((ret =
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",
469 ret);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000470
471 return 0;
472}
473
Billy McFall22aa3e92016-09-09 08:46:40 -0400474/*?
yanlongd826a602023-08-08 11:36:32 +0800475 * Apply the rule to the interface. The following example shows how to use
476classify
477 * entry and Layer 2-Rewrite entry to modify the packet ethernet header on the
478 * interface.
Billy McFall22aa3e92016-09-09 08:46:40 -0400479 *
480 * @cliexpar
yanlongd826a602023-08-08 11:36:32 +0800481 * Example use the classify to filter packets that do not need to be modified
482(where
483 * 192.168.68.34 is the destination ip of the data packet, 8080 is the
484destination port
485 * of the packet):
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
488dst 192.168.68.34 l4 dst_port 8080}
489 *
490 * @cliexpar
491 * Example apply classify and l2 rewrite rules to the interface (where
492YusurK2Eth6/0/1/3
493 * is interface, \"table 0\" means Table Id is 0, \"miss 0\" means the packet
494that matches
495 * the classify. miss will be modified according to the l2 rewrite entry with
496index 0):
497 * @cliexcmd{set interface l2 rewrite YusurK2Eth6/0/1/3 table 0 miss-index 0}
Billy McFall22aa3e92016-09-09 08:46:40 -0400498?*/
Dave Barach97d8dc22016-08-15 15:31:15 -0400499/* *INDENT-OFF* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000500VLIB_CLI_COMMAND (l2_rw_interface_cli, static) = {
501 .path = "set interface l2 rewrite",
502 .short_help =
503 "set interface l2 rewrite <interface> [table <table index>] [miss-index <entry-index>]",
504 .function = l2_rw_interface_cli_fn,
505};
Dave Barach97d8dc22016-08-15 15:31:15 -0400506/* *INDENT-ON* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000507
508static clib_error_t *
509l2_rw_show_interfaces_cli_fn (vlib_main_t * vm,
Dave Barach97d8dc22016-08-15 15:31:15 -0400510 unformat_input_t * input,
511 vlib_cli_command_t * cmd)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000512{
513 l2_rw_main_t *rw = &l2_rw_main;
Dave Barach97d8dc22016-08-15 15:31:15 -0400514 if (clib_bitmap_count_set_bits (rw->configs_bitmap) == 0)
515 vlib_cli_output (vm, "No interface is currently using l2 rewrite\n");
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000516
517 uword i;
Dave Barach97d8dc22016-08-15 15:31:15 -0400518 /* *INDENT-OFF* */
Damjan Marionf0ca1e82020-12-13 23:26:56 +0100519 clib_bitmap_foreach (i, rw->configs_bitmap) {
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000520 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 +0100521 }
Dave Barach97d8dc22016-08-15 15:31:15 -0400522 /* *INDENT-ON* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000523 return 0;
524}
525
Billy McFall22aa3e92016-09-09 08:46:40 -0400526/*?
yanlongd826a602023-08-08 11:36:32 +0800527 * This command displays the l2 rewrite entries of the interfaces.
Billy McFall22aa3e92016-09-09 08:46:40 -0400528 *
529 * @cliexpar
yanlongd826a602023-08-08 11:36:32 +0800530 * 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
533 * @cliexend
Billy McFall22aa3e92016-09-09 08:46:40 -0400534?*/
Dave Barach97d8dc22016-08-15 15:31:15 -0400535/* *INDENT-OFF* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000536VLIB_CLI_COMMAND (l2_rw_show_interfaces_cli, static) = {
537 .path = "show l2 rewrite interfaces",
538 .short_help =
539 "show l2 rewrite interfaces",
540 .function = l2_rw_show_interfaces_cli_fn,
541};
Dave Barach97d8dc22016-08-15 15:31:15 -0400542/* *INDENT-ON* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000543
544static clib_error_t *
545l2_rw_show_entries_cli_fn (vlib_main_t * vm,
Dave Barach97d8dc22016-08-15 15:31:15 -0400546 unformat_input_t * input, vlib_cli_command_t * cmd)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000547{
548 l2_rw_main_t *rw = &l2_rw_main;
549 l2_rw_entry_t *e;
Dave Barach97d8dc22016-08-15 15:31:15 -0400550 if (pool_elts (rw->entries) == 0)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000551 vlib_cli_output (vm, "No entries\n");
552
Dave Barach97d8dc22016-08-15 15:31:15 -0400553 /* *INDENT-OFF* */
Damjan Marionb2c31b62020-12-13 21:47:40 +0100554 pool_foreach (e, rw->entries) {
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000555 vlib_cli_output (vm, "%U\n", format_l2_rw_entry, e);
Damjan Marionb2c31b62020-12-13 21:47:40 +0100556 }
Dave Barach97d8dc22016-08-15 15:31:15 -0400557 /* *INDENT-ON* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000558 return 0;
559}
560
Billy McFall22aa3e92016-09-09 08:46:40 -0400561/*?
yanlongd826a602023-08-08 11:36:32 +0800562 * This command displays all l2 rewrite entries.
Billy McFall22aa3e92016-09-09 08:46:40 -0400563 *
564 * @cliexpar
yanlongd826a602023-08-08 11:36:32 +0800565 * Example of how to display all l2 rewrite entries:
566 * @cliexstart{show l2 rewrite entries}
567 * 0 - mask:ffffffffffff00000000000000000000
568value:aabbccddeeff00000000000000000000
569 * hits:0 skip_bytes:0
570 * @cliexend
Billy McFall22aa3e92016-09-09 08:46:40 -0400571?*/
Dave Barach97d8dc22016-08-15 15:31:15 -0400572/* *INDENT-OFF* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000573VLIB_CLI_COMMAND (l2_rw_show_entries_cli, static) = {
574 .path = "show l2 rewrite entries",
575 .short_help =
576 "show l2 rewrite entries",
577 .function = l2_rw_show_entries_cli_fn,
578};
Dave Barach97d8dc22016-08-15 15:31:15 -0400579/* *INDENT-ON* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000580
Filip Tehlar44f0f712019-03-11 04:26:37 -0700581static int
Dave Barach97d8dc22016-08-15 15:31:15 -0400582l2_rw_enable_disable (u32 bridge_domain, u8 disable)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000583{
584 u32 mask = L2INPUT_FEAT_RW;
Dave Barach97d8dc22016-08-15 15:31:15 -0400585 l2input_set_bridge_features (bridge_domain, mask, disable ? 0 : mask);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000586 return 0;
587}
588
589static clib_error_t *
590l2_rw_set_cli_fn (vlib_main_t * vm,
Dave Barach97d8dc22016-08-15 15:31:15 -0400591 unformat_input_t * input, vlib_cli_command_t * cmd)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000592{
593 u32 bridge_domain;
594 u8 disable = 0;
595
Dave Barach97d8dc22016-08-15 15:31:15 -0400596 if (unformat_check_input (input) == UNFORMAT_END_OF_INPUT ||
597 !unformat (input, "%d", &bridge_domain))
598 {
599 return clib_error_return (0, "You must specify a bridge domain");
600 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000601
Dave Barach97d8dc22016-08-15 15:31:15 -0400602 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT &&
603 unformat (input, "disable"))
604 {
605 disable = 1;
606 }
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000607
Dave Barach97d8dc22016-08-15 15:31:15 -0400608 if (l2_rw_enable_disable (bridge_domain, disable))
609 return clib_error_return (0, "Could not enable or disable rewrite");
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000610
611 return 0;
612}
613
Billy McFall22aa3e92016-09-09 08:46:40 -0400614/*?
yanlongd826a602023-08-08 11:36:32 +0800615 * Layer 2 rewrite can be enabled and disabled on each interface and on each
616bridge-domain.
617 * Use this command to manage l2 rewrite on bridge-domain.
Billy McFall22aa3e92016-09-09 08:46:40 -0400618 *
619 * @cliexpar
yanlongd826a602023-08-08 11:36:32 +0800620 * 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}
Billy McFall22aa3e92016-09-09 08:46:40 -0400624?*/
Dave Barach97d8dc22016-08-15 15:31:15 -0400625/* *INDENT-OFF* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000626VLIB_CLI_COMMAND (l2_rw_set_cli, static) = {
627 .path = "set bridge-domain rewrite",
628 .short_help =
629 "set bridge-domain rewrite <bridge-domain> [disable]",
630 .function = l2_rw_set_cli_fn,
631};
Dave Barach97d8dc22016-08-15 15:31:15 -0400632/* *INDENT-ON* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000633
Dave Barach97d8dc22016-08-15 15:31:15 -0400634static clib_error_t *
635l2_rw_init (vlib_main_t * vm)
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000636{
637 l2_rw_main_t *rw = &l2_rw_main;
638 rw->configs = 0;
639 rw->entries = 0;
Dave Barach97d8dc22016-08-15 15:31:15 -0400640 clib_bitmap_alloc (rw->configs_bitmap, 1);
641 feat_bitmap_init_next_nodes (vm,
642 l2_rw_node.index,
643 L2INPUT_N_FEAT,
644 l2input_get_feat_names (),
645 rw->feat_next_node_index);
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000646 return 0;
647}
Dave Barach97d8dc22016-08-15 15:31:15 -0400648
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000649VLIB_INIT_FUNCTION (l2_rw_init);
650
Dave Barach97d8dc22016-08-15 15:31:15 -0400651enum
652{
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000653 L2_RW_NEXT_DROP,
654 L2_RW_N_NEXT,
655};
656
657#define foreach_l2_rw_error \
658_(UNKNOWN, "Unknown error")
659
Dave Barach97d8dc22016-08-15 15:31:15 -0400660typedef enum
661{
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000662#define _(sym,str) L2_RW_ERROR_##sym,
663 foreach_l2_rw_error
664#undef _
Dave Barach97d8dc22016-08-15 15:31:15 -0400665 L2_RW_N_ERROR,
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000666} l2_rw_error_t;
667
Dave Barach97d8dc22016-08-15 15:31:15 -0400668static char *l2_rw_error_strings[] = {
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000669#define _(sym,string) string,
Dave Barach97d8dc22016-08-15 15:31:15 -0400670 foreach_l2_rw_error
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000671#undef _
672};
673
Dave Barach97d8dc22016-08-15 15:31:15 -0400674/* *INDENT-OFF* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000675VLIB_REGISTER_NODE (l2_rw_node) = {
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000676 .name = "l2-rw",
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"},
685};
Dave Barach97d8dc22016-08-15 15:31:15 -0400686/* *INDENT-ON* */
Pierre Pfisterd6f5b962016-03-21 16:17:52 +0000687
Dave Barach97d8dc22016-08-15 15:31:15 -0400688/*
689 * fd.io coding-style-patch-verification: ON
690 *
691 * Local Variables:
692 * eval: (c-set-style "gnu")
693 * End:
694 */