1//===----------------------------------------------------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef _LIBCPP___MEMORY_RESOURCE_MEMORY_RESOURCE_H
10#define _LIBCPP___MEMORY_RESOURCE_MEMORY_RESOURCE_H
11
12#include <__config>
13#include <__cstddef/max_align_t.h>
14#include <__cstddef/size_t.h>
15#include <__fwd/memory_resource.h>
16
17#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
18# pragma GCC system_header
19#endif
20
21#if _LIBCPP_STD_VER >= 17
22
23_LIBCPP_BEGIN_NAMESPACE_STD
24
25namespace pmr {
26
27// [mem.res.class]
28
29class _LIBCPP_AVAILABILITY_PMR _LIBCPP_EXPORTED_FROM_ABI memory_resource {
30 static const size_t __max_align = alignof(max_align_t);
31
32public:
33 virtual ~memory_resource();
34
35 [[nodiscard]] [[using __gnu__: __returns_nonnull__, __alloc_size__(2), __alloc_align__(3)]]
36 _LIBCPP_HIDE_FROM_ABI void* allocate(size_t __bytes, size_t __align = __max_align) {
37 return do_allocate(__bytes, __align);
38 }
39
40 [[__gnu__::__nonnull__]] _LIBCPP_HIDE_FROM_ABI void
41 deallocate(void* __p, size_t __bytes, size_t __align = __max_align) {
42 do_deallocate(__p, __bytes, __align);
43 }
44
45 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI bool is_equal(const memory_resource& __other) const noexcept {
46 return do_is_equal(__other);
47 }
48
49private:
50 virtual void* do_allocate(size_t, size_t) = 0;
51 virtual void do_deallocate(void*, size_t, size_t) = 0;
52 virtual bool do_is_equal(memory_resource const&) const noexcept = 0;
53};
54
55// [mem.res.eq]
56
57inline _LIBCPP_AVAILABILITY_PMR _LIBCPP_HIDE_FROM_ABI bool
58operator==(const memory_resource& __lhs, const memory_resource& __rhs) noexcept {
59 return &__lhs == &__rhs || __lhs.is_equal(__rhs);
60}
61
62# if _LIBCPP_STD_VER <= 17
63
64inline _LIBCPP_AVAILABILITY_PMR _LIBCPP_HIDE_FROM_ABI bool
65operator!=(const memory_resource& __lhs, const memory_resource& __rhs) noexcept {
66 return !(__lhs == __rhs);
67}
68
69# endif
70
71// [mem.res.global]
72
73[[nodiscard, __gnu__::__returns_nonnull__]] _LIBCPP_AVAILABILITY_PMR _LIBCPP_EXPORTED_FROM_ABI memory_resource*
74get_default_resource() noexcept;
75
76[[__gnu__::__returns_nonnull__]] _LIBCPP_AVAILABILITY_PMR _LIBCPP_EXPORTED_FROM_ABI memory_resource*
77set_default_resource(memory_resource*) noexcept;
78
79[[using __gnu__: __returns_nonnull__, __const__]] _LIBCPP_AVAILABILITY_PMR _LIBCPP_EXPORTED_FROM_ABI memory_resource*
80new_delete_resource() noexcept;
81
82[[using __gnu__: __returns_nonnull__, __const__]] _LIBCPP_AVAILABILITY_PMR _LIBCPP_EXPORTED_FROM_ABI memory_resource*
83null_memory_resource() noexcept;
84
85} // namespace pmr
86
87_LIBCPP_END_NAMESPACE_STD
88
89#endif // _LIBCPP_STD_VER >= 17
90
91#endif // _LIBCPP___MEMORY_RESOURCE_MEMORY_RESOURCE_H