MemoryResource.h

Go to the documentation of this file.

#ifndef ZSERIO_PMR_I_MEMORY_RESOURCE_H_INC
#define ZSERIO_PMR_I_MEMORY_RESOURCE_H_INC
 
#ifdef ZSERIO_MEMORY_RESOURCE_TRACING
    #include <iostream>
#endif
 
#include "zserio/Types.h"
 
namespace zserio
{
namespace pmr
{
 
class MemoryResource
{
public:
    // this empty constructor is necessary for gcc 9.3.0 bug which causes test coverage failure
    MemoryResource() = default;
 
    virtual ~MemoryResource() = default;
 
    MemoryResource(const MemoryResource& other) = delete;
    MemoryResource(MemoryResource&& other) = delete;
 
    MemoryResource& operator=(const MemoryResource& other) = delete;
    MemoryResource& operator=(MemoryResource&& other) = delete;
    void* allocate(size_t bytes, size_t alignment = alignof(max_align_t))
    {
#ifdef ZSERIO_MEMORY_RESOURCE_TRACING
        void* const ptr = doAllocate(bytes, alignment);
        std::cout << "MemoryResource::allocate bytes=" << bytes << " alignment=" << alignment << " -> "
                  << std::hex << ptr << std::dec << std::endl;
        return ptr;
#else
        return doAllocate(bytes, alignment);
#endif
    }
 
    void deallocate(void* storage, size_t bytes, size_t alignment = alignof(max_align_t))
    {
#ifdef ZSERIO_MEMORY_RESOURCE_TRACING
        std::cout << "MemoryResource::deallocate p=" << std::hex << storage << std::dec << " bytes=" << bytes
                  << " alignment=" << alignment << std::endl;
#endif
        doDeallocate(storage, bytes, alignment);
    }
 
    bool isEqual(const MemoryResource& other) const noexcept
    {
#ifdef ZSERIO_MEMORY_RESOURCE_TRACING
        std::cout << "MemoryResource::isEqual other=" << std::hex << &other << std::dec << std::endl;
#endif
        return doIsEqual(other);
    }
 
private:
    virtual void* doAllocate(size_t bytes, size_t alignment) = 0;
 
    virtual void doDeallocate(void* storage, size_t bytes, size_t alignment) = 0;
 
    virtual bool doIsEqual(const MemoryResource& other) const noexcept = 0;
};
 
inline bool operator==(const MemoryResource& lhs, const MemoryResource& rhs)
{
    return &lhs == &rhs || lhs.isEqual(rhs);
}
 
inline bool operator!=(const MemoryResource& lhs, const MemoryResource& rhs)
{
    return !(lhs == rhs);
}
 
MemoryResource* getDefaultResource() noexcept;
 
MemoryResource* setDefaultResource(MemoryResource* resource) noexcept;
 
} // namespace pmr
} // namespace zserio
 
#endif // ZSERIO_PMR_I_MEMORY_RESOURCE_H_INC