pool.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: BSD-3-Clause
/* Copyright 2016-2021, Intel Corporation */
 
#ifndef LIBPMEMOBJ_CPP_POOL_HPP
#define LIBPMEMOBJ_CPP_POOL_HPP
 
#include <cstddef>
#include <errno.h>
#include <functional>
#include <mutex>
#include <string>
#include <sys/stat.h>
#include <typeindex>
#include <unordered_map>
#include <vector>
 
#include <libpmemobj++/detail/common.hpp>
#include <libpmemobj++/detail/ctl.hpp>
#include <libpmemobj++/detail/pool_data.hpp>
#include <libpmemobj++/p.hpp>
#include <libpmemobj++/persistent_ptr_base.hpp>
#include <libpmemobj++/pexceptions.hpp>
#include <libpmemobj/atomic_base.h>
#include <libpmemobj/pool_base.h>
 
namespace pmem
{
 
namespace obj
{
template <typename T>
class persistent_ptr;
 
class pool_base {
public:
    pool_base() noexcept : pop(nullptr)
    {
    }
 
    explicit pool_base(pmemobjpool *cpop) noexcept : pop(cpop)
    {
    }
 
    pool_base(const pool_base &) noexcept = default;
 
    pool_base(pool_base &&) noexcept = default;
 
    pool_base &operator=(const pool_base &) noexcept = default;
 
    pool_base &operator=(pool_base &&) noexcept = default;
 
    virtual ~pool_base() noexcept = default;
 
    static pool_base
    open(const std::string &path, const std::string &layout)
    {
#ifdef _WIN32
        pmemobjpool *pop = pmemobj_openU(path.c_str(), layout.c_str());
#else
        pmemobjpool *pop = pmemobj_open(path.c_str(), layout.c_str());
#endif
        check_pool(pop, "opening");
 
        pmemobj_set_user_data(pop, new detail::pool_data);
 
        return pool_base(pop);
    }
 
    static pool_base
    create(const std::string &path, const std::string &layout,
           std::size_t size = PMEMOBJ_MIN_POOL, mode_t mode = DEFAULT_MODE)
    {
#ifdef _WIN32
        pmemobjpool *pop = pmemobj_createU(path.c_str(), layout.c_str(),
                           size, mode);
#else
        pmemobjpool *pop = pmemobj_create(path.c_str(), layout.c_str(),
                          size, mode);
#endif
        check_pool(pop, "creating");
 
        pmemobj_set_user_data(pop, new detail::pool_data);
 
        return pool_base(pop);
    }
 
    static int
    check(const std::string &path, const std::string &layout) noexcept
    {
#ifdef _WIN32
        return pmemobj_checkU(path.c_str(), layout.c_str());
#else
        return pmemobj_check(path.c_str(), layout.c_str());
#endif
    }
 
#ifdef _WIN32
    static pool_base
    open(const std::wstring &path, const std::wstring &layout)
    {
        pmemobjpool *pop = pmemobj_openW(path.c_str(), layout.c_str());
        check_pool(pop, "opening");
 
        pmemobj_set_user_data(pop, new detail::pool_data);
 
        return pool_base(pop);
    }
 
    static pool_base
    create(const std::wstring &path, const std::wstring &layout,
           std::size_t size = PMEMOBJ_MIN_POOL, mode_t mode = DEFAULT_MODE)
    {
        pmemobjpool *pop = pmemobj_createW(path.c_str(), layout.c_str(),
                           size, mode);
        check_pool(pop, "creating");
 
        pmemobj_set_user_data(pop, new detail::pool_data);
 
        return pool_base(pop);
    }
 
    static int
    check(const std::wstring &path, const std::wstring &layout) noexcept
    {
        return pmemobj_checkW(path.c_str(), layout.c_str());
    }
#endif
 
    void
    close()
    {
        if (this->pop == nullptr)
            throw std::logic_error("Pool already closed");
 
        auto *user_data = static_cast<detail::pool_data *>(
            pmemobj_get_user_data(this->pop));
 
        if (user_data->initialized.load())
            user_data->cleanup();
 
        delete user_data;
 
        pmemobj_close(this->pop);
        this->pop = nullptr;
    }
 
    void
    persist(const void *addr, size_t len) noexcept
    {
        pmemobj_persist(this->pop, addr, len);
    }
 
    template <typename Y>
    void
    persist(const p<Y> &prop) noexcept
    {
        pmemobj_persist(this->pop, &prop, sizeof(Y));
    }
 
    template <typename Y>
    void
    persist(const persistent_ptr<Y> &ptr) noexcept
    {
        pmemobj_persist(this->pop, &ptr, sizeof(ptr));
    }
 
    void
    flush(const void *addr, size_t len) noexcept
    {
        pmemobj_flush(this->pop, addr, len);
    }
 
    template <typename Y>
    void
    flush(const p<Y> &prop) noexcept
    {
        pmemobj_flush(this->pop, &prop, sizeof(Y));
    }
 
    template <typename Y>
    void
    flush(const persistent_ptr<Y> &ptr) noexcept
    {
        pmemobj_flush(this->pop, &ptr, sizeof(ptr));
    }
 
    void
    drain(void) noexcept
    {
        pmemobj_drain(this->pop);
    }
 
    void *
    memcpy_persist(void *dest, const void *src, size_t len) noexcept
    {
        return pmemobj_memcpy_persist(this->pop, dest, src, len);
    }
 
    void *
    memset_persist(void *dest, int c, size_t len) noexcept
    {
        return pmemobj_memset_persist(this->pop, dest, c, len);
    }
 
    PMEMobjpool *
    handle() noexcept
    {
        return this->pop;
    }
 
    POBJ_CPP_DEPRECATED PMEMobjpool *
    get_handle() noexcept
    {
        return pool_base::handle();
    }
 
    pobj_defrag_result
    defrag(persistent_ptr_base **ptrv, size_t oidcnt)
    {
        pobj_defrag_result result;
        int ret = pmemobj_defrag(this->pop, (PMEMoid **)ptrv, oidcnt,
                     &result);
 
        if (ret != 0)
            throw detail::exception_with_errormsg<defrag_error>(
                result, "Defragmentation failed");
        return result;
    }
 
protected:
    static void
    check_pool(pmemobjpool *pop, std::string mode)
    {
        if (pop == nullptr) {
            std::string msg = "Failed " + mode + " pool";
            if (errno == EINVAL || errno == EFBIG ||
                errno == ENOENT || errno == EEXIST) {
                throw detail::exception_with_errormsg<
                    pmem::pool_invalid_argument>(msg);
            } else {
                throw detail::exception_with_errormsg<
                    pmem::pool_error>(msg);
            }
        }
    }
 
    /* The pool opaque handle */
    PMEMobjpool *pop;
 
#ifndef _WIN32
    static const int DEFAULT_MODE = S_IWUSR | S_IRUSR;
#else
    static const int DEFAULT_MODE = S_IWRITE | S_IREAD;
#endif
};
 
template <typename T>
class pool : public pool_base {
public:
    pool() noexcept = default;
 
    pool(const pool &) noexcept = default;
 
    pool(pool &&) noexcept = default;
 
    pool &operator=(const pool &) noexcept = default;
 
    pool &operator=(pool &&) noexcept = default;
 
    ~pool() noexcept = default;
 
    explicit pool(const pool_base &pb) noexcept : pool_base(pb)
    {
    }
 
    explicit pool(pool_base &&pb) noexcept : pool_base(pb)
    {
    }
 
    template <typename M>
    M
    ctl_get(const std::string &name)
    {
        return ctl_get_detail<M>(pop, name);
    }
 
    template <typename M>
    M
    ctl_set(const std::string &name, M arg)
    {
        return ctl_set_detail(pop, name, arg);
    }
 
    template <typename M>
    M
    ctl_exec(const std::string &name, M arg)
    {
        return ctl_exec_detail(pop, name, arg);
    }
 
#ifdef _WIN32
    template <typename M>
    M
    ctl_get(const std::wstring &name)
    {
        return ctl_get_detail<M>(pop, name);
    }
 
    template <typename M>
    M
    ctl_set(const std::wstring &name, M arg)
    {
        return ctl_set_detail(pop, name, arg);
    }
 
    template <typename M>
    M
    ctl_exec(const std::wstring &name, M arg)
    {
        return ctl_exec_detail(pop, name, arg);
    }
#endif
 
    persistent_ptr<T>
    root()
    {
        if (pop == nullptr)
            throw pmem::pool_error("Invalid pool handle");
 
        persistent_ptr<T> root = pmemobj_root(this->pop, sizeof(T));
        return root;
    }
 
    POBJ_CPP_DEPRECATED persistent_ptr<T>
    get_root()
    {
        return pool::root();
    }
 
    static pool<T>
    open(const std::string &path, const std::string &layout)
    {
        return pool<T>(pool_base::open(path, layout));
    }
 
    static pool<T>
    create(const std::string &path, const std::string &layout,
           std::size_t size = PMEMOBJ_MIN_POOL, mode_t mode = DEFAULT_MODE)
    {
        return pool<T>(pool_base::create(path, layout, size, mode));
    }
 
    static int
    check(const std::string &path, const std::string &layout)
    {
        return pool_base::check(path, layout);
    }
 
#ifdef _WIN32
    static pool<T>
    open(const std::wstring &path, const std::wstring &layout)
    {
        return pool<T>(pool_base::open(path, layout));
    }
 
    static pool<T>
    create(const std::wstring &path, const std::wstring &layout,
           std::size_t size = PMEMOBJ_MIN_POOL, mode_t mode = DEFAULT_MODE)
    {
        return pool<T>(pool_base::create(path, layout, size, mode));
    }
 
    static int
    check(const std::wstring &path, const std::wstring &layout)
    {
        return pool_base::check(path, layout);
    }
#endif
};
 
template <typename T>
T
ctl_get(const std::string &name)
{
    return ctl_get_detail<T>(nullptr, name);
}
 
template <typename T>
T
ctl_set(const std::string &name, T arg)
{
    return ctl_set_detail(nullptr, name, arg);
}
 
template <typename T>
T
ctl_exec(const std::string &name, T arg)
{
    return ctl_exec_detail(nullptr, name, arg);
}
 
#ifdef _WIN32
template <typename T>
T
ctl_get(const std::wstring &name)
{
    return ctl_get_detail<T>(nullptr, name);
}
 
template <typename T>
T
ctl_set(const std::wstring &name, T arg)
{
    return ctl_set_detail(nullptr, name, arg);
}
 
template <typename T>
T
ctl_exec(const std::wstring &name, T arg)
{
    return ctl_exec_detail(nullptr, name, arg);
}
#endif
 
} /* namespace obj */
 
} /* namespace pmem */
 
#endif /* LIBPMEMOBJ_CPP_POOL_HPP */