DPDK  20.11.0
Data Structures | Macros | Functions
rte_sched.h File Reference
#include <sys/types.h>
#include <rte_compat.h>
#include <rte_mbuf.h>
#include <rte_meter.h>

Go to the source code of this file.

Data Structures

struct  rte_sched_subport_stats
 
struct  rte_sched_queue_stats
 
struct  rte_sched_port_params
 

Macros

#define RTE_SCHED_QUEUES_PER_PIPE   16
 
#define RTE_SCHED_BE_QUEUES_PER_PIPE   4
 
#define RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE   (RTE_SCHED_QUEUES_PER_PIPE - RTE_SCHED_BE_QUEUES_PER_PIPE + 1)
 
#define RTE_SCHED_TRAFFIC_CLASS_BE   (RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE - 1)
 

Functions

struct rte_sched_port * rte_sched_port_config (struct rte_sched_port_params *params)
 
void rte_sched_port_free (struct rte_sched_port *port)
 
__rte_experimental int rte_sched_subport_pipe_profile_add (struct rte_sched_port *port, uint32_t subport_id, struct rte_sched_pipe_params *params, uint32_t *pipe_profile_id)
 
__rte_experimental int rte_sched_port_subport_profile_add (struct rte_sched_port *port, struct rte_sched_subport_profile_params *profile, uint32_t *subport_profile_id)
 
int rte_sched_subport_config (struct rte_sched_port *port, uint32_t subport_id, struct rte_sched_subport_params *params, uint32_t subport_profile_id)
 
int rte_sched_pipe_config (struct rte_sched_port *port, uint32_t subport_id, uint32_t pipe_id, int32_t pipe_profile)
 
uint32_t rte_sched_port_get_memory_footprint (struct rte_sched_port_params *port_params, struct rte_sched_subport_params **subport_params)
 
int rte_sched_subport_read_stats (struct rte_sched_port *port, uint32_t subport_id, struct rte_sched_subport_stats *stats, uint32_t *tc_ov)
 
int rte_sched_queue_read_stats (struct rte_sched_port *port, uint32_t queue_id, struct rte_sched_queue_stats *stats, uint16_t *qlen)
 
void rte_sched_port_pkt_write (struct rte_sched_port *port, struct rte_mbuf *pkt, uint32_t subport, uint32_t pipe, uint32_t traffic_class, uint32_t queue, enum rte_color color)
 
void rte_sched_port_pkt_read_tree_path (struct rte_sched_port *port, const struct rte_mbuf *pkt, uint32_t *subport, uint32_t *pipe, uint32_t *traffic_class, uint32_t *queue)
 
int rte_sched_port_enqueue (struct rte_sched_port *port, struct rte_mbuf **pkts, uint32_t n_pkts)
 
int rte_sched_port_dequeue (struct rte_sched_port *port, struct rte_mbuf **pkts, uint32_t n_pkts)
 

Detailed Description

RTE Hierarchical Scheduler

The hierarchical scheduler prioritizes the transmission of packets from different users and traffic classes according to the Service Level Agreements (SLAs) defined for the current network node.

The scheduler supports thousands of packet queues grouped under a 5-level hierarchy:

  1. Port:
    • Typical usage: output Ethernet port;
    • Multiple ports are scheduled in round robin order with equal priority;
  2. Subport:
    • Typical usage: group of users;
    • Traffic shaping using the token bucket algorithm (one bucket per subport);
    • Upper limit enforced per traffic class at subport level;
    • Lower priority traffic classes able to reuse subport bandwidth currently unused by higher priority traffic classes of the same subport;
    • When any subport traffic class is oversubscribed (configuration time event), the usage of subport member pipes with high demand for that traffic class pipes is truncated to a dynamically adjusted value with no impact to low demand pipes;
  3. Pipe:
    • Typical usage: individual user/subscriber;
    • Traffic shaping using the token bucket algorithm (one bucket per pipe);
  4. Traffic class:
    • Traffic classes of the same pipe handled in strict priority order;
    • Upper limit enforced per traffic class at the pipe level;
    • Lower priority traffic classes able to reuse pipe bandwidth currently unused by higher priority traffic classes of the same pipe;
  5. Queue:
    • Typical usage: queue hosting packets from one or multiple connections of same traffic class belonging to the same user;
    • Weighted Round Robin (WRR) is used to service the queues within same pipe lowest priority traffic class (best-effort).

Definition in file rte_sched.h.

Macro Definition Documentation

#define RTE_SCHED_QUEUES_PER_PIPE   16

Random Early Detection (RED) Maximum number of queues per pipe. Note that the multiple queues (power of 2) can only be assigned to lowest priority (best-effort) traffic class. Other higher priority traffic classes can only have one queue. Can not change.

See also
struct rte_sched_port_params
Examples:
examples/qos_sched/cfg_file.c, and examples/qos_sched/stats.c.

Definition at line 77 of file rte_sched.h.

#define RTE_SCHED_BE_QUEUES_PER_PIPE   4

Number of WRR queues for best-effort traffic class per pipe.

See also
struct rte_sched_pipe_params
Examples:
examples/ip_pipeline/cli.c, examples/qos_sched/cfg_file.c, and examples/qos_sched/stats.c.

Definition at line 83 of file rte_sched.h.

#define RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE   (RTE_SCHED_QUEUES_PER_PIPE - RTE_SCHED_BE_QUEUES_PER_PIPE + 1)

Number of traffic classes per pipe (as well as subport).

See also
struct rte_sched_subport_params
struct rte_sched_pipe_params
Examples:
examples/ip_pipeline/cli.c, examples/qos_sched/cfg_file.c, and examples/qos_sched/stats.c.

Definition at line 89 of file rte_sched.h.

#define RTE_SCHED_TRAFFIC_CLASS_BE   (RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE - 1)

Best-effort traffic class ID Can not change.

Examples:
examples/qos_sched/app_thread.c, examples/qos_sched/cfg_file.c, and examples/qos_sched/stats.c.

Definition at line 95 of file rte_sched.h.

Function Documentation

struct rte_sched_port* rte_sched_port_config ( struct rte_sched_port_params params)

Hierarchical scheduler port configuration

Parameters
paramsPort scheduler configuration parameter structure
Returns
Handle to port scheduler instance upon success or NULL otherwise.
Examples:
examples/ip_pipeline/tmgr.c, and examples/qos_sched/init.c.
void rte_sched_port_free ( struct rte_sched_port *  port)

Hierarchical scheduler port free

Parameters
portHandle to port scheduler instance
Examples:
examples/ip_pipeline/tmgr.c.
__rte_experimental int rte_sched_subport_pipe_profile_add ( struct rte_sched_port *  port,
uint32_t  subport_id,
struct rte_sched_pipe_params *  params,
uint32_t *  pipe_profile_id 
)
Warning
EXPERIMENTAL: this API may change without prior notice.

Hierarchical scheduler pipe profile add

Parameters
portHandle to port scheduler instance
subport_idSubport ID
paramsPipe profile parameters
pipe_profile_idSet to valid profile id when profile is added successfully.
Returns
0 upon success, error code otherwise
__rte_experimental int rte_sched_port_subport_profile_add ( struct rte_sched_port *  port,
struct rte_sched_subport_profile_params *  profile,
uint32_t *  subport_profile_id 
)
Warning
EXPERIMENTAL: this API may change without prior notice.

Hierarchical scheduler subport bandwidth profile add Note that this function is safe to use in runtime for adding new subport bandwidth profile as it doesn't have any impact on hiearchical structure of the scheduler.

Parameters
portHandle to port scheduler instance
profileSubport bandwidth profile
subport_profile_idSubport profile id
Returns
0 upon success, error code otherwise
int rte_sched_subport_config ( struct rte_sched_port *  port,
uint32_t  subport_id,
struct rte_sched_subport_params *  params,
uint32_t  subport_profile_id 
)

Hierarchical scheduler subport configuration Note that this function is safe to use at runtime to configure subport bandwidth profile.

Parameters
portHandle to port scheduler instance
subport_idSubport ID
paramsSubport configuration parameters. Must be non-NULL for first invocation (i.e initialization) for a given subport. Ignored (recommended value is NULL) for all subsequent invocation on the same subport.
subport_profile_idID of subport bandwidth profile
Returns
0 upon success, error code otherwise
Examples:
examples/ip_pipeline/tmgr.c, and examples/qos_sched/init.c.
int rte_sched_pipe_config ( struct rte_sched_port *  port,
uint32_t  subport_id,
uint32_t  pipe_id,
int32_t  pipe_profile 
)

Hierarchical scheduler pipe configuration

Parameters
portHandle to port scheduler instance
subport_idSubport ID
pipe_idPipe ID within subport
pipe_profileID of subport-level pre-configured pipe profile
Returns
0 upon success, error code otherwise
Examples:
examples/ip_pipeline/tmgr.c, and examples/qos_sched/init.c.
uint32_t rte_sched_port_get_memory_footprint ( struct rte_sched_port_params port_params,
struct rte_sched_subport_params **  subport_params 
)

Hierarchical scheduler memory footprint size per port

Parameters
port_paramsPort scheduler configuration parameter structure
subport_paramsArray of subport parameter structures
Returns
Memory footprint size in bytes upon success, 0 otherwise
int rte_sched_subport_read_stats ( struct rte_sched_port *  port,
uint32_t  subport_id,
struct rte_sched_subport_stats stats,
uint32_t *  tc_ov 
)

Hierarchical scheduler subport statistics read

Parameters
portHandle to port scheduler instance
subport_idSubport ID
statsPointer to pre-allocated subport statistics structure where the statistics counters should be stored
tc_ovPointer to pre-allocated RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE-entry array where the oversubscription status for each of the subport traffic classes should be stored.
Returns
0 upon success, error code otherwise
Examples:
examples/qos_sched/stats.c.
int rte_sched_queue_read_stats ( struct rte_sched_port *  port,
uint32_t  queue_id,
struct rte_sched_queue_stats stats,
uint16_t *  qlen 
)

Hierarchical scheduler queue statistics read

Parameters
portHandle to port scheduler instance
queue_idQueue ID within port scheduler
statsPointer to pre-allocated subport statistics structure where the statistics counters should be stored
qlenPointer to pre-allocated variable where the current queue length should be stored.
Returns
0 upon success, error code otherwise
Examples:
examples/qos_sched/stats.c.
void rte_sched_port_pkt_write ( struct rte_sched_port *  port,
struct rte_mbuf pkt,
uint32_t  subport,
uint32_t  pipe,
uint32_t  traffic_class,
uint32_t  queue,
enum rte_color  color 
)

Scheduler hierarchy path write to packet descriptor. Typically called by the packet classification stage.

Parameters
portHandle to port scheduler instance
pktPacket descriptor handle
subportSubport ID
pipePipe ID within subport
traffic_classTraffic class ID within pipe (0 .. RTE_SCHED_TRAFFIC_CLASS_BE)
queueQueue ID within pipe traffic class, 0 for high priority TCs, and 0 .. (RTE_SCHED_BE_QUEUES_PER_PIPE - 1) for best-effort TC
colorPacket color set
Examples:
examples/qos_sched/app_thread.c.
void rte_sched_port_pkt_read_tree_path ( struct rte_sched_port *  port,
const struct rte_mbuf pkt,
uint32_t *  subport,
uint32_t *  pipe,
uint32_t *  traffic_class,
uint32_t *  queue 
)

Scheduler hierarchy path read from packet descriptor (struct rte_mbuf). Typically called as part of the hierarchical scheduler enqueue operation. The subport, pipe, traffic class and queue parameters need to be pre-allocated by the caller.

Parameters
portHandle to port scheduler instance
pktPacket descriptor handle
subportSubport ID
pipePipe ID within subport
traffic_classTraffic class ID within pipe (0 .. RTE_SCHED_TRAFFIC_CLASS_BE)
queueQueue ID within pipe traffic class, 0 for high priority TCs, and 0 .. (RTE_SCHED_BE_QUEUES_PER_PIPE - 1) for best-effort TC
int rte_sched_port_enqueue ( struct rte_sched_port *  port,
struct rte_mbuf **  pkts,
uint32_t  n_pkts 
)

Hierarchical scheduler port enqueue. Writes up to n_pkts to port scheduler and returns the number of packets actually written. For each packet, the port scheduler queue to write the packet to is identified by reading the hierarchy path from the packet descriptor; if the queue is full or congested and the packet is not written to the queue, then the packet is automatically dropped without any action required from the caller.

Parameters
portHandle to port scheduler instance
pktsArray storing the packet descriptor handles
n_pktsNumber of packets to enqueue from the pkts array into the port scheduler
Returns
Number of packets successfully enqueued
Examples:
examples/qos_sched/app_thread.c.
int rte_sched_port_dequeue ( struct rte_sched_port *  port,
struct rte_mbuf **  pkts,
uint32_t  n_pkts 
)

Hierarchical scheduler port dequeue. Reads up to n_pkts from the port scheduler and stores them in the pkts array and returns the number of packets actually read. The pkts array needs to be pre-allocated by the caller with at least n_pkts entries.

Parameters
portHandle to port scheduler instance
pktsPre-allocated packet descriptor array where the packets dequeued from the port scheduler should be stored
n_pktsNumber of packets to dequeue from the port scheduler
Returns
Number of packets successfully dequeued and placed in the pkts array
Examples:
examples/qos_sched/app_thread.c.