rte_pipeline.h

Go to the documentation of this file.

/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2010-2016 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_PIPELINE_H__
#define __INCLUDE_RTE_PIPELINE_H__

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>

#include <rte_port.h>
#include <rte_table.h>
#include <rte_common.h>

struct rte_mbuf;

/*
 * Pipeline
 *
 */
struct rte_pipeline;

struct rte_pipeline_params {
    const char *name;

    int socket_id;

    uint32_t offset_port_id;
};

struct rte_pipeline_port_in_stats {
    struct rte_port_in_stats stats;

    uint64_t n_pkts_dropped_by_ah;

};

struct rte_pipeline_port_out_stats {
    struct rte_port_out_stats stats;

    uint64_t n_pkts_dropped_by_ah;
};

struct rte_pipeline_table_stats {
    struct rte_table_stats stats;

    uint64_t n_pkts_dropped_by_lkp_hit_ah;

    uint64_t n_pkts_dropped_by_lkp_miss_ah;

    uint64_t n_pkts_dropped_lkp_hit;

    uint64_t n_pkts_dropped_lkp_miss;
};

struct rte_pipeline *rte_pipeline_create(struct rte_pipeline_params *params);

int rte_pipeline_free(struct rte_pipeline *p);

int rte_pipeline_check(struct rte_pipeline *p);

int rte_pipeline_run(struct rte_pipeline *p);

int rte_pipeline_flush(struct rte_pipeline *p);

/*
 * Actions
 *
 */
enum rte_pipeline_action {
    RTE_PIPELINE_ACTION_DROP = 0,

    RTE_PIPELINE_ACTION_PORT,

    RTE_PIPELINE_ACTION_PORT_META,

    RTE_PIPELINE_ACTION_TABLE,

    RTE_PIPELINE_ACTIONS
};

/*
 * Table
 *
 */
#define RTE_PIPELINE_TABLE_MAX                                     64

struct rte_pipeline_table_entry {
    enum rte_pipeline_action action;

    RTE_STD_C11
    union {
        uint32_t port_id;
        uint32_t table_id;
    };
    __extension__ uint8_t action_data[0];
};

typedef int (*rte_pipeline_table_action_handler_hit)(
    struct rte_pipeline *p,
    struct rte_mbuf **pkts,
    uint64_t pkts_mask,
    struct rte_pipeline_table_entry **entries,
    void *arg);

typedef int (*rte_pipeline_table_action_handler_miss)(
    struct rte_pipeline *p,
    struct rte_mbuf **pkts,
    uint64_t pkts_mask,
    struct rte_pipeline_table_entry *entry,
    void *arg);

struct rte_pipeline_table_params {
    struct rte_table_ops *ops;
    void *arg_create;
    rte_pipeline_table_action_handler_hit f_action_hit;
    rte_pipeline_table_action_handler_miss f_action_miss;

    void *arg_ah;
    uint32_t action_data_size;
};

int rte_pipeline_table_create(struct rte_pipeline *p,
    struct rte_pipeline_table_params *params,
    uint32_t *table_id);

int rte_pipeline_table_default_entry_add(struct rte_pipeline *p,
    uint32_t table_id,
    struct rte_pipeline_table_entry *default_entry,
    struct rte_pipeline_table_entry **default_entry_ptr);

int rte_pipeline_table_default_entry_delete(struct rte_pipeline *p,
    uint32_t table_id,
    struct rte_pipeline_table_entry *entry);

int rte_pipeline_table_entry_add(struct rte_pipeline *p,
    uint32_t table_id,
    void *key,
    struct rte_pipeline_table_entry *entry,
    int *key_found,
    struct rte_pipeline_table_entry **entry_ptr);

int rte_pipeline_table_entry_delete(struct rte_pipeline *p,
    uint32_t table_id,
    void *key,
    int *key_found,
    struct rte_pipeline_table_entry *entry);

int rte_pipeline_table_entry_add_bulk(struct rte_pipeline *p,
    uint32_t table_id,
    void **keys,
    struct rte_pipeline_table_entry **entries,
    uint32_t n_keys,
    int *key_found,
    struct rte_pipeline_table_entry **entries_ptr);

int rte_pipeline_table_entry_delete_bulk(struct rte_pipeline *p,
    uint32_t table_id,
    void **keys,
    uint32_t n_keys,
    int *key_found,
    struct rte_pipeline_table_entry **entries);

int rte_pipeline_table_stats_read(struct rte_pipeline *p, uint32_t table_id,
    struct rte_pipeline_table_stats *stats, int clear);

/*
 * Port IN
 *
 */
#define RTE_PIPELINE_PORT_IN_MAX                                    64

typedef int (*rte_pipeline_port_in_action_handler)(
    struct rte_pipeline *p,
    struct rte_mbuf **pkts,
    uint32_t n,
    void *arg);

struct rte_pipeline_port_in_params {
    struct rte_port_in_ops *ops;
    void *arg_create;

    rte_pipeline_port_in_action_handler f_action;
    void *arg_ah;

    uint32_t burst_size;
};

int rte_pipeline_port_in_create(struct rte_pipeline *p,
    struct rte_pipeline_port_in_params *params,
    uint32_t *port_id);

int rte_pipeline_port_in_connect_to_table(struct rte_pipeline *p,
    uint32_t port_id,
    uint32_t table_id);

int rte_pipeline_port_in_enable(struct rte_pipeline *p,
    uint32_t port_id);

int rte_pipeline_port_in_disable(struct rte_pipeline *p,
    uint32_t port_id);

int rte_pipeline_port_in_stats_read(struct rte_pipeline *p, uint32_t port_id,
    struct rte_pipeline_port_in_stats *stats, int clear);

/*
 * Port OUT
 *
 */
#define RTE_PIPELINE_PORT_OUT_MAX                                   64

typedef int (*rte_pipeline_port_out_action_handler)(
    struct rte_pipeline *p,
    struct rte_mbuf **pkts,
    uint64_t pkts_mask,
    void *arg);

struct rte_pipeline_port_out_params {
    struct rte_port_out_ops *ops;
    void *arg_create;

    rte_pipeline_port_out_action_handler f_action;
    void *arg_ah;
};

int rte_pipeline_port_out_create(struct rte_pipeline *p,
    struct rte_pipeline_port_out_params *params,
    uint32_t *port_id);

int rte_pipeline_port_out_stats_read(struct rte_pipeline *p, uint32_t port_id,
    struct rte_pipeline_port_out_stats *stats, int clear);

/*
 * Functions to be called as part of the port IN/OUT or table action handlers
 *
 */
int rte_pipeline_port_out_packet_insert(struct rte_pipeline *p,
    uint32_t port_id,
    struct rte_mbuf *pkt);

#define rte_pipeline_ah_port_out_packet_insert \
    rte_pipeline_port_out_packet_insert

int rte_pipeline_ah_packet_hijack(struct rte_pipeline *p,
    uint64_t pkts_mask);

int rte_pipeline_ah_packet_drop(struct rte_pipeline *p,
    uint64_t pkts_mask);

#ifdef __cplusplus
}
#endif

#endif