1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright 2016 6WIND S.A. 3 * Copyright 2016 Mellanox Technologies, Ltd 4 */ 5 6 #ifndef RTE_FLOW_DRIVER_H_ 7 #define RTE_FLOW_DRIVER_H_ 8 9 /** 10 * @file 11 * RTE generic flow API (driver side) 12 * 13 * This file provides implementation helpers for internal use by PMDs, they 14 * are not intended to be exposed to applications and are not subject to ABI 15 * versioning. 16 */ 17 18 #include <stdint.h> 19 20 #include "rte_ethdev.h" 21 #include "rte_flow.h" 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /** 28 * Generic flow operations structure implemented and returned by PMDs. 29 * 30 * To implement this API, PMDs must handle the RTE_ETH_FILTER_GENERIC filter 31 * type in their .filter_ctrl callback function (struct eth_dev_ops) as well 32 * as the RTE_ETH_FILTER_GET filter operation. 33 * 34 * If successful, this operation must result in a pointer to a PMD-specific 35 * struct rte_flow_ops written to the argument address as described below: 36 * 37 * \code 38 * 39 * // PMD filter_ctrl callback 40 * 41 * static const struct rte_flow_ops pmd_flow_ops = { ... }; 42 * 43 * switch (filter_type) { 44 * case RTE_ETH_FILTER_GENERIC: 45 * if (filter_op != RTE_ETH_FILTER_GET) 46 * return -EINVAL; 47 * *(const void **)arg = &pmd_flow_ops; 48 * return 0; 49 * } 50 * 51 * \endcode 52 * 53 * See also rte_flow_ops_get(). 54 * 55 * These callback functions are not supposed to be used by applications 56 * directly, which must rely on the API defined in rte_flow.h. 57 * 58 * Public-facing wrapper functions perform a few consistency checks so that 59 * unimplemented (i.e. NULL) callbacks simply return -ENOTSUP. These 60 * callbacks otherwise only differ by their first argument (with port ID 61 * already resolved to a pointer to struct rte_eth_dev). 62 */ 63 struct rte_flow_ops { 64 /** See rte_flow_validate(). */ 65 int (*validate) 66 (struct rte_eth_dev *, 67 const struct rte_flow_attr *, 68 const struct rte_flow_item [], 69 const struct rte_flow_action [], 70 struct rte_flow_error *); 71 /** See rte_flow_create(). */ 72 struct rte_flow *(*create) 73 (struct rte_eth_dev *, 74 const struct rte_flow_attr *, 75 const struct rte_flow_item [], 76 const struct rte_flow_action [], 77 struct rte_flow_error *); 78 /** See rte_flow_destroy(). */ 79 int (*destroy) 80 (struct rte_eth_dev *, 81 struct rte_flow *, 82 struct rte_flow_error *); 83 /** See rte_flow_flush(). */ 84 int (*flush) 85 (struct rte_eth_dev *, 86 struct rte_flow_error *); 87 /** See rte_flow_query(). */ 88 int (*query) 89 (struct rte_eth_dev *, 90 struct rte_flow *, 91 const struct rte_flow_action *, 92 void *, 93 struct rte_flow_error *); 94 /** See rte_flow_isolate(). */ 95 int (*isolate) 96 (struct rte_eth_dev *, 97 int, 98 struct rte_flow_error *); 99 }; 100 101 /** 102 * Get generic flow operations structure from a port. 103 * 104 * @param port_id 105 * Port identifier to query. 106 * @param[out] error 107 * Pointer to flow error structure. 108 * 109 * @return 110 * The flow operations structure associated with port_id, NULL in case of 111 * error, in which case rte_errno is set and the error structure contains 112 * additional details. 113 */ 114 const struct rte_flow_ops * 115 rte_flow_ops_get(uint16_t port_id, struct rte_flow_error *error); 116 117 /** Helper macro to build input graph for rte_flow_expand_rss(). */ 118 #define RTE_FLOW_EXPAND_RSS_NEXT(...) \ 119 (const int []){ \ 120 __VA_ARGS__, 0, \ 121 } 122 123 /** Node object of input graph for rte_flow_expand_rss(). */ 124 struct rte_flow_expand_node { 125 const int *const next; 126 /**< 127 * List of next node indexes. Index 0 is interpreted as a terminator. 128 */ 129 const enum rte_flow_item_type type; 130 /**< Pattern item type of current node. */ 131 uint64_t rss_types; 132 /**< 133 * RSS types bit-field associated with this node 134 * (see ETH_RSS_* definitions). 135 */ 136 }; 137 138 /** Object returned by rte_flow_expand_rss(). */ 139 struct rte_flow_expand_rss { 140 uint32_t entries; 141 /**< Number of entries @p patterns and @p priorities. */ 142 struct { 143 struct rte_flow_item *pattern; /**< Expanded pattern array. */ 144 uint32_t priority; /**< Priority offset for each expansion. */ 145 } entry[]; 146 }; 147 148 /** 149 * Expand RSS flows into several possible flows according to the RSS hash 150 * fields requested and the driver capabilities. 151 * 152 * @b EXPERIMENTAL: this API may change without prior notice 153 * 154 * @param[out] buf 155 * Buffer to store the result expansion. 156 * @param[in] size 157 * Buffer size in bytes. If 0, @p buf can be NULL. 158 * @param[in] pattern 159 * User flow pattern. 160 * @param[in] types 161 * RSS types to expand (see ETH_RSS_* definitions). 162 * @param[in] graph 163 * Input graph to expand @p pattern according to @p types. 164 * @param[in] graph_root_index 165 * Index of root node in @p graph, typically 0. 166 * 167 * @return 168 * A positive value representing the size of @p buf in bytes regardless of 169 * @p size on success, a negative errno value otherwise and rte_errno is 170 * set, the following errors are defined: 171 * 172 * -E2BIG: graph-depth @p graph is too deep. 173 */ 174 int __rte_experimental 175 rte_flow_expand_rss(struct rte_flow_expand_rss *buf, size_t size, 176 const struct rte_flow_item *pattern, uint64_t types, 177 const struct rte_flow_expand_node graph[], 178 int graph_root_index); 179 180 #ifdef __cplusplus 181 } 182 #endif 183 184 #endif /* RTE_FLOW_DRIVER_H_ */ 185