2 * l2_in_out_acl.c : layer 2 input/output acl processing
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:
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
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>
27 #include <vnet/l2/l2_input.h>
28 #include <vnet/l2/l2_output.h>
29 #include <vnet/l2/feat_bitmap.h>
31 #include <vppinfra/error.h>
32 #include <vppinfra/hash.h>
33 #include <vppinfra/cache.h>
35 #include <vnet/classify/vnet_classify.h>
36 #include <vnet/classify/in_out_acl.h>
41 /* Next nodes for each feature */
42 u32 feat_next_node_index[IN_OUT_ACL_N_TABLE_GROUPS][32];
44 /* convenience variables */
45 vlib_main_t *vlib_main;
46 vnet_main_t *vnet_main;
47 } l2_in_out_acl_main_t;
55 } l2_in_out_acl_trace_t;
57 /* packet trace format function */
59 format_l2_in_out_acl_trace (u8 * s, u32 is_output, va_list * args)
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 *);
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);
72 format_l2_inacl_trace (u8 * s, va_list * args)
74 return format_l2_in_out_acl_trace (s, IN_OUT_ACL_INPUT_TABLE_GROUP, args);
78 format_l2_outacl_trace (u8 * s, va_list * args)
80 return format_l2_in_out_acl_trace (s, IN_OUT_ACL_OUTPUT_TABLE_GROUP, args);
83 extern l2_in_out_acl_main_t l2_in_out_acl_main;
85 #ifndef CLIB_MARCH_VARIANT
86 l2_in_out_acl_main_t l2_in_out_acl_main;
87 #endif /* CLIB_MARCH_VARIANT */
89 extern vlib_node_registration_t l2_inacl_node;
90 extern vlib_node_registration_t l2_outacl_node;
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")
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")
111 #define _(sym,str) L2_INACL_ERROR_##sym,
112 foreach_l2_inacl_error
117 static char *l2_inacl_error_strings[] = {
118 #define _(sym,string) string,
119 foreach_l2_inacl_error
125 #define _(sym,str) L2_OUTACL_ERROR_##sym,
126 foreach_l2_outacl_error
131 static char *l2_outacl_error_strings[] = {
132 #define _(sym,string) string,
133 foreach_l2_outacl_error
139 l2_in_out_acl_node_fn (vlib_main_t * vm,
140 vlib_node_runtime_t * node, vlib_frame_t * frame,
143 u32 n_left_from, *from, *to_next;
144 acl_next_index_t next_index;
145 l2_in_out_acl_main_t *msm = &l2_in_out_acl_main;
146 in_out_acl_main_t *am = &in_out_acl_main;
147 vnet_classify_main_t *vcm = am->vnet_classify_main;
148 in_out_acl_table_id_t tid = IN_OUT_ACL_TABLE_L2;
149 f64 now = vlib_time_now (vm);
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;
158 /* First pass: compute hashes */
159 while (n_left_from > 2)
161 vlib_buffer_t *b0, *b1;
164 u32 sw_if_index0, sw_if_index1;
165 u32 table_index0, table_index1;
166 vnet_classify_table_t *t0, *t1;
168 /* prefetch next iteration */
170 vlib_buffer_t *p1, *p2;
172 p1 = vlib_get_buffer (vm, from[1]);
173 p2 = vlib_get_buffer (vm, from[2]);
175 vlib_prefetch_buffer_header (p1, STORE);
176 CLIB_PREFETCH (p1->data, CLIB_CACHE_LINE_BYTES, STORE);
177 vlib_prefetch_buffer_header (p2, STORE);
178 CLIB_PREFETCH (p2->data, CLIB_CACHE_LINE_BYTES, STORE);
182 b0 = vlib_get_buffer (vm, bi0);
185 b1 = vlib_get_buffer (vm, bi1);
188 vnet_buffer (b0)->sw_if_index[is_output ? VLIB_TX : VLIB_RX];
190 am->classify_table_index_by_sw_if_index[is_output][tid][sw_if_index0];
193 vnet_buffer (b1)->sw_if_index[is_output ? VLIB_TX : VLIB_RX];
195 am->classify_table_index_by_sw_if_index[is_output][tid][sw_if_index1];
197 t0 = pool_elt_at_index (vcm->tables, table_index0);
199 t1 = pool_elt_at_index (vcm->tables, table_index1);
201 if (t0->current_data_flag == CLASSIFY_FLAG_USE_CURR_DATA)
202 h0 = (void *) vlib_buffer_get_current (b0) + t0->current_data_offset;
204 h0 = (void *) vlib_buffer_get_current (b0);
206 vnet_buffer (b0)->l2_classify.hash =
207 vnet_classify_hash_packet (t0, (u8 *) h0);
209 vnet_classify_prefetch_bucket (t0, vnet_buffer (b0)->l2_classify.hash);
211 if (t1->current_data_flag == CLASSIFY_FLAG_USE_CURR_DATA)
212 h1 = (void *) vlib_buffer_get_current (b1) + t1->current_data_offset;
214 h1 = (void *) vlib_buffer_get_current (b1);
216 vnet_buffer (b1)->l2_classify.hash =
217 vnet_classify_hash_packet (t1, (u8 *) h1);
219 vnet_classify_prefetch_bucket (t1, vnet_buffer (b1)->l2_classify.hash);
221 vnet_buffer (b0)->l2_classify.table_index = table_index0;
223 vnet_buffer (b1)->l2_classify.table_index = table_index1;
229 while (n_left_from > 0)
236 vnet_classify_table_t *t0;
239 b0 = vlib_get_buffer (vm, bi0);
242 vnet_buffer (b0)->sw_if_index[is_output ? VLIB_TX : VLIB_RX];
244 am->classify_table_index_by_sw_if_index[is_output][tid][sw_if_index0];
246 t0 = pool_elt_at_index (vcm->tables, table_index0);
248 if (t0->current_data_flag == CLASSIFY_FLAG_USE_CURR_DATA)
249 h0 = (void *) vlib_buffer_get_current (b0) + t0->current_data_offset;
251 h0 = (void *) vlib_buffer_get_current (b0);
253 vnet_buffer (b0)->l2_classify.hash =
254 vnet_classify_hash_packet (t0, (u8 *) h0);
256 vnet_buffer (b0)->l2_classify.table_index = table_index0;
257 vnet_classify_prefetch_bucket (t0, vnet_buffer (b0)->l2_classify.hash);
263 next_index = node->cached_next_index;
264 from = vlib_frame_vector_args (frame);
265 n_left_from = frame->n_vectors;
267 while (n_left_from > 0)
271 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
273 /* Not enough load/store slots to dual loop... */
274 while (n_left_from > 0 && n_left_to_next > 0)
278 u32 next0 = ACL_NEXT_INDEX_DENY;
280 vnet_classify_table_t *t0;
281 vnet_classify_entry_t *e0;
286 /* Stride 3 seems to work best */
287 if (PREDICT_TRUE (n_left_from > 3))
289 vlib_buffer_t *p1 = vlib_get_buffer (vm, from[3]);
290 vnet_classify_table_t *tp1;
294 table_index1 = vnet_buffer (p1)->l2_classify.table_index;
296 if (PREDICT_TRUE (table_index1 != ~0))
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);
304 /* speculatively enqueue b0 to the current next frame */
312 b0 = vlib_get_buffer (vm, bi0);
314 table_index0 = vnet_buffer (b0)->l2_classify.table_index;
318 vnet_buffer (b0)->l2_classify.opaque_index = ~0;
320 /* Determine the next node */
322 vnet_l2_feature_next (b0, msm->feat_next_node_index[is_output],
323 is_output ? L2OUTPUT_FEAT_ACL :
326 if (PREDICT_TRUE (table_index0 != ~0))
328 hash0 = vnet_buffer (b0)->l2_classify.hash;
329 t0 = pool_elt_at_index (vcm->tables, table_index0);
331 if (t0->current_data_flag == CLASSIFY_FLAG_USE_CURR_DATA)
333 (void *) vlib_buffer_get_current (b0) +
334 t0->current_data_offset;
336 h0 = (void *) vlib_buffer_get_current (b0);
338 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
341 vnet_buffer (b0)->l2_classify.opaque_index
343 vlib_buffer_advance (b0, e0->advance);
345 next0 = (e0->next_index < ACL_NEXT_INDEX_N_NEXT) ?
346 e0->next_index : next0;
351 error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
352 L2_OUTACL_ERROR_SESSION_DENY : L2_INACL_ERROR_NONE;
354 error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
355 L2_OUTACL_ERROR_SESSION_DENY : L2_OUTACL_ERROR_NONE;
356 b0->error = node->errors[error0];
362 if (PREDICT_TRUE (t0->next_table_index != ~0))
363 t0 = pool_elt_at_index (vcm->tables,
364 t0->next_table_index);
368 (t0->miss_next_index <
369 ACL_NEXT_INDEX_N_NEXT) ? t0->miss_next_index :
375 error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
376 L2_OUTACL_ERROR_TABLE_MISS :
377 L2_OUTACL_ERROR_NONE;
379 error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
380 L2_INACL_ERROR_TABLE_MISS : L2_INACL_ERROR_NONE;
381 b0->error = node->errors[error0];
385 if (t0->current_data_flag ==
386 CLASSIFY_FLAG_USE_CURR_DATA)
388 (void *) vlib_buffer_get_current (b0) +
389 t0->current_data_offset;
391 h0 = (void *) vlib_buffer_get_current (b0);
393 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
394 e0 = vnet_classify_find_entry
395 (t0, (u8 *) h0, hash0, now);
398 vlib_buffer_advance (b0, e0->advance);
399 next0 = (e0->next_index < ACL_NEXT_INDEX_N_NEXT) ?
400 e0->next_index : next0;
405 error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
406 L2_OUTACL_ERROR_SESSION_DENY :
407 L2_OUTACL_ERROR_NONE;
409 error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
410 L2_INACL_ERROR_SESSION_DENY :
412 b0->error = node->errors[error0];
419 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
420 && (b0->flags & VLIB_BUFFER_IS_TRACED)))
422 l2_in_out_acl_trace_t *t =
423 vlib_add_trace (vm, node, b0, sizeof (*t));
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;
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,
437 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
440 vlib_node_increment_counter (vm, node->node_index,
441 is_output ? L2_OUTACL_ERROR_MISS :
442 L2_INACL_ERROR_MISS, misses);
443 vlib_node_increment_counter (vm, node->node_index,
444 is_output ? L2_OUTACL_ERROR_HIT :
445 L2_INACL_ERROR_HIT, hits);
446 vlib_node_increment_counter (vm, node->node_index,
447 is_output ? L2_OUTACL_ERROR_CHAIN_HIT :
448 L2_INACL_ERROR_CHAIN_HIT, chain_hits);
449 return frame->n_vectors;
452 VLIB_NODE_FN (l2_inacl_node) (vlib_main_t * vm,
453 vlib_node_runtime_t * node,
454 vlib_frame_t * frame)
456 return l2_in_out_acl_node_fn (vm, node, frame,
457 IN_OUT_ACL_INPUT_TABLE_GROUP);
460 VLIB_NODE_FN (l2_outacl_node) (vlib_main_t * vm,
461 vlib_node_runtime_t * node,
462 vlib_frame_t * frame)
464 return l2_in_out_acl_node_fn (vm, node, frame,
465 IN_OUT_ACL_OUTPUT_TABLE_GROUP);
469 VLIB_REGISTER_NODE (l2_inacl_node) = {
470 .name = "l2-input-acl",
471 .vector_size = sizeof (u32),
472 .format_trace = format_l2_inacl_trace,
473 .type = VLIB_NODE_TYPE_INTERNAL,
475 .n_errors = ARRAY_LEN(l2_inacl_error_strings),
476 .error_strings = l2_inacl_error_strings,
478 .n_next_nodes = ACL_NEXT_INDEX_N_NEXT,
480 /* edit / add dispositions here */
482 [ACL_NEXT_INDEX_DENY] = "error-drop",
486 VLIB_REGISTER_NODE (l2_outacl_node) = {
487 .name = "l2-output-acl",
488 .vector_size = sizeof (u32),
489 .format_trace = format_l2_outacl_trace,
490 .type = VLIB_NODE_TYPE_INTERNAL,
492 .n_errors = ARRAY_LEN(l2_outacl_error_strings),
493 .error_strings = l2_outacl_error_strings,
495 .n_next_nodes = ACL_NEXT_INDEX_N_NEXT,
497 /* edit / add dispositions here */
499 [ACL_NEXT_INDEX_DENY] = "error-drop",
505 #ifndef CLIB_MARCH_VARIANT
507 l2_in_out_acl_init (vlib_main_t * vm)
509 l2_in_out_acl_main_t *mp = &l2_in_out_acl_main;
512 mp->vnet_main = vnet_get_main ();
514 /* Initialize the feature next-node indexes */
515 feat_bitmap_init_next_nodes (vm,
518 l2input_get_feat_names (),
519 mp->feat_next_node_index
520 [IN_OUT_ACL_INPUT_TABLE_GROUP]);
521 feat_bitmap_init_next_nodes (vm, l2_outacl_node.index, L2OUTPUT_N_FEAT,
522 l2output_get_feat_names (),
523 mp->feat_next_node_index
524 [IN_OUT_ACL_OUTPUT_TABLE_GROUP]);
529 VLIB_INIT_FUNCTION (l2_in_out_acl_init);
530 #endif /* CLIB_MARCH_VARIANT */
533 * fd.io coding-style-patch-verification: ON
536 * eval: (c-set-style "gnu")