session: add support for memfd segments
[vpp.git] / src / svm / svm_fifo_segment.c
index 2094ba7..4d1833e 100644 (file)
@@ -57,11 +57,12 @@ allocate_new_fifo_chunk (svm_fifo_segment_header_t * fsh,
 }
 
 static void
-preallocate_fifo_pairs (svm_fifo_segment_header_t * fsh,
-                       svm_fifo_segment_create_args_t * a)
+preallocate_fifo_pairs (svm_fifo_segment_private_t * s,
+                       svm_fifo_segment_create_args_t * a, u32 protect_size)
 {
-  u32 rx_fifo_size, tx_fifo_size;
-  u32 rx_rounded_data_size, tx_rounded_data_size;
+  svm_fifo_segment_header_t *fsh = s->h;
+  u32 rx_fifo_size, tx_fifo_size, pairs_to_allocate;
+  u32 rx_rounded_data_size, tx_rounded_data_size, pair_size;
   svm_fifo_t *f;
   u8 *rx_fifo_space, *tx_fifo_space;
   int rx_freelist_index, tx_freelist_index;
@@ -97,18 +98,18 @@ preallocate_fifo_pairs (svm_fifo_segment_header_t * fsh,
     - max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE);
 
   /* Calculate space requirements */
-  rx_fifo_size = (sizeof (*f) + rx_rounded_data_size)
-    * a->preallocated_fifo_pairs;
-  tx_fifo_size = (sizeof (*f) + tx_rounded_data_size)
-    * a->preallocated_fifo_pairs;
+  pair_size = 2 * sizeof (*f) + rx_rounded_data_size + tx_rounded_data_size;
+  if (protect_size)
+    protect_size += mheap_bytes (s->ssvm.sh->heap);
+  pairs_to_allocate =
+    clib_min ((s->ssvm.ssvm_size - protect_size) / pair_size,
+             a->preallocated_fifo_pairs);
+  rx_fifo_size = (sizeof (*f) + rx_rounded_data_size) * pairs_to_allocate;
+  tx_fifo_size = (sizeof (*f) + tx_rounded_data_size) * pairs_to_allocate;
 
   vec_validate_init_empty (fsh->free_fifos,
                           clib_max (rx_freelist_index, tx_freelist_index),
                           0);
-  if (0)
-    clib_warning ("rx_fifo_size %u (%d mb), tx_fifo_size %u (%d mb)",
-                 rx_fifo_size, rx_fifo_size >> 20,
-                 tx_fifo_size, tx_fifo_size >> 20);
 
   /* Allocate rx fifo space. May fail. */
   rx_fifo_space = clib_mem_alloc_aligned_at_offset
@@ -139,7 +140,7 @@ preallocate_fifo_pairs (svm_fifo_segment_header_t * fsh,
 
   /* Carve rx fifo space */
   f = (svm_fifo_t *) rx_fifo_space;
-  for (i = 0; i < a->preallocated_fifo_pairs; i++)
+  for (i = 0; i < pairs_to_allocate; i++)
     {
       f->freelist_index = rx_freelist_index;
       f->next = fsh->free_fifos[rx_freelist_index];
@@ -149,7 +150,7 @@ preallocate_fifo_pairs (svm_fifo_segment_header_t * fsh,
     }
   /* Carve tx fifo space */
   f = (svm_fifo_t *) tx_fifo_space;
-  for (i = 0; i < a->preallocated_fifo_pairs; i++)
+  for (i = 0; i < pairs_to_allocate; i++)
     {
       f->freelist_index = tx_freelist_index;
       f->next = fsh->free_fifos[tx_freelist_index];
@@ -157,18 +158,23 @@ preallocate_fifo_pairs (svm_fifo_segment_header_t * fsh,
       tx_fifo_space += sizeof (*f) + tx_rounded_data_size;
       f = (svm_fifo_t *) tx_fifo_space;
     }
+
+  /* Account for the pairs allocated */
+  a->preallocated_fifo_pairs -= pairs_to_allocate;
 }
 
-/** (master) create an svm fifo segment */
+/**
+ * Create an svm fifo segment and initialize as master
+ */
 int
 svm_fifo_segment_create (svm_fifo_segment_create_args_t * a)
 {
-  int rv;
-  svm_fifo_segment_private_t *s;
   svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
+  svm_fifo_segment_private_t *s;
   ssvm_shared_header_t *sh;
   svm_fifo_segment_header_t *fsh;
   void *oldheap;
+  int rv;
 
   /* Allocate a fresh segment */
   pool_get (sm->segments, s);
@@ -180,16 +186,14 @@ svm_fifo_segment_create (svm_fifo_segment_create_args_t * a)
   s->ssvm.name = format (0, "%s%c", a->segment_name, 0);
   s->ssvm.requested_va = sm->next_baseva;
 
-  rv = ssvm_master_init (&s->ssvm, s - sm->segments);
-
-  if (rv)
+  if ((rv = ssvm_master_init (&s->ssvm, a->segment_type)))
     {
-      _vec_len (s) = vec_len (s) - 1;
+      pool_put (sm->segments, s);
       return (rv);
     }
 
-  /* Note; requested_va updated due to seg base addr randomization */
-  sm->next_baseva = s->ssvm.requested_va + a->segment_size;
+  /* Note: requested_va updated due to seg base addr randomization */
+  sm->next_baseva = s->ssvm.sh->ssvm_va + a->segment_size;
 
   sh = s->ssvm.sh;
   oldheap = ssvm_push_heap (sh);
@@ -197,11 +201,8 @@ svm_fifo_segment_create (svm_fifo_segment_create_args_t * a)
   /* Set up svm_fifo_segment shared header */
   fsh = clib_mem_alloc (sizeof (*fsh));
   memset (fsh, 0, sizeof (*fsh));
-  sh->opaque[0] = fsh;
-  s->h = fsh;
-  fsh->segment_name = format (0, "%s%c", a->segment_name, 0);
-
-  preallocate_fifo_pairs (fsh, a);
+  s->h = sh->opaque[0] = fsh;
+  preallocate_fifo_pairs (s, a, a->seg_protected_space);
 
   ssvm_pop_heap (oldheap);
 
@@ -210,7 +211,9 @@ svm_fifo_segment_create (svm_fifo_segment_create_args_t * a)
   return (0);
 }
 
-/** Create an svm fifo segment in process-private memory */
+/**
+ * Create an svm fifo segment in process-private memory
+ */
 int
 svm_fifo_segment_create_process_private (svm_fifo_segment_create_args_t * a)
 {
@@ -222,29 +225,23 @@ svm_fifo_segment_create_process_private (svm_fifo_segment_create_args_t * a)
   u8 **heaps = 0;
   mheap_t *heap_header;
   int segment_count = 1;
+  u32 rnd_size = 0;
   int i;
 
-  if (a->private_segment_count && a->private_segment_size)
+  if (a->private_segment_count)
     {
-      void *mem;
       u8 *heap;
       u32 pagesize = clib_mem_get_page_size ();
-      u32 rnd_size;
+      rnd_size = (a->segment_size + (pagesize - 1)) & ~pagesize;
 
       for (i = 0; i < a->private_segment_count; i++)
        {
-         rnd_size = (a->private_segment_size + (pagesize - 1)) & ~pagesize;
-
-         mem = mmap (0, rnd_size, PROT_READ | PROT_WRITE,
-                     MAP_PRIVATE | MAP_ANONYMOUS,
-                     -1 /* fd */ , 0 /* offset */ );
-
-         if (mem == MAP_FAILED)
+         heap = mheap_alloc (0, rnd_size);
+         if (heap == 0)
            {
-             clib_unix_warning ("mmap");
+             clib_unix_warning ("mheap alloc");
              return -1;
            }
-         heap = mheap_alloc (mem, rnd_size);
          heap_header = mheap_header (heap);
          heap_header->flags |= MHEAP_FLAG_THREAD_SAFE;
          vec_add1 (heaps, heap);
@@ -252,16 +249,13 @@ svm_fifo_segment_create_process_private (svm_fifo_segment_create_args_t * a)
       segment_count = a->private_segment_count;
     }
 
-  /* Spread preallocated fifo pairs across segments */
-  a->preallocated_fifo_pairs /= segment_count;
-
   /* Allocate segments */
   for (i = 0; i < segment_count; i++)
     {
       pool_get (sm->segments, s);
       memset (s, 0, sizeof (*s));
 
-      s->ssvm.ssvm_size = ~0;
+      s->ssvm.ssvm_size = rnd_size;
       s->ssvm.i_am_master = 1;
       s->ssvm.my_pid = getpid ();
       s->ssvm.name = format (0, "%s%c", a->segment_name, 0);
@@ -277,18 +271,20 @@ svm_fifo_segment_create_process_private (svm_fifo_segment_create_args_t * a)
       /* Set up svm_fifo_segment shared header */
       fsh = clib_mem_alloc (sizeof (*fsh));
       memset (fsh, 0, sizeof (*fsh));
-      sh->opaque[0] = fsh;
-      s->h = fsh;
-      fsh->segment_name = format (0, "%s%c", a->segment_name, 0);
+      fsh->flags = FIFO_SEGMENT_F_IS_PRIVATE;
+      s->h = sh->opaque[0] = fsh;
+      if (!a->private_segment_count)
+       fsh->flags |= FIFO_SEGMENT_F_IS_MAIN_HEAP;
 
       if (a->private_segment_count)
        {
+         if (i != 0)
+           fsh->flags |= FIFO_SEGMENT_F_IS_PREALLOCATED;
          oldheap = clib_mem_get_heap ();
          clib_mem_set_heap (sh->heap);
-         preallocate_fifo_pairs (fsh, a);
+         preallocate_fifo_pairs (s, a, i == 0 ? a->seg_protected_space : 0);
          clib_mem_set_heap (oldheap);
        }
-
       sh->ready = 1;
       vec_add1 (a->new_segment_indices, s - sm->segments);
     }
@@ -296,15 +292,15 @@ svm_fifo_segment_create_process_private (svm_fifo_segment_create_args_t * a)
   return (0);
 }
 
-/** (slave) attach to an svm fifo segment */
+/**
+ * Attach as slave to an svm fifo segment
+ */
 int
 svm_fifo_segment_attach (svm_fifo_segment_create_args_t * a)
 {
-  int rv;
-  svm_fifo_segment_private_t *s;
   svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
-  ssvm_shared_header_t *sh;
-  svm_fifo_segment_header_t *fsh;
+  svm_fifo_segment_private_t *s;
+  int rv;
 
   /* Allocate a fresh segment */
   pool_get (sm->segments, s);
@@ -314,19 +310,19 @@ svm_fifo_segment_attach (svm_fifo_segment_create_args_t * a)
   s->ssvm.my_pid = getpid ();
   s->ssvm.name = format (0, "%s%c", a->segment_name, 0);
   s->ssvm.requested_va = sm->next_baseva;
+  if (a->segment_type == SSVM_SEGMENT_MEMFD)
+    s->ssvm.fd = a->memfd_fd;
+  else
+    s->ssvm.attach_timeout = sm->timeout_in_seconds;
 
-  rv = ssvm_slave_init (&s->ssvm, sm->timeout_in_seconds);
-
-  if (rv)
+  if ((rv = ssvm_slave_init (&s->ssvm, a->segment_type)))
     {
       _vec_len (s) = vec_len (s) - 1;
       return (rv);
     }
 
   /* Fish the segment header */
-  sh = s->ssvm.sh;
-  fsh = (svm_fifo_segment_header_t *) sh->opaque[0];
-  s->h = fsh;
+  s->h = s->ssvm.sh->opaque[0];
 
   vec_add1 (a->new_segment_indices, s - sm->segments);
   return (0);
@@ -336,10 +332,26 @@ void
 svm_fifo_segment_delete (svm_fifo_segment_private_t * s)
 {
   svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
-  ssvm_delete (&s->ssvm);
+
+  if (s->h->flags & FIFO_SEGMENT_F_IS_PRIVATE)
+    {
+      /* Don't try to free vpp's heap! */
+      if (!(s->h->flags & FIFO_SEGMENT_F_IS_MAIN_HEAP))
+       mheap_free (s->ssvm.sh->heap);
+      clib_mem_free (s->ssvm.sh);
+      clib_mem_free (s->h);
+    }
+  else
+    {
+      ssvm_delete (&s->ssvm);
+    }
+  memset (s, 0xfe, sizeof (*s));
   pool_put (sm->segments, s);
 }
 
+/**
+ * Allocate fifo in svm segment
+ */
 svm_fifo_t *
 svm_fifo_segment_alloc_fifo (svm_fifo_segment_private_t * s,
                             u32 data_size_in_bytes,
@@ -352,8 +364,8 @@ svm_fifo_segment_alloc_fifo (svm_fifo_segment_private_t * s,
   int freelist_index;
 
   /*
-   * 2K minimum. It's not likely that anything good will happen
-   * with a 1K FIFO.
+   * 4K minimum. It's not likely that anything good will happen
+   * with a smaller FIFO.
    */
   if (data_size_in_bytes < FIFO_SEGMENT_MIN_FIFO_SIZE ||
       data_size_in_bytes > FIFO_SEGMENT_MAX_FIFO_SIZE)
@@ -428,6 +440,7 @@ found:
        }
       fsh->fifos = f;
     }
+  fsh->n_active_fifos++;
 
   ssvm_pop_heap (oldheap);
   ssvm_unlock_non_recursive (sh);
@@ -453,7 +466,7 @@ svm_fifo_segment_free_fifo (svm_fifo_segment_private_t * s, svm_fifo_t * f,
 
   freelist_index = f->freelist_index;
 
-  ASSERT (freelist_index > 0 && freelist_index < vec_len (fsh->free_fifos));
+  ASSERT (freelist_index < vec_len (fsh->free_fifos));
 
   ssvm_lock_non_recursive (sh, 2);
   oldheap = ssvm_push_heap (sh);
@@ -489,6 +502,7 @@ svm_fifo_segment_free_fifo (svm_fifo_segment_private_t * s, svm_fifo_t * f,
       f->master_thread_index = ~0;
     }
 
+  fsh->n_active_fifos--;
   ssvm_pop_heap (oldheap);
   ssvm_unlock_non_recursive (sh);
 }
@@ -508,6 +522,162 @@ svm_fifo_segment_index (svm_fifo_segment_private_t * s)
   return s - svm_fifo_segment_main.segments;
 }
 
+/**
+ * Retrieve svm segments pool. Used only for debug purposes.
+ */
+svm_fifo_segment_private_t *
+svm_fifo_segment_segments_pool (void)
+{
+  svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
+  return sm->segments;
+}
+
+/**
+ * Get number of active fifos
+ */
+u32
+svm_fifo_segment_num_fifos (svm_fifo_segment_private_t * fifo_segment)
+{
+  return fifo_segment->h->n_active_fifos;
+}
+
+u32
+svm_fifo_segment_num_free_fifos (svm_fifo_segment_private_t * fifo_segment,
+                                u32 fifo_size_in_bytes)
+{
+  ssvm_shared_header_t *sh;
+  svm_fifo_segment_header_t *fsh;
+  svm_fifo_t *f;
+  int i;
+  u32 count = 0, rounded_data_size, freelist_index;
+
+  sh = fifo_segment->ssvm.sh;
+  fsh = (svm_fifo_segment_header_t *) sh->opaque[0];
+
+  /* Count all free fifos? */
+  if (fifo_size_in_bytes == ~0)
+    {
+      for (i = 0; i < vec_len (fsh->free_fifos); i++)
+       {
+         f = fsh->free_fifos[i];
+         if (f == 0)
+           continue;
+
+         while (f)
+           {
+             f = f->next;
+             count++;
+           }
+       }
+      return count;
+    }
+
+  rounded_data_size = (1 << (max_log2 (fifo_size_in_bytes)));
+  freelist_index = max_log2 (rounded_data_size)
+    - max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE);
+
+  if (freelist_index > vec_len (fsh->free_fifos))
+    return 0;
+
+  f = fsh->free_fifos[freelist_index];
+  if (f == 0)
+    return 0;
+
+  while (f)
+    {
+      f = f->next;
+      count++;
+    }
+  return count;
+}
+
+void
+svm_fifo_segment_info (svm_fifo_segment_private_t * seg, uword * address,
+                      u64 * size)
+{
+  if (seg->h->flags & FIFO_SEGMENT_F_IS_PRIVATE)
+    {
+      mheap_t *heap_header;
+
+      *address = pointer_to_uword (seg->ssvm.sh->heap);
+      heap_header = mheap_header (seg->ssvm.sh->heap);
+      *size = heap_header->max_size;
+    }
+  else
+    {
+      *address = seg->ssvm.sh->ssvm_va;
+      *size = seg->ssvm.ssvm_size;
+    }
+}
+
+mheap_t *
+svm_fifo_segment_heap (svm_fifo_segment_private_t * seg)
+{
+  return seg->ssvm.sh->heap;
+}
+
+u8 *
+format_svm_fifo_segment_type (u8 * s, va_list * args)
+{
+  svm_fifo_segment_private_t *sp;
+  sp = va_arg (*args, svm_fifo_segment_private_t *);
+  ssvm_segment_type_t st = ssvm_type (&sp->ssvm);
+
+  if ((sp->h->flags & FIFO_SEGMENT_F_IS_PRIVATE)
+      && !(sp->h->flags & FIFO_SEGMENT_F_IS_MAIN_HEAP))
+    s = format (s, "%s", "private-heap");
+  else if ((sp->h->flags & FIFO_SEGMENT_F_IS_PRIVATE)
+          && (sp->h->flags & FIFO_SEGMENT_F_IS_MAIN_HEAP))
+    s = format (s, "%s", "main-heap");
+  else if (st == SSVM_SEGMENT_MEMFD)
+    s = format (s, "%s", "memfd");
+  else if (st == SSVM_SEGMENT_SHM)
+    s = format (s, "%s", "shm");
+  else
+    s = format (s, "%s", "unknown");
+  return s;
+}
+
+/**
+ * Segment format function
+ */
+u8 *
+format_svm_fifo_segment (u8 * s, va_list * args)
+{
+  svm_fifo_segment_private_t *sp
+    = va_arg (*args, svm_fifo_segment_private_t *);
+  int verbose = va_arg (*args, int);
+  svm_fifo_segment_header_t *fsh = sp->h;
+  u32 count, indent;
+  svm_fifo_t *f;
+  int i;
+
+  indent = format_get_indent (s) + 2;
+  s = format (s, "%U segment heap: %U\n", format_white_space, indent,
+             format_mheap, svm_fifo_segment_heap (sp), verbose);
+  s = format (s, "%U segment has %u active fifos\n",
+             format_white_space, indent, svm_fifo_segment_num_fifos (sp));
+
+  for (i = 0; i < vec_len (fsh->free_fifos); i++)
+    {
+      f = fsh->free_fifos[i];
+      if (f == 0)
+       continue;
+      count = 0;
+      while (f)
+       {
+         f = f->next;
+         count++;
+       }
+
+      s = format (s, "%U%-5u Kb: %u free",
+                 format_white_space, indent + 2,
+                 1 << (i + max_log2 (FIFO_SEGMENT_MIN_FIFO_SIZE) - 10),
+                 count);
+    }
+  return s;
+}
+
 /*
  * fd.io coding-style-patch-verification: ON
  *