Skip to contentSkip to conversation

ethdev: add calculate hash function

PATCH Superseded Ori Kam 4 participants 8 messages Sep 26, 2023 – Oct 11, 2023

lore
Share & tools
lore

Ori Kam

author
#0 lore raw

PATCH 1/1 ethdev: add calculate hash function

rte_flow supports insert by index table[1].

Using the above table, the application can create rules
that are based on hash.
For example application can create the following logic in order to create load balancing:
1. Create insert by index table with 2 rules, that hashes based on dmac
2. Insert to index 0 a rule that sends the traffic to port A.
3. Insert to index 1 a rule that sends the traffic to port B.

Let's also assume that before this table, there is a 5 tuple match table that jumps to the above table.

So each packet that matches one of the 5 tuple rules is RSSed to port A or B, based on dmac hash.

The issue arises when there is a miss on the 5 tuple table, which resulted due to the packet being the first packet of this flow, or fragmented packet or any other reason.
In this case, the application must calculate what would be the hash calculated by the HW so it can send the packet to the correct port.

This new API allows applications to calculate the hash value of a given packet for a given table.

[1] - http://patches.dpdk.org/project/dpdk/patch/[email protected]/

Signed-off-by Ori Kam <[email protected]>
---
 app/test-pmd/cmdline_flow.c  | 86 +++++++++++++++++++++++++++++++++++-
 app/test-pmd/config.c        | 54 ++++++++++++++++++++++
 app/test-pmd/testpmd.h       |  2 +
 lib/ethdev/rte_flow.c        | 21 +++++++++
 lib/ethdev/rte_flow.h        | 32 ++++++++++++++
 lib/ethdev/rte_flow_driver.h |  5 +++
 lib/ethdev/version.map       |  1 +
 7 files changed, 200 insertions(+), 1 deletion(-)
app/test-pmd/cmdline_flow.c +85 -1
index 94827bcc4a..e1e4bb49fa 100644
@@ -101,6 +101,7 @@ enum index {
 	QUEUE,
 	PUSH,
 	PULL,
+	HASH,
 
 	/* Flex arguments */
 	FLEX_ITEM_INIT,

@@ -206,6 +207,11 @@ enum index {
 	TABLE_PATTERN_TEMPLATE,
 	TABLE_ACTIONS_TEMPLATE,
 
+	/* Hash calculation arguments. */
+	HASH_CALC_TABLE,
+	HASH_CALC_PATTERN_INDEX,
+	HASH_CALC_PATTERN,
+
 	/* Tunnel arguments. */
 	TUNNEL_CREATE,
 	TUNNEL_CREATE_TYPE,

@@ -2678,6 +2684,9 @@ static int parse_push(struct context *, const struct token *,
 static int parse_pull(struct context *, const struct token *,
 		      const char *, unsigned int,
 		      void *, unsigned int);
+static int parse_hash(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);

@@ -3035,7 +3044,8 @@ static const struct token token_list[] = {
 			      FLEX,
 			      QUEUE,
 			      PUSH,
-			      PULL)),
+			      PULL,
+			      HASH)),
 		.call = parse_init,
 	},
 	/* Top-level command. */

@@ -3680,6 +3690,33 @@ static const struct token token_list[] = {
 		.args = ARGS(ARGS_ENTRY(struct buffer, queue)),
 	},
 	/* Top-level command. */
+	[HASH] = {
+		.name = "hash",
+		.help = "calculate hash for a given pattern in a given template table",
+		.next = NEXT(NEXT_ENTRY(HASH_CALC_TABLE), NEXT_ENTRY(COMMON_PORT_ID)),
+		.args = ARGS(ARGS_ENTRY(struct buffer, port)),
+		.call = parse_hash,
+	},
+	/* Sub-level commands. */
+	[HASH_CALC_TABLE] = {
+		.name = "template_table",
+		.help = "specify table id",
+		.next = NEXT(NEXT_ENTRY(HASH_CALC_PATTERN_INDEX),
+			     NEXT_ENTRY(COMMON_TABLE_ID)),
+		.args = ARGS(ARGS_ENTRY(struct buffer,
+					args.vc.table_id)),
+		.call = parse_hash,
+	},
+	[HASH_CALC_PATTERN_INDEX] = {
+		.name = "pattern_template",
+		.help = "specify pattern template id",
+		.next = NEXT(NEXT_ENTRY(ITEM_PATTERN),
+			     NEXT_ENTRY(COMMON_UNSIGNED)),
+		.args = ARGS(ARGS_ENTRY(struct buffer,
+					args.vc.pat_templ_id)),
+		.call = parse_hash,
+	},
+	/* Top-level command. */
 	[INDIRECT_ACTION] = {
 		.name = "indirect_action",
 		.type = "{command} {port_id} [{arg} [...]]",

@@ -10449,6 +10486,48 @@ parse_pull(struct context *ctx, const struct token *token,
 	return len;
 }
 
+/** Parse tokens for hash calculation commands. */
+static int
+parse_hash(struct context *ctx, const struct token *token,
+	 const char *str, unsigned int len,
+	 void *buf, unsigned int size)
+{
+	struct buffer *out = buf;
+
+	/* 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 != HASH)
+			return -1;
+		if (sizeof(*out) > size)
+			return -1;
+		out->command = ctx->curr;
+		ctx->objdata = 0;
+		ctx->object = out;
+		ctx->objmask = NULL;
+		out->args.vc.data = (uint8_t *)out + size;
+		return len;
+	}
+	switch (ctx->curr) {
+	case HASH_CALC_TABLE:
+	case HASH_CALC_PATTERN_INDEX:
+		return len;
+	case ITEM_PATTERN:
+		out->args.vc.pattern =
+			(void *)RTE_ALIGN_CEIL((uintptr_t)(out + 1),
+					       sizeof(double));
+		ctx->object = out->args.vc.pattern;
+		ctx->objmask = NULL;
+		return len;
+	default:
+		return -1;
+	}
+}
+
 static int
 parse_flex(struct context *ctx, const struct token *token,
 	     const char *str, unsigned int len,

@@ -12351,6 +12430,11 @@ cmd_flow_parsed(const struct buffer *in)
 	case PULL:
 		port_queue_flow_pull(in->port, in->queue);
 		break;
+	case HASH:
+		port_flow_hash_calc(in->port, in->args.vc.table_id,
+				    in->args.vc.pat_templ_id,
+				    in->args.vc.pattern);
+		break;
 	case QUEUE_AGED:
 		port_queue_flow_aged(in->port, in->queue,
 				     in->args.aged.destroy);
app/test-pmd/config.c +54 -0

66 lines not on this page · raw message

app/test-pmd/testpmd.h +2 -0
index f1df6a8faf..4637a47c06 100644
@@ -1009,6 +1009,8 @@ port_queue_action_handle_query_update(portid_t port_id,
 				      const struct rte_flow_action *action);
 int port_queue_flow_push(portid_t port_id, queueid_t queue_id);
 int port_queue_flow_pull(portid_t port_id, queueid_t queue_id);
+int port_flow_hash_calc(portid_t port_id, uint32_t table_id,
+			uint8_t pattern_template_index, const struct rte_flow_item pattern[]);
 void port_queue_flow_aged(portid_t port_id, uint32_t queue_id, uint8_t destroy);
 int port_flow_validate(portid_t port_id,
 		       const struct rte_flow_attr *attr,
lib/ethdev/rte_flow.c +21 -0
index 271d854f78..5f7dcdfdad 100644
@@ -2431,3 +2431,24 @@ rte_flow_async_action_list_handle_query_update(uint16_t port_id, uint32_t queue_
 							     ret);
 	return ret;
 }
+
+int
+rte_flow_calc_table_hash(uint16_t port_id, const struct rte_flow_template_table *table,
+			 const struct rte_flow_item pattern[], uint8_t pattern_template_index,
+			 uint32_t *hash, struct rte_flow_error *error)
+{
+	int ret;
+	struct rte_eth_dev *dev;
+	const struct rte_flow_ops *ops;
+
+	RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
+	ops = rte_flow_ops_get(port_id, error);
+	if (!ops || !ops->flow_calc_table_hash)
+		return rte_flow_error_set(error, ENOTSUP,
+					  RTE_FLOW_ERROR_TYPE_UNSPECIFIED, NULL,
+					  "action_list async query_update not supported");
+	dev = &rte_eth_devices[port_id];
+	ret = ops->flow_calc_table_hash(dev, table, pattern, pattern_template_index,
+					hash, error);
+	return flow_err(port_id, ret, error);
+}
lib/ethdev/rte_flow.h +32 -0
index 23addb4382..b8c28394a1 100644
@@ -6624,6 +6624,38 @@ rte_flow_async_action_list_handle_query_update(uint16_t port_id, uint32_t queue_
 					  void *user_data,
 					  struct rte_flow_error *error);
 
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice.
+ *
+ * Calculate the hash for a given pattern in a given table as
+ * calculated by the HW.
+ *
+ * @param port_id
+ *   Port identifier of Ethernet device.
+ * @param table
+ *   The table the SW wishes to simulate.
+ * @param pattern
+ *   The values to be used in the hash calculation.
+ * @param pattern_template_index
+ *   The pattern index in the table to be used for the calculation.
+ * @param hash
+ *   Used to return the calculated hash.
+ * @param error
+ *   Perform verbose error reporting if not NULL.
+ *   PMDs initialize this structure in case of error only.
+ *
+ * @return
+ *   - (0) if success.
+ *   - (-ENODEV) if *port_id* invalid.
+ *   - (-ENOTSUP) if underlying device does not support this functionality.
+ */
+__rte_experimental
+int
+rte_flow_calc_table_hash(uint16_t port_id, const struct rte_flow_template_table *table,
+			 const struct rte_flow_item pattern[], uint8_t pattern_template_index,
+			 uint32_t *hash, struct rte_flow_error *error);
+
 #ifdef __cplusplus
 }
 #endif
lib/ethdev/rte_flow_driver.h +5 -0
index f9fb01b8a2..aa8635b1a8 100644
@@ -358,6 +358,11 @@ struct rte_flow_ops {
 		 const void **update, void **query,
 		 enum rte_flow_query_update_mode mode,
 		 void *user_data, struct rte_flow_error *error);
+	/** @see rte_flow_calc_table_hash() */
+	int (*flow_calc_table_hash)
+		(struct rte_eth_dev *dev, const struct rte_flow_template_table *table,
+		 const struct rte_flow_item pattern[], uint8_t pattern_template_index,
+		 uint32_t *hash, struct rte_flow_error *error);
 };
 
 /**
lib/ethdev/version.map +1 -0
index b965d6aa52..1496d8caa6 100644
@@ -312,6 +312,7 @@ EXPERIMENTAL {
 	rte_flow_async_action_list_handle_query_update;
 	rte_flow_async_actions_update;
 	rte_flow_restore_info_dynflag;
+	rte_flow_calc_table_hash;
 };
 
 INTERNAL {
Signature · 1 line
2.34.1
Acked-by on v1 1/1
#1 lore raw

Hi,

Quoted 36 lines

-----Original Message-----
From: Ori Kam <[email protected]>
Sent: Tuesday, September 26, 2023 13:38
To: [email protected]; Aman Singh <[email protected]>; Yuying Zhang <[email protected]>; NBU-Contact-Thomas Monjalon (EXTERNAL) <[email protected]>; Ferruh Yigit <[email protected]>; Andrew Rybchenko <[email protected]>
Cc: [email protected]; Ori Kam <[email protected]>; Raslan Darawsheh <[email protected]>
Subject: [PATCH] ethdev: add calculate hash function

External email: Use caution opening links or attachments

rte_flow supports insert by index table[1].

Using the above table, the application can create rules that are based on hash. For example application can create the following logic in order to create load balancing:
1. Create insert by index table with 2 rules, that hashes based on dmac 2. Insert to index 0 a rule that sends the traffic to port A.
3. Insert to index 1 a rule that sends the traffic to port B.

Let's also assume that before this table, there is a 5 tuple match table that jumps to the above table.

So each packet that matches one of the 5 tuple rules is RSSed to port A or B, based on dmac hash.

The issue arises when there is a miss on the 5 tuple table, which resulted due to the packet being the first packet of this flow, or fragmented packet or any other reason.
In this case, the application must calculate what would be the hash calculated by the HW so it can send the packet to the correct port.

Quoted 8 lines

This new API allows applications to calculate the hash value of a given packet for a given table.

[1] -
http://patches.dpdk.org/project/dpdk/patch/20230208030624.78465-2-
[email protected]/

Signed-off-by Ori Kam <[email protected]>
Acked-by Dariusz Sosnowski <[email protected]>

Thanks,
Dariusz Sosnowski

#2 lore raw
In reply to Ori Kam
Quoted 29 lines · Ori Kam

rte_flow supports insert by index table[1].

Using the above table, the application can create rules
that are based on hash.
For example application can create the following logic in order to create load balancing:
1. Create insert by index table with 2 rules, that hashes based on dmac
2. Insert to index 0 a rule that sends the traffic to port A.
3. Insert to index 1 a rule that sends the traffic to port B.

Let's also assume that before this table, there is a 5 tuple match table that jumps to the above table.

So each packet that matches one of the 5 tuple rules is RSSed to port A or B, based on dmac hash.

The issue arises when there is a miss on the 5 tuple table, which resulted due to the packet being the first packet of this flow, or fragmented packet or any other reason.
In this case, the application must calculate what would be the hash calculated by the HW so it can send the packet to the correct port.

This new API allows applications to calculate the hash value of a given packet for a given table.

[1] - http://patches.dpdk.org/project/dpdk/patch/[email protected]/

Signed-off-by Ori Kam <[email protected]>
Quoted 10 lines
---
 app/test-pmd/cmdline_flow.c  | 86 +++++++++++++++++++++++++++++++++++-
 app/test-pmd/config.c        | 54 ++++++++++++++++++++++
 app/test-pmd/testpmd.h       |  2 +
 lib/ethdev/rte_flow.c        | 21 +++++++++
 lib/ethdev/rte_flow.h        | 32 ++++++++++++++
 lib/ethdev/rte_flow_driver.h |  5 +++
 lib/ethdev/version.map       |  1 +
 7 files changed, 200 insertions(+), 1 deletion(-)

This is a new rte_flow API but unfortunately there isn't any review/comment, at least it is experimental API. If there is no objection/discussion in next few days, I will merge the feature.

Probably it will be another rte flow feature that only NVIDIA knows and uses. While mentioned from using, is the driver update for the feature planned for this release?

Meanwhile, can you please update the documentation, rte_flow.rst and testpmd_funcs.rst?
Also can you please rebase on top of latest next-net, this patch conflicts with merged group set miss action feature.

author
#3 lore raw

Hi Ferruh,

Quoted 47 lines

-----Original Message-----
From: Ferruh Yigit <[email protected]>
Sent: Tuesday, October 10, 2023 2:06 PM

Quoted 23 lines · Ori Kam

rte_flow supports insert by index table[1].

Using the above table, the application can create rules
that are based on hash.
For example application can create the following logic in order to create load balancing:
1. Create insert by index table with 2 rules, that hashes based on dmac
2. Insert to index 0 a rule that sends the traffic to port A.
3. Insert to index 1 a rule that sends the traffic to port B.

Let's also assume that before this table, there is a 5 tuple match table that jumps to the above table.

So each packet that matches one of the 5 tuple rules is RSSed to port A or B, based on dmac hash.

The issue arises when there is a miss on the 5 tuple table, which resulted due to the packet being the first packet of this flow, or fragmented packet or any other reason.
In this case, the application must calculate what would be the hash calculated by the HW so it can send the packet to the correct port.

Quoted 4 lines

This new API allows applications to calculate the hash value of a given packet for a given table.

[1] - http://patches.dpdk.org/project/dpdk/patch/20230208030624.78465-2-

[email protected]/

Quoted 4 lines
Signed-off-by Ori Kam <[email protected]>
---
 app/test-pmd/cmdline_flow.c  | 86

+++++++++++++++++++++++++++++++++++-

Quoted 8 lines
 app/test-pmd/config.c        | 54 ++++++++++++++++++++++
 app/test-pmd/testpmd.h       |  2 +
 lib/ethdev/rte_flow.c        | 21 +++++++++
 lib/ethdev/rte_flow.h        | 32 ++++++++++++++
 lib/ethdev/rte_flow_driver.h |  5 +++
 lib/ethdev/version.map       |  1 +
 7 files changed, 200 insertions(+), 1 deletion(-)
Quoted 4 lines

This is a new rte_flow API but unfortunately there isn't any review/comment, at least it is experimental API. If there is no objection/discussion in next few days, I will merge the feature.

Thanks,

Quoted 4 lines

Probably it will be another rte flow feature that only NVIDIA knows and uses. While mentioned from using, is the driver update for the feature planned for this release?

Yes, I hope to send the mlx5 patches in a few days.

Quoted 5 lines

Meanwhile, can you please update the documentation, rte_flow.rst and testpmd_funcs.rst?
Also can you please rebase on top of latest next-net, this patch conflicts with merged group set miss action feature.

Sure

#4 lore raw
In reply to Ferruh Yigit

Hi,

Quoted 41 lines · Ferruh Yigit
Quoted 29 lines · Ori Kam

rte_flow supports insert by index table[1].

Using the above table, the application can create rules
that are based on hash.
For example application can create the following logic in order to create load balancing:
1. Create insert by index table with 2 rules, that hashes based on dmac
2. Insert to index 0 a rule that sends the traffic to port A.
3. Insert to index 1 a rule that sends the traffic to port B.

Let's also assume that before this table, there is a 5 tuple match table that jumps to the above table.

So each packet that matches one of the 5 tuple rules is RSSed to port A or B, based on dmac hash.

The issue arises when there is a miss on the 5 tuple table, which resulted due to the packet being the first packet of this flow, or fragmented packet or any other reason.
In this case, the application must calculate what would be the hash calculated by the HW so it can send the packet to the correct port.

This new API allows applications to calculate the hash value of a given packet for a given table.

[1] - http://patches.dpdk.org/project/dpdk/patch/[email protected]/

Signed-off-by Ori Kam <[email protected]>
Quoted 10 lines
---
 app/test-pmd/cmdline_flow.c  | 86 +++++++++++++++++++++++++++++++++++-
 app/test-pmd/config.c        | 54 ++++++++++++++++++++++
 app/test-pmd/testpmd.h       |  2 +
 lib/ethdev/rte_flow.c        | 21 +++++++++
 lib/ethdev/rte_flow.h        | 32 ++++++++++++++
 lib/ethdev/rte_flow_driver.h |  5 +++
 lib/ethdev/version.map       |  1 +
 7 files changed, 200 insertions(+), 1 deletion(-)
Quoted 6 lines

This is a new rte_flow API but unfortunately there isn't any review/comment, at least it is experimental API. If there is no objection/discussion in next few days, I will merge the feature.

Probably it will be another rte flow feature that only NVIDIA knows and uses. While mentioned from using, is the driver update for the feature

The hns3 driver support subset of rte_flow, we found the rte_flow feature is very flexible. And its implementation varies according to vendors.

Can the rte_flow be standardized ?

Quoted 10 lines

planned for this release?

Meanwhile, can you please update the documentation, rte_flow.rst and testpmd_funcs.rst?
Also can you please rebase on top of latest next-net, this patch conflicts with merged group set miss action feature.

.

#5 lore raw
Quoted 48 lines · fengchengwen

Hi,

Quoted 45 lines · Ferruh Yigit
Quoted 29 lines · Ori Kam

rte_flow supports insert by index table[1].

Using the above table, the application can create rules
that are based on hash.
For example application can create the following logic in order to create load balancing:
1. Create insert by index table with 2 rules, that hashes based on dmac
2. Insert to index 0 a rule that sends the traffic to port A.
3. Insert to index 1 a rule that sends the traffic to port B.

Let's also assume that before this table, there is a 5 tuple match table that jumps to the above table.

So each packet that matches one of the 5 tuple rules is RSSed to port A or B, based on dmac hash.

The issue arises when there is a miss on the 5 tuple table, which resulted due to the packet being the first packet of this flow, or fragmented packet or any other reason.
In this case, the application must calculate what would be the hash calculated by the HW so it can send the packet to the correct port.

This new API allows applications to calculate the hash value of a given packet for a given table.

[1] - http://patches.dpdk.org/project/dpdk/patch/[email protected]/

Signed-off-by Ori Kam <[email protected]>
Quoted 10 lines
---
 app/test-pmd/cmdline_flow.c  | 86 +++++++++++++++++++++++++++++++++++-
 app/test-pmd/config.c        | 54 ++++++++++++++++++++++
 app/test-pmd/testpmd.h       |  2 +
 lib/ethdev/rte_flow.c        | 21 +++++++++
 lib/ethdev/rte_flow.h        | 32 ++++++++++++++
 lib/ethdev/rte_flow_driver.h |  5 +++
 lib/ethdev/version.map       |  1 +
 7 files changed, 200 insertions(+), 1 deletion(-)

This is a new rte_flow API but unfortunately there isn't any review/comment, at least it is experimental API. If there is no objection/discussion in next few days, I will merge the feature.

Quoted 8 lines
Quoted 2 lines

Probably it will be another rte flow feature that only NVIDIA knows and uses. While mentioned from using, is the driver update for the feature

The hns3 driver support subset of rte_flow, we found the rte_flow feature is very flexible. And its implementation varies according to vendors.

Can the rte_flow be standardized ?

Hi Chengwen,

Yes rte_flow is already implemented by many vendors, each uses some subset of it. It is flexible and useful, no concern about it.

My point was, most of the new rte_flow features are coming from single vendor and most of them are not fully reviewed by the wider community.

As some of the features merged without much review from wider community, not everyone aware of them, and features are not fully benefited from, although that is somewhat related to HW support as Jerin pointed before.

As hns3 is a user of the rte_flow already, it would be great to get more feedback and review from hns3 maintainers, that boosts the confidence to the new proposed features/APIs.

Thanks,
ferruh

Quoted 10 lines
Quoted 10 lines

planned for this release?

Meanwhile, can you please update the documentation, rte_flow.rst and testpmd_funcs.rst?
Also can you please rebase on top of latest next-net, this patch conflicts with merged group set miss action feature.

.

author
#6 lore raw

PATCH v2 1/1 ethdev: add calculate hash function

In reply to Ori Kam

rte_flow supports insert by index table[1].

Using the above table, the application can create rules
that are based on hash.
For example application can create the following logic in order to create load balancing:
1. Create insert by index table with 2 rules, that hashes based on dmac
2. Insert to index 0 a rule that sends the traffic to port A.
3. Insert to index 1 a rule that sends the traffic to port B.

Let's also assume that before this table, there is a 5 tuple match table that jumps to the above table.

So each packet that matches one of the 5 tuple rules is RSSed to port A or B, based on dmac hash.

The issue arises when there is a miss on the 5 tuple table, which resulted due to the packet being the first packet of this flow, or fragmented packet or any other reason.
In this case, the application must calculate what would be the hash calculated by the HW so it can send the packet to the correct port.

This new API allows applications to calculate the hash value of a given packet for a given table.

[1] - http://patches.dpdk.org/project/dpdk/patch/[email protected]/

Signed-off-by Ori Kam <[email protected]>

---

v2: add rst documentations

---
 app/test-pmd/cmdline_flow.c                 | 86 ++++++++++++++++++++-
 app/test-pmd/config.c                       | 54 +++++++++++++
 app/test-pmd/testpmd.h                      |  2 +
 doc/guides/prog_guide/rte_flow.rst          | 17 ++++
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 22 ++++++
 lib/ethdev/rte_flow.c                       | 21 +++++
 lib/ethdev/rte_flow.h                       | 32 ++++++++
 lib/ethdev/rte_flow_driver.h                |  5 ++
 lib/ethdev/version.map                      |  1 +
 9 files changed, 239 insertions(+), 1 deletion(-)
app/test-pmd/cmdline_flow.c +85 -1
index 12809f1042..dd66429554 100644
@@ -102,6 +102,7 @@ enum index {
 	QUEUE,
 	PUSH,
 	PULL,
+	HASH,
 
 	/* Flex arguments */
 	FLEX_ITEM_INIT,

@@ -214,6 +215,11 @@ enum index {
 	GROUP_TRANSFER,
 	GROUP_SET_MISS_ACTIONS,
 
+	/* Hash calculation arguments. */
+	HASH_CALC_TABLE,
+	HASH_CALC_PATTERN_INDEX,
+	HASH_CALC_PATTERN,
+
 	/* Tunnel arguments. */
 	TUNNEL_CREATE,
 	TUNNEL_CREATE_TYPE,

@@ -2708,6 +2714,9 @@ static int parse_pull(struct context *, const struct token *,
 static int parse_group(struct context *, const struct token *,
 		       const char *, unsigned int,
 		       void *, unsigned int);
+static int parse_hash(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);

@@ -3066,7 +3075,8 @@ static const struct token token_list[] = {
 			      FLEX,
 			      QUEUE,
 			      PUSH,
-			      PULL)),
+			      PULL,
+			      HASH)),
 		.call = parse_init,
 	},
 	/* Top-level command. */

@@ -3751,6 +3761,33 @@ static const struct token token_list[] = {
 		.args = ARGS(ARGS_ENTRY(struct buffer, queue)),
 	},
 	/* Top-level command. */
+	[HASH] = {
+		.name = "hash",
+		.help = "calculate hash for a given pattern in a given template table",
+		.next = NEXT(NEXT_ENTRY(HASH_CALC_TABLE), NEXT_ENTRY(COMMON_PORT_ID)),
+		.args = ARGS(ARGS_ENTRY(struct buffer, port)),
+		.call = parse_hash,
+	},
+	/* Sub-level commands. */
+	[HASH_CALC_TABLE] = {
+		.name = "template_table",
+		.help = "specify table id",
+		.next = NEXT(NEXT_ENTRY(HASH_CALC_PATTERN_INDEX),
+			     NEXT_ENTRY(COMMON_TABLE_ID)),
+		.args = ARGS(ARGS_ENTRY(struct buffer,
+					args.vc.table_id)),
+		.call = parse_hash,
+	},
+	[HASH_CALC_PATTERN_INDEX] = {
+		.name = "pattern_template",
+		.help = "specify pattern template id",
+		.next = NEXT(NEXT_ENTRY(ITEM_PATTERN),
+			     NEXT_ENTRY(COMMON_UNSIGNED)),
+		.args = ARGS(ARGS_ENTRY(struct buffer,
+					args.vc.pat_templ_id)),
+		.call = parse_hash,
+	},
+	/* Top-level command. */
 	[INDIRECT_ACTION] = {
 		.name = "indirect_action",
 		.type = "{command} {port_id} [{arg} [...]]",

@@ -10544,6 +10581,48 @@ parse_pull(struct context *ctx, const struct token *token,
 	return len;
 }
 
+/** Parse tokens for hash calculation commands. */
+static int
+parse_hash(struct context *ctx, const struct token *token,
+	 const char *str, unsigned int len,
+	 void *buf, unsigned int size)
+{
+	struct buffer *out = buf;
+
+	/* 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 != HASH)
+			return -1;
+		if (sizeof(*out) > size)
+			return -1;
+		out->command = ctx->curr;
+		ctx->objdata = 0;
+		ctx->object = out;
+		ctx->objmask = NULL;
+		out->args.vc.data = (uint8_t *)out + size;
+		return len;
+	}
+	switch (ctx->curr) {
+	case HASH_CALC_TABLE:
+	case HASH_CALC_PATTERN_INDEX:
+		return len;
+	case ITEM_PATTERN:
+		out->args.vc.pattern =
+			(void *)RTE_ALIGN_CEIL((uintptr_t)(out + 1),
+					       sizeof(double));
+		ctx->object = out->args.vc.pattern;
+		ctx->objmask = NULL;
+		return len;
+	default:
+		return -1;
+	}
+}
+
 static int
 parse_group(struct context *ctx, const struct token *token,
 	    const char *str, unsigned int len,

@@ -12498,6 +12577,11 @@ cmd_flow_parsed(const struct buffer *in)
 	case PULL:
 		port_queue_flow_pull(in->port, in->queue);
 		break;
+	case HASH:
+		port_flow_hash_calc(in->port, in->args.vc.table_id,
+				    in->args.vc.pat_templ_id,
+				    in->args.vc.pattern);
+		break;
 	case QUEUE_AGED:
 		port_queue_flow_aged(in->port, in->queue,
 				     in->args.aged.destroy);
app/test-pmd/config.c +54 -0

66 lines not on this page · raw message

app/test-pmd/testpmd.h +2 -0
index e236845a81..dec333a8fa 100644
@@ -1014,6 +1014,8 @@ port_queue_action_handle_query_update(portid_t port_id,
 				      const struct rte_flow_action *action);
 int port_queue_flow_push(portid_t port_id, queueid_t queue_id);
 int port_queue_flow_pull(portid_t port_id, queueid_t queue_id);
+int port_flow_hash_calc(portid_t port_id, uint32_t table_id,
+			uint8_t pattern_template_index, const struct rte_flow_item pattern[]);
 void port_queue_flow_aged(portid_t port_id, uint32_t queue_id, uint8_t destroy);
 int port_flow_validate(portid_t port_id,
 		       const struct rte_flow_attr *attr,
doc/guides/prog_guide/rte_flow.rst +17 -0
index 860e42025f..a11eb2977a 100644
@@ -4173,6 +4173,23 @@ User data may be provided during a flow creation/destruction in order
 to distinguish between multiple operations. User data is returned as part
 of the result to provide a method to detect which operation is completed.
 
+Calculate hash
+~~~~~~~~~~~~~~
+
+Calculating hash of a packet in SW as it would be calculated in HW.
+
+The application can use this function to calculate the hash of a given packet
+as it would be calculated in the HW.
+
+.. code-block:: c
+
+   int
+   rte_flow_calc_table_hash(uint16_t port_id,
+                            const struct rte_flow_template_table *table,
+			                   const struct rte_flow_item pattern[],
+                            uint8_t pattern_template_index,
+			                   uint32_t *hash, struct rte_flow_error *error);
+
 .. _flow_isolated_mode:
 
 Flow isolated mode
doc/guides/testpmd_app_ug/testpmd_funcs.rst +22 -0
index e6d218caaa..1006239d86 100644
@@ -3276,6 +3276,28 @@ The usual error message is shown when operations results cannot be pulled::
 
    Caught error type [...] ([...]): [...]
 
+Calculating hash
+~~~~~~~~~~~~~~~~
+
+``flow hash`` calculates the hash for a given pattern.
+It is bound to ``rte_flow_calc_table_hash()``::
+
+   flow hash {port_id} template_table {table_id}
+       pattern_template {pattern_template_index}
+       actions_template {actions_template_index}
+       pattern {item} [/ {item} [...]] / end
+
+If successful, it will show the calculated hash result as seen below::
+
+   Hash results 0x[...]
+
+Otherwise, it will show an error message of the form::
+
+   Caught error type [...] ([...]): [...]
+
+This command uses the same pattern items as ``flow create``,
+their format is described in `Creating flow rules`_.
+
 Creating a tunnel stub for offload
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/ethdev/rte_flow.c +21 -0
index c9d23da702..6917fbd262 100644
@@ -2454,3 +2454,24 @@ rte_flow_async_action_list_handle_query_update(uint16_t port_id, uint32_t queue_
 							     ret);
 	return ret;
 }
+
+int
+rte_flow_calc_table_hash(uint16_t port_id, const struct rte_flow_template_table *table,
+			 const struct rte_flow_item pattern[], uint8_t pattern_template_index,
+			 uint32_t *hash, struct rte_flow_error *error)
+{
+	int ret;
+	struct rte_eth_dev *dev;
+	const struct rte_flow_ops *ops;
+
+	RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
+	ops = rte_flow_ops_get(port_id, error);
+	if (!ops || !ops->flow_calc_table_hash)
+		return rte_flow_error_set(error, ENOTSUP,
+					  RTE_FLOW_ERROR_TYPE_UNSPECIFIED, NULL,
+					  "action_list async query_update not supported");
+	dev = &rte_eth_devices[port_id];
+	ret = ops->flow_calc_table_hash(dev, table, pattern, pattern_template_index,
+					hash, error);
+	return flow_err(port_id, ret, error);
+}
lib/ethdev/rte_flow.h +32 -0
index e576b15e3d..00e472b65b 100644
@@ -6717,6 +6717,38 @@ rte_flow_async_action_list_handle_query_update(uint16_t port_id, uint32_t queue_
 					  void *user_data,
 					  struct rte_flow_error *error);
 
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice.
+ *
+ * Calculate the hash for a given pattern in a given table as
+ * calculated by the HW.
+ *
+ * @param port_id
+ *   Port identifier of Ethernet device.
+ * @param table
+ *   The table the SW wishes to simulate.
+ * @param pattern
+ *   The values to be used in the hash calculation.
+ * @param pattern_template_index
+ *   The pattern index in the table to be used for the calculation.
+ * @param hash
+ *   Used to return the calculated hash.
+ * @param error
+ *   Perform verbose error reporting if not NULL.
+ *   PMDs initialize this structure in case of error only.
+ *
+ * @return
+ *   - (0) if success.
+ *   - (-ENODEV) if *port_id* invalid.
+ *   - (-ENOTSUP) if underlying device does not support this functionality.
+ */
+__rte_experimental
+int
+rte_flow_calc_table_hash(uint16_t port_id, const struct rte_flow_template_table *table,
+			 const struct rte_flow_item pattern[], uint8_t pattern_template_index,
+			 uint32_t *hash, struct rte_flow_error *error);
+
 #ifdef __cplusplus
 }
 #endif
lib/ethdev/rte_flow_driver.h +5 -0
index 3ced086c47..f35f659503 100644
@@ -365,6 +365,11 @@ struct rte_flow_ops {
 		 const void **update, void **query,
 		 enum rte_flow_query_update_mode mode,
 		 void *user_data, struct rte_flow_error *error);
+	/** @see rte_flow_calc_table_hash() */
+	int (*flow_calc_table_hash)
+		(struct rte_eth_dev *dev, const struct rte_flow_template_table *table,
+		 const struct rte_flow_item pattern[], uint8_t pattern_template_index,
+		 uint32_t *hash, struct rte_flow_error *error);
 };
 
 /**
lib/ethdev/version.map +1 -0
index 1e51478405..919ba5b8e6 100644
@@ -316,6 +316,7 @@ EXPERIMENTAL {
 	# added in 23.11
 	rte_eth_recycle_rx_queue_info_get;
 	rte_flow_group_set_miss_actions;
+	rte_flow_calc_table_hash;
 };
 
 INTERNAL {
Signature · 1 line
2.34.1
Applied
#7 lore raw
Quoted 23 lines · Ori Kam

rte_flow supports insert by index table[1].

Using the above table, the application can create rules
that are based on hash.
For example application can create the following logic in order to create load balancing:
1. Create insert by index table with 2 rules, that hashes based on dmac
2. Insert to index 0 a rule that sends the traffic to port A.
3. Insert to index 1 a rule that sends the traffic to port B.

Let's also assume that before this table, there is a 5 tuple match table that jumps to the above table.

So each packet that matches one of the 5 tuple rules is RSSed to port A or B, based on dmac hash.

The issue arises when there is a miss on the 5 tuple table, which resulted due to the packet being the first packet of this flow, or fragmented packet or any other reason.
In this case, the application must calculate what would be the hash calculated by the HW so it can send the packet to the correct port.

Quoted 7 lines

This new API allows applications to calculate the hash value of a given packet for a given table.

[1] - http://patches.dpdk.org/project/dpdk/patch/[email protected]/

Signed-off-by Ori Kam <[email protected]>

Applied to dpdk-next-net/main, thanks.