svm: support for multi-segment enqueues
[vpp.git] / src / svm / ssvm.c
index 04e0efa..cfdb796 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015 Cisco and/or its affiliates.
+ * Copyright (c) 2015-2019 Cisco and/or its affiliates.
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at:
 typedef int (*init_fn) (ssvm_private_t *);
 typedef void (*delete_fn) (ssvm_private_t *);
 
-static init_fn master_init_fns[SSVM_N_SEGMENT_TYPES] =
-  { ssvm_master_init_shm, ssvm_master_init_memfd, ssvm_master_init_private };
-static init_fn slave_init_fns[SSVM_N_SEGMENT_TYPES] =
-  { ssvm_slave_init_shm, ssvm_slave_init_memfd, ssvm_slave_init_private };
+static init_fn server_init_fns[SSVM_N_SEGMENT_TYPES] =
+  { ssvm_server_init_shm, ssvm_server_init_memfd, ssvm_server_init_private };
+static init_fn client_init_fns[SSVM_N_SEGMENT_TYPES] =
+  { ssvm_client_init_shm, ssvm_client_init_memfd, ssvm_client_init_private };
 static delete_fn delete_fns[SSVM_N_SEGMENT_TYPES] =
   { ssvm_delete_shm, ssvm_delete_memfd, ssvm_delete_private };
 
 int
-ssvm_master_init_shm (ssvm_private_t * ssvm)
+ssvm_server_init_shm (ssvm_private_t * ssvm)
 {
-  int ssvm_fd, mh_flags = MHEAP_FLAG_DISABLE_VM | MHEAP_FLAG_THREAD_SAFE;
-  svm_main_region_t *smr = svm_get_root_rp ()->data_base;
-  clib_mem_vm_map_t mapa = { 0 };
+  int ssvm_fd;
   u8 junk = 0, *ssvm_filename;
   ssvm_shared_header_t *sh;
   uword page_size, requested_va = 0;
@@ -56,8 +54,13 @@ ssvm_master_init_shm (ssvm_private_t * ssvm)
 
   if (fchmod (ssvm_fd, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP) < 0)
     clib_unix_warning ("ssvm segment chmod");
-  if (fchown (ssvm_fd, smr->uid, smr->gid) < 0)
-    clib_unix_warning ("ssvm segment chown");
+  if (svm_get_root_rp ())
+    {
+      /* TODO: is this really needed? */
+      svm_main_region_t *smr = svm_get_root_rp ()->data_base;
+      if (fchown (ssvm_fd, smr->uid, smr->gid) < 0)
+       clib_unix_warning ("ssvm segment chown");
+    }
 
   if (lseek (ssvm_fd, ssvm->ssvm_size, SEEK_SET) < 0)
     {
@@ -73,31 +76,33 @@ ssvm_master_init_shm (ssvm_private_t * ssvm)
       return SSVM_API_ERROR_SET_SIZE;
     }
 
-  page_size = clib_mem_vm_get_page_size (ssvm_fd);
+  page_size = clib_mem_get_fd_page_size (ssvm_fd);
   if (ssvm->requested_va)
     {
       requested_va = ssvm->requested_va;
       clib_mem_vm_randomize_va (&requested_va, min_log2 (page_size));
     }
 
-  mapa.requested_va = requested_va;
-  mapa.size = ssvm->ssvm_size;
-  mapa.fd = ssvm_fd;
-  if (clib_mem_vm_ext_map (&mapa))
+  sh = clib_mem_vm_map_shared (uword_to_pointer (requested_va, void *),
+                              ssvm->ssvm_size, ssvm_fd, 0,
+                              (char *) ssvm->name);
+  if (sh == CLIB_MEM_VM_MAP_FAILED)
     {
       clib_unix_warning ("mmap");
       close (ssvm_fd);
       return SSVM_API_ERROR_MMAP;
     }
+
   close (ssvm_fd);
 
-  sh = mapa.addr;
-  sh->master_pid = ssvm->my_pid;
+  CLIB_MEM_UNPOISON (sh, sizeof (*sh));
+  sh->server_pid = ssvm->my_pid;
   sh->ssvm_size = ssvm->ssvm_size;
   sh->ssvm_va = pointer_to_uword (sh);
   sh->type = SSVM_SEGMENT_SHM;
-  sh->heap = mheap_alloc_with_flags (((u8 *) sh) + page_size,
-                                    ssvm->ssvm_size - page_size, mh_flags);
+  sh->heap = clib_mem_create_heap (((u8 *) sh) + page_size,
+                                  ssvm->ssvm_size - page_size,
+                                  1 /* locked */ , "ssvm server shm");
 
   oldheap = ssvm_push_heap (sh);
   sh->name = format (0, "%s", ssvm->name, 0);
@@ -105,21 +110,21 @@ ssvm_master_init_shm (ssvm_private_t * ssvm)
 
   ssvm->sh = sh;
   ssvm->my_pid = getpid ();
-  ssvm->i_am_master = 1;
+  ssvm->is_server = 1;
 
   /* The application has to set set sh->ready... */
   return 0;
 }
 
 int
-ssvm_slave_init_shm (ssvm_private_t * ssvm)
+ssvm_client_init_shm (ssvm_private_t * ssvm)
 {
   struct stat stat;
   int ssvm_fd = -1;
   ssvm_shared_header_t *sh;
 
   ASSERT (vec_c_string_is_terminated (ssvm->name));
-  ssvm->i_am_master = 0;
+  ssvm->is_server = 0;
 
   while (ssvm->attach_timeout-- > 0)
     {
@@ -139,15 +144,15 @@ ssvm_slave_init_shm (ssvm_private_t * ssvm)
       if (stat.st_size > 0)
        goto map_it;
     }
-  clib_warning ("slave timeout");
-  return SSVM_API_ERROR_SLAVE_TIMEOUT;
+  clib_warning ("client timeout");
+  return SSVM_API_ERROR_CLIENT_TIMEOUT;
 
 map_it:
   sh = (void *) mmap (0, MMAP_PAGESIZE, PROT_READ | PROT_WRITE, MAP_SHARED,
                      ssvm_fd, 0);
   if (sh == MAP_FAILED)
     {
-      clib_unix_warning ("slave research mmap");
+      clib_unix_warning ("client research mmap");
       close (ssvm_fd);
       return SSVM_API_ERROR_MMAP;
     }
@@ -159,11 +164,11 @@ map_it:
     }
   close (ssvm_fd);
   munmap (sh, MMAP_PAGESIZE);
-  clib_warning ("slave timeout 2");
-  return SSVM_API_ERROR_SLAVE_TIMEOUT;
+  clib_warning ("client timeout 2");
+  return SSVM_API_ERROR_CLIENT_TIMEOUT;
 
 re_map_it:
-  ssvm->requested_va = (u64) sh->ssvm_va;
+  ssvm->requested_va = sh->ssvm_va;
   ssvm->ssvm_size = sh->ssvm_size;
   munmap (sh, MMAP_PAGESIZE);
 
@@ -173,11 +178,11 @@ re_map_it:
 
   if (sh == MAP_FAILED)
     {
-      clib_unix_warning ("slave final mmap");
+      clib_unix_warning ("client final mmap");
       close (ssvm_fd);
       return SSVM_API_ERROR_MMAP;
     }
-  sh->slave_pid = getpid ();
+  sh->client_pid = getpid ();
   return 0;
 }
 
@@ -199,50 +204,75 @@ ssvm_delete_shm (ssvm_private_t * ssvm)
   vec_free (fn);
   vec_free (ssvm->name);
 
-  munmap ((void *) ssvm->requested_va, ssvm->ssvm_size);
+  if (ssvm->is_server)
+    clib_mem_vm_unmap (ssvm->sh);
+  else
+    munmap ((void *) ssvm->sh, ssvm->ssvm_size);
 }
 
 /**
- * Initialize memfd segment master
+ * Initialize memfd segment server
  */
 int
-ssvm_master_init_memfd (ssvm_private_t * memfd)
+ssvm_server_init_memfd (ssvm_private_t * memfd)
 {
-  uword page_size, flags = MHEAP_FLAG_DISABLE_VM | MHEAP_FLAG_THREAD_SAFE;
+  uword page_size, n_pages;
   ssvm_shared_header_t *sh;
+  int log2_page_size;
   void *oldheap;
-  clib_mem_vm_alloc_t alloc = { 0 };
-  clib_error_t *err;
 
   if (memfd->ssvm_size == 0)
     return SSVM_API_ERROR_NO_SIZE;
 
   ASSERT (vec_c_string_is_terminated (memfd->name));
 
-  alloc.name = (char *) memfd->name;
-  alloc.size = memfd->ssvm_size;
-  alloc.flags = CLIB_MEM_VM_F_SHARED;
-  alloc.requested_va = memfd->requested_va;
-  if ((err = clib_mem_vm_ext_alloc (&alloc)))
+  memfd->fd = clib_mem_vm_create_fd (CLIB_MEM_PAGE_SZ_DEFAULT,
+                                    (char *) memfd->name);
+
+  if (memfd->fd == CLIB_MEM_ERROR)
+    {
+      clib_unix_warning ("failed to create memfd");
+      return SSVM_API_ERROR_CREATE_FAILURE;
+    }
+
+  log2_page_size = clib_mem_get_fd_log2_page_size (memfd->fd);
+  if (log2_page_size == 0)
     {
-      clib_error_report (err);
+      clib_unix_warning ("cannot determine page size");
       return SSVM_API_ERROR_CREATE_FAILURE;
     }
 
-  memfd->fd = alloc.fd;
-  memfd->sh = (ssvm_shared_header_t *) alloc.addr;
+  n_pages = ((memfd->ssvm_size - 1) >> log2_page_size) + 1;
+
+  if ((ftruncate (memfd->fd, n_pages << log2_page_size)) == -1)
+    {
+      clib_unix_warning ("memfd ftruncate failure");
+      return SSVM_API_ERROR_CREATE_FAILURE;
+    }
+
+  sh = clib_mem_vm_map_shared (uword_to_pointer (memfd->requested_va, void *),
+                              memfd->ssvm_size, memfd->fd, 0,
+                              (char *) memfd->name);
+  if (sh == CLIB_MEM_VM_MAP_FAILED)
+    {
+      clib_unix_warning ("memfd map (fd %d)", memfd->fd);
+      close (memfd->fd);
+      return SSVM_API_ERROR_CREATE_FAILURE;
+    }
+
+  memfd->sh = sh;
   memfd->my_pid = getpid ();
-  memfd->i_am_master = 1;
+  memfd->is_server = 1;
 
-  page_size = 1 << alloc.log2_page_size;
-  sh = memfd->sh;
-  sh->master_pid = memfd->my_pid;
+  sh->server_pid = memfd->my_pid;
   sh->ssvm_size = memfd->ssvm_size;
   sh->ssvm_va = pointer_to_uword (sh);
   sh->type = SSVM_SEGMENT_MEMFD;
-  sh->heap = mheap_alloc_with_flags (((u8 *) sh) + page_size,
-                                    memfd->ssvm_size - page_size, flags);
 
+  page_size = 1ULL << log2_page_size;
+  sh->heap = clib_mem_create_heap (((u8 *) sh) + page_size,
+                                  memfd->ssvm_size - page_size,
+                                  1 /* locked */ , "ssvm server memfd");
   oldheap = ssvm_push_heap (sh);
   sh->name = format (0, "%s", memfd->name, 0);
   ssvm_pop_heap (oldheap);
@@ -252,60 +282,63 @@ ssvm_master_init_memfd (ssvm_private_t * memfd)
 }
 
 /**
- * Initialize memfd segment slave
+ * Initialize memfd segment client
  *
- * Subtly different than svm_slave_init. The caller needs to acquire
+ * Subtly different than svm_client_init. The caller needs to acquire
  * a usable file descriptor for the memfd segment e.g. via
  * vppinfra/socket.c:default_socket_recvmsg
  */
 int
-ssvm_slave_init_memfd (ssvm_private_t * memfd)
+ssvm_client_init_memfd (ssvm_private_t * memfd)
 {
-  clib_mem_vm_map_t mapa = { 0 };
+  int mmap_flags = MAP_SHARED;
   ssvm_shared_header_t *sh;
   uword page_size;
 
-  memfd->i_am_master = 0;
+  memfd->is_server = 0;
 
-  page_size = clib_mem_vm_get_page_size (memfd->fd);
+  page_size = clib_mem_get_fd_page_size (memfd->fd);
   if (!page_size)
     {
       clib_unix_warning ("page size unknown");
       return SSVM_API_ERROR_MMAP;
     }
 
+  if (memfd->requested_va)
+    mmap_flags |= MAP_FIXED;
+
   /*
    * Map the segment once, to look at the shared header
    */
-  mapa.fd = memfd->fd;
-  mapa.size = page_size;
+  sh = (void *) mmap (0, page_size, PROT_READ | PROT_WRITE, MAP_SHARED,
+                     memfd->fd, 0);
 
-  if (clib_mem_vm_ext_map (&mapa))
+  if (sh == MAP_FAILED)
     {
-      clib_unix_warning ("slave research mmap (fd %d)", mapa.fd);
+      clib_unix_warning ("client research mmap (fd %d)", memfd->fd);
       close (memfd->fd);
       return SSVM_API_ERROR_MMAP;
     }
 
-  sh = mapa.addr;
   memfd->requested_va = sh->ssvm_va;
   memfd->ssvm_size = sh->ssvm_size;
-  clib_mem_vm_free (sh, page_size);
+  munmap (sh, page_size);
 
   /*
    * Remap the segment at the 'right' address
    */
-  mapa.requested_va = memfd->requested_va;
-  mapa.size = memfd->ssvm_size;
-  if (clib_mem_vm_ext_map (&mapa))
+  sh = (void *) mmap (uword_to_pointer (memfd->requested_va, void *),
+                     memfd->ssvm_size,
+                     PROT_READ | PROT_WRITE, mmap_flags, memfd->fd, 0);
+
+  if (sh == MAP_FAILED)
     {
-      clib_unix_warning ("slave final mmap");
+      clib_unix_warning ("client final mmap");
       close (memfd->fd);
       return SSVM_API_ERROR_MMAP;
     }
 
-  sh = mapa.addr;
-  sh->slave_pid = getpid ();
+  sh->client_pid = getpid ();
   memfd->sh = sh;
   return 0;
 }
@@ -314,7 +347,10 @@ void
 ssvm_delete_memfd (ssvm_private_t * memfd)
 {
   vec_free (memfd->name);
-  clib_mem_vm_free (memfd->sh, memfd->ssvm_size);
+  if (memfd->is_server)
+    clib_mem_vm_unmap (memfd->sh);
+  else
+    munmap (memfd->sh, memfd->ssvm_size);
   close (memfd->fd);
 }
 
@@ -322,42 +358,64 @@ ssvm_delete_memfd (ssvm_private_t * memfd)
  * Initialize segment in a private heap
  */
 int
-ssvm_master_init_private (ssvm_private_t * ssvm)
+ssvm_server_init_private (ssvm_private_t * ssvm)
 {
-  u32 pagesize = clib_mem_get_page_size ();
+  uword page_size, log2_page_size, rnd_size = 0;
   ssvm_shared_header_t *sh;
-  mheap_t *heap_header;
-  u32 rnd_size = 0;
-  u8 *heap;
+  clib_mem_heap_t *heap, *oldheap;
+
+  log2_page_size = clib_mem_get_log2_page_size ();
+  if (log2_page_size == 0)
+    {
+      clib_unix_warning ("cannot determine page size");
+      return SSVM_API_ERROR_CREATE_FAILURE;
+    }
+
+  page_size = 1ULL << log2_page_size;
+  rnd_size = clib_max (ssvm->ssvm_size + (page_size - 1), ssvm->ssvm_size);
+  rnd_size &= ~(page_size - 1);
 
-  rnd_size = (ssvm->ssvm_size + (pagesize - 1)) & ~pagesize;
-  heap = mheap_alloc (0, rnd_size);
+  sh = clib_mem_vm_map (0, rnd_size + page_size, log2_page_size,
+                       (char *) ssvm->name);
+  if (sh == CLIB_MEM_VM_MAP_FAILED)
+    {
+      clib_unix_warning ("private map failed");
+      return SSVM_API_ERROR_CREATE_FAILURE;
+    }
+
+  heap = clib_mem_create_heap ((u8 *) sh + page_size, rnd_size,
+                              1 /* locked */ , "ssvm server private");
   if (heap == 0)
     {
-      clib_unix_warning ("mheap alloc");
+      clib_unix_warning ("heap alloc");
       return -1;
     }
-  heap_header = mheap_header (heap);
-  heap_header->flags |= MHEAP_FLAG_THREAD_SAFE;
+
+  rnd_size = clib_mem_get_heap_free_space (heap);
 
   ssvm->ssvm_size = rnd_size;
-  ssvm->i_am_master = 1;
+  ssvm->is_server = 1;
   ssvm->my_pid = getpid ();
   ssvm->requested_va = ~0;
 
-  /* Allocate a [sic] shared memory header, in process memory... */
-  sh = clib_mem_alloc_aligned (sizeof (*sh), CLIB_CACHE_LINE_BYTES);
+  /* First page in allocated memory is set aside for the shared header */
   ssvm->sh = sh;
 
-  memset (sh, 0, sizeof (*sh));
+  clib_memset (sh, 0, sizeof (*sh));
   sh->heap = heap;
+  sh->ssvm_size = rnd_size;
+  sh->ssvm_va = pointer_to_uword (heap);
   sh->type = SSVM_SEGMENT_PRIVATE;
 
+  oldheap = ssvm_push_heap (sh);
+  sh->name = format (0, "%s", ssvm->name, 0);
+  ssvm_pop_heap (oldheap);
+
   return 0;
 }
 
 int
-ssvm_slave_init_private (ssvm_private_t * ssvm)
+ssvm_client_init_private (ssvm_private_t * ssvm)
 {
   clib_warning ("BUG: this should not be called!");
   return -1;
@@ -367,20 +425,20 @@ void
 ssvm_delete_private (ssvm_private_t * ssvm)
 {
   vec_free (ssvm->name);
-  mheap_free (ssvm->sh->heap);
-  clib_mem_free (ssvm->sh);
+  clib_mem_destroy_heap (ssvm->sh->heap);
+  clib_mem_vm_unmap (ssvm->sh);
 }
 
 int
-ssvm_master_init (ssvm_private_t * ssvm, ssvm_segment_type_t type)
+ssvm_server_init (ssvm_private_t * ssvm, ssvm_segment_type_t type)
 {
-  return (master_init_fns[type]) (ssvm);
+  return (server_init_fns[type]) (ssvm);
 }
 
 int
-ssvm_slave_init (ssvm_private_t * ssvm, ssvm_segment_type_t type)
+ssvm_client_init (ssvm_private_t * ssvm, ssvm_segment_type_t type)
 {
-  return (slave_init_fns[type]) (ssvm);
+  return (client_init_fns[type]) (ssvm);
 }
 
 void