4 * Copyright(c) 2017 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #ifndef __INCLUDE_RTE_ETH_SOFTNIC_INTERNALS_H__
35 #define __INCLUDE_RTE_ETH_SOFTNIC_INTERNALS_H__
40 #include <rte_sched.h>
41 #include <rte_ethdev.h>
42 #include <rte_tm_driver.h>
44 #include "rte_eth_softnic.h"
51 PMD_FEATURE_TM = 1, /**< Traffic Management (TM) */
59 /** Parameters for the soft device (to be created) */
61 const char *name; /**< Name */
62 uint32_t flags; /**< Flags */
64 /** 0 = Access hard device though API only (potentially slower,
66 * 1 = Access hard device private data structures is allowed
67 * (potentially faster).
71 /** Traffic Management (TM) */
73 uint32_t rate; /**< Rate (bytes/second) */
74 uint32_t nb_queues; /**< Number of queues */
75 uint16_t qsize[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];
76 /**< Queue size per traffic class */
77 uint32_t enq_bsz; /**< Enqueue burst size */
78 uint32_t deq_bsz; /**< Dequeue burst size */
82 /** Parameters for the hard device (existing) */
84 char *name; /**< Name */
85 uint16_t tx_queue_id; /**< TX queue ID */
93 #ifndef DEFAULT_BURST_SIZE
94 #define DEFAULT_BURST_SIZE 32
97 #ifndef FLUSH_COUNT_THRESHOLD
98 #define FLUSH_COUNT_THRESHOLD (1 << 17)
101 struct default_internals {
102 struct rte_mbuf **pkts;
105 uint32_t flush_count;
109 * Traffic Management (TM) Internals
112 #ifndef TM_MAX_SUBPORTS
113 #define TM_MAX_SUBPORTS 8
116 #ifndef TM_MAX_PIPES_PER_SUBPORT
117 #define TM_MAX_PIPES_PER_SUBPORT 4096
121 struct rte_sched_port_params port_params;
123 struct rte_sched_subport_params subport_params[TM_MAX_SUBPORTS];
125 struct rte_sched_pipe_params
126 pipe_profiles[RTE_SCHED_PIPE_PROFILES_PER_PORT];
127 uint32_t n_pipe_profiles;
128 uint32_t pipe_to_profile[TM_MAX_SUBPORTS * TM_MAX_PIPES_PER_SUBPORT];
133 TM_NODE_LEVEL_PORT = 0,
134 TM_NODE_LEVEL_SUBPORT,
141 /* TM Shaper Profile */
142 struct tm_shaper_profile {
143 TAILQ_ENTRY(tm_shaper_profile) node;
144 uint32_t shaper_profile_id;
146 struct rte_tm_shaper_params params;
149 TAILQ_HEAD(tm_shaper_profile_list, tm_shaper_profile);
151 /* TM Shared Shaper */
152 struct tm_shared_shaper {
153 TAILQ_ENTRY(tm_shared_shaper) node;
154 uint32_t shared_shaper_id;
156 uint32_t shaper_profile_id;
159 TAILQ_HEAD(tm_shared_shaper_list, tm_shared_shaper);
161 /* TM WRED Profile */
162 struct tm_wred_profile {
163 TAILQ_ENTRY(tm_wred_profile) node;
164 uint32_t wred_profile_id;
166 struct rte_tm_wred_params params;
169 TAILQ_HEAD(tm_wred_profile_list, tm_wred_profile);
173 TAILQ_ENTRY(tm_node) node;
175 uint32_t parent_node_id;
179 struct tm_node *parent_node;
180 struct tm_shaper_profile *shaper_profile;
181 struct tm_wred_profile *wred_profile;
182 struct rte_tm_node_params params;
183 struct rte_tm_node_stats stats;
187 TAILQ_HEAD(tm_node_list, tm_node);
189 /* TM Hierarchy Specification */
190 struct tm_hierarchy {
191 struct tm_shaper_profile_list shaper_profiles;
192 struct tm_shared_shaper_list shared_shapers;
193 struct tm_wred_profile_list wred_profiles;
194 struct tm_node_list nodes;
196 uint32_t n_shaper_profiles;
197 uint32_t n_shared_shapers;
198 uint32_t n_wred_profiles;
201 uint32_t n_tm_nodes[TM_NODE_LEVEL_MAX];
204 struct tm_internals {
205 /** Hierarchy specification
207 * -Hierarchy is unfrozen at init and when port is stopped.
208 * -Hierarchy is frozen on successful hierarchy commit.
209 * -Run-time hierarchy changes are not allowed, therefore it makes
210 * sense to keep the hierarchy frozen after the port is started.
212 struct tm_hierarchy h;
213 int hierarchy_frozen;
216 struct tm_params params;
219 struct rte_sched_port *sched;
220 struct rte_mbuf **pkts_enq;
221 struct rte_mbuf **pkts_deq;
222 uint32_t pkts_enq_len;
224 uint32_t flush_count;
230 struct pmd_internals {
232 struct pmd_params params;
236 struct default_internals def; /**< Default */
237 struct tm_internals tm; /**< Traffic Management */
246 struct pmd_rx_queue {
250 uint16_t rx_queue_id;
255 * Traffic Management (TM) Operation
257 extern const struct rte_tm_ops pmd_tm_ops;
260 tm_params_check(struct pmd_params *params, uint32_t hard_rate);
263 tm_init(struct pmd_internals *p, struct pmd_params *params, int numa_node);
266 tm_free(struct pmd_internals *p);
269 tm_start(struct pmd_internals *p);
272 tm_stop(struct pmd_internals *p);
275 tm_enabled(struct rte_eth_dev *dev)
277 struct pmd_internals *p = dev->data->dev_private;
279 return (p->params.soft.flags & PMD_FEATURE_TM);
283 tm_used(struct rte_eth_dev *dev)
285 struct pmd_internals *p = dev->data->dev_private;
287 return (p->params.soft.flags & PMD_FEATURE_TM) &&
288 p->soft.tm.h.n_tm_nodes[TM_NODE_LEVEL_PORT];
291 #endif /* __INCLUDE_RTE_ETH_SOFTNIC_INTERNALS_H__ */