cne_lport.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2019-2022 Intel Corporation
 */
 
#ifndef _CNE_LPORT_H_
#define _CNE_LPORT_H_
 
#include <stdint.h>        // for uint16_t, uint32_t
#include <sys/types.h>
#include <stdbool.h>
#include <pktmbuf.h>
 
#include <cne_common.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define LPORT_NAME_LEN             32
#define LPORT_FRAME_SIZE           2048
#define LPORT_MBUF_OVERHEAD        sizeof(struct pkt_buf)
#define LPORT_DATA_HEADROOM        XDP_PACKET_HEADROOM
#define LPORT_DFLT_RX_NUM_DESCS    XSK_RING_CONS__DEFAULT_NUM_DESCS
#define LPORT_DFLT_TX_NUM_DESCS    (XSK_RING_CONS__DEFAULT_NUM_DESCS * 2)
#define LPORT_FRAME_SHIFT          11 /* Log2(2048) of LPORT_FRAME_SIZE to avoid a divide */
#define LPORT_DFLT_START_QUEUE_IDX 0
#define LPORT_DFLT_QUEUE_COUNT     1
#define LPORT_RX_BATCH_SIZE        256
#define LPORT_TX_BATCH_SIZE        256
 
typedef int (*buf_alloc_t)(void *arg, void **bufs, uint16_t nb_pkts);
typedef void (*buf_free_t)(void *arg, void **bufs, uint16_t nb_pkts);
typedef void (*buf_set_len_t)(void *buf, int len);
typedef void (*buf_set_data_len_t)(void *buf, int len);
typedef void (*buf_set_data_t)(void *buf, uint64_t off);
typedef void (*buf_reset_t)(void *buf, uint32_t buf_len, size_t headroom);
typedef void **(*buf_inc_ptr_t)(void **buf);
typedef uint16_t (*buf_get_data_len_t)(void *buf);
typedef uint64_t (*buf_get_data_t)(void *buf);
typedef uint64_t (*buf_get_addr_t)(void *buf);
typedef uint16_t (*buf_rx_burst_t)(void *arg, void **bufs, uint16_t nb_pkts);
typedef uint16_t (*buf_tx_burst_t)(void *arg, void **bufs, uint16_t nb_pkts);
 
typedef struct lport_buf_mgmt {
    buf_alloc_t buf_alloc;               
    buf_free_t buf_free;                 
    buf_set_len_t buf_set_len;           
    buf_set_data_len_t buf_set_data_len; 
    buf_set_data_t buf_set_data;         
    buf_reset_t buf_reset;               
    buf_get_data_len_t buf_get_data_len; 
    buf_get_data_t buf_get_data;         
    buf_get_addr_t buf_get_addr;         
    buf_inc_ptr_t buf_inc_ptr;           
    uint32_t frame_size;                 
    size_t buf_headroom;                 
    size_t pool_header_sz;               
    void *buf_arg;                       
    buf_rx_burst_t buf_rx_burst;         
    buf_tx_burst_t buf_tx_burst;         
    bool unaligned_buff;                 
} lport_buf_mgmt_t;
 
typedef struct lport_cfg {
    char name[LPORT_NAME_LEN];     
    char ifname[LPORT_NAME_LEN];   
    char pmd_name[LPORT_NAME_LEN]; 
    uint16_t flags;                
    uint16_t qid;                  
    uint32_t bufcnt;               
    uint32_t bufsz;                
    uint32_t rx_nb_desc;           
    uint32_t tx_nb_desc;           
    uint16_t busy_timeout;         
    uint16_t busy_budget;          
    void *addr;                    
    char *umem_addr;               
    char *pmd_opts;                
    size_t umem_size;              
    pktmbuf_info_t *pi;            
    void *xsk_uds;                 
    lport_buf_mgmt_t buf_mgmt;     
} lport_cfg_t;
 
#define LPORT_UNPRIVILEGED           (1 << 0) 
#define LPORT_FORCE_WAKEUP           (1 << 1) 
#define LPORT_SKB_MODE               (1 << 2) 
#define LPORT_BUSY_POLLING           (1 << 3) 
#define LPORT_SHARED_UMEM            (1 << 4) 
#define LPORT_USER_MANAGED_BUFFERS   (1 << 5) 
#define LPORT_UMEM_UNALIGNED_BUFFERS (1 << 6) 
typedef struct lport_stats {
    uint64_t ipackets;           
    uint64_t opackets;           
    uint64_t ibytes;             
    uint64_t obytes;             
    uint64_t ierrors;            
    uint64_t oerrors;            
    uint64_t imissed;            
    uint64_t odropped;           
    uint64_t rx_invalid;         
    uint64_t tx_invalid;         
                                 /* RX debug stats */
    uint64_t rx_ring_empty;      
    uint64_t rx_buf_alloc;       
    uint64_t rx_busypoll_wakeup; 
    uint64_t rx_poll_wakeup;     
    uint64_t rx_rcvd_count;      
    uint64_t rx_burst_called;    
#if LINUX_VERSION_CODE >= KERNEL_VERSION(5, 9, 0)
    uint64_t rx_ring_full;       
    uint64_t rx_fill_ring_empty; 
    uint64_t tx_ring_empty;      
#endif
    /* FQ debug stats */
    uint64_t fq_add_count;    
    uint64_t fq_alloc_failed; 
    uint64_t fq_buf_freed;    
                              /* TX debug stats */
    uint64_t tx_kicks;        
    uint64_t tx_kick_failed;  
    uint64_t tx_kick_again;   
    uint64_t tx_ring_full;    
    uint64_t tx_copied;       
                              /* CQ debug stats */
    uint64_t cq_empty;        
    uint64_t cq_buf_freed;    
} lport_stats_t;
 
#ifdef __cplusplus
}
#endif
 
#endif /* _CNE_LPORT_H_ */