extras/libmemif/src/memif_private.h

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2017 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17
  18
  19 #ifndef _MEMIF_PRIVATE_H_
  20 #define _MEMIF_PRIVATE_H_
  21
  22 #define _GNU_SOURCE
  23 #include <unistd.h>
  24 #include <sys/syscall.h>
  25 #include <stdint.h>
  26 #include <inttypes.h>
  27 #include <limits.h>
  28 #include <sys/timerfd.h>
  29 #include <string.h>
  30
  31 #include <memif.h>
  32 #include <libmemif.h>
  33
  34 #define MEMIF_NAME_LEN 32
  35 _Static_assert (strlen (MEMIF_DEFAULT_APP_NAME) <= MEMIF_NAME_LEN,
  36                 "MEMIF_DEFAULT_APP_NAME max length is 32");
  37
  38 #define MEMIF_DEFAULT_SOCKET_DIR "/run/vpp"
  39 #define MEMIF_DEFAULT_SOCKET_FILENAME  "memif.sock"
  40 #define MEMIF_DEFAULT_RING_SIZE 1024
  41 #define MEMIF_DEFAULT_LOG2_RING_SIZE 10
  42 #define MEMIF_DEFAULT_RX_QUEUES 1
  43 #define MEMIF_DEFAULT_TX_QUEUES 1
  44 #define MEMIF_DEFAULT_BUFFER_SIZE 2048
  45
  46 #define MEMIF_MAX_M2S_RING              255
  47 #define MEMIF_MAX_S2M_RING              255
  48 #define MEMIF_MAX_REGION                255
  49 #define MEMIF_MAX_LOG2_RING_SIZE        14
  50
  51 #define MEMIF_MAX_FDS 512
  52
  53 #define memif_min(a,b) (((a) < (b)) ? (a) : (b))
  54
  55 #define EXPECT_TRUE(x) __builtin_expect((x),1)
  56 #define EXPECT_FALSE(x) __builtin_expect((x),0)
  57
  58 #ifdef MEMIF_DBG
  59 #define DBG(...) do {                                                             \
  60                         printf("MEMIF_DEBUG:%s:%s:%d: ", __FILE__, __func__, __LINE__);  \
  61                         printf(__VA_ARGS__);                                            \
  62                         printf("\n");                                                   \
  63                         } while (0)
  64 #else
  65 #define DBG(...)
  66 #endif /* MEMIF_DBG */
  67
  68 typedef struct
  69 {
  70   void *addr;
  71   uint32_t region_size;
  72   uint32_t buffer_offset;
  73   int fd;
  74   uint8_t is_external;
  75 } memif_region_t;
  76
  77 typedef struct
  78 {
  79   memif_ring_t *ring;
  80   uint8_t log2_ring_size;
  81   uint8_t region;
  82   uint32_t offset;
  83
  84   uint16_t last_head;
  85   uint16_t last_tail;
  86
  87   int int_fd;
  88
  89   uint64_t int_count;
  90   uint32_t alloc_bufs;
  91 } memif_queue_t;
  92
  93 typedef struct memif_msg_queue_elt
  94 {
  95   memif_msg_t msg;
  96   int fd;
  97   struct memif_msg_queue_elt *next;
  98 } memif_msg_queue_elt_t;
  99
 100 struct memif_connection;
 101
 102 typedef struct memif_connection memif_connection_t;
 103
 104 /* functions called by memif_control_fd_handler */
 105 typedef int (memif_fn) (memif_connection_t * conn);
 106
 107 typedef struct
 108 {
 109   uint8_t num_s2m_rings;
 110   uint8_t num_m2s_rings;
 111   uint16_t buffer_size;
 112   memif_log2_ring_size_t log2_ring_size;
 113 } memif_conn_run_args_t;
 114
 115 typedef struct memif_connection
 116 {
 117   uint16_t index;
 118   memif_conn_args_t args;
 119   memif_conn_run_args_t run_args;
 120
 121   int fd;
 122   int listener_fd;
 123
 124   memif_fn *write_fn, *read_fn, *error_fn;
 125
 126   memif_connection_update_t *on_connect, *on_disconnect;
 127   memif_interrupt_t *on_interrupt;
 128   void *private_ctx;
 129
 130   /* connection message queue */
 131   memif_msg_queue_elt_t *msg_queue;
 132
 133   uint8_t remote_if_name[MEMIF_NAME_LEN];
 134   uint8_t remote_name[MEMIF_NAME_LEN];
 135   uint8_t remote_disconnect_string[96];
 136
 137   uint8_t regions_num;
 138   memif_region_t *regions;
 139
 140   uint8_t rx_queues_num;
 141   uint8_t tx_queues_num;
 142   memif_queue_t *rx_queues;
 143   memif_queue_t *tx_queues;
 144
 145   uint16_t flags;
 146 #define MEMIF_CONNECTION_FLAG_WRITE (1 << 0)
 147 } memif_connection_t;
 148
 149 typedef struct
 150 {
 151   int key;
 152   void *data_struct;
 153 } memif_list_elt_t;
 154
 155 typedef struct
 156 {
 157   int fd;
 158   uint16_t use_count;
 159   uint8_t *filename;
 160   uint16_t interface_list_len;
 161   memif_list_elt_t *interface_list;     /* memif master interfaces listening on this socket */
 162 } memif_socket_t;
 163
 164 typedef struct
 165 {
 166   memif_control_fd_update_t *control_fd_update;
 167   int timerfd;
 168   struct itimerspec arm, disarm;
 169   uint16_t disconn_slaves;
 170   uint8_t app_name[MEMIF_NAME_LEN];
 171
 172   memif_add_external_region_t *add_external_region;
 173   memif_get_external_region_addr_t *get_external_region_addr;
 174   memif_del_external_region_t *del_external_region;
 175   memif_get_external_buffer_offset_t *get_external_buffer_offset;
 176
 177   memif_alloc_t *alloc;
 178   memif_realloc_t *realloc;
 179   memif_free_t *free;
 180
 181   uint16_t control_list_len;
 182   uint16_t interrupt_list_len;
 183   uint16_t listener_list_len;
 184   uint16_t pending_list_len;
 185   memif_list_elt_t *control_list;
 186   memif_list_elt_t *interrupt_list;
 187   memif_list_elt_t *listener_list;
 188   memif_list_elt_t *pending_list;
 189 } libmemif_main_t;
 190
 191 extern libmemif_main_t libmemif_main;
 192 extern int memif_epfd;
 193
 194 /* main.c */
 195
 196 /* if region doesn't contain shared memory, mmap region, check ring cookie */
 197 int memif_connect1 (memif_connection_t * c);
 198
 199 /* memory map region, initalize rings and queues */
 200 int memif_init_regions_and_queues (memif_connection_t * c);
 201
 202 int memif_disconnect_internal (memif_connection_t * c);
 203
 204 /* map errno to memif error code */
 205 int memif_syscall_error_handler (int err_code);
 206
 207 int add_list_elt (memif_list_elt_t * e, memif_list_elt_t ** list,
 208                   uint16_t * len);
 209
 210 int get_list_elt (memif_list_elt_t ** e, memif_list_elt_t * list,
 211                   uint16_t len, int key);
 212
 213 int free_list_elt (memif_list_elt_t * list, uint16_t len, int key);
 214
 215 #ifndef __NR_memfd_create
 216 #if defined __x86_64__
 217 #define __NR_memfd_create 319
 218 #elif defined __arm__
 219 #define __NR_memfd_create 385
 220 #elif defined __aarch64__
 221 #define __NR_memfd_create 279
 222 #else
 223 #error "__NR_memfd_create unknown for this architecture"
 224 #endif
 225 #endif
 226
 227 #ifndef HAVE_MEMFD_CREATE
 228 static inline int
 229 memfd_create (const char *name, unsigned int flags)
 230 {
 231   return syscall (__NR_memfd_create, name, flags);
 232 }
 233 #endif
 234
 235 static inline void *
 236 memif_get_buffer (memif_connection_t * conn, memif_ring_t * ring,
 237                   uint16_t index)
 238 {
 239   return (conn->regions[ring->desc[index].region].addr +
 240           ring->desc[index].offset);
 241 }
 242
 243 #ifndef F_LINUX_SPECIFIC_BASE
 244 #define F_LINUX_SPECIFIC_BASE 1024
 245 #endif
 246
 247 #ifndef MFD_ALLOW_SEALING
 248 #define MFD_ALLOW_SEALING       0x0002U
 249 #endif
 250
 251 #ifndef F_ADD_SEALS
 252 #define F_ADD_SEALS (F_LINUX_SPECIFIC_BASE + 9)
 253 #define F_GET_SEALS (F_LINUX_SPECIFIC_BASE + 10)
 254
 255 #define F_SEAL_SEAL     0x0001  /* prevent further seals from being set */
 256 #define F_SEAL_SHRINK   0x0002  /* prevent file from shrinking */
 257 #define F_SEAL_GROW     0x0004  /* prevent file from growing */
 258 #define F_SEAL_WRITE    0x0008  /* prevent writes */
 259 #endif
 260
 261 #endif /* _MEMIF_PRIVATE_H_ */