Add testpmd support for the rte_flow_table API.
Provide the command line interface for the flow
table creation/destruction. Usage example:
testpmd> flow table 0 create table_id 6
group 9 priority 4 ingress mode 1
rules_number 64 item_template 2 action_template 4
testpmd> flow table 0 destroy table 6
Signed-off-by: Alexander Kozyrev <akozy...@nvidia.com>
---
app/test-pmd/cmdline_flow.c | 315 ++++++++++++++++++++
app/test-pmd/config.c | 168 +++++++++++
app/test-pmd/testpmd.h | 15 +
doc/guides/testpmd_app_ug/testpmd_funcs.rst | 53 ++++
4 files changed, 551 insertions(+)
diff --git a/app/test-pmd/cmdline_flow.c b/app/test-pmd/cmdline_flow.c
index fb27a97855..4dc2a2aaeb 100644
--- a/app/test-pmd/cmdline_flow.c
+++ b/app/test-pmd/cmdline_flow.c
@@ -58,6 +58,7 @@ enum index {
COMMON_FLEX_TOKEN,
COMMON_ITEM_TEMPLATE_ID,
COMMON_ACTION_TEMPLATE_ID,
+ COMMON_TABLE_ID,
/* TOP-level command. */
ADD,
@@ -77,6 +78,7 @@ enum index {
CONFIGURE,
ITEM_TEMPLATE,
ACTION_TEMPLATE,
+ TABLE,
INDIRECT_ACTION,
VALIDATE,
CREATE,
@@ -111,6 +113,20 @@ enum index {
ACTION_TEMPLATE_SPEC,
ACTION_TEMPLATE_MASK,
+ /* Table arguments. */
+ TABLE_CREATE,
+ TABLE_DESTROY,
+ TABLE_CREATE_ID,
+ TABLE_DESTROY_ID,
+ TABLE_GROUP,
+ TABLE_PRIORITY,
+ TABLE_INGRESS,
+ TABLE_EGRESS,
+ TABLE_TRANSFER,
+ TABLE_RULES_NUMBER,
+ TABLE_ITEM_TEMPLATE,
+ TABLE_ACTION_TEMPLATE,
+
/* Tunnel arguments. */
TUNNEL_CREATE,
TUNNEL_CREATE_TYPE,
@@ -882,6 +898,18 @@ struct buffer {
uint32_t *template_id;
uint32_t template_id_n;
} templ_destroy; /**< Template destroy arguments. */
+ struct {
+ uint32_t id;
+ struct rte_flow_table_attr attr;
+ uint32_t *item_id;
+ uint32_t item_id_n;
+ uint32_t *action_id;
+ uint32_t action_id_n;
+ } table; /**< Table arguments. */
+ struct {
+ uint32_t *table_id;
+ uint32_t table_id_n;
+ } table_destroy; /**< Template destroy arguments. */
struct {
uint32_t *action_id;
uint32_t action_id_n;
@@ -1013,6 +1041,32 @@ static const enum index next_at_destroy_attr[] = {
ZERO,
};
+static const enum index next_table_subcmd[] = {
+ TABLE_CREATE,
+ TABLE_DESTROY,
+ ZERO,
+};
+
+static const enum index next_table_attr[] = {
+ TABLE_CREATE_ID,
+ TABLE_GROUP,
+ TABLE_PRIORITY,
+ TABLE_INGRESS,
+ TABLE_EGRESS,
+ TABLE_TRANSFER,
+ TABLE_RULES_NUMBER,
+ TABLE_ITEM_TEMPLATE,
+ TABLE_ACTION_TEMPLATE,
+ END,
+ ZERO,
+};
+
+static const enum index next_table_destroy_attr[] = {
+ TABLE_DESTROY_ID,
+ END,
+ ZERO,
+};
+
static const enum index next_ia_create_attr[] = {
INDIRECT_ACTION_CREATE_ID,
INDIRECT_ACTION_INGRESS,
@@ -2057,6 +2111,11 @@ static int parse_template(struct context *, const struct
token *,
static int parse_template_destroy(struct context *, const struct token *,
const char *, unsigned int,
void *, unsigned int);
+static int parse_table(struct context *, const struct token *,
+ const char *, unsigned int, void *, unsigned int);
+static int parse_table_destroy(struct context *, const struct token *,
+ const char *, unsigned int,
+ void *, unsigned int);
static int parse_tunnel(struct context *, const struct token *,
const char *, unsigned int,
void *, unsigned int);
@@ -2130,6 +2189,8 @@ static int comp_item_template_id(struct context *, const
struct token *,
unsigned int, char *, unsigned int);
static int comp_action_template_id(struct context *, const struct token *,
unsigned int, char *, unsigned int);
+static int comp_table_id(struct context *, const struct token *,
+ unsigned int, char *, unsigned int);
/** Token definitions. */
static const struct token token_list[] = {
@@ -2294,6 +2355,13 @@ static const struct token token_list[] = {
.call = parse_int,
.comp = comp_action_template_id,
},
+ [COMMON_TABLE_ID] = {
+ .name = "{table_id}",
+ .type = "TABLE_ID",
+ .help = "table id",
+ .call = parse_int,
+ .comp = comp_table_id,
+ },
/* Top-level command. */
[FLOW] = {
.name = "flow",
@@ -2303,6 +2371,7 @@ static const struct token token_list[] = {
(CONFIGURE,
ITEM_TEMPLATE,
ACTION_TEMPLATE,
+ TABLE,
INDIRECT_ACTION,
VALIDATE,
CREATE,
@@ -2474,6 +2543,104 @@ static const struct token token_list[] = {
.call = parse_template,
},
/* Top-level command. */
+ [TABLE] = {
+ .name = "table",
+ .type = "{command} {port_id} [{arg} [...]]",
+ .help = "manage tables",
+ .next = NEXT(next_table_subcmd, NEXT_ENTRY(COMMON_PORT_ID)),
+ .args = ARGS(ARGS_ENTRY(struct buffer, port)),
+ .call = parse_table,
+ },
+ /* Sub-level commands. */
+ [TABLE_CREATE] = {
+ .name = "create",
+ .help = "create table",
+ .next = NEXT(next_table_attr),
+ .call = parse_table,
+ },
+ [TABLE_DESTROY] = {
+ .name = "destroy",
+ .help = "destroy table",
+ .next = NEXT(NEXT_ENTRY(TABLE_DESTROY_ID)),
+ .args = ARGS(ARGS_ENTRY(struct buffer, port)),
+ .call = parse_table_destroy,
+ },
+ /* Table arguments. */
+ [TABLE_CREATE_ID] = {
+ .name = "table_id",
+ .help = "specify table id to create",
+ .next = NEXT(next_table_attr,
+ NEXT_ENTRY(COMMON_TABLE_ID)),
+ .args = ARGS(ARGS_ENTRY(struct buffer, args.table.id)),
+ },
+ [TABLE_DESTROY_ID] = {
+ .name = "table",
+ .help = "specify table id to destroy",
+ .next = NEXT(next_table_destroy_attr,
+ NEXT_ENTRY(COMMON_TABLE_ID)),
+ .args = ARGS(ARGS_ENTRY_PTR(struct buffer,
+ args.table_destroy.table_id)),
+ .call = parse_table_destroy,
+ },
+ [TABLE_GROUP] = {
+ .name = "group",
+ .help = "specify a group",
+ .next = NEXT(next_table_attr, NEXT_ENTRY(COMMON_GROUP_ID)),
+ .args = ARGS(ARGS_ENTRY(struct buffer,
+ args.table.attr.flow_attr.group)),
+ },
+ [TABLE_PRIORITY] = {
+ .name = "priority",
+ .help = "specify a priority level",
+ .next = NEXT(next_table_attr,
NEXT_ENTRY(COMMON_PRIORITY_LEVEL)),
+ .args = ARGS(ARGS_ENTRY(struct buffer,
+ args.table.attr.flow_attr.priority)),
+ },
+ [TABLE_EGRESS] = {
+ .name = "egress",
+ .help = "affect rule to egress",
+ .next = NEXT(next_table_attr),
+ .call = parse_table,
+ },
+ [TABLE_INGRESS] = {
+ .name = "ingress",
+ .help = "affect rule to ingress",
+ .next = NEXT(next_table_attr),
+ .call = parse_table,
+ },
+ [TABLE_TRANSFER] = {
+ .name = "transfer",
+ .help = "affect rule to transfer",
+ .next = NEXT(next_table_attr),
+ .call = parse_table,
+ },
+ [TABLE_RULES_NUMBER] = {
+ .name = "rules_number",
+ .help = "number of rules in table",
+ .next = NEXT(next_table_attr,
+ NEXT_ENTRY(COMMON_UNSIGNED)),
+ .args = ARGS(ARGS_ENTRY(struct buffer,
+ args.table.attr.nb_flows)),
+ },
+ [TABLE_ITEM_TEMPLATE] = {
+ .name = "item_template",
+ .help = "specify item template id",
+ .next = NEXT(next_table_attr,
+ NEXT_ENTRY(COMMON_ITEM_TEMPLATE_ID)),
+ .args = ARGS(ARGS_ENTRY_PTR(struct buffer,
+ args.table.item_id)),
+ .call = parse_table,
+ },
+ [TABLE_ACTION_TEMPLATE] = {
+ .name = "action_template",
+ .help = "specify action template id",
+ .next = NEXT(next_table_attr,
+ NEXT_ENTRY(COMMON_ACTION_TEMPLATE_ID)),
+ .args = ARGS(ARGS_ENTRY_PTR(struct buffer,
+ args.table.action_id)),
+ .call = parse_table,
+ },
+ /* Top-level command. */
[INDIRECT_ACTION] = {
.name = "indirect_action",
.type = "{command} {port_id} [{arg} [...]]",
@@ -7874,6 +8041,119 @@ parse_template_destroy(struct context *ctx, const
struct token *token,
return len;
}
+/** Parse tokens for indirect action commands. */
+static int
+parse_table(struct context *ctx, const struct token *token,
+ const char *str, unsigned int len,
+ void *buf, unsigned int size)
+{
+ struct buffer *out = buf;
+ uint32_t *template_id;
+
+ /* Token name must match. */
+ if (parse_default(ctx, token, str, len, NULL, 0) < 0)
+ return -1;
+ /* Nothing else to do if there is no buffer. */
+ if (!out)
+ return len;
+ if (!out->command) {
+ if (ctx->curr != TABLE)
+ return -1;
+ if (sizeof(*out) > size)
+ return -1;
+ out->command = ctx->curr;
+ ctx->objdata = 0;
+ ctx->object = out;
+ ctx->objmask = NULL;
+ return len;
+ }
+ switch (ctx->curr) {
+ case TABLE_CREATE:
+ out->command = ctx->curr;
+ ctx->objdata = 0;
+ ctx->object = out;
+ ctx->objmask = NULL;
+ out->args.table.id = UINT32_MAX;
+ return len;
+ case TABLE_ITEM_TEMPLATE:
+ out->args.table.item_id =
+ (void *)RTE_ALIGN_CEIL((uintptr_t)(out + 1),
+ sizeof(double));
+ template_id = out->args.table.item_id
+ + out->args.table.item_id_n++;
+ if ((uint8_t *)template_id > (uint8_t *)out + size)
+ return -1;
+ ctx->objdata = 0;
+ ctx->object = template_id;
+ ctx->objmask = NULL;
+ return len;
+ case TABLE_ACTION_TEMPLATE:
+ out->args.table.action_id =
+ (void *)RTE_ALIGN_CEIL((uintptr_t)
+ (out->args.table.item_id +
+ out->args.table.item_id_n),
+ sizeof(double));
+ template_id = out->args.table.action_id
+ + out->args.table.action_id_n++;
+ if ((uint8_t *)template_id > (uint8_t *)out + size)
+ return -1;
+ ctx->objdata = 0;
+ ctx->object = template_id;
+ ctx->objmask = NULL;
+ return len;
+ case TABLE_INGRESS:
+ out->args.table.attr.flow_attr.ingress = 1;
+ return len;
+ case TABLE_EGRESS:
+ out->args.table.attr.flow_attr.egress = 1;
+ return len;
+ case TABLE_TRANSFER:
+ out->args.table.attr.flow_attr.transfer = 1;
+ return len;
+ default:
+ return -1;
+ }
+}
+
+/** Parse tokens for indirect action destroy command. */
+static int
+parse_table_destroy(struct context *ctx, const struct token *token,
+ const char *str, unsigned int len,
+ void *buf, unsigned int size)
+{
+ struct buffer *out = buf;
+ uint32_t *table_id;
+
+ /* Token name must match. */
+ if (parse_default(ctx, token, str, len, NULL, 0) < 0)
+ return -1;
+ /* Nothing else to do if there is no buffer. */
+ if (!out)
+ return len;
+ if (!out->command || out->command == TABLE) {
+ if (ctx->curr != TABLE_DESTROY)
+ return -1;
+ if (sizeof(*out) > size)
+ return -1;
+ out->command = ctx->curr;
+ ctx->objdata = 0;
+ ctx->object = out;
+ ctx->objmask = NULL;
+ out->args.table_destroy.table_id =
+ (void *)RTE_ALIGN_CEIL((uintptr_t)(out + 1),
+ sizeof(double));
+ return len;
+ }
+ table_id = out->args.table_destroy.table_id
+ + out->args.table_destroy.table_id_n++;
+ if ((uint8_t *)table_id > (uint8_t *)out + size)
+ return -1;
+ ctx->objdata = 0;
+ ctx->object = table_id;
+ ctx->objmask = NULL;
+ return len;
+}
+
static int
parse_flex(struct context *ctx, const struct token *token,
const char *str, unsigned int len,
@@ -8889,6 +9169,30 @@ comp_action_template_id(struct context *ctx, const
struct token *token,
return i;
}
+/** Complete available table IDs. */
+static int
+comp_table_id(struct context *ctx, const struct token *token,
+ unsigned int ent, char *buf, unsigned int size)
+{
+ unsigned int i = 0;
+ struct rte_port *port;
+ struct port_table *pt;
+
+ (void)token;
+ if (port_id_is_invalid(ctx->port, DISABLED_WARN) ||
+ ctx->port == (portid_t)RTE_PORT_ALL)
+ return -1;
+ port = &ports[ctx->port];
+ for (pt = port->table_list; pt != NULL; pt = pt->next) {
+ if (buf && i == ent)
+ return snprintf(buf, size, "%u", pt->id);
+ ++i;
+ }
+ if (buf)
+ return -1;
+ return i;
+}
+
/** Internal context. */
static struct context cmd_flow_context;
@@ -9170,6 +9474,17 @@ cmd_flow_parsed(const struct buffer *in)
in->args.templ_destroy.template_id_n,
in->args.templ_destroy.template_id);
break;
+ case TABLE_CREATE:
+ port_flow_table_create(in->port, in->args.table.id,
+ &in->args.table.attr, in->args.table.item_id_n,
+ in->args.table.item_id, in->args.table.action_id_n,
+ in->args.table.action_id);
+ break;
+ case TABLE_DESTROY:
+ port_flow_table_destroy(in->port,
+ in->args.table_destroy.table_id_n,
+ in->args.table_destroy.table_id);
+ break;
case INDIRECT_ACTION_CREATE:
port_action_handle_create(
in->port, in->args.vc.attr.group,
diff --git a/app/test-pmd/config.c b/app/test-pmd/config.c
index 80678d851f..07582fa552 100644
--- a/app/test-pmd/config.c
+++ b/app/test-pmd/config.c
@@ -1638,6 +1638,49 @@ template_alloc(uint32_t id, struct port_template
**template,
return 0;
}
+static int
+table_alloc(uint32_t id, struct port_table **table,
+ struct port_table **list)
+{
+ struct port_table *lst = *list;
+ struct port_table **ppt;
+ struct port_table *pt = NULL;
+
+ *table = NULL;
+ if (id == UINT32_MAX) {
+ /* taking first available ID */
+ if (lst) {
+ if (lst->id == UINT32_MAX - 1) {
+ printf("Highest table ID is already"
+ " assigned, delete it first\n");
+ return -ENOMEM;
+ }
+ id = lst->id + 1;
+ } else {
+ id = 0;
+ }
+ }
+ pt = calloc(1, sizeof(*pt));
+ if (!pt) {
+ printf("Allocation of table failed\n");
+ return -ENOMEM;
+ }
+ ppt = list;
+ while (*ppt && (*ppt)->id > id)
+ ppt = &(*ppt)->next;
+ if (*ppt && (*ppt)->id == id) {
+ printf("Table #%u is already assigned,"
+ " delete it first\n", id);
+ free(pt);
+ return -EINVAL;
+ }
+ pt->next = *ppt;
+ pt->id = id;
+ *ppt = pt;
+ *table = pt;
+ return 0;
+}
+
/** Configure flow management resources. */
int
port_flow_configure(portid_t port_id,
@@ -2243,6 +2286,131 @@ port_flow_action_template_destroy(portid_t port_id,
uint32_t n,
return ret;
}
+/** Create table */
+int
+port_flow_table_create(portid_t port_id, uint32_t id,
+ const struct rte_flow_table_attr *table_attr,
+ uint32_t nb_item_templates, uint32_t *item_templates,
+ uint32_t nb_action_templates, uint32_t *action_templates)
+{
+ struct rte_port *port;
+ struct port_table *pt;
+ struct port_template *temp = NULL;
+ int ret;
+ uint32_t i;
+ struct rte_flow_error error;
+ struct rte_flow_item_template
+ *flow_item_templates[nb_item_templates];
+ struct rte_flow_action_template
+ *flow_action_templates[nb_action_templates];
+
+ if (port_id_is_invalid(port_id, ENABLED_WARN) ||
+ port_id == (portid_t)RTE_PORT_ALL)
+ return -EINVAL;
+ port = &ports[port_id];
+ for (i = 0; i < nb_item_templates; ++i) {
+ bool found = false;
+ temp = port->item_templ_list;
+ while (temp) {
+ if (item_templates[i] == temp->id) {
+ flow_item_templates[i] = temp->template.itempl;
+ found = true;
+ break;
+ }
+ temp = temp->next;
+ }
+ if (!found) {
+ printf("Item template #%u is invalid\n",
+ item_templates[i]);
+ return -EINVAL;
+ }
+ }
+ for (i = 0; i < nb_action_templates; ++i) {
+ bool found = false;
+ temp = port->action_templ_list;
+ while (temp) {
+ if (action_templates[i] == temp->id) {
+ flow_action_templates[i] =
+ temp->template.atempl;
+ found = true;
+ break;
+ }
+ temp = temp->next;
+ }
+ if (!found) {
+ printf("Action template #%u is invalid\n",
+ action_templates[i]);
+ return -EINVAL;
+ }
+ }
+ ret = table_alloc(id, &pt, &port->table_list);
+ if (ret)
+ return ret;
+ /* Poisoning to make sure PMDs update it in case of error. */
+ memset(&error, 0x22, sizeof(error));
+ pt->table = rte_flow_table_create(port_id, table_attr,
+ flow_item_templates, nb_item_templates,
+ flow_action_templates, nb_action_templates,
+ &error);
+
+ if (!pt->table) {
+ uint32_t destroy_id = pt->id;
+ port_flow_table_destroy(port_id, 1, &destroy_id);
+ return port_flow_complain(&error);
+ }
+ printf("Table #%u created\n", pt->id);
+ return 0;
+}
+
+/** Destroy table */
+int
+port_flow_table_destroy(portid_t port_id,
+ uint32_t n, const uint32_t *table)
+{
+ struct rte_port *port;
+ struct port_table **tmp;
+ uint32_t c = 0;
+ int ret = 0;
+
+ if (port_id_is_invalid(port_id, ENABLED_WARN) ||
+ port_id == (portid_t)RTE_PORT_ALL)
+ return -EINVAL;
+ port = &ports[port_id];
+ tmp = &port->table_list;
+ while (*tmp) {
+ uint32_t i;
+
+ for (i = 0; i != n; ++i) {
+ struct rte_flow_error error;
+ struct port_table *pt = *tmp;
+
+ if (table[i] != pt->id)
+ continue;
+ /*
+ * Poisoning to make sure PMDs update it in case
+ * of error.
+ */
+ memset(&error, 0x33, sizeof(error));
+
+ if (pt->table &&
+ rte_flow_table_destroy(port_id,
+ pt->table,
+ &error)) {
+ ret = port_flow_complain(&error);
+ continue;
+ }
+ *tmp = pt->next;
+ printf("Table #%u destroyed\n", pt->id);
+ free(pt);
+ break;
+ }
+ if (i == n)
+ tmp = &(*tmp)->next;
+ ++c;
+ }
+ return ret;
+}
+
/** Create flow rule. */
int
port_flow_create(portid_t port_id,
diff --git a/app/test-pmd/testpmd.h b/app/test-pmd/testpmd.h
index 4befa6d7a4..b8655b9987 100644
--- a/app/test-pmd/testpmd.h
+++ b/app/test-pmd/testpmd.h
@@ -177,6 +177,14 @@ struct port_template {
} template; /**< PMD opaque template object */
};
+/** Descriptor for a flow table. */
+struct port_table {
+ struct port_table *next; /**< Next table in list. */
+ struct port_table *tmp; /**< Temporary linking. */
+ uint32_t id; /**< Table ID. */
+ struct rte_flow_table *table; /**< PMD opaque template object */
+};
+
/** Descriptor for a single flow. */
struct port_flow {
struct port_flow *next; /**< Next flow in list. */
@@ -259,6 +267,7 @@ struct rte_port {
uint8_t slave_flag; /**< bonding slave port */
struct port_template *item_templ_list; /**< Item templates. */
struct port_template *action_templ_list; /**< Action templates. */
+ struct port_table *table_list; /**< Flow tables. */
struct port_flow *flow_list; /**< Associated flows. */
struct port_indirect_action *actions_list;
/**< Associated indirect actions. */
@@ -912,6 +921,12 @@ int port_flow_action_template_create(portid_t port_id,
uint32_t id,
const struct rte_flow_action *masks);
int port_flow_action_template_destroy(portid_t port_id, uint32_t n,
const uint32_t *template);
+int port_flow_table_create(portid_t port_id, uint32_t id,
+ const struct rte_flow_table_attr *table_attr,
+ uint32_t nb_item_templates, uint32_t *item_templates,
+ uint32_t nb_action_templates, uint32_t *action_templates);
+int port_flow_table_destroy(portid_t port_id,
+ uint32_t n, const uint32_t *table);
int port_flow_validate(portid_t port_id,
const struct rte_flow_attr *attr,
const struct rte_flow_item *pattern,
diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index d23cfa6572..f8a87564be 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -3335,6 +3335,19 @@ following sections.
flow action_template {port_id} destroy action_template {id} [...]
+- Create a table::
+
+ flow table {port_id} create
+ [table_id {id}]
+ [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
+ rules_number {number}
+ item_template {item_template_id}
+ action_template {action_template_id}
+
+- Destroy a table::
+
+ flow table {port_id} destroy table {id} [...]
+
- Check whether a flow rule can be created::
flow validate {port_id}
@@ -3495,6 +3508,46 @@ The usual error message is shown when an item template
cannot be destroyed::
Caught error type [...] ([...]): [...]
+Creating flow table
+~~~~~~~~~~~~~~~~~~~
+
+``flow table create`` creates the specified flow table.
+It is bound to ``rte_flow_table_create()``::
+
+ flow table {port_id} create
+ [table_id {id}] [group {group_id}]
+ [priority {level}] [ingress] [egress] [transfer]
+ rules_number {number}
+ item_template {item_template_id}
+ action_template {action_template_id}
+
+If successful, it will show::
+
+ Table #[...] created
+
+Otherwise it will show an error message of the form::
+
+ Caught error type [...] ([...]): [...]
+
+Destroying flow table
+~~~~~~~~~~~~~~~~~~~~~
+
+``flow table destroy`` destroys one or more flow tables
+from their table ID (as returned by ``flow table create``),
+this command calls ``rte_flow_table_destroy()`` as many
+times as necessary::
+
+ flow table {port_id} destroy table {id} [...]
+
+If successful, it will show::
+
+ Table #[...] destroyed
+
+It does not report anything for table IDs that do not exist.
+The usual error message is shown when a table cannot be destroyed::
+
+ Caught error type [...] ([...]): [...]
+
Creating a tunnel stub for offload
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
2.18.2
