rte_flow_classify.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2017 Intel Corporation
 */

#ifndef _RTE_FLOW_CLASSIFY_H_
#define _RTE_FLOW_CLASSIFY_H_

#include <rte_compat.h>
#include <rte_common.h>
#include <rte_flow.h>

#ifdef __cplusplus
extern "C" {
#endif

extern int librte_flow_classify_logtype;

#define RTE_FLOW_CLASSIFY_LOG(level, ...) \
    rte_log(RTE_LOG_ ## level, \
        librte_flow_classify_logtype, \
        RTE_FMT("%s(): " RTE_FMT_HEAD(__VA_ARGS__,), \
            __func__, \
            RTE_FMT_TAIL(__VA_ARGS__,)))

#ifndef RTE_FLOW_CLASSIFY_TABLE_MAX
#define RTE_FLOW_CLASSIFY_TABLE_MAX     32
#endif

struct rte_flow_classifier;

struct rte_flow_classify_rule;

enum rte_flow_classify_rule_type {
    RTE_FLOW_CLASSIFY_RULE_TYPE_NONE,
    RTE_FLOW_CLASSIFY_RULE_TYPE_IPV4_5TUPLE,
};

enum rte_flow_classify_table_type {
    RTE_FLOW_CLASSIFY_TABLE_TYPE_NONE = 1 << 0,
    RTE_FLOW_CLASSIFY_TABLE_ACL_IP4_5TUPLE = 1 << 1,
    RTE_FLOW_CLASSIFY_TABLE_ACL_VLAN_IP4_5TUPLE = 1 << 2,
    RTE_FLOW_CLASSIFY_TABLE_ACL_QINQ_IP4_5TUPLE = 1 << 3,

};

struct rte_flow_classifier_params {
    const char *name;

    int socket_id;
};

struct rte_flow_classify_table_params {
    struct rte_table_ops *ops;

    void *arg_create;

    enum rte_flow_classify_table_type type;
};

struct rte_flow_classify_ipv4_5tuple {
    uint32_t dst_ip;         
    uint32_t dst_ip_mask;    
    uint32_t src_ip;         
    uint32_t src_ip_mask;    
    uint16_t dst_port;       
    uint16_t dst_port_mask;  
    uint16_t src_port;       
    uint16_t src_port_mask;  
    uint8_t proto;           
    uint8_t proto_mask;      
};

struct rte_flow_classify_stats {
    void *stats;
};

struct rte_flow_classify_ipv4_5tuple_stats {
    uint64_t counter1;
    struct rte_flow_classify_ipv4_5tuple ipv4_5tuple;
};

__rte_experimental
struct rte_flow_classifier *
rte_flow_classifier_create(struct rte_flow_classifier_params *params);

__rte_experimental
int
rte_flow_classifier_free(struct rte_flow_classifier *cls);

__rte_experimental
int
rte_flow_classify_table_create(struct rte_flow_classifier *cls,
        struct rte_flow_classify_table_params *params);

__rte_experimental
int
rte_flow_classify_validate(struct rte_flow_classifier *cls,
        const struct rte_flow_attr *attr,
        const struct rte_flow_item pattern[],
        const struct rte_flow_action actions[],
        struct rte_flow_error *error);

__rte_experimental
struct rte_flow_classify_rule *
rte_flow_classify_table_entry_add(struct rte_flow_classifier *cls,
        const struct rte_flow_attr *attr,
        const struct rte_flow_item pattern[],
        const struct rte_flow_action actions[],
        int *key_found,
        struct rte_flow_error *error);

__rte_experimental
int
rte_flow_classify_table_entry_delete(struct rte_flow_classifier *cls,
        struct rte_flow_classify_rule *rule);

__rte_experimental
int
rte_flow_classifier_query(struct rte_flow_classifier *cls,
        struct rte_mbuf **pkts,
        const uint16_t nb_pkts,
        struct rte_flow_classify_rule *rule,
        struct rte_flow_classify_stats *stats);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_FLOW_CLASSIFY_H_ */