d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

ethdev: add shared actions to flow API

Browse Source 
Introduce extension of flow action API enabling sharing of single
rte_flow_action in multiple flows. The API intended for PMDs, where
multiple HW offloaded flows can reuse the same HW essence/object
representing flow action and modification of such an essence/object
affects all the rules using it.

Motivation and example
===
Adding or removing one or more queues to RSS used by multiple flow rules
imposes per rule toll for current DPDK flow API; the scenario requires
for each flow sharing cloned RSS action:
- call `rte_flow_destroy()`
- call `rte_flow_create()` with modified RSS action

API for sharing action and its in-place update benefits:
- reduce the overhead of multiple RSS flow rules reconfiguration
- optimize resource utilization by sharing action across multiple
  flows

Change description
===

Shared action
===
In order to represent flow action shared by multiple flows new action
type RTE_FLOW_ACTION_TYPE_SHARED is introduced (see `enum
rte_flow_action_type`).
Actually the introduced API decouples action from any specific flow and
enables sharing of single action by its handle across multiple flows.

Shared action create/use/destroy
===
Shared action may be reused by some or none flow rules at any given
moment, i.e. shared action resides outside of the context of any flow.
Shared action represent HW resources/objects used for action offloading
implementation.
API for shared action create (see `rte_flow_shared_action_create()`):
- should allocate HW resources and make related initializations required
  for shared action implementation.
- make necessary preparations to maintain shared access to
  the action resources, configuration and state.
API for shared action destroy (see `rte_flow_shared_action_destroy()`)
should release HW resources and make related cleanups required for shared
action implementation.

In order to share some flow action reuse the handle of type
`struct rte_flow_shared_action` returned by
rte_flow_shared_action_create() as a `conf` field of
`struct rte_flow_action` (see "example" section).

If some shared action not used by any flow rule all resources allocated
by the shared action can be released by rte_flow_shared_action_destroy()
(see "example" section). The shared action handle passed as argument to
destroy API should not be used any further i.e. result of the usage is
undefined.

Shared action re-configuration
===
Shared action behavior defined by its configuration can be updated via
rte_flow_shared_action_update() (see "example" section). The shared
action update operation modifies HW related resources/objects allocated
on the action creation. The number of operations performed by the update
operation should not depend on the number of flows sharing the related
action. On return of shared action update API action behavior should be
according to updated configuration for all flows sharing the action.

Shared action query
===
Provide separate API to query shared action state (see
rte_flow_shared_action_update()). Taking a counter as an example: query
returns value aggregating all counter increments across all flow rules
sharing the counter. This API doesn't query shared action configuration
since it is controlled by rte_flow_shared_action_create() and
rte_flow_shared_action_update() APIs and no supposed to change by other
means.

example
===

struct rte_flow_action actions[2];
struct rte_flow_shared_action_conf conf;
struct rte_flow_action action;
/* skipped: initialize conf and action */
struct rte_flow_shared_action *handle =
	rte_flow_shared_action_create(port_id, &conf, &action, &error);
actions[0].type = RTE_FLOW_ACTION_TYPE_SHARED;
actions[0].conf = handle;
actions[1].type = RTE_FLOW_ACTION_TYPE_END;
/* skipped: init attr0 & pattern0 args */
struct rte_flow *flow0 = rte_flow_create(port_id, &attr0, pattern0,
					actions, error);
/* create more rules reusing shared action */
struct rte_flow *flow1 = rte_flow_create(port_id, &attr1, pattern1,
					actions, error);
/* skipped: for flows 2 till N */
struct rte_flow *flowN = rte_flow_create(port_id, &attrN, patternN,
					actions, error);
/* update shared action */
struct rte_flow_action updated_action;
/*
 * skipped: initialize updated_action according to desired action
 * configuration change
 */
rte_flow_shared_action_update(port_id, handle, &updated_action, error);
/*
 * from now on all flows 1 till N will act according to configuration of
 * updated_action
 */
/* skipped: destroy all flows 1 till N */
rte_flow_shared_action_destroy(port_id, handle, error);

Signed-off-by: Andrey Vesnovaty <andreyv@nvidia.com>
Acked-by: Ori Kam <orika@nvidia.com>
Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
This commit is contained in:
Andrey Vesnovaty 2020-10-14 14:40:14 +03:00 committed by Ferruh Yigit
parent f78b86c323
commit 4d9fd85fb5
6 changed files with 317 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/guides/prog_guide/rte_flow.rst
View File

@ -2708,6 +2708,25 @@ packets, and must have a fate action.
| ``actions`` | sub-action list for sampling |
+--------------+---------------------------------+
Action: ``SHARED``
^^^^^^^^^^^^^^^^^^
Flow utilize shared action by handle as returned from
``rte_flow_shared_action_create()``.
The behaviour of the shared action defined by ``action`` argument of type
``struct rte_flow_action`` passed to ``rte_flow_shared_action_create()``.
.. _table_rte_flow_shared_action:
.. table:: SHARED
+---------------+
| Field |
+===============+
| no properties |
+---------------+
Negative types
~~~~~~~~~~~~~~

10
doc/guides/rel_notes/release_20_11.rst
View File

@ -100,6 +100,16 @@ New Features
packets with specified ratio, and apply with own set of actions with a fate
action. When the ratio is set to 1 then the packets will be 100% mirrored.
* **Added support of shared action in flow API.**
Added shared action support to utilize single flow action in multiple flow
rules. An update of shared action configuration alters the behavior of all
flow rules using it.
* Added new action: ``RTE_FLOW_ACTION_TYPE_SHARED`` to use shared action
as flow action.
* Added new flow APIs to create/update/destroy/query shared action.
* **Updated Broadcom bnxt driver.**
Updated the Broadcom bnxt driver with new features and improvements, including:

4
lib/librte_ethdev/rte_ethdev_version.map
View File

@ -232,6 +232,10 @@ EXPERIMENTAL {
rte_eth_fec_get_capability;
rte_eth_fec_get;
rte_eth_fec_set;
rte_flow_shared_action_create;
rte_flow_shared_action_destroy;
rte_flow_shared_action_query;
rte_flow_shared_action_update;
};
INTERNAL {

90
lib/librte_ethdev/rte_flow.c
View File

@ -175,6 +175,13 @@ static const struct rte_flow_desc_data rte_flow_desc_action[] = {
MK_FLOW_ACTION(SET_IPV6_DSCP, sizeof(struct rte_flow_action_set_dscp)),
MK_FLOW_ACTION(AGE, sizeof(struct rte_flow_action_age)),
MK_FLOW_ACTION(SAMPLE, sizeof(struct rte_flow_action_sample)),
/**
* Shared action represented as handle of type
* (struct rte_flow_shared action *) stored in conf field (see
* struct rte_flow_action); no need for additional structure to * store
* shared action handle.
*/
MK_FLOW_ACTION(SHARED, 0),
};
int
@ -1036,3 +1043,86 @@ rte_flow_get_aged_flows(uint16_t port_id, void **contexts,
RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
NULL, rte_strerror(ENOTSUP));
}
struct rte_flow_shared_action *
rte_flow_shared_action_create(uint16_t port_id,
const struct rte_flow_shared_action_conf *conf,
const struct rte_flow_action *action,
struct rte_flow_error *error)
{
struct rte_flow_shared_action *shared_action;
const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
if (unlikely(!ops))
return NULL;
if (unlikely(!ops->shared_action_create)) {
rte_flow_error_set(error, ENOSYS,
RTE_FLOW_ERROR_TYPE_UNSPECIFIED, NULL,
rte_strerror(ENOSYS));
return NULL;
}
shared_action = ops->shared_action_create(&rte_eth_devices[port_id],
conf, action, error);
if (shared_action == NULL)
flow_err(port_id, -rte_errno, error);
return shared_action;
}
int
rte_flow_shared_action_destroy(uint16_t port_id,
struct rte_flow_shared_action *action,
struct rte_flow_error *error)
{
int ret;
const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
if (unlikely(!ops))
return -rte_errno;
if (unlikely(!ops->shared_action_destroy))
return rte_flow_error_set(error, ENOSYS,
RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
NULL, rte_strerror(ENOSYS));
ret = ops->shared_action_destroy(&rte_eth_devices[port_id], action,
error);
return flow_err(port_id, ret, error);
}
int
rte_flow_shared_action_update(uint16_t port_id,
struct rte_flow_shared_action *action,
const struct rte_flow_action *update,
struct rte_flow_error *error)
{
int ret;
const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
if (unlikely(!ops))
return -rte_errno;
if (unlikely(!ops->shared_action_update))
return rte_flow_error_set(error, ENOSYS,
RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
NULL, rte_strerror(ENOSYS));
ret = ops->shared_action_update(&rte_eth_devices[port_id], action,
update, error);
return flow_err(port_id, ret, error);
}
int
rte_flow_shared_action_query(uint16_t port_id,
const struct rte_flow_shared_action *action,
void *data,
struct rte_flow_error *error)
{
int ret;
const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
if (unlikely(!ops))
return -rte_errno;
if (unlikely(!ops->shared_action_query))
return rte_flow_error_set(error, ENOSYS,
RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
NULL, rte_strerror(ENOSYS));
ret = ops->shared_action_query(&rte_eth_devices[port_id], action,
data, error);
return flow_err(port_id, ret, error);
}

172
lib/librte_ethdev/rte_flow.h
View File

@ -1714,7 +1714,8 @@ enum rte_flow_action_type {
/**
* Enables counters for this flow rule.
*
* These counters can be retrieved and reset through rte_flow_query(),
* These counters can be retrieved and reset through rte_flow_query() or
* rte_flow_shared_action_query() if the action provided via handle,
* see struct rte_flow_query_count.
*
* See struct rte_flow_action_count.
@ -2141,6 +2142,14 @@ enum rte_flow_action_type {
* See struct rte_flow_action_sample.
*/
RTE_FLOW_ACTION_TYPE_SAMPLE,
/**
* Describe action shared across multiple flow rules.
*
* Allow multiple rules reference the same action by handle (see
* struct rte_flow_shared_action).
*/
RTE_FLOW_ACTION_TYPE_SHARED,
};
/**
@ -2716,6 +2725,20 @@ struct rte_flow_action_set_dscp {
uint8_t dscp;
};
/**
* RTE_FLOW_ACTION_TYPE_SHARED
*
* Opaque type returned after successfully creating a shared action.
*
* This handle can be used to manage and query the related action:
* - share it across multiple flow rules
* - update action configuration
* - query action data
* - destroy action
*/
struct rte_flow_shared_action;
/* Mbuf dynamic field offset for metadata. */
extern int32_t rte_flow_dynf_metadata_offs;
@ -3402,6 +3425,153 @@ int
rte_flow_get_aged_flows(uint16_t port_id, void **contexts,
uint32_t nb_contexts, struct rte_flow_error *error);
/**
* Specify shared action configuration
*/
struct rte_flow_shared_action_conf {
/**
* Flow direction for shared action configuration.
*
* Shared action should be valid at least for one flow direction,
* otherwise it is invalid for both ingress and egress rules.
*/
uint32_t ingress:1;
/**< Action valid for rules applied to ingress traffic. */
uint32_t egress:1;
/**< Action valid for rules applied to egress traffic. */
};
/**
* @warning
* @b EXPERIMENTAL: this API may change without prior notice.
*
* Create shared action for reuse in multiple flow rules.
* The created shared action has single state and configuration
* across all flow rules using it.
*
* @param[in] port_id
* The port identifier of the Ethernet device.
* @param[in] conf
* Shared action configuration.
* @param[in] action
* Action configuration for shared action creation.
* @param[out] error
* Perform verbose error reporting if not NULL. PMDs initialize this
* structure in case of error only.
* @return
* A valid handle in case of success, NULL otherwise and rte_errno is set
* to one of the error codes defined:
* - (ENODEV) if *port_id* invalid.
* - (ENOSYS) if underlying device does not support this functionality.
* - (EIO) if underlying device is removed.
* - (EINVAL) if *action* invalid.
* - (ENOTSUP) if *action* valid but unsupported.
*/
__rte_experimental
struct rte_flow_shared_action *
rte_flow_shared_action_create(uint16_t port_id,
const struct rte_flow_shared_action_conf *conf,
const struct rte_flow_action *action,
struct rte_flow_error *error);
/**
* @warning
* @b EXPERIMENTAL: this API may change without prior notice.
*
* Destroy the shared action by handle.
*
* @param[in] port_id
* The port identifier of the Ethernet device.
* @param[in] action
* Handle for the shared action to be destroyed.
* @param[out] 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.
* - (-ENOSYS) if underlying device does not support this functionality.
* - (-EIO) if underlying device is removed.
* - (-ENOENT) if action pointed by *action* handle was not found.
* - (-ETOOMANYREFS) if action pointed by *action* handle still used by one or
* more rules
* rte_errno is also set.
*/
__rte_experimental
int
rte_flow_shared_action_destroy(uint16_t port_id,
struct rte_flow_shared_action *action,
struct rte_flow_error *error);
/**
* @warning
* @b EXPERIMENTAL: this API may change without prior notice.
*
* Update in-place the shared action configuration pointed by *action* handle
* with the configuration provided as *update* argument.
* The update of the shared action configuration effects all flow rules reusing
* the action via handle.
*
* @param[in] port_id
* The port identifier of the Ethernet device.
* @param[in] action
* Handle for the shared action to be updated.
* @param[in] update
* Action specification used to modify the action pointed by handle.
* *update* should be of same type with the action pointed by the *action*
* handle argument, otherwise considered as invalid.
* @param[out] 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.
* - (-ENOSYS) if underlying device does not support this functionality.
* - (-EIO) if underlying device is removed.
* - (-EINVAL) if *update* invalid.
* - (-ENOTSUP) if *update* valid but unsupported.
* - (-ENOENT) if action pointed by *ctx* was not found.
* rte_errno is also set.
*/
__rte_experimental
int
rte_flow_shared_action_update(uint16_t port_id,
struct rte_flow_shared_action *action,
const struct rte_flow_action *update,
struct rte_flow_error *error);
/**
* @warning
* @b EXPERIMENTAL: this API may change without prior notice.
*
* Query the shared action by handle.
*
* Retrieve action-specific data such as counters.
* Data is gathered by special action which may be present/referenced in
* more than one flow rule definition.
*
* \see RTE_FLOW_ACTION_TYPE_COUNT
*
* @param port_id
* Port identifier of Ethernet device.
* @param[in] action
* Handle for the shared action to query.
* @param[in, out] data
* Pointer to storage for the associated query data type.
* @param[out] error
* Perform verbose error reporting if not NULL. PMDs initialize this
* structure in case of error only.
*
* @return
* 0 on success, a negative errno value otherwise and rte_errno is set.
*/
__rte_experimental
int
rte_flow_shared_action_query(uint16_t port_id,
const struct rte_flow_shared_action *action,
void *data,
struct rte_flow_error *error);
#ifdef __cplusplus
}
#endif

23
lib/librte_ethdev/rte_flow_driver.h
View File

@ -108,6 +108,29 @@ struct rte_flow_ops {
void **context,
uint32_t nb_contexts,
struct rte_flow_error *err);
/** See rte_flow_shared_action_create() */
struct rte_flow_shared_action *(*shared_action_create)
(struct rte_eth_dev *dev,
const struct rte_flow_shared_action_conf *conf,
const struct rte_flow_action *action,
struct rte_flow_error *error);
/** See rte_flow_shared_action_destroy() */
int (*shared_action_destroy)
(struct rte_eth_dev *dev,
struct rte_flow_shared_action *shared_action,
struct rte_flow_error *error);
/** See rte_flow_shared_action_update() */
int (*shared_action_update)
(struct rte_eth_dev *dev,
struct rte_flow_shared_action *shared_action,
const struct rte_flow_action *update,
struct rte_flow_error *error);
/** See rte_flow_shared_action_query() */
int (*shared_action_query)
(struct rte_eth_dev *dev,
const struct rte_flow_shared_action *shared_action,
void *data,
struct rte_flow_error *error);
};
/**