src/svm/ssvm.c

   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 #include <svm/ssvm.h>
  16 #include <svm/svm_common.h>
  17
  18 int
  19 ssvm_master_init (ssvm_private_t * ssvm, u32 master_index)
  20 {
  21   svm_main_region_t *smr = svm_get_root_rp ()->data_base;
  22   int ssvm_fd;
  23   u8 *ssvm_filename;
  24   u8 junk = 0;
  25   int flags;
  26   ssvm_shared_header_t *sh;
  27   u64 ticks = clib_cpu_time_now ();
  28   u64 randomize_baseva;
  29   void *oldheap;
  30
  31   if (ssvm->ssvm_size == 0)
  32     return SSVM_API_ERROR_NO_SIZE;
  33
  34   if (CLIB_DEBUG > 1)
  35     clib_warning ("[%d] creating segment '%s'", getpid (), ssvm->name);
  36
  37   ASSERT (vec_c_string_is_terminated (ssvm->name));
  38   ssvm_filename = format (0, "/dev/shm/%s%c", ssvm->name, 0);
  39
  40   unlink ((char *) ssvm_filename);
  41
  42   vec_free (ssvm_filename);
  43
  44   ssvm_fd = shm_open ((char *) ssvm->name, O_RDWR | O_CREAT | O_EXCL, 0777);
  45
  46   if (ssvm_fd < 0)
  47     {
  48       clib_unix_warning ("create segment '%s'", ssvm->name);
  49       return SSVM_API_ERROR_CREATE_FAILURE;
  50     }
  51
  52   if (fchmod (ssvm_fd, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP) < 0)
  53     clib_unix_warning ("ssvm segment chmod");
  54   if (fchown (ssvm_fd, smr->uid, smr->gid) < 0)
  55     clib_unix_warning ("ssvm segment chown");
  56
  57   if (lseek (ssvm_fd, ssvm->ssvm_size, SEEK_SET) < 0)
  58     {
  59       clib_unix_warning ("lseek");
  60       close (ssvm_fd);
  61       return SSVM_API_ERROR_SET_SIZE;
  62     }
  63
  64   if (write (ssvm_fd, &junk, 1) != 1)
  65     {
  66       clib_unix_warning ("set ssvm size");
  67       close (ssvm_fd);
  68       return SSVM_API_ERROR_SET_SIZE;
  69     }
  70
  71   flags = MAP_SHARED;
  72   if (ssvm->requested_va)
  73     flags |= MAP_FIXED;
  74
  75   randomize_baseva = (ticks & 15) * MMAP_PAGESIZE;
  76
  77   if (ssvm->requested_va)
  78     ssvm->requested_va += randomize_baseva;
  79
  80   sh = ssvm->sh =
  81     (ssvm_shared_header_t *) mmap ((void *) ssvm->requested_va,
  82                                    ssvm->ssvm_size, PROT_READ | PROT_WRITE,
  83                                    flags, ssvm_fd, 0);
  84
  85   if (ssvm->sh == MAP_FAILED)
  86     {
  87       clib_unix_warning ("mmap");
  88       close (ssvm_fd);
  89       return SSVM_API_ERROR_MMAP;
  90     }
  91
  92   close (ssvm_fd);
  93
  94   ssvm->my_pid = getpid ();
  95   sh->master_pid = ssvm->my_pid;
  96   sh->ssvm_size = ssvm->ssvm_size;
  97   sh->heap = mheap_alloc_with_flags
  98     (((u8 *) sh) + MMAP_PAGESIZE, ssvm->ssvm_size - MMAP_PAGESIZE,
  99      MHEAP_FLAG_DISABLE_VM | MHEAP_FLAG_THREAD_SAFE);
 100
 101   sh->ssvm_va = pointer_to_uword (sh);
 102   sh->master_index = master_index;
 103
 104   oldheap = ssvm_push_heap (sh);
 105   sh->name = format (0, "%s%c", ssvm->name, 0);
 106   ssvm_pop_heap (oldheap);
 107
 108   ssvm->i_am_master = 1;
 109
 110   /* The application has to set set sh->ready... */
 111   return 0;
 112 }
 113
 114 int
 115 ssvm_slave_init (ssvm_private_t * ssvm, int timeout_in_seconds)
 116 {
 117   struct stat stat;
 118   int ssvm_fd = -1;
 119   ssvm_shared_header_t *sh;
 120
 121   ASSERT (vec_c_string_is_terminated (ssvm->name));
 122   ssvm->i_am_master = 0;
 123
 124   while (timeout_in_seconds-- > 0)
 125     {
 126       if (ssvm_fd < 0)
 127         ssvm_fd = shm_open ((char *) ssvm->name, O_RDWR, 0777);
 128       if (ssvm_fd < 0)
 129         {
 130           sleep (1);
 131           continue;
 132         }
 133       if (fstat (ssvm_fd, &stat) < 0)
 134         {
 135           sleep (1);
 136           continue;
 137         }
 138
 139       if (stat.st_size > 0)
 140         goto map_it;
 141     }
 142   clib_warning ("slave timeout");
 143   return SSVM_API_ERROR_SLAVE_TIMEOUT;
 144
 145 map_it:
 146   sh = (void *) mmap (0, MMAP_PAGESIZE, PROT_READ | PROT_WRITE, MAP_SHARED,
 147                       ssvm_fd, 0);
 148   if (sh == MAP_FAILED)
 149     {
 150       clib_unix_warning ("slave research mmap");
 151       close (ssvm_fd);
 152       return SSVM_API_ERROR_MMAP;
 153     }
 154
 155   while (timeout_in_seconds-- > 0)
 156     {
 157       if (sh->ready)
 158         goto re_map_it;
 159     }
 160   close (ssvm_fd);
 161   munmap (sh, MMAP_PAGESIZE);
 162   clib_warning ("slave timeout 2");
 163   return SSVM_API_ERROR_SLAVE_TIMEOUT;
 164
 165 re_map_it:
 166   ssvm->requested_va = (u64) sh->ssvm_va;
 167   ssvm->ssvm_size = sh->ssvm_size;
 168   munmap (sh, MMAP_PAGESIZE);
 169
 170   sh = ssvm->sh = (void *) mmap ((void *) ssvm->requested_va, ssvm->ssvm_size,
 171                                  PROT_READ | PROT_WRITE,
 172                                  MAP_SHARED | MAP_FIXED, ssvm_fd, 0);
 173
 174   if (sh == MAP_FAILED)
 175     {
 176       clib_unix_warning ("slave final mmap");
 177       close (ssvm_fd);
 178       return SSVM_API_ERROR_MMAP;
 179     }
 180   sh->slave_pid = getpid ();
 181   return 0;
 182 }
 183
 184 void
 185 ssvm_delete (ssvm_private_t * ssvm)
 186 {
 187   u8 *fn;
 188
 189   fn = format (0, "/dev/shm/%s%c", ssvm->name, 0);
 190
 191   if (CLIB_DEBUG > 1)
 192     clib_warning ("[%d] unlinking ssvm (%s) backing file '%s'", getpid (),
 193                   ssvm->name, fn);
 194
 195   /* Throw away the backing file */
 196   if (unlink ((char *) fn) < 0)
 197     clib_unix_warning ("unlink segment '%s'", ssvm->name);
 198
 199   vec_free (fn);
 200   vec_free (ssvm->name);
 201
 202   munmap ((void *) ssvm->requested_va, ssvm->ssvm_size);
 203 }
 204
 205 int
 206 ssvm_master_init_memfd (ssvm_private_t * memfd, u32 master_index)
 207 {
 208   int flags;
 209   ssvm_shared_header_t *sh;
 210   u64 ticks = clib_cpu_time_now ();
 211   u64 randomize_baseva;
 212   void *oldheap;
 213
 214   if (memfd->ssvm_size == 0)
 215     return SSVM_API_ERROR_NO_SIZE;
 216
 217   ASSERT (vec_c_string_is_terminated (memfd->name));
 218   memfd->name = format (0, "memfd svm region %d", master_index);
 219
 220   memfd->fd = memfd_create ((char *) memfd->name, MFD_ALLOW_SEALING);
 221   if (memfd->fd < 0)
 222     {
 223       clib_unix_warning ("create segment '%s'", memfd->name);
 224       return SSVM_API_ERROR_CREATE_FAILURE;
 225     }
 226
 227   if ((ftruncate (memfd->fd, memfd->ssvm_size)) == -1)
 228     {
 229       clib_unix_warning ("set memfd size");
 230       return SSVM_API_ERROR_SET_SIZE;
 231     }
 232
 233   if ((fcntl (memfd->fd, F_ADD_SEALS, F_SEAL_SHRINK)) == -1)
 234     clib_unix_warning ("fcntl (F_ADD_SEALS, F_SEAL_SHRINK)");
 235
 236   flags = MAP_SHARED;
 237   if (memfd->requested_va)
 238     flags |= MAP_FIXED;
 239
 240   randomize_baseva = (ticks & 15) * MMAP_PAGESIZE;
 241
 242   if (memfd->requested_va)
 243     memfd->requested_va += randomize_baseva;
 244
 245   sh = memfd->sh =
 246     (ssvm_shared_header_t *) mmap ((void *) memfd->requested_va,
 247                                    memfd->ssvm_size, PROT_READ | PROT_WRITE,
 248                                    flags, memfd->fd, 0);
 249
 250   if (memfd->sh == MAP_FAILED)
 251     {
 252       clib_unix_warning ("mmap");
 253       close (memfd->fd);
 254       return SSVM_API_ERROR_MMAP;
 255     }
 256
 257   memfd->my_pid = getpid ();
 258   sh->master_pid = memfd->my_pid;
 259   sh->ssvm_size = memfd->ssvm_size;
 260   sh->heap = mheap_alloc_with_flags
 261     (((u8 *) sh) + MMAP_PAGESIZE, memfd->ssvm_size - MMAP_PAGESIZE,
 262      MHEAP_FLAG_DISABLE_VM | MHEAP_FLAG_THREAD_SAFE);
 263
 264   sh->ssvm_va = pointer_to_uword (sh);
 265   sh->master_index = master_index;
 266
 267   oldheap = ssvm_push_heap (sh);
 268   sh->name = format (0, "%s%c", memfd->name, 0);
 269   ssvm_pop_heap (oldheap);
 270
 271   memfd->i_am_master = 1;
 272
 273   /* The application has to set set sh->ready... */
 274   return 0;
 275 }
 276
 277 /*
 278  * Subtly different than svm_slave_init. The caller
 279  * needs to acquire a usable file descriptor for the memfd segment
 280  * e.g. via vppinfra/socket.c:default_socket_recvmsg
 281  */
 282
 283 int
 284 ssvm_slave_init_memfd (ssvm_private_t * memfd)
 285 {
 286   ssvm_shared_header_t *sh;
 287
 288   memfd->i_am_master = 0;
 289
 290   /* Map the segment once, to look at the shared header */
 291   sh = (void *) mmap (0, MMAP_PAGESIZE, PROT_READ | PROT_WRITE, MAP_SHARED,
 292                       memfd->fd, 0);
 293   if (sh == MAP_FAILED)
 294     {
 295       clib_unix_warning ("slave research mmap");
 296       close (memfd->fd);
 297       return SSVM_API_ERROR_MMAP;
 298     }
 299
 300   memfd->requested_va = (u64) sh->ssvm_va;
 301   memfd->ssvm_size = sh->ssvm_size;
 302   munmap (sh, MMAP_PAGESIZE);
 303
 304   sh = (void *) mmap ((void *) memfd->requested_va, memfd->ssvm_size,
 305                       PROT_READ | PROT_WRITE, MAP_SHARED | MAP_FIXED,
 306                       memfd->fd, 0);
 307
 308   if (sh == MAP_FAILED)
 309     {
 310       clib_unix_warning ("slave final mmap");
 311       close (memfd->fd);
 312       return SSVM_API_ERROR_MMAP;
 313     }
 314   sh->slave_pid = getpid ();
 315   memfd->sh = sh;
 316   return 0;
 317 }
 318
 319 /*
 320  * fd.io coding-style-patch-verification: ON
 321  *
 322  * Local Variables:
 323  * eval: (c-set-style "gnu")
 324  * End:
 325  */