1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 Intel Corporation
5 #include <rte_flow_classify.h>
6 #include "rte_flow_classify_parse.h"
7 #include <rte_flow_driver.h>
8 #include <rte_table_acl.h>
11 int librte_flow_classify_logtype;
13 static uint32_t unique_id = 1;
15 enum rte_flow_classify_table_type table_type
16 = RTE_FLOW_CLASSIFY_TABLE_TYPE_NONE;
18 struct rte_flow_classify_table_entry {
19 /* meta-data for classify rule */
23 struct classify_action action;
26 struct rte_cls_table {
27 /* Input parameters */
28 struct rte_table_ops ops;
30 enum rte_flow_classify_table_type type;
32 /* Handle to the low-level table object */
36 #define RTE_FLOW_CLASSIFIER_MAX_NAME_SZ 256
38 struct rte_flow_classifier {
39 /* Input parameters */
40 char name[RTE_FLOW_CLASSIFIER_MAX_NAME_SZ];
45 struct rte_eth_ntuple_filter ntuple_filter;
47 /* classifier tables */
48 struct rte_cls_table tables[RTE_FLOW_CLASSIFY_TABLE_MAX];
53 struct rte_flow_classify_table_entry
54 *entries[RTE_PORT_IN_BURST_SIZE_MAX];
55 } __rte_cache_aligned;
67 struct rte_table_acl_rule_add_params key_add; /* add key */
68 struct rte_table_acl_rule_delete_params key_del; /* delete key */
71 struct classify_rules {
72 enum rte_flow_classify_rule_type type;
74 struct rte_flow_classify_ipv4_5tuple ipv4_5tuple;
78 struct rte_flow_classify_rule {
79 uint32_t id; /* unique ID of classify rule */
80 enum rte_flow_classify_table_type tbl_type; /* rule table */
81 struct classify_rules rules; /* union of rules */
85 int key_found; /* rule key found in table */
86 struct rte_flow_classify_table_entry entry; /* rule meta data */
87 void *entry_ptr; /* handle to the table entry for rule meta data */
91 rte_flow_classify_validate(
92 struct rte_flow_classifier *cls,
93 const struct rte_flow_attr *attr,
94 const struct rte_flow_item pattern[],
95 const struct rte_flow_action actions[],
96 struct rte_flow_error *error)
98 struct rte_flow_item *items;
99 parse_filter_t parse_filter;
100 uint32_t item_num = 0;
108 RTE_FLOW_CLASSIFY_LOG(ERR,
109 "%s: rte_flow_classifier parameter is NULL\n",
115 rte_flow_error_set(error, EINVAL,
116 RTE_FLOW_ERROR_TYPE_ATTR,
117 NULL, "NULL attribute.");
122 rte_flow_error_set(error,
123 EINVAL, RTE_FLOW_ERROR_TYPE_ITEM_NUM,
124 NULL, "NULL pattern.");
129 rte_flow_error_set(error, EINVAL,
130 RTE_FLOW_ERROR_TYPE_ACTION_NUM,
131 NULL, "NULL action.");
135 memset(&cls->ntuple_filter, 0, sizeof(cls->ntuple_filter));
137 /* Get the non-void item number of pattern */
138 while ((pattern + i)->type != RTE_FLOW_ITEM_TYPE_END) {
139 if ((pattern + i)->type != RTE_FLOW_ITEM_TYPE_VOID)
145 items = malloc(item_num * sizeof(struct rte_flow_item));
147 rte_flow_error_set(error, ENOMEM,
148 RTE_FLOW_ERROR_TYPE_ITEM_NUM,
149 NULL, "No memory for pattern items.");
153 memset(items, 0, item_num * sizeof(struct rte_flow_item));
154 classify_pattern_skip_void_item(items, pattern);
156 parse_filter = classify_find_parse_filter_func(items);
158 rte_flow_error_set(error, EINVAL,
159 RTE_FLOW_ERROR_TYPE_ITEM,
160 pattern, "Unsupported pattern");
165 ret = parse_filter(attr, items, actions, &cls->ntuple_filter, error);
171 #define uint32_t_to_char(ip, a, b, c, d) do {\
172 *a = (unsigned char)(ip >> 24 & 0xff);\
173 *b = (unsigned char)(ip >> 16 & 0xff);\
174 *c = (unsigned char)(ip >> 8 & 0xff);\
175 *d = (unsigned char)(ip & 0xff);\
179 print_acl_ipv4_key_add(struct rte_table_acl_rule_add_params *key)
181 unsigned char a, b, c, d;
183 printf("%s: 0x%02hhx/0x%hhx ", __func__,
184 key->field_value[PROTO_FIELD_IPV4].value.u8,
185 key->field_value[PROTO_FIELD_IPV4].mask_range.u8);
187 uint32_t_to_char(key->field_value[SRC_FIELD_IPV4].value.u32,
189 printf(" %hhu.%hhu.%hhu.%hhu/0x%x ", a, b, c, d,
190 key->field_value[SRC_FIELD_IPV4].mask_range.u32);
192 uint32_t_to_char(key->field_value[DST_FIELD_IPV4].value.u32,
194 printf("%hhu.%hhu.%hhu.%hhu/0x%x ", a, b, c, d,
195 key->field_value[DST_FIELD_IPV4].mask_range.u32);
197 printf("%hu : 0x%x %hu : 0x%x",
198 key->field_value[SRCP_FIELD_IPV4].value.u16,
199 key->field_value[SRCP_FIELD_IPV4].mask_range.u16,
200 key->field_value[DSTP_FIELD_IPV4].value.u16,
201 key->field_value[DSTP_FIELD_IPV4].mask_range.u16);
203 printf(" priority: 0x%x\n", key->priority);
207 print_acl_ipv4_key_delete(struct rte_table_acl_rule_delete_params *key)
209 unsigned char a, b, c, d;
211 printf("%s: 0x%02hhx/0x%hhx ", __func__,
212 key->field_value[PROTO_FIELD_IPV4].value.u8,
213 key->field_value[PROTO_FIELD_IPV4].mask_range.u8);
215 uint32_t_to_char(key->field_value[SRC_FIELD_IPV4].value.u32,
217 printf(" %hhu.%hhu.%hhu.%hhu/0x%x ", a, b, c, d,
218 key->field_value[SRC_FIELD_IPV4].mask_range.u32);
220 uint32_t_to_char(key->field_value[DST_FIELD_IPV4].value.u32,
222 printf("%hhu.%hhu.%hhu.%hhu/0x%x ", a, b, c, d,
223 key->field_value[DST_FIELD_IPV4].mask_range.u32);
225 printf("%hu : 0x%x %hu : 0x%x\n",
226 key->field_value[SRCP_FIELD_IPV4].value.u16,
227 key->field_value[SRCP_FIELD_IPV4].mask_range.u16,
228 key->field_value[DSTP_FIELD_IPV4].value.u16,
229 key->field_value[DSTP_FIELD_IPV4].mask_range.u16);
233 rte_flow_classifier_check_params(struct rte_flow_classifier_params *params)
235 if (params == NULL) {
236 RTE_FLOW_CLASSIFY_LOG(ERR,
237 "%s: Incorrect value for parameter params\n", __func__);
242 if (params->name == NULL) {
243 RTE_FLOW_CLASSIFY_LOG(ERR,
244 "%s: Incorrect value for parameter name\n", __func__);
249 if ((params->socket_id < 0) ||
250 (params->socket_id >= RTE_MAX_NUMA_NODES)) {
251 RTE_FLOW_CLASSIFY_LOG(ERR,
252 "%s: Incorrect value for parameter socket_id\n",
260 struct rte_flow_classifier *
261 rte_flow_classifier_create(struct rte_flow_classifier_params *params)
263 struct rte_flow_classifier *cls;
266 /* Check input parameters */
267 ret = rte_flow_classifier_check_params(params);
269 RTE_FLOW_CLASSIFY_LOG(ERR,
270 "%s: flow classifier params check failed (%d)\n",
275 /* Allocate memory for the flow classifier */
276 cls = rte_zmalloc_socket("FLOW_CLASSIFIER",
277 sizeof(struct rte_flow_classifier),
278 RTE_CACHE_LINE_SIZE, params->socket_id);
281 RTE_FLOW_CLASSIFY_LOG(ERR,
282 "%s: flow classifier memory allocation failed\n",
287 /* Save input parameters */
288 snprintf(cls->name, RTE_FLOW_CLASSIFIER_MAX_NAME_SZ, "%s",
291 cls->socket_id = params->socket_id;
297 rte_flow_classify_table_free(struct rte_cls_table *table)
299 if (table->ops.f_free != NULL)
300 table->ops.f_free(table->h_table);
304 rte_flow_classifier_free(struct rte_flow_classifier *cls)
308 /* Check input parameters */
310 RTE_FLOW_CLASSIFY_LOG(ERR,
311 "%s: rte_flow_classifier parameter is NULL\n",
317 for (i = 0; i < cls->num_tables; i++) {
318 struct rte_cls_table *table = &cls->tables[i];
320 rte_flow_classify_table_free(table);
323 /* Free flow classifier memory */
330 rte_table_check_params(struct rte_flow_classifier *cls,
331 struct rte_flow_classify_table_params *params)
334 RTE_FLOW_CLASSIFY_LOG(ERR,
335 "%s: flow classifier parameter is NULL\n",
339 if (params == NULL) {
340 RTE_FLOW_CLASSIFY_LOG(ERR, "%s: params parameter is NULL\n",
346 if (params->ops == NULL) {
347 RTE_FLOW_CLASSIFY_LOG(ERR, "%s: params->ops is NULL\n",
352 if (params->ops->f_create == NULL) {
353 RTE_FLOW_CLASSIFY_LOG(ERR,
354 "%s: f_create function pointer is NULL\n", __func__);
358 if (params->ops->f_lookup == NULL) {
359 RTE_FLOW_CLASSIFY_LOG(ERR,
360 "%s: f_lookup function pointer is NULL\n", __func__);
364 /* De we have room for one more table? */
365 if (cls->num_tables == RTE_FLOW_CLASSIFY_TABLE_MAX) {
366 RTE_FLOW_CLASSIFY_LOG(ERR,
367 "%s: Incorrect value for num_tables parameter\n",
376 rte_flow_classify_table_create(struct rte_flow_classifier *cls,
377 struct rte_flow_classify_table_params *params)
379 struct rte_cls_table *table;
384 /* Check input arguments */
385 ret = rte_table_check_params(cls, params);
389 /* calculate table entry size */
390 entry_size = sizeof(struct rte_flow_classify_table_entry);
392 /* Create the table */
393 h_table = params->ops->f_create(params->arg_create, cls->socket_id,
395 if (h_table == NULL) {
396 RTE_FLOW_CLASSIFY_LOG(ERR, "%s: Table creation failed\n",
401 /* Commit current table to the classifier */
402 table = &cls->tables[cls->num_tables];
403 table->type = params->type;
406 /* Save input parameters */
407 memcpy(&table->ops, params->ops, sizeof(struct rte_table_ops));
409 /* Initialize table internal data structure */
410 table->entry_size = entry_size;
411 table->h_table = h_table;
416 static struct rte_flow_classify_rule *
417 allocate_acl_ipv4_5tuple_rule(struct rte_flow_classifier *cls)
419 struct rte_flow_classify_rule *rule;
422 rule = malloc(sizeof(struct rte_flow_classify_rule));
426 memset(rule, 0, sizeof(struct rte_flow_classify_rule));
427 rule->id = unique_id++;
428 rule->rules.type = RTE_FLOW_CLASSIFY_RULE_TYPE_IPV4_5TUPLE;
431 rule->u.key.key_add.priority = cls->ntuple_filter.priority;
432 rule->u.key.key_add.field_value[PROTO_FIELD_IPV4].mask_range.u8 =
433 cls->ntuple_filter.proto_mask;
434 rule->u.key.key_add.field_value[PROTO_FIELD_IPV4].value.u8 =
435 cls->ntuple_filter.proto;
436 rule->rules.u.ipv4_5tuple.proto = cls->ntuple_filter.proto;
437 rule->rules.u.ipv4_5tuple.proto_mask = cls->ntuple_filter.proto_mask;
439 rule->u.key.key_add.field_value[SRC_FIELD_IPV4].mask_range.u32 =
440 cls->ntuple_filter.src_ip_mask;
441 rule->u.key.key_add.field_value[SRC_FIELD_IPV4].value.u32 =
442 cls->ntuple_filter.src_ip;
443 rule->rules.u.ipv4_5tuple.src_ip_mask = cls->ntuple_filter.src_ip_mask;
444 rule->rules.u.ipv4_5tuple.src_ip = cls->ntuple_filter.src_ip;
446 rule->u.key.key_add.field_value[DST_FIELD_IPV4].mask_range.u32 =
447 cls->ntuple_filter.dst_ip_mask;
448 rule->u.key.key_add.field_value[DST_FIELD_IPV4].value.u32 =
449 cls->ntuple_filter.dst_ip;
450 rule->rules.u.ipv4_5tuple.dst_ip_mask = cls->ntuple_filter.dst_ip_mask;
451 rule->rules.u.ipv4_5tuple.dst_ip = cls->ntuple_filter.dst_ip;
453 rule->u.key.key_add.field_value[SRCP_FIELD_IPV4].mask_range.u16 =
454 cls->ntuple_filter.src_port_mask;
455 rule->u.key.key_add.field_value[SRCP_FIELD_IPV4].value.u16 =
456 cls->ntuple_filter.src_port;
457 rule->rules.u.ipv4_5tuple.src_port_mask =
458 cls->ntuple_filter.src_port_mask;
459 rule->rules.u.ipv4_5tuple.src_port = cls->ntuple_filter.src_port;
461 rule->u.key.key_add.field_value[DSTP_FIELD_IPV4].mask_range.u16 =
462 cls->ntuple_filter.dst_port_mask;
463 rule->u.key.key_add.field_value[DSTP_FIELD_IPV4].value.u16 =
464 cls->ntuple_filter.dst_port;
465 rule->rules.u.ipv4_5tuple.dst_port_mask =
466 cls->ntuple_filter.dst_port_mask;
467 rule->rules.u.ipv4_5tuple.dst_port = cls->ntuple_filter.dst_port;
469 log_level = rte_log_get_level(librte_flow_classify_logtype);
471 if (log_level == RTE_LOG_DEBUG)
472 print_acl_ipv4_key_add(&rule->u.key.key_add);
474 /* key delete values */
475 memcpy(&rule->u.key.key_del.field_value[PROTO_FIELD_IPV4],
476 &rule->u.key.key_add.field_value[PROTO_FIELD_IPV4],
477 NUM_FIELDS_IPV4 * sizeof(struct rte_acl_field));
479 if (log_level == RTE_LOG_DEBUG)
480 print_acl_ipv4_key_delete(&rule->u.key.key_del);
485 struct rte_flow_classify_rule *
486 rte_flow_classify_table_entry_add(struct rte_flow_classifier *cls,
487 const struct rte_flow_attr *attr,
488 const struct rte_flow_item pattern[],
489 const struct rte_flow_action actions[],
491 struct rte_flow_error *error)
493 struct rte_flow_classify_rule *rule;
494 struct rte_flow_classify_table_entry *table_entry;
495 struct classify_action *action;
502 if (key_found == NULL) {
503 rte_flow_error_set(error, EINVAL,
504 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
505 NULL, "NULL key_found.");
509 /* parse attr, pattern and actions */
510 ret = rte_flow_classify_validate(cls, attr, pattern, actions, error);
514 switch (table_type) {
515 case RTE_FLOW_CLASSIFY_TABLE_ACL_IP4_5TUPLE:
516 rule = allocate_acl_ipv4_5tuple_rule(cls);
519 rule->tbl_type = table_type;
520 cls->table_mask |= table_type;
526 action = classify_get_flow_action();
527 table_entry = &rule->entry;
528 table_entry->rule_id = rule->id;
529 table_entry->action.action_mask = action->action_mask;
532 if (action->action_mask & (1LLU << RTE_FLOW_ACTION_TYPE_COUNT)) {
533 memcpy(&table_entry->action.act.counter, &action->act.counter,
534 sizeof(table_entry->action.act.counter));
536 if (action->action_mask & (1LLU << RTE_FLOW_ACTION_TYPE_MARK)) {
537 memcpy(&table_entry->action.act.mark, &action->act.mark,
538 sizeof(table_entry->action.act.mark));
541 for (i = 0; i < cls->num_tables; i++) {
542 struct rte_cls_table *table = &cls->tables[i];
544 if (table->type == table_type) {
545 if (table->ops.f_add != NULL) {
546 ret = table->ops.f_add(
548 &rule->u.key.key_add,
557 *key_found = rule->key_found;
567 rte_flow_classify_table_entry_delete(struct rte_flow_classifier *cls,
568 struct rte_flow_classify_rule *rule)
575 enum rte_flow_classify_table_type tbl_type = rule->tbl_type;
577 for (i = 0; i < cls->num_tables; i++) {
578 struct rte_cls_table *table = &cls->tables[i];
580 if (table->type == tbl_type) {
581 if (table->ops.f_delete != NULL) {
582 ret = table->ops.f_delete(table->h_table,
583 &rule->u.key.key_del,
596 flow_classifier_lookup(struct rte_flow_classifier *cls,
597 struct rte_cls_table *table,
598 struct rte_mbuf **pkts,
599 const uint16_t nb_pkts)
603 uint64_t lookup_hit_mask;
605 pkts_mask = RTE_LEN2MASK(nb_pkts, uint64_t);
606 ret = table->ops.f_lookup(table->h_table,
607 pkts, pkts_mask, &lookup_hit_mask,
608 (void **)cls->entries);
610 if (!ret && lookup_hit_mask)
611 cls->nb_pkts = nb_pkts;
619 action_apply(struct rte_flow_classifier *cls,
620 struct rte_flow_classify_rule *rule,
621 struct rte_flow_classify_stats *stats)
623 struct rte_flow_classify_ipv4_5tuple_stats *ntuple_stats;
624 struct rte_flow_classify_table_entry *entry = &rule->entry;
626 uint32_t action_mask = entry->action.action_mask;
627 int i, ret = -EINVAL;
629 if (action_mask & (1LLU << RTE_FLOW_ACTION_TYPE_COUNT)) {
630 for (i = 0; i < cls->nb_pkts; i++) {
631 if (rule->id == cls->entries[i]->rule_id)
637 (struct rte_flow_classify_ipv4_5tuple_stats *)
639 ntuple_stats->counter1 = count;
640 ntuple_stats->ipv4_5tuple = rule->rules.u.ipv4_5tuple;
647 rte_flow_classifier_query(struct rte_flow_classifier *cls,
648 struct rte_mbuf **pkts,
649 const uint16_t nb_pkts,
650 struct rte_flow_classify_rule *rule,
651 struct rte_flow_classify_stats *stats)
653 enum rte_flow_classify_table_type tbl_type;
657 if (!cls || !rule || !stats || !pkts || nb_pkts == 0)
660 tbl_type = rule->tbl_type;
661 for (i = 0; i < cls->num_tables; i++) {
662 struct rte_cls_table *table = &cls->tables[i];
664 if (table->type == tbl_type) {
665 ret = flow_classifier_lookup(cls, table,
668 ret = action_apply(cls, rule, stats);
676 RTE_INIT(librte_flow_classify_init_log);
679 librte_flow_classify_init_log(void)
681 librte_flow_classify_logtype =
682 rte_log_register("lib.flow_classify");
683 if (librte_flow_classify_logtype >= 0)
684 rte_log_set_level(librte_flow_classify_logtype, RTE_LOG_INFO);