Skip to content

Add OV_LIFETIME_BOUND attribute #862

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
FakeByte merged 1 commit into from
Sep 4, 2026
Merged

Add OV_LIFETIME_BOUND attribute #862

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions src/openvic-simulation/core/Typedefs.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,20 @@
#endif
#endif // OV_NO_UNIQUE_ADDRESS

#ifndef OV_LIFETIME_BOUND
#if __has_cpp_attribute(clang::lifetimebound)
#define OV_LIFETIME_BOUND [[clang::lifetimebound]]
#elif __has_cpp_attribute(gnu::lifetimebound)
#define OV_LIFETIME_BOUND [[gnu::lifetimebound]]
#elif __has_cpp_attribute(msvc::lifetimebound)
#define OV_LIFETIME_BOUND [[msvc::lifetimebound]]
#elif __has_cpp_attribute(lifetimebound)
#define OV_LIFETIME_BOUND [[lifetimebound]]
#else
#define OV_LIFETIME_BOUND
#endif
#endif // OV_LIFETIME_BOUND

namespace OpenVic {
template<std::size_t... Idxs>
constexpr auto substring_as_array(std::string_view str, std::index_sequence<Idxs...>) {
Expand Down
5 changes: 3 additions & 2 deletions src/openvic-simulation/core/io/BMP.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
#include <span>

#include "openvic-simulation/core/memory/Vector.hpp"
#include "openvic-simulation/core/Typedefs.hpp"

namespace OpenVic {
namespace fs = std::filesystem;
Expand Down Expand Up @@ -60,7 +61,7 @@ namespace OpenVic {
int32_t get_width() const;
int32_t get_height() const;
uint16_t get_bits_per_pixel() const;
std::span<const palette_colour_t> get_palette() const;
std::span<const uint8_t> get_pixel_data() const;
std::span<const palette_colour_t> get_palette() const OV_LIFETIME_BOUND;
std::span<const uint8_t> get_pixel_data() const OV_LIFETIME_BOUND;
};
}
10 changes: 5 additions & 5 deletions src/openvic-simulation/core/object/Colour.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -546,11 +546,11 @@ namespace OpenVic {
return operator integer_type() <=> rhs;
}

OV_SPEED_INLINE constexpr value_type& operator[](std::size_t index) {
OV_SPEED_INLINE constexpr value_type& operator[](std::size_t index) OV_LIFETIME_BOUND {
return _array_access_helper<value_type>(*this, index);
}

OV_SPEED_INLINE constexpr value_type const& operator[](std::size_t index) const {
OV_SPEED_INLINE constexpr value_type const& operator[](std::size_t index) const OV_LIFETIME_BOUND {
return _array_access_helper<const value_type>(*this, index);
}

Expand Down Expand Up @@ -611,7 +611,7 @@ namespace OpenVic {

public:
template<std::size_t Index>
OV_SPEED_INLINE auto&& get() & {
OV_SPEED_INLINE auto&& get() & OV_LIFETIME_BOUND {
return get_helper<Index>(*this);
}

Expand All @@ -621,12 +621,12 @@ namespace OpenVic {
}

template<std::size_t Index>
OV_SPEED_INLINE auto&& get() const& {
OV_SPEED_INLINE auto&& get() const& OV_LIFETIME_BOUND {
return get_helper<Index>(*this);
}

template<std::size_t Index>
OV_SPEED_INLINE auto&& get() const&& {
OV_SPEED_INLINE auto&& get() const&& OV_LIFETIME_BOUND {
return get_helper<Index>(*this);
}

Expand Down
7 changes: 4 additions & 3 deletions src/openvic-simulation/core/object/FixedPoint/String.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,23 @@
#include "openvic-simulation/core/object/FixedPoint.hpp"
#include "openvic-simulation/core/stl/containers/StackString.hpp"
#include "openvic-simulation/core/string/CharConv.hpp"
#include "openvic-simulation/core/Typedefs.hpp"
#include "openvic-simulation/utility/Logger.hpp"

namespace OpenVic::fp {
struct stack_string final : public StackString<25> {
protected:
using StackString::StackString;
public:
constexpr char* front() {
constexpr char* front() OV_LIFETIME_BOUND {
return _array.data();
}

constexpr char* back() {
constexpr char* back() OV_LIFETIME_BOUND {
return _array.data() + _array.size();
}

constexpr uint8_t& string_size() {
constexpr uint8_t& string_size() OV_LIFETIME_BOUND {
return _string_size;
}
};
Expand Down
4 changes: 2 additions & 2 deletions src/openvic-simulation/core/object/VectorN.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,11 +190,11 @@ namespace OpenVic {
return components;
}

OV_SPEED_INLINE constexpr T& operator[](size_t index) {
OV_SPEED_INLINE constexpr T& operator[](size_t index) OV_LIFETIME_BOUND {
return components[index % size];
}

OV_SPEED_INLINE constexpr T const& operator[](size_t index) const {
OV_SPEED_INLINE constexpr T const& operator[](size_t index) const OV_LIFETIME_BOUND {
return components[index % size];
}

Expand Down
4 changes: 2 additions & 2 deletions src/openvic-simulation/core/random/RandomGenerator.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,11 @@ namespace OpenVic {
return lhs._generator != rhs._generator;
}

[[nodiscard]] OV_ALWAYS_INLINE constexpr T& generator() {
[[nodiscard]] OV_ALWAYS_INLINE constexpr T& generator() OV_LIFETIME_BOUND {
return _generator;
}

[[nodiscard]] OV_ALWAYS_INLINE constexpr T const& generator() const {
[[nodiscard]] OV_ALWAYS_INLINE constexpr T const& generator() const OV_LIFETIME_BOUND {
return _generator;
}

Expand Down
49 changes: 25 additions & 24 deletions src/openvic-simulation/core/stl/containers/BulkInsertWrapper.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
#include <utility>

#include "openvic-simulation/core/Assert.hpp"
#include "openvic-simulation/core/Typedefs.hpp"

namespace OpenVic {
// not thread safe
Expand Down Expand Up @@ -64,74 +65,74 @@ namespace OpenVic {
}

// Element access based on std::vector
constexpr reference operator[](const size_type pos) {
constexpr reference operator[](const size_type pos) OV_LIFETIME_BOUND {
OV_HARDEN_ASSERT_ACCESS(pos, "operator[]");
return container[pos];
}
constexpr const_reference operator[](const size_type pos) const {
constexpr const_reference operator[](const size_type pos) const OV_LIFETIME_BOUND {
OV_HARDEN_ASSERT_ACCESS(pos, "operator[]");
return container[pos];
}

constexpr reference front() {
constexpr reference front() OV_LIFETIME_BOUND {
OV_HARDEN_ASSERT_NONEMPTY("front");
return container[0];
}
constexpr const_reference front() const {
constexpr const_reference front() const OV_LIFETIME_BOUND {
OV_HARDEN_ASSERT_NONEMPTY("front");
return container[0];
}
constexpr reference back() {

constexpr reference back() OV_LIFETIME_BOUND {
OV_HARDEN_ASSERT_NONEMPTY("back");
return container[size()-1];
}
constexpr const_reference back() const {
constexpr const_reference back() const OV_LIFETIME_BOUND {
OV_HARDEN_ASSERT_NONEMPTY("back");
return container[size()-1];
}

constexpr value_type* data() noexcept { return container.data(); }
constexpr value_type const* data() const noexcept { return container.data(); }
constexpr value_type* data() noexcept OV_LIFETIME_BOUND { return container.data(); }
constexpr value_type const* data() const noexcept OV_LIFETIME_BOUND { return container.data(); }

// Iterators based on std::vector
constexpr iterator begin() noexcept {
constexpr iterator begin() noexcept OV_LIFETIME_BOUND {
return container.begin();
}
constexpr const_iterator begin() const noexcept {
constexpr const_iterator begin() const noexcept OV_LIFETIME_BOUND {
return container.begin();
}
constexpr const_iterator cbegin() const noexcept {
constexpr const_iterator cbegin() const noexcept OV_LIFETIME_BOUND {
return container.cbegin();
}

constexpr iterator end() noexcept {
constexpr iterator end() noexcept OV_LIFETIME_BOUND {
return container.end();
}
constexpr const_iterator end() const noexcept {
constexpr const_iterator end() const noexcept OV_LIFETIME_BOUND {
return container.end();
}
constexpr const_iterator cend() const noexcept {
constexpr const_iterator cend() const noexcept OV_LIFETIME_BOUND {
return container.cend();
}

constexpr reverse_iterator rbegin() noexcept {
constexpr reverse_iterator rbegin() noexcept OV_LIFETIME_BOUND {
return container.rbegin();
}
constexpr const_reverse_iterator rbegin() const noexcept {
constexpr const_reverse_iterator rbegin() const noexcept OV_LIFETIME_BOUND {
return container.rbegin();
}
constexpr const_reverse_iterator crbegin() const noexcept {
constexpr const_reverse_iterator crbegin() const noexcept OV_LIFETIME_BOUND {
return container.crbegin();
}

constexpr reverse_iterator rend() noexcept {
constexpr reverse_iterator rend() noexcept OV_LIFETIME_BOUND {
return container.rend();
}
constexpr const_reverse_iterator rend() const noexcept {
constexpr const_reverse_iterator rend() const noexcept OV_LIFETIME_BOUND {
return container.rend();
}
constexpr const_reverse_iterator crend() const noexcept {
constexpr const_reverse_iterator crend() const noexcept OV_LIFETIME_BOUND {
return container.crend();
}

Expand Down Expand Up @@ -173,7 +174,7 @@ namespace OpenVic {

template<typename... Args>
requires std::is_trivially_destructible_v<value_type>
constexpr reference emplace_back(Args&&... args) {
constexpr reference emplace_back(Args&&... args) OV_LIFETIME_BOUND {
return container.emplace_back(std::forward<Args>(args)...);
}

Expand All @@ -185,7 +186,7 @@ namespace OpenVic {
template <typename InputIt>
constexpr void append_range(const InputIt first, const InputIt last) {
flush_pending_room();

const size_type new_valid_size = size() + std::distance(first, last);
if (new_valid_size > container.capacity()) {
assert(!"append_range called without make_room_for");
Expand All @@ -198,4 +199,4 @@ namespace OpenVic {

// resize() is omitted as we manage that via make_room_for
};
}
}
16 changes: 8 additions & 8 deletions src/openvic-simulation/core/stl/containers/CowPtr.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,26 +113,26 @@ namespace OpenVic::stl {
return *this;
}

OV_ALWAYS_INLINE reference write() {
OV_ALWAYS_INLINE reference write() OV_LIFETIME_BOUND {
if (data->count != 1) {
*this = cow_ptr(read(), payload_allocator_traits::select_on_container_copy_construction(alloc));
}
return data->value;
}

OV_ALWAYS_INLINE const_reference read() const {
OV_ALWAYS_INLINE const_reference read() const OV_LIFETIME_BOUND {
return data->value;
}

OV_ALWAYS_INLINE const_pointer get() const {
OV_ALWAYS_INLINE const_pointer get() const OV_LIFETIME_BOUND {
return &read();
}

OV_ALWAYS_INLINE const_reference operator*() const {
OV_ALWAYS_INLINE const_reference operator*() const OV_LIFETIME_BOUND {
return read();
}

OV_ALWAYS_INLINE const_pointer operator->() const {
OV_ALWAYS_INLINE const_pointer operator->() const OV_LIFETIME_BOUND {
return get();
}

Expand All @@ -142,7 +142,7 @@ namespace OpenVic::stl {

template<typename... Args>
requires std::constructible_from<T, Args...>
OV_ALWAYS_INLINE const_reference emplace(Args&&... args) {
OV_ALWAYS_INLINE const_reference emplace(Args&&... args) OV_LIFETIME_BOUND {
if (data->count > 1) {
~cow_ptr();
data = _allocate_payload();
Expand All @@ -155,7 +155,7 @@ namespace OpenVic::stl {

template<typename U, typename... Args>
requires std::constructible_from<T, std::initializer_list<U>&, Args&&...>
OV_ALWAYS_INLINE const_reference emplace(std::initializer_list<U> ilist, Args&&... args) {
OV_ALWAYS_INLINE const_reference emplace(std::initializer_list<U> ilist, Args&&... args) OV_LIFETIME_BOUND {
if (data->count > 1) {
~cow_ptr();
data = _allocate_payload();
Expand Down Expand Up @@ -189,7 +189,7 @@ namespace OpenVic::stl {
OV_NO_UNIQUE_ADDRESS payload_allocator_type alloc;
payload* data;

inline payload* _allocate_payload() {
inline payload* _allocate_payload() OV_LIFETIME_BOUND {
return payload_allocator_traits::allocate(alloc, 1);
}
};
Expand Down
Loading
Loading