FairMQ/test/memory_resources/_memory_resources.cxx

/********************************************************************************
 *    Copyright (C) 2018 Goethe University Frankfurt                            *
 *                                                                              *
 *              This software is distributed under the terms of the             *
 *              GNU Lesser General Public Licence (LGPL) version 3,             *
 *                  copied verbatim in the file "LICENSE"                       *
 ********************************************************************************/

#include <fairmq/TransportFactory.h>
#include <fairmq/MemoryResourceTools.h>
#include <fairmq/ProgOptions.h>
#include <fairmq/tools/Unique.h>

#include <boost/container/pmr/polymorphic_allocator.hpp>

#include <gtest/gtest.h>

#include <cstring>
#include <string>
#include <vector>

namespace
{

using namespace std;
using namespace fair::mq;

using FactoryType = shared_ptr<TransportFactory>;

struct TestData
{
    int i{1};
    static int nallocated;
    static int nallocations;
    static int ndeallocations;

    TestData()
    {
        ++nallocated;
        ++nallocations;
    }

    TestData& operator=(const TestData&) = delete;
    TestData& operator=(TestData&&) = delete;

    TestData(const TestData& in)
        : i{in.i}
    {
        ++nallocated;
        ++nallocations;
    }

    TestData(const TestData&& in)
        : i{in.i}
    {
        ++nallocated;
        ++nallocations;
    }

    TestData(int in)
        : i{in}
    {
        ++nallocated;
        ++nallocations;
    }

    ~TestData()
    {
        --nallocated;
        ++ndeallocations;
    }
};

int TestData::nallocated = 0;
int TestData::nallocations = 0;
int TestData::ndeallocations = 0;

TEST(MemoryResources, transportAllocatorMap)
{
    size_t session{tools::UuidHash()};
    ProgOptions config;
    config.SetProperty<string>("session", to_string(session));
    config.SetProperty<bool>("shm-monitor", true);

    FactoryType factoryZMQ = TransportFactory::CreateTransportFactory("zeromq", fair::mq::tools::Uuid(), &config);
    FactoryType factorySHM = TransportFactory::CreateTransportFactory("shmem", fair::mq::tools::Uuid(), &config);

    auto allocZMQ = factoryZMQ->GetMemoryResource();
    auto allocSHM = factorySHM->GetMemoryResource();

    EXPECT_TRUE(allocZMQ != nullptr && allocSHM != allocZMQ);
    auto _tmp = factoryZMQ->GetMemoryResource();
    EXPECT_TRUE(_tmp == allocZMQ);
}

using namespace fair::mq::pmr;

TEST(MemoryResources, allocator)
{
    TestData::nallocations = 0;
    TestData::ndeallocations = 0;

    size_t session{tools::UuidHash()};
    ProgOptions config;
    config.SetProperty<std::string>("session", to_string(session));

    FactoryType factoryZMQ = TransportFactory::CreateTransportFactory("zeromq", fair::mq::tools::Uuid(), &config);

    auto allocZMQ = factoryZMQ->GetMemoryResource();

    {
        std::vector<TestData, polymorphic_allocator<TestData>> v(polymorphic_allocator<TestData>{allocZMQ});
        v.reserve(3);
        EXPECT_TRUE(v.capacity() == 3);
        EXPECT_TRUE(allocZMQ->getNumberOfMessages() == 1);
        v.emplace_back(1);
        v.emplace_back(2);
        v.emplace_back(3);
        EXPECT_TRUE((fair::mq::byte*)&(*v.end()) - (fair::mq::byte*)&(*v.begin()) == 3 * sizeof(TestData));
        EXPECT_TRUE(TestData::nallocated == 3);
    }
    EXPECT_TRUE(TestData::nallocated == 0);
    EXPECT_TRUE(TestData::nallocations == TestData::ndeallocations);
}

TEST(MemoryResources, getMessage)
{
    TestData::nallocations = 0;
    TestData::ndeallocations = 0;

    size_t session{tools::UuidHash()};
    ProgOptions config;
    config.SetProperty<std::string>("session", to_string(session));
    config.SetProperty<bool>("shm-monitor", true);

    FactoryType factoryZMQ = TransportFactory::CreateTransportFactory("zeromq", fair::mq::tools::Uuid(), &config);
    FactoryType factorySHM = TransportFactory::CreateTransportFactory("shmem", fair::mq::tools::Uuid(), &config);

    auto allocZMQ = factoryZMQ->GetMemoryResource();

    MessagePtr message{nullptr};

    int* messageArray{nullptr};

    // test message creation on the same channel it was allocated with
    {
        std::vector<TestData, polymorphic_allocator<TestData>> v(polymorphic_allocator<TestData>{allocZMQ});
        v.emplace_back(1);
        v.emplace_back(2);
        v.emplace_back(3);
        void* vectorBeginPtr = &v[0];
        message = getMessage(std::move(v));
        EXPECT_TRUE(message != nullptr);
        EXPECT_TRUE(message->GetData() == vectorBeginPtr);
    }
    EXPECT_TRUE(message->GetSize() == 3 * sizeof(TestData));
    messageArray = static_cast<int*>(message->GetData());
    EXPECT_TRUE(messageArray[0] == 1 && messageArray[1] == 2 && messageArray[2] == 3);

    // test message creation on a different channel than it was allocated with
    {
        std::vector<TestData, polymorphic_allocator<TestData>> v(polymorphic_allocator<TestData>{allocZMQ});
        v.emplace_back(4);
        v.emplace_back(5);
        v.emplace_back(6);
        void* vectorBeginPtr = &v[0];
        message = getMessage(std::move(v), *factorySHM);
        EXPECT_TRUE(message != nullptr);
        EXPECT_TRUE(message->GetData() != vectorBeginPtr);
    }

    EXPECT_TRUE(message->GetSize() == 3 * sizeof(TestData));
    messageArray = static_cast<int*>(message->GetData());
    EXPECT_TRUE(messageArray[0] == 4 && messageArray[1] == 5 && messageArray[2] == 6);
}

}   // namespace