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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include <vnet/l2/l2_classify.h>
20 #include <vnet/api_errno.h>
24 * @brief L2 input classifier.
26 * @sa @ref vnet/vnet/classify/vnet_classify.c
27 * @sa @ref vnet/vnet/classify/vnet_classify.h
31 * @brief l2_input_classifier packet trace record.
35 /** interface handle for the ith packet */
37 /** graph arc index selected for this packet */
39 /** classifier table which provided the final result */
41 /** offset in classifier heap of the corresponding session */
43 } l2_input_classify_trace_t;
46 * @brief vlib node runtime.
50 /** use-case independent main object pointer */
51 vnet_classify_main_t *vcm;
52 /** l2 input classifier main object pointer */
53 l2_input_classify_main_t *l2cm;
54 } l2_input_classify_runtime_t;
56 /** Packet trace format function. */
58 format_l2_input_classify_trace (u8 * s, va_list * args)
60 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
61 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
62 l2_input_classify_trace_t *t = va_arg (*args, l2_input_classify_trace_t *);
64 s = format (s, "l2-classify: sw_if_index %d, table %d, offset %x, next %d",
65 t->sw_if_index, t->table_index, t->session_offset,
70 /** l2 input classifier main data structure. */
71 l2_input_classify_main_t l2_input_classify_main;
73 vlib_node_registration_t l2_input_classify_node;
75 #define foreach_l2_input_classify_error \
76 _(MISS, "Classify misses") \
77 _(HIT, "Classify hits") \
78 _(CHAIN_HIT, "Classify hits after chain walk") \
79 _(DROP, "L2 Classify Drops")
83 #define _(sym,str) L2_INPUT_CLASSIFY_ERROR_##sym,
84 foreach_l2_input_classify_error
86 L2_INPUT_CLASSIFY_N_ERROR,
87 } l2_input_classify_error_t;
89 static char *l2_input_classify_error_strings[] = {
90 #define _(sym,string) string,
91 foreach_l2_input_classify_error
96 * @brief l2 input classifier node.
97 * @node l2-input-classify
99 * This is the l2 input classifier dispatch node
101 * @param vm vlib_main_t corresponding to the current thread.
102 * @param node vlib_node_runtime_t data for this node.
103 * @param frame vlib_frame_t whose contents should be dispatched.
105 * @par Graph mechanics: buffer metadata, next index usage
108 * - <code>(l2_input_classify_runtime_t *)
109 * rt->classify_table_index_by_sw_if_index</code>
110 * - Head of the per-interface, per-protocol classifier table chain
111 * for a specific interface.
112 * - @c ~0 => send pkts to the next feature in the L2 feature chain.
113 * - <code>vnet_buffer(b)->sw_if_index[VLIB_RX]</code>
114 * - Indicates the @c sw_if_index value of the interface that the
115 * packet was received on.
116 * - <code>vnet_buffer(b0)->l2.feature_bitmap</code>
117 * - Used to steer packets across l2 features enabled on the interface
118 * - <code>(vnet_classify_entry_t) e0->next_index</code>
119 * - Used to steer traffic when the classifier hits on a session
120 * - <code>(vnet_classify_entry_t) e0->advance</code>
121 * - Signed quantity applied via <code>vlib_buffer_advance</code>
122 * when the classifier hits on a session
123 * - <code>(vnet_classify_table_t) t0->miss_next_index</code>
124 * - Used to steer traffic when the classifier misses
127 * - <code>vnet_buffer (b0)->l2_classify.table_index</code>
128 * - Classifier table index of the first classifier table in
129 * the classifier table chain
130 * - <code>vnet_buffer (b0)->l2_classify.hash</code>
131 * - Bounded-index extensible hash corresponding to the
132 * masked fields in the current packet
133 * - <code>vnet_buffer (b0)->l2.feature_bitmap</code>
134 * - Used to steer packets across l2 features enabled on the interface
135 * - <code>vnet_buffer (b0)->l2_classify.opaque_index</code>
136 * - Copied from the classifier session object upon classifier hit
139 * - <code>L2_INPUT_CLASSIFY_ERROR_MISS</code> Classifier misses
140 * - <code>L2_INPUT_CLASSIFY_ERROR_HIT</code> Classifier hits
141 * - <code>L2_INPUT_CLASSIFY_ERROR_CHAIN_HIT</code>
142 * Classifier hits in other than the first table
146 l2_input_classify_node_fn (vlib_main_t * vm,
147 vlib_node_runtime_t * node, vlib_frame_t * frame)
149 u32 n_left_from, *from, *to_next;
150 l2_input_classify_next_t next_index;
151 l2_input_classify_main_t *cm = &l2_input_classify_main;
152 vnet_classify_main_t *vcm = cm->vnet_classify_main;
153 l2_input_classify_runtime_t *rt =
154 (l2_input_classify_runtime_t *) node->runtime_data;
162 n_next_nodes = node->n_next_nodes;
164 now = vlib_time_now (vm);
166 n_left_from = frame->n_vectors;
167 from = vlib_frame_vector_args (frame);
169 /* First pass: compute hash */
171 while (n_left_from > 2)
173 vlib_buffer_t *b0, *b1;
175 ethernet_header_t *h0, *h1;
176 u32 sw_if_index0, sw_if_index1;
178 int type_index0, type_index1;
179 vnet_classify_table_t *t0, *t1;
180 u32 table_index0, table_index1;
184 /* prefetch next iteration */
186 vlib_buffer_t *p1, *p2;
188 p1 = vlib_get_buffer (vm, from[1]);
189 p2 = vlib_get_buffer (vm, from[2]);
191 vlib_prefetch_buffer_header (p1, STORE);
192 CLIB_PREFETCH (p1->data, CLIB_CACHE_LINE_BYTES, STORE);
193 vlib_prefetch_buffer_header (p2, STORE);
194 CLIB_PREFETCH (p2->data, CLIB_CACHE_LINE_BYTES, STORE);
198 b0 = vlib_get_buffer (vm, bi0);
199 h0 = vlib_buffer_get_current (b0);
202 b1 = vlib_get_buffer (vm, bi1);
203 h1 = vlib_buffer_get_current (b1);
205 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
206 vnet_buffer (b0)->l2_classify.table_index = ~0;
208 sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
209 vnet_buffer (b1)->l2_classify.table_index = ~0;
211 /* Select classifier table based on ethertype */
212 type0 = clib_net_to_host_u16 (h0->type);
213 type1 = clib_net_to_host_u16 (h1->type);
215 type_index0 = (type0 == ETHERNET_TYPE_IP4)
216 ? L2_INPUT_CLASSIFY_TABLE_IP4 : L2_INPUT_CLASSIFY_TABLE_OTHER;
217 type_index0 = (type0 == ETHERNET_TYPE_IP6)
218 ? L2_INPUT_CLASSIFY_TABLE_IP6 : type_index0;
220 type_index1 = (type1 == ETHERNET_TYPE_IP4)
221 ? L2_INPUT_CLASSIFY_TABLE_IP4 : L2_INPUT_CLASSIFY_TABLE_OTHER;
222 type_index1 = (type1 == ETHERNET_TYPE_IP6)
223 ? L2_INPUT_CLASSIFY_TABLE_IP6 : type_index1;
225 vnet_buffer (b0)->l2_classify.table_index =
227 rt->l2cm->classify_table_index_by_sw_if_index
228 [type_index0][sw_if_index0];
230 if (table_index0 != ~0)
232 t0 = pool_elt_at_index (vcm->tables, table_index0);
234 vnet_buffer (b0)->l2_classify.hash = hash0 =
235 vnet_classify_hash_packet (t0, (u8 *) h0);
236 vnet_classify_prefetch_bucket (t0, hash0);
239 vnet_buffer (b1)->l2_classify.table_index =
241 rt->l2cm->classify_table_index_by_sw_if_index
242 [type_index1][sw_if_index1];
244 if (table_index1 != ~0)
246 t1 = pool_elt_at_index (vcm->tables, table_index1);
248 vnet_buffer (b1)->l2_classify.hash = hash1 =
249 vnet_classify_hash_packet (t1, (u8 *) h1);
250 vnet_classify_prefetch_bucket (t1, hash1);
257 while (n_left_from > 0)
261 ethernet_header_t *h0;
265 vnet_classify_table_t *t0;
270 b0 = vlib_get_buffer (vm, bi0);
271 h0 = vlib_buffer_get_current (b0);
273 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
274 vnet_buffer (b0)->l2_classify.table_index = ~0;
276 /* Select classifier table based on ethertype */
277 type0 = clib_net_to_host_u16 (h0->type);
279 type_index0 = (type0 == ETHERNET_TYPE_IP4)
280 ? L2_INPUT_CLASSIFY_TABLE_IP4 : L2_INPUT_CLASSIFY_TABLE_OTHER;
281 type_index0 = (type0 == ETHERNET_TYPE_IP6)
282 ? L2_INPUT_CLASSIFY_TABLE_IP6 : type_index0;
284 vnet_buffer (b0)->l2_classify.table_index =
285 table_index0 = rt->l2cm->classify_table_index_by_sw_if_index
286 [type_index0][sw_if_index0];
288 if (table_index0 != ~0)
290 t0 = pool_elt_at_index (vcm->tables, table_index0);
292 vnet_buffer (b0)->l2_classify.hash = hash0 =
293 vnet_classify_hash_packet (t0, (u8 *) h0);
294 vnet_classify_prefetch_bucket (t0, hash0);
300 next_index = node->cached_next_index;
301 from = vlib_frame_vector_args (frame);
302 n_left_from = frame->n_vectors;
304 while (n_left_from > 0)
308 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
310 /* Not enough load/store slots to dual loop... */
311 while (n_left_from > 0 && n_left_to_next > 0)
315 u32 next0 = ~0; /* next l2 input feature, please... */
316 ethernet_header_t *h0;
319 vnet_classify_table_t *t0;
320 vnet_classify_entry_t *e0;
322 if (PREDICT_TRUE (n_left_from > 2))
324 vlib_buffer_t *p2 = vlib_get_buffer (vm, from[2]);
327 vnet_classify_table_t *tp2;
330 * Prefetch table entry two ahead. Buffer / data
331 * were prefetched above...
333 table_index2 = vnet_buffer (p2)->l2_classify.table_index;
335 if (PREDICT_TRUE (table_index2 != ~0))
337 tp2 = pool_elt_at_index (vcm->tables, table_index2);
338 phash2 = vnet_buffer (p2)->l2_classify.hash;
339 vnet_classify_prefetch_entry (tp2, phash2);
343 /* speculatively enqueue b0 to the current next frame */
351 b0 = vlib_get_buffer (vm, bi0);
352 h0 = vlib_buffer_get_current (b0);
353 table_index0 = vnet_buffer (b0)->l2_classify.table_index;
355 vnet_buffer (b0)->l2_classify.opaque_index = ~0;
357 /* Remove ourself from the feature bitmap */
358 feature_bitmap = vnet_buffer (b0)->l2.feature_bitmap
359 & ~L2INPUT_FEAT_INPUT_CLASSIFY;
361 /* save for next feature graph nodes */
362 vnet_buffer (b0)->l2.feature_bitmap = feature_bitmap;
364 if (PREDICT_TRUE (table_index0 != ~0))
366 hash0 = vnet_buffer (b0)->l2_classify.hash;
367 t0 = pool_elt_at_index (vcm->tables, table_index0);
369 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
372 vnet_buffer (b0)->l2_classify.opaque_index
374 vlib_buffer_advance (b0, e0->advance);
375 next0 = (e0->next_index < n_next_nodes) ?
376 e0->next_index : next0;
383 if (t0->next_table_index != ~0)
384 t0 = pool_elt_at_index (vcm->tables,
385 t0->next_table_index);
388 next0 = (t0->miss_next_index < n_next_nodes) ?
389 t0->miss_next_index : next0;
394 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
396 vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
399 vnet_buffer (b0)->l2_classify.opaque_index
401 vlib_buffer_advance (b0, e0->advance);
402 next0 = (e0->next_index < n_next_nodes) ?
403 e0->next_index : next0;
412 if (PREDICT_FALSE (next0 == 0))
413 b0->error = node->errors[L2_INPUT_CLASSIFY_ERROR_DROP];
415 if (PREDICT_TRUE (next0 == ~0))
417 // Determine the next node
419 feat_bitmap_get_next_node_index (cm->feat_next_node_index,
423 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
424 && (b0->flags & VLIB_BUFFER_IS_TRACED)))
426 l2_input_classify_trace_t *t =
427 vlib_add_trace (vm, node, b0, sizeof (*t));
428 t->sw_if_index = vnet_buffer (b0)->sw_if_index[VLIB_RX];
429 t->table_index = table_index0;
430 t->next_index = next0;
431 t->session_offset = e0 ? vnet_classify_get_offset (t0, e0) : 0;
434 /* verify speculative enqueue, maybe switch current next frame */
435 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
436 to_next, n_left_to_next,
440 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
443 vlib_node_increment_counter (vm, node->node_index,
444 L2_INPUT_CLASSIFY_ERROR_MISS, misses);
445 vlib_node_increment_counter (vm, node->node_index,
446 L2_INPUT_CLASSIFY_ERROR_HIT, hits);
447 vlib_node_increment_counter (vm, node->node_index,
448 L2_INPUT_CLASSIFY_ERROR_CHAIN_HIT, chain_hits);
449 return frame->n_vectors;
453 VLIB_REGISTER_NODE (l2_input_classify_node) = {
454 .function = l2_input_classify_node_fn,
455 .name = "l2-input-classify",
456 .vector_size = sizeof (u32),
457 .format_trace = format_l2_input_classify_trace,
458 .type = VLIB_NODE_TYPE_INTERNAL,
460 .n_errors = ARRAY_LEN(l2_input_classify_error_strings),
461 .error_strings = l2_input_classify_error_strings,
463 .runtime_data_bytes = sizeof (l2_input_classify_runtime_t),
465 .n_next_nodes = L2_INPUT_CLASSIFY_N_NEXT,
467 /* edit / add dispositions here */
469 [L2_INPUT_CLASSIFY_NEXT_DROP] = "error-drop",
470 [L2_INPUT_CLASSIFY_NEXT_ETHERNET_INPUT] = "ethernet-input-not-l2",
471 [L2_INPUT_CLASSIFY_NEXT_IP4_INPUT] = "ip4-input",
472 [L2_INPUT_CLASSIFY_NEXT_IP6_INPUT] = "ip6-input",
473 [L2_INPUT_CLASSIFY_NEXT_LI] = "li-hit",
478 VLIB_NODE_FUNCTION_MULTIARCH (l2_input_classify_node,
479 l2_input_classify_node_fn);
481 /** l2 input classsifier feature initialization. */
483 l2_input_classify_init (vlib_main_t * vm)
485 l2_input_classify_main_t *cm = &l2_input_classify_main;
486 l2_input_classify_runtime_t *rt;
488 rt = vlib_node_get_runtime_data (vm, l2_input_classify_node.index);
491 cm->vnet_main = vnet_get_main ();
492 cm->vnet_classify_main = &vnet_classify_main;
494 /* Initialize the feature next-node indexes */
495 feat_bitmap_init_next_nodes (vm,
496 l2_input_classify_node.index,
498 l2input_get_feat_names (),
499 cm->feat_next_node_index);
501 rt->vcm = cm->vnet_classify_main;
506 VLIB_INIT_FUNCTION (l2_input_classify_init);
509 l2_input_classify_worker_init (vlib_main_t * vm)
511 l2_input_classify_main_t *cm = &l2_input_classify_main;
512 l2_input_classify_runtime_t *rt;
514 rt = vlib_node_get_runtime_data (vm, l2_input_classify_node.index);
517 rt->vcm = cm->vnet_classify_main;
522 VLIB_WORKER_INIT_FUNCTION (l2_input_classify_worker_init);
524 /** Enable/disable l2 input classification on a specific interface. */
526 vnet_l2_input_classify_enable_disable (u32 sw_if_index, int enable_disable)
528 l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_INPUT_CLASSIFY,
529 (u32) enable_disable);
532 /** @brief Set l2 per-protocol, per-interface input classification tables.
534 * @param sw_if_index interface handle
535 * @param ip4_table_index ip4 classification table index, or ~0
536 * @param ip6_table_index ip6 classification table index, or ~0
537 * @param other_table_index non-ip4, non-ip6 classification table index,
539 * @returns 0 on success, VNET_API_ERROR_NO_SUCH_TABLE, TABLE2, TABLE3
540 * if the indicated (non-~0) table does not exist.
544 vnet_l2_input_classify_set_tables (u32 sw_if_index,
546 u32 ip6_table_index, u32 other_table_index)
548 l2_input_classify_main_t *cm = &l2_input_classify_main;
549 vnet_classify_main_t *vcm = cm->vnet_classify_main;
551 /* Assume that we've validated sw_if_index in the API layer */
553 if (ip4_table_index != ~0 &&
554 pool_is_free_index (vcm->tables, ip4_table_index))
555 return VNET_API_ERROR_NO_SUCH_TABLE;
557 if (ip6_table_index != ~0 &&
558 pool_is_free_index (vcm->tables, ip6_table_index))
559 return VNET_API_ERROR_NO_SUCH_TABLE2;
561 if (other_table_index != ~0 &&
562 pool_is_free_index (vcm->tables, other_table_index))
563 return VNET_API_ERROR_NO_SUCH_TABLE3;
566 (cm->classify_table_index_by_sw_if_index[L2_INPUT_CLASSIFY_TABLE_IP4],
570 (cm->classify_table_index_by_sw_if_index[L2_INPUT_CLASSIFY_TABLE_IP6],
574 (cm->classify_table_index_by_sw_if_index[L2_INPUT_CLASSIFY_TABLE_OTHER],
577 cm->classify_table_index_by_sw_if_index[L2_INPUT_CLASSIFY_TABLE_IP4]
578 [sw_if_index] = ip4_table_index;
580 cm->classify_table_index_by_sw_if_index[L2_INPUT_CLASSIFY_TABLE_IP6]
581 [sw_if_index] = ip6_table_index;
583 cm->classify_table_index_by_sw_if_index[L2_INPUT_CLASSIFY_TABLE_OTHER]
584 [sw_if_index] = other_table_index;
589 static clib_error_t *
590 int_l2_input_classify_command_fn (vlib_main_t * vm,
591 unformat_input_t * input,
592 vlib_cli_command_t * cmd)
594 vnet_main_t *vnm = vnet_get_main ();
595 u32 sw_if_index = ~0;
596 u32 ip4_table_index = ~0;
597 u32 ip6_table_index = ~0;
598 u32 other_table_index = ~0;
601 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
603 if (unformat (input, "intfc %U", unformat_vnet_sw_interface,
606 else if (unformat (input, "ip4-table %d", &ip4_table_index))
608 else if (unformat (input, "ip6-table %d", &ip6_table_index))
610 else if (unformat (input, "other-table %d", &other_table_index))
616 if (sw_if_index == ~0)
617 return clib_error_return (0, "interface must be specified");
620 if (ip4_table_index == ~0 && ip6_table_index == ~0
621 && other_table_index == ~0)
623 vlib_cli_output (vm, "L2 classification disabled");
624 vnet_l2_input_classify_enable_disable (sw_if_index, 0 /* enable */ );
628 rv = vnet_l2_input_classify_set_tables (sw_if_index, ip4_table_index,
629 ip6_table_index, other_table_index);
633 vnet_l2_input_classify_enable_disable (sw_if_index, 1 /* enable */ );
637 return clib_error_return (0, "vnet_l2_input_classify_set_tables: %d",
646 * Configure l2 input classification.
649 * @cliexstart{set interface l2 input classify intfc <interface-name> [ip4-table <index>] [ip6-table <index>] [other-table <index>]}
651 * @todo This is incomplete. This needs a detailed description and a
655 VLIB_CLI_COMMAND (int_l2_input_classify_cli, static) = {
656 .path = "set interface l2 input classify",
658 "set interface l2 input classify intfc <interface-name> [ip4-table <n>]\n"
659 " [ip6-table <n>] [other-table <n>]",
660 .function = int_l2_input_classify_command_fn,
665 * fd.io coding-style-patch-verification: ON
668 * eval: (c-set-style "gnu")