src/svm/ssvm.h

   1 /*
   2  * Copyright (c) 2015-2019 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 #ifndef __included_ssvm_h__
  16 #define __included_ssvm_h__
  17
  18 #include <stdio.h>
  19 #include <stdlib.h>
  20 #include <sys/types.h>
  21 #include <sys/mman.h>
  22 #include <sys/stat.h>
  23 #include <netinet/in.h>
  24 #include <signal.h>
  25 #include <pthread.h>
  26 #include <unistd.h>
  27 #include <time.h>
  28 #include <fcntl.h>
  29 #include <string.h>
  30 #include <vppinfra/clib.h>
  31 #include <vppinfra/vec.h>
  32 #include <vppinfra/hash.h>
  33 #include <vppinfra/bitmap.h>
  34 #include <vppinfra/fifo.h>
  35 #include <vppinfra/time.h>
  36 #include <vppinfra/mheap.h>
  37 #include <vppinfra/heap.h>
  38 #include <vppinfra/pool.h>
  39 #include <vppinfra/format.h>
  40
  41 #ifndef MMAP_PAGESIZE
  42 #define MMAP_PAGESIZE (clib_mem_get_page_size())
  43 #endif
  44
  45 #define SSVM_N_OPAQUE 7
  46
  47 typedef enum ssvm_segment_type_
  48 {
  49   SSVM_SEGMENT_SHM = 0,
  50   SSVM_SEGMENT_MEMFD,
  51   SSVM_SEGMENT_PRIVATE,
  52   SSVM_N_SEGMENT_TYPES          /**< Private segments */
  53 } ssvm_segment_type_t;
  54
  55 typedef struct
  56 {
  57   /* Spin-lock */
  58   volatile u32 lock;
  59   volatile u32 owner_pid;
  60   int recursion_count;
  61   u32 tag;                      /* for debugging */
  62
  63   /* The allocation arena */
  64   void *heap;
  65
  66   /* Segment must be mapped at this address, or no supper */
  67   uword ssvm_va;
  68   /* The actual mmap size */
  69   uword ssvm_size;
  70   u32 master_pid;
  71   u32 slave_pid;
  72   u8 *name;
  73   void *opaque[SSVM_N_OPAQUE];
  74
  75   /* Set when the master application thinks it's time to make the donuts */
  76   volatile u32 ready;
  77
  78   ssvm_segment_type_t type;
  79 } ssvm_shared_header_t;
  80
  81 typedef struct
  82 {
  83   ssvm_shared_header_t *sh;
  84   u64 ssvm_size;
  85   u32 my_pid;
  86   u8 *name;
  87   uword requested_va;
  88   int i_am_master;
  89
  90   union
  91   {
  92     int fd;                     /**< memfd segments */
  93     int attach_timeout;         /**< shm segments attach timeout (sec) */
  94   };
  95 } ssvm_private_t;
  96
  97 always_inline void
  98 ssvm_lock (ssvm_shared_header_t * h, u32 my_pid, u32 tag)
  99 {
 100   if (h->owner_pid == my_pid)
 101     {
 102       h->recursion_count++;
 103       return;
 104     }
 105
 106   while (clib_atomic_test_and_set (&h->lock))
 107     ;
 108
 109   h->owner_pid = my_pid;
 110   h->recursion_count = 1;
 111   h->tag = tag;
 112 }
 113
 114 always_inline void
 115 ssvm_lock_non_recursive (ssvm_shared_header_t * h, u32 tag)
 116 {
 117   while (clib_atomic_test_and_set (&h->lock))
 118     ;
 119
 120   h->tag = tag;
 121 }
 122
 123 always_inline void
 124 ssvm_unlock (ssvm_shared_header_t * h)
 125 {
 126   if (--h->recursion_count == 0)
 127     {
 128       h->owner_pid = 0;
 129       h->tag = 0;
 130       CLIB_MEMORY_BARRIER ();
 131       h->lock = 0;
 132     }
 133 }
 134
 135 always_inline void
 136 ssvm_unlock_non_recursive (ssvm_shared_header_t * h)
 137 {
 138   h->tag = 0;
 139   CLIB_MEMORY_BARRIER ();
 140   h->lock = 0;
 141 }
 142
 143 static inline void *
 144 ssvm_push_heap (ssvm_shared_header_t * sh)
 145 {
 146   u8 *oldheap;
 147   oldheap = clib_mem_set_heap (sh->heap);
 148   return ((void *) oldheap);
 149 }
 150
 151 static inline void
 152 ssvm_pop_heap (void *oldheap)
 153 {
 154   clib_mem_set_heap (oldheap);
 155 }
 156
 157 static inline void *
 158 ssvm_mem_alloc (ssvm_private_t * ssvm, uword size)
 159 {
 160   u8 *oldheap;
 161   void *rv;
 162
 163   oldheap = clib_mem_set_heap (ssvm->sh->heap);
 164   rv = clib_mem_alloc (size);
 165   clib_mem_set_heap (oldheap);
 166   return (rv);
 167 }
 168
 169 #define foreach_ssvm_api_error                  \
 170 _(NO_NAME, "No shared segment name", -100)      \
 171 _(NO_SIZE, "Size not set (master)", -101)       \
 172 _(CREATE_FAILURE, "Create failed", -102)        \
 173 _(SET_SIZE, "Set size failed", -103)            \
 174 _(MMAP, "mmap failed", -104)                    \
 175 _(SLAVE_TIMEOUT, "Slave map timeout", -105)
 176
 177 typedef enum
 178 {
 179 #define _(n,s,c) SSVM_API_ERROR_##n = c,
 180   foreach_ssvm_api_error
 181 #undef _
 182 } ssvm_api_error_enum_t;
 183
 184 #define SSVM_API_ERROR_NO_NAME  (-10)
 185
 186 int ssvm_master_init (ssvm_private_t * ssvm, ssvm_segment_type_t type);
 187 int ssvm_slave_init (ssvm_private_t * ssvm, ssvm_segment_type_t type);
 188 void ssvm_delete (ssvm_private_t * ssvm);
 189
 190 int ssvm_master_init_shm (ssvm_private_t * ssvm);
 191 int ssvm_slave_init_shm (ssvm_private_t * ssvm);
 192 void ssvm_delete_shm (ssvm_private_t * ssvm);
 193
 194 int ssvm_master_init_memfd (ssvm_private_t * memfd);
 195 int ssvm_slave_init_memfd (ssvm_private_t * memfd);
 196 void ssvm_delete_memfd (ssvm_private_t * memfd);
 197
 198 int ssvm_master_init_private (ssvm_private_t * ssvm);
 199 int ssvm_slave_init_private (ssvm_private_t * ssvm);
 200 void ssvm_delete_private (ssvm_private_t * ssvm);
 201
 202 ssvm_segment_type_t ssvm_type (const ssvm_private_t * ssvm);
 203 u8 *ssvm_name (const ssvm_private_t * ssvm);
 204
 205 #endif /* __included_ssvm_h__ */
 206
 207 /*
 208  * fd.io coding-style-patch-verification: ON
 209  *
 210  * Local Variables:
 211  * eval: (c-set-style "gnu")
 212  * End:
 213  */