rte_port.h

Go to the documentation of this file.

/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2010-2014 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_PORT_H__
#define __INCLUDE_RTE_PORT_H__

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <rte_mbuf.h>

#define RTE_MBUF_METADATA_UINT8_PTR(mbuf, offset)          \
    (&((uint8_t *)(mbuf))[offset])
#define RTE_MBUF_METADATA_UINT16_PTR(mbuf, offset)         \
    ((uint16_t *) RTE_MBUF_METADATA_UINT8_PTR(mbuf, offset))
#define RTE_MBUF_METADATA_UINT32_PTR(mbuf, offset)         \
    ((uint32_t *) RTE_MBUF_METADATA_UINT8_PTR(mbuf, offset))
#define RTE_MBUF_METADATA_UINT64_PTR(mbuf, offset)         \
    ((uint64_t *) RTE_MBUF_METADATA_UINT8_PTR(mbuf, offset))

#define RTE_MBUF_METADATA_UINT8(mbuf, offset)              \
    (*RTE_MBUF_METADATA_UINT8_PTR(mbuf, offset))
#define RTE_MBUF_METADATA_UINT16(mbuf, offset)             \
    (*RTE_MBUF_METADATA_UINT16_PTR(mbuf, offset))
#define RTE_MBUF_METADATA_UINT32(mbuf, offset)             \
    (*RTE_MBUF_METADATA_UINT32_PTR(mbuf, offset))
#define RTE_MBUF_METADATA_UINT64(mbuf, offset)             \
    (*RTE_MBUF_METADATA_UINT64_PTR(mbuf, offset))

/*
 * Port IN
 *
 */
#define RTE_PORT_IN_BURST_SIZE_MAX                         64

struct rte_port_in_stats {
    uint64_t n_pkts_in;
    uint64_t n_pkts_drop;
};

typedef void* (*rte_port_in_op_create)(void *params, int socket_id);

typedef int (*rte_port_in_op_free)(void *port);

typedef int (*rte_port_in_op_rx)(
    void *port,
    struct rte_mbuf **pkts,
    uint32_t n_pkts);

typedef int (*rte_port_in_op_stats_read)(
        void *port,
        struct rte_port_in_stats *stats,
        int clear);

struct rte_port_in_ops {
    rte_port_in_op_create f_create;      
    rte_port_in_op_free f_free;          
    rte_port_in_op_rx f_rx;              
    rte_port_in_op_stats_read f_stats;   
};

/*
 * Port OUT
 *
 */
struct rte_port_out_stats {
    uint64_t n_pkts_in;
    uint64_t n_pkts_drop;
};

typedef void* (*rte_port_out_op_create)(void *params, int socket_id);

typedef int (*rte_port_out_op_free)(void *port);

typedef int (*rte_port_out_op_tx)(
    void *port,
    struct rte_mbuf *pkt);

typedef int (*rte_port_out_op_tx_bulk)(
    void *port,
    struct rte_mbuf **pkt,
    uint64_t pkts_mask);

typedef int (*rte_port_out_op_flush)(void *port);

typedef int (*rte_port_out_op_stats_read)(
        void *port,
        struct rte_port_out_stats *stats,
        int clear);

struct rte_port_out_ops {
    rte_port_out_op_create f_create;      
    rte_port_out_op_free f_free;          
    rte_port_out_op_tx f_tx;              
    rte_port_out_op_tx_bulk f_tx_bulk;    
    rte_port_out_op_flush f_flush;        
    rte_port_out_op_stats_read f_stats;   
};

#ifdef __cplusplus
}
#endif

#endif