rte_sched.h

Go to the documentation of this file.

/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef __INCLUDE_RTE_SCHED_H__
#define __INCLUDE_RTE_SCHED_H__

#ifdef __cplusplus
extern "C" {
#endif

#include <sys/types.h>
#include <rte_mbuf.h>
#include <rte_meter.h>

#ifdef RTE_SCHED_RED
#include "rte_red.h"
#endif

#define RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE    4

#define RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS    4

#define RTE_SCHED_QUEUES_PER_PIPE             \
    (RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE *     \
    RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS)

#ifndef RTE_SCHED_PIPE_PROFILES_PER_PORT
#define RTE_SCHED_PIPE_PROFILES_PER_PORT      256
#endif

/*
 * Ethernet framing overhead. Overhead fields per Ethernet frame:
 * 1. Preamble:                             7 bytes;
 * 2. Start of Frame Delimiter (SFD):       1 byte;
 * 3. Frame Check Sequence (FCS):           4 bytes;
 * 4. Inter Frame Gap (IFG):               12 bytes.
 *
 * The FCS is considered overhead only if not included in the packet
 * length (field pkt_len of struct rte_mbuf).
 */
#ifndef RTE_SCHED_FRAME_OVERHEAD_DEFAULT
#define RTE_SCHED_FRAME_OVERHEAD_DEFAULT      24
#endif

/*
 * Subport configuration parameters. The period and credits_per_period
 * parameters are measured in bytes, with one byte meaning the time
 * duration associated with the transmission of one byte on the
 * physical medium of the output port, with pipe or pipe traffic class
 * rate (measured as percentage of output port rate) determined as
 * credits_per_period divided by period. One credit represents one
 * byte.
 */
struct rte_sched_subport_params {
    /* Subport token bucket */
    uint32_t tb_rate;                
    uint32_t tb_size;                
    /* Subport traffic classes */
    uint32_t tc_rate[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];
    uint32_t tc_period;
};

struct rte_sched_subport_stats {
    /* Packets */
    uint32_t n_pkts_tc[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];
    uint32_t n_pkts_tc_dropped[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];
    /* Bytes */
    uint32_t n_bytes_tc[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];
    uint32_t n_bytes_tc_dropped[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];
#ifdef RTE_SCHED_RED
    uint32_t n_pkts_red_dropped[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];
#endif
};

/*
 * Pipe configuration parameters. The period and credits_per_period
 * parameters are measured in bytes, with one byte meaning the time
 * duration associated with the transmission of one byte on the
 * physical medium of the output port, with pipe or pipe traffic class
 * rate (measured as percentage of output port rate) determined as
 * credits_per_period divided by period. One credit represents one
 * byte.
 */
struct rte_sched_pipe_params {
    /* Pipe token bucket */
    uint32_t tb_rate;                
    uint32_t tb_size;                
    /* Pipe traffic classes */
    uint32_t tc_rate[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];
    uint32_t tc_period;
#ifdef RTE_SCHED_SUBPORT_TC_OV
    uint8_t tc_ov_weight;        
#endif

    /* Pipe queues */
    uint8_t  wrr_weights[RTE_SCHED_QUEUES_PER_PIPE]; 
};

struct rte_sched_queue_stats {
    /* Packets */
    uint32_t n_pkts;                 
    uint32_t n_pkts_dropped;         
#ifdef RTE_SCHED_RED
    uint32_t n_pkts_red_dropped;     
#endif

    /* Bytes */
    uint32_t n_bytes;                
    uint32_t n_bytes_dropped;        
};

struct rte_sched_port_params {
    const char *name;                
    int socket;                      
    uint32_t rate;                   
    uint32_t mtu;                    
    uint32_t frame_overhead;         
    uint32_t n_subports_per_port;    
    uint32_t n_pipes_per_subport;    
    uint16_t qsize[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE];
    struct rte_sched_pipe_params *pipe_profiles;
    uint32_t n_pipe_profiles;        
#ifdef RTE_SCHED_RED
    struct rte_red_params red_params[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE][e_RTE_METER_COLORS]; 
#endif
};

/*
 * Configuration
 *
 ***/

struct rte_sched_port *
rte_sched_port_config(struct rte_sched_port_params *params);

void
rte_sched_port_free(struct rte_sched_port *port);

int
rte_sched_subport_config(struct rte_sched_port *port,
    uint32_t subport_id,
    struct rte_sched_subport_params *params);

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 *params);

/*
 * Statistics
 *
 ***/

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_mbuf *pkt,
             uint32_t subport, uint32_t pipe, uint32_t traffic_class,
             uint32_t queue, enum rte_meter_color color);

void
rte_sched_port_pkt_read_tree_path(const struct rte_mbuf *pkt,
                  uint32_t *subport, uint32_t *pipe,
                  uint32_t *traffic_class, uint32_t *queue);

enum rte_meter_color
rte_sched_port_pkt_read_color(const struct rte_mbuf *pkt);

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);

#ifdef __cplusplus
}
#endif

#endif /* __INCLUDE_RTE_SCHED_H__ */