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 l2_in_out_acl_main_t l2_in_out_acl_main;
85 static vlib_node_registration_t l2_inacl_node;
86 static vlib_node_registration_t l2_outacl_node;
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")
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")
107 #define _(sym,str) L2_INACL_ERROR_##sym,
108 foreach_l2_inacl_error
113 static char *l2_inacl_error_strings[] = {
114 #define _(sym,string) string,
115 foreach_l2_inacl_error
121 #define _(sym,str) L2_OUTACL_ERROR_##sym,
122 foreach_l2_outacl_error
127 static char *l2_outacl_error_strings[] = {
128 #define _(sym,string) string,
129 foreach_l2_outacl_error
135 l2_in_out_acl_node_fn (vlib_main_t * vm,
136 vlib_node_runtime_t * node, vlib_frame_t * frame,
139 u32 n_left_from, *from, *to_next;
140 acl_next_index_t next_index;
141 l2_in_out_acl_main_t *msm = &l2_in_out_acl_main;
142 in_out_acl_main_t *am = &in_out_acl_main;
143 vnet_classify_main_t *vcm = am->vnet_classify_main;
144 in_out_acl_table_id_t tid = IN_OUT_ACL_TABLE_L2;
145 f64 now = vlib_time_now (vm);
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;
154 /* First pass: compute hashes */
155 while (n_left_from > 2)
157 vlib_buffer_t *b0, *b1;
160 u32 sw_if_index0, sw_if_index1;
161 u32 table_index0, table_index1;
162 vnet_classify_table_t *t0, *t1;
164 /* prefetch next iteration */
166 vlib_buffer_t *p1, *p2;
168 p1 = vlib_get_buffer (vm, from[1]);
169 p2 = vlib_get_buffer (vm, from[2]);
171 vlib_prefetch_buffer_header (p1, STORE);
172 CLIB_PREFETCH (p1->data, CLIB_CACHE_LINE_BYTES, STORE);
173 vlib_prefetch_buffer_header (p2, STORE);
174 CLIB_PREFETCH (p2->data, CLIB_CACHE_LINE_BYTES, STORE);
178 b0 = vlib_get_buffer (vm, bi0);
181 b1 = vlib_get_buffer (vm, bi1);
184 vnet_buffer (b0)->sw_if_index[is_output ? VLIB_TX : VLIB_RX];
186 am->classify_table_index_by_sw_if_index[is_output][tid][sw_if_index0];
189 vnet_buffer (b1)->sw_if_index[is_output ? VLIB_TX : VLIB_RX];
191 am->classify_table_index_by_sw_if_index[is_output][tid][sw_if_index1];
193 t0 = pool_elt_at_index (vcm->tables, table_index0);
195 t1 = pool_elt_at_index (vcm->tables, table_index1);
197 if (t0->current_data_flag == CLASSIFY_FLAG_USE_CURR_DATA)
198 h0 = (void *) vlib_buffer_get_current (b0) + t0->current_data_offset;
200 h0 = (void *) vlib_buffer_get_current (b0);
202 vnet_buffer (b0)->l2_classify.hash =
203 vnet_classify_hash_packet (t0, (u8 *) h0);
205 vnet_classify_prefetch_bucket (t0, vnet_buffer (b0)->l2_classify.hash);
207 if (t1->current_data_flag == CLASSIFY_FLAG_USE_CURR_DATA)
208 h1 = (void *) vlib_buffer_get_current (b1) + t1->current_data_offset;
210 h1 = (void *) vlib_buffer_get_current (b1);
212 vnet_buffer (b1)->l2_classify.hash =
213 vnet_classify_hash_packet (t1, (u8 *) h1);
215 vnet_classify_prefetch_bucket (t1, vnet_buffer (b1)->l2_classify.hash);
217 vnet_buffer (b0)->l2_classify.table_index = table_index0;
219 vnet_buffer (b1)->l2_classify.table_index = table_index1;
225 while (n_left_from > 0)
232 vnet_classify_table_t *t0;
235 b0 = vlib_get_buffer (vm, bi0);
238 vnet_buffer (b0)->sw_if_index[is_output ? VLIB_TX : VLIB_RX];
240 am->classify_table_index_by_sw_if_index[is_output][tid][sw_if_index0];
242 t0 = pool_elt_at_index (vcm->tables, table_index0);
244 if (t0->current_data_flag == CLASSIFY_FLAG_USE_CURR_DATA)
245 h0 = (void *) vlib_buffer_get_current (b0) + t0->current_data_offset;
247 h0 = (void *) vlib_buffer_get_current (b0);
249 vnet_buffer (b0)->l2_classify.hash =
250 vnet_classify_hash_packet (t0, (u8 *) h0);
252 vnet_buffer (b0)->l2_classify.table_index = table_index0;
253 vnet_classify_prefetch_bucket (t0, vnet_buffer (b0)->l2_classify.hash);
259 next_index = node->cached_next_index;
260 from = vlib_frame_vector_args (frame);
261 n_left_from = frame->n_vectors;
263 while (n_left_from > 0)
267 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
269 /* Not enough load/store slots to dual loop... */
270 while (n_left_from > 0 && n_left_to_next > 0)
274 u32 next0 = ACL_NEXT_INDEX_DENY;
276 vnet_classify_table_t *t0;
277 vnet_classify_entry_t *e0;
282 /* Stride 3 seems to work best */
283 if (PREDICT_TRUE (n_left_from > 3))
285 vlib_buffer_t *p1 = vlib_get_buffer (vm, from[3]);
286 vnet_classify_table_t *tp1;
290 table_index1 = vnet_buffer (p1)->l2_classify.table_index;
292 if (PREDICT_TRUE (table_index1 != ~0))
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);
300 /* speculatively enqueue b0 to the current next frame */
308 b0 = vlib_get_buffer (vm, bi0);
310 table_index0 = vnet_buffer (b0)->l2_classify.table_index;
314 vnet_buffer (b0)->l2_classify.opaque_index = ~0;
316 /* Determine the next node */
318 vnet_l2_feature_next (b0, msm->feat_next_node_index[is_output],
319 is_output ? L2OUTPUT_FEAT_ACL :
322 if (PREDICT_TRUE (table_index0 != ~0))
324 hash0 = vnet_buffer (b0)->l2_classify.hash;
325 t0 = pool_elt_at_index (vcm->tables, table_index0);
327 if (t0->current_data_flag == CLASSIFY_FLAG_USE_CURR_DATA)
329 (void *) vlib_buffer_get_current (b0) +
330 t0->current_data_offset;
332 h0 = (void *) vlib_buffer_get_current (b0);
334 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
337 vnet_buffer (b0)->l2_classify.opaque_index
339 vlib_buffer_advance (b0, e0->advance);
341 next0 = (e0->next_index < ACL_NEXT_INDEX_N_NEXT) ?
342 e0->next_index : next0;
347 error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
348 L2_OUTACL_ERROR_SESSION_DENY : L2_INACL_ERROR_NONE;
350 error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
351 L2_OUTACL_ERROR_SESSION_DENY : L2_OUTACL_ERROR_NONE;
352 b0->error = node->errors[error0];
358 if (PREDICT_TRUE (t0->next_table_index != ~0))
359 t0 = pool_elt_at_index (vcm->tables,
360 t0->next_table_index);
364 (t0->miss_next_index <
365 ACL_NEXT_INDEX_N_NEXT) ? t0->miss_next_index :
371 error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
372 L2_OUTACL_ERROR_TABLE_MISS :
373 L2_OUTACL_ERROR_NONE;
375 error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
376 L2_INACL_ERROR_TABLE_MISS : L2_INACL_ERROR_NONE;
377 b0->error = node->errors[error0];
381 if (t0->current_data_flag ==
382 CLASSIFY_FLAG_USE_CURR_DATA)
384 (void *) vlib_buffer_get_current (b0) +
385 t0->current_data_offset;
387 h0 = (void *) vlib_buffer_get_current (b0);
389 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
390 e0 = vnet_classify_find_entry
391 (t0, (u8 *) h0, hash0, now);
394 vlib_buffer_advance (b0, e0->advance);
395 next0 = (e0->next_index < ACL_NEXT_INDEX_N_NEXT) ?
396 e0->next_index : next0;
401 error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
402 L2_OUTACL_ERROR_SESSION_DENY :
403 L2_OUTACL_ERROR_NONE;
405 error0 = (next0 == ACL_NEXT_INDEX_DENY) ?
406 L2_INACL_ERROR_SESSION_DENY :
408 b0->error = node->errors[error0];
415 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
416 && (b0->flags & VLIB_BUFFER_IS_TRACED)))
418 l2_in_out_acl_trace_t *t =
419 vlib_add_trace (vm, node, b0, sizeof (*t));
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;
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,
433 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
436 vlib_node_increment_counter (vm, node->node_index,
437 is_output ? L2_OUTACL_ERROR_MISS :
438 L2_INACL_ERROR_MISS, misses);
439 vlib_node_increment_counter (vm, node->node_index,
440 is_output ? L2_OUTACL_ERROR_HIT :
441 L2_INACL_ERROR_HIT, hits);
442 vlib_node_increment_counter (vm, node->node_index,
443 is_output ? L2_OUTACL_ERROR_CHAIN_HIT :
444 L2_INACL_ERROR_CHAIN_HIT, chain_hits);
445 return frame->n_vectors;
449 l2_inacl_node_fn (vlib_main_t * vm,
450 vlib_node_runtime_t * node, vlib_frame_t * frame)
452 return l2_in_out_acl_node_fn (vm, node, frame,
453 IN_OUT_ACL_INPUT_TABLE_GROUP);
457 l2_outacl_node_fn (vlib_main_t * vm,
458 vlib_node_runtime_t * node, vlib_frame_t * frame)
460 return l2_in_out_acl_node_fn (vm, node, frame,
461 IN_OUT_ACL_OUTPUT_TABLE_GROUP);
465 VLIB_REGISTER_NODE (l2_inacl_node,static) = {
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,
472 .n_errors = ARRAY_LEN(l2_inacl_error_strings),
473 .error_strings = l2_inacl_error_strings,
475 .n_next_nodes = ACL_NEXT_INDEX_N_NEXT,
477 /* edit / add dispositions here */
479 [ACL_NEXT_INDEX_DENY] = "error-drop",
483 VLIB_REGISTER_NODE (l2_outacl_node,static) = {
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,
490 .n_errors = ARRAY_LEN(l2_outacl_error_strings),
491 .error_strings = l2_outacl_error_strings,
493 .n_next_nodes = ACL_NEXT_INDEX_N_NEXT,
495 /* edit / add dispositions here */
497 [ACL_NEXT_INDEX_DENY] = "error-drop",
501 VLIB_NODE_FUNCTION_MULTIARCH (l2_inacl_node, l2_inacl_node_fn)
502 VLIB_NODE_FUNCTION_MULTIARCH (l2_outacl_node, l2_outacl_node_fn)
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);
532 * fd.io coding-style-patch-verification: ON
535 * eval: (c-set-style "gnu")