rte_flow_classify.h

Go to the documentation of this file.

/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2017 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 _RTE_FLOW_CLASSIFY_H_
#define _RTE_FLOW_CLASSIFY_H_

#include <rte_common.h>
#include <rte_ethdev.h>
#include <rte_ether.h>
#include <rte_flow.h>
#include <rte_acl.h>
#include <rte_table_acl.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__,)))

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,
    RTE_FLOW_CLASSIFY_TABLE_TYPE_ACL,
};

#define RTE_FLOW_CLASSIFY_TABLE_MAX  64

struct rte_flow_classifier_params {
    const char *name;

    int socket_id;

    enum rte_flow_classify_table_type type;
};

struct rte_flow_classify_table_params {
    struct rte_table_ops *ops;

    void *arg_create;
};

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

struct rte_flow_classifier *
rte_flow_classifier_create(struct rte_flow_classifier_params *params);

int
rte_flow_classifier_free(struct rte_flow_classifier *cls);

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

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

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

int
rte_flow_classifier_query(struct rte_flow_classifier *cls,
        uint32_t table_id,
        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_ */