utils.hpp
Go to the documentation of this file.
/*
* Copyright 2016-2017, 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_UTILS_HPP
#define LIBPMEMOBJ_UTILS_HPP
#include "libpmemobj++/detail/pexceptions.hpp"
#include "libpmemobj++/persistent_ptr.hpp"
#include "libpmemobj/base.h"
namespace pmem
{
namespace obj
{
template <typename T>
inline pool_base
pool_by_vptr(const T *that)
{
auto pop = pmemobj_pool_by_ptr(that);
if (!pop)
throw pool_error("Object not in an open pool.");
return pool_base(pop);
}
template <typename T>
inline pool_base
pool_by_pptr(const persistent_ptr<T> ptr)
{
auto pop = pmemobj_pool_by_oid(ptr.raw());
if (!pop)
throw pool_error("Object not in an open pool.");
return pool_base(pop);
}
} /* namespace obj */
} /* namespace pmem */
#endif /* LIBPMEMOBJ_UTILS_HPP */
pmem::obj::persistent_ptr
Persistent pointer class.
Definition: common.hpp:51
pmem::obj::pool_base
The non-template pool base class.
Definition: pool.hpp:65
pmem::pool_error
Custom pool error class.
Definition: pexceptions.hpp:53
pexceptions.hpp
Custom exceptions.
pmem::obj::pool_by_pptr
pool_base pool_by_pptr(const persistent_ptr< T > ptr)
Retrieve pool handle for the given persistent_ptr.
Definition: utils.hpp:81
pmem::obj::pool_by_vptr
pool_base pool_by_vptr(const T *that)
Retrieve pool handle for the given pointer.
Definition: utils.hpp:61
persistent_ptr.hpp
Persistent smart pointer.
pmem::detail::persistent_ptr_base::raw
const PMEMoid & raw() const noexcept
Get PMEMoid encapsulated by this object.
Definition: persistent_ptr_base.hpp:296
pmem
Definition: allocator.hpp:48