pmd_memif_socket.h

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright 2018-2021 Cisco Systems, Inc.  All rights reserved.
 */
 
#ifndef _CNE_ETH_MEMIF_H_
#define _CNE_ETH_MEMIF_H_
 
#ifndef _GNU_SOURCE
#define _GNU_SOURCE
#endif /* GNU_SOURCE */
 
#include <sys/queue.h>
 
#include <cne_spinlock.h>
#include <cne_event.h>
#include "pktdev_api.h"          // for pktdev_get_name_by_port, pktdev_portid
#include "pktdev_core.h"         // for cne_pktdev, pktdev_data, pktdev_ops
#include "netdev_funcs.h"        // for netdev_get_mac_addr
#include "memif_socket.h"
 
#define PMD_NET_MEMIF_NAME "net_memif_socket"
 
#define CNE_ETH_MEMIF_DEFAULT_SOCKET_FILENAME "/var/run/memif.sock"
#define CNE_ETH_MEMIF_DEFAULT_RING_SIZE       10
#define CNE_ETH_MEMIF_DEFAULT_PKT_BUFFER_SIZE 2048
 
#define CNE_ETH_MEMIF_MAX_NUM_Q_PAIRS    1
#define CNE_ETH_MEMIF_MAX_LOG2_RING_SIZE 14
#define CNE_ETH_MEMIF_MAX_REGION_NUM     256
 
#define CNE_ETH_MEMIF_SHM_NAME_SIZE    32
#define CNE_ETH_MEMIF_DISC_STRING_SIZE 96
#define CNE_ETH_MEMIF_SECRET_SIZE      24
 
extern int cne_memif_logtype;
 
#define MIF_LOG(level, fmt, args...) cne_log(CNE_LOG_##level, __func__, __LINE__, fmt, ##args)
 
enum cne_memif_role_t {
    CNE_MEMIF_ROLE_SERVER,
    CNE_MEMIF_ROLE_CLIENT,
};
 
struct cne_memif_region {
    void *addr;                          
    cne_memif_region_size_t region_size; 
    int fd;                              
    uint32_t pkt_buffer_offset;
};
 
struct pmd_internals {
    cne_memif_interface_id_t id; 
    enum cne_memif_role_t role;  
    uint32_t flags;              
#define CNE_ETH_MEMIF_FLAG_CONNECTING (1 << 0)
#define CNE_ETH_MEMIF_FLAG_CONNECTED (1 << 1)
#define CNE_ETH_MEMIF_FLAG_ZERO_COPY (1 << 2)
#define CNE_ETH_MEMIF_FLAG_DISABLED (1 << 3)
#define CNE_ETH_MEMIF_FLAG_SOCKET_ABSTRACT (1 << 4)
    char *socket_filename;                  
    struct cne_memif_socket *socket;        
    char secret[CNE_ETH_MEMIF_SECRET_SIZE]; 
    pktmbuf_info_t *pi;                     
    struct cne_memif_control_channel *cc;   
    cne_spinlock_t cc_lock;                 
    /* remote info */
    char remote_name[PKTDEV_NAME_MAX_LEN];    
    char remote_if_name[PKTDEV_NAME_MAX_LEN]; 
    char pmd_name[PKTDEV_NAME_MAX_LEN];
 
    struct {
        cne_memif_log2_ring_size_t log2_ring_size; 
        uint8_t num_c2s_rings;                     
        uint8_t num_s2c_rings;                     
        uint16_t pkt_buffer_size;                  
    } cfg;                                         
    struct {
        cne_memif_log2_ring_size_t log2_ring_size; 
        uint8_t num_c2s_rings;                     
        uint8_t num_s2c_rings;                     
        uint16_t pkt_buffer_size;                  
    } run;
    char local_disc_string[CNE_ETH_MEMIF_DISC_STRING_SIZE];
    char remote_disc_string[CNE_ETH_MEMIF_DISC_STRING_SIZE];
};
 
struct cne_memif_queue {
    pktmbuf_info_t *pi;        
    struct pmd_internals *pmd; 
    cne_memif_ring_type_t type;      
    cne_memif_region_index_t region; 
    uint16_t in_port; 
    cne_memif_region_offset_t ring_offset;
    uint16_t last_head; 
    uint16_t last_tail; 
    struct cne_mbuf **buffers;
    /* rx/tx info */
    uint64_t n_pkts;  
    uint64_t n_bytes; 
    struct cne_ev_handle ev_handle; 
    cne_memif_log2_ring_size_t log2_ring_size; 
};
 
struct pmd_process_private {
    struct cne_memif_region *regions[CNE_ETH_MEMIF_MAX_REGION_NUM];
    cne_memif_region_index_t regions_num; 
};
 
void cne_memif_free_regions(struct cne_pktdev *dev);
 
int cne_memif_connect(struct cne_pktdev *dev);
 
int cne_memif_connect_start(struct cne_pktdev *dev);
 
int cne_memif_init_regions_and_queues(struct cne_pktdev *dev);
 
const char *cne_memif_version(void);
 
#ifndef MFD_HUGETLB
#ifndef __NR_memfd_create
 
#if defined __x86_64__
#define __NR_memfd_create 319
#else
#error "__NR_memfd_create unknown for this architecture"
#endif
 
#endif /* __NR_memfd_create */
 
static inline int
memfd_create(const char *name, unsigned int flags)
{
    return syscall(__NR_memfd_create, name, flags);
}
#endif /* MFD_HUGETLB */
 
#ifndef F_LINUX_SPECIFIC_BASE
#define F_LINUX_SPECIFIC_BASE 1024
#endif
 
#ifndef MFD_ALLOW_SEALING
#define MFD_ALLOW_SEALING 0x0002U
#endif
 
#ifndef F_ADD_SEALS
#define F_ADD_SEALS (F_LINUX_SPECIFIC_BASE + 9)
#define F_GET_SEALS (F_LINUX_SPECIFIC_BASE + 10)
 
#define F_SEAL_SEAL   0x0001 /* prevent further seals from being set */
#define F_SEAL_SHRINK 0x0002 /* prevent file from shrinking */
#define F_SEAL_GROW   0x0004 /* prevent file from growing */
#define F_SEAL_WRITE  0x0008 /* prevent writes */
#endif
 
#endif /* CNE_ETH_MEMIF_H */