Files
scylladb/utils/managed_ref.hh
Avi Kivity f3eade2f62 treewide: relicense to ScyllaDB-Source-Available-1.0
Drop the AGPL license in favor of a source-available license.
See the blog post [1] for details.

[1] https://www.scylladb.com/2024/12/18/why-were-moving-to-a-source-available-license/
2024-12-18 17:45:13 +02:00

127 lines
2.8 KiB
C++

/*
* Copyright (C) 2015-present ScyllaDB
*/
/*
* SPDX-License-Identifier: LicenseRef-ScyllaDB-Source-Available-1.0
*/
#pragma once
#include "utils/allocation_strategy.hh"
template<typename T>
requires std::is_nothrow_move_constructible_v<T>
class managed;
//
// Similar to std::unique_ptr<>, but for LSA-allocated objects. Remains
// valid across deferring points. See make_managed().
//
// std::unique_ptr<> can't be used with LSA-allocated objects because
// it assumes that the object doesn't move after being allocated. This
// is not true for LSA, which moves objects during compaction.
//
// Also works for objects allocated using standard allocators, though
// there the extra space overhead of a pointer is not justified.
// It still make sense to use it in places which are meant to work
// with either kind of allocator.
//
template<typename T>
struct managed_ref {
managed<T>* _ptr;
managed_ref() : _ptr(nullptr) {}
managed_ref(const managed_ref&) = delete;
managed_ref(managed_ref&& other) noexcept
: _ptr(other._ptr)
{
other._ptr = nullptr;
if (_ptr) {
_ptr->_backref = &_ptr;
}
}
~managed_ref() {
if (_ptr) {
current_allocator().destroy(_ptr);
}
}
managed_ref& operator=(managed_ref&& o) {
this->~managed_ref();
new (this) managed_ref(std::move(o));
return *this;
}
T* get() {
return _ptr ? &_ptr->_value : nullptr;
}
const T* get() const {
return _ptr ? &_ptr->_value : nullptr;
}
T& operator*() {
return _ptr->_value;
}
const T& operator*() const {
return _ptr->_value;
}
T* operator->() {
return &_ptr->_value;
}
const T* operator->() const {
return &_ptr->_value;
}
explicit operator bool() const {
return _ptr != nullptr;
}
size_t external_memory_usage() const {
return _ptr ? current_allocator().object_memory_size_in_allocator(_ptr) : 0;
}
};
template<typename T>
requires std::is_nothrow_move_constructible_v<T>
class managed {
managed<T>** _backref;
T _value;
template<typename T_>
friend struct managed_ref;
public:
managed(managed<T>** backref, T&& v) noexcept
: _backref(backref)
, _value(std::move(v))
{
*_backref = this;
}
managed(managed&& other) noexcept
: _backref(other._backref)
, _value(std::move(other._value))
{
*_backref = this;
}
};
//
// Allocates T using given AllocationStrategy and returns a managed_ref owning the
// allocated object.
//
template<typename T, typename... Args>
managed_ref<T>
make_managed(Args&&... args) {
managed_ref<T> ref;
current_allocator().construct<managed<T>>(&ref._ptr, T(std::forward<Args>(args)...));
return ref;
}