lib/librte_sched/rte_sched.h

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