sparsemap/tests/test.c

/*
 * smartmap is MIT-licensed, but for this file:
 *
 * To the extent possible under law, the author(s) of this file have
 * waived all copyright and related or neighboring rights to this
 * work.  See <https://creativecommons.org/publicdomain/zero/1.0/> for
 * details.
 */

#define MUNIT_NO_FORK (1)
#define MUNIT_ENABLE_ASSERT_ALIASES (1)

#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>

#include "../include/sparsemap.h"
#include "common.h"
#include "munit.h"

#if defined(_MSC_VER)
#pragma warning(disable : 4127)
#endif

/* !!! Duplicated here for testing purposes. Keep in sync, or suffer. !!! */
struct sparsemap {
  uint8_t *m_data;
  size_t m_capacity;
  size_t m_data_used;
};

struct user_data {
  int foo;
};

/* -------------------------- Supporting Functions for Testing */

void
populate_map(sparsemap_t *map, int size, int max_value)
{
  int array[size];

  setup_test_array(array, size, max_value);
  // TODO ensure_sequential_set(array, size, 10);
  shuffle(array, size);
  for (int i = 0; i < size; i++) {
    sparsemap_set(map, array[i], true);
    bool set = sparsemap_is_set(map, array[i]);
    munit_assert_true(set);
  }
}

static void *
test_api_setup(const MunitParameter params[], void *user_data)
{
  struct test_info *info = (struct test_info *)user_data;
  (void)info;
  (void)params;
  sparsemap_t *map = munit_calloc(1, sizeof(sparsemap_t));
  assert_ptr_not_null(map);
  return (void *)(uintptr_t)map;
}

static void
test_api_tear_down(void *fixture)
{
  sparsemap_t *map = (sparsemap_t *)fixture;
  assert_ptr_not_null(map);
  free(map);
}

/* -------------------------- API Tests */

static MunitResult
test_api_static_init(const MunitParameter params[], void *data)
{
  sparsemap_t a_map, *map = &a_map;
  uint8_t buf[1024] = { 0 };

  (void)params;
  (void)data;

  assert_ptr_not_null(map);
  sparsemap_init(map, buf, 1024);
  assert_ptr_equal(&buf, map->m_data);
  assert_true(map->m_capacity == 1024);
  assert_true(map->m_data_used == sizeof(uint32_t));

  return MUNIT_OK;
}

static void *
test_api_clear_setup(const MunitParameter params[], void *user_data)
{
  uint8_t *buf = munit_calloc(1024, sizeof(uint8_t));
  sparsemap_t *map = (sparsemap_t *)test_api_setup(params, user_data);

  sparsemap_init(map, buf, 1024);

  return (void *)map;
}
static void
test_api_clear_tear_down(void *fixture)
{
  sparsemap_t *map = (sparsemap_t *)fixture;
  free(map->m_data);
  test_api_tear_down(fixture);
}
static MunitResult
test_api_clear(const MunitParameter params[], void *data)
{
  sparsemap_t *map = (sparsemap_t *)data;
  (void)params;

  assert_ptr_not_null(map);

  sparsemap_set(map, 42, true);
  assert_true(sparsemap_is_set(map, 42));
  sparsemap_clear(map);
  assert_false(sparsemap_is_set(map, 42));

  return MUNIT_OK;
}

static void *
test_api_open_setup(const MunitParameter params[], void *user_data)
{
  uint8_t *buf = munit_calloc(1024, sizeof(uint8_t));
  sparsemap_t *map = (sparsemap_t *)test_api_setup(params, user_data);

  sparsemap_init(map, buf, 1024);
  populate_map(map, 1024, 3 * 1024);

  return (void *)map;
}
static void
test_api_open_tear_down(void *fixture)
{
  sparsemap_t *map = (sparsemap_t *)fixture;
  free(map->m_data);
  test_api_tear_down(fixture);
}
static MunitResult
test_api_open(const MunitParameter params[], void *data)
{
  sparsemap_t _sm, *sm = &_sm, *map = (sparsemap_t *)data;
  (void)params;

  assert_ptr_not_null(map);

  sparsemap_open(sm, (uint8_t *)map->m_data, map->m_capacity);
  for (int i = 0; i < 3 * 1024; i++) {
    assert_true(sparsemap_is_set(sm, i) == sparsemap_is_set(map, i));
  }

  return MUNIT_OK;
}

static void *
test_api_set_data_size_setup(const MunitParameter params[], void *user_data)
{
  uint8_t *buf = munit_calloc(1024, sizeof(uint8_t));
  sparsemap_t *map = (sparsemap_t *)test_api_setup(params, user_data);

  sparsemap_init(map, buf, 1024);
  populate_map(map, 1024, 3 * 1024);

  return (void *)map;
}
static void
test_api_set_data_size_tear_down(void *fixture)
{
  sparsemap_t *map = (sparsemap_t *)fixture;
  free(map->m_data);
  test_api_tear_down(fixture);
}
static MunitResult
test_api_set_data_size(const MunitParameter params[], void *data)
{
  sparsemap_t *map = (sparsemap_t *)data;
  (void)params;

  assert_ptr_not_null(map);
  assert_true(map->m_capacity == 1024);
  assert_true(map->m_capacity == sparsemap_get_capacity(map));
  sparsemap_set_data_size(map, 512);
  assert_true(map->m_capacity == 512);
  assert_true(map->m_capacity == sparsemap_get_capacity(map));
  return MUNIT_OK;
}

static void *
test_api_remaining_capacity_setup(const MunitParameter params[], void *user_data)
{
  uint8_t *buf = munit_calloc(1024, sizeof(uint8_t));
  sparsemap_t *map = (sparsemap_t *)test_api_setup(params, user_data);

  sparsemap_init(map, buf, 1024);

  return (void *)map;
}
static void
test_api_remaining_capacity_tear_down(void *fixture)
{
  sparsemap_t *map = (sparsemap_t *)fixture;
  free(map->m_data);
  test_api_tear_down(fixture);
}
static MunitResult
test_api_remaining_capacity(const MunitParameter params[], void *data)
{
  sparsemap_t *map = (sparsemap_t *)data;
  (void)params;

  assert_ptr_not_null(map);

  int i = 0;
  double cap;
  do {
    sparsemap_set(map, i++, true);
    cap = sparsemap_capacity_remaining(map);
  } while (cap > 1.0);
  // assert_true(i == 169985); when seed is 8675309
  assert_true(cap <= 1.0);

  sparsemap_clear(map);
  i = 0;
  do {
    int p = munit_rand_int_range(0, 150000);
    sparsemap_set(map, p, true);
    i++;
    cap = sparsemap_capacity_remaining(map);
  } while (cap > 2.0);
  // assert_true(i == 64); when seed is 8675309
  assert_true(cap <= 2.0);

  return MUNIT_OK;
}

static void *
test_api_get_capacity_setup(const MunitParameter params[], void *user_data)
{
  uint8_t *buf = munit_calloc(1024, sizeof(uint8_t));
  sparsemap_t *map = (sparsemap_t *)test_api_setup(params, user_data);

  sparsemap_init(map, buf, 1024);
  populate_map(map, 1024, 3 * 1024);

  return (void *)map;
}
static void
test_api_get_capacity_tear_down(void *fixture)
{
  sparsemap_t *map = (sparsemap_t *)fixture;
  free(map->m_data);
  test_api_tear_down(fixture);
}
static MunitResult
test_api_get_capacity(const MunitParameter params[], void *data)
{
  sparsemap_t *map = (sparsemap_t *)data;
  (void)params;

  assert_ptr_not_null(map);

  sparsemap_set(map, 42, true);
  assert_true(sparsemap_is_set(map, 42));
  assert_true(sparsemap_get_capacity(map) == 1024);

  return MUNIT_OK;
}

static void *
test_api_is_set_setup(const MunitParameter params[], void *user_data)
{
  uint8_t *buf = munit_calloc(1024, sizeof(uint8_t));
  sparsemap_t *map = (sparsemap_t *)test_api_setup(params, user_data);

  sparsemap_init(map, buf, 1024);
  populate_map(map, 1024, 3 * 1024);

  return (void *)map;
}
static void
test_api_is_set_tear_down(void *fixture)
{
  sparsemap_t *map = (sparsemap_t *)fixture;
  free(map->m_data);
  test_api_tear_down(fixture);
}
static MunitResult
test_api_is_set(const MunitParameter params[], void *data)
{
  sparsemap_t *map = (sparsemap_t *)data;
  (void)params;

  assert_ptr_not_null(map);

  sparsemap_set(map, 42, true);
  assert_true(sparsemap_is_set(map, 42));

  return MUNIT_OK;
}

static void *
test_api_set_setup(const MunitParameter params[], void *user_data)
{
  uint8_t *buf = munit_calloc(1024, sizeof(uint8_t));
  sparsemap_t *map = (sparsemap_t *)test_api_setup(params, user_data);

  sparsemap_init(map, buf, 1024);

  return (void *)map;
}
static void
test_api_set_tear_down(void *fixture)
{
  sparsemap_t *map = (sparsemap_t *)fixture;
  free(map->m_data);
  test_api_tear_down(fixture);
}
static MunitResult
test_api_set(const MunitParameter params[], void *data)
{
  sparsemap_t *map = (sparsemap_t *)data;
  (void)params;

  assert_ptr_not_null(map);

  assert_false(sparsemap_is_set(map, 1));
  assert_false(sparsemap_is_set(map, 8192));
  sparsemap_set(map, 1, true);
  sparsemap_set(map, 8192, true);
  assert_true(sparsemap_is_set(map, 1));
  assert_true(sparsemap_is_set(map, 8192));
  sparsemap_set(map, 1, false);
  sparsemap_set(map, 8192, false);
  assert_false(sparsemap_is_set(map, 1));
  assert_false(sparsemap_is_set(map, 8192));

  return MUNIT_OK;
}

static void *
test_api_get_starting_offset_setup(const MunitParameter params[], void *user_data)
{
  uint8_t *buf = munit_calloc(1024, sizeof(uint8_t));
  sparsemap_t *map = (sparsemap_t *)test_api_setup(params, user_data);

  sparsemap_init(map, buf, 1024);
  populate_map(map, 1024, 3 * 1024);

  return (void *)map;
}
static void
test_api_get_starting_offset_tear_down(void *fixture)
{
  sparsemap_t *map = (sparsemap_t *)fixture;
  free(map->m_data);
  test_api_tear_down(fixture);
}
static MunitResult
test_api_get_starting_offset(const MunitParameter params[], void *data)
{
  sparsemap_t *map = (sparsemap_t *)data;
  (void)params;

  assert_ptr_not_null(map);

  sparsemap_set(map, 42, true);
  assert_true(sparsemap_is_set(map, 42));
  size_t offset = sparsemap_get_starting_offset(map);
  assert_true(offset == 0);

  return MUNIT_OK;
}

static void *
test_api_get_size_setup(const MunitParameter params[], void *user_data)
{
  uint8_t *buf = munit_calloc(1024, sizeof(uint8_t));
  sparsemap_t *map = (sparsemap_t *)test_api_setup(params, user_data);

  sparsemap_init(map, buf, 1024);
  populate_map(map, 1024, 3 * 1024);

  return (void *)map;
}
static void
test_api_get_size_tear_down(void *fixture)
{
  sparsemap_t *map = (sparsemap_t *)fixture;
  free(map->m_data);
  test_api_tear_down(fixture);
}
static MunitResult
test_api_get_size(const MunitParameter params[], void *data)
{
  sparsemap_t *map = (sparsemap_t *)data;
  (void)params;

  assert_ptr_not_null(map);

  size_t size = sparsemap_get_size(map);
  assert_true(size > 400);

  return MUNIT_OK;
}

static void *
test_api_scan_setup(const MunitParameter params[], void *user_data)
{
  uint8_t *buf = munit_calloc(1024, sizeof(uint8_t));
  sparsemap_t *map = (sparsemap_t *)test_api_setup(params, user_data);

  sparsemap_init(map, buf, 1024);
  bitmap_from_uint64(map, ((uint64_t)0xfeedface << 32) | 0xbadc0ffee);

  return (void *)map;
}
static void
test_api_scan_tear_down(void *fixture)
{
  sparsemap_t *map = (sparsemap_t *)fixture;
  free(map->m_data);
  test_api_tear_down(fixture);
}
void
scan_for_0xfeedfacebadcoffee(sm_idx_t v[], size_t n)
{
  /* Called multiple times */
  ((void)v);
  ((void)n);
}
static MunitResult
test_api_scan(const MunitParameter params[], void *data)
{
  sparsemap_t *map = (sparsemap_t *)data;
  (void)params;

  assert_ptr_not_null(map);

  sparsemap_set(map, 4200, true);
  assert_true(sparsemap_is_set(map, 42));
  sparsemap_scan(map, scan_for_0xfeedfacebadcoffee, 0);

  return MUNIT_OK;
}

static void *
test_api_split_setup(const MunitParameter params[], void *user_data)
{
  uint8_t *buf = munit_calloc(1024, sizeof(uint8_t));
  sparsemap_t *map = (sparsemap_t *)test_api_setup(params, user_data);

  sparsemap_init(map, buf, 1024);
  for (int i = 0; i < 1024; i++) {
    sparsemap_set(map, i, true);
  }
  return (void *)map;
}
static void
test_api_split_tear_down(void *fixture)
{
  sparsemap_t *map = (sparsemap_t *)fixture;
  free(map->m_data);
  test_api_tear_down(fixture);
}
static MunitResult
test_api_split(const MunitParameter params[], void *data)
{
  sparsemap_t *map = (sparsemap_t *)data;
  uint8_t buf[1024] = { 0 };
  sparsemap_t portion;
  (void)params;

  assert_ptr_not_null(map);

  sparsemap_init(&portion, buf, 512);
  sparsemap_split(map, 512, &portion);
  for (int i = 0; i < 512; i++) {
    assert_true(sparsemap_is_set(map, i));
    assert_false(sparsemap_is_set(&portion, i));
  }
  for (int i = 513; i < 1024; i++) {
    assert_false(sparsemap_is_set(map, i));
    assert_true(sparsemap_is_set(&portion, i));
  }

  return MUNIT_OK;
}

static void *
test_api_select_setup(const MunitParameter params[], void *user_data)
{
  uint8_t *buf = munit_calloc(1024, sizeof(uint8_t));
  sparsemap_t *map = (sparsemap_t *)test_api_setup(params, user_data);

  sparsemap_init(map, buf, 1024);
  bitmap_from_uint64(map, ((uint64_t)0xfeedface << 32) | 0xbadc0ffee);

  return (void *)map;
}
static void
test_api_select_tear_down(void *fixture)
{
  sparsemap_t *map = (sparsemap_t *)fixture;
  free(map->m_data);
  test_api_tear_down(fixture);
}
static MunitResult
test_api_select(const MunitParameter params[], void *data)
{
  sparsemap_t *map = (sparsemap_t *)data;
  (void)params;

  assert_ptr_not_null(map);

  /* NOTE: select() is 0-based, to get the bit position of the 1st logical bit set
     call select(map, 0), to get the 18th, select(map, 17), etc. */
  assert_true(sparsemap_select(map, 0, true) == 1);
  assert_true(sparsemap_select(map, 4, true) == 6);
  assert_true(sparsemap_select(map, 17, true) == 26);

#if 0 // TODO
  size_t f = sparsemap_select(map, 0, false);
  for (int i = 0; i <= f; i++) {
    assert_false(sparsemap_is_set(map, i % 2));
  }

  sparsemap_clear(map);

  for (int i = 0; i < 1000; i++) {
    sparsemap_set(map, i, i % 2 ? true : false);
  }

  f = sparsemap_select(map, 0, false);
  assert_true(f == 1000);

  sparsemap_clear(map);

  sparsemap_set(map, 42, true);
  sparsemap_set(map, 420, true);
  sparsemap_set(map, 4200, true);

  f = sparsemap_select(map, 0, false);
  assert_true(f == 0);

  f = sparsemap_select(map, -1, true);
  assert_true(f == 4200);
  f = sparsemap_select(map, -2, true);
  assert_true(f == 420);
  f = sparsemap_select(map, -3, true);
  assert_true(f == 42);
#endif
  return MUNIT_OK;
}

static void *
test_api_rank_setup(const MunitParameter params[], void *user_data)
{
  uint8_t *buf = munit_calloc(1024, sizeof(uint8_t));
  sparsemap_t *map = (sparsemap_t *)test_api_setup(params, user_data);

  sparsemap_init(map, buf, 1024);

  return (void *)map;
}
static void
test_api_rank_tear_down(void *fixture)
{
  sparsemap_t *map = (sparsemap_t *)fixture;
  free(map->m_data);
  test_api_tear_down(fixture);
}
static MunitResult
test_api_rank(const MunitParameter params[], void *data)
{
  int r1, r2;
  sparsemap_t *map = (sparsemap_t *)data;
  (void)params;

  assert_ptr_not_null(map);

  for (int i = 0; i < 10; i++) {
    sparsemap_set(map, i, true);
  }
  for (int i = 0; i < 10; i++) {
    assert_true(sparsemap_is_set(map, i));
  }
  for (int i = 10; i < 1000; i++) {
    assert_true(!sparsemap_is_set(map, i));
  }
  /* rank() is also 0-based, for consistency (and confusion sake); consider the
     range as [start, end] of [0, 9] counts the bits set in the first 10
     positions (starting from the LSB) in the index. */
  r1 = rank_uint64((uint64_t)-1, 0, 9);
  r2 = sparsemap_rank(map, 0, 9, true);
  assert_true(r1 == r2);
  assert_true(sparsemap_rank(map, 0, 9, true) == 10);
  assert_true(sparsemap_rank(map, 1000, 1050, true) == 0);

  for (int i = 0; i < 10; i++) {
    for (int j = i; j < 10; j++) {
      r1 = rank_uint64((uint64_t)-1, i, j);
      r2 = sparsemap_rank(map, i, j, true);
      assert_true(r1 == r2);
    }
  }

  return MUNIT_OK;
}

static void *
test_api_span_setup(const MunitParameter params[], void *user_data)
{
  uint8_t *buf = munit_calloc(1024, sizeof(uint8_t));
  sparsemap_t *map = (sparsemap_t *)test_api_setup(params, user_data);

  sparsemap_init(map, buf, 1024);

  return (void *)map;
}
static void
test_api_span_tear_down(void *fixture)
{
  sparsemap_t *map = (sparsemap_t *)fixture;
  free(map->m_data);
  test_api_tear_down(fixture);
}
static MunitResult
test_api_span(const MunitParameter params[], void *data)
{
  sparsemap_t *map = (sparsemap_t *)data;
  (void)params;

  assert_ptr_not_null(map);

  int located_at, placed_at, amt = 10000;

  placed_at = create_sequential_set_in_empty_map(map, amt, 1);
  located_at = sparsemap_span(map, 0, 1, true);
  assert_true(located_at == placed_at);

  sparsemap_clear(map);

  placed_at = create_sequential_set_in_empty_map(map, amt, 50);
  located_at = sparsemap_span(map, 0, 50, true);
  assert_true(located_at == placed_at);

  sparsemap_clear(map);

  placed_at = create_sequential_set_in_empty_map(map, amt, 50);
  located_at = sparsemap_span(map, placed_at / 2, 50, true);
  assert_true(located_at == placed_at);

  /* TODO
  sparsemap_clear(map);

  placed_at = create_sequential_set_in_empty_map(map, amt, amt - 1);
  located_at = sparsemap_span(map, 0, amt - 1, true);
  assert_true(located_at == placed_at);
   */

  return MUNIT_OK;
}

// clang-format off
static MunitTest api_test_suite[] = {
  { (char *)"/static_init", test_api_static_init, NULL, NULL, MUNIT_TEST_OPTION_NONE, NULL },
  { (char *)"/clear", test_api_clear, test_api_clear_setup, test_api_clear_tear_down, MUNIT_TEST_OPTION_NONE, NULL },
  { (char *)"/open", test_api_open, test_api_open_setup, test_api_open_tear_down, MUNIT_TEST_OPTION_NONE, NULL },
  { (char *)"/set_data_size", test_api_set_data_size, test_api_set_data_size_setup, test_api_set_data_size_tear_down, MUNIT_TEST_OPTION_NONE, NULL },
  { (char *)"/remaining_capacity", test_api_remaining_capacity, test_api_remaining_capacity_setup, test_api_remaining_capacity_tear_down,
    MUNIT_TEST_OPTION_NONE, NULL },
  { (char *)"/get_capacity", test_api_get_capacity, test_api_get_capacity_setup, test_api_get_capacity_tear_down, MUNIT_TEST_OPTION_NONE, NULL },
  { (char *)"/is_set", test_api_is_set, test_api_is_set_setup, test_api_is_set_tear_down, MUNIT_TEST_OPTION_NONE, NULL },
  { (char *)"/set", test_api_set, test_api_set_setup, test_api_set_tear_down, MUNIT_TEST_OPTION_NONE, NULL },
  { (char *)"/get_starting_offset", test_api_get_starting_offset, test_api_get_starting_offset_setup, test_api_get_starting_offset_tear_down, MUNIT_TEST_OPTION_NONE, NULL },
  //TODO { (char *)"/get_ending_offset", test_api_get_ending_offset, test_api_get_ending_offset_setup, test_api_get_ending_offset_tear_down, MUNIT_TEST_OPTION_NONE, NULL },
  { (char *)"/get_size", test_api_get_size, test_api_get_size_setup, test_api_get_size_tear_down, MUNIT_TEST_OPTION_NONE, NULL },
  { (char *)"/scan", test_api_scan, test_api_scan_setup, test_api_scan_tear_down, MUNIT_TEST_OPTION_NONE, NULL },
  { (char *)"/split", test_api_split, test_api_split_setup, test_api_split_tear_down, MUNIT_TEST_OPTION_NONE, NULL },
  { (char *)"/select", test_api_select, test_api_select_setup, test_api_select_tear_down, MUNIT_TEST_OPTION_NONE, NULL },
  { (char *)"/rank", test_api_rank, test_api_rank_setup, test_api_rank_tear_down, MUNIT_TEST_OPTION_NONE, NULL },
  { (char *)"/span", test_api_span, test_api_span_setup, test_api_span_tear_down, MUNIT_TEST_OPTION_NONE, NULL },
  { NULL, NULL, NULL, NULL, MUNIT_TEST_OPTION_NONE, NULL }
};
// clang-format on

/* -------------------------- Scale Tests */

static void *
test_scale_lots_o_spans_setup(const MunitParameter params[], void *user_data)
{
  uint8_t *buf = munit_calloc(1024, sizeof(uint8_t));
  sparsemap_t *map = (sparsemap_t *)test_api_setup(params, user_data);

  sparsemap_init(map, buf, 1024);

  return (void *)map;
}
static void
test_scale_lots_o_spans_tear_down(void *fixture)
{
  sparsemap_t *map = (sparsemap_t *)fixture;
  free(map->m_data);
  test_api_tear_down(fixture);
}
static MunitResult
test_scale_lots_o_spans(const MunitParameter params[], void *data)
{
  sparsemap_t *map = (sparsemap_t *)data;
  (void)params;

  assert_ptr_not_null(map);

  for (int i = 0; i < 268435456;) {
    int l = i % 31 + 16;
    create_sequential_set_in_empty_map(map, 268435456, l);
    i += l;
    /* ANSI esc code to clear line, carrage return, then print on the same line */
    //printf("\033[2K\r%d", i);
    //printf("%d\t%d\n", l, i);
    //fflush(stdout);
  }

  return MUNIT_OK;
}

static void *
test_scale_spans_come_spans_go_setup(const MunitParameter params[], void *user_data)
{
  uint8_t *buf = munit_calloc(1024, sizeof(uint8_t));
  sparsemap_t *map = (sparsemap_t *)test_api_setup(params, user_data);

  sparsemap_init(map, buf, 1024);

  return (void *)map;
}
static void
test_scale_spans_come_spans_go_tear_down(void *fixture)
{
  sparsemap_t *map = (sparsemap_t *)fixture;
  free(map->m_data);
  test_api_tear_down(fixture);
}
static MunitResult
test_scale_spans_come_spans_go(const MunitParameter params[], void *data)
{
  sparsemap_t *map = (sparsemap_t *)data;
  (void)params;

  assert_ptr_not_null(map);

  for (int i = 0; i < 268435456;) {
    int l = i % 31 + 16;
    create_sequential_set_in_empty_map(map, 268435456, l);
    i += l;

    /* After 10,000 spans are in there we consume a span every iteration. */
    if (l > 10000) {
      do {
	int s = munit_rand_int_range(1, 30);
	int o = munit_rand_int_range(1, 268435456 - s - 1);
	size_t b = sparsemap_span(map, o, s, true);
	if (b == SM_LOC_MAX) {
	  continue;
	}
	for (int j = b; j < s; j++) {
	  assert_true(sparsemap_is_set(map, j) == true);
	}
	for (int j = b; j < s; j++) {
	  sparsemap_set(map, j, false);
	}
	for (int j = b; j < s; j++) {
	  assert_true(sparsemap_is_set(map, j) == false);
	}
	break;
      } while (true);
    }
  }

  return MUNIT_OK;
}

static void *
test_scale_best_case_setup(const MunitParameter params[], void *user_data)
{
  uint8_t *buf = munit_calloc(1024, sizeof(uint8_t));
  sparsemap_t *map = (sparsemap_t *)test_api_setup(params, user_data);

  sparsemap_init(map, buf, 1024);

  return (void *)map;
}
static void
test_scale_best_case_tear_down(void *fixture)
{
  sparsemap_t *map = (sparsemap_t *)fixture;
  free(map->m_data);
  test_api_tear_down(fixture);
}
static MunitResult
test_scale_best_case(const MunitParameter params[], void *data)
{
  sparsemap_t *map = (sparsemap_t *)data;
  (void)params;

  assert_ptr_not_null(map);

  /* Best case a map can contain 2048 bits in 8 bytes.
     So, in a 1KiB buffer you have:
       (1024 KiB / 8 bytes) * 2048 = 268,435,456 bits
     or 1.09 TiB of 4KiB pages. Let's investigate, and find out if that's the case.

     TODO: Actually, 172032 are stored before SEGV, or 706 MiB of 4KiB pages.
  */

  /* Set every bit on, that should be the best case. */
  for (int i = 0; i < 268435456; i++) {
    /* ANSI esc code to clear line, carrage return, then print on the same line */
    //    printf("\033[2K\r%d", i);
    //    fflush(stdout);
    sparsemap_set(map, i, true);
  }

  return MUNIT_OK;
}

static void *
test_scale_worst_case_setup(const MunitParameter params[], void *user_data)
{
  uint8_t *buf = munit_calloc(1024, sizeof(uint8_t));
  sparsemap_t *map = (sparsemap_t *)test_api_setup(params, user_data);

  sparsemap_init(map, buf, 1024);

  return (void *)map;
}
static void
test_scale_worst_case_tear_down(void *fixture)
{
  sparsemap_t *map = (sparsemap_t *)fixture;
  free(map->m_data);
  test_api_tear_down(fixture);
}
static MunitResult
test_scale_worst_case(const MunitParameter params[], void *data)
{
  sparsemap_t *map = (sparsemap_t *)data;
  (void)params;

  assert_ptr_not_null(map);

  /* Worst case a map can contain 2048 bits in 265 + 8 = 264 bytes.
     So, in a 1KiB buffer you have:
       (1024 KiB / 264 bytes) * 2048 = 8,134,407.75758 bits
     or 33.3 GiB of 4KiB pages. Let's investigate, and find out if that's the case.

     TODO: actually 7744 are stored before SEGV, or 31MiB of 4KiB pages.
  */

  /* Set every other bit, that has to be the "worst case" for this index. */
  for (int i = 0; i < 8134407; i += 2) {
    /* ANSI esc code to clear line, carrage return, then print on the same line */
    //    printf("\033[2K\r%d", i);
    //    fflush(stdout);
    sparsemap_set(map, i, true);
  }

  return MUNIT_OK;
}

/* -------------------------- Performance Tests */

static void *
test_perf_span_solo_setup(const MunitParameter params[], void *user_data)
{
  uint8_t *buf = munit_calloc(1024 * 3, sizeof(uint8_t));
  sparsemap_t *map = (sparsemap_t *)test_api_setup(params, user_data);

  sparsemap_init(map, buf, 3 * 1024);

  return (void *)map;
}
static void
test_perf_span_solo_tear_down(void *fixture)
{
  sparsemap_t *map = (sparsemap_t *)fixture;
  free(map->m_data);
  test_api_tear_down(fixture);
}
static MunitResult
test_perf_span_solo(const MunitParameter params[], void *data)
{
  sparsemap_t *map = (sparsemap_t *)data;
  // double stop, start;
  (void)params;
  int located_at, placed_at, amt = 500;

  assert_ptr_not_null(map);

  for (int i = 1; i < amt; i++) {
    for (int j = 1; j <= 100; j++) {
      sparsemap_clear(map);
      placed_at = create_sequential_set_in_empty_map(map, amt, j);
      // logf("i = %d, j = %d\tplaced_at %d\n", i, j, placed_at);
      // whats_set(map, 5000);
      // start = nsts();
      located_at = sparsemap_span(map, 0, j, true);
      // stop = nsts();
      // double amt = (stop - start) * 1e6;
      // if (amt > 0) {
      //   fprintf(stdout, "%0.8f\n", amt);
      // }
      if (placed_at != located_at)
        logf("a: i = %d, j = %d\tplaced_at %d located_at %d\n", i, j, placed_at, located_at);
    }
  }
  return MUNIT_OK;
}

static void *
test_perf_span_tainted_setup(const MunitParameter params[], void *user_data)
{
  uint8_t *buf = munit_calloc(1024 * 3, sizeof(uint8_t));
  sparsemap_t *map = (sparsemap_t *)test_api_setup(params, user_data);

  sparsemap_init(map, buf, 3 * 1024);

  return (void *)map;
}
static void
test_perf_span_tainted_tear_down(void *fixture)
{
  sparsemap_t *map = (sparsemap_t *)fixture;
  free(map->m_data);
  test_api_tear_down(fixture);
}
static MunitResult
test_perf_span_tainted(const MunitParameter params[], void *data)
{
  sparsemap_t *map = (sparsemap_t *)data;
  // double stop, start;
  (void)params;

  assert_ptr_not_null(map);

  int located_at, placed_at, amt = 500;
  for (int i = 1; i < amt; i++) {
    for (int j = 100; j <= 10; j++) {
      sparsemap_clear(map);
      populate_map(map, 1024, 1 * 1024);
      placed_at = create_sequential_set_in_empty_map(map, amt, j);
      // start = nsts();
      located_at = sparsemap_span(map, 0, j, true);
      // stop = nsts();
      // double amt = (stop - start) * 1e6;
      // if (amt > 0) {
      // fprintf(stdout, "%0.8f\n", amt);
      // }
      if (located_at >= placed_at)
        logf("b: i = %d, j = %d\tplaced_at %d located_at %d\n", i, j, placed_at, located_at);
    }
  }

  return MUNIT_OK;
}

// clang-format off
static MunitTest scale_test_suite[] = {
  { (char *)"/lots-o-spans", test_scale_lots_o_spans, test_scale_lots_o_spans_setup, test_scale_lots_o_spans_tear_down, MUNIT_TEST_OPTION_NONE, NULL },
  { (char *)"/spans_come_spans_go", test_scale_spans_come_spans_go, test_scale_spans_come_spans_go_setup, test_scale_spans_come_spans_go_tear_down, MUNIT_TEST_OPTION_NONE, NULL },
  { (char *)"/best-case", test_scale_best_case, test_scale_best_case_setup, test_scale_best_case_tear_down, MUNIT_TEST_OPTION_NONE, NULL },
  { (char *)"/worst-case", test_scale_worst_case, test_scale_worst_case_setup, test_scale_worst_case_tear_down, MUNIT_TEST_OPTION_NONE, NULL },
  { NULL, NULL, NULL, NULL, MUNIT_TEST_OPTION_NONE, NULL } };
// clang-format on

// clang-format off
static MunitTest perf_test_suite[] = {
  { (char *)"/span/solo", test_perf_span_solo, test_perf_span_solo_setup, test_perf_span_solo_tear_down, MUNIT_TEST_OPTION_NONE, NULL },
  { (char *)"/span/tainted", test_perf_span_tainted, test_perf_span_tainted_setup, test_perf_span_tainted_tear_down, MUNIT_TEST_OPTION_NONE, NULL },
  { NULL, NULL, NULL, NULL, MUNIT_TEST_OPTION_NONE, NULL } };
// clang-format on

// clang-format off
static MunitSuite other_test_suite[] = {
  { "/perf", perf_test_suite, NULL, 1, MUNIT_SUITE_OPTION_NONE },
  { "/scale", scale_test_suite, NULL, 1, MUNIT_SUITE_OPTION_NONE },
  { NULL, NULL, NULL, 0, MUNIT_SUITE_OPTION_NONE } };
// clang-format on

static const MunitSuite main_test_suite = { (char *)"/api", api_test_suite, other_test_suite, 1, MUNIT_SUITE_OPTION_NONE };

int
main(int argc, char *argv[MUNIT_ARRAY_PARAM(argc + 1)])
{
  struct user_data info;
  return munit_suite_main(&main_test_suite, (void *)&info, argc, argv);
}

/* ARGS: --no-fork --seed 8675309 */