1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright(c) 2010-2014 Intel Corporation 3 */ 4 5 #ifndef __INCLUDE_RTE_SCHED_H__ 6 #define __INCLUDE_RTE_SCHED_H__ 7 8 #ifdef __cplusplus 9 extern "C" { 10 #endif 11 12 /** 13 * @file 14 * RTE Hierarchical Scheduler 15 * 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. 19 * 20 * The scheduler supports thousands of packet queues grouped under a 21 * 5-level hierarchy: 22 * 1. Port: 23 * - Typical usage: output Ethernet port; 24 * - Multiple ports are scheduled in round robin order with 25 * equal priority; 26 * 2. Subport: 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 that traffic class pipes is 37 * truncated to a dynamically adjusted value with no 38 * impact to low demand pipes; 39 * 3. Pipe: 40 * - Typical usage: individual user/subscriber; 41 * - Traffic shaping using the token bucket algorithm 42 * (one bucket per pipe); 43 * 4. Traffic class: 44 * - Traffic classes of the same pipe handled in strict 45 * priority order; 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; 50 * 5. Queue: 51 * - Typical usage: queue hosting packets from one or 52 * multiple connections of same traffic class belonging to 53 * the same user; 54 * - Weighted Round Robin (WRR) is used to service the 55 * queues within same pipe lowest priority traffic class (best-effort). 56 * 57 */ 58 59 #include <sys/types.h> 60 #include <rte_compat.h> 61 #include <rte_mbuf.h> 62 #include <rte_meter.h> 63 64 /** Random Early Detection (RED) */ 65 #ifdef RTE_SCHED_RED 66 #include "rte_red.h" 67 #endif 68 69 /** Maximum number of queues per pipe. 70 * Note that the multiple queues (power of 2) can only be assigned to 71 * lowest priority (best-effort) traffic class. Other higher priority traffic 72 * classes can only have one queue. 73 * Can not change. 74 * 75 * @see struct rte_sched_port_params 76 */ 77 #define RTE_SCHED_QUEUES_PER_PIPE 16 78 79 /** Number of WRR queues for best-effort traffic class per pipe. 80 * 81 * @see struct rte_sched_pipe_params 82 */ 83 #define RTE_SCHED_BE_QUEUES_PER_PIPE 4 84 85 /** Number of traffic classes per pipe (as well as subport). 86 * @see struct rte_sched_subport_params 87 * @see struct rte_sched_pipe_params 88 */ 89 #define RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE \ 90 (RTE_SCHED_QUEUES_PER_PIPE - RTE_SCHED_BE_QUEUES_PER_PIPE + 1) 91 92 /** Best-effort traffic class ID 93 * Can not change. 94 */ 95 #define RTE_SCHED_TRAFFIC_CLASS_BE (RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE - 1) 96 97 /* 98 * Ethernet framing overhead. Overhead fields per Ethernet frame: 99 * 1. Preamble: 7 bytes; 100 * 2. Start of Frame Delimiter (SFD): 1 byte; 101 * 3. Frame Check Sequence (FCS): 4 bytes; 102 * 4. Inter Frame Gap (IFG): 12 bytes. 103 * 104 * The FCS is considered overhead only if not included in the packet 105 * length (field pkt_len of struct rte_mbuf). 106 * 107 * @see struct rte_sched_port_params 108 */ 109 #ifndef RTE_SCHED_FRAME_OVERHEAD_DEFAULT 110 #define RTE_SCHED_FRAME_OVERHEAD_DEFAULT 24 111 #endif 112 113 /* 114 * Pipe configuration parameters. The period and credits_per_period 115 * parameters are measured in bytes, with one byte meaning the time 116 * duration associated with the transmission of one byte on the 117 * physical medium of the output port, with pipe or pipe traffic class 118 * rate (measured as percentage of output port rate) determined as 119 * credits_per_period divided by period. One credit represents one 120 * byte. 121 */ 122 struct rte_sched_pipe_params { 123 /** Token bucket rate (measured in bytes per second) */ 124 uint64_t tb_rate; 125 126 /** Token bucket size (measured in credits) */ 127 uint64_t tb_size; 128 129 /** Traffic class rates (measured in bytes per second) */ 130 uint64_t tc_rate[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; 131 132 /** Enforcement period (measured in milliseconds) */ 133 uint64_t tc_period; 134 135 /** Best-effort traffic class oversubscription weight */ 136 uint8_t tc_ov_weight; 137 138 /** WRR weights of best-effort traffic class queues */ 139 uint8_t wrr_weights[RTE_SCHED_BE_QUEUES_PER_PIPE]; 140 }; 141 142 /* 143 * Subport configuration parameters. The period and credits_per_period 144 * parameters are measured in bytes, with one byte meaning the time 145 * duration associated with the transmission of one byte on the 146 * physical medium of the output port, with pipe or pipe traffic class 147 * rate (measured as percentage of output port rate) determined as 148 * credits_per_period divided by period. One credit represents one 149 * byte. 150 */ 151 struct rte_sched_subport_params { 152 /** Number of subport pipes. 153 * The subport can enable/allocate fewer pipes than the maximum 154 * number set through struct port_params::n_max_pipes_per_subport, 155 * as needed, to avoid memory allocation for the queues of the 156 * pipes that are not really needed. 157 */ 158 uint32_t n_pipes_per_subport_enabled; 159 160 /** Packet queue size for each traffic class. 161 * All the pipes within the same subport share the similar 162 * configuration for the queues. 163 */ 164 uint16_t qsize[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; 165 166 /** Pipe profile table. 167 * Every pipe is configured using one of the profiles from this table. 168 */ 169 struct rte_sched_pipe_params *pipe_profiles; 170 171 /** Profiles in the pipe profile table */ 172 uint32_t n_pipe_profiles; 173 174 /** Max allowed profiles in the pipe profile table */ 175 uint32_t n_max_pipe_profiles; 176 177 #ifdef RTE_SCHED_RED 178 /** RED parameters */ 179 struct rte_red_params red_params[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE][RTE_COLORS]; 180 #endif 181 }; 182 183 struct rte_sched_subport_profile_params { 184 /** Token bucket rate (measured in bytes per second) */ 185 uint64_t tb_rate; 186 187 /** Token bucket size (measured in credits) */ 188 uint64_t tb_size; 189 190 /** Traffic class rates (measured in bytes per second) */ 191 uint64_t tc_rate[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; 192 193 /** Enforcement period for rates (measured in milliseconds) */ 194 uint64_t tc_period; 195 }; 196 197 /** Subport statistics */ 198 struct rte_sched_subport_stats { 199 /** Number of packets successfully written */ 200 uint64_t n_pkts_tc[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; 201 202 /** Number of packets dropped */ 203 uint64_t n_pkts_tc_dropped[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; 204 205 /** Number of bytes successfully written for each traffic class */ 206 uint64_t n_bytes_tc[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; 207 208 /** Number of bytes dropped for each traffic class */ 209 uint64_t n_bytes_tc_dropped[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; 210 211 #ifdef RTE_SCHED_RED 212 /** Number of packets dropped by red */ 213 uint64_t n_pkts_red_dropped[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; 214 #endif 215 }; 216 217 /** Queue statistics */ 218 struct rte_sched_queue_stats { 219 /** Packets successfully written */ 220 uint64_t n_pkts; 221 222 /** Packets dropped */ 223 uint64_t n_pkts_dropped; 224 225 #ifdef RTE_SCHED_RED 226 /** Packets dropped by RED */ 227 uint64_t n_pkts_red_dropped; 228 #endif 229 230 /** Bytes successfully written */ 231 uint64_t n_bytes; 232 233 /** Bytes dropped */ 234 uint64_t n_bytes_dropped; 235 }; 236 237 /** Port configuration parameters. */ 238 struct rte_sched_port_params { 239 /** Name of the port to be associated */ 240 const char *name; 241 242 /** CPU socket ID */ 243 int socket; 244 245 /** Output port rate (measured in bytes per second) */ 246 uint64_t rate; 247 248 /** Maximum Ethernet frame size (measured in bytes). 249 * Should not include the framing overhead. 250 */ 251 uint32_t mtu; 252 253 /** Framing overhead per packet (measured in bytes) */ 254 uint32_t frame_overhead; 255 256 /** Number of subports */ 257 uint32_t n_subports_per_port; 258 259 /** subport profile table. 260 * Every pipe is configured using one of the profiles from this table. 261 */ 262 struct rte_sched_subport_profile_params *subport_profiles; 263 264 /** Profiles in the pipe profile table */ 265 uint32_t n_subport_profiles; 266 267 /** Max allowed profiles in the pipe profile table */ 268 uint32_t n_max_subport_profiles; 269 270 /** Maximum number of subport pipes. 271 * This parameter is used to reserve a fixed number of bits 272 * in struct rte_mbuf::sched.queue_id for the pipe_id for all 273 * the subports of the same port. 274 */ 275 uint32_t n_pipes_per_subport; 276 }; 277 278 /* 279 * Configuration 280 * 281 ***/ 282 283 /** 284 * Hierarchical scheduler port configuration 285 * 286 * @param params 287 * Port scheduler configuration parameter structure 288 * @return 289 * Handle to port scheduler instance upon success or NULL otherwise. 290 */ 291 struct rte_sched_port * 292 rte_sched_port_config(struct rte_sched_port_params *params); 293 294 /** 295 * Hierarchical scheduler port free 296 * 297 * @param port 298 * Handle to port scheduler instance 299 */ 300 void 301 rte_sched_port_free(struct rte_sched_port *port); 302 303 /** 304 * Hierarchical scheduler pipe profile add 305 * 306 * @param port 307 * Handle to port scheduler instance 308 * @param subport_id 309 * Subport ID 310 * @param params 311 * Pipe profile parameters 312 * @param pipe_profile_id 313 * Set to valid profile id when profile is added successfully. 314 * @return 315 * 0 upon success, error code otherwise 316 */ 317 int 318 rte_sched_subport_pipe_profile_add(struct rte_sched_port *port, 319 uint32_t subport_id, 320 struct rte_sched_pipe_params *params, 321 uint32_t *pipe_profile_id); 322 323 /** 324 * @warning 325 * @b EXPERIMENTAL: this API may change without prior notice. 326 * 327 * Hierarchical scheduler subport bandwidth profile add 328 * Note that this function is safe to use in runtime for adding new 329 * subport bandwidth profile as it doesn't have any impact on hiearchical 330 * structure of the scheduler. 331 * @param port 332 * Handle to port scheduler instance 333 * @param profile 334 * Subport bandwidth profile 335 * @param subport_profile_id 336 * Subport profile id 337 * @return 338 * 0 upon success, error code otherwise 339 */ 340 __rte_experimental 341 int 342 rte_sched_port_subport_profile_add(struct rte_sched_port *port, 343 struct rte_sched_subport_profile_params *profile, 344 uint32_t *subport_profile_id); 345 346 /** 347 * Hierarchical scheduler subport configuration 348 * Note that this function is safe to use at runtime 349 * to configure subport bandwidth profile. 350 * @param port 351 * Handle to port scheduler instance 352 * @param subport_id 353 * Subport ID 354 * @param params 355 * Subport configuration parameters. Must be non-NULL 356 * for first invocation (i.e initialization) for a given 357 * subport. Ignored (recommended value is NULL) for all 358 * subsequent invocation on the same subport. 359 * @param subport_profile_id 360 * ID of subport bandwidth profile 361 * @return 362 * 0 upon success, error code otherwise 363 */ 364 int 365 rte_sched_subport_config(struct rte_sched_port *port, 366 uint32_t subport_id, 367 struct rte_sched_subport_params *params, 368 uint32_t subport_profile_id); 369 370 /** 371 * Hierarchical scheduler pipe configuration 372 * 373 * @param port 374 * Handle to port scheduler instance 375 * @param subport_id 376 * Subport ID 377 * @param pipe_id 378 * Pipe ID within subport 379 * @param pipe_profile 380 * ID of subport-level pre-configured pipe profile 381 * @return 382 * 0 upon success, error code otherwise 383 */ 384 int 385 rte_sched_pipe_config(struct rte_sched_port *port, 386 uint32_t subport_id, 387 uint32_t pipe_id, 388 int32_t pipe_profile); 389 390 /** 391 * Hierarchical scheduler memory footprint size per port 392 * 393 * @param port_params 394 * Port scheduler configuration parameter structure 395 * @param subport_params 396 * Array of subport parameter structures 397 * @return 398 * Memory footprint size in bytes upon success, 0 otherwise 399 */ 400 uint32_t 401 rte_sched_port_get_memory_footprint(struct rte_sched_port_params *port_params, 402 struct rte_sched_subport_params **subport_params); 403 /* 404 * Statistics 405 * 406 ***/ 407 408 /** 409 * Hierarchical scheduler subport statistics read 410 * 411 * @param port 412 * Handle to port scheduler instance 413 * @param subport_id 414 * Subport ID 415 * @param stats 416 * Pointer to pre-allocated subport statistics structure where the statistics 417 * counters should be stored 418 * @param tc_ov 419 * Pointer to pre-allocated RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE-entry array 420 * where the oversubscription status for each of the subport traffic classes 421 * should be stored. 422 * @return 423 * 0 upon success, error code otherwise 424 */ 425 int 426 rte_sched_subport_read_stats(struct rte_sched_port *port, 427 uint32_t subport_id, 428 struct rte_sched_subport_stats *stats, 429 uint32_t *tc_ov); 430 431 /** 432 * Hierarchical scheduler queue statistics read 433 * 434 * @param port 435 * Handle to port scheduler instance 436 * @param queue_id 437 * Queue ID within port scheduler 438 * @param stats 439 * Pointer to pre-allocated subport statistics structure where the statistics 440 * counters should be stored 441 * @param qlen 442 * Pointer to pre-allocated variable where the current queue length 443 * should be stored. 444 * @return 445 * 0 upon success, error code otherwise 446 */ 447 int 448 rte_sched_queue_read_stats(struct rte_sched_port *port, 449 uint32_t queue_id, 450 struct rte_sched_queue_stats *stats, 451 uint16_t *qlen); 452 453 /** 454 * Scheduler hierarchy path write to packet descriptor. Typically 455 * called by the packet classification stage. 456 * 457 * @param port 458 * Handle to port scheduler instance 459 * @param pkt 460 * Packet descriptor handle 461 * @param subport 462 * Subport ID 463 * @param pipe 464 * Pipe ID within subport 465 * @param traffic_class 466 * Traffic class ID within pipe (0 .. RTE_SCHED_TRAFFIC_CLASS_BE) 467 * @param queue 468 * Queue ID within pipe traffic class, 0 for high priority TCs, and 469 * 0 .. (RTE_SCHED_BE_QUEUES_PER_PIPE - 1) for best-effort TC 470 * @param color 471 * Packet color set 472 */ 473 void 474 rte_sched_port_pkt_write(struct rte_sched_port *port, 475 struct rte_mbuf *pkt, 476 uint32_t subport, uint32_t pipe, uint32_t traffic_class, 477 uint32_t queue, enum rte_color color); 478 479 /** 480 * Scheduler hierarchy path read from packet descriptor (struct 481 * rte_mbuf). Typically called as part of the hierarchical scheduler 482 * enqueue operation. The subport, pipe, traffic class and queue 483 * parameters need to be pre-allocated by the caller. 484 * 485 * @param port 486 * Handle to port scheduler instance 487 * @param pkt 488 * Packet descriptor handle 489 * @param subport 490 * Subport ID 491 * @param pipe 492 * Pipe ID within subport 493 * @param traffic_class 494 * Traffic class ID within pipe (0 .. RTE_SCHED_TRAFFIC_CLASS_BE) 495 * @param queue 496 * Queue ID within pipe traffic class, 0 for high priority TCs, and 497 * 0 .. (RTE_SCHED_BE_QUEUES_PER_PIPE - 1) for best-effort TC 498 */ 499 void 500 rte_sched_port_pkt_read_tree_path(struct rte_sched_port *port, 501 const struct rte_mbuf *pkt, 502 uint32_t *subport, uint32_t *pipe, 503 uint32_t *traffic_class, uint32_t *queue); 504 505 enum rte_color 506 rte_sched_port_pkt_read_color(const struct rte_mbuf *pkt); 507 508 /** 509 * Hierarchical scheduler port enqueue. Writes up to n_pkts to port 510 * scheduler and returns the number of packets actually written. For 511 * each packet, the port scheduler queue to write the packet to is 512 * identified by reading the hierarchy path from the packet 513 * descriptor; if the queue is full or congested and the packet is not 514 * written to the queue, then the packet is automatically dropped 515 * without any action required from the caller. 516 * 517 * @param port 518 * Handle to port scheduler instance 519 * @param pkts 520 * Array storing the packet descriptor handles 521 * @param n_pkts 522 * Number of packets to enqueue from the pkts array into the port scheduler 523 * @return 524 * Number of packets successfully enqueued 525 */ 526 int 527 rte_sched_port_enqueue(struct rte_sched_port *port, struct rte_mbuf **pkts, uint32_t n_pkts); 528 529 /** 530 * Hierarchical scheduler port dequeue. Reads up to n_pkts from the 531 * port scheduler and stores them in the pkts array and returns the 532 * number of packets actually read. The pkts array needs to be 533 * pre-allocated by the caller with at least n_pkts entries. 534 * 535 * @param port 536 * Handle to port scheduler instance 537 * @param pkts 538 * Pre-allocated packet descriptor array where the packets dequeued 539 * from the port 540 * scheduler should be stored 541 * @param n_pkts 542 * Number of packets to dequeue from the port scheduler 543 * @return 544 * Number of packets successfully dequeued and placed in the pkts array 545 */ 546 int 547 rte_sched_port_dequeue(struct rte_sched_port *port, struct rte_mbuf **pkts, uint32_t n_pkts); 548 549 #ifdef __cplusplus 550 } 551 #endif 552 553 #endif /* __INCLUDE_RTE_SCHED_H__ */ 554