mlib/tests/test-mshared-ptr.c

/*
 * Copyright (c) 2017-2024, Patrick Pelissier
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * + Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * + Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include <stdio.h>

#include "m-shared-ptr.h"

#include "m-string.h"
#include "m-array.h"
#include "m-bptree.h"
#include "m-deque.h"
#include "m-dict.h"
#include "m-list.h"
#include "m-prioqueue.h"
#include "m-rbtree.h"
#include "m-tuple.h"
#include "m-variant.h"

#include "coverage.h"

// TEST WITH INT
SHARED_PTR_DECL_AS(shared_int, SharedInt, M_BASIC_OPLIST)

// TEST WITH DOUBLE
SHARED_PTR_DECL_AS(shared_double, SharedDouble, M_BASIC_OPLIST)
extern SharedDouble *shared_double_new_from(double); // Workaround for test.

static void test_double(void)
{
  SharedDouble *p = shared_double_new();
  SharedDouble *q = shared_double_new_from(2.0);
  SharedDouble *r = shared_double_new_from(1.0);
  SharedDouble *rr = shared_double_new_from(3.0);
  shared_double_add(p, q, r);
  assert(shared_double_equal_p(p, rr));
  shared_double_sub(p, q, r);
  assert(shared_double_equal_p(p, r));
  shared_double_mul(p, q, r);
  assert(shared_double_equal_p(p, q));
  shared_double_div(p, q, r);
  assert(shared_double_equal_p(p, q));
  shared_double_reset(p);
  shared_double_release(p);
  shared_double_release(q);
  shared_double_release(r);
  shared_double_release(rr);
}

// TEST WITH STRING
static inline void string_add(string_t d, const string_t a, const string_t b)
{
  int ia = atoi(string_get_cstr(a));
  int ib = atoi(string_get_cstr(b));
  string_printf(d, "%d", ia+ib);
}
static inline void string_sub(string_t d, const string_t a, const string_t b)
{
  int ia = atoi(string_get_cstr(a));
  int ib = atoi(string_get_cstr(b));
  string_printf(d, "%d", ia-ib);
}
static inline void string_mul(string_t d, const string_t a, const string_t b)
{
  int ia = atoi(string_get_cstr(a));
  int ib = atoi(string_get_cstr(b));
  string_printf(d, "%d", ia*ib);
}
static inline void string_div(string_t d, const string_t a, const string_t b)
{
  int ia = atoi(string_get_cstr(a));
  int ib = atoi(string_get_cstr(b));
  string_printf(d, "%d", ia/ib);
}

#define STR_OPL M_OPEXTEND(STRING_OPLIST, POP(string_pop_u), GET_SIZE(string_length_u), ADD(string_add), SUB(string_sub), MUL(string_mul), DIV(string_div))
SHARED_PTR_DECL(shared_string, STR_OPL)

static int str_callback(void *data, const string_unicode_t *u)
{
  string_unicode_t *pu = (string_unicode_t *) data;
  *pu += *u;
  return 0;
}

static int str_callback2(void *data, const string_unicode_t *u)
{
  string_unicode_t *pu = (string_unicode_t *) data;
  *pu += *u;
  return 1;
}

static void test_string(void)
{
    shared_string_t *p = shared_string_new();
    shared_string_t *q = shared_string_make("Hello world");
    shared_string_t *r = shared_string_acquire(p);
    assert(p == r);
    assert(shared_string_equal_p(r, p));
    assert(!shared_string_equal_p(r, q));
    shared_string_t *p2 = shared_string_clone(p);
    assert(p2 != p);
    assert(shared_string_equal_p(p2, p));
    bool b = shared_string_empty_p(p);
    assert(b);
    shared_string_clear(p);
    b = shared_string_empty_p(r);
    assert(b);
    shared_string_copy(q, r);
    assert(shared_string_equal_p(r, q));
    shared_string_set(&q, r);
    assert(shared_string_equal_p(r, q));
    shared_string_t *r2 = shared_string_make("Hello world!");
    shared_string_copy(q, r2);
    assert(shared_string_equal_p(r2, q));
    shared_string_set(&q, r);
    assert(shared_string_equal_p(r, q));
    assert(shared_string_cmp(r, q) == 0);
    assert(shared_string_cmp(q, r) == 0);
    assert(shared_string_cmp(q, p) == 0);
    string_unicode_t u;
    b = shared_string_try_pop(&u, p2);
    assert(!b);
    b = shared_string_try_push(p2, 'X');
    assert(b);
    shared_string_push(p2, 'X');
    assert(shared_string_size(p2) == 2);
    b = shared_string_try_pop(&u, p2);
    assert(b);
    assert(shared_string_cmp(q, p2) < 0);
    assert(shared_string_cmp(p2, q) > 0);
    shared_string_push(p2, 'X');
    u = 0;
    int res = shared_string_for_each(p2, str_callback, (void*) &u);
    assert(res == 0);
    assert(u == 2* 'X');
    res = shared_string_for_each(p2, str_callback2, (void*) &u);
    assert(res == 1);
    assert(u == 3* 'X');
    shared_string_reset(q);
    assert(!shared_string_equal_p(r2, q));
    assert(shared_string_empty_p(q));
    assert(shared_string_hash(q) != 0);
    shared_string_swap(r2, r2);
    shared_string_swap(r2, q);
    assert(shared_string_empty_p(r2));
    assert(!shared_string_empty_p(q));
    shared_string_swap(q, r2);
    assert(!shared_string_empty_p(r2));
    assert(shared_string_empty_p(q));
    // todo: shared_string_splice
    // todo: shared_string_erase
    shared_string_release(r2);
    shared_string_clear(q);
    shared_string_release(r);
    shared_string_clear(p2);
}

static void test_string_io(void)
{
  shared_string_t *p = shared_string_new();
  shared_string_t *q = shared_string_make("Hello world");

  FILE *f = m_core_fopen ("a-mshared-ptr.dat", "wt");
  if (!f) abort();
  shared_string_out_str(f, q);
  fclose (f);

  f = m_core_fopen ("a-mshared-ptr.dat", "rt");
  if (!f) abort();
  bool b = shared_string_in_str (p, f);
  assert (b == true);
  assert (shared_string_equal_p (p, q));
  fclose(f);

  shared_string_reset(p);
  M_LET(str, STRING_OPLIST) {
    shared_string_get_str(str, q, false);
    assert (string_cmp_str (str, "\"Hello world\"") == 0);
    const char *sp;
    b = shared_string_parse_str(p, string_get_cstr(str), &sp);
    assert(b);
    assert(*sp == 0);
    assert(shared_string_equal_p(p, q));
  }

  shared_string_clear(p);
  shared_string_release(q);
}


// TEST WITH ARRAY
ARRAY_DEF(array, int)
// Provide a FULL_P operator
static inline bool array_full_p(const array_t a) { return array_size(a) >= 10; }
#define M_OPL_array_t() M_OPEXTEND( ARRAY_OPLIST(array, M_BASIC_OPLIST), SUBTYPE(int), FULL_P(array_full_p) )
SHARED_PTR_DECL(shared_array, M_OPL_array_t() )

static int callback1(void *data, const int *el)
{
    int *s_ptr = (int *) data;
    *s_ptr += *el;
    return 0;
}

static int callback2(void *data, const int *el)
{
    int *s_ptr = (int *) data;
    return *s_ptr == *el;
}

static int callback3(void *data, int *el)
{
    int *s_ptr = (int *) data;
    *el *= *s_ptr;
    return 0;
}

static void test_array(void)
{
    shared_array_t *p = shared_array_new();
    bool b;
    int j;

    for(int i = 0 ; i < 10; i++) {
        assert(!shared_array_full_p(p));
        assert(shared_array_size(p) == (size_t) i);
        b = shared_array_try_push(p, i);
        assert(b);
    }
    // We can only push 10 elements before being full.
    b = shared_array_try_push(p, 11);
    assert(!b);
    assert(shared_array_full_p(p));
    shared_array_get(&j, p, 4);
    assert( j == 4);

    shared_array_set_at(p, 4, 5);
    shared_array_get(&j, p, 4);
    assert( j == 5);

    shared_array_set_at(p, 4, 4);
    shared_array_get(&j, p, 4);
    assert( j == 4);

    int s = 0;
    int r = shared_array_for_each(p, callback1, &s);
    assert(r == 0);
    assert(s == 9*10/2);

    s = 4;
    r = shared_array_for_each(p, callback2, &s);
    assert(r == 1);

    s = 2;
    r = shared_array_apply(p, callback3, &s);
    assert(r == 0);

    s = 0;
    r = shared_array_for_each(p, callback1, &s);
    assert(r == 0);
    assert(s == 9*10);

    for(int i = 9 ; i >= 0; i--) {
        b = shared_array_try_pop(&j, p);
        assert(b);
        assert(i * 2== j);
    }
    b = shared_array_try_pop(&j, p);
    assert(!b);

    shared_array_safe_get(&r, p, 23);
    assert(r == 0);
    assert(shared_array_size(p) == 24);

    shared_array_erase(p, 10);
    assert(shared_array_size(p) == 23);

    b = shared_array_get(&r, p, 22);
    assert(b);
    assert(r == 0);

    shared_array_release(p);
}


ARRAY_DEF(array_str, string_t)
SHARED_PTR_DECL(shared_array_str, ARRAY_OPLIST(array_str, M_STRING_OPLIST))

static void test_array_string(void)
{
    shared_array_str_t *p = shared_array_str_new();

    M_LET( (x, ("Hello")), string_t)
        shared_array_str_push(p, x);

    string_t tmp;
    string_init_set_str(tmp, "World");
    shared_array_str_push_move(p, &tmp); // No need to clear tmp

    shared_array_str_emplace(p, "!");

    bool b = shared_array_str_try_emplace(p, " ");
    assert(b);

    string_init_set_str(tmp, "!");
    b = shared_array_str_try_push_move(p, &tmp); // No need to clear tmp
    assert(b);

    shared_array_str_release(p);
}

// TEST WITH LIST
LIST_DEF(list, float)
#define M_OPL_list_t() LIST_OPLIST(list, M_BASIC_OPLIST)
SHARED_WEAK_PTR_DECL(shared_list, M_OPL_list_t())
SHARED_WEAK_PTR_DEF_EXTERN(shared_list, list_t)

LIST_DUAL_PUSH_DEF(list2, int)
SHARED_WEAK_PTR_DEF(shared_list2, list2_t, LIST_OPLIST(list2))


// TEST WITH DICT
DICT_DEF2(dict, float, float)
#define M_OPL_dict_t() DICT_OPLIST(dict, M_BASIC_OPLIST, M_BASIC_OPLIST)
SHARED_WEAK_PTR_DECL_AS(shared_dict, shared_dict_t, M_OPL_dict_t())
SHARED_WEAK_PTR_DEF_EXTERN_AS(shared_dict, shared_dict_t, dict_t)

DICT_DEF2(string_pool, string_t, string_t)
#define M_OPL_string_pool_t() DICT_OPLIST(string_pool, STRING_OPLIST, STRING_OPLIST)
SHARED_PTR_DEF(string_pool_ts, string_pool_t, M_OPL_string_pool_t() )

DICT_SET_DEF(dict2, int)
SHARED_PTR_DEF(shared_dict2, dict2_t, DICT_SET_OPLIST(dict2))

/* OA dict needs more operators than the default ones to work */
static inline bool int_oor_equal_p(int s, unsigned char n)
{
  return s == -n;
}
static inline void int_oor_set(int *s, unsigned char n)
{
  *s = -n;
}
#define INT_OA_OPLIST                                                   \
  M_OPEXTEND(M_BASIC_OPLIST, OOR_EQUAL(int_oor_equal_p), OOR_SET(API_2(int_oor_set)))
DICT_OA_DEF2(dict3, int, INT_OA_OPLIST, int, M_BASIC_OPLIST)
SHARED_PTR_DEF(shared_dict3, dict3_t, DICT_OPLIST(dict3))

// TEST WITH TUPLE
TUPLE_DEF2(point, (x, int), (y, int))
#define M_OPL_point_t() TUPLE_OPLIST(point, M_BASIC_OPLIST, M_BASIC_OPLIST)
SHARED_PTR_DEF(shared_point, point_t)

//SHARED_PTR_DECL(shared_point, ARRAY_OPLIST(array_str, M_STRING_OPLIST))
//M_OPL_point_t())

// TEST WITH VARIANT
VARIANT_DEF2(dimension, (x, int), (y, float))
#define M_OPL_dimension_t() VARIANT_OPLIST(dimension, M_BASIC_OPLIST, M_BASIC_OPLIST)
SHARED_PTR_DEF(shared_dimension, dimension_t)


// TEST WITH DEQUE
DEQUE_DEF(deque1, int)
// Provide a FULL_P operator
static inline bool deque1_full_p(const deque1_t a) { return deque1_size(a) >= 10; }
#define M_OPL_deque1_t() M_OPEXTEND( DEQUE_OPLIST(deque1, M_BASIC_OPLIST), SUBTYPE(int), FULL_P(deque1_full_p) )
SHARED_PTR_DEF(shared_deque1, deque1_t)

PRIOQUEUE_DEF(prio1, int)
SHARED_PTR_DEF(shared_prio1, prio1_t, PRIOQUEUE_OPLIST(prio1))

// TEST WITH B+TREE
BPTREE_DEF2(bptree1, 10, int, int)
SHARED_PTR_DEF(shared_bptree1, bptree1_t, BPTREE_OPLIST2(bptree1, M_BASIC_OPLIST, M_BASIC_OPLIST))

BPTREE_DEF(bptree2, 10, int)
SHARED_PTR_DEF(shared_bptree2, bptree2_t, BPTREE_OPLIST(bptree2))

// TEST WITH R/B TREE
RBTREE_DEF(rbtree1, int)
SHARED_PTR_DEF(shared_rbtree1, rbtree1_t, RBTREE_OPLIST(rbtree1))

/********************************/

static void conso(void *p)
{
  shared_deque1_t *ptr = (shared_deque1_t*) p;
  for(int i = 0; i < 1000; i++) {
    int j;
    shared_deque1_pop(&j, ptr);
    assert (j == i);
  }
  shared_deque1_release(ptr);
}

static void test_thread(void)
{
  m_thread_t idx;
  shared_deque1_t *ptr = shared_deque1_new();
  m_thread_create (idx, conso, shared_deque1_acquire(ptr));
  for(int i = 0; i < 1000; i++) {
    // shared_deque1 is full if number of stored element is >= 10
    shared_deque1_push (ptr, i);
  }
  shared_deque1_release(ptr);
  m_thread_join(idx);
}

/************************************************************************/

// Define effective code when only _DECL was used.
START_COVERAGE
SHARED_PTR_DEF_EXTERN(shared_string, string_t, STR_OPL)
END_COVERAGE
// Non measured code
#include "test-mshared-ptr.h"

static void test_string2(void)
{
  M_LET( (x, ("Hello")), string_t) {
    shared_string_t *p = shared_string_new_from(x);
    assert(!shared_string_empty_p(p));
    assert(string_equal_str_p(*shared_string_cref(p), "Hello"));
    assert(string_equal_str_p(*shared_string_ref(p), "Hello"));
    shared_string_release(p);
  }

  shared_string_t *p = shared_string_new();
  shared_string_t *q = shared_string_make("2");
  shared_string_t *r = shared_string_make("1");
  shared_string_t *rr = shared_string_make("3");
  shared_string_add(p, q, r);
  assert(shared_string_equal_p(p, rr));
  shared_string_add(p, r, q);
  assert(shared_string_equal_p(p, rr));
  shared_string_add(p, r, r);
  assert(shared_string_equal_p(p, q));
  shared_string_add(p, p, r);
  assert(shared_string_equal_p(p, rr));
  shared_string_add(p, r, r);
  assert(shared_string_equal_p(p, q));
  shared_string_add(p, r, p);
  assert(shared_string_equal_p(p, rr));
  shared_string_sub(p, q, r);
  assert(shared_string_equal_p(p, r));
  shared_string_add(p, p, p);
  assert(shared_string_equal_p(p, q));
  shared_string_mul(p, q, r);
  assert(shared_string_equal_p(p, q));
  shared_string_div(p, q, r);
  assert(shared_string_equal_p(p, q));
  shared_string_reset(p);
  shared_string_release(p);
  shared_string_release(q);
  shared_string_release(r);
  shared_string_release(rr);
}

/************************************************************************/

#define MAX_NUM 200

static void conso_thread1_string(void *p)
{
  shared_string_t *ptr = (shared_string_t*) p;
  bool tmp[MAX_NUM] = {0};
  for(int i = 1; i < MAX_NUM; i++) {
    m_string_unicode_t j;
    shared_string_pop(&j, ptr);
    assert (j > 0 && j < MAX_NUM);
    assert(tmp[j] == false);
    tmp[j] = true;
  }
  shared_string_release(ptr);
}

static void test_thread1_string(void)
{
  m_thread_t idx;
  shared_string_t *ptr = shared_string_new();
  m_thread_create (idx, conso_thread1_string, shared_string_acquire(ptr));
  for(int i = 1; i < MAX_NUM; i++) {
    shared_string_push (ptr, (m_string_unicode_t) i);
  }
  shared_string_release(ptr);
  m_thread_join(idx);
}

// This will test the proper handling of the read lock,
// by pushing it to its limit.
#define MAX_READER 8

static void conso_thread2_string(void *p)
{
  shared_string_t *ptr = (shared_string_t*) p;
  size_t size = shared_string_size(ptr);
  for(int i = 0; i < 1000; i++) {
    size_t n = shared_string_size(ptr);
    assert( n >= size);
    size = n;
  }
  shared_string_release(ptr);
}

static void test_thread2_string(void)
{
  m_thread_t idx[MAX_READER];
  shared_string_t *ptr = shared_string_new();
  for(int i = 0; i < MAX_READER; i++) {
    m_thread_create (idx[i], conso_thread2_string, shared_string_acquire(ptr));
  }
  for(int i = 1; i < 100000; i++) {
    shared_string_push (ptr, (m_string_unicode_t) i);
  }
  shared_string_release(ptr);
  for(int i = 0; i < MAX_READER; i++) {
    m_thread_join(idx[i]);
  }
}

/************************************************************************/

int main(void)
{
    test_string();
    test_string2();
    test_thread1_string();
    test_thread2_string();
    test_string_io();
    test_double();
    test_array();
    test_array_string();
    test_thread();
    exit(0);
}