memif.h

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright 2018-2021 Cisco Systems, Inc.  All rights reserved.
 */
 
#ifndef _MEMIF_H_
#define _MEMIF_H_
 
#define CNE_MEMIF_COOKIE        0x3E31F20
#define CNE_MEMIF_VERSION_MAJOR 2
#define CNE_MEMIF_VERSION_MINOR 0
#define CNE_MEMIF_VERSION       ((CNE_MEMIF_VERSION_MAJOR << 8) | CNE_MEMIF_VERSION_MINOR)
#define CNE_MEMIF_NAME_SZ       32
 
/*
 * C2S: direction client -> server
 * S2C: direction server -> client
 */
 
/*
 *  Type definitions
 */
 
typedef enum cne_memif_msg_type {
    CNE_MEMIF_MSG_TYPE_NONE,
    CNE_MEMIF_MSG_TYPE_ACK,
    CNE_MEMIF_MSG_TYPE_HELLO,
    CNE_MEMIF_MSG_TYPE_INIT,
    CNE_MEMIF_MSG_TYPE_ADD_REGION,
    CNE_MEMIF_MSG_TYPE_ADD_RING,
    CNE_MEMIF_MSG_TYPE_CONNECT,
    CNE_MEMIF_MSG_TYPE_CONNECTED,
    CNE_MEMIF_MSG_TYPE_DISCONNECT,
} cne_memif_msg_type_t;
 
typedef enum {
    CNE_MEMIF_RING_C2S, 
    CNE_MEMIF_RING_S2C, 
} cne_memif_ring_type_t;
 
typedef enum {
    CNE_MEMIF_INTERFACE_MODE_ETHERNET,
    CNE_MEMIF_INTERFACE_MODE_IP,
    CNE_MEMIF_INTERFACE_MODE_PUNT_INJECT,
} cne_memif_interface_mode_t;
 
typedef uint16_t cne_memif_region_index_t;
typedef uint32_t cne_memif_region_offset_t;
typedef uint64_t cne_memif_region_size_t;
typedef uint16_t cne_memif_ring_index_t;
typedef uint32_t cne_memif_interface_id_t;
typedef uint16_t cne_memif_version_t;
typedef uint8_t cne_memif_log2_ring_size_t;
 
/*
 *  Socket messages
 */
 
typedef struct __cne_packed {
    uint8_t name[CNE_MEMIF_NAME_SZ];               
    cne_memif_version_t min_version;               
    cne_memif_version_t max_version;               
    cne_memif_region_index_t max_region;           
    cne_memif_ring_index_t max_s2c_ring;           
    cne_memif_ring_index_t max_c2s_ring;           
    cne_memif_log2_ring_size_t max_log2_ring_size; 
} cne_memif_msg_hello_t;
 
typedef struct __cne_packed {
    cne_memif_version_t version;         
    cne_memif_interface_id_t id;         
    cne_memif_interface_mode_t mode : 8; 
    uint8_t secret[24];                  
    uint8_t name[CNE_MEMIF_NAME_SZ];     
} cne_memif_msg_init_t;
 
typedef struct __cne_packed {
    cne_memif_region_index_t index; 
    cne_memif_region_size_t size;   
} cne_memif_msg_add_region_t;
 
typedef struct __cne_packed {
    uint16_t flags;                            
#define CNE_MEMIF_MSG_ADD_RING_FLAG_C2S 1      
    cne_memif_ring_index_t index;              
    cne_memif_region_index_t region;           
    cne_memif_region_offset_t offset;          
    cne_memif_log2_ring_size_t log2_ring_size; 
    uint16_t private_hdr_size;                 
} cne_memif_msg_add_ring_t;
 
typedef struct __cne_packed {
    uint8_t if_name[CNE_MEMIF_NAME_SZ]; 
} cne_memif_msg_connect_t;
 
typedef struct __cne_packed {
    uint8_t if_name[CNE_MEMIF_NAME_SZ]; 
} cne_memif_msg_connected_t;
 
typedef struct __cne_packed {
    uint32_t code;      
    uint8_t string[96]; 
} cne_memif_msg_disconnect_t;
 
typedef struct __cne_packed __cne_aligned(128)
{
    cne_memif_msg_type_t type : 16;
    union {
        cne_memif_msg_hello_t hello;
        cne_memif_msg_init_t init;
        cne_memif_msg_add_region_t add_region;
        cne_memif_msg_add_ring_t add_ring;
        cne_memif_msg_connect_t connect;
        cne_memif_msg_connected_t connected;
        cne_memif_msg_disconnect_t disconnect;
    };
}
cne_memif_msg_t;
 
/*
 *  Ring and Descriptor Layout
 */
 
typedef struct __cne_packed {
    uint16_t flags;                   
#define CNE_MEMIF_DESC_FLAG_NEXT 1    
    cne_memif_region_index_t region;  
    uint32_t length;                  
    cne_memif_region_offset_t offset; 
    uint32_t metadata;
} cne_memif_desc_t;
 
#define CNE_MEMIF_CACHELINE_ALIGN_MARK(mark) CNE_MARKER mark __cne_cache_aligned;
 
typedef struct {
    CNE_MEMIF_CACHELINE_ALIGN_MARK(cacheline0);
    uint32_t cookie;                   
    uint16_t flags;                    
#define CNE_MEMIF_RING_FLAG_MASK_INT 1 
    uint16_t head;                     
    CNE_MEMIF_CACHELINE_ALIGN_MARK(cacheline1);
    uint16_t tail; 
    CNE_MEMIF_CACHELINE_ALIGN_MARK(cacheline2);
    cne_memif_desc_t desc[0]; 
} cne_memif_ring_t;
 
#endif /* _MEMIF_H_ */