src/svm/ssvm.c

   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 #include <svm/ssvm.h>
  16 #include <svm/svm_common.h>
  17
  18 typedef int (*init_fn) (ssvm_private_t *);
  19 typedef void (*delete_fn) (ssvm_private_t *);
  20
  21 static init_fn master_init_fns[SSVM_N_SEGMENT_TYPES] =
  22   { ssvm_master_init_shm, ssvm_master_init_memfd, ssvm_master_init_private };
  23 static init_fn slave_init_fns[SSVM_N_SEGMENT_TYPES] =
  24   { ssvm_slave_init_shm, ssvm_slave_init_memfd, ssvm_slave_init_private };
  25 static delete_fn delete_fns[SSVM_N_SEGMENT_TYPES] =
  26   { ssvm_delete_shm, ssvm_delete_memfd, ssvm_delete_private };
  27
  28 int
  29 ssvm_master_init_shm (ssvm_private_t * ssvm)
  30 {
  31   int ssvm_fd;
  32   clib_mem_vm_map_t mapa = { 0 };
  33   u8 junk = 0, *ssvm_filename;
  34   ssvm_shared_header_t *sh;
  35   uword page_size, requested_va = 0;
  36   void *oldheap;
  37
  38   if (ssvm->ssvm_size == 0)
  39     return SSVM_API_ERROR_NO_SIZE;
  40
  41   if (CLIB_DEBUG > 1)
  42     clib_warning ("[%d] creating segment '%s'", getpid (), ssvm->name);
  43
  44   ASSERT (vec_c_string_is_terminated (ssvm->name));
  45   ssvm_filename = format (0, "/dev/shm/%s%c", ssvm->name, 0);
  46   unlink ((char *) ssvm_filename);
  47   vec_free (ssvm_filename);
  48
  49   ssvm_fd = shm_open ((char *) ssvm->name, O_RDWR | O_CREAT | O_EXCL, 0777);
  50   if (ssvm_fd < 0)
  51     {
  52       clib_unix_warning ("create segment '%s'", ssvm->name);
  53       return SSVM_API_ERROR_CREATE_FAILURE;
  54     }
  55
  56   if (fchmod (ssvm_fd, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP) < 0)
  57     clib_unix_warning ("ssvm segment chmod");
  58   if (svm_get_root_rp ())
  59     {
  60       /* TODO: is this really needed? */
  61       svm_main_region_t *smr = svm_get_root_rp ()->data_base;
  62       if (fchown (ssvm_fd, smr->uid, smr->gid) < 0)
  63         clib_unix_warning ("ssvm segment chown");
  64     }
  65
  66   if (lseek (ssvm_fd, ssvm->ssvm_size, SEEK_SET) < 0)
  67     {
  68       clib_unix_warning ("lseek");
  69       close (ssvm_fd);
  70       return SSVM_API_ERROR_SET_SIZE;
  71     }
  72
  73   if (write (ssvm_fd, &junk, 1) != 1)
  74     {
  75       clib_unix_warning ("set ssvm size");
  76       close (ssvm_fd);
  77       return SSVM_API_ERROR_SET_SIZE;
  78     }
  79
  80   page_size = clib_mem_get_fd_page_size (ssvm_fd);
  81   if (ssvm->requested_va)
  82     {
  83       requested_va = ssvm->requested_va;
  84       clib_mem_vm_randomize_va (&requested_va, min_log2 (page_size));
  85     }
  86
  87   mapa.requested_va = requested_va;
  88   mapa.size = ssvm->ssvm_size;
  89   mapa.fd = ssvm_fd;
  90   mapa.numa_node = ssvm->numa;
  91   if (clib_mem_vm_ext_map (&mapa))
  92     {
  93       clib_unix_warning ("mmap");
  94       close (ssvm_fd);
  95       return SSVM_API_ERROR_MMAP;
  96     }
  97   close (ssvm_fd);
  98
  99   sh = mapa.addr;
 100   CLIB_MEM_UNPOISON (sh, sizeof (*sh));
 101   sh->master_pid = ssvm->my_pid;
 102   sh->ssvm_size = ssvm->ssvm_size;
 103   sh->ssvm_va = pointer_to_uword (sh);
 104   sh->type = SSVM_SEGMENT_SHM;
 105   sh->heap = clib_mem_create_heap (((u8 *) sh) + page_size,
 106                                    ssvm->ssvm_size - page_size,
 107                                    1 /* locked */ , "ssvm master shm");
 108
 109   oldheap = ssvm_push_heap (sh);
 110   sh->name = format (0, "%s", ssvm->name, 0);
 111   ssvm_pop_heap (oldheap);
 112
 113   ssvm->sh = sh;
 114   ssvm->my_pid = getpid ();
 115   ssvm->i_am_master = 1;
 116
 117   /* The application has to set set sh->ready... */
 118   return 0;
 119 }
 120
 121 int
 122 ssvm_slave_init_shm (ssvm_private_t * ssvm)
 123 {
 124   struct stat stat;
 125   int ssvm_fd = -1;
 126   ssvm_shared_header_t *sh;
 127
 128   ASSERT (vec_c_string_is_terminated (ssvm->name));
 129   ssvm->i_am_master = 0;
 130
 131   while (ssvm->attach_timeout-- > 0)
 132     {
 133       if (ssvm_fd < 0)
 134         ssvm_fd = shm_open ((char *) ssvm->name, O_RDWR, 0777);
 135       if (ssvm_fd < 0)
 136         {
 137           sleep (1);
 138           continue;
 139         }
 140       if (fstat (ssvm_fd, &stat) < 0)
 141         {
 142           sleep (1);
 143           continue;
 144         }
 145
 146       if (stat.st_size > 0)
 147         goto map_it;
 148     }
 149   clib_warning ("slave timeout");
 150   return SSVM_API_ERROR_SLAVE_TIMEOUT;
 151
 152 map_it:
 153   sh = (void *) mmap (0, MMAP_PAGESIZE, PROT_READ | PROT_WRITE, MAP_SHARED,
 154                       ssvm_fd, 0);
 155   if (sh == MAP_FAILED)
 156     {
 157       clib_unix_warning ("slave research mmap");
 158       close (ssvm_fd);
 159       return SSVM_API_ERROR_MMAP;
 160     }
 161
 162   while (ssvm->attach_timeout-- > 0)
 163     {
 164       if (sh->ready)
 165         goto re_map_it;
 166     }
 167   close (ssvm_fd);
 168   munmap (sh, MMAP_PAGESIZE);
 169   clib_warning ("slave timeout 2");
 170   return SSVM_API_ERROR_SLAVE_TIMEOUT;
 171
 172 re_map_it:
 173   ssvm->requested_va = sh->ssvm_va;
 174   ssvm->ssvm_size = sh->ssvm_size;
 175   munmap (sh, MMAP_PAGESIZE);
 176
 177   sh = ssvm->sh = (void *) mmap ((void *) ssvm->requested_va, ssvm->ssvm_size,
 178                                  PROT_READ | PROT_WRITE,
 179                                  MAP_SHARED | MAP_FIXED, ssvm_fd, 0);
 180
 181   if (sh == MAP_FAILED)
 182     {
 183       clib_unix_warning ("slave final mmap");
 184       close (ssvm_fd);
 185       return SSVM_API_ERROR_MMAP;
 186     }
 187   sh->slave_pid = getpid ();
 188   return 0;
 189 }
 190
 191 void
 192 ssvm_delete_shm (ssvm_private_t * ssvm)
 193 {
 194   u8 *fn;
 195
 196   fn = format (0, "/dev/shm/%s%c", ssvm->name, 0);
 197
 198   if (CLIB_DEBUG > 1)
 199     clib_warning ("[%d] unlinking ssvm (%s) backing file '%s'", getpid (),
 200                   ssvm->name, fn);
 201
 202   /* Throw away the backing file */
 203   if (unlink ((char *) fn) < 0)
 204     clib_unix_warning ("unlink segment '%s'", ssvm->name);
 205
 206   vec_free (fn);
 207   vec_free (ssvm->name);
 208
 209   munmap ((void *) ssvm->sh, ssvm->ssvm_size);
 210 }
 211
 212 /**
 213  * Initialize memfd segment master
 214  */
 215 int
 216 ssvm_master_init_memfd (ssvm_private_t * memfd)
 217 {
 218   uword page_size;
 219   ssvm_shared_header_t *sh;
 220   void *oldheap;
 221   clib_mem_vm_alloc_t alloc = { 0 };
 222   clib_error_t *err;
 223
 224   if (memfd->ssvm_size == 0)
 225     return SSVM_API_ERROR_NO_SIZE;
 226
 227   ASSERT (vec_c_string_is_terminated (memfd->name));
 228
 229   alloc.name = (char *) memfd->name;
 230   alloc.size = memfd->ssvm_size;
 231   alloc.flags = CLIB_MEM_VM_F_SHARED;
 232   alloc.requested_va = memfd->requested_va;
 233   if (memfd->numa)
 234     {
 235       alloc.numa_node = memfd->numa;
 236       alloc.flags |= CLIB_MEM_VM_F_NUMA_PREFER;
 237     }
 238   if ((err = clib_mem_vm_ext_alloc (&alloc)))
 239     {
 240       clib_error_report (err);
 241       return SSVM_API_ERROR_CREATE_FAILURE;
 242     }
 243
 244   memfd->fd = alloc.fd;
 245   memfd->sh = (ssvm_shared_header_t *) alloc.addr;
 246   memfd->my_pid = getpid ();
 247   memfd->i_am_master = 1;
 248
 249   page_size = 1ull << alloc.log2_page_size;
 250   sh = memfd->sh;
 251   sh->master_pid = memfd->my_pid;
 252   sh->ssvm_size = memfd->ssvm_size;
 253   sh->ssvm_va = pointer_to_uword (sh);
 254   sh->type = SSVM_SEGMENT_MEMFD;
 255
 256   sh->heap = clib_mem_create_heap (((u8 *) sh) + page_size,
 257                                    memfd->ssvm_size - page_size,
 258                                    1 /* locked */ , "ssvm master memfd");
 259   oldheap = ssvm_push_heap (sh);
 260   sh->name = format (0, "%s", memfd->name, 0);
 261   ssvm_pop_heap (oldheap);
 262
 263   /* The application has to set set sh->ready... */
 264   return 0;
 265 }
 266
 267 /**
 268  * Initialize memfd segment slave
 269  *
 270  * Subtly different than svm_slave_init. The caller needs to acquire
 271  * a usable file descriptor for the memfd segment e.g. via
 272  * vppinfra/socket.c:default_socket_recvmsg
 273  */
 274 int
 275 ssvm_slave_init_memfd (ssvm_private_t * memfd)
 276 {
 277   clib_mem_vm_map_t mapa = { 0 };
 278   ssvm_shared_header_t *sh;
 279   uword page_size;
 280
 281   memfd->i_am_master = 0;
 282
 283   page_size = clib_mem_get_fd_page_size (memfd->fd);
 284   if (!page_size)
 285     {
 286       clib_unix_warning ("page size unknown");
 287       return SSVM_API_ERROR_MMAP;
 288     }
 289
 290   /*
 291    * Map the segment once, to look at the shared header
 292    */
 293   mapa.fd = memfd->fd;
 294   mapa.size = page_size;
 295
 296   if (clib_mem_vm_ext_map (&mapa))
 297     {
 298       clib_unix_warning ("slave research mmap (fd %d)", mapa.fd);
 299       close (memfd->fd);
 300       return SSVM_API_ERROR_MMAP;
 301     }
 302
 303   sh = mapa.addr;
 304   memfd->requested_va = sh->ssvm_va;
 305   memfd->ssvm_size = sh->ssvm_size;
 306   clib_mem_vm_free (sh, page_size);
 307
 308   /*
 309    * Remap the segment at the 'right' address
 310    */
 311   mapa.requested_va = memfd->requested_va;
 312   mapa.size = memfd->ssvm_size;
 313   if (clib_mem_vm_ext_map (&mapa))
 314     {
 315       clib_unix_warning ("slave final mmap");
 316       close (memfd->fd);
 317       return SSVM_API_ERROR_MMAP;
 318     }
 319
 320   sh = mapa.addr;
 321   sh->slave_pid = getpid ();
 322   memfd->sh = sh;
 323   return 0;
 324 }
 325
 326 void
 327 ssvm_delete_memfd (ssvm_private_t * memfd)
 328 {
 329   vec_free (memfd->name);
 330   clib_mem_vm_free (memfd->sh, memfd->ssvm_size);
 331   close (memfd->fd);
 332 }
 333
 334 /**
 335  * Initialize segment in a private heap
 336  */
 337 int
 338 ssvm_master_init_private (ssvm_private_t * ssvm)
 339 {
 340   uword pagesize = clib_mem_get_page_size (), rnd_size = 0;
 341   clib_mem_vm_alloc_t alloc = { 0 };
 342   ssvm_shared_header_t *sh;
 343   clib_error_t *err;
 344   u8 *heap;
 345
 346   rnd_size = clib_max (ssvm->ssvm_size + (pagesize - 1), ssvm->ssvm_size);
 347   rnd_size &= ~(pagesize - 1);
 348
 349   alloc.name = (char *) ssvm->name;
 350   alloc.size = rnd_size + pagesize;
 351   if (ssvm->numa)
 352     {
 353       alloc.numa_node = ssvm->numa;
 354       alloc.flags |= CLIB_MEM_VM_F_NUMA_PREFER;
 355     }
 356
 357   if ((err = clib_mem_vm_ext_alloc (&alloc)))
 358     {
 359       clib_error_report (err);
 360       return SSVM_API_ERROR_CREATE_FAILURE;
 361     }
 362
 363   heap = clib_mem_create_heap ((u8 *) alloc.addr + pagesize, rnd_size,
 364                                1 /* locked */ , "ssvm master private");
 365   if (heap == 0)
 366     {
 367       clib_unix_warning ("mheap alloc");
 368       return -1;
 369     }
 370
 371   rnd_size = clib_mem_get_heap_free_space (heap);
 372
 373   ssvm->ssvm_size = rnd_size;
 374   ssvm->i_am_master = 1;
 375   ssvm->my_pid = getpid ();
 376   ssvm->requested_va = ~0;
 377
 378   /* First page in allocated memory is set aside for the shared header */
 379   sh = alloc.addr;
 380   ssvm->sh = sh;
 381
 382   clib_memset (sh, 0, sizeof (*sh));
 383   sh->heap = heap;
 384   sh->ssvm_size = rnd_size;
 385   sh->ssvm_va = pointer_to_uword (heap);
 386   sh->type = SSVM_SEGMENT_PRIVATE;
 387   sh->name = ssvm->name;
 388
 389   return 0;
 390 }
 391
 392 int
 393 ssvm_slave_init_private (ssvm_private_t * ssvm)
 394 {
 395   clib_warning ("BUG: this should not be called!");
 396   return -1;
 397 }
 398
 399 void
 400 ssvm_delete_private (ssvm_private_t * ssvm)
 401 {
 402   vec_free (ssvm->name);
 403   clib_mem_destroy_heap (ssvm->sh->heap);
 404   clib_mem_vm_free (ssvm->sh, ssvm->ssvm_size + clib_mem_get_page_size ());
 405 }
 406
 407 int
 408 ssvm_master_init (ssvm_private_t * ssvm, ssvm_segment_type_t type)
 409 {
 410   return (master_init_fns[type]) (ssvm);
 411 }
 412
 413 int
 414 ssvm_slave_init (ssvm_private_t * ssvm, ssvm_segment_type_t type)
 415 {
 416   return (slave_init_fns[type]) (ssvm);
 417 }
 418
 419 void
 420 ssvm_delete (ssvm_private_t * ssvm)
 421 {
 422   delete_fns[ssvm->sh->type] (ssvm);
 423 }
 424
 425 ssvm_segment_type_t
 426 ssvm_type (const ssvm_private_t * ssvm)
 427 {
 428   return ssvm->sh->type;
 429 }
 430
 431 u8 *
 432 ssvm_name (const ssvm_private_t * ssvm)
 433 {
 434   return ssvm->sh->name;
 435 }
 436
 437 /*
 438  * fd.io coding-style-patch-verification: ON
 439  *
 440  * Local Variables:
 441  * eval: (c-set-style "gnu")
 442  * End:
 443  */