lib/librte_sched/rte_sched.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  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
  16  *       distribution.
  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.
  20  *
  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.
  32  *
  33  */
  34
  35 #ifndef __INCLUDE_RTE_SCHED_H__
  36 #define __INCLUDE_RTE_SCHED_H__
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 /**
  43  * @file
  44  * RTE Hierarchical Scheduler
  45  *
  46  * The hierarchical scheduler prioritizes the transmission of packets from different
  47  * users and traffic classes according to the Service Level Agreements (SLAs) defined
  48  * for the current network node.
  49  *
  50  * The scheduler supports thousands of packet queues grouped under a 5-level hierarchy:
  51  *     1. Port:
  52  *           - Typical usage: output Ethernet port;
  53  *           - Multiple ports are scheduled in round robin order with equal priority;
  54  *     2. Subport:
  55  *           - Typical usage: group of users;
  56  *           - Traffic shaping using the token bucket algorithm (one bucket per subport);
  57  *           - Upper limit enforced per traffic class at subport level;
  58  *           - Lower priority traffic classes able to reuse subport bandwidth currently
  59  *             unused by higher priority traffic classes of the same subport;
  60  *           - When any subport traffic class is oversubscribed (configuration time
  61  *             event), the usage of subport member pipes with high demand for that
  62  *             traffic class pipes is truncated to a dynamically adjusted value with no
  63  *             impact to low demand pipes;
  64  *     3. Pipe:
  65  *           - Typical usage: individual user/subscriber;
  66  *           - Traffic shaping using the token bucket algorithm (one bucket per pipe);
  67  *     4. Traffic class:
  68  *           - Traffic classes of the same pipe handled in strict priority order;
  69  *           - Upper limit enforced per traffic class at the pipe level;
  70  *           - Lower priority traffic classes able to reuse pipe bandwidth currently
  71  *             unused by higher priority traffic classes of the same pipe;
  72  *     5. Queue:
  73  *           - Typical usage: queue hosting packets from one or multiple connections
  74  *             of same traffic class belonging to the same user;
  75  *           - Weighted Round Robin (WRR) is used to service the queues within same
  76  *             pipe traffic class.
  77  *
  78  ***/
  79
  80 #include <sys/types.h>
  81 #include <rte_mbuf.h>
  82 #include <rte_meter.h>
  83
  84 /** Random Early Detection (RED) */
  85 #ifdef RTE_SCHED_RED
  86 #include "rte_red.h"
  87 #endif
  88
  89 /** Number of traffic classes per pipe (as well as subport). Cannot be changed. */
  90 #define RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE    4
  91
  92 /** Number of queues per pipe traffic class. Cannot be changed. */
  93 #define RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS    4
  94
  95 /** Number of queues per pipe. */
  96 #define RTE_SCHED_QUEUES_PER_PIPE             \
  97         (RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE *     \
  98         RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS)
  99
 100 /** Maximum number of pipe profiles that can be defined per port. Compile-time configurable.*/
 101 #ifndef RTE_SCHED_PIPE_PROFILES_PER_PORT
 102 #define RTE_SCHED_PIPE_PROFILES_PER_PORT      256
 103 #endif
 104
 105 /** Ethernet framing overhead. Overhead fields per Ethernet frame:
 106    1. Preamble:                             7 bytes;
 107    2. Start of Frame Delimiter (SFD):       1 byte;
 108    3. Frame Check Sequence (FCS):           4 bytes;
 109    4. Inter Frame Gap (IFG):               12 bytes.
 110 The FCS is considered overhead only if not included in the packet length (field pkt.pkt_len
 111 of struct rte_mbuf). */
 112 #ifndef RTE_SCHED_FRAME_OVERHEAD_DEFAULT
 113 #define RTE_SCHED_FRAME_OVERHEAD_DEFAULT      24
 114 #endif
 115
 116 /** Subport configuration parameters. The period and credits_per_period parameters are measured
 117 in bytes, with one byte meaning the time duration associated with the transmission of one byte
 118 on the physical medium of the output port, with pipe or pipe traffic class rate (measured as
 119 percentage of output port rate) determined as credits_per_period divided by period. One credit
 120 represents one byte. */
 121 struct rte_sched_subport_params {
 122         /* Subport token bucket */
 123         uint32_t tb_rate;                /**< Subport token bucket rate (measured in bytes per second) */
 124         uint32_t tb_size;                /**< Subport token bucket size (measured in credits) */
 125
 126         /* Subport traffic classes */
 127         uint32_t tc_rate[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; /**< Subport traffic class rates (measured in bytes per second) */
 128         uint32_t tc_period;              /**< Enforcement period for traffic class rates (measured in milliseconds) */
 129 #ifdef RTE_SCHED_SUBPORT_TC_OV
 130         uint32_t tc_ov_period;           /**< Enforcement period for traffic class oversubscription (measured in milliseconds) */
 131 #endif
 132 };
 133
 134 /** Subport statistics */
 135 struct rte_sched_subport_stats {
 136         /* Packets */
 137         uint32_t n_pkts_tc[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; /**< Number of packets successfully written to current
 138                                               subport for each traffic class */
 139         uint32_t n_pkts_tc_dropped[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; /**< Number of packets dropped by the current
 140                                               subport for each traffic class due to subport queues being full or congested*/
 141
 142         /* Bytes */
 143         uint32_t n_bytes_tc[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; /**< Number of bytes successfully written to current
 144                                               subport for each traffic class*/
 145         uint32_t n_bytes_tc_dropped[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; /**< Number of bytes dropped by the current
 146                                           subport for each traffic class due to subport queues being full or congested */
 147 };
 148
 149 /** Pipe configuration parameters. The period and credits_per_period parameters are measured
 150 in bytes, with one byte meaning the time duration associated with the transmission of one byte
 151 on the physical medium of the output port, with pipe or pipe traffic class rate (measured as
 152 percentage of output port rate) determined as credits_per_period divided by period. One credit
 153 represents one byte. */
 154 struct rte_sched_pipe_params {
 155         /* Pipe token bucket */
 156         uint32_t tb_rate;                /**< Pipe token bucket rate (measured in bytes per second) */
 157         uint32_t tb_size;                /**< Pipe token bucket size (measured in credits) */
 158
 159         /* Pipe traffic classes */
 160         uint32_t tc_rate[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; /**< Pipe traffic class rates (measured in bytes per second) */
 161         uint32_t tc_period;              /**< Enforcement period for pipe traffic class rates (measured in milliseconds) */
 162 #ifdef RTE_SCHED_SUBPORT_TC_OV
 163         uint8_t tc_ov_weight[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; /**< Traffic class weights to be used for the
 164                                               current pipe in the event of subport traffic class oversubscription */
 165 #endif
 166
 167         /* Pipe queues */
 168         uint8_t  wrr_weights[RTE_SCHED_QUEUES_PER_PIPE]; /**< WRR weights for the queues of the current pipe */
 169 };
 170
 171 /** Queue statistics */
 172 struct rte_sched_queue_stats {
 173         /* Packets */
 174         uint32_t n_pkts;                 /**< Number of packets successfully written to current queue */
 175         uint32_t n_pkts_dropped;         /**< Number of packets dropped due to current queue being full or congested */
 176
 177         /* Bytes */
 178         uint32_t n_bytes;                /**< Number of bytes successfully written to current queue */
 179         uint32_t n_bytes_dropped;        /**< Number of bytes dropped due to current queue being full or congested */
 180 };
 181
 182 /** Port configuration parameters. */
 183 struct rte_sched_port_params {
 184         const char *name;                /**< Literal string to be associated to the current port scheduler instance */
 185         int socket;                      /**< CPU socket ID where the memory for port scheduler should be allocated */
 186         uint32_t rate;                   /**< Output port rate (measured in bytes per second) */
 187         uint32_t frame_overhead;         /**< Framing overhead per packet (measured in bytes) */
 188         uint32_t n_subports_per_port;    /**< Number of subports for the current port scheduler instance*/
 189         uint32_t n_pipes_per_subport;    /**< Number of pipes for each port scheduler subport */
 190         uint16_t qsize[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE]; /**< Packet queue size for each traffic class. All queues
 191                                               within the same pipe traffic class have the same size. Queues from
 192                                                                                   different pipes serving the same traffic class have the same size. */
 193         struct rte_sched_pipe_params *pipe_profiles; /**< Pipe profile table defined for current port scheduler instance.
 194                                           Every pipe of the current port scheduler is configured using one of the
 195                                                                                   profiles from this table. */
 196         uint32_t n_pipe_profiles;        /**< Number of profiles in the pipe profile table */
 197 #ifdef RTE_SCHED_RED
 198         struct rte_red_params red_params[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE][e_RTE_METER_COLORS]; /**< RED parameters */
 199 #endif
 200 };
 201
 202 /** Path through the scheduler hierarchy used by the scheduler enqueue operation to
 203 identify the destination queue for the current packet. Stored in the field pkt.hash.sched
 204 of struct rte_mbuf of each packet, typically written by the classification stage and read by
 205 scheduler enqueue.*/
 206 struct rte_sched_port_hierarchy {
 207         uint32_t queue:2;                /**< Queue ID (0 .. 3) */
 208         uint32_t traffic_class:2;        /**< Traffic class ID (0 .. 3)*/
 209         uint32_t pipe:20;                /**< Pipe ID */
 210         uint32_t subport:6;              /**< Subport ID */
 211         uint32_t color:2;                /**< Color */
 212 };
 213
 214 /*
 215  * Configuration
 216  *
 217  ***/
 218
 219 /**
 220  * Hierarchical scheduler port configuration
 221  *
 222  * @param params
 223  *   Port scheduler configuration parameter structure
 224  * @return
 225  *   Handle to port scheduler instance upon success or NULL otherwise.
 226  */
 227 struct rte_sched_port *
 228 rte_sched_port_config(struct rte_sched_port_params *params);
 229
 230 /**
 231  * Hierarchical scheduler port free
 232  *
 233  * @param port
 234  *   Handle to port scheduler instance
 235  */
 236 void
 237 rte_sched_port_free(struct rte_sched_port *port);
 238
 239 /**
 240  * Hierarchical scheduler subport configuration
 241  *
 242  * @param port
 243  *   Handle to port scheduler instance
 244  * @param subport_id
 245  *   Subport ID
 246  * @param params
 247  *   Subport configuration parameters
 248  * @return
 249  *   0 upon success, error code otherwise
 250  */
 251 int
 252 rte_sched_subport_config(struct rte_sched_port *port,
 253         uint32_t subport_id,
 254         struct rte_sched_subport_params *params);
 255
 256 /**
 257  * Hierarchical scheduler pipe configuration
 258  *
 259  * @param port
 260  *   Handle to port scheduler instance
 261  * @param subport_id
 262  *   Subport ID
 263  * @param pipe_id
 264  *   Pipe ID within subport
 265  * @param pipe_profile
 266  *   ID of port-level pre-configured pipe profile
 267  * @return
 268  *   0 upon success, error code otherwise
 269  */
 270 int
 271 rte_sched_pipe_config(struct rte_sched_port *port,
 272         uint32_t subport_id,
 273         uint32_t pipe_id,
 274         int32_t pipe_profile);
 275
 276 /**
 277  * Hierarchical scheduler memory footprint size per port
 278  *
 279  * @param params
 280  *   Port scheduler configuration parameter structure
 281  * @return
 282  *   Memory footprint size in bytes upon success, 0 otherwise
 283  */
 284 uint32_t
 285 rte_sched_port_get_memory_footprint(struct rte_sched_port_params *params);
 286
 287 /*
 288  * Statistics
 289  *
 290  ***/
 291
 292 /**
 293  * Hierarchical scheduler subport statistics read
 294  *
 295  * @param port
 296  *   Handle to port scheduler instance
 297  * @param subport_id
 298  *   Subport ID
 299  * @param stats
 300  *   Pointer to pre-allocated subport statistics structure where the statistics
 301  *   counters should be stored
 302  * @param tc_ov
 303  *   Pointer to pre-allocated 4-entry array where the oversubscription status for
 304  *   each of the 4 subport traffic classes should be stored.
 305  * @return
 306  *   0 upon success, error code otherwise
 307  */
 308 int
 309 rte_sched_subport_read_stats(struct rte_sched_port *port,
 310         uint32_t subport_id,
 311         struct rte_sched_subport_stats *stats,
 312         uint32_t *tc_ov);
 313
 314 /**
 315  * Hierarchical scheduler queue statistics read
 316  *
 317  * @param port
 318  *   Handle to port scheduler instance
 319  * @param queue_id
 320  *   Queue ID within port scheduler
 321  * @param stats
 322  *   Pointer to pre-allocated subport statistics structure where the statistics
 323  *   counters should be stored
 324  * @param qlen
 325  *   Pointer to pre-allocated variable where the current queue length should be stored.
 326  * @return
 327  *   0 upon success, error code otherwise
 328  */
 329 int
 330 rte_sched_queue_read_stats(struct rte_sched_port *port,
 331         uint32_t queue_id,
 332         struct rte_sched_queue_stats *stats,
 333         uint16_t *qlen);
 334
 335 /*
 336  * Run-time
 337  *
 338  ***/
 339
 340 /**
 341  * Scheduler hierarchy path write to packet descriptor. Typically called by the
 342  * packet classification stage.
 343  *
 344  * @param pkt
 345  *   Packet descriptor handle
 346  * @param subport
 347  *   Subport ID
 348  * @param pipe
 349  *   Pipe ID within subport
 350  * @param traffic_class
 351  *   Traffic class ID within pipe (0 .. 3)
 352  * @param queue
 353  *   Queue ID within pipe traffic class (0 .. 3)
 354  */
 355 static inline void
 356 rte_sched_port_pkt_write(struct rte_mbuf *pkt,
 357         uint32_t subport, uint32_t pipe, uint32_t traffic_class, uint32_t queue, enum rte_meter_color color)
 358 {
 359         struct rte_sched_port_hierarchy *sched = (struct rte_sched_port_hierarchy *) &pkt->pkt.hash.sched;
 360
 361         sched->color = (uint32_t) color;
 362         sched->subport = subport;
 363         sched->pipe = pipe;
 364         sched->traffic_class = traffic_class;
 365         sched->queue = queue;
 366 }
 367
 368 /**
 369  * Scheduler hierarchy path read from packet descriptor (struct rte_mbuf). Typically
 370  * called as part of the hierarchical scheduler enqueue operation. The subport,
 371  * pipe, traffic class and queue parameters need to be pre-allocated by the caller.
 372  *
 373  * @param pkt
 374  *   Packet descriptor handle
 375  * @param subport
 376  *   Subport ID
 377  * @param pipe
 378  *   Pipe ID within subport
 379  * @param traffic_class
 380  *   Traffic class ID within pipe (0 .. 3)
 381  * @param queue
 382  *   Queue ID within pipe traffic class (0 .. 3)
 383  *
 384  */
 385 static inline void
 386 rte_sched_port_pkt_read_tree_path(struct rte_mbuf *pkt, uint32_t *subport, uint32_t *pipe, uint32_t *traffic_class, uint32_t *queue)
 387 {
 388         struct rte_sched_port_hierarchy *sched = (struct rte_sched_port_hierarchy *) &pkt->pkt.hash.sched;
 389
 390         *subport = sched->subport;
 391         *pipe = sched->pipe;
 392         *traffic_class = sched->traffic_class;
 393         *queue = sched->queue;
 394 }
 395
 396 static inline enum rte_meter_color
 397 rte_sched_port_pkt_read_color(struct rte_mbuf *pkt)
 398 {
 399         struct rte_sched_port_hierarchy *sched = (struct rte_sched_port_hierarchy *) &pkt->pkt.hash.sched;
 400
 401         return (enum rte_meter_color) sched->color;
 402 }
 403
 404 /**
 405  * Hierarchical scheduler port enqueue. Writes up to n_pkts to port scheduler and
 406  * returns the number of packets actually written. For each packet, the port scheduler
 407  * queue to write the packet to is identified by reading the hierarchy path from the
 408  * packet descriptor; if the queue is full or congested and the packet is not written
 409  * to the queue, then the packet is automatically dropped without any action required
 410  * from the caller.
 411  *
 412  * @param port
 413  *   Handle to port scheduler instance
 414  * @param pkts
 415  *   Array storing the packet descriptor handles
 416  * @param n_pkts
 417  *   Number of packets to enqueue from the pkts array into the port scheduler
 418  * @return
 419  *   Number of packets successfully enqueued
 420  */
 421 int
 422 rte_sched_port_enqueue(struct rte_sched_port *port, struct rte_mbuf **pkts, uint32_t n_pkts);
 423
 424 /**
 425  * Hierarchical scheduler port dequeue. Reads up to n_pkts from the port scheduler
 426  * and stores them in the pkts array and returns the number of packets actually read.
 427  * The pkts array needs to be pre-allocated by the caller with at least n_pkts entries.
 428  *
 429  * @param port
 430  *   Handle to port scheduler instance
 431  * @param pkts
 432  *   Pre-allocated packet descriptor array where the packets dequeued from the port
 433  *   scheduler should be stored
 434  * @param n_pkts
 435  *   Number of packets to dequeue from the port scheduler
 436  * @return
 437  *   Number of packets successfully dequeued and placed in the pkts array
 438  */
 439 int
 440 rte_sched_port_dequeue(struct rte_sched_port *port, struct rte_mbuf **pkts, uint32_t n_pkts);
 441
 442 #ifdef __cplusplus
 443 }
 444 #endif
 445
 446 #endif /* __INCLUDE_RTE_SCHED_H__ */