/*
*------------------------------------------------------------------
- * Copyright (c) 2016 Cisco and/or its affiliates.
+ * Copyright (c) 2017 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*------------------------------------------------------------------
*/
-typedef struct
-{
- u16 version;
-#define MEMIF_VERSION_MAJOR 0
-#define MEMIF_VERSION_MINOR 1
-#define MEMIF_VERSION ((MEMIF_VERSION_MAJOR << 8) | MEMIF_VERSION_MINOR)
- u8 type;
-#define MEMIF_MSG_TYPE_CONNECT_REQ 0
-#define MEMIF_MSG_TYPE_CONNECT_RESP 1
-#define MEMIF_MSG_TYPE_DISCONNECT 2
+#ifndef _MEMIF_H_
+#define _MEMIF_H_
- /* Connection-request parameters: */
- u64 key;
- u8 log2_ring_size;
-#define MEMIF_DEFAULT_RING_SIZE 1024
- u16 num_s2m_rings;
- u16 num_m2s_rings;
- u16 buffer_size;
-#define MEMIF_DEFAULT_BUFFER_SIZE 2048
- u32 shared_mem_size;
+#ifndef MEMIF_CACHELINE_SIZE
+#define MEMIF_CACHELINE_SIZE 64
+#endif
- /* Connection-response parameters: */
- u8 retval;
-} memif_msg_t;
+#define MEMIF_COOKIE 0x3E31F20
+#define MEMIF_VERSION_MAJOR 2
+#define MEMIF_VERSION_MINOR 0
+#define MEMIF_VERSION ((MEMIF_VERSION_MAJOR << 8) | MEMIF_VERSION_MINOR)
-typedef struct __attribute__ ((packed))
-{
- u16 flags;
-#define MEMIF_DESC_FLAG_NEXT (1 << 0)
- u16 region;
- u32 buffer_length;
- u32 length;;
- u8 reserved[4];
- u64 offset;
- u64 metadata;
-} memif_desc_t;
+/*
+ * Type definitions
+ */
-STATIC_ASSERT_SIZEOF (memif_desc_t, 32);
+typedef enum memif_msg_type
+{
+ MEMIF_MSG_TYPE_NONE = 0,
+ MEMIF_MSG_TYPE_ACK = 1,
+ MEMIF_MSG_TYPE_HELLO = 2,
+ MEMIF_MSG_TYPE_INIT = 3,
+ MEMIF_MSG_TYPE_ADD_REGION = 4,
+ MEMIF_MSG_TYPE_ADD_RING = 5,
+ MEMIF_MSG_TYPE_CONNECT = 6,
+ MEMIF_MSG_TYPE_CONNECTED = 7,
+ MEMIF_MSG_TYPE_DISCONNECT = 8,
+} memif_msg_type_t;
-typedef struct
+typedef enum
{
- u16 head __attribute__ ((aligned (128)));
- u16 tail __attribute__ ((aligned (128)));
- memif_desc_t desc[0] __attribute__ ((aligned (128)));
-} memif_ring_t;
+ MEMIF_RING_S2M = 0,
+ MEMIF_RING_M2S = 1
+} memif_ring_type_t;
-typedef struct
+typedef enum
{
- u32 cookie __attribute__ ((aligned (128)));
-} memif_shm_t;
+ MEMIF_INTERFACE_MODE_ETHERNET = 0,
+ MEMIF_INTERFACE_MODE_IP = 1,
+ MEMIF_INTERFACE_MODE_PUNT_INJECT = 2,
+} memif_interface_mode_t;
+typedef uint16_t memif_region_index_t;
+typedef uint32_t memif_region_offset_t;
+typedef uint64_t memif_region_size_t;
+typedef uint16_t memif_ring_index_t;
+typedef uint32_t memif_interface_id_t;
+typedef uint16_t memif_version_t;
+typedef uint8_t memif_log2_ring_size_t;
-typedef struct
-{
- u16 last_head;
- u16 last_tail;
-} memif_ring_data_t;
+/*
+ * Socket messages
+ */
-typedef struct
+typedef struct __attribute__ ((packed))
{
- int fd;
- u32 index;
-} memif_file_t;
+ uint8_t name[32];
+ memif_version_t min_version;
+ memif_version_t max_version;
+ memif_region_index_t max_region;
+ memif_ring_index_t max_m2s_ring;
+ memif_ring_index_t max_s2m_ring;
+ memif_log2_ring_size_t max_log2_ring_size;
+} memif_msg_hello_t;
-typedef struct
+typedef struct __attribute__ ((packed))
{
- uword index;
- dev_t sock_dev;
- ino_t sock_ino;
- memif_file_t socket;
- u16 usage_counter;
-} memif_listener_t;
+ memif_version_t version;
+ memif_interface_id_t id;
+ memif_interface_mode_t mode:8;
+ uint8_t secret[24];
+ uint8_t name[32];
+} memif_msg_init_t;
-typedef struct
+typedef struct __attribute__ ((packed))
{
- uword index;
- memif_file_t connection;
- uword listener_index;
-} memif_pending_conn_t;
+ memif_region_index_t index;
+ memif_region_size_t size;
+} memif_msg_add_region_t;
-typedef struct
+typedef struct __attribute__ ((packed))
{
- CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
- volatile u32 *lockp;
- u32 flags;
-#define MEMIF_IF_FLAG_ADMIN_UP (1 << 0)
-#define MEMIF_IF_FLAG_IS_SLAVE (1 << 1)
-#define MEMIF_IF_FLAG_CONNECTING (1 << 2)
-#define MEMIF_IF_FLAG_CONNECTED (1 << 3)
-#define MEMIF_IF_FLAG_DELETING (1 << 4)
-
- u64 key;
- uword if_index;
- u32 hw_if_index;
- u32 sw_if_index;
-
- u32 per_interface_next_index;
-
- uword listener_index;
- memif_file_t connection;
- memif_file_t interrupt_line;
- u8 *socket_filename;
-
- void **regions;
-
- u8 log2_ring_size;
- u8 num_s2m_rings;
- u8 num_m2s_rings;
- u16 buffer_size;
-
- memif_ring_data_t *ring_data;
+ uint16_t flags;
+#define MEMIF_MSG_ADD_RING_FLAG_S2M (1 << 0)
+ memif_ring_index_t index;
+ memif_region_index_t region;
+ memif_region_offset_t offset;
+ memif_log2_ring_size_t log2_ring_size;
+ uint16_t private_hdr_size; /* used for private metadata */
+} memif_msg_add_ring_t;
- /* remote info */
- pid_t remote_pid;
- uid_t remote_uid;
-} memif_if_t;
-
-typedef struct
+typedef struct __attribute__ ((packed))
{
- CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
-
- /** API message ID base */
- u16 msg_id_base;
-
- /* pool of all memory interfaces */
- memif_if_t *interfaces;
-
- /* pool of all listeners */
- memif_listener_t *listeners;
-
- /* pool of pending connections */
- memif_pending_conn_t *pending_conns;
-
- /* bitmap of pending rx interfaces */
- uword *pending_input_bitmap;
-
- /* rx buffer cache */
- u32 **rx_buffers;
-
- /* hash of all registered keys */
- mhash_t if_index_by_key;
+ uint8_t if_name[32];
+} memif_msg_connect_t;
- /* first cpu index */
- u32 input_cpu_first_index;
-
- /* total cpu count */
- u32 input_cpu_count;
-
- /* configuration */
- u8 *default_socket_filename;
-#define MEMIF_DEFAULT_SOCKET_FILENAME "/var/vpp/memif.sock"
-} memif_main_t;
-
-extern memif_main_t memif_main;
-extern vnet_device_class_t memif_device_class;
-extern vlib_node_registration_t memif_input_node;
-
-enum
+typedef struct __attribute__ ((packed))
{
- MEMIF_PROCESS_EVENT_START = 1,
- MEMIF_PROCESS_EVENT_STOP = 2,
-} memif_process_event_t;
+ uint8_t if_name[32];
+} memif_msg_connected_t;
-typedef struct
+typedef struct __attribute__ ((packed))
{
- u64 key;
- u8 *socket_filename;
- u8 is_master;
- u8 log2_ring_size;
- u16 buffer_size;
- u8 hw_addr_set;
- u8 hw_addr[6];
-
- /* return */
- u32 sw_if_index;
-} memif_create_if_args_t;
-
-int memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args);
-int memif_delete_if (vlib_main_t * vm, u64 key);
-clib_error_t *memif_plugin_api_hookup (vlib_main_t * vm);
+ uint32_t code;
+ uint8_t string[96];
+} memif_msg_disconnect_t;
+
+typedef struct __attribute__ ((packed, aligned (128)))
+{
+ memif_msg_type_t type:16;
+ union
+ {
+ memif_msg_hello_t hello;
+ memif_msg_init_t init;
+ memif_msg_add_region_t add_region;
+ memif_msg_add_ring_t add_ring;
+ memif_msg_connect_t connect;
+ memif_msg_connected_t connected;
+ memif_msg_disconnect_t disconnect;
+ };
+} memif_msg_t;
-#ifndef __NR_memfd_create
-#if defined __x86_64__
-#define __NR_memfd_create 319
-#elif defined __arm__
-#define __NR_memfd_create 385
-#elif defined __aarch64__
-#define __NR_memfd_create 279
-#else
-#error "__NR_memfd_create unknown for this architecture"
-#endif
-#endif
+_Static_assert (sizeof (memif_msg_t) == 128,
+ "Size of memif_msg_t must be 128");
-static inline int
-memfd_create (const char *name, unsigned int flags)
-{
- return syscall (__NR_memfd_create, name, flags);
-}
+/*
+ * Ring and Descriptor Layout
+ */
-typedef enum
+typedef struct __attribute__ ((packed))
{
- MEMIF_RING_S2M = 0,
- MEMIF_RING_M2S = 1
-} memif_ring_type_t;
+ uint16_t flags;
+#define MEMIF_DESC_FLAG_NEXT (1 << 0)
+ memif_region_index_t region;
+ uint32_t length;
+ memif_region_offset_t offset;
+ uint32_t metadata;
+} memif_desc_t;
-static_always_inline memif_ring_t *
-memif_get_ring (memif_if_t * mif, memif_ring_type_t type, u16 ring_num)
-{
- if (vec_len (mif->regions) == 0)
- return NULL;
- void *p = mif->regions[0];
- int ring_size =
- sizeof (memif_ring_t) +
- sizeof (memif_desc_t) * (1 << mif->log2_ring_size);
- p += sizeof (memif_shm_t);
- p += (ring_num + type * mif->num_s2m_rings) * ring_size;
+_Static_assert (sizeof (memif_desc_t) == 16,
+ "Size of memif_dsct_t must be 16 bytes");
- return (memif_ring_t *) p;
-}
+#define MEMIF_CACHELINE_ALIGN_MARK(mark) \
+ uint8_t mark[0] __attribute__((aligned(MEMIF_CACHELINE_SIZE)))
-static_always_inline void *
-memif_get_buffer (memif_if_t * mif, memif_ring_t * ring, u16 slot)
+typedef struct
{
- u16 region = ring->desc[slot].region;
- return mif->regions[region] + ring->desc[slot].offset;
-}
-
-#ifndef F_LINUX_SPECIFIC_BASE
-#define F_LINUX_SPECIFIC_BASE 1024
-#endif
-#define MFD_ALLOW_SEALING 0x0002U
-#define F_ADD_SEALS (F_LINUX_SPECIFIC_BASE + 9)
-#define F_GET_SEALS (F_LINUX_SPECIFIC_BASE + 10)
+ MEMIF_CACHELINE_ALIGN_MARK (cacheline0);
+ uint32_t cookie;
+ uint16_t flags;
+#define MEMIF_RING_FLAG_MASK_INT 1
+ volatile uint16_t head;
+ MEMIF_CACHELINE_ALIGN_MARK (cacheline1);
+ volatile uint16_t tail;
+ MEMIF_CACHELINE_ALIGN_MARK (cacheline2);
+ memif_desc_t desc[0];
+} memif_ring_t;
-#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 /* _MEMIF_H_ */
/*
* fd.io coding-style-patch-verification: ON
Code Review / vpp.git / blobdiff