svm: improve fifo segment test
[vpp.git] / src / plugins / unittest / svm_fifo_test.c
index 7d83b10..bf633b7 100644 (file)
@@ -1908,7 +1908,6 @@ sfifo_test_fifo_segment_hello_world (int verbose)
   a->segment_size = 256 << 10;
 
   rv = fifo_segment_create (sm, a);
-
   SFIFO_TEST (!rv, "svm_fifo_segment_create returned %d", rv);
 
   fs = fifo_segment_get_segment (sm, a->new_segment_indices[0]);
@@ -1945,16 +1944,21 @@ sfifo_test_fifo_segment_hello_world (int verbose)
 static int
 sfifo_test_fifo_segment_fifo_grow (int verbose)
 {
+  int rv, fifo_size = 4096, n_chunks, n_batch;
   fifo_segment_main_t *sm = &segment_main;
   fifo_segment_create_args_t _a, *a = &_a;
-  int rv, fifo_size = 4096, n_chunks;
+  u32 n_free_chunk_bytes;
   fifo_segment_t *fs;
   svm_fifo_t *f;
 
   clib_memset (a, 0, sizeof (*a));
   a->segment_name = "fifo-test1";
+  /* size chosen to be able to force multi chunk allocation lower */
   a->segment_size = 256 << 10;
 
+  /* fifo allocation allocates chunks in batch */
+  n_batch = FIFO_SEGMENT_ALLOC_BATCH_SIZE;
+
   rv = fifo_segment_create (sm, a);
 
   SFIFO_TEST (!rv, "svm_fifo_segment_create returned %d", rv);
@@ -1967,27 +1971,55 @@ sfifo_test_fifo_segment_fifo_grow (int verbose)
 
   SFIFO_TEST (f != 0, "svm_fifo_segment_alloc_fifo");
 
+  n_chunks = fifo_segment_num_free_chunks (fs, fifo_size);
+  SFIFO_TEST (n_chunks == n_batch - 1, "free 2^10B chunks "
+             "should be %u is %u", n_batch - 1, n_chunks);
+  rv = fifo_segment_fl_chunk_bytes (fs);
+  SFIFO_TEST (rv == (n_batch - 1) * fifo_size, "free chunk bytes %u "
+             "expected %u", rv, (n_batch - 1) * fifo_size);
+
+  /* Grow by preallocated fifo_size chunk */
   fifo_segment_grow_fifo (fs, f, fifo_size);
   SFIFO_TEST (f->size == 2 * fifo_size, "fifo size should be %u is %u",
              2 * fifo_size, f->size);
 
+  n_chunks = fifo_segment_num_free_chunks (fs, fifo_size);
+  SFIFO_TEST (n_chunks == n_batch - 2, "free 2^10B chunks "
+             "should be %u is %u", n_batch - 2, n_chunks);
+  rv = fifo_segment_fl_chunk_bytes (fs);
+  SFIFO_TEST (rv == (n_batch - 2) * fifo_size, "free chunk bytes %u "
+             "expected %u", rv, (n_batch - 2) * fifo_size);
+
+  /* Grow by a size not preallocated but first make sure there's space */
+  rv = fifo_segment_free_bytes (fs);
+  SFIFO_TEST (rv > 16 * fifo_size, "free bytes %u more than %u", rv,
+             16 * fifo_size);
+
   fifo_segment_grow_fifo (fs, f, 16 * fifo_size);
   SFIFO_TEST (f->size == 18 * fifo_size, "fifo size should be %u is %u",
              18 * fifo_size, f->size);
 
+  rv = fifo_segment_fl_chunk_bytes (fs);
+  SFIFO_TEST (rv == (n_batch - 2) * fifo_size, "free chunk bytes %u "
+             "expected %u", rv, (n_batch - 2) * fifo_size);
+
   /*
    * Free and test free list size
    */
   fifo_segment_free_fifo (fs, f);
 
+  rv = fifo_segment_fl_chunk_bytes (fs);
+  SFIFO_TEST (rv == (16 + n_batch) * fifo_size, "free chunk bytes expected %u"
+             " is %u", (16 + n_batch) * fifo_size, rv);
   n_chunks = fifo_segment_num_free_chunks (fs, fifo_size);
-  SFIFO_TEST (n_chunks == 1, "free 2^10B chunks should be %u is %u", 1,
-             n_chunks);
+  SFIFO_TEST (n_chunks == n_batch, "free 2^10B chunks "
+             "should be %u is %u", n_batch, n_chunks);
   n_chunks = fifo_segment_num_free_chunks (fs, 16 * fifo_size);
   SFIFO_TEST (n_chunks == 1, "free 2^14B chunks should be %u is %u", 1,
              n_chunks);
   n_chunks = fifo_segment_num_free_chunks (fs, ~0);
-  SFIFO_TEST (n_chunks == 2, "free chunks should be %u is %u", 2, n_chunks);
+  SFIFO_TEST (n_chunks == 1 + n_batch, "free chunks should be %u is %u",
+             1 + n_batch, n_chunks);
 
   /*
    * Realloc fifo
@@ -1996,21 +2028,179 @@ sfifo_test_fifo_segment_fifo_grow (int verbose)
 
   fifo_segment_grow_fifo (fs, f, fifo_size);
   n_chunks = fifo_segment_num_free_chunks (fs, fifo_size);
-  SFIFO_TEST (n_chunks == 0, "free 2^10B chunks should be %u is %u", 0,
-             n_chunks);
+  SFIFO_TEST (n_chunks == n_batch - 2, "free 2^10B chunks should be %u is %u",
+             n_batch - 2, n_chunks);
 
   fifo_segment_grow_fifo (fs, f, 16 * fifo_size);
+  n_chunks = fifo_segment_num_free_chunks (fs, 16 * fifo_size);
   SFIFO_TEST (n_chunks == 0, "free 2^14B chunks should be %u is %u", 0,
              n_chunks);
   n_chunks = fifo_segment_num_free_chunks (fs, ~0);
-  SFIFO_TEST (n_chunks == 0, "free chunks should be %u is %u", 0, n_chunks);
+  SFIFO_TEST (n_chunks == n_batch - 2, "free chunks should be %u is %u",
+             n_batch - 2, n_chunks);
 
   /*
    * Free again
    */
   fifo_segment_free_fifo (fs, f);
   n_chunks = fifo_segment_num_free_chunks (fs, ~0);
-  SFIFO_TEST (n_chunks == 2, "free chunks should be %u is %u", 2, n_chunks);
+  SFIFO_TEST (n_chunks == 1 + n_batch, "free chunks should be %u is %u",
+             1 + n_batch, n_chunks);
+
+  rv = fifo_segment_fl_chunk_bytes (fs);
+  SFIFO_TEST (rv == (16 + n_batch) * fifo_size, "free chunk bytes expected %u"
+             " is %u", (16 + n_batch) * fifo_size, rv);
+
+  n_free_chunk_bytes = rv;
+
+  /*
+   * Allocate non power of 2 fifo/chunk and check that free chunk bytes
+   * is correctly updated
+   */
+
+  f = fifo_segment_alloc_fifo (fs, 16 * fifo_size - 1, FIFO_SEGMENT_RX_FIFO);
+  rv = fifo_segment_fl_chunk_bytes (fs);
+
+  SFIFO_TEST (n_free_chunk_bytes - 16 * fifo_size == rv, "free chunk bytes "
+             "expected %u is %u", n_free_chunk_bytes - 16 * fifo_size, rv);
+
+  fifo_segment_free_fifo (fs, f);
+  rv = fifo_segment_fl_chunk_bytes (fs);
+
+  SFIFO_TEST (n_free_chunk_bytes == rv, "free chunk bytes expected %u is %u",
+             n_free_chunk_bytes, rv);
+
+  /*
+   * Force multi chunk fifo allocation
+   */
+
+  /* Check that we can force multi chunk allocation. Note that fifo size
+   * rounded up to power of 2, i.e., 17 becomes 32 */
+  rv = fifo_segment_free_bytes (fs);
+  SFIFO_TEST (rv < 32 * fifo_size, "free bytes %u less than %u", rv,
+             32 * fifo_size);
+
+  f = fifo_segment_alloc_fifo (fs, 17 * fifo_size, FIFO_SEGMENT_RX_FIFO);
+  rv = fifo_segment_fl_chunk_bytes (fs);
+
+  /* Make sure that the non-power of two chunk freed above is correctly
+   * accounted for in the chunk free bytes reduction due to chunk allocation
+   * for the fifo, i.e., it's rounded up by 1 */
+  SFIFO_TEST (n_free_chunk_bytes - 17 * fifo_size == rv, "free chunk bytes "
+             "expected %u is %u", n_free_chunk_bytes - 17 * fifo_size, rv);
+
+  fifo_segment_free_fifo (fs, f);
+
+  rv = fifo_segment_fl_chunk_bytes (fs);
+  SFIFO_TEST (n_free_chunk_bytes == rv, "free chunk bytes expected %u is %u",
+             n_free_chunk_bytes, rv);
+
+  /*
+   * Allocate fifo that has all chunks
+   */
+  f = fifo_segment_alloc_fifo (fs, n_free_chunk_bytes, FIFO_SEGMENT_RX_FIFO);
+  SFIFO_TEST (f != 0, "allocation should work");
+
+  fifo_segment_free_fifo (fs, f);
+
+  rv = fifo_segment_fl_chunk_bytes (fs);
+  SFIFO_TEST (n_free_chunk_bytes == rv, "free chunk bytes expected %u is %u",
+             n_free_chunk_bytes, rv);
+
+  /*
+   * Try to allocate more than space available
+   */
+
+  f = fifo_segment_alloc_fifo (fs, n_free_chunk_bytes + fifo_size,
+                              FIFO_SEGMENT_RX_FIFO);
+  SFIFO_TEST (f == 0, "allocation should fail");
+
+  /*
+   * Allocate fifo and try to grow beyond available space
+   */
+  f = fifo_segment_alloc_fifo (fs, fifo_size, FIFO_SEGMENT_RX_FIFO);
+  rv = fifo_segment_grow_fifo (fs, f, n_free_chunk_bytes);
+
+  SFIFO_TEST (rv == -1, "grow should fail");
+
+  fifo_segment_free_fifo (fs, f);
+
+  /*
+   * Cleanup
+   */
+  fifo_segment_delete (sm, fs);
+  vec_free (a->new_segment_indices);
+  return 0;
+}
+
+static int
+sfifo_test_fifo_segment_fifo_shrink (int verbose)
+{
+  int i, rv, chunk_size = 4096, n_chunks, n_free;
+  fifo_segment_main_t *sm = &segment_main;
+  fifo_segment_create_args_t _a, *a = &_a;
+  fifo_segment_t *fs;
+  svm_fifo_t *f;
+
+  clib_memset (a, 0, sizeof (*a));
+  a->segment_name = "fifo-test1";
+  a->segment_size = 256 << 10;
+
+  rv = fifo_segment_create (sm, a);
+
+  SFIFO_TEST (!rv, "svm_fifo_segment_create returned %d", rv);
+
+  /*
+   * Alloc and grow fifo
+   */
+  fs = fifo_segment_get_segment (sm, a->new_segment_indices[0]);
+  f = fifo_segment_alloc_fifo (fs, chunk_size, FIFO_SEGMENT_RX_FIFO);
+  n_free = FIFO_SEGMENT_ALLOC_BATCH_SIZE - 1;
+
+  SFIFO_TEST (f != 0, "svm_fifo_segment_alloc_fifo");
+
+  for (i = 0; i < 9; i++)
+    {
+      fifo_segment_grow_fifo (fs, f, chunk_size);
+      n_free -= 1;
+      if (f->size != (i + 2) * chunk_size)
+       SFIFO_TEST (0, "fifo size should be %u is %u",
+                   (i + 2) * chunk_size, f->size);
+    }
+
+  rv = svm_fifo_reduce_size (f, 3.5 * chunk_size, 1 /* is producer */ );
+  SFIFO_TEST (rv == 3 * chunk_size, "len expected %u is %u", 3 * chunk_size,
+             rv);
+
+  n_chunks = fifo_segment_num_free_chunks (fs, chunk_size);
+  SFIFO_TEST (n_chunks == n_free, "free chunks should be %u is %u", n_free,
+             n_chunks);
+
+  fifo_segment_collect_fifo_chunks (fs, f);
+
+  n_free += 3;
+  n_chunks = fifo_segment_num_free_chunks (fs, chunk_size);
+  SFIFO_TEST (n_chunks == n_free, "free chunks should be %u is %u", n_free,
+             n_chunks);
+
+  rv = svm_fifo_reduce_size (f, 7 * chunk_size - 1, 1 /* is producer */ );
+  SFIFO_TEST (rv == 6 * chunk_size, "len expected %u is %u", 6 * chunk_size,
+             rv);
+
+  fifo_segment_collect_fifo_chunks (fs, f);
+
+  n_free += 6;
+  n_chunks = fifo_segment_num_free_chunks (fs, chunk_size);
+  SFIFO_TEST (n_chunks == n_free, "free chunks should be %u is %u", n_free,
+             n_chunks);
+  /*
+   * Free
+   */
+  fifo_segment_free_fifo (fs, f);
+  n_free += 1;
+  n_chunks = fifo_segment_num_free_chunks (fs, ~0);
+  SFIFO_TEST (n_chunks == n_free, "free chunks should be %u is %u", n_free,
+             n_chunks);
 
   /*
    * Cleanup
@@ -2190,11 +2380,117 @@ sfifo_test_fifo_segment_mempig (int verbose)
   return 0;
 }
 
+static int
+sfifo_test_fifo_segment_prealloc (int verbose)
+{
+  fifo_segment_create_args_t _a, *a = &_a;
+  fifo_segment_main_t *sm = &segment_main;
+  u32 max_pairs, pairs_req, free_space, pair_mem;
+  svm_fifo_t *f, *old;
+  fifo_segment_t *fs;
+  int rv;
+
+  clib_memset (a, 0, sizeof (*a));
+
+  a->segment_name = "fifo-test-prealloc";
+  a->segment_size = 256 << 10;
+  a->segment_type = SSVM_SEGMENT_MEMFD;
+
+  rv = fifo_segment_create (sm, a);
+  SFIFO_TEST (!rv, "svm_fifo_segment_create returned %d", rv);
+  fs = fifo_segment_get_segment (sm, a->new_segment_indices[0]);
+
+  /*
+   * Prealloc chunks and headers
+   */
+  free_space = fifo_segment_free_bytes (fs);
+  SFIFO_TEST (free_space <= 256 << 10, "free space expected %u is %u",
+             256 << 10, free_space);
+  rv = fifo_segment_prealloc_fifo_chunks (fs, 4096, 50);
+  SFIFO_TEST (rv == 0, "chunk prealloc should work");
+  rv = fifo_segment_num_free_chunks (fs, 4096);
+  SFIFO_TEST (rv == 50, "prealloc chunks expected %u is %u", 50, rv);
+  rv = fifo_segment_free_bytes (fs);
+  free_space -= (sizeof (svm_fifo_chunk_t) + 4096) * 50;
+  SFIFO_TEST (rv == free_space, "free space expected %u is %u", free_space,
+             rv);
+  rv = fifo_segment_fl_chunk_bytes (fs);
+  SFIFO_TEST (rv == 4096 * 50, "chunk free space expected %u is %u",
+             4096 * 50, rv);
+
+  rv = fifo_segment_prealloc_fifo_hdrs (fs, 50);
+  SFIFO_TEST (rv == 0, "fifo hdr prealloc should work");
+  rv = fifo_segment_num_free_fifos (fs);
+  SFIFO_TEST (rv == 50, "prealloc fifo hdrs expected %u is %u", 50, rv);
+  rv = fifo_segment_free_bytes (fs);
+  free_space -= sizeof (svm_fifo_t) * 50;
+  SFIFO_TEST (rv == free_space, "free space expected %u is %u", free_space,
+             rv);
+
+  fifo_segment_update_free_bytes (fs);
+  rv = fifo_segment_free_bytes (fs);
+  SFIFO_TEST (clib_abs (rv - (int) free_space) < 512,
+             "free space expected %u is %u", free_space, rv);
+
+  f = fifo_segment_alloc_fifo (fs, 200 << 10, FIFO_SEGMENT_RX_FIFO);
+  SFIFO_TEST (f != 0, "fifo allocated");
+  rv = fifo_segment_num_free_chunks (fs, 4096);
+  SFIFO_TEST (rv == 0, "prealloc chunks expected %u is %u", 0, rv);
+  rv = fifo_segment_fl_chunk_bytes (fs);
+  SFIFO_TEST (rv == 0, "chunk free space expected %u is %u", 0, rv);
+
+  /*
+   * Multiple preallocs that consume the remaining space
+   */
+  pair_mem = 2 * (4096 + sizeof (*f) + sizeof (svm_fifo_chunk_t));
+  max_pairs = pairs_req = free_space / pair_mem - 1;
+  fifo_segment_preallocate_fifo_pairs (fs, 4096, 4096, &pairs_req);
+  SFIFO_TEST (pairs_req == 0, "prealloc pairs should work");
+  rv = fifo_segment_num_free_chunks (fs, 4096);
+  SFIFO_TEST (rv == max_pairs * 2, "prealloc chunks expected %u is %u",
+             max_pairs * 2, rv);
+
+  rv = fifo_segment_prealloc_fifo_chunks (fs, 4096, 2);
+  SFIFO_TEST (rv == 0, "chunk prealloc should work");
+  rv = fifo_segment_num_free_chunks (fs, 4096);
+  SFIFO_TEST (rv == (max_pairs + 1) * 2, "prealloc chunks expected %u is %u",
+             (max_pairs + 1) * 2, rv);
+
+  free_space = fifo_segment_free_bytes (fs);
+  SFIFO_TEST (rv < 8192, "free bytes expected less than %u is %u", 8192, rv);
+
+  /*
+   * Test negative prealloc cases
+   */
+  pairs_req = 1;
+  fifo_segment_preallocate_fifo_pairs (fs, 4096, 4096, &pairs_req);
+  SFIFO_TEST (pairs_req == 1, "prealloc pairs should not work");
+
+  old = f;
+  f = fifo_segment_alloc_fifo (fs, 200 << 10, FIFO_SEGMENT_RX_FIFO);
+  SFIFO_TEST (f == 0, "fifo alloc should fail");
+
+  rv = fifo_segment_prealloc_fifo_chunks (fs, 4096, 50);
+  SFIFO_TEST (rv == -1, "chunk prealloc should fail");
+
+  rv = fifo_segment_prealloc_fifo_hdrs (fs, 50);
+  SFIFO_TEST (rv == -1, "fifo hdr prealloc should fail");
+
+  /*
+   * Cleanup
+   */
+  fifo_segment_free_fifo (fs, old);
+  close (fs->ssvm.fd);
+  fifo_segment_delete (sm, fs);
+  return 0;
+}
+
 static int
 sfifo_test_fifo_segment (vlib_main_t * vm, unformat_input_t * input)
 {
   int rv, verbose = 0;
 
+  fifo_segment_main_init (&segment_main, 3ULL << 30, 5);
   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
     {
       if (unformat (input, "verbose"))
@@ -2219,6 +2515,16 @@ sfifo_test_fifo_segment (vlib_main_t * vm, unformat_input_t * input)
          if ((rv = sfifo_test_fifo_segment_fifo_grow (verbose)))
            return -1;
        }
+      else if (unformat (input, "shrink fifo"))
+       {
+         if ((rv = sfifo_test_fifo_segment_fifo_shrink (verbose)))
+           return -1;
+       }
+      else if (unformat (input, "prealloc"))
+       {
+         if ((rv = sfifo_test_fifo_segment_prealloc (verbose)))
+           return -1;
+       }
       else if (unformat (input, "all"))
        {
          if ((rv = sfifo_test_fifo_segment_hello_world (verbose)))
@@ -2227,6 +2533,10 @@ sfifo_test_fifo_segment (vlib_main_t * vm, unformat_input_t * input)
            return -1;
          if ((rv = sfifo_test_fifo_segment_fifo_grow (verbose)))
            return -1;
+         if ((rv = sfifo_test_fifo_segment_fifo_shrink (verbose)))
+           return -1;
+         if ((rv = sfifo_test_fifo_segment_prealloc (verbose)))
+           return -1;
          /* Pretty slow so avoid running it always
             if ((rv = sfifo_test_fifo_segment_master_slave (verbose)))
             return -1;
@@ -2249,6 +2559,7 @@ svm_fifo_test (vlib_main_t * vm, unformat_input_t * input,
   int res = 0;
   char *str;
 
+
   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
     {
       if (unformat (input, "fifo1"))