FD.io VPP  v19.01.3-6-g70449b9b9
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 
87 
88 #define foreach_l2_inacl_error \
89 _(NONE, "valid input ACL packets") \
90 _(MISS, "input ACL misses") \
91 _(HIT, "input ACL hits") \
92 _(CHAIN_HIT, "input ACL hits after chain walk") \
93 _(TABLE_MISS, "input ACL table-miss drops") \
94 _(SESSION_DENY, "input ACL session deny drops")
95 
96 #define foreach_l2_outacl_error \
97 _(NONE, "valid output ACL packets") \
98 _(MISS, "output ACL misses") \
99 _(HIT, "output ACL hits") \
100 _(CHAIN_HIT, "output ACL hits after chain walk") \
101 _(TABLE_MISS, "output ACL table-miss drops") \
102 _(SESSION_DENY, "output ACL session deny drops")
103 
104 
105 typedef enum
106 {
107 #define _(sym,str) L2_INACL_ERROR_##sym,
109 #undef _
112 
113 static char *l2_inacl_error_strings[] = {
114 #define _(sym,string) string,
116 #undef _
117 };
118 
119 typedef enum
120 {
121 #define _(sym,str) L2_OUTACL_ERROR_##sym,
123 #undef _
126 
127 static char *l2_outacl_error_strings[] = {
128 #define _(sym,string) string,
130 #undef _
131 };
132 
133 
134 static inline uword
136  vlib_node_runtime_t * node, vlib_frame_t * frame,
137  int is_output)
138 {
139  u32 n_left_from, *from, *to_next;
140  acl_next_index_t next_index;
145  f64 now = vlib_time_now (vm);
146  u32 hits = 0;
147  u32 misses = 0;
148  u32 chain_hits = 0;
149 
150  from = vlib_frame_vector_args (frame);
151  n_left_from = frame->n_vectors; /* number of packets to process */
152  next_index = node->cached_next_index;
153 
154  /* First pass: compute hashes */
155  while (n_left_from > 2)
156  {
157  vlib_buffer_t *b0, *b1;
158  u32 bi0, bi1;
159  u8 *h0, *h1;
160  u32 sw_if_index0, sw_if_index1;
161  u32 table_index0, table_index1;
162  vnet_classify_table_t *t0, *t1;
163 
164  /* prefetch next iteration */
165  {
166  vlib_buffer_t *p1, *p2;
167 
168  p1 = vlib_get_buffer (vm, from[1]);
169  p2 = vlib_get_buffer (vm, from[2]);
170 
171  vlib_prefetch_buffer_header (p1, STORE);
173  vlib_prefetch_buffer_header (p2, STORE);
175  }
176 
177  bi0 = from[0];
178  b0 = vlib_get_buffer (vm, bi0);
179 
180  bi1 = from[1];
181  b1 = vlib_get_buffer (vm, bi1);
182 
183  sw_if_index0 =
184  vnet_buffer (b0)->sw_if_index[is_output ? VLIB_TX : VLIB_RX];
185  table_index0 =
186  am->classify_table_index_by_sw_if_index[is_output][tid][sw_if_index0];
187 
188  sw_if_index1 =
189  vnet_buffer (b1)->sw_if_index[is_output ? VLIB_TX : VLIB_RX];
190  table_index1 =
191  am->classify_table_index_by_sw_if_index[is_output][tid][sw_if_index1];
192 
193  t0 = pool_elt_at_index (vcm->tables, table_index0);
194 
195  t1 = pool_elt_at_index (vcm->tables, table_index1);
196 
198  h0 = (void *) vlib_buffer_get_current (b0) + t0->current_data_offset;
199  else
200  h0 = (void *) vlib_buffer_get_current (b0);
201 
202  vnet_buffer (b0)->l2_classify.hash =
203  vnet_classify_hash_packet (t0, (u8 *) h0);
204 
205  vnet_classify_prefetch_bucket (t0, vnet_buffer (b0)->l2_classify.hash);
206 
208  h1 = (void *) vlib_buffer_get_current (b1) + t1->current_data_offset;
209  else
210  h1 = (void *) vlib_buffer_get_current (b1);
211 
212  vnet_buffer (b1)->l2_classify.hash =
213  vnet_classify_hash_packet (t1, (u8 *) h1);
214 
215  vnet_classify_prefetch_bucket (t1, vnet_buffer (b1)->l2_classify.hash);
216 
217  vnet_buffer (b0)->l2_classify.table_index = table_index0;
218 
219  vnet_buffer (b1)->l2_classify.table_index = table_index1;
220 
221  from += 2;
222  n_left_from -= 2;
223  }
224 
225  while (n_left_from > 0)
226  {
227  vlib_buffer_t *b0;
228  u32 bi0;
229  u8 *h0;
230  u32 sw_if_index0;
231  u32 table_index0;
233 
234  bi0 = from[0];
235  b0 = vlib_get_buffer (vm, bi0);
236 
237  sw_if_index0 =
238  vnet_buffer (b0)->sw_if_index[is_output ? VLIB_TX : VLIB_RX];
239  table_index0 =
240  am->classify_table_index_by_sw_if_index[is_output][tid][sw_if_index0];
241 
242  t0 = pool_elt_at_index (vcm->tables, table_index0);
243 
245  h0 = (void *) vlib_buffer_get_current (b0) + t0->current_data_offset;
246  else
247  h0 = (void *) vlib_buffer_get_current (b0);
248 
249  vnet_buffer (b0)->l2_classify.hash =
250  vnet_classify_hash_packet (t0, (u8 *) h0);
251 
252  vnet_buffer (b0)->l2_classify.table_index = table_index0;
253  vnet_classify_prefetch_bucket (t0, vnet_buffer (b0)->l2_classify.hash);
254 
255  from++;
256  n_left_from--;
257  }
258 
259  next_index = node->cached_next_index;
260  from = vlib_frame_vector_args (frame);
261  n_left_from = frame->n_vectors;
262 
263  while (n_left_from > 0)
264  {
265  u32 n_left_to_next;
266 
267  vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
268 
269  /* Not enough load/store slots to dual loop... */
270  while (n_left_from > 0 && n_left_to_next > 0)
271  {
272  u32 bi0;
273  vlib_buffer_t *b0;
274  u32 next0 = ACL_NEXT_INDEX_DENY;
275  u32 table_index0;
277  vnet_classify_entry_t *e0;
278  u64 hash0;
279  u8 *h0;
280  u8 error0;
281 
282  /* Stride 3 seems to work best */
283  if (PREDICT_TRUE (n_left_from > 3))
284  {
285  vlib_buffer_t *p1 = vlib_get_buffer (vm, from[3]);
287  u32 table_index1;
288  u64 phash1;
289 
290  table_index1 = vnet_buffer (p1)->l2_classify.table_index;
291 
292  if (PREDICT_TRUE (table_index1 != ~0))
293  {
294  tp1 = pool_elt_at_index (vcm->tables, table_index1);
295  phash1 = vnet_buffer (p1)->l2_classify.hash;
296  vnet_classify_prefetch_entry (tp1, phash1);
297  }
298  }
299 
300  /* speculatively enqueue b0 to the current next frame */
301  bi0 = from[0];
302  to_next[0] = bi0;
303  from += 1;
304  to_next += 1;
305  n_left_from -= 1;
306  n_left_to_next -= 1;
307 
308  b0 = vlib_get_buffer (vm, bi0);
309 
310  table_index0 = vnet_buffer (b0)->l2_classify.table_index;
311  e0 = 0;
312  t0 = 0;
313 
314  vnet_buffer (b0)->l2_classify.opaque_index = ~0;
315 
316  /* Determine the next node */
317  next0 =
318  vnet_l2_feature_next (b0, msm->feat_next_node_index[is_output],
319  is_output ? L2OUTPUT_FEAT_ACL :
320  L2INPUT_FEAT_ACL);
321 
322  if (PREDICT_TRUE (table_index0 != ~0))
323  {
324  hash0 = vnet_buffer (b0)->l2_classify.hash;
325  t0 = pool_elt_at_index (vcm->tables, table_index0);
326 
328  h0 =
329  (void *) vlib_buffer_get_current (b0) +
331  else
332  h0 = (void *) vlib_buffer_get_current (b0);
333 
334  e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
335  if (e0)
336  {
337  vnet_buffer (b0)->l2_classify.opaque_index
338  = e0->opaque_index;
339  vlib_buffer_advance (b0, e0->advance);
340 
341  next0 = (e0->next_index < ACL_NEXT_INDEX_N_NEXT) ?
342  e0->next_index : next0;
343 
344  hits++;
345 
346  if (is_output)
347  error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
348  L2_OUTACL_ERROR_SESSION_DENY : L2_INACL_ERROR_NONE;
349  else
350  error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
351  L2_OUTACL_ERROR_SESSION_DENY : L2_OUTACL_ERROR_NONE;
352  b0->error = node->errors[error0];
353  }
354  else
355  {
356  while (1)
357  {
358  if (PREDICT_TRUE (t0->next_table_index != ~0))
359  t0 = pool_elt_at_index (vcm->tables,
360  t0->next_table_index);
361  else
362  {
363  next0 =
364  (t0->miss_next_index <
366  next0;
367 
368  misses++;
369 
370  if (is_output)
371  error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
372  L2_OUTACL_ERROR_TABLE_MISS :
373  L2_OUTACL_ERROR_NONE;
374  else
375  error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
376  L2_INACL_ERROR_TABLE_MISS : L2_INACL_ERROR_NONE;
377  b0->error = node->errors[error0];
378  break;
379  }
380 
381  if (t0->current_data_flag ==
383  h0 =
384  (void *) vlib_buffer_get_current (b0) +
386  else
387  h0 = (void *) vlib_buffer_get_current (b0);
388 
389  hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
391  (t0, (u8 *) h0, hash0, now);
392  if (e0)
393  {
394  vlib_buffer_advance (b0, e0->advance);
395  next0 = (e0->next_index < ACL_NEXT_INDEX_N_NEXT) ?
396  e0->next_index : next0;
397  hits++;
398  chain_hits++;
399 
400  if (is_output)
401  error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
402  L2_OUTACL_ERROR_SESSION_DENY :
403  L2_OUTACL_ERROR_NONE;
404  else
405  error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
406  L2_INACL_ERROR_SESSION_DENY :
407  L2_INACL_ERROR_NONE;
408  b0->error = node->errors[error0];
409  break;
410  }
411  }
412  }
413  }
414 
416  && (b0->flags & VLIB_BUFFER_IS_TRACED)))
417  {
419  vlib_add_trace (vm, node, b0, sizeof (*t));
420  t->sw_if_index =
421  vnet_buffer (b0)->sw_if_index[is_output ? VLIB_TX : VLIB_RX];
422  t->next_index = next0;
423  t->table_index = t0 ? t0 - vcm->tables : ~0;
424  t->offset = (t0 && e0) ? vnet_classify_get_offset (t0, e0) : ~0;
425  }
426 
427  /* verify speculative enqueue, maybe switch current next frame */
428  vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
429  to_next, n_left_to_next,
430  bi0, next0);
431  }
432 
433  vlib_put_next_frame (vm, node, next_index, n_left_to_next);
434  }
435 
437  is_output ? L2_OUTACL_ERROR_MISS :
438  L2_INACL_ERROR_MISS, misses);
440  is_output ? L2_OUTACL_ERROR_HIT :
441  L2_INACL_ERROR_HIT, hits);
443  is_output ? L2_OUTACL_ERROR_CHAIN_HIT :
444  L2_INACL_ERROR_CHAIN_HIT, chain_hits);
445  return frame->n_vectors;
446 }
447 
448 static uword
450  vlib_node_runtime_t * node, vlib_frame_t * frame)
451 {
452  return l2_in_out_acl_node_fn (vm, node, frame,
454 }
455 
456 static uword
458  vlib_node_runtime_t * node, vlib_frame_t * frame)
459 {
460  return l2_in_out_acl_node_fn (vm, node, frame,
462 }
463 
464 /* *INDENT-OFF* */
466  .function = l2_inacl_node_fn,
467  .name = "l2-input-acl",
468  .vector_size = sizeof (u32),
469  .format_trace = format_l2_inacl_trace,
470  .type = VLIB_NODE_TYPE_INTERNAL,
471 
472  .n_errors = ARRAY_LEN(l2_inacl_error_strings),
473  .error_strings = l2_inacl_error_strings,
474 
475  .n_next_nodes = ACL_NEXT_INDEX_N_NEXT,
476 
477  /* edit / add dispositions here */
478  .next_nodes = {
479  [ACL_NEXT_INDEX_DENY] = "error-drop",
480  },
481 };
482 
484  .function = l2_outacl_node_fn,
485  .name = "l2-output-acl",
486  .vector_size = sizeof (u32),
487  .format_trace = format_l2_outacl_trace,
488  .type = VLIB_NODE_TYPE_INTERNAL,
489 
490  .n_errors = ARRAY_LEN(l2_outacl_error_strings),
491  .error_strings = l2_outacl_error_strings,
492 
493  .n_next_nodes = ACL_NEXT_INDEX_N_NEXT,
494 
495  /* edit / add dispositions here */
496  .next_nodes = {
497  [ACL_NEXT_INDEX_DENY] = "error-drop",
498  },
499 };
500 
503 /* *INDENT-ON* */
504 
505 
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 
531 /*
532  * fd.io coding-style-patch-verification: ON
533  *
534  * Local Variables:
535  * eval: (c-set-style "gnu")
536  * End:
537  */
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)
#define CLIB_UNUSED(x)
Definition: clib.h:82
char ** l2output_get_feat_names(void)
Definition: l2_output.c:39
vnet_main_t * vnet_get_main(void)
Definition: misc.c:47
#define PREDICT_TRUE(x)
Definition: clib.h:112
unsigned long u64
Definition: types.h:89
static vlib_node_registration_t l2_outacl_node
(constructor) VLIB_REGISTER_NODE (l2_outacl_node)
Definition: l2_in_out_acl.c:86
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:232
#define foreach_l2_inacl_error
Definition: l2_in_out_acl.c:88
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
vnet_main_t * vnet_main
Definition: l2_in_out_acl.c:46
vlib_error_t * errors
Vector of errors for this node.
Definition: node.h:493
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:48
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:163
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:188
l2_in_out_acl_main_t l2_in_out_acl_main
Definition: l2_in_out_acl.c:83
unsigned int u32
Definition: types.h:88
static void vnet_classify_prefetch_bucket(vnet_classify_table_t *t, u64 hash)
static uword l2_inacl_node_fn(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
l2_inacl_error_t
static void vnet_classify_prefetch_entry(vnet_classify_table_t *t, u64 hash)
#define VLIB_NODE_FUNCTION_MULTIARCH(node, fn)
Definition: node.h:223
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:511
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:214
#define PREDICT_FALSE(x)
Definition: clib.h:111
u32 node_index
Node index.
Definition: node.h:518
#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:218
#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:338
vlib_error_t error
Error code for buffers to be enqueued to error handler.
Definition: buffer.h:139
static void vlib_node_increment_counter(vlib_main_t *vm, u32 node_index, u32 counter_index, u64 increment)
Definition: node_funcs.h:1150
static vlib_node_registration_t l2_inacl_node
(constructor) VLIB_REGISTER_NODE (l2_inacl_node)
Definition: l2_in_out_acl.c:85
static uword vnet_classify_get_offset(vnet_classify_table_t *t, vnet_classify_entry_t *v)
#define foreach_l2_outacl_error
Definition: l2_in_out_acl.c:96
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:169
u16 n_vectors
Definition: node.h:420
#define CLIB_PREFETCH(addr, size, type)
Definition: cache.h:79
vlib_main_t * vm
Definition: buffer.c:301
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
#define ARRAY_LEN(x)
Definition: clib.h:62
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:452
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:60
struct _vnet_classify_main vnet_classify_main_t
Definition: vnet_classify.h:67
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:537
static void vlib_buffer_advance(vlib_buffer_t *b, word l)
Advance current data pointer by the supplied (signed!) amount.
Definition: buffer.h:233
static char * l2_inacl_error_strings[]
static void * vlib_add_trace(vlib_main_t *vm, vlib_node_runtime_t *r, vlib_buffer_t *b, u32 n_data_bytes)
Definition: trace_funcs.h:57
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
static uword l2_outacl_node_fn(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
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:244
#define vnet_buffer(b)
Definition: buffer.h:368
u8 data[0]
Packet data.
Definition: buffer.h:176
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:531
acl_next_index_t
Definition: in_out_acl.h:23
#define VLIB_NODE_FLAG_TRACE
Definition: node.h:326
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59
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:117
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:62
vnet_classify_entry_t * vnet_classify_find_entry(vnet_classify_table_t *t, u8 *h, u64 hash, f64 now)
Definition: defs.h:46