api/spec/traffic_mngr.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2015-2018 Linaro Limited
 * Copyright (c) 2021-2026 Nokia
 * Copyright (c) 2022-2025 Marvell
 */
 
#ifndef ODP_API_SPEC_TRAFFIC_MNGR_H_
#define ODP_API_SPEC_TRAFFIC_MNGR_H_
#include <odp/visibility_begin.h>
 
#include <odp/api/packet_io_types.h>
#include <odp/api/std_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct odp_tm_queue_stats_t {
    uint64_t octets;
 
    uint64_t packets;
 
    uint64_t discards;
 
    uint64_t discard_octets;
 
    uint64_t errors;
 
} odp_tm_queue_stats_t;
 
typedef struct odp_tm_queue_stats_capability_t {
    union {
        struct {
            uint64_t octets          : 1;
 
            uint64_t packets         : 1;
 
            uint64_t discards        : 1;
 
            uint64_t discard_octets  : 1;
 
            uint64_t errors          : 1;
 
        } counter;
 
        uint64_t all_counters;
    };
} odp_tm_queue_stats_capability_t;
 
typedef struct odp_tm_node_stats_t {
    uint64_t discards;
 
    uint64_t discard_octets;
 
    uint64_t packets;
 
    uint64_t octets;
} odp_tm_node_stats_t;
 
typedef struct odp_tm_node_stats_capability_t {
    union {
        struct {
            uint64_t discards       : 1;
 
            uint64_t discard_octets : 1;
 
            uint64_t packets        : 1;
 
            uint64_t octets         : 1;
 
        } counter;
 
        uint64_t all_counters;
    };
} odp_tm_node_stats_capability_t;
 
typedef struct {
    uint32_t max_num_tm_nodes;
 
    uint32_t max_fanin_per_node;
 
    uint8_t max_priority;
 
    uint32_t min_weight;
 
    uint32_t max_weight;
 
    uint32_t min_burst_packets;
 
    uint32_t max_burst_packets;
 
    uint64_t min_rate_packets;
 
    uint64_t max_rate_packets;
 
    uint32_t min_burst;
 
    uint32_t max_burst;
 
    uint64_t min_rate;
 
    uint64_t max_rate;
 
    odp_bool_t tm_node_shaper_supported;
 
    odp_bool_t tm_node_rate_limiter_supported;
 
    odp_bool_t tm_node_shaper_packet_mode;
 
    odp_bool_t tm_node_wred_supported;
 
    odp_bool_t tm_node_dual_slope_supported;
 
    odp_bool_t fair_queuing_supported;
 
    odp_bool_t weights_supported;
 
    struct {
        uint8_t byte            : 1;
 
        uint8_t packet          : 1;
 
        uint8_t byte_and_packet : 1;
 
    } tm_node_threshold;
 
    odp_tm_node_stats_capability_t node_stats;
} odp_tm_level_capabilities_t;
 
typedef enum odp_tm_pkt_prio_mode {
    ODP_TM_PKT_PRIO_MODE_PRESERVE,
 
    ODP_TM_PKT_PRIO_MODE_OVERWRITE,
 
    ODP_TM_PKT_PRIO_MODE_MAX,
} odp_tm_pkt_prio_mode_t;
 
typedef struct {
    char *name;
 
    uint32_t max_tm_queues;
 
    uint8_t max_levels;
 
    odp_bool_t egress_fcn_supported;
 
    odp_bool_t tm_queue_shaper_supported;
 
    odp_bool_t tm_queue_rate_limiter_supported;
 
    odp_bool_t tm_queue_shaper_packet_mode;
 
    odp_bool_t tm_queue_wred_supported;
 
    odp_bool_t tm_queue_dual_slope_supported;
 
    odp_bool_t vlan_marking_supported;
 
    odp_bool_t ecn_marking_supported;
 
    odp_bool_t drop_prec_marking_supported;
 
    odp_bool_t marking_colors_supported[ODP_NUM_PACKET_COLORS];
 
    odp_tm_level_capabilities_t per_level[ODP_TM_MAX_LEVELS];
 
    odp_bool_t dynamic_topology_update;
 
    odp_bool_t dynamic_shaper_update;
 
    odp_bool_t dynamic_sched_update;
 
    odp_bool_t dynamic_wred_update;
 
    odp_bool_t dynamic_threshold_update;
 
    odp_tm_queue_stats_capability_t queue_stats;
 
    struct {
        uint8_t byte            : 1;
 
        uint8_t packet          : 1;
 
        uint8_t byte_and_packet : 1;
 
    } tm_queue_threshold;
 
    uint32_t tm_queue_query_flags;
 
    odp_bool_t pkt_prio_modes[ODP_TM_PKT_PRIO_MODE_MAX];
 
    uint8_t max_schedulers_per_node;
 
    odp_packet_ref_types_t packet_ref;
 
} odp_tm_capabilities_t;
 
typedef struct {
    uint32_t max_num_tm_nodes;
 
    uint32_t max_fanin_per_node;
 
    uint8_t max_priority;
 
    uint32_t min_weight;
 
    uint32_t max_weight;
 
    odp_bool_t tm_node_shaper_needed;
 
    odp_bool_t tm_node_wred_needed;
 
    odp_bool_t tm_node_dual_slope_needed;
 
    odp_bool_t fair_queuing_needed;
 
    odp_bool_t weights_needed;
 
    odp_bool_t tm_node_threshold_needed;
} odp_tm_level_requirements_t;
 
typedef struct {
    uint32_t max_tm_queues;
 
    uint8_t num_levels;
 
    odp_bool_t tm_queue_shaper_needed;
 
    odp_bool_t tm_queue_wred_needed;
 
    odp_bool_t tm_queue_dual_slope_needed;
 
    odp_bool_t tm_queue_threshold_needed;
 
    odp_bool_t vlan_marking_needed;
 
    odp_bool_t ecn_marking_needed;
 
    odp_bool_t drop_prec_marking_needed;
 
    odp_bool_t marking_colors_needed[ODP_NUM_PACKET_COLORS];
 
    odp_tm_pkt_prio_mode_t pkt_prio_mode;
 
    odp_tm_level_requirements_t per_level[ODP_TM_MAX_LEVELS];
} odp_tm_requirements_t;
 
typedef void (*odp_tm_egress_fcn_t) (odp_packet_t odp_pkt);
 
typedef enum {
    ODP_TM_EGRESS_PKT_IO,
    ODP_TM_EGRESS_FN,
} odp_tm_egress_kind_t;
 
typedef struct {
    odp_tm_egress_kind_t egress_kind; 
    union {
        odp_pktio_t pktio;              
        odp_tm_egress_fcn_t egress_fcn; 
    };
} odp_tm_egress_t;
 
void odp_tm_requirements_init(odp_tm_requirements_t *requirements);
 
void odp_tm_egress_init(odp_tm_egress_t *egress);
 
int odp_tm_egress_capabilities(odp_tm_capabilities_t *capabilities,
                   const odp_tm_egress_t *egress);
 
odp_tm_t odp_tm_create(const char            *name,
               odp_tm_requirements_t *requirements,
               odp_tm_egress_t       *egress);
 
odp_tm_t odp_tm_find(const char            *name,
             odp_tm_requirements_t *requirements,
             odp_tm_egress_t       *egress);
 
int odp_tm_capability(odp_tm_t tm, odp_tm_capabilities_t *capabilities);
 
int odp_tm_start(odp_tm_t tm);
 
int odp_tm_stop(odp_tm_t tm);
 
int odp_tm_destroy(odp_tm_t tm);
 
/* Marking APIs
 * -------------------------------------------------------- */
 
int odp_tm_vlan_marking(odp_tm_t           tm,
            odp_packet_color_t color,
            odp_bool_t         drop_eligible_enabled);
 
int odp_tm_ecn_marking(odp_tm_t           tm,
               odp_packet_color_t color,
               odp_bool_t         ecn_ce_enabled);
 
int odp_tm_drop_prec_marking(odp_tm_t           tm,
                 odp_packet_color_t color,
                 odp_bool_t         drop_prec_enabled);
 
/* Shaper profile types and functions
 * -------------------------------------------------------- */
 
typedef enum {
    ODP_TM_SHAPER_RATE_SHAPE,
 
    ODP_TM_SHAPER_RATE_LIMIT
 
} odp_tm_shaper_mode_t;
 
typedef struct {
    odp_tm_shaper_mode_t mode;
 
    uint64_t commit_rate;
 
    uint64_t peak_rate;
 
    uint32_t commit_burst;
 
    uint32_t peak_burst;
 
    int8_t shaper_len_adjust;
 
    odp_bool_t dual_rate;
 
    odp_bool_t packet_mode;
 
} odp_tm_shaper_params_t;
 
void odp_tm_shaper_params_init(odp_tm_shaper_params_t *params);
 
odp_tm_shaper_t odp_tm_shaper_create(const char *name,
                     const odp_tm_shaper_params_t *params);
 
int odp_tm_shaper_destroy(odp_tm_shaper_t shaper_profile);
 
int odp_tm_shaper_params_read(odp_tm_shaper_t shaper_profile,
                  odp_tm_shaper_params_t *params);
 
int odp_tm_shaper_params_update(odp_tm_shaper_t shaper_profile,
                const odp_tm_shaper_params_t *params);
 
odp_tm_shaper_t odp_tm_shaper_lookup(const char *name);
 
/* Scheduler Profiles - types and functions
 * -------------------------------------------------------- */
 
typedef enum {
    ODP_TM_BYTE_BASED_WEIGHTS, 
    ODP_TM_FRAME_BASED_WEIGHTS 
} odp_tm_sched_mode_t;
 
typedef struct {
    odp_tm_sched_mode_t sched_modes[ODP_TM_MAX_PRIORITIES];
 
    uint32_t sched_weights[ODP_TM_MAX_PRIORITIES];
} odp_tm_sched_params_t;
 
void odp_tm_sched_params_init(odp_tm_sched_params_t *params);
 
odp_tm_sched_t odp_tm_sched_create(const char *name,
                   const odp_tm_sched_params_t *params);
 
int odp_tm_sched_destroy(odp_tm_sched_t sched_profile);
 
int odp_tm_sched_params_read(odp_tm_sched_t sched_profile,
                 odp_tm_sched_params_t *params);
 
int odp_tm_sched_params_update(odp_tm_sched_t sched_profile,
                   const odp_tm_sched_params_t *params);
 
odp_tm_sched_t odp_tm_sched_lookup(const char *name);
 
/* Queue Threshold Profiles - types and functions
 * -------------------------------------------------------- */
 
typedef struct {
    uint64_t max_pkts; 
    uint64_t max_bytes; 
    odp_bool_t enable_max_pkts;
 
    odp_bool_t enable_max_bytes;
} odp_tm_threshold_params_t;
 
void odp_tm_threshold_params_init(odp_tm_threshold_params_t *params);
 
odp_tm_threshold_t odp_tm_threshold_create(const char *name,
                       const odp_tm_threshold_params_t
                       *params);
 
int odp_tm_threshold_destroy(odp_tm_threshold_t threshold_profile);
 
int odp_tm_thresholds_params_read(odp_tm_threshold_t threshold_profile,
                  odp_tm_threshold_params_t *params);
 
int odp_tm_thresholds_params_update(odp_tm_threshold_t threshold_profile,
                    const odp_tm_threshold_params_t *params);
 
odp_tm_threshold_t odp_tm_thresholds_lookup(const char *name);
 
/* WRED Profiles - types and functions
 * -------------------------------------------------------- */
 
typedef struct {
    odp_tm_percent_t min_threshold;
 
    odp_tm_percent_t med_threshold;
 
    odp_tm_percent_t med_drop_prob;
 
    odp_tm_percent_t max_drop_prob;
 
    odp_bool_t enable_wred;
 
    odp_bool_t use_byte_fullness;
} odp_tm_wred_params_t;
 
void odp_tm_wred_params_init(odp_tm_wred_params_t *params);
 
odp_tm_wred_t odp_tm_wred_create(const char *name,
                 const odp_tm_wred_params_t *params);
 
int odp_tm_wred_destroy(odp_tm_wred_t wred_profile);
 
int odp_tm_wred_params_read(odp_tm_wred_t wred_profile,
                odp_tm_wred_params_t *params);
 
int odp_tm_wred_params_update(odp_tm_wred_t wred_profile,
                  const odp_tm_wred_params_t *params);
 
odp_tm_wred_t odp_tm_wred_lookup(const char *name);
 
typedef struct {
    void *user_context;
 
    uint32_t max_fanin;
 
    odp_tm_shaper_t shaper_profile;
 
    odp_tm_threshold_t threshold_profile;
 
    odp_tm_wred_t wred_profile[ODP_NUM_PACKET_COLORS];
 
    uint8_t level;
 
    uint8_t priority;
} odp_tm_node_params_t;
 
void odp_tm_node_params_init(odp_tm_node_params_t *params);
 
odp_tm_node_t odp_tm_node_create(odp_tm_t tm, const char *name,
                 const odp_tm_node_params_t *params);
 
int odp_tm_node_destroy(odp_tm_node_t tm_node);
 
int odp_tm_node_shaper_config(odp_tm_node_t tm_node,
                  odp_tm_shaper_t shaper_profile);
 
int odp_tm_node_sched_config(odp_tm_node_t tm_node,
                 odp_tm_node_t tm_fan_in_node,
                 odp_tm_sched_t sched_profile);
 
int odp_tm_node_threshold_config(odp_tm_node_t tm_node,
                 odp_tm_threshold_t thresholds_profile);
 
int odp_tm_node_wred_config(odp_tm_node_t tm_node,
                odp_packet_color_t pkt_color,
                odp_tm_wred_t wred_profile);
 
odp_tm_node_t odp_tm_node_lookup(odp_tm_t tm, const char *name);
 
void *odp_tm_node_context(odp_tm_node_t tm_node);
 
int odp_tm_node_context_set(odp_tm_node_t tm_node, void *user_context);
 
typedef struct {
    void *user_context;
 
    odp_tm_shaper_t shaper_profile;
 
    odp_tm_threshold_t threshold_profile;
 
    odp_tm_wred_t wred_profile[ODP_NUM_PACKET_COLORS];
 
    uint8_t priority;
 
    odp_bool_t ordered_enqueue;
} odp_tm_queue_params_t;
 
void odp_tm_queue_params_init(odp_tm_queue_params_t *params);
 
odp_tm_queue_t odp_tm_queue_create(odp_tm_t tm,
                   const odp_tm_queue_params_t *params);
 
int odp_tm_queue_destroy(odp_tm_queue_t tm_queue);
 
void *odp_tm_queue_context(odp_tm_queue_t tm_queue);
 
int odp_tm_queue_context_set(odp_tm_queue_t tm_queue, void *user_context);
 
int odp_tm_queue_shaper_config(odp_tm_queue_t tm_queue,
                   odp_tm_shaper_t shaper_profile);
 
int odp_tm_queue_sched_config(odp_tm_node_t tm_node,
                  odp_tm_queue_t tm_fan_in_queue,
                  odp_tm_sched_t sched_profile);
 
int odp_tm_queue_threshold_config(odp_tm_queue_t tm_queue,
                  odp_tm_threshold_t thresholds_profile);
 
int odp_tm_queue_wred_config(odp_tm_queue_t tm_queue,
                 odp_packet_color_t pkt_color,
                 odp_tm_wred_t wred_profile);
 
/* Topology setting functions
 * -------------------------------------------------------- */
 
int odp_tm_node_connect(odp_tm_node_t src_tm_node, odp_tm_node_t dst_tm_node);
 
int odp_tm_node_disconnect(odp_tm_node_t src_tm_node);
 
int odp_tm_queue_connect(odp_tm_queue_t tm_queue, odp_tm_node_t dst_tm_node);
 
int odp_tm_queue_disconnect(odp_tm_queue_t tm_queue);
 
/* Input API
 * -------------------------------------------------------- */
 
int odp_tm_enq(odp_tm_queue_t tm_queue, odp_packet_t pkt);
 
int odp_tm_enq_multi(odp_tm_queue_t tm_queue, const odp_packet_t packets[], int num);
 
int odp_tm_enq_multi_lso(odp_tm_queue_t tm_queue, const odp_packet_t packets[], int num,
             const odp_packet_lso_opt_t *lso_opt);
 
int odp_tm_enq_with_cnt(odp_tm_queue_t tm_queue, odp_packet_t pkt);
 
/* Dynamic state query functions
 * -------------------------------------------------------- */
 
typedef struct {
    odp_tm_shaper_t shaper_profile;
 
    odp_tm_threshold_t threshold_profile;
 
    odp_tm_wred_t wred_profile[ODP_NUM_PACKET_COLORS];
 
    uint32_t tm_queue_fanin;
 
    uint32_t tm_node_fanin;
 
    odp_tm_node_t next_tm_node;
 
    uint8_t level;
} odp_tm_node_info_t;
 
int odp_tm_node_info(odp_tm_node_t tm_node, odp_tm_node_info_t *info);
 
typedef struct {
    odp_tm_sched_t sched_profile;
 
    odp_tm_queue_t tm_queue;
 
    odp_tm_node_t tm_node;
 
    odp_bool_t is_last;
} odp_tm_node_fanin_info_t;
 
int odp_tm_node_fanin_info(odp_tm_node_t             tm_node,
               odp_tm_node_fanin_info_t *info);
 
int odp_tm_node_stats(odp_tm_node_t tm_node, odp_tm_node_stats_t *stats);
 
typedef struct {
    odp_tm_shaper_t shaper_profile;
 
    odp_tm_threshold_t threshold_profile;
 
    odp_tm_wred_t wred_profile[ODP_NUM_PACKET_COLORS];
 
    odp_tm_node_t next_tm_node;
 
    odp_packet_t active_pkt;
} odp_tm_queue_info_t;
 
int odp_tm_queue_info(odp_tm_queue_t tm_queue, odp_tm_queue_info_t *info);
 
#define ODP_TM_QUERY_PKT_CNT     0x01   
#define ODP_TM_QUERY_BYTE_CNT    0x02   
#define ODP_TM_QUERY_THRESHOLDS  0x04   
typedef struct {
    uint64_t total_pkt_cnt;
 
    uint64_t max_pkt_cnt;
 
    uint64_t total_byte_cnt;
 
    uint64_t max_byte_cnt;
 
    odp_bool_t total_pkt_cnt_valid;  
    odp_bool_t max_pkt_cnt_valid;    
    odp_bool_t total_byte_cnt_valid; 
    odp_bool_t max_byte_cnt_valid;   
    odp_bool_t approx_byte_cnt;
} odp_tm_query_info_t;
 
int odp_tm_queue_query(odp_tm_queue_t       tm_queue,
               uint32_t             query_flags,
               odp_tm_query_info_t *info);
 
int odp_tm_priority_query(odp_tm_t             odp_tm,
              uint8_t              priority,
              uint32_t             query_flags,
              odp_tm_query_info_t *info);
 
int odp_tm_total_query(odp_tm_t             odp_tm,
               uint32_t             query_flags,
               odp_tm_query_info_t *info);
 
int odp_tm_priority_threshold_config(odp_tm_t           odp_tm,
                     uint8_t            priority,
                     odp_tm_threshold_t thresholds_profile);
 
int odp_tm_total_threshold_config(odp_tm_t tm,
                  odp_tm_threshold_t thresholds_profile);
 
odp_bool_t odp_tm_is_idle(odp_tm_t tm);
 
void odp_tm_stats_print(odp_tm_t tm);
 
int odp_tm_queue_stats(odp_tm_queue_t tm_queue, odp_tm_queue_stats_t *stats);
 
uint64_t odp_tm_to_u64(odp_tm_t tm);
 
uint64_t odp_tm_queue_to_u64(odp_tm_queue_t hdl);
 
uint64_t odp_tm_node_to_u64(odp_tm_node_t hdl);
 
uint64_t odp_tm_shaper_to_u64(odp_tm_shaper_t hdl);
 
uint64_t odp_tm_sched_to_u64(odp_tm_sched_t hdl);
 
uint64_t odp_tm_threshold_to_u64(odp_tm_threshold_t hdl);
 
uint64_t odp_tm_wred_to_u64(odp_tm_wred_t hdl);
 
#ifdef __cplusplus
}
#endif
 
#include <odp/visibility_end.h>
#endif