allocator_tester.cc

/*
Copyright (c) 2023-2028, Hossein Moein
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.
* Neither the name of Hossein Moein and/or the Cougar nor the
  names of its contributors may be used to endorse or promote products
  derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 Hossein Moein 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 <Cougar/AlignedAllocator.h>
#include <Cougar/FixedSizeAllocator.h>

#include <algorithm>
#include <cassert>
#include <cstdlib>
#include <iostream>
#include <map>
#include <random>
#include <string>
#include <vector>

using namespace hmcgr;

struct MyData  {

    MyData()  { std::cout << "Printing from constructor" << std::endl;  }
    ~MyData()  { std::cout << "Printing from destructor" << std::endl; }

    int i { 101 };
};

// -----------------------------------------------------------------------------

static void test_aligned_allocator()  {

    std::cout << "\nTesting AlignedAllocator ..." << std::endl;

    const std::size_t   NUM = 5;

    {
        AlignedAllocator<double>        a1;
        AlignedAllocator<int>           a2;
        AlignedAllocator<double, 512>   a3;
        AlignedAllocator<int, 512>      a4;

        assert(std::size_t(a1.align_value) == 8);
        assert(std::size_t(a2.align_value) == 4);
        assert(std::size_t(a3.align_value) == 512);
        assert(std::size_t(a4.align_value) == 512);
    }
    {
        std::vector<double, AlignedAllocator<double, 512>>  vec;

        vec.reserve(NUM - 1);
        for (std::size_t i = 0; i < NUM; ++i)
            vec.push_back(double(i));

        std::vector<double, AlignedAllocator<double, 512>>  vec2 = vec;

        for (std::size_t i = 0; i < vec.size(); ++i)  {
            assert(vec[i] == double(i));
            assert(vec2[i] == double(i));
        }
    }
    {
        std::vector<int, AlignedAllocator<int, 64>> vec;

        vec.reserve(NUM - 1);
        for (std::size_t i = 0; i < NUM; ++i)
            vec.push_back(int(i));
        for (std::size_t i = 0; i < vec.size(); ++i)
            assert(vec[i] == int(i));
    }
    {
        std::vector<int, AlignedAllocator<int>> vec;

        vec.reserve(NUM - 1);
        for (std::size_t i = 0; i < NUM; ++i)
            vec.push_back(int(i));
        for (std::size_t i = 0; i < vec.size(); ++i)
            assert(vec[i] == int(i));
    }
    {
        std::vector<int, AlignedAllocator<int, 1024>>   vec;

        vec.reserve(NUM - 1);
        for (std::size_t i = 0; i < NUM; ++i)
            vec.push_back(int(i + 1024));
        for (std::size_t i = 0; i < vec.size(); ++i)
            assert(vec[i] == int(i + 1024));
    }
    {
        std::vector<char, AlignedAllocator<char, 512>>  vec;

        vec.reserve(NUM - 1);
        for (std::size_t i = 101; i < 101 + NUM; ++i)
            vec.push_back(char(i));
        for (std::size_t i = 101; i < 101 + NUM; ++i)
            assert(vec[i - 101] == char(i));
    }
    {
        std::vector<long double, AlignedAllocator<long double, 512>>    vec;

        vec.reserve(NUM);
        for (std::size_t i = 0; i < NUM; ++i)
            vec.push_back(static_cast<long double>(i));
        for (std::size_t i = 0; i < vec.size(); ++i)
            assert(vec[i] == static_cast<long double>(i));
    }
    {
        std::vector<MyData, AlignedAllocator<MyData, 512>>  vec(NUM);

        vec[1].i = 1001;
        vec[3].i = 3001;
        for (auto &citer : vec)
            std::cout << citer.i << ", ";
        std::cout << std::endl;
    }
    {
        std::vector<int, AlignedAllocator<int, 1024>>   vec1;
        std::vector<int, AlignedAllocator<int>>         vec2;

        vec1.reserve(NUM);
        for (std::size_t i = 0; i < NUM; ++i)  {
            vec1.push_back(int(i));
            vec2.push_back(int(i));
        }
        for (std::size_t i = 0; i < NUM; ++i)
            assert(vec1[i] == vec2[i]);
    }

    // This must fail to compile
    //
    /*
    {
        std::vector<long double, AlignedAllocator<long double, 8>>  vec;

        vec.reserve(NUM);
        for (std::size_t i = 0; i < NUM; ++i)
            vec.push_back(static_cast<long double>(i));
        for (auto citer : vec)
            std::cout << citer << ", ";
        std::cout << std::endl;
    }
    */
}

// -----------------------------------------------------------------------------

static void test_first_fit_static_allocator()  {

    std::cout << "\nTesting StaticFirstFitAllocator ..." << std::endl;

    std::vector<int, StaticFirstFitAllocator<int, 1000000>> vec1;

    vec1.reserve(100000);
    for (std::size_t i = 0; i < 100000; ++i)
        vec1.push_back(int(i));
    for (std::size_t i = 0; i < 100000; ++i)
        assert(vec1[i] == int(i));

    std::vector<int, StaticFirstFitAllocator<int, 1000000>> vec11 = vec1;

    for (std::size_t i = 0; i < vec1.size(); ++i)
        vec11[i] *= 10;
    for (std::size_t i = 0; i < 100000; ++i)  {
        assert(vec1[i] == int(i));
        assert(vec11[i] == int(i) * 10);
    }

    std::vector<int, StaticFirstFitAllocator<int, 100000>>  vec2;

    for (std::size_t i = 0; i < 10000; ++i)
        vec2.push_back(int(i));
    for (std::size_t i = 0; i < 10000; ++i)
        assert(vec2[i] == int(i));

    {
        std::vector<double, StaticFirstFitAllocator<double, 1000000>>   vec3;

        for (std::size_t i = 0; i < 10000; ++i)
            vec3.push_back(double(i));
        for (std::size_t i = 0; i < 10000; ++i)
            assert(vec3[i] == double(i));
    }

    std::vector<double, StaticFirstFitAllocator<double, 1000000>>   vec4;

    for (std::size_t i = 0; i < 10000; ++i)
        vec4.push_back(double(i));
    for (std::size_t i = 0; i < 10000; ++i)
        assert(vec4[i] == double(i));

    using MyString = std::basic_string<char, std::char_traits<char>,
                                       StaticFirstFitAllocator<char, 10000>>;

    {
        MyString    str1 =
            "This is the first strig xo xo xo xo xo xo xo xo xo xo xo xo xo xo";

        str1 += ". Adding more stuff xo xo xo xo xo xo xo xo xo xo";

        {
            MyString    str2 =
                "This is the second strig";

            str2 += ". Again, adding more stuff wd wd wd wd wd wd wd wd wd wd";

            std::cout << str2 << std::endl;
        }
        std::cout << str1 << std::endl;
    }

    MyString    str3 = "This is the third strig";

    str3 += ". Adding more stuff";
    std::cout << str3 << std::endl;

    std::vector<double, StaticFirstFitAllocator<double, 1000000>>   vec5;

    vec5.reserve(1);
    for (std::size_t i = 0; i < 2; ++i)
        vec5.push_back(double(i));
    for (std::size_t i = 0; i < 2; ++i)
        assert(vec5[i] == double(i));

    using map_t =
        std::map<int, int, std::less<int>,
                 StaticFirstFitAllocator<std::pair<const int, int>, 1000>>;

    map_t   my_map;

    for (int i = 0; i < 1000; ++i)
        my_map.insert({ i, i * 10 });
    for (int i = 0; i < 1000; ++i)
        assert((my_map.find(i)->second == i * 10));

    // Test how badly it fragments the memory
    //
    FirstFitAlgo<FirstFitStatic<int, 10000>>                allocator;
    std::vector<std::pair<unsigned char *, std::size_t>>    ptr_vec;
    std::mt19937                                            gen { 98 };

    std::srand(98);
    for (std::size_t i = 0; i < 1000; ++i)  {
        for (std::size_t j = 0; j < 10; ++j)  {
            const std::size_t   size = (std::rand() % 100) * sizeof(int);
            const auto          ptr = allocator.get_space(size);

            ptr_vec.push_back(std::make_pair(ptr, size));
        }

        std::shuffle(ptr_vec.begin(), ptr_vec.end(), gen);

        if ((i % 10) == 0)  {
            for (std::size_t w = 0; w < (ptr_vec.size() / 3); ++w)
               allocator.put_space(ptr_vec[w].first, ptr_vec[w].second);
            ptr_vec.erase(ptr_vec.begin(),
                          ptr_vec.begin() + (ptr_vec.size() / 3));
        }
        else  {
            for (std::size_t w = 0; w < (ptr_vec.size() / 2); ++w)
               allocator.put_space(ptr_vec[w].first, ptr_vec[w].second);
            ptr_vec.erase(ptr_vec.begin(),
                          ptr_vec.begin() + (ptr_vec.size() / 2));
        }
    }
}

// -----------------------------------------------------------------------------

static void test_first_fit_stack_allocator()  {

    std::cout << "\nTesting StackFirstFitAllocator ..." << std::endl;

    std::vector<int, StackFirstFitAllocator<int, 10000>>    vec1;

    vec1.reserve(100);
    for (std::size_t i = 0; i < 1000; ++i)
        vec1.push_back(int(i));
    for (std::size_t i = 0; i < 1000; ++i)
        assert(vec1[i] == int(i));

    std::vector<int, StackFirstFitAllocator<int, 10000>>  vec11 = vec1;

    for (std::size_t i = 0; i < vec1.size(); ++i)
        vec11[i] *= 10;
    for (std::size_t i = 0; i < 1000; ++i)  {
        assert(vec1[i] == int(i));
        assert(vec11[i] == int(i) * 10);
    }

    for (std::size_t i = 0; i < 3000; ++i)
        vec11.push_back((i + 1000) * 10);
    for (std::size_t i = 0; i < 4000; ++i)
        assert(vec11[i] == int(i) * 10);

    std::vector<int, StackFirstFitAllocator<int, 1000>> vec2;

    for (std::size_t i = 0; i < 100; ++i)
        vec2.push_back(int(i));
    for (std::size_t i = 0; i < 100; ++i)
        assert(vec2[i] == int(i));

    {
        std::vector<double, StackFirstFitAllocator<double, 10000>>  vec3;

        for (std::size_t i = 0; i < 100; ++i)
            vec3.push_back(double(i));
        for (std::size_t i = 0; i < 100; ++i)
            assert(vec3[i] == double(i));
    }

    std::vector<double, StackFirstFitAllocator<double, 10000>>  vec4;

    for (std::size_t i = 0; i < 100; ++i)
        vec4.push_back(double(i));
    for (std::size_t i = 0; i < 100; ++i)
        assert(vec4[i] == double(i));

    using MyString = std::basic_string<char, std::char_traits<char>,
                                       StackFirstFitAllocator<char, 1000>>;

    {
        MyString    str1 =
            "This is the first strig xo xo xo xo xo xo xo xo xo xo xo xo xo xo";

        str1 += ". Adding more stuff xo xo xo xo xo xo xo xo xo xo";

        {
            MyString    str2 =
                "This is the second strig";

            str2 += ". Again, adding more stuff wd wd wd wd wd wd wd wd wd wd";

            std::cout << str2 << std::endl;
        }
        std::cout << str1 << std::endl;
    }

    MyString    str3 = "This is the third strig";

    str3 += ". Adding more stuff";
    std::cout << str3 << std::endl;

    std::vector<double, StackFirstFitAllocator<double, 10000>>  vec5;

    vec5.reserve(1);
    for (std::size_t i = 0; i < 2; ++i)
        vec5.push_back(double(i));
    for (std::size_t i = 0; i < 2; ++i)
        assert(vec5[i] == double(i));

    using map_t =
        std::map<int, int, std::less<int>,
                 StackFirstFitAllocator<std::pair<const int, int>, 1000>>;

    map_t   my_map;

    for (int i = 0; i < 1000; ++i)
        my_map.insert({ i, i * 10 });
    for (int i = 0; i < 1000; ++i)
        assert((my_map.find(i)->second == i * 10));
}

// -----------------------------------------------------------------------------

static void test_best_fit_static_allocator()  {

    std::cout << "\nTesting StaticBestFitAllocator ..." << std::endl;

    std::vector<int, StaticBestFitAllocator<int, 1000000>> vec1;

    vec1.reserve(100000);
    for (std::size_t i = 0; i < 100000; ++i)
        vec1.push_back(int(i));
    for (std::size_t i = 0; i < 100000; ++i)
        assert(vec1[i] == int(i));

    std::vector<int, StaticBestFitAllocator<int, 1000000>> vec11 = vec1;

    for (std::size_t i = 0; i < vec1.size(); ++i)
        vec11[i] *= 10;
    for (std::size_t i = 0; i < 100000; ++i)  {
        assert(vec1[i] == int(i));
        assert(vec11[i] == int(i) * 10);
    }

    for (std::size_t i = 0; i < 3000; ++i)
        vec11.push_back((i + 1000) * 10);
    for (std::size_t i = 0; i < 4000; ++i)
        assert(vec11[i] == int(i) * 10);

    std::vector<int, StaticBestFitAllocator<int, 100000>>  vec2;

    for (std::size_t i = 0; i < 10000; ++i)
        vec2.push_back(int(i));
    for (std::size_t i = 0; i < 10000; ++i)
        assert(vec2[i] == int(i));

    {
        std::vector<double, StaticBestFitAllocator<double, 1000000>>   vec3;

        for (std::size_t i = 0; i < 10000; ++i)
            vec3.push_back(double(i));
        for (std::size_t i = 0; i < 10000; ++i)
            assert(vec3[i] == double(i));
    }

    std::vector<double, StaticBestFitAllocator<double, 1000000>>   vec4;

    for (std::size_t i = 0; i < 10000; ++i)
        vec4.push_back(double(i));
    for (std::size_t i = 0; i < 10000; ++i)
        assert(vec4[i] == double(i));

    using MyString = std::basic_string<char, std::char_traits<char>,
                                       StaticBestFitAllocator<char, 10000>>;

    {
        MyString    str1 =
            "This is the first strig xo xo xo xo xo xo xo xo xo xo xo xo xo xo";

        str1 += ". Adding more stuff xo xo xo xo xo xo xo xo xo xo";

        {
            MyString    str2 =
                "This is the second strig";

            str2 += ". Again, adding more stuff wd wd wd wd wd wd wd wd wd wd";

            std::cout << str2 << std::endl;
        }
        std::cout << str1 << std::endl;
    }

    MyString    str3 = "This is the third strig";

    str3 += ". Adding more stuff";
    std::cout << str3 << std::endl;

    std::vector<double, StaticBestFitAllocator<double, 1000000>>   vec5;

    vec5.reserve(1);
    for (std::size_t i = 0; i < 2; ++i)
        vec5.push_back(double(i));
    for (std::size_t i = 0; i < 2; ++i)
        assert(vec5[i] == double(i));

    using map_t =
        std::map<int, int, std::less<int>,
                 StaticBestFitAllocator<std::pair<const int, int>, 1000>>;

    map_t   my_map;

    for (int i = 0; i < 1000; ++i)
        my_map.insert({ i, i * 10 });
    for (int i = 0; i < 1000; ++i)
        assert((my_map.find(i)->second == i * 10));

    // Test how badly it fragments the memory
    //
    BestFitAlgo<StaticStorage<int, 10000>>                  allocator;
    std::vector<std::pair<unsigned char *, std::size_t>>    ptr_vec;
    std::mt19937                                            gen { 98 };

    std::srand(98);
    for (std::size_t i = 0; i < 10000; ++i)  {
        for (std::size_t j = 0; j < 100; ++j)  {
            const std::size_t   size = (std::rand() % 100) * sizeof(int);
            const auto          ptr = allocator.get_space(size);

            ptr_vec.push_back(std::make_pair(ptr, size));
        }

        std::shuffle(ptr_vec.begin(), ptr_vec.end(), gen);

        if ((i % 10) == 0)  {
            for (std::size_t w = 0; w < (ptr_vec.size() / 3); ++w)
               allocator.put_space(ptr_vec[w].first, ptr_vec[w].second);
            ptr_vec.erase(ptr_vec.begin(),
                          ptr_vec.begin() + (ptr_vec.size() / 3));
        }
        else  {
            for (std::size_t w = 0; w < (ptr_vec.size() / 2); ++w)
               allocator.put_space(ptr_vec[w].first, ptr_vec[w].second);
            ptr_vec.erase(ptr_vec.begin(),
                          ptr_vec.begin() + (ptr_vec.size() / 2));
        }
    }
}

// -----------------------------------------------------------------------------

static void test_best_fit_stack_allocator()  {

    std::cout << "\nTesting StackBestFitAllocator ..." << std::endl;

    std::vector<int, StackBestFitAllocator<int, 10000>> vec1;

    vec1.reserve(1000);
    for (std::size_t i = 0; i < 1000; ++i)
        vec1.push_back(int(i));
    for (std::size_t i = 0; i < 1000; ++i)
        assert(vec1[i] == int(i));

    std::vector<int, StackBestFitAllocator<int, 10000>> vec11 = vec1;

    for (std::size_t i = 0; i < vec1.size(); ++i)
        vec11[i] *= 10;
    for (std::size_t i = 0; i < 1000; ++i)  {
        assert(vec1[i] == int(i));
        assert(vec11[i] == int(i) * 10);
    }

    for (std::size_t i = 0; i < 3000; ++i)
        vec11.push_back((i + 1000) * 10);
    for (std::size_t i = 0; i < 4000; ++i)
        assert(vec11[i] == int(i) * 10);

    std::vector<int, StackBestFitAllocator<int, 1000>> vec2;

    for (std::size_t i = 0; i < 100; ++i)
        vec2.push_back(int(i));
    for (std::size_t i = 0; i < 100; ++i)
        assert(vec2[i] == int(i));

    {
        std::vector<double, StackBestFitAllocator<double, 10000>>  vec3;

        for (std::size_t i = 0; i < 100; ++i)
            vec3.push_back(double(i));
        for (std::size_t i = 0; i < 100; ++i)
            assert(vec3[i] == double(i));
    }

    std::vector<double, StackBestFitAllocator<double, 10000>>  vec4;

    for (std::size_t i = 0; i < 100; ++i)
        vec4.push_back(double(i));
    for (std::size_t i = 0; i < 100; ++i)
        assert(vec4[i] == double(i));

    using MyString = std::basic_string<char, std::char_traits<char>,
                                       StackBestFitAllocator<char, 1000>>;

    {
        MyString    str1 =
            "This is the first strig xo xo xo xo xo xo xo xo xo xo xo xo xo xo";

        str1 += ". Adding more stuff xo xo xo xo xo xo xo xo xo xo";

        {
            MyString    str2 =
                "This is the second strig";

            str2 += ". Again, adding more stuff wd wd wd wd wd wd wd wd wd wd";

            std::cout << str2 << std::endl;
        }
        std::cout << str1 << std::endl;
    }

    MyString    str3 = "This is the third strig";

    str3 += ". Adding more stuff";
    std::cout << str3 << std::endl;

    std::vector<double, StackBestFitAllocator<double, 10000>>  vec5;

    vec5.reserve(1);
    for (std::size_t i = 0; i < 2; ++i)
        vec5.push_back(double(i));
    for (std::size_t i = 0; i < 2; ++i)
        assert(vec5[i] == double(i));

    using map_t =
        std::map<int, int, std::less<int>,
                 StackBestFitAllocator<std::pair<const int, int>, 1000>>;

    map_t   my_map;

    for (int i = 0; i < 1000; ++i)
        my_map.insert({ i, i * 10 });
    for (int i = 0; i < 1000; ++i)
        assert((my_map.find(i)->second == i * 10));
}

// -----------------------------------------------------------------------------

int main(int, char *[]) {

    test_aligned_allocator();
    test_first_fit_static_allocator();
    test_first_fit_stack_allocator();
    test_best_fit_static_allocator();
    test_best_fit_stack_allocator();

    return (0);
}

// -----------------------------------------------------------------------------

// Local Variables:
// mode:C++
// tab-width:4
// c-basic-offset:4
// End: