From 929e3319342b7ae2ec0c0fc5c5a4e954037d7d29 Mon Sep 17 00:00:00 2001 From: Adrien Mazarguil Date: Wed, 25 Apr 2018 17:27:52 +0200 Subject: [PATCH] ethdev: add hash function to RSS flow API action By definition, RSS involves some kind of hash algorithm, usually Toeplitz. Until now it could not be modified on a flow rule basis and PMDs had to always assume RTE_ETH_HASH_FUNCTION_DEFAULT, which remains the default behavior when unspecified (0). This breaks ABI compatibility for the following public functions: - rte_flow_copy() - rte_flow_create() - rte_flow_query() - rte_flow_validate() Signed-off-by: Adrien Mazarguil Acked-by: Andrew Rybchenko --- app/test-pmd/cmdline_flow.c | 72 +++++++++++++++++++++ app/test-pmd/config.c | 1 + doc/guides/prog_guide/rte_flow.rst | 2 + doc/guides/rel_notes/release_18_05.rst | 3 +- doc/guides/testpmd_app_ug/testpmd_funcs.rst | 3 + drivers/net/e1000/igb_flow.c | 4 ++ drivers/net/e1000/igb_rxtx.c | 4 +- drivers/net/i40e/i40e_ethdev.c | 4 +- drivers/net/i40e/i40e_flow.c | 4 ++ drivers/net/ixgbe/ixgbe_flow.c | 4 ++ drivers/net/ixgbe/ixgbe_rxtx.c | 4 +- drivers/net/mlx4/mlx4_flow.c | 7 ++ drivers/net/mlx5/mlx5_flow.c | 13 ++++ drivers/net/sfc/sfc_flow.c | 8 +++ drivers/net/tap/tap_flow.c | 6 ++ lib/librte_ether/rte_flow.c | 1 + lib/librte_ether/rte_flow.h | 2 + 17 files changed, 138 insertions(+), 4 deletions(-) diff --git a/app/test-pmd/cmdline_flow.c b/app/test-pmd/cmdline_flow.c index c9c2c3ad9f..7436e03562 100644 --- a/app/test-pmd/cmdline_flow.c +++ b/app/test-pmd/cmdline_flow.c @@ -14,6 +14,7 @@ #include #include +#include #include #include #include @@ -165,6 +166,10 @@ enum index { ACTION_DROP, ACTION_COUNT, ACTION_RSS, + ACTION_RSS_FUNC, + ACTION_RSS_FUNC_DEFAULT, + ACTION_RSS_FUNC_TOEPLITZ, + ACTION_RSS_FUNC_SIMPLE_XOR, ACTION_RSS_TYPES, ACTION_RSS_TYPE, ACTION_RSS_KEY, @@ -632,6 +637,7 @@ static const enum index action_queue[] = { }; static const enum index action_rss[] = { + ACTION_RSS_FUNC, ACTION_RSS_TYPES, ACTION_RSS_KEY, ACTION_RSS_KEY_LEN, @@ -666,6 +672,9 @@ static int parse_vc_conf(struct context *, const struct token *, static int parse_vc_action_rss(struct context *, const struct token *, const char *, unsigned int, void *, unsigned int); +static int parse_vc_action_rss_func(struct context *, const struct token *, + const char *, unsigned int, void *, + unsigned int); static int parse_vc_action_rss_type(struct context *, const struct token *, const char *, unsigned int, void *, unsigned int); @@ -1584,6 +1593,29 @@ static const struct token token_list[] = { .next = NEXT(action_rss), .call = parse_vc_action_rss, }, + [ACTION_RSS_FUNC] = { + .name = "func", + .help = "RSS hash function to apply", + .next = NEXT(action_rss, + NEXT_ENTRY(ACTION_RSS_FUNC_DEFAULT, + ACTION_RSS_FUNC_TOEPLITZ, + ACTION_RSS_FUNC_SIMPLE_XOR)), + }, + [ACTION_RSS_FUNC_DEFAULT] = { + .name = "default", + .help = "default hash function", + .call = parse_vc_action_rss_func, + }, + [ACTION_RSS_FUNC_TOEPLITZ] = { + .name = "toeplitz", + .help = "Toeplitz hash function", + .call = parse_vc_action_rss_func, + }, + [ACTION_RSS_FUNC_SIMPLE_XOR] = { + .name = "simple_xor", + .help = "simple XOR hash function", + .call = parse_vc_action_rss_func, + }, [ACTION_RSS_TYPES] = { .name = "types", .help = "specific RSS hash types", @@ -2074,6 +2106,7 @@ parse_vc_action_rss(struct context *ctx, const struct token *token, action_rss_data = ctx->object; *action_rss_data = (struct action_rss_data){ .conf = (struct rte_flow_action_rss){ + .func = RTE_ETH_HASH_FUNCTION_DEFAULT, .types = rss_hf, .key_len = sizeof(action_rss_data->key), .queue_num = RTE_MIN(nb_rxq, ACTION_RSS_QUEUE_NUM), @@ -2098,6 +2131,45 @@ parse_vc_action_rss(struct context *ctx, const struct token *token, return ret; } +/** + * Parse func field for RSS action. + * + * The RTE_ETH_HASH_FUNCTION_* value to assign is derived from the + * ACTION_RSS_FUNC_* index that called this function. + */ +static int +parse_vc_action_rss_func(struct context *ctx, const struct token *token, + const char *str, unsigned int len, + void *buf, unsigned int size) +{ + struct action_rss_data *action_rss_data; + enum rte_eth_hash_function func; + + (void)buf; + (void)size; + /* Token name must match. */ + if (parse_default(ctx, token, str, len, NULL, 0) < 0) + return -1; + switch (ctx->curr) { + case ACTION_RSS_FUNC_DEFAULT: + func = RTE_ETH_HASH_FUNCTION_DEFAULT; + break; + case ACTION_RSS_FUNC_TOEPLITZ: + func = RTE_ETH_HASH_FUNCTION_TOEPLITZ; + break; + case ACTION_RSS_FUNC_SIMPLE_XOR: + func = RTE_ETH_HASH_FUNCTION_SIMPLE_XOR; + break; + default: + return -1; + } + if (!ctx->object) + return len; + action_rss_data = ctx->object; + action_rss_data->conf.func = func; + return len; +} + /** * Parse type field for RSS action. * diff --git a/app/test-pmd/config.c b/app/test-pmd/config.c index ece2664186..107d7fd26f 100644 --- a/app/test-pmd/config.c +++ b/app/test-pmd/config.c @@ -1117,6 +1117,7 @@ flow_action_conf_copy(void *buf, const struct rte_flow_action *action) off = 0; if (dst.rss) *dst.rss = (struct rte_flow_action_rss){ + .func = src.rss->func, .types = src.rss->types, .key_len = src.rss->key_len, .queue_num = src.rss->queue_num, diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst index cf252eeba0..e0c68495ce 100644 --- a/doc/guides/prog_guide/rte_flow.rst +++ b/doc/guides/prog_guide/rte_flow.rst @@ -1318,6 +1318,8 @@ field only, both can be requested simultaneously. +---------------+---------------------------------------------+ | Field | Value | +===============+=============================================+ + | ``func`` | RSS hash function to apply | + +---------------+---------------------------------------------+ | ``types`` | specific RSS hash types (see ``ETH_RSS_*``) | +---------------+---------------------------------------------+ | ``key_len`` | hash key length in bytes | diff --git a/doc/guides/rel_notes/release_18_05.rst b/doc/guides/rel_notes/release_18_05.rst index 76699fbc0c..239d96d963 100644 --- a/doc/guides/rel_notes/release_18_05.rst +++ b/doc/guides/rel_notes/release_18_05.rst @@ -275,7 +275,8 @@ API Changes (``rss_conf->rss_key`` => ``key``, ``rss_conf->rss_key_len`` => ``key_len``, ``rss_conf->rss_hf`` => ``types``, - ``num`` => ``queue_num``). + ``num`` => ``queue_num``), and the addition of missing RSS parameters + (``func`` for RSS hash function to apply). ABI Changes diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst index a12e0267a5..12933ef1ec 100644 --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst @@ -3422,6 +3422,9 @@ This section lists supported actions and their attributes, if any. - ``rss``: spread packets among several queues. + - ``func {hash function}``: RSS hash function to apply, allowed tokens are + the same as `set_hash_global_config`_. + - ``types [{RSS hash type} [...]] end``: specific RSS hash types, allowed tokens are the same as `set_hash_input_set`_, except that an empty list does not disable RSS but instead requests unspecified "best-effort" diff --git a/drivers/net/e1000/igb_flow.c b/drivers/net/e1000/igb_flow.c index 8dc5f75f2c..82307ec5db 100644 --- a/drivers/net/e1000/igb_flow.c +++ b/drivers/net/e1000/igb_flow.c @@ -1310,6 +1310,10 @@ igb_parse_rss_filter(struct rte_eth_dev *dev, } } + if (rss->func != RTE_ETH_HASH_FUNCTION_DEFAULT) + return rte_flow_error_set + (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ACTION, act, + "non-default RSS hash functions are not supported"); if (rss->key_len && rss->key_len != RTE_DIM(rss_conf->key)) return rte_flow_error_set (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ACTION, act, diff --git a/drivers/net/e1000/igb_rxtx.c b/drivers/net/e1000/igb_rxtx.c index 45bb3455c6..d5c1cd3d35 100644 --- a/drivers/net/e1000/igb_rxtx.c +++ b/drivers/net/e1000/igb_rxtx.c @@ -2905,6 +2905,7 @@ igb_rss_conf_init(struct igb_rte_flow_rss_conf *out, in->queue_num > RTE_DIM(out->queue)) return -EINVAL; out->conf = (struct rte_flow_action_rss){ + .func = in->func, .types = in->types, .key_len = in->key_len, .queue_num = in->queue_num, @@ -2919,7 +2920,8 @@ int igb_action_rss_same(const struct rte_flow_action_rss *comp, const struct rte_flow_action_rss *with) { - return (comp->types == with->types && + return (comp->func == with->func && + comp->types == with->types && comp->key_len == with->key_len && comp->queue_num == with->queue_num && !memcmp(comp->key, with->key, with->key_len) && diff --git a/drivers/net/i40e/i40e_ethdev.c b/drivers/net/i40e/i40e_ethdev.c index 50e77901ca..cf19649dc2 100644 --- a/drivers/net/i40e/i40e_ethdev.c +++ b/drivers/net/i40e/i40e_ethdev.c @@ -12190,6 +12190,7 @@ i40e_rss_conf_init(struct i40e_rte_flow_rss_conf *out, in->queue_num > RTE_DIM(out->queue)) return -EINVAL; out->conf = (struct rte_flow_action_rss){ + .func = in->func, .types = in->types, .key_len = in->key_len, .queue_num = in->queue_num, @@ -12204,7 +12205,8 @@ int i40e_action_rss_same(const struct rte_flow_action_rss *comp, const struct rte_flow_action_rss *with) { - return (comp->types == with->types && + return (comp->func == with->func && + comp->types == with->types && comp->key_len == with->key_len && comp->queue_num == with->queue_num && !memcmp(comp->key, with->key, with->key_len) && diff --git a/drivers/net/i40e/i40e_flow.c b/drivers/net/i40e/i40e_flow.c index ec62310034..897989bbd0 100644 --- a/drivers/net/i40e/i40e_flow.c +++ b/drivers/net/i40e/i40e_flow.c @@ -4376,6 +4376,10 @@ i40e_flow_parse_rss_action(struct rte_eth_dev *dev, } /* Parse RSS related parameters from configuration */ + if (rss->func != RTE_ETH_HASH_FUNCTION_DEFAULT) + return rte_flow_error_set + (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ACTION, act, + "non-default RSS hash functions are not supported"); if (rss->key_len && rss->key_len > RTE_DIM(rss_config->key)) return rte_flow_error_set (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ACTION, act, diff --git a/drivers/net/ixgbe/ixgbe_flow.c b/drivers/net/ixgbe/ixgbe_flow.c index 4e31c7c565..00d975b93d 100644 --- a/drivers/net/ixgbe/ixgbe_flow.c +++ b/drivers/net/ixgbe/ixgbe_flow.c @@ -2779,6 +2779,10 @@ ixgbe_parse_rss_filter(struct rte_eth_dev *dev, } } + if (rss->func != RTE_ETH_HASH_FUNCTION_DEFAULT) + return rte_flow_error_set + (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ACTION, act, + "non-default RSS hash functions are not supported"); if (rss->key_len && rss->key_len != RTE_DIM(rss_conf->key)) return rte_flow_error_set (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ACTION, act, diff --git a/drivers/net/ixgbe/ixgbe_rxtx.c b/drivers/net/ixgbe/ixgbe_rxtx.c index 9fbd7dbd7e..e91e7f7463 100644 --- a/drivers/net/ixgbe/ixgbe_rxtx.c +++ b/drivers/net/ixgbe/ixgbe_rxtx.c @@ -5683,6 +5683,7 @@ ixgbe_rss_conf_init(struct ixgbe_rte_flow_rss_conf *out, in->queue_num > RTE_DIM(out->queue)) return -EINVAL; out->conf = (struct rte_flow_action_rss){ + .func = in->func, .types = in->types, .key_len = in->key_len, .queue_num = in->queue_num, @@ -5697,7 +5698,8 @@ int ixgbe_action_rss_same(const struct rte_flow_action_rss *comp, const struct rte_flow_action_rss *with) { - return (comp->types == with->types && + return (comp->func == with->func && + comp->types == with->types && comp->key_len == with->key_len && comp->queue_num == with->queue_num && !memcmp(comp->key, with->key, with->key_len) && diff --git a/drivers/net/mlx4/mlx4_flow.c b/drivers/net/mlx4/mlx4_flow.c index dd86e4ce74..0020032350 100644 --- a/drivers/net/mlx4/mlx4_flow.c +++ b/drivers/net/mlx4/mlx4_flow.c @@ -790,6 +790,12 @@ fill: " of the context size"; goto exit_action_not_supported; } + if (rss->func && + rss->func != RTE_ETH_HASH_FUNCTION_TOEPLITZ) { + msg = "the only supported RSS hash function" + " is Toeplitz"; + goto exit_action_not_supported; + } rte_errno = 0; fields = mlx4_conv_rss_types(priv, rss->types); if (fields == (uint64_t)-1 && rte_errno) { @@ -1283,6 +1289,7 @@ mlx4_flow_internal(struct priv *priv, struct rte_flow_error *error) rte_align32pow2(priv->dev->data->nb_rx_queues + 1) >> 1; uint16_t queue[queues]; struct rte_flow_action_rss action_rss = { + .func = RTE_ETH_HASH_FUNCTION_DEFAULT, .types = -1, .key_len = MLX4_RSS_HASH_KEY_SIZE, .queue_num = queues, diff --git a/drivers/net/mlx5/mlx5_flow.c b/drivers/net/mlx5/mlx5_flow.c index af8853e09e..093e3a2287 100644 --- a/drivers/net/mlx5/mlx5_flow.c +++ b/drivers/net/mlx5/mlx5_flow.c @@ -18,6 +18,7 @@ #endif #include +#include #include #include #include @@ -642,6 +643,15 @@ mlx5_flow_convert_actions(struct rte_eth_dev *dev, if (overlap & FATE) goto exit_action_overlap; overlap |= FATE; + if (rss->func && + rss->func != RTE_ETH_HASH_FUNCTION_TOEPLITZ) { + rte_flow_error_set(error, EINVAL, + RTE_FLOW_ERROR_TYPE_ACTION, + actions, + "the only supported RSS hash" + " function is Toeplitz"); + return -rte_errno; + } if (rss->types & MLX5_RSS_HF_MASK) { rte_flow_error_set(error, EINVAL, RTE_FLOW_ERROR_TYPE_ACTION, @@ -691,6 +701,7 @@ mlx5_flow_convert_actions(struct rte_eth_dev *dev, } } parser->rss_conf = (struct rte_flow_action_rss){ + .func = RTE_ETH_HASH_FUNCTION_DEFAULT, .types = rss->types, .key_len = rss_key_len, .queue_num = rss->queue_num, @@ -1925,6 +1936,7 @@ mlx5_flow_list_create(struct rte_eth_dev *dev, /* Copy configuration. */ flow->queues = (uint16_t (*)[])(flow + 1); flow->rss_conf = (struct rte_flow_action_rss){ + .func = RTE_ETH_HASH_FUNCTION_DEFAULT, .types = parser.rss_conf.types, .key_len = parser.rss_conf.key_len, .queue_num = parser.rss_conf.queue_num, @@ -2439,6 +2451,7 @@ mlx5_ctrl_flow_vlan(struct rte_eth_dev *dev, }; uint16_t queue[priv->reta_idx_n]; struct rte_flow_action_rss action_rss = { + .func = RTE_ETH_HASH_FUNCTION_DEFAULT, .types = priv->rss_conf.rss_hf, .key_len = priv->rss_conf.rss_key_len, .queue_num = priv->reta_idx_n, diff --git a/drivers/net/sfc/sfc_flow.c b/drivers/net/sfc/sfc_flow.c index 1a2c0299c3..779edad0c2 100644 --- a/drivers/net/sfc/sfc_flow.c +++ b/drivers/net/sfc/sfc_flow.c @@ -1261,6 +1261,14 @@ sfc_flow_parse_rss(struct sfc_adapter *sa, rxq_hw_index_max = rxq->hw_index; } + switch (rss->func) { + case RTE_ETH_HASH_FUNCTION_DEFAULT: + case RTE_ETH_HASH_FUNCTION_TOEPLITZ: + break; + default: + return -EINVAL; + } + if ((rss->types & ~SFC_RSS_OFFLOADS) != 0) return -EINVAL; diff --git a/drivers/net/tap/tap_flow.c b/drivers/net/tap/tap_flow.c index 67146aabad..845031a313 100644 --- a/drivers/net/tap/tap_flow.c +++ b/drivers/net/tap/tap_flow.c @@ -2055,6 +2055,12 @@ static int rss_add_actions(struct rte_flow *flow, struct pmd_internals *pmd, struct rss_key rss_entry = { .hash_fields = 0, .key_size = 0 }; + /* Check supported hash functions */ + if (rss->func != RTE_ETH_HASH_FUNCTION_DEFAULT) + return rte_flow_error_set + (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_UNSPECIFIED, NULL, + "non-default RSS hash functions are not supported"); + /* Get a new map key for a new RSS rule */ err = bpf_rss_key(KEY_CMD_GET, &flow->key_idx); if (err < 0) { diff --git a/lib/librte_ether/rte_flow.c b/lib/librte_ether/rte_flow.c index cc7819b6ab..a2b51f1e06 100644 --- a/lib/librte_ether/rte_flow.c +++ b/lib/librte_ether/rte_flow.c @@ -330,6 +330,7 @@ flow_action_conf_copy(void *buf, const struct rte_flow_action *action) off = 0; if (dst.rss) *dst.rss = (struct rte_flow_action_rss){ + .func = src.rss->func, .types = src.rss->types, .key_len = src.rss->key_len, .queue_num = src.rss->queue_num, diff --git a/lib/librte_ether/rte_flow.h b/lib/librte_ether/rte_flow.h index bbc408fa6c..97d7d3594f 100644 --- a/lib/librte_ether/rte_flow.h +++ b/lib/librte_ether/rte_flow.h @@ -19,6 +19,7 @@ #include #include +#include #include #include #include @@ -1044,6 +1045,7 @@ struct rte_flow_query_count { * both can be requested simultaneously. */ struct rte_flow_action_rss { + enum rte_eth_hash_function func; /**< RSS hash function to apply. */ uint64_t types; /**< Specific RSS hash types (see ETH_RSS_*). */ uint32_t key_len; /**< Hash key length in bytes. */ uint32_t queue_num; /**< Number of entries in @p queue. */ -- 2.20.1