13cd6d5cc7
Queue-based flow rules management mechanism is suitable not only for flow rules creation/destruction, but also for speeding up other types of Flow API management. Indirect action object operations may be executed asynchronously as well. Provide async versions for all indirect action operations, namely: rte_flow_async_action_handle_create, rte_flow_async_action_handle_destroy and rte_flow_async_action_handle_update. Signed-off-by: Alexander Kozyrev <akozyrev@nvidia.com> Acked-by: Ori Kam <orika@nvidia.com> Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
286 lines
8.8 KiB
C
286 lines
8.8 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);
|
|
/** See rte_flow_pick_transfer_proxy() */
|
|
int (*pick_transfer_proxy)
|
|
(struct rte_eth_dev *dev,
|
|
uint16_t *proxy_port_id,
|
|
struct rte_flow_error *error);
|
|
struct rte_flow_item_flex_handle *(*flex_item_create)
|
|
(struct rte_eth_dev *dev,
|
|
const struct rte_flow_item_flex_conf *conf,
|
|
struct rte_flow_error *error);
|
|
int (*flex_item_release)
|
|
(struct rte_eth_dev *dev,
|
|
const struct rte_flow_item_flex_handle *handle,
|
|
struct rte_flow_error *error);
|
|
/** See rte_flow_info_get() */
|
|
int (*info_get)
|
|
(struct rte_eth_dev *dev,
|
|
struct rte_flow_port_info *port_info,
|
|
struct rte_flow_queue_info *queue_info,
|
|
struct rte_flow_error *err);
|
|
/** See rte_flow_configure() */
|
|
int (*configure)
|
|
(struct rte_eth_dev *dev,
|
|
const struct rte_flow_port_attr *port_attr,
|
|
uint16_t nb_queue,
|
|
const struct rte_flow_queue_attr *queue_attr[],
|
|
struct rte_flow_error *err);
|
|
/** See rte_flow_pattern_template_create() */
|
|
struct rte_flow_pattern_template *(*pattern_template_create)
|
|
(struct rte_eth_dev *dev,
|
|
const struct rte_flow_pattern_template_attr *template_attr,
|
|
const struct rte_flow_item pattern[],
|
|
struct rte_flow_error *err);
|
|
/** See rte_flow_pattern_template_destroy() */
|
|
int (*pattern_template_destroy)
|
|
(struct rte_eth_dev *dev,
|
|
struct rte_flow_pattern_template *pattern_template,
|
|
struct rte_flow_error *err);
|
|
/** See rte_flow_actions_template_create() */
|
|
struct rte_flow_actions_template *(*actions_template_create)
|
|
(struct rte_eth_dev *dev,
|
|
const struct rte_flow_actions_template_attr *template_attr,
|
|
const struct rte_flow_action actions[],
|
|
const struct rte_flow_action masks[],
|
|
struct rte_flow_error *err);
|
|
/** See rte_flow_actions_template_destroy() */
|
|
int (*actions_template_destroy)
|
|
(struct rte_eth_dev *dev,
|
|
struct rte_flow_actions_template *actions_template,
|
|
struct rte_flow_error *err);
|
|
/** See rte_flow_template_table_create() */
|
|
struct rte_flow_template_table *(*template_table_create)
|
|
(struct rte_eth_dev *dev,
|
|
const struct rte_flow_template_table_attr *table_attr,
|
|
struct rte_flow_pattern_template *pattern_templates[],
|
|
uint8_t nb_pattern_templates,
|
|
struct rte_flow_actions_template *actions_templates[],
|
|
uint8_t nb_actions_templates,
|
|
struct rte_flow_error *err);
|
|
/** See rte_flow_template_table_destroy() */
|
|
int (*template_table_destroy)
|
|
(struct rte_eth_dev *dev,
|
|
struct rte_flow_template_table *template_table,
|
|
struct rte_flow_error *err);
|
|
/** See rte_flow_async_create() */
|
|
struct rte_flow *(*async_create)
|
|
(struct rte_eth_dev *dev,
|
|
uint32_t queue_id,
|
|
const struct rte_flow_op_attr *op_attr,
|
|
struct rte_flow_template_table *template_table,
|
|
const struct rte_flow_item pattern[],
|
|
uint8_t pattern_template_index,
|
|
const struct rte_flow_action actions[],
|
|
uint8_t actions_template_index,
|
|
void *user_data,
|
|
struct rte_flow_error *err);
|
|
/** See rte_flow_async_destroy() */
|
|
int (*async_destroy)
|
|
(struct rte_eth_dev *dev,
|
|
uint32_t queue_id,
|
|
const struct rte_flow_op_attr *op_attr,
|
|
struct rte_flow *flow,
|
|
void *user_data,
|
|
struct rte_flow_error *err);
|
|
/** See rte_flow_push() */
|
|
int (*push)
|
|
(struct rte_eth_dev *dev,
|
|
uint32_t queue_id,
|
|
struct rte_flow_error *err);
|
|
/** See rte_flow_pull() */
|
|
int (*pull)
|
|
(struct rte_eth_dev *dev,
|
|
uint32_t queue_id,
|
|
struct rte_flow_op_result res[],
|
|
uint16_t n_res,
|
|
struct rte_flow_error *error);
|
|
/** See rte_flow_async_action_handle_create() */
|
|
struct rte_flow_action_handle *(*async_action_handle_create)
|
|
(struct rte_eth_dev *dev,
|
|
uint32_t queue_id,
|
|
const struct rte_flow_op_attr *op_attr,
|
|
const struct rte_flow_indir_action_conf *indir_action_conf,
|
|
const struct rte_flow_action *action,
|
|
void *user_data,
|
|
struct rte_flow_error *err);
|
|
/** See rte_flow_async_action_handle_destroy() */
|
|
int (*async_action_handle_destroy)
|
|
(struct rte_eth_dev *dev,
|
|
uint32_t queue_id,
|
|
const struct rte_flow_op_attr *op_attr,
|
|
struct rte_flow_action_handle *action_handle,
|
|
void *user_data,
|
|
struct rte_flow_error *error);
|
|
/** See rte_flow_async_action_handle_update() */
|
|
int (*async_action_handle_update)
|
|
(struct rte_eth_dev *dev,
|
|
uint32_t queue_id,
|
|
const struct rte_flow_op_attr *op_attr,
|
|
struct rte_flow_action_handle *action_handle,
|
|
const void *update,
|
|
void *user_data,
|
|
struct rte_flow_error *error);
|
|
};
|
|
|
|
/**
|
|
* 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_ */
|