FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
l2_in_out_acl.c
Go to the documentation of this file.
1 /*
2  * l2_in_out_acl.c : layer 2 input/output acl processing
3  *
4  * Copyright (c) 2013,2018 Cisco and/or its affiliates.
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at:
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #include <vlib/vlib.h>
19 #include <vnet/vnet.h>
20 #include <vnet/pg/pg.h>
21 #include <vnet/ethernet/ethernet.h>
22 #include <vnet/ethernet/packet.h>
23 #include <vnet/ip/ip_packet.h>
24 #include <vnet/ip/ip4_packet.h>
25 #include <vnet/ip/ip6_packet.h>
26 #include <vlib/cli.h>
27 #include <vnet/l2/l2_input.h>
28 #include <vnet/l2/l2_output.h>
29 #include <vnet/l2/feat_bitmap.h>
30 
31 #include <vppinfra/error.h>
32 #include <vppinfra/hash.h>
33 #include <vppinfra/cache.h>
34 
37 
38 typedef struct
39 {
40 
41  /* Next nodes for each feature */
42  u32 feat_next_node_index[IN_OUT_ACL_N_TABLE_GROUPS][32];
43 
44  /* convenience variables */
48 
49 typedef struct
50 {
56 
57 /* packet trace format function */
58 static u8 *
59 format_l2_in_out_acl_trace (u8 * s, u32 is_output, va_list * args)
60 {
61  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
62  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
63  l2_in_out_acl_trace_t *t = va_arg (*args, l2_in_out_acl_trace_t *);
64 
65  s = format (s, "%s: sw_if_index %d, next_index %d, table %d, offset %d",
66  is_output ? "OUTACL" : "INACL",
67  t->sw_if_index, t->next_index, t->table_index, t->offset);
68  return s;
69 }
70 
71 static u8 *
72 format_l2_inacl_trace (u8 * s, va_list * args)
73 {
75 }
76 
77 static u8 *
78 format_l2_outacl_trace (u8 * s, va_list * args)
79 {
81 }
82 
84 
85 #ifndef CLIB_MARCH_VARIANT
87 #endif /* CLIB_MARCH_VARIANT */
88 
91 
92 #define foreach_l2_inacl_error \
93 _(NONE, "valid input ACL packets") \
94 _(MISS, "input ACL misses") \
95 _(HIT, "input ACL hits") \
96 _(CHAIN_HIT, "input ACL hits after chain walk") \
97 _(TABLE_MISS, "input ACL table-miss drops") \
98 _(SESSION_DENY, "input ACL session deny drops")
99 
100 #define foreach_l2_outacl_error \
101 _(NONE, "valid output ACL packets") \
102 _(MISS, "output ACL misses") \
103 _(HIT, "output ACL hits") \
104 _(CHAIN_HIT, "output ACL hits after chain walk") \
105 _(TABLE_MISS, "output ACL table-miss drops") \
106 _(SESSION_DENY, "output ACL session deny drops")
107 
108 
109 typedef enum
110 {
111 #define _(sym,str) L2_INACL_ERROR_##sym,
113 #undef _
116 
117 static char *l2_inacl_error_strings[] = {
118 #define _(sym,string) string,
120 #undef _
121 };
122 
123 typedef enum
124 {
125 #define _(sym,str) L2_OUTACL_ERROR_##sym,
127 #undef _
130 
131 static char *l2_outacl_error_strings[] = {
132 #define _(sym,string) string,
134 #undef _
135 };
136 
137 
138 static inline uword
141  int is_output)
142 {
143  u32 n_left_from, *from, *to_next;
144  acl_next_index_t next_index;
149  f64 now = vlib_time_now (vm);
150  u32 hits = 0;
151  u32 misses = 0;
152  u32 chain_hits = 0;
153 
154  from = vlib_frame_vector_args (frame);
155  n_left_from = frame->n_vectors; /* number of packets to process */
156  next_index = node->cached_next_index;
157 
158  /* First pass: compute hashes */
159  while (n_left_from > 2)
160  {
161  vlib_buffer_t *b0, *b1;
162  u32 bi0, bi1;
163  u8 *h0, *h1;
164  u32 sw_if_index0, sw_if_index1;
165  u32 table_index0, table_index1;
166  vnet_classify_table_t *t0, *t1;
167 
168  /* prefetch next iteration */
169  {
170  vlib_buffer_t *p1, *p2;
171 
172  p1 = vlib_get_buffer (vm, from[1]);
173  p2 = vlib_get_buffer (vm, from[2]);
174 
175  vlib_prefetch_buffer_header (p1, STORE);
177  vlib_prefetch_buffer_header (p2, STORE);
179  }
180 
181  bi0 = from[0];
182  b0 = vlib_get_buffer (vm, bi0);
183 
184  bi1 = from[1];
185  b1 = vlib_get_buffer (vm, bi1);
186 
187  sw_if_index0 =
188  vnet_buffer (b0)->sw_if_index[is_output ? VLIB_TX : VLIB_RX];
189  table_index0 =
190  am->classify_table_index_by_sw_if_index[is_output][tid][sw_if_index0];
191 
192  sw_if_index1 =
193  vnet_buffer (b1)->sw_if_index[is_output ? VLIB_TX : VLIB_RX];
194  table_index1 =
195  am->classify_table_index_by_sw_if_index[is_output][tid][sw_if_index1];
196 
197  t0 = pool_elt_at_index (vcm->tables, table_index0);
198 
199  t1 = pool_elt_at_index (vcm->tables, table_index1);
200 
202  h0 = (void *) vlib_buffer_get_current (b0) + t0->current_data_offset;
203  else
204  h0 = (void *) vlib_buffer_get_current (b0);
205 
206  vnet_buffer (b0)->l2_classify.hash =
207  vnet_classify_hash_packet (t0, (u8 *) h0);
208 
209  vnet_classify_prefetch_bucket (t0, vnet_buffer (b0)->l2_classify.hash);
210 
212  h1 = (void *) vlib_buffer_get_current (b1) + t1->current_data_offset;
213  else
214  h1 = (void *) vlib_buffer_get_current (b1);
215 
216  vnet_buffer (b1)->l2_classify.hash =
217  vnet_classify_hash_packet (t1, (u8 *) h1);
218 
219  vnet_classify_prefetch_bucket (t1, vnet_buffer (b1)->l2_classify.hash);
220 
221  vnet_buffer (b0)->l2_classify.table_index = table_index0;
222 
223  vnet_buffer (b1)->l2_classify.table_index = table_index1;
224 
225  from += 2;
226  n_left_from -= 2;
227  }
228 
229  while (n_left_from > 0)
230  {
231  vlib_buffer_t *b0;
232  u32 bi0;
233  u8 *h0;
234  u32 sw_if_index0;
235  u32 table_index0;
237 
238  bi0 = from[0];
239  b0 = vlib_get_buffer (vm, bi0);
240 
241  sw_if_index0 =
242  vnet_buffer (b0)->sw_if_index[is_output ? VLIB_TX : VLIB_RX];
243  table_index0 =
244  am->classify_table_index_by_sw_if_index[is_output][tid][sw_if_index0];
245 
246  t0 = pool_elt_at_index (vcm->tables, table_index0);
247 
249  h0 = (void *) vlib_buffer_get_current (b0) + t0->current_data_offset;
250  else
251  h0 = (void *) vlib_buffer_get_current (b0);
252 
253  vnet_buffer (b0)->l2_classify.hash =
254  vnet_classify_hash_packet (t0, (u8 *) h0);
255 
256  vnet_buffer (b0)->l2_classify.table_index = table_index0;
257  vnet_classify_prefetch_bucket (t0, vnet_buffer (b0)->l2_classify.hash);
258 
259  from++;
260  n_left_from--;
261  }
262 
263  next_index = node->cached_next_index;
264  from = vlib_frame_vector_args (frame);
265  n_left_from = frame->n_vectors;
266 
267  while (n_left_from > 0)
268  {
269  u32 n_left_to_next;
270 
271  vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
272 
273  /* Not enough load/store slots to dual loop... */
274  while (n_left_from > 0 && n_left_to_next > 0)
275  {
276  u32 bi0;
277  vlib_buffer_t *b0;
278  u32 next0 = ACL_NEXT_INDEX_DENY;
279  u32 table_index0;
281  vnet_classify_entry_t *e0;
282  u64 hash0;
283  u8 *h0;
284  u8 error0;
285 
286  /* Stride 3 seems to work best */
287  if (PREDICT_TRUE (n_left_from > 3))
288  {
289  vlib_buffer_t *p1 = vlib_get_buffer (vm, from[3]);
291  u32 table_index1;
292  u64 phash1;
293 
294  table_index1 = vnet_buffer (p1)->l2_classify.table_index;
295 
296  if (PREDICT_TRUE (table_index1 != ~0))
297  {
298  tp1 = pool_elt_at_index (vcm->tables, table_index1);
299  phash1 = vnet_buffer (p1)->l2_classify.hash;
300  vnet_classify_prefetch_entry (tp1, phash1);
301  }
302  }
303 
304  /* speculatively enqueue b0 to the current next frame */
305  bi0 = from[0];
306  to_next[0] = bi0;
307  from += 1;
308  to_next += 1;
309  n_left_from -= 1;
310  n_left_to_next -= 1;
311 
312  b0 = vlib_get_buffer (vm, bi0);
313 
314  table_index0 = vnet_buffer (b0)->l2_classify.table_index;
315  e0 = 0;
316  t0 = 0;
317 
318  vnet_buffer (b0)->l2_classify.opaque_index = ~0;
319 
320  /* Determine the next node */
321  next0 =
322  vnet_l2_feature_next (b0, msm->feat_next_node_index[is_output],
323  is_output ? L2OUTPUT_FEAT_ACL :
324  L2INPUT_FEAT_ACL);
325 
326  if (PREDICT_TRUE (table_index0 != ~0))
327  {
328  hash0 = vnet_buffer (b0)->l2_classify.hash;
329  t0 = pool_elt_at_index (vcm->tables, table_index0);
330 
332  h0 =
333  (void *) vlib_buffer_get_current (b0) +
335  else
336  h0 = (void *) vlib_buffer_get_current (b0);
337 
338  e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
339  if (e0)
340  {
341  vnet_buffer (b0)->l2_classify.opaque_index
342  = e0->opaque_index;
343  vlib_buffer_advance (b0, e0->advance);
344 
345  next0 = (e0->next_index < ACL_NEXT_INDEX_N_NEXT) ?
346  e0->next_index : next0;
347 
348  hits++;
349 
350  if (is_output)
351  error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
352  L2_OUTACL_ERROR_SESSION_DENY : L2_INACL_ERROR_NONE;
353  else
354  error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
355  L2_OUTACL_ERROR_SESSION_DENY : L2_OUTACL_ERROR_NONE;
356  b0->error = node->errors[error0];
357  }
358  else
359  {
360  while (1)
361  {
362  if (PREDICT_TRUE (t0->next_table_index != ~0))
363  t0 = pool_elt_at_index (vcm->tables,
364  t0->next_table_index);
365  else
366  {
367  next0 =
368  (t0->miss_next_index <
370  next0;
371 
372  misses++;
373 
374  if (is_output)
375  error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
376  L2_OUTACL_ERROR_TABLE_MISS :
377  L2_OUTACL_ERROR_NONE;
378  else
379  error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
380  L2_INACL_ERROR_TABLE_MISS : L2_INACL_ERROR_NONE;
381  b0->error = node->errors[error0];
382  break;
383  }
384 
385  if (t0->current_data_flag ==
387  h0 =
388  (void *) vlib_buffer_get_current (b0) +
390  else
391  h0 = (void *) vlib_buffer_get_current (b0);
392 
393  hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
395  (t0, (u8 *) h0, hash0, now);
396  if (e0)
397  {
398  vlib_buffer_advance (b0, e0->advance);
399  next0 = (e0->next_index < ACL_NEXT_INDEX_N_NEXT) ?
400  e0->next_index : next0;
401  hits++;
402  chain_hits++;
403 
404  if (is_output)
405  error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
406  L2_OUTACL_ERROR_SESSION_DENY :
407  L2_OUTACL_ERROR_NONE;
408  else
409  error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
410  L2_INACL_ERROR_SESSION_DENY :
411  L2_INACL_ERROR_NONE;
412  b0->error = node->errors[error0];
413  break;
414  }
415  }
416  }
417  }
418 
420  && (b0->flags & VLIB_BUFFER_IS_TRACED)))
421  {
423  vlib_add_trace (vm, node, b0, sizeof (*t));
424  t->sw_if_index =
425  vnet_buffer (b0)->sw_if_index[is_output ? VLIB_TX : VLIB_RX];
426  t->next_index = next0;
427  t->table_index = t0 ? t0 - vcm->tables : ~0;
428  t->offset = (t0 && e0) ? vnet_classify_get_offset (t0, e0) : ~0;
429  }
430 
431  /* verify speculative enqueue, maybe switch current next frame */
432  vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
433  to_next, n_left_to_next,
434  bi0, next0);
435  }
436 
437  vlib_put_next_frame (vm, node, next_index, n_left_to_next);
438  }
439 
441  is_output ? L2_OUTACL_ERROR_MISS :
442  L2_INACL_ERROR_MISS, misses);
444  is_output ? L2_OUTACL_ERROR_HIT :
445  L2_INACL_ERROR_HIT, hits);
447  is_output ? L2_OUTACL_ERROR_CHAIN_HIT :
448  L2_INACL_ERROR_CHAIN_HIT, chain_hits);
449  return frame->n_vectors;
450 }
451 
455 {
456  return l2_in_out_acl_node_fn (vm, node, frame,
458 }
459 
463 {
464  return l2_in_out_acl_node_fn (vm, node, frame,
466 }
467 
468 /* *INDENT-OFF* */
470  .name = "l2-input-acl",
471  .vector_size = sizeof (u32),
472  .format_trace = format_l2_inacl_trace,
474 
475  .n_errors = ARRAY_LEN(l2_inacl_error_strings),
476  .error_strings = l2_inacl_error_strings,
477 
478  .n_next_nodes = ACL_NEXT_INDEX_N_NEXT,
479 
480  /* edit / add dispositions here */
481  .next_nodes = {
482  [ACL_NEXT_INDEX_DENY] = "error-drop",
483  },
484 };
485 
487  .name = "l2-output-acl",
488  .vector_size = sizeof (u32),
489  .format_trace = format_l2_outacl_trace,
491 
492  .n_errors = ARRAY_LEN(l2_outacl_error_strings),
493  .error_strings = l2_outacl_error_strings,
494 
495  .n_next_nodes = ACL_NEXT_INDEX_N_NEXT,
496 
497  /* edit / add dispositions here */
498  .next_nodes = {
499  [ACL_NEXT_INDEX_DENY] = "error-drop",
500  },
501 };
502 /* *INDENT-ON* */
503 
504 
505 #ifndef CLIB_MARCH_VARIANT
506 clib_error_t *
508 {
510 
511  mp->vlib_main = vm;
512  mp->vnet_main = vnet_get_main ();
513 
514  /* Initialize the feature next-node indexes */
516  l2_inacl_node.index,
525 
526  return 0;
527 }
528 
530 #endif /* CLIB_MARCH_VARIANT */
531 
532 /*
533  * fd.io coding-style-patch-verification: ON
534  *
535  * Local Variables:
536  * eval: (c-set-style "gnu")
537  * End:
538  */
u64 vnet_classify_hash_packet(vnet_classify_table_t *t, u8 *h)
static uword l2_in_out_acl_node_fn(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame, int is_output)
vlib_node_registration_t l2_inacl_node
(constructor) VLIB_REGISTER_NODE (l2_inacl_node)
u32 flags
buffer flags: VLIB_BUFFER_FREE_LIST_INDEX_MASK: bits used to store free list index, VLIB_BUFFER_IS_TRACED: trace this buffer.
Definition: buffer.h:124
#define CLIB_UNUSED(x)
Definition: clib.h:87
char ** l2output_get_feat_names(void)
Definition: l2_output.c:39
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
#define PREDICT_TRUE(x)
Definition: clib.h:121
unsigned long u64
Definition: types.h:89
u32 * classify_table_index_by_sw_if_index[IN_OUT_ACL_N_TABLE_GROUPS][IN_OUT_ACL_N_TABLES]
Definition: in_out_acl.h:50
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:333
#define foreach_l2_inacl_error
Definition: l2_in_out_acl.c:92
vlib_main_t * vm
Definition: in2out_ed.c:1582
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
vnet_main_t * vnet_main
Definition: l2_in_out_acl.c:46
#define VLIB_NODE_FN(node)
Definition: node.h:202
vlib_error_t * errors
Vector of errors for this node.
Definition: node.h:469
unsigned char u8
Definition: types.h:56
static u32 vnet_l2_feature_next(vlib_buffer_t *b, u32 *next_nodes, u32 feat_bit)
Return the graph node index for the feature corresponding to the next set bit after clearing the curr...
Definition: feat_bitmap.h:94
static u8 * format_l2_outacl_trace(u8 *s, va_list *args)
Definition: l2_in_out_acl.c:78
double f64
Definition: types.h:142
static u8 * format_l2_inacl_trace(u8 *s, va_list *args)
Definition: l2_in_out_acl.c:72
#define CLASSIFY_FLAG_USE_CURR_DATA
Definition: vnet_classify.h:36
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:173
l2_outacl_error_t
vlib_main_t * vlib_main
Definition: l2_in_out_acl.c:45
#define vlib_prefetch_buffer_header(b, type)
Prefetch buffer metadata.
Definition: buffer.h:203
l2_in_out_acl_main_t l2_in_out_acl_main
Definition: l2_in_out_acl.c:86
unsigned int u32
Definition: types.h:88
static void vnet_classify_prefetch_bucket(vnet_classify_table_t *t, u64 hash)
l2_inacl_error_t
static void vnet_classify_prefetch_entry(vnet_classify_table_t *t, u64 hash)
vl_api_fib_path_type_t type
Definition: fib_types.api:123
vlib_error_t error
Error code for buffers to be enqueued to error handler.
Definition: buffer.h:136
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:534
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:229
#define PREDICT_FALSE(x)
Definition: clib.h:120
u32 node_index
Node index.
Definition: node.h:487
#define vlib_validate_buffer_enqueue_x1(vm, node, next_index, to_next, n_left_to_next, bi0, next0)
Finish enqueueing one buffer forward in the graph.
Definition: buffer_node.h:224
#define vlib_get_next_frame(vm, node, next_index, vectors, n_vectors_left)
Get pointer to next frame vector data by (vlib_node_runtime_t, next_index).
Definition: node_funcs.h:391
static void vlib_node_increment_counter(vlib_main_t *vm, u32 node_index, u32 counter_index, u64 increment)
Definition: node_funcs.h:1231
static uword vnet_classify_get_offset(vnet_classify_table_t *t, vnet_classify_entry_t *v)
#define foreach_l2_outacl_error
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:169
u16 n_vectors
Definition: node.h:396
#define CLIB_PREFETCH(addr, size, type)
Definition: cache.h:80
static void feat_bitmap_init_next_nodes(vlib_main_t *vm, u32 node_index, u32 num_features, char **feat_names, u32 *next_nodes)
Initialize the feature next-node indexes of a graph node.
Definition: feat_bitmap.h:43
u32 feat_next_node_index[IN_OUT_ACL_N_TABLE_GROUPS][32]
Definition: l2_in_out_acl.c:42
u8 data[]
Packet data.
Definition: buffer.h:181
#define ARRAY_LEN(x)
Definition: clib.h:67
void vlib_put_next_frame(vlib_main_t *vm, vlib_node_runtime_t *r, u32 next_index, u32 n_vectors_left)
Release pointer to next frame vector data.
Definition: main.c:483
in_out_acl_table_id_t
Definition: in_out_acl.h:29
char ** l2input_get_feat_names(void)
Return an array of strings containing graph node names of each feature.
Definition: l2_input.c:62
vlib_main_t vlib_node_runtime_t * node
Definition: in2out_ed.c:1582
struct _vnet_classify_main vnet_classify_main_t
Definition: vnet_classify.h:55
clib_error_t * l2_in_out_acl_init(vlib_main_t *vm)
u16 cached_next_index
Next frame index that vector arguments were last enqueued to last time this node ran.
Definition: node.h:510
static void vlib_buffer_advance(vlib_buffer_t *b, word l)
Advance current data pointer by the supplied (signed!) amount.
Definition: buffer.h:248
static char * l2_inacl_error_strings[]
static char * l2_outacl_error_strings[]
struct _vlib_node_registration vlib_node_registration_t
Definition: defs.h:47
vnet_classify_main_t * vnet_classify_main
Definition: in_out_acl.h:55
vlib_main_t vlib_node_runtime_t vlib_frame_t * frame
Definition: in2out_ed.c:1583
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:297
#define vnet_buffer(b)
Definition: buffer.h:417
in_out_acl_main_t in_out_acl_main
Definition: in_out_acl.c:21
u16 flags
Copy of main node flags.
Definition: node.h:500
void * vlib_add_trace(vlib_main_t *vm, vlib_node_runtime_t *r, vlib_buffer_t *b, u32 n_data_bytes)
Definition: trace.c:577
acl_next_index_t
Definition: in_out_acl.h:23
#define VLIB_NODE_FLAG_TRACE
Definition: node.h:301
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59
static u8 * format_l2_in_out_acl_trace(u8 *s, u32 is_output, va_list *args)
Definition: l2_in_out_acl.c:59
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:85
vnet_classify_entry_t * vnet_classify_find_entry(vnet_classify_table_t *t, u8 *h, u64 hash, f64 now)
Definition: defs.h:46
vlib_node_registration_t l2_outacl_node
(constructor) VLIB_REGISTER_NODE (l2_outacl_node)