4b61b8774b
Right now, rte_flow_shared_action_* APIs are used for some shared actions, like RSS, count. The shared action should be created before using it inside a flow. These shared actions sometimes are not really shared but just some indirect actions decoupled from a flow. The new functions rte_flow_action_handle_* are added to replace the current shared functions rte_flow_shared_action_*. There are two types of flow actions: 1. the direct (normal) actions that could be created and stored within a flow rule. Such action is tied to its flow rule and cannot be reused. 2. the indirect action, in the past, named shared_action. It is created from a direct actioni, like count or rss, and then used in the flow rules with an object handle. The PMD will take care of the retrieve from indirect action to the direct action when it is referenced. The indirect action is accessed (update / query) w/o any flow rule, just via the action object handle. For example, when querying or resetting a counter, it could be done out of any flow using this counter, but only the handle of the counter action object is required. The indirect action object could be shared by different flows or used by a single flow, depending on the direct action type and the real-life requirements. The handle of an indirect action object is opaque and defined in each driver and possibly different per direct action type. The old name "shared" is improper in a sense and should be replaced. Since the APIs are changed from "rte_flow_shared_action*" to the new "rte_flow_action_handle*", the testpmd application code and command line interfaces also need to be updated to do the adaption. The testpmd application user guide is also updated. All the "shared action" related parts are replaced with "indirect action" to have a correct explanation. The parameter of "update" interface is also changed. A general pointer will replace the rte_flow_action struct pointer due to the facts: 1. Some action may not support fields updating. In the example of a counter, the only "update" supported should be the reset. So passing a rte_flow_action struct pointer is meaningless and there is even no such corresponding action struct. What's more, if more than one operations should be supported, for some other action, such pointer parameter may not meet the need. 2. Some action may need conditional or partial update, the current parameter will not provide the ability to indicate which part(s) to update. For different types of indirect action objects, the pointer could either be the same of rte_flow_action* struct - in order not to break the current driver implementation, or some wrapper structures with bits as masks to indicate which part to be updated, depending on real needs of the corresponding direct action. For different direct actions, the structures of indirect action objects updating will be different. All the underlayer PMD callbacks will be moved to these new APIs. The RTE_FLOW_ACTION_TYPE_SHARED is kept for now in order not to break the ABI. All the implementations are changed by using RTE_FLOW_ACTION_TYPE_INDIRECT. Since the APIs are changed from "rte_flow_shared_action*" to the new "rte_flow_action_handle*" and the "update" interface's 3rd input parameter is changed to generic pointer, the mlx5 PMD that uses these APIs needs to do the adaption to the new APIs as well. Signed-off-by: Bing Zhao <bingz@nvidia.com> Acked-by: Andrey Vesnovaty <andreyv@nvidia.com> Acked-by: Ori Kam <orika@nvidia.com> Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com> Acked-by: Thomas Monjalon <thomas@monjalon.net>
165 lines
4.6 KiB
C
165 lines
4.6 KiB
C
/* SPDX-License-Identifier: BSD-3-Clause
|
|
* Copyright 2016 6WIND S.A.
|
|
* Copyright 2016 Mellanox Technologies, Ltd
|
|
*/
|
|
|
|
#ifndef RTE_FLOW_DRIVER_H_
|
|
#define RTE_FLOW_DRIVER_H_
|
|
|
|
/**
|
|
* @file
|
|
* RTE generic flow API (driver side)
|
|
*
|
|
* This file provides implementation helpers for internal use by PMDs, they
|
|
* are not intended to be exposed to applications and are not subject to ABI
|
|
* versioning.
|
|
*/
|
|
|
|
#include <stdint.h>
|
|
|
|
#include "rte_ethdev.h"
|
|
#include "ethdev_driver.h"
|
|
#include "rte_flow.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* Generic flow operations structure implemented and returned by PMDs.
|
|
*
|
|
* These callback functions are not supposed to be used by applications
|
|
* directly, which must rely on the API defined in rte_flow.h.
|
|
*
|
|
* Public-facing wrapper functions perform a few consistency checks so that
|
|
* unimplemented (i.e. NULL) callbacks simply return -ENOTSUP. These
|
|
* callbacks otherwise only differ by their first argument (with port ID
|
|
* already resolved to a pointer to struct rte_eth_dev).
|
|
*/
|
|
struct rte_flow_ops {
|
|
/** See rte_flow_validate(). */
|
|
int (*validate)
|
|
(struct rte_eth_dev *,
|
|
const struct rte_flow_attr *,
|
|
const struct rte_flow_item [],
|
|
const struct rte_flow_action [],
|
|
struct rte_flow_error *);
|
|
/** See rte_flow_create(). */
|
|
struct rte_flow *(*create)
|
|
(struct rte_eth_dev *,
|
|
const struct rte_flow_attr *,
|
|
const struct rte_flow_item [],
|
|
const struct rte_flow_action [],
|
|
struct rte_flow_error *);
|
|
/** See rte_flow_destroy(). */
|
|
int (*destroy)
|
|
(struct rte_eth_dev *,
|
|
struct rte_flow *,
|
|
struct rte_flow_error *);
|
|
/** See rte_flow_flush(). */
|
|
int (*flush)
|
|
(struct rte_eth_dev *,
|
|
struct rte_flow_error *);
|
|
/** See rte_flow_query(). */
|
|
int (*query)
|
|
(struct rte_eth_dev *,
|
|
struct rte_flow *,
|
|
const struct rte_flow_action *,
|
|
void *,
|
|
struct rte_flow_error *);
|
|
/** See rte_flow_isolate(). */
|
|
int (*isolate)
|
|
(struct rte_eth_dev *,
|
|
int,
|
|
struct rte_flow_error *);
|
|
/** See rte_flow_dev_dump(). */
|
|
int (*dev_dump)
|
|
(struct rte_eth_dev *dev,
|
|
struct rte_flow *flow,
|
|
FILE *file,
|
|
struct rte_flow_error *error);
|
|
/** See rte_flow_get_aged_flows() */
|
|
int (*get_aged_flows)
|
|
(struct rte_eth_dev *dev,
|
|
void **context,
|
|
uint32_t nb_contexts,
|
|
struct rte_flow_error *err);
|
|
/** See rte_flow_action_handle_create() */
|
|
struct rte_flow_action_handle *(*action_handle_create)
|
|
(struct rte_eth_dev *dev,
|
|
const struct rte_flow_indir_action_conf *conf,
|
|
const struct rte_flow_action *action,
|
|
struct rte_flow_error *error);
|
|
/** See rte_flow_action_handle_destroy() */
|
|
int (*action_handle_destroy)
|
|
(struct rte_eth_dev *dev,
|
|
struct rte_flow_action_handle *handle,
|
|
struct rte_flow_error *error);
|
|
/** See rte_flow_action_handle_update() */
|
|
int (*action_handle_update)
|
|
(struct rte_eth_dev *dev,
|
|
struct rte_flow_action_handle *handle,
|
|
const void *update,
|
|
struct rte_flow_error *error);
|
|
/** See rte_flow_action_handle_query() */
|
|
int (*action_handle_query)
|
|
(struct rte_eth_dev *dev,
|
|
const struct rte_flow_action_handle *handle,
|
|
void *data,
|
|
struct rte_flow_error *error);
|
|
/** See rte_flow_tunnel_decap_set() */
|
|
int (*tunnel_decap_set)
|
|
(struct rte_eth_dev *dev,
|
|
struct rte_flow_tunnel *tunnel,
|
|
struct rte_flow_action **pmd_actions,
|
|
uint32_t *num_of_actions,
|
|
struct rte_flow_error *err);
|
|
/** See rte_flow_tunnel_match() */
|
|
int (*tunnel_match)
|
|
(struct rte_eth_dev *dev,
|
|
struct rte_flow_tunnel *tunnel,
|
|
struct rte_flow_item **pmd_items,
|
|
uint32_t *num_of_items,
|
|
struct rte_flow_error *err);
|
|
/** See rte_flow_get_rte_flow_restore_info() */
|
|
int (*get_restore_info)
|
|
(struct rte_eth_dev *dev,
|
|
struct rte_mbuf *m,
|
|
struct rte_flow_restore_info *info,
|
|
struct rte_flow_error *err);
|
|
/** See rte_flow_action_tunnel_decap_release() */
|
|
int (*tunnel_action_decap_release)
|
|
(struct rte_eth_dev *dev,
|
|
struct rte_flow_action *pmd_actions,
|
|
uint32_t num_of_actions,
|
|
struct rte_flow_error *err);
|
|
/** See rte_flow_item_release() */
|
|
int (*tunnel_item_release)
|
|
(struct rte_eth_dev *dev,
|
|
struct rte_flow_item *pmd_items,
|
|
uint32_t num_of_items,
|
|
struct rte_flow_error *err);
|
|
};
|
|
|
|
/**
|
|
* Get generic flow operations structure from a port.
|
|
*
|
|
* @param port_id
|
|
* Port identifier to query.
|
|
* @param[out] error
|
|
* Pointer to flow error structure.
|
|
*
|
|
* @return
|
|
* The flow operations structure associated with port_id, NULL in case of
|
|
* error, in which case rte_errno is set and the error structure contains
|
|
* additional details.
|
|
*/
|
|
const struct rte_flow_ops *
|
|
rte_flow_ops_get(uint16_t port_id, struct rte_flow_error *error);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* RTE_FLOW_DRIVER_H_ */
|