persistent_ptr_base.hpp

Go to the documentation of this file.

/*
 * Copyright 2016-2020, Intel Corporation
 *
 * 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 the copyright holder 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 THE COPYRIGHT
 * OWNER OR 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.
 */
 
#ifndef LIBPMEMOBJ_CPP_PERSISTENT_PTR_BASE_HPP
#define LIBPMEMOBJ_CPP_PERSISTENT_PTR_BASE_HPP
 
#include <cstdint>
#include <type_traits>
 
#include <libpmemobj++/detail/common.hpp>
#include <libpmemobj++/detail/specialization.hpp>
#include <libpmemobj/base.h>
 
/* Windows has a max macro which collides with std::numeric_limits::max */
#if defined(max) && defined(_WIN32)
#undef max
#endif
 
namespace pmem
{
 
namespace obj
{
 
class persistent_ptr_base {
public:
    persistent_ptr_base() noexcept : oid(OID_NULL)
    {
    }
 
    /*
     * Curly braces initialization is not used because the
     * PMEMoid is a plain C (POD) type and we can't add a default
     * constructor in there.
     */
 
    persistent_ptr_base(PMEMoid oid) noexcept : oid(oid)
    {
    }
 
    /*
     * Copy constructor.
     *
     * @param r Persistent pointer to the same type.
     */
    persistent_ptr_base(persistent_ptr_base const &r) noexcept : oid(r.oid)
    {
    }
 
    persistent_ptr_base(persistent_ptr_base &&r) noexcept
        : oid(std::move(r.oid))
    {
    }
 
    persistent_ptr_base &
    operator=(persistent_ptr_base &&r)
    {
        detail::conditional_add_to_tx(this);
        this->oid = std::move(r.oid);
 
        return *this;
    }
 
    persistent_ptr_base &
    operator=(persistent_ptr_base const &r)
    {
        detail::conditional_add_to_tx(this);
        this->oid = r.oid;
 
        return *this;
    }
 
    persistent_ptr_base &
    operator=(std::nullptr_t &&)
    {
        detail::conditional_add_to_tx(this);
        this->oid = {0, 0};
        return *this;
    }
 
    void
    swap(persistent_ptr_base &other)
    {
        detail::conditional_add_to_tx(this);
        detail::conditional_add_to_tx(&other);
        std::swap(this->oid, other.oid);
    }
 
    const PMEMoid &
    raw() const noexcept
    {
        return this->oid;
    }
 
    PMEMoid *
    raw_ptr() noexcept
    {
        return &(this->oid);
    }
 
protected:
    /* The underlying PMEMoid of the held object. */
    PMEMoid oid;
};
 
} /* namespace obj */
 
} /* namespace pmem */
 
#endif /* LIBPMEMOBJ_CPP_PERSISTENT_PTR_BASE_HPP */