src/svm/ssvm.h

   1 /*
   2  * Copyright (c) 2015 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 #include <vppinfra/linux/syscall.h>
  41
  42 #ifndef MMAP_PAGESIZE
  43 #define MMAP_PAGESIZE (clib_mem_get_page_size())
  44 #endif
  45
  46 #define SSVM_N_OPAQUE 7
  47
  48 typedef struct
  49 {
  50   /* Spin-lock */
  51   volatile u32 lock;
  52   volatile u32 owner_pid;
  53   int recursion_count;
  54   u32 tag;                      /* for debugging */
  55
  56   /* The allocation arena */
  57   void *heap;
  58
  59   /* Segment must be mapped at this address, or no supper */
  60   u64 ssvm_va;
  61   /* The actual mmap size */
  62   u64 ssvm_size;
  63   u32 master_pid;
  64   u32 slave_pid;
  65   u8 *name;
  66   void *opaque[SSVM_N_OPAQUE];
  67
  68   /* Set when the master application thinks it's time to make the donuts */
  69   volatile u32 ready;
  70
  71   /* Needed to make unique MAC addresses, etc. */
  72   u32 master_index;
  73 } ssvm_shared_header_t;
  74
  75 typedef struct
  76 {
  77   ssvm_shared_header_t *sh;
  78   u64 ssvm_size;
  79   u32 my_pid;
  80   u8 *name;
  81   uword requested_va;
  82   int i_am_master;
  83
  84   /* Needed by memfd segments */
  85   int fd;
  86 } ssvm_private_t;
  87
  88 always_inline void
  89 ssvm_lock (ssvm_shared_header_t * h, u32 my_pid, u32 tag)
  90 {
  91   if (h->owner_pid == my_pid)
  92     {
  93       h->recursion_count++;
  94       return;
  95     }
  96
  97   while (__sync_lock_test_and_set (&h->lock, 1))
  98     ;
  99
 100   h->owner_pid = my_pid;
 101   h->recursion_count = 1;
 102   h->tag = tag;
 103 }
 104
 105 always_inline void
 106 ssvm_lock_non_recursive (ssvm_shared_header_t * h, u32 tag)
 107 {
 108   while (__sync_lock_test_and_set (&h->lock, 1))
 109     ;
 110
 111   h->tag = tag;
 112 }
 113
 114 always_inline void
 115 ssvm_unlock (ssvm_shared_header_t * h)
 116 {
 117   if (--h->recursion_count == 0)
 118     {
 119       h->owner_pid = 0;
 120       h->tag = 0;
 121       CLIB_MEMORY_BARRIER ();
 122       h->lock = 0;
 123     }
 124 }
 125
 126 always_inline void
 127 ssvm_unlock_non_recursive (ssvm_shared_header_t * h)
 128 {
 129   h->tag = 0;
 130   CLIB_MEMORY_BARRIER ();
 131   h->lock = 0;
 132 }
 133
 134 static inline void *
 135 ssvm_push_heap (ssvm_shared_header_t * sh)
 136 {
 137   u8 *oldheap;
 138   oldheap = clib_mem_set_heap (sh->heap);
 139   return ((void *) oldheap);
 140 }
 141
 142 static inline void
 143 ssvm_pop_heap (void *oldheap)
 144 {
 145   clib_mem_set_heap (oldheap);
 146 }
 147
 148 #define foreach_ssvm_api_error                  \
 149 _(NO_NAME, "No shared segment name", -100)      \
 150 _(NO_SIZE, "Size not set (master)", -101)       \
 151 _(CREATE_FAILURE, "Create failed", -102)        \
 152 _(SET_SIZE, "Set size failed", -103)            \
 153 _(MMAP, "mmap failed", -104)                    \
 154 _(SLAVE_TIMEOUT, "Slave map timeout", -105)
 155
 156 typedef enum
 157 {
 158 #define _(n,s,c) SSVM_API_ERROR_##n = c,
 159   foreach_ssvm_api_error
 160 #undef _
 161 } ssvm_api_error_enum_t;
 162
 163 #define SSVM_API_ERROR_NO_NAME  (-10)
 164
 165 int ssvm_master_init (ssvm_private_t * ssvm, u32 master_index);
 166 int ssvm_slave_init (ssvm_private_t * ssvm, int timeout_in_seconds);
 167 void ssvm_delete (ssvm_private_t * ssvm);
 168
 169 int ssvm_master_init_memfd (ssvm_private_t * memfd, u32 master_index);
 170 int ssvm_slave_init_memfd (ssvm_private_t * memfd);
 171 void ssvm_delete_memfd (ssvm_private_t * memfd);
 172
 173 #endif /* __included_ssvm_h__ */
 174
 175 /*
 176  * fd.io coding-style-patch-verification: ON
 177  *
 178  * Local Variables:
 179  * eval: (c-set-style "gnu")
 180  * End:
 181  */