rte_port.h

Go to the documentation of this file.

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

#ifndef __INCLUDE_RTE_PORT_H__
#define __INCLUDE_RTE_PORT_H__

#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 **pkts,
    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;   
};

#endif