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   uword page_size, flags = MHEAP_FLAG_DISABLE_VM | MHEAP_FLAG_THREAD_SAFE;
 209   ssvm_shared_header_t *sh;
 210   void *oldheap;
 211   clib_mem_vm_alloc_t alloc = { 0 };
 212   clib_error_t *err;
 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%c", master_index, 0);
 219
 220   alloc.name = (char *) memfd->name;
 221   alloc.size = memfd->ssvm_size;
 222   alloc.flags = CLIB_MEM_VM_F_SHARED;
 223   if ((err = clib_mem_vm_ext_alloc (&alloc)))
 224     {
 225       clib_error_report (err);
 226       return SSVM_API_ERROR_CREATE_FAILURE;
 227     }
 228
 229   memfd->fd = alloc.fd;
 230   memfd->sh = alloc.addr;
 231   memfd->my_pid = getpid ();
 232   memfd->i_am_master = 1;
 233
 234   page_size = 1 << alloc.log2_page_size;
 235   sh = (ssvm_shared_header_t *) memfd->sh;
 236   sh->master_pid = memfd->my_pid;
 237   sh->ssvm_size = memfd->ssvm_size;
 238   sh->heap = mheap_alloc_with_flags (((u8 *) sh) + page_size,
 239                                      memfd->ssvm_size - page_size, flags);
 240   sh->ssvm_va = pointer_to_uword (sh);
 241   sh->master_index = master_index;
 242
 243   oldheap = ssvm_push_heap (sh);
 244   sh->name = format (0, "%s%c", memfd->name, 0);
 245   ssvm_pop_heap (oldheap);
 246
 247   /* The application has to set set sh->ready... */
 248   return 0;
 249 }
 250
 251 /*
 252  * Subtly different than svm_slave_init. The caller
 253  * needs to acquire a usable file descriptor for the memfd segment
 254  * e.g. via vppinfra/socket.c:default_socket_recvmsg
 255  */
 256
 257 int
 258 ssvm_slave_init_memfd (ssvm_private_t * memfd)
 259 {
 260   clib_mem_vm_map_t mapa = { 0 };
 261   ssvm_shared_header_t *sh;
 262   uword page_size;
 263
 264   memfd->i_am_master = 0;
 265
 266   page_size = clib_mem_vm_get_page_size (memfd->fd);
 267   if (!page_size)
 268     {
 269       clib_unix_warning ("page size unknown");
 270       return SSVM_API_ERROR_MMAP;
 271     }
 272
 273   /*
 274    * Map the segment once, to look at the shared header
 275    */
 276   mapa.fd = memfd->fd;
 277   mapa.size = page_size;
 278
 279   if (clib_mem_vm_ext_map (&mapa))
 280     {
 281       clib_unix_warning ("slave research mmap");
 282       close (memfd->fd);
 283       return SSVM_API_ERROR_MMAP;
 284     }
 285
 286   sh = mapa.addr;
 287   memfd->requested_va = sh->ssvm_va;
 288   memfd->ssvm_size = sh->ssvm_size;
 289   munmap (sh, page_size);
 290
 291   /*
 292    * Remap the segment at the 'right' address
 293    */
 294   mapa.requested_va = memfd->requested_va;
 295   mapa.size = memfd->ssvm_size;
 296   if (clib_mem_vm_ext_map (&mapa))
 297     {
 298       clib_unix_warning ("slave final mmap");
 299       close (memfd->fd);
 300       return SSVM_API_ERROR_MMAP;
 301     }
 302
 303   sh = mapa.addr;
 304   sh->slave_pid = getpid ();
 305   memfd->sh = sh;
 306   return 0;
 307 }
 308
 309 void
 310 ssvm_delete_memfd (ssvm_private_t * memfd)
 311 {
 312   vec_free (memfd->name);
 313   clib_mem_vm_free (memfd->sh, memfd->ssvm_size);
 314   close (memfd->fd);
 315 }
 316
 317 /*
 318  * fd.io coding-style-patch-verification: ON
 319  *
 320  * Local Variables:
 321  * eval: (c-set-style "gnu")
 322  * End:
 323  */