1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation
5 #ifndef __INCLUDE_RTE_SCHED_H__
6 #define __INCLUDE_RTE_SCHED_H__
14 * RTE Hierarchical Scheduler
16 * The hierarchical scheduler prioritizes the transmission of packets
17 * from different users and traffic classes according to the Service
18 * Level Agreements (SLAs) defined for the current network node.
20 * The scheduler supports thousands of packet queues grouped under a
23 * - Typical usage: output Ethernet port;
24 * - Multiple ports are scheduled in round robin order with
27 * - Typical usage: group of users;
28 * - Traffic shaping using the token bucket algorithm
29 * (one bucket per subport);
30 * - Upper limit enforced per traffic class at subport level;
31 * - Lower priority traffic classes able to reuse subport
32 * bandwidth currently unused by higher priority traffic
33 * classes of the same subport;
34 * - When any subport traffic class is oversubscribed
35 * (configuration time event), the usage of subport member
36 * pipes with high demand for thattraffic class pipes is
37 * truncated to a dynamically adjusted value with no
38 * impact to low demand pipes;
40 * - Typical usage: individual user/subscriber;
41 * - Traffic shaping using the token bucket algorithm
42 * (one bucket per pipe);
44 * - Traffic classes of the same pipe handled in strict
46 * - Upper limit enforced per traffic class at the pipe level;
47 * - Lower priority traffic classes able to reuse pipe
48 * bandwidth currently unused by higher priority traffic
49 * classes of the same pipe;
51 * - Typical usage: queue hosting packets from one or
52 * multiple connections of same traffic class belonging to
54 * - Weighted Round Robin (WRR) is used to service the
55 * queues within same pipe traffic class.
59 #include <sys/types.h>
60 #include <rte_compat.h>
62 #include <rte_meter.h>
64 /** Random Early Detection (RED) */
69 /** Number of traffic classes per pipe (as well as subport).
72 #define RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE 4
74 /** Number of queues per pipe traffic class. Cannot be changed. */
75 #define RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS 4
77 /** Number of queues per pipe. */
78 #define RTE_SCHED_QUEUES_PER_PIPE \
79 (RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE * \
80 RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS)
82 /** Maximum number of pipe profiles that can be defined per port.
83 * Compile-time configurable.
85 #ifndef RTE_SCHED_PIPE_PROFILES_PER_PORT
86 #define RTE_SCHED_PIPE_PROFILES_PER_PORT 256
90 * Ethernet framing overhead. Overhead fields per Ethernet frame:
91 * 1. Preamble: 7 bytes;
92 * 2. Start of Frame Delimiter (SFD): 1 byte;
93 * 3. Frame Check Sequence (FCS): 4 bytes;
94 * 4. Inter Frame Gap (IFG): 12 bytes.
96 * The FCS is considered overhead only if not included in the packet
97 * length (field pkt_len of struct rte_mbuf).
99 #ifndef RTE_SCHED_FRAME_OVERHEAD_DEFAULT
100 #define RTE_SCHED_FRAME_OVERHEAD_DEFAULT 24
104 * Subport configuration parameters. The period and credits_per_period
105 * parameters are measured in bytes, with one byte meaning the time
106 * duration associated with the transmission of one byte on the
107 * physical medium of the output port, with pipe or pipe traffic class
108 * rate (measured as percentage of output port rate) determined as
109 * credits_per_period divided by period. One credit represents one
112 struct rte_sched_subport_params {
113 /* Subport token bucket */
114 uint32_t tb_rate; /**< Rate (measured in bytes per second) */
115 uint32_t tb_size; /**< Size (measured in credits) */
117 /* Subport traffic classes */
118 uint32_t tc_rate[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];
119 /**< Traffic class rates (measured in bytes per second) */
121 /**< Enforcement period for rates (measured in milliseconds) */
124 /** Subport statistics */
125 struct rte_sched_subport_stats {
127 uint32_t n_pkts_tc[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];
128 /**< Number of packets successfully written */
129 uint32_t n_pkts_tc_dropped[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];
130 /**< Number of packets dropped */
133 uint32_t n_bytes_tc[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];
134 /**< Number of bytes successfully written for each traffic class */
135 uint32_t n_bytes_tc_dropped[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];
136 /**< Number of bytes dropped for each traffic class */
139 uint32_t n_pkts_red_dropped[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];
140 /**< Number of packets dropped by red */
145 * Pipe configuration parameters. The period and credits_per_period
146 * parameters are measured in bytes, with one byte meaning the time
147 * duration associated with the transmission of one byte on the
148 * physical medium of the output port, with pipe or pipe traffic class
149 * rate (measured as percentage of output port rate) determined as
150 * credits_per_period divided by period. One credit represents one
153 struct rte_sched_pipe_params {
154 /* Pipe token bucket */
155 uint32_t tb_rate; /**< Rate (measured in bytes per second) */
156 uint32_t tb_size; /**< Size (measured in credits) */
158 /* Pipe traffic classes */
159 uint32_t tc_rate[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];
160 /**< Traffic class rates (measured in bytes per second) */
162 /**< Enforcement period (measured in milliseconds) */
163 #ifdef RTE_SCHED_SUBPORT_TC_OV
164 uint8_t tc_ov_weight; /**< Weight Traffic class 3 oversubscription */
168 uint8_t wrr_weights[RTE_SCHED_QUEUES_PER_PIPE]; /**< WRR weights */
171 /** Queue statistics */
172 struct rte_sched_queue_stats {
174 uint32_t n_pkts; /**< Packets successfully written */
175 uint32_t n_pkts_dropped; /**< Packets dropped */
177 uint32_t n_pkts_red_dropped; /**< Packets dropped by RED */
181 uint32_t n_bytes; /**< Bytes successfully written */
182 uint32_t n_bytes_dropped; /**< Bytes dropped */
185 /** Port configuration parameters. */
186 struct rte_sched_port_params {
187 const char *name; /**< String to be associated */
188 int socket; /**< CPU socket ID */
189 uint32_t rate; /**< Output port rate
190 * (measured in bytes per second) */
191 uint32_t mtu; /**< Maximum Ethernet frame size
192 * (measured in bytes).
193 * Should not include the framing overhead. */
194 uint32_t frame_overhead; /**< Framing overhead per packet
195 * (measured in bytes) */
196 uint32_t n_subports_per_port; /**< Number of subports */
197 uint32_t n_pipes_per_subport; /**< Number of pipes per subport */
198 uint16_t qsize[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];
199 /**< Packet queue size for each traffic class.
200 * All queues within the same pipe traffic class have the same
201 * size. Queues from different pipes serving the same traffic
202 * class have the same size. */
203 struct rte_sched_pipe_params *pipe_profiles;
204 /**< Pipe profile table.
205 * Every pipe is configured using one of the profiles from this table. */
206 uint32_t n_pipe_profiles; /**< Profiles in the pipe profile table */
208 struct rte_red_params red_params[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE][e_RTE_METER_COLORS]; /**< RED parameters */
218 * Hierarchical scheduler port configuration
221 * Port scheduler configuration parameter structure
223 * Handle to port scheduler instance upon success or NULL otherwise.
225 struct rte_sched_port *
226 rte_sched_port_config(struct rte_sched_port_params *params);
229 * Hierarchical scheduler port free
232 * Handle to port scheduler instance
235 rte_sched_port_free(struct rte_sched_port *port);
239 * @b EXPERIMENTAL: this API may change without prior notice.
241 * Hierarchical scheduler pipe profile add
244 * Handle to port scheduler instance
246 * Pipe profile parameters
247 * @param pipe_profile_id
248 * Set to valid profile id when profile is added successfully.
250 * 0 upon success, error code otherwise
252 int __rte_experimental
253 rte_sched_port_pipe_profile_add(struct rte_sched_port *port,
254 struct rte_sched_pipe_params *params,
255 uint32_t *pipe_profile_id);
258 * Hierarchical scheduler subport configuration
261 * Handle to port scheduler instance
265 * Subport configuration parameters
267 * 0 upon success, error code otherwise
270 rte_sched_subport_config(struct rte_sched_port *port,
272 struct rte_sched_subport_params *params);
275 * Hierarchical scheduler pipe configuration
278 * Handle to port scheduler instance
282 * Pipe ID within subport
283 * @param pipe_profile
284 * ID of port-level pre-configured pipe profile
286 * 0 upon success, error code otherwise
289 rte_sched_pipe_config(struct rte_sched_port *port,
292 int32_t pipe_profile);
295 * Hierarchical scheduler memory footprint size per port
298 * Port scheduler configuration parameter structure
300 * Memory footprint size in bytes upon success, 0 otherwise
303 rte_sched_port_get_memory_footprint(struct rte_sched_port_params *params);
311 * Hierarchical scheduler subport statistics read
314 * Handle to port scheduler instance
318 * Pointer to pre-allocated subport statistics structure where the statistics
319 * counters should be stored
321 * Pointer to pre-allocated 4-entry array where the oversubscription status for
322 * each of the 4 subport traffic classes should be stored.
324 * 0 upon success, error code otherwise
327 rte_sched_subport_read_stats(struct rte_sched_port *port,
329 struct rte_sched_subport_stats *stats,
333 * Hierarchical scheduler queue statistics read
336 * Handle to port scheduler instance
338 * Queue ID within port scheduler
340 * Pointer to pre-allocated subport statistics structure where the statistics
341 * counters should be stored
343 * Pointer to pre-allocated variable where the current queue length
346 * 0 upon success, error code otherwise
349 rte_sched_queue_read_stats(struct rte_sched_port *port,
351 struct rte_sched_queue_stats *stats,
355 * Scheduler hierarchy path write to packet descriptor. Typically
356 * called by the packet classification stage.
359 * Packet descriptor handle
363 * Pipe ID within subport
364 * @param traffic_class
365 * Traffic class ID within pipe (0 .. 3)
367 * Queue ID within pipe traffic class (0 .. 3)
372 rte_sched_port_pkt_write(struct rte_mbuf *pkt,
373 uint32_t subport, uint32_t pipe, uint32_t traffic_class,
374 uint32_t queue, enum rte_meter_color color);
377 * Scheduler hierarchy path read from packet descriptor (struct
378 * rte_mbuf). Typically called as part of the hierarchical scheduler
379 * enqueue operation. The subport, pipe, traffic class and queue
380 * parameters need to be pre-allocated by the caller.
383 * Packet descriptor handle
387 * Pipe ID within subport
388 * @param traffic_class
389 * Traffic class ID within pipe (0 .. 3)
391 * Queue ID within pipe traffic class (0 .. 3)
395 rte_sched_port_pkt_read_tree_path(const struct rte_mbuf *pkt,
396 uint32_t *subport, uint32_t *pipe,
397 uint32_t *traffic_class, uint32_t *queue);
400 rte_sched_port_pkt_read_color(const struct rte_mbuf *pkt);
403 * Hierarchical scheduler port enqueue. Writes up to n_pkts to port
404 * scheduler and returns the number of packets actually written. For
405 * each packet, the port scheduler queue to write the packet to is
406 * identified by reading the hierarchy path from the packet
407 * descriptor; if the queue is full or congested and the packet is not
408 * written to the queue, then the packet is automatically dropped
409 * without any action required from the caller.
412 * Handle to port scheduler instance
414 * Array storing the packet descriptor handles
416 * Number of packets to enqueue from the pkts array into the port scheduler
418 * Number of packets successfully enqueued
421 rte_sched_port_enqueue(struct rte_sched_port *port, struct rte_mbuf **pkts, uint32_t n_pkts);
424 * Hierarchical scheduler port dequeue. Reads up to n_pkts from the
425 * port scheduler and stores them in the pkts array and returns the
426 * number of packets actually read. The pkts array needs to be
427 * pre-allocated by the caller with at least n_pkts entries.
430 * Handle to port scheduler instance
432 * Pre-allocated packet descriptor array where the packets dequeued
434 * scheduler should be stored
436 * Number of packets to dequeue from the port scheduler
438 * Number of packets successfully dequeued and placed in the pkts array
441 rte_sched_port_dequeue(struct rte_sched_port *port, struct rte_mbuf **pkts, uint32_t n_pkts);
447 #endif /* __INCLUDE_RTE_SCHED_H__ */