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 extern l2_input_classify_main_t l2_input_classify_main;
72 #ifndef CLIB_MARCH_VARIANT
73 /** l2 input classifier main data structure. */
74 l2_input_classify_main_t l2_input_classify_main;
75 #endif /* CLIB_MARCH_VARIANT */
77 #define foreach_l2_input_classify_error \
78 _(MISS, "Classify misses") \
79 _(HIT, "Classify hits") \
80 _(CHAIN_HIT, "Classify hits after chain walk") \
81 _(DROP, "L2 Classify Drops")
85 #define _(sym,str) L2_INPUT_CLASSIFY_ERROR_##sym,
86 foreach_l2_input_classify_error
88 L2_INPUT_CLASSIFY_N_ERROR,
89 } l2_input_classify_error_t;
91 static char *l2_input_classify_error_strings[] = {
92 #define _(sym,string) string,
93 foreach_l2_input_classify_error
98 * @brief l2 input classifier node.
99 * @node l2-input-classify
101 * This is the l2 input classifier dispatch node
103 * @param vm vlib_main_t corresponding to the current thread.
104 * @param node vlib_node_runtime_t data for this node.
105 * @param frame vlib_frame_t whose contents should be dispatched.
107 * @par Graph mechanics: buffer metadata, next index usage
110 * - <code>(l2_input_classify_runtime_t *)
111 * rt->classify_table_index_by_sw_if_index</code>
112 * - Head of the per-interface, per-protocol classifier table chain
113 * for a specific interface.
114 * - @c ~0 => send pkts to the next feature in the L2 feature chain.
115 * - <code>vnet_buffer(b)->sw_if_index[VLIB_RX]</code>
116 * - Indicates the @c sw_if_index value of the interface that the
117 * packet was received on.
118 * - <code>vnet_buffer(b0)->l2.feature_bitmap</code>
119 * - Used to steer packets across l2 features enabled on the interface
120 * - <code>(vnet_classify_entry_t) e0->next_index</code>
121 * - Used to steer traffic when the classifier hits on a session
122 * - <code>(vnet_classify_entry_t) e0->advance</code>
123 * - Signed quantity applied via <code>vlib_buffer_advance</code>
124 * when the classifier hits on a session
125 * - <code>(vnet_classify_table_t) t0->miss_next_index</code>
126 * - Used to steer traffic when the classifier misses
129 * - <code>vnet_buffer (b0)->l2_classify.table_index</code>
130 * - Classifier table index of the first classifier table in
131 * the classifier table chain
132 * - <code>vnet_buffer (b0)->l2_classify.hash</code>
133 * - Bounded-index extensible hash corresponding to the
134 * masked fields in the current packet
135 * - <code>vnet_buffer (b0)->l2.feature_bitmap</code>
136 * - Used to steer packets across l2 features enabled on the interface
137 * - <code>vnet_buffer (b0)->l2_classify.opaque_index</code>
138 * - Copied from the classifier session object upon classifier hit
141 * - <code>L2_INPUT_CLASSIFY_ERROR_MISS</code> Classifier misses
142 * - <code>L2_INPUT_CLASSIFY_ERROR_HIT</code> Classifier hits
143 * - <code>L2_INPUT_CLASSIFY_ERROR_CHAIN_HIT</code>
144 * Classifier hits in other than the first table
147 VLIB_NODE_FN (l2_input_classify_node) (vlib_main_t * vm,
148 vlib_node_runtime_t * node,
149 vlib_frame_t * frame)
151 u32 n_left_from, *from, *to_next;
152 l2_input_classify_next_t next_index;
153 l2_input_classify_main_t *cm = &l2_input_classify_main;
154 vnet_classify_main_t *vcm = cm->vnet_classify_main;
155 l2_input_classify_runtime_t *rt =
156 (l2_input_classify_runtime_t *) node->runtime_data;
163 n_next_nodes = node->n_next_nodes;
165 now = vlib_time_now (vm);
167 n_left_from = frame->n_vectors;
168 from = vlib_frame_vector_args (frame);
170 /* First pass: compute hash */
172 while (n_left_from >= 4)
174 vlib_buffer_t *b0, *b1;
176 ethernet_header_t *h0, *h1;
177 u32 sw_if_index0, sw_if_index1;
179 int type_index0, type_index1;
180 vnet_classify_table_t *t0, *t1;
181 u32 table_index0, table_index1;
185 /* prefetch next iteration */
187 vlib_buffer_t *p2, *p3;
189 p2 = vlib_get_buffer (vm, from[2]);
190 p3 = vlib_get_buffer (vm, from[3]);
192 vlib_prefetch_buffer_header (p2, STORE);
193 CLIB_PREFETCH (p2->data, CLIB_CACHE_LINE_BYTES, STORE);
194 vlib_prefetch_buffer_header (p3, STORE);
195 CLIB_PREFETCH (p3->data, CLIB_CACHE_LINE_BYTES, STORE);
199 b0 = vlib_get_buffer (vm, bi0);
200 h0 = vlib_buffer_get_current (b0);
203 b1 = vlib_get_buffer (vm, bi1);
204 h1 = vlib_buffer_get_current (b1);
206 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
207 vnet_buffer (b0)->l2_classify.table_index = ~0;
209 sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
210 vnet_buffer (b1)->l2_classify.table_index = ~0;
212 /* Select classifier table based on ethertype */
213 type0 = clib_net_to_host_u16 (h0->type);
214 type1 = clib_net_to_host_u16 (h1->type);
216 type_index0 = (type0 == ETHERNET_TYPE_IP4)
217 ? L2_INPUT_CLASSIFY_TABLE_IP4 : L2_INPUT_CLASSIFY_TABLE_OTHER;
218 type_index0 = (type0 == ETHERNET_TYPE_IP6)
219 ? L2_INPUT_CLASSIFY_TABLE_IP6 : type_index0;
221 type_index1 = (type1 == ETHERNET_TYPE_IP4)
222 ? L2_INPUT_CLASSIFY_TABLE_IP4 : L2_INPUT_CLASSIFY_TABLE_OTHER;
223 type_index1 = (type1 == ETHERNET_TYPE_IP6)
224 ? L2_INPUT_CLASSIFY_TABLE_IP6 : type_index1;
226 vnet_buffer (b0)->l2_classify.table_index =
228 rt->l2cm->classify_table_index_by_sw_if_index
229 [type_index0][sw_if_index0];
231 if (table_index0 != ~0)
233 t0 = pool_elt_at_index (vcm->tables, table_index0);
235 vnet_buffer (b0)->l2_classify.hash = hash0 =
236 vnet_classify_hash_packet (t0, (u8 *) h0);
237 vnet_classify_prefetch_bucket (t0, hash0);
240 vnet_buffer (b1)->l2_classify.table_index =
242 rt->l2cm->classify_table_index_by_sw_if_index
243 [type_index1][sw_if_index1];
245 if (table_index1 != ~0)
247 t1 = pool_elt_at_index (vcm->tables, table_index1);
249 vnet_buffer (b1)->l2_classify.hash = hash1 =
250 vnet_classify_hash_packet (t1, (u8 *) h1);
251 vnet_classify_prefetch_bucket (t1, hash1);
258 while (n_left_from > 0)
262 ethernet_header_t *h0;
266 vnet_classify_table_t *t0;
271 b0 = vlib_get_buffer (vm, bi0);
272 h0 = vlib_buffer_get_current (b0);
274 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
275 vnet_buffer (b0)->l2_classify.table_index = ~0;
277 /* Select classifier table based on ethertype */
278 type0 = clib_net_to_host_u16 (h0->type);
280 type_index0 = (type0 == ETHERNET_TYPE_IP4)
281 ? L2_INPUT_CLASSIFY_TABLE_IP4 : L2_INPUT_CLASSIFY_TABLE_OTHER;
282 type_index0 = (type0 == ETHERNET_TYPE_IP6)
283 ? L2_INPUT_CLASSIFY_TABLE_IP6 : type_index0;
285 vnet_buffer (b0)->l2_classify.table_index =
286 table_index0 = rt->l2cm->classify_table_index_by_sw_if_index
287 [type_index0][sw_if_index0];
289 if (table_index0 != ~0)
291 t0 = pool_elt_at_index (vcm->tables, table_index0);
293 vnet_buffer (b0)->l2_classify.hash = hash0 =
294 vnet_classify_hash_packet (t0, (u8 *) h0);
295 vnet_classify_prefetch_bucket (t0, hash0);
301 next_index = node->cached_next_index;
302 from = vlib_frame_vector_args (frame);
303 n_left_from = frame->n_vectors;
305 while (n_left_from > 0)
309 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
311 /* Not enough load/store slots to dual loop... */
312 while (n_left_from > 0 && n_left_to_next > 0)
316 u32 next0 = ~0; /* next l2 input feature, please... */
317 ethernet_header_t *h0;
320 vnet_classify_table_t *t0;
321 vnet_classify_entry_t *e0;
323 if (PREDICT_TRUE (n_left_from > 2))
325 vlib_buffer_t *p2 = vlib_get_buffer (vm, from[2]);
328 vnet_classify_table_t *tp2;
331 * Prefetch table entry two ahead. Buffer / data
332 * were prefetched above...
334 table_index2 = vnet_buffer (p2)->l2_classify.table_index;
336 if (PREDICT_TRUE (table_index2 != ~0))
338 tp2 = pool_elt_at_index (vcm->tables, table_index2);
339 phash2 = vnet_buffer (p2)->l2_classify.hash;
340 vnet_classify_prefetch_entry (tp2, phash2);
344 /* speculatively enqueue b0 to the current next frame */
352 b0 = vlib_get_buffer (vm, bi0);
353 h0 = vlib_buffer_get_current (b0);
354 table_index0 = vnet_buffer (b0)->l2_classify.table_index;
356 vnet_buffer (b0)->l2_classify.opaque_index = ~0;
358 if (PREDICT_TRUE (table_index0 != ~0))
360 hash0 = vnet_buffer (b0)->l2_classify.hash;
361 t0 = pool_elt_at_index (vcm->tables, table_index0);
363 e0 = vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
366 vnet_buffer (b0)->l2_classify.opaque_index
368 vlib_buffer_advance (b0, e0->advance);
369 next0 = (e0->next_index < n_next_nodes) ?
370 e0->next_index : next0;
377 if (t0->next_table_index != ~0)
378 t0 = pool_elt_at_index (vcm->tables,
379 t0->next_table_index);
382 next0 = (t0->miss_next_index < n_next_nodes) ?
383 t0->miss_next_index : next0;
388 hash0 = vnet_classify_hash_packet (t0, (u8 *) h0);
390 vnet_classify_find_entry (t0, (u8 *) h0, hash0, now);
393 vnet_buffer (b0)->l2_classify.opaque_index
395 vlib_buffer_advance (b0, e0->advance);
396 next0 = (e0->next_index < n_next_nodes) ?
397 e0->next_index : next0;
406 if (PREDICT_FALSE (next0 == 0))
407 b0->error = node->errors[L2_INPUT_CLASSIFY_ERROR_DROP];
409 /* Determine the next node and remove ourself from bitmap */
410 if (PREDICT_TRUE (next0 == ~0))
411 next0 = vnet_l2_feature_next (b0, cm->l2_inp_feat_next,
412 L2INPUT_FEAT_INPUT_CLASSIFY);
414 vnet_buffer (b0)->l2.feature_bitmap &=
415 ~L2INPUT_FEAT_INPUT_CLASSIFY;
417 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
418 && (b0->flags & VLIB_BUFFER_IS_TRACED)))
420 l2_input_classify_trace_t *t =
421 vlib_add_trace (vm, node, b0, sizeof (*t));
422 t->sw_if_index = vnet_buffer (b0)->sw_if_index[VLIB_RX];
423 t->table_index = table_index0;
424 t->next_index = next0;
425 t->session_offset = e0 ? vnet_classify_get_offset (t0, e0) : 0;
428 /* verify speculative enqueue, maybe switch current next frame */
429 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
430 to_next, n_left_to_next,
434 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
437 vlib_node_increment_counter (vm, node->node_index,
438 L2_INPUT_CLASSIFY_ERROR_MISS, misses);
439 vlib_node_increment_counter (vm, node->node_index,
440 L2_INPUT_CLASSIFY_ERROR_HIT, hits);
441 vlib_node_increment_counter (vm, node->node_index,
442 L2_INPUT_CLASSIFY_ERROR_CHAIN_HIT, chain_hits);
443 return frame->n_vectors;
447 VLIB_REGISTER_NODE (l2_input_classify_node) = {
448 .name = "l2-input-classify",
449 .vector_size = sizeof (u32),
450 .format_trace = format_l2_input_classify_trace,
451 .type = VLIB_NODE_TYPE_INTERNAL,
453 .n_errors = ARRAY_LEN(l2_input_classify_error_strings),
454 .error_strings = l2_input_classify_error_strings,
456 .runtime_data_bytes = sizeof (l2_input_classify_runtime_t),
458 .n_next_nodes = L2_INPUT_CLASSIFY_N_NEXT,
460 /* edit / add dispositions here */
462 [L2_INPUT_CLASSIFY_NEXT_DROP] = "error-drop",
463 [L2_INPUT_CLASSIFY_NEXT_ETHERNET_INPUT] = "ethernet-input-not-l2",
464 [L2_INPUT_CLASSIFY_NEXT_IP4_INPUT] = "ip4-input",
465 [L2_INPUT_CLASSIFY_NEXT_IP6_INPUT] = "ip6-input",
466 [L2_INPUT_CLASSIFY_NEXT_LI] = "li-hit",
471 #ifndef CLIB_MARCH_VARIANT
472 /** l2 input classsifier feature initialization. */
474 l2_input_classify_init (vlib_main_t * vm)
476 l2_input_classify_main_t *cm = &l2_input_classify_main;
477 l2_input_classify_runtime_t *rt;
479 rt = vlib_node_get_runtime_data (vm, l2_input_classify_node.index);
482 cm->vnet_main = vnet_get_main ();
483 cm->vnet_classify_main = &vnet_classify_main;
485 /* Initialize the feature next-node indexes */
486 feat_bitmap_init_next_nodes (vm,
487 l2_input_classify_node.index,
489 l2input_get_feat_names (),
490 cm->l2_inp_feat_next);
492 rt->vcm = cm->vnet_classify_main;
497 VLIB_INIT_FUNCTION (l2_input_classify_init);
500 l2_input_classify_worker_init (vlib_main_t * vm)
502 l2_input_classify_main_t *cm = &l2_input_classify_main;
503 l2_input_classify_runtime_t *rt;
505 rt = vlib_node_get_runtime_data (vm, l2_input_classify_node.index);
508 rt->vcm = cm->vnet_classify_main;
513 VLIB_WORKER_INIT_FUNCTION (l2_input_classify_worker_init);
515 /** Enable/disable l2 input classification on a specific interface. */
517 vnet_l2_input_classify_enable_disable (u32 sw_if_index, int enable_disable)
519 l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_INPUT_CLASSIFY,
520 (u32) enable_disable);
523 /** @brief Set l2 per-protocol, per-interface input classification tables.
525 * @param sw_if_index interface handle
526 * @param ip4_table_index ip4 classification table index, or ~0
527 * @param ip6_table_index ip6 classification table index, or ~0
528 * @param other_table_index non-ip4, non-ip6 classification table index,
530 * @returns 0 on success, VNET_API_ERROR_NO_SUCH_TABLE, TABLE2, TABLE3
531 * if the indicated (non-~0) table does not exist.
535 vnet_l2_input_classify_set_tables (u32 sw_if_index,
537 u32 ip6_table_index, u32 other_table_index)
539 l2_input_classify_main_t *cm = &l2_input_classify_main;
540 vnet_classify_main_t *vcm = cm->vnet_classify_main;
542 /* Assume that we've validated sw_if_index in the API layer */
544 if (ip4_table_index != ~0 &&
545 pool_is_free_index (vcm->tables, ip4_table_index))
546 return VNET_API_ERROR_NO_SUCH_TABLE;
548 if (ip6_table_index != ~0 &&
549 pool_is_free_index (vcm->tables, ip6_table_index))
550 return VNET_API_ERROR_NO_SUCH_TABLE2;
552 if (other_table_index != ~0 &&
553 pool_is_free_index (vcm->tables, other_table_index))
554 return VNET_API_ERROR_NO_SUCH_TABLE3;
557 (cm->classify_table_index_by_sw_if_index[L2_INPUT_CLASSIFY_TABLE_IP4],
561 (cm->classify_table_index_by_sw_if_index[L2_INPUT_CLASSIFY_TABLE_IP6],
565 (cm->classify_table_index_by_sw_if_index[L2_INPUT_CLASSIFY_TABLE_OTHER],
568 cm->classify_table_index_by_sw_if_index[L2_INPUT_CLASSIFY_TABLE_IP4]
569 [sw_if_index] = ip4_table_index;
571 cm->classify_table_index_by_sw_if_index[L2_INPUT_CLASSIFY_TABLE_IP6]
572 [sw_if_index] = ip6_table_index;
574 cm->classify_table_index_by_sw_if_index[L2_INPUT_CLASSIFY_TABLE_OTHER]
575 [sw_if_index] = other_table_index;
579 #endif /* CLIB_MARCH_VARIANT */
581 static clib_error_t *
582 int_l2_input_classify_command_fn (vlib_main_t * vm,
583 unformat_input_t * input,
584 vlib_cli_command_t * cmd)
586 vnet_main_t *vnm = vnet_get_main ();
587 u32 sw_if_index = ~0;
588 u32 ip4_table_index = ~0;
589 u32 ip6_table_index = ~0;
590 u32 other_table_index = ~0;
593 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
595 if (unformat (input, "intfc %U", unformat_vnet_sw_interface,
598 else if (unformat (input, "ip4-table %d", &ip4_table_index))
600 else if (unformat (input, "ip6-table %d", &ip6_table_index))
602 else if (unformat (input, "other-table %d", &other_table_index))
608 if (sw_if_index == ~0)
609 return clib_error_return (0, "interface must be specified");
612 if (ip4_table_index == ~0 && ip6_table_index == ~0
613 && other_table_index == ~0)
615 vlib_cli_output (vm, "L2 classification disabled");
616 vnet_l2_input_classify_enable_disable (sw_if_index, 0 /* enable */ );
620 rv = vnet_l2_input_classify_set_tables (sw_if_index, ip4_table_index,
621 ip6_table_index, other_table_index);
625 vnet_l2_input_classify_enable_disable (sw_if_index, 1 /* enable */ );
629 return clib_error_return (0, "vnet_l2_input_classify_set_tables: %d",
638 * Configure l2 input classification.
641 * @cliexstart{set interface l2 input classify intfc <interface-name> [ip4-table <index>] [ip6-table <index>] [other-table <index>]}
643 * @todo This is incomplete. This needs a detailed description and a
647 VLIB_CLI_COMMAND (int_l2_input_classify_cli, static) = {
648 .path = "set interface l2 input classify",
650 "set interface l2 input classify intfc <interface-name> [ip4-table <n>]\n"
651 " [ip6-table <n>] [other-table <n>]",
652 .function = int_l2_input_classify_command_fn,
657 * fd.io coding-style-patch-verification: ON
660 * eval: (c-set-style "gnu")