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_PATH "/run/vpp/memif.sock"
  39 #define MEMIF_DEFAULT_RING_SIZE 1024
  40 #define MEMIF_DEFAULT_LOG2_RING_SIZE 10
  41 #define MEMIF_DEFAULT_RX_QUEUES 1
  42 #define MEMIF_DEFAULT_TX_QUEUES 1
  43 #define MEMIF_DEFAULT_BUFFER_SIZE 2048
  44 #define MEMIF_DEFAULT_RECONNECT_PERIOD_SEC 2
  45 #define MEMIF_DEFAULT_RECONNECT_PERIOD_NSEC 0
  46
  47 #define MEMIF_MAX_M2S_RING              255
  48 #define MEMIF_MAX_S2M_RING              255
  49 #define MEMIF_MAX_REGION                255
  50 #define MEMIF_MAX_LOG2_RING_SIZE        14
  51
  52 #define MEMIF_MAX_FDS 512
  53
  54 #define memif_min(a,b) (((a) < (b)) ? (a) : (b))
  55
  56 #define EXPECT_TRUE(x) __builtin_expect((x),1)
  57 #define EXPECT_FALSE(x) __builtin_expect((x),0)
  58
  59 #ifdef MEMIF_DBG
  60 #define DBG(...) do {                                                             \
  61                         printf("MEMIF_DEBUG:%s:%s:%d: ", __FILE__, __func__, __LINE__);  \
  62                         printf(__VA_ARGS__);                                            \
  63                         printf("\n");                                                   \
  64                         } while (0)
  65 #else
  66 #define DBG(...)
  67 #endif /* MEMIF_DBG */
  68
  69 typedef enum
  70 {
  71   MEMIF_SOCKET_TYPE_NONE = 0,   /* unassigned, not used by any interface */
  72   MEMIF_SOCKET_TYPE_LISTENER,   /* listener socket, master interface assigned */
  73   MEMIF_SOCKET_TYPE_CLIENT      /* client socket, slave interface assigned */
  74 } memif_socket_type_t;
  75
  76 typedef struct
  77 {
  78   void *addr;
  79   uint32_t region_size;
  80   uint32_t buffer_offset;
  81   int fd;
  82   uint8_t is_external;
  83 } memif_region_t;
  84
  85 typedef struct
  86 {
  87   memif_ring_t *ring;
  88   uint8_t log2_ring_size;
  89   uint8_t region;
  90   uint32_t offset;
  91
  92   uint16_t last_head;
  93   uint16_t last_tail;
  94
  95   int int_fd;
  96
  97   uint64_t int_count;
  98   uint32_t next_buf; /* points to next free buffer */
  99 } memif_queue_t;
 100
 101 typedef struct memif_msg_queue_elt
 102 {
 103   memif_msg_t msg;
 104   int fd;
 105   struct memif_msg_queue_elt *next;
 106 } memif_msg_queue_elt_t;
 107
 108 struct memif_connection;
 109
 110 typedef struct memif_connection memif_connection_t;
 111
 112 /* functions called by memif_control_fd_handler */
 113 typedef int (memif_fn) (memif_connection_t * conn);
 114
 115 typedef struct
 116 {
 117   uint8_t num_s2m_rings;
 118   uint8_t num_m2s_rings;
 119   uint16_t buffer_size;
 120   memif_log2_ring_size_t log2_ring_size;
 121 } memif_conn_run_args_t;
 122
 123 struct libmemif_main;
 124
 125 typedef struct memif_connection
 126 {
 127   uint16_t index;
 128   memif_conn_args_t args;
 129   memif_conn_run_args_t run_args;
 130
 131   int fd;
 132
 133   memif_fn *write_fn, *read_fn, *error_fn;
 134
 135   memif_connection_update_t *on_connect, *on_disconnect;
 136   memif_interrupt_t *on_interrupt;
 137   void *private_ctx;
 138
 139   /* connection message queue */
 140   memif_msg_queue_elt_t *msg_queue;
 141
 142   uint8_t remote_if_name[MEMIF_NAME_LEN];
 143   uint8_t remote_name[MEMIF_NAME_LEN];
 144   uint8_t remote_disconnect_string[96];
 145
 146   uint8_t regions_num;
 147   memif_region_t *regions;
 148
 149   uint8_t rx_queues_num;
 150   uint8_t tx_queues_num;
 151   memif_queue_t *rx_queues;
 152   memif_queue_t *tx_queues;
 153
 154   uint16_t flags;
 155 #define MEMIF_CONNECTION_FLAG_WRITE (1 << 0)
 156 } memif_connection_t;
 157
 158 typedef struct
 159 {
 160   int key;
 161   void *data_struct;
 162 } memif_list_elt_t;
 163
 164 typedef struct
 165 {
 166   int fd;
 167   uint16_t use_count;
 168   memif_socket_type_t type;
 169   uint8_t *filename;
 170   /* unique database */
 171   struct libmemif_main *lm;
 172   uint16_t interface_list_len;
 173   void *private_ctx;
 174   memif_list_elt_t *interface_list;     /* memif master interfaces listening on this socket */
 175 } memif_socket_t;
 176
 177 typedef struct libmemif_main
 178 {
 179   memif_control_fd_update_t *control_fd_update;
 180   int timerfd;
 181   int epfd;
 182   int poll_cancel_fd;
 183   struct itimerspec arm, disarm;
 184   uint16_t disconn_slaves;
 185   uint8_t app_name[MEMIF_NAME_LEN];
 186
 187   void *private_ctx;
 188
 189   memif_socket_handle_t default_socket;
 190
 191   memif_add_external_region_t *add_external_region;
 192   memif_get_external_region_addr_t *get_external_region_addr;
 193   memif_del_external_region_t *del_external_region;
 194   memif_get_external_buffer_offset_t *get_external_buffer_offset;
 195
 196   memif_alloc_t *alloc;
 197   memif_realloc_t *realloc;
 198   memif_free_t *free;
 199
 200   uint16_t control_list_len;
 201   uint16_t interrupt_list_len;
 202   uint16_t socket_list_len;
 203   uint16_t pending_list_len;
 204   memif_list_elt_t *control_list;
 205   memif_list_elt_t *interrupt_list;
 206   memif_list_elt_t *socket_list;
 207   memif_list_elt_t *pending_list;
 208 } libmemif_main_t;
 209
 210 extern libmemif_main_t libmemif_main;
 211
 212 /* main.c */
 213
 214 /* if region doesn't contain shared memory, mmap region, check ring cookie */
 215 int memif_connect1 (memif_connection_t * c);
 216
 217 /* memory map region, initialize rings and queues */
 218 int memif_init_regions_and_queues (memif_connection_t * c);
 219
 220 int memif_disconnect_internal (memif_connection_t * c);
 221
 222 /* map errno to memif error code */
 223 int memif_syscall_error_handler (int err_code);
 224
 225 int add_list_elt (libmemif_main_t *lm, memif_list_elt_t * e, memif_list_elt_t ** list,
 226                   uint16_t * len);
 227
 228 int get_list_elt (memif_list_elt_t ** e, memif_list_elt_t * list,
 229                   uint16_t len, int key);
 230
 231 int free_list_elt (memif_list_elt_t * list, uint16_t len, int key);
 232
 233 libmemif_main_t *get_libmemif_main (memif_socket_t * ms);
 234
 235 #ifndef __NR_memfd_create
 236 #if defined __x86_64__
 237 #define __NR_memfd_create 319
 238 #elif defined __arm__
 239 #define __NR_memfd_create 385
 240 #elif defined __aarch64__
 241 #define __NR_memfd_create 279
 242 #else
 243 #error "__NR_memfd_create unknown for this architecture"
 244 #endif
 245 #endif
 246
 247 #ifndef HAVE_MEMFD_CREATE
 248 static inline int
 249 memfd_create (const char *name, unsigned int flags)
 250 {
 251   return syscall (__NR_memfd_create, name, flags);
 252 }
 253 #endif
 254
 255 static inline void *
 256 memif_get_buffer (memif_connection_t * conn, memif_ring_t * ring,
 257                   uint16_t index)
 258 {
 259   return (conn->regions[ring->desc[index].region].addr +
 260           ring->desc[index].offset);
 261 }
 262
 263 #ifndef F_LINUX_SPECIFIC_BASE
 264 #define F_LINUX_SPECIFIC_BASE 1024
 265 #endif
 266
 267 #ifndef MFD_ALLOW_SEALING
 268 #define MFD_ALLOW_SEALING       0x0002U
 269 #endif
 270
 271 #ifndef F_ADD_SEALS
 272 #define F_ADD_SEALS (F_LINUX_SPECIFIC_BASE + 9)
 273 #define F_GET_SEALS (F_LINUX_SPECIFIC_BASE + 10)
 274
 275 #define F_SEAL_SEAL     0x0001  /* prevent further seals from being set */
 276 #define F_SEAL_SHRINK   0x0002  /* prevent file from shrinking */
 277 #define F_SEAL_GROW     0x0004  /* prevent file from growing */
 278 #define F_SEAL_WRITE    0x0008  /* prevent writes */
 279 #endif
 280
 281 #endif /* _MEMIF_PRIVATE_H_ */