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 *shm;
  71   uint32_t region_size;
  72   uint32_t buffer_offset;
  73   int fd;
  74 } memif_region_t;
  75
  76 typedef struct
  77 {
  78   memif_ring_t *ring;
  79   uint8_t log2_ring_size;
  80   uint8_t region;
  81   uint32_t offset;
  82
  83   uint16_t last_head;
  84   uint16_t last_tail;
  85
  86   int int_fd;
  87
  88   uint64_t int_count;
  89   uint32_t alloc_bufs;
  90 } memif_queue_t;
  91
  92 typedef struct memif_msg_queue_elt
  93 {
  94   memif_msg_t msg;
  95   int fd;
  96   struct memif_msg_queue_elt *next;
  97 } memif_msg_queue_elt_t;
  98
  99 struct memif_connection;
 100
 101 typedef struct memif_connection memif_connection_t;
 102
 103 /* functions called by memif_control_fd_handler */
 104 typedef int (memif_fn) (memif_connection_t * conn);
 105
 106 typedef struct
 107 {
 108   uint8_t num_s2m_rings;
 109   uint8_t num_m2s_rings;
 110   uint16_t buffer_size;
 111   memif_log2_ring_size_t log2_ring_size;
 112 } memif_conn_run_args_t;
 113
 114 typedef struct memif_connection
 115 {
 116   uint16_t index;
 117   memif_conn_args_t args;
 118   memif_conn_run_args_t run_args;
 119
 120   int fd;
 121   int listener_fd;
 122
 123   memif_fn *write_fn, *read_fn, *error_fn;
 124
 125   memif_connection_update_t *on_connect, *on_disconnect;
 126   memif_interrupt_t *on_interrupt;
 127   void *private_ctx;
 128
 129   /* connection message queue */
 130   memif_msg_queue_elt_t *msg_queue;
 131
 132   uint8_t remote_if_name[MEMIF_NAME_LEN];
 133   uint8_t remote_name[MEMIF_NAME_LEN];
 134   uint8_t remote_disconnect_string[96];
 135
 136   memif_region_t *regions;
 137
 138   memif_queue_t *rx_queues;
 139   memif_queue_t *tx_queues;
 140
 141   uint16_t flags;
 142 #define MEMIF_CONNECTION_FLAG_WRITE (1 << 0)
 143 } memif_connection_t;
 144
 145 typedef struct
 146 {
 147   int key;
 148   void *data_struct;
 149 } memif_list_elt_t;
 150
 151 typedef struct
 152 {
 153   int fd;
 154   uint16_t use_count;
 155   uint8_t *filename;
 156   uint16_t interface_list_len;
 157   memif_list_elt_t *interface_list;     /* memif master interfaces listening on this socket */
 158 } memif_socket_t;
 159
 160 typedef struct
 161 {
 162   memif_control_fd_update_t *control_fd_update;
 163   int timerfd;
 164   struct itimerspec arm, disarm;
 165   uint16_t disconn_slaves;
 166   uint8_t app_name[MEMIF_NAME_LEN];
 167
 168   memif_alloc_t *alloc;
 169   memif_free_t *free;
 170
 171   uint16_t control_list_len;
 172   uint16_t interrupt_list_len;
 173   uint16_t listener_list_len;
 174   uint16_t pending_list_len;
 175   memif_list_elt_t *control_list;
 176   memif_list_elt_t *interrupt_list;
 177   memif_list_elt_t *listener_list;
 178   memif_list_elt_t *pending_list;
 179 } libmemif_main_t;
 180
 181 extern libmemif_main_t libmemif_main;
 182 extern int memif_epfd;
 183
 184 /* main.c */
 185
 186 /* if region doesn't contain shared memory, mmap region, check ring cookie */
 187 int memif_connect1 (memif_connection_t * c);
 188
 189 /* memory map region, initalize rings and queues */
 190 int memif_init_regions_and_queues (memif_connection_t * c);
 191
 192 int memif_disconnect_internal (memif_connection_t * c);
 193
 194 /* map errno to memif error code */
 195 int memif_syscall_error_handler (int err_code);
 196
 197 int add_list_elt (memif_list_elt_t * e, memif_list_elt_t ** list,
 198                   uint16_t * len);
 199
 200 int get_list_elt (memif_list_elt_t ** e, memif_list_elt_t * list,
 201                   uint16_t len, int key);
 202
 203 int free_list_elt (memif_list_elt_t * list, uint16_t len, int key);
 204
 205 #ifndef __NR_memfd_create
 206 #if defined __x86_64__
 207 #define __NR_memfd_create 319
 208 #elif defined __arm__
 209 #define __NR_memfd_create 385
 210 #elif defined __aarch64__
 211 #define __NR_memfd_create 279
 212 #else
 213 #error "__NR_memfd_create unknown for this architecture"
 214 #endif
 215 #endif
 216
 217 #ifndef HAVE_MEMFD_CREATE
 218 static inline int
 219 memfd_create (const char *name, unsigned int flags)
 220 {
 221   return syscall (__NR_memfd_create, name, flags);
 222 }
 223 #endif
 224
 225 static inline void *
 226 memif_get_buffer (memif_connection_t * conn, memif_ring_t * ring,
 227                   uint16_t index)
 228 {
 229   return (conn->regions[ring->desc[index].region].shm +
 230           ring->desc[index].offset);
 231 }
 232
 233 #ifndef F_LINUX_SPECIFIC_BASE
 234 #define F_LINUX_SPECIFIC_BASE 1024
 235 #endif
 236
 237 #ifndef MFD_ALLOW_SEALING
 238 #define MFD_ALLOW_SEALING       0x0002U
 239 #endif
 240
 241 #ifndef F_ADD_SEALS
 242 #define F_ADD_SEALS (F_LINUX_SPECIFIC_BASE + 9)
 243 #define F_GET_SEALS (F_LINUX_SPECIFIC_BASE + 10)
 244
 245 #define F_SEAL_SEAL     0x0001  /* prevent further seals from being set */
 246 #define F_SEAL_SHRINK   0x0002  /* prevent file from shrinking */
 247 #define F_SEAL_GROW     0x0004  /* prevent file from growing */
 248 #define F_SEAL_WRITE    0x0008  /* prevent writes */
 249 #endif
 250
 251 #endif /* _MEMIF_PRIVATE_H_ */