api/spec/classification.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2014-2018 Linaro Limited
 * Copyright (c) 2021-2025 Nokia
 */
 
#ifndef ODP_API_SPEC_CLASSIFICATION_H_
#define ODP_API_SPEC_CLASSIFICATION_H_
#include <odp/visibility_begin.h>
 
#include <odp/api/packet_io_types.h>
#include <odp/api/pool_types.h>
#include <odp/api/std_types.h>
#include <odp/api/threshold.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
    ODP_PMR_LEN,
 
    ODP_PMR_ETHTYPE_0,
 
    ODP_PMR_ETHTYPE_X,
 
    ODP_PMR_VLAN_ID_0,
 
    ODP_PMR_VLAN_ID_X,
 
    ODP_PMR_VLAN_PCP_0,
 
    ODP_PMR_DMAC,
 
    ODP_PMR_IPPROTO,
 
    ODP_PMR_IP_DSCP,
 
    ODP_PMR_UDP_DPORT,
 
    ODP_PMR_TCP_DPORT,
 
    ODP_PMR_UDP_SPORT,
 
    ODP_PMR_TCP_SPORT,
 
    ODP_PMR_SIP_ADDR,
 
    ODP_PMR_DIP_ADDR,
 
    ODP_PMR_SIP6_ADDR,
 
    ODP_PMR_DIP6_ADDR,
 
    ODP_PMR_IPSEC_SPI,
 
    ODP_PMR_LD_VNI,
 
    ODP_PMR_CUSTOM_FRAME,
 
    ODP_PMR_CUSTOM_L3,
 
    ODP_PMR_IGMP_GRP_ADDR,
 
    ODP_PMR_ICMP_ID,
 
    ODP_PMR_ICMP_TYPE,
 
    ODP_PMR_ICMP_CODE,
 
    ODP_PMR_SCTP_SPORT,
 
    ODP_PMR_SCTP_DPORT,
 
    ODP_PMR_GTPV1_TEID,
 
    ODP_PMR_INNER_HDR_OFF = 32
 
} odp_cls_pmr_term_t;
 
typedef union odp_cls_pmr_terms_t {
    struct {
        uint64_t    len:1;
        uint64_t    ethtype_0:1;
        uint64_t    ethtype_x:1;
        uint64_t    vlan_id_0:1;
        uint64_t    vlan_id_x:1;
        uint64_t    vlan_pcp_0:1;
        uint64_t    dmac:1;
        uint64_t    ip_proto:1;
        uint64_t    ip_dscp:1;
        uint64_t    udp_dport:1;
        uint64_t    tcp_dport:1;
        uint64_t    udp_sport:1;
        uint64_t    tcp_sport:1;
        uint64_t    sip_addr:1;
        uint64_t    dip_addr:1;
        uint64_t    sip6_addr:1;
        uint64_t    dip6_addr:1;
        uint64_t    ipsec_spi:1;
        uint64_t    ld_vni:1;
        uint64_t        custom_frame:1;
        uint64_t        custom_l3:1;
        uint64_t    igmp_grp_addr:1;
        uint64_t    icmp_id:1;
        uint64_t    icmp_type:1;
        uint64_t    icmp_code:1;
        uint64_t    sctp_sport:1;
        uint64_t    sctp_dport:1;
        uint64_t    gtpv1_teid:1;
    } bit;
 
    uint64_t all_bits;
 
} odp_cls_pmr_terms_t;
 
typedef struct odp_pmr_param_t {
    odp_cls_pmr_term_t  term;
 
    odp_bool_t range_term;
 
    union {
        struct {
            const void *value;
 
            const void *mask;
        } match;
 
        struct {
            const void *val_start;
 
            const void *val_end;
        } range;
    };
 
    uint32_t val_sz;
 
    uint32_t offset;
 
} odp_pmr_param_t;
 
typedef struct odp_pmr_create_opt_t {
    odp_pmr_param_t *terms;
 
    int num_terms;
 
    uint64_t mark;
 
} odp_pmr_create_opt_t;
 
typedef struct odp_red_param_t {
    odp_bool_t enable;
 
    odp_threshold_t threshold;
 
} odp_red_param_t;
 
typedef struct odp_bp_param_t {
    odp_bool_t enable;
 
    odp_threshold_t threshold;
 
    uint8_t pfc_level;
 
} odp_bp_param_t;
 
typedef struct odp_cls_cos_stats_t {
    uint64_t octets;
 
    uint64_t packets;
 
    uint64_t discards;
 
    uint64_t errors;
 
} odp_cls_cos_stats_t;
 
typedef struct odp_cls_queue_stats_t {
    uint64_t octets;
 
    uint64_t packets;
 
    uint64_t discards;
 
    uint64_t errors;
 
} odp_cls_queue_stats_t;
 
typedef struct odp_cls_stats_capability_t {
    struct {
        union {
            struct {
                uint64_t octets          : 1;
 
                uint64_t packets         : 1;
 
                uint64_t discards        : 1;
 
                uint64_t errors          : 1;
 
            } counter;
 
            uint64_t all_counters;
        };
    } cos;
 
    struct {
        union {
            struct {
                uint64_t octets          : 1;
 
                uint64_t packets         : 1;
 
                uint64_t discards        : 1;
 
                uint64_t errors          : 1;
 
            } counter;
 
            uint64_t all_counters;
        };
    } queue;
 
} odp_cls_stats_capability_t;
 
typedef struct odp_cls_aggr_capability_t {
    struct {
        uint64_t ipv4_frag : 1;
 
        uint64_t ipv6_frag : 1;
 
        uint64_t custom : 1;
 
    } enq_profile_type;
 
} odp_cls_aggr_capability_t;
 
typedef struct odp_cls_capability_t {
    odp_cls_pmr_terms_t supported_terms;
 
    uint32_t max_pmr;
 
    uint32_t max_pmr_per_cos;
 
    uint32_t max_terms_per_pmr;
 
    uint32_t max_cos;
 
    uint32_t max_cos_stats;
 
    uint32_t max_hash_queues;
 
    odp_pktin_hash_proto_t hash_protocols;
 
    odp_bool_t pmr_range_supported;
 
    odp_support_t random_early_detection;
 
    odp_threshold_types_t threshold_red;
 
    odp_support_t back_pressure;
 
    odp_threshold_types_t threshold_bp;
 
    uint64_t max_mark;
 
    odp_cls_stats_capability_t stats;
 
    odp_cls_aggr_capability_t aggr;
 
} odp_cls_capability_t;
 
typedef enum {
    ODP_COS_ACTION_ENQUEUE,
 
    ODP_COS_ACTION_DROP,
 
} odp_cos_action_t;
 
typedef struct odp_cls_cos_param {
    odp_cos_action_t action;
 
    odp_bool_t stats_enable;
 
    uint32_t num_queue;
 
    union {
        odp_queue_t queue;
 
        struct {
            odp_queue_param_t queue_param;
 
            odp_pktin_hash_proto_t hash_proto;
        };
    };
    odp_pool_t pool;
 
    odp_red_param_t red;
 
    odp_bp_param_t bp;
 
    odp_pktin_vector_config_t vector;
 
    odp_aggr_enq_profile_t aggr_enq_profile;
 
} odp_cls_cos_param_t;
 
void odp_cls_cos_param_init(odp_cls_cos_param_t *param);
 
int odp_cls_capability(odp_cls_capability_t *capability);
 
odp_cos_t odp_cls_cos_create(const char *name,
                 const odp_cls_cos_param_t *param);
 
int odp_cls_cos_create_multi(const char *name[],
                 const odp_cls_cos_param_t param[],
                 odp_cos_t cos[], int num);
 
odp_queue_t odp_cls_hash_result(odp_cos_t cos, odp_packet_t packet);
 
int odp_cos_destroy(odp_cos_t cos);
 
int odp_cos_destroy_multi(odp_cos_t cos[], int num);
 
int odp_cos_queue_set(odp_cos_t cos, odp_queue_t queue);
 
odp_queue_t odp_cos_queue(odp_cos_t cos);
 
uint32_t odp_cls_cos_num_queue(odp_cos_t cos);
 
uint32_t odp_cls_cos_queues(odp_cos_t cos, odp_queue_t queue[], uint32_t num);
 
int odp_cls_cos_stats(odp_cos_t cos, odp_cls_cos_stats_t *stats);
 
int odp_cls_queue_stats(odp_cos_t cos, odp_queue_t queue,
            odp_cls_queue_stats_t *stats);
 
void odp_cls_pmr_param_init(odp_pmr_param_t *param);
 
void odp_cls_pmr_create_opt_init(odp_pmr_create_opt_t *opt);
 
odp_pmr_t odp_cls_pmr_create(const odp_pmr_param_t *terms, int num_terms,
                 odp_cos_t src_cos, odp_cos_t dst_cos);
 
odp_pmr_t odp_cls_pmr_create_opt(const odp_pmr_create_opt_t *opt,
                 odp_cos_t src_cos, odp_cos_t dst_cos);
 
int odp_cls_pmr_create_multi(const odp_pmr_create_opt_t opt[],
                 odp_cos_t src_cos[], odp_cos_t dst_cos[],
                 odp_pmr_t pmr[], int num);
 
int odp_cls_pmr_destroy(odp_pmr_t pmr);
 
int odp_cls_pmr_destroy_multi(odp_pmr_t pmr[], int num);
 
int odp_cls_cos_pool_set(odp_cos_t cos, odp_pool_t pool_id);
 
odp_pool_t odp_cls_cos_pool(odp_cos_t cos);
 
uint64_t odp_cos_to_u64(odp_cos_t cos);
 
uint64_t odp_pmr_to_u64(odp_pmr_t pmr);
 
void odp_cls_print_all(void);
 
#ifdef __cplusplus
}
#endif
 
#include <odp/visibility_end.h>
#endif