libstdc++
memory
Go to the documentation of this file.
1// <memory> -*- C++ -*-
2
3// Copyright (C) 2001-2022 Free Software Foundation, Inc.
4//
5// This file is part of the GNU ISO C++ Library. This library is free
6// software; you can redistribute it and/or modify it under the
7// terms of the GNU General Public License as published by the
8// Free Software Foundation; either version 3, or (at your option)
9// any later version.
10
11// This library is distributed in the hope that it will be useful,
12// but WITHOUT ANY WARRANTY; without even the implied warranty of
13// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14// GNU General Public License for more details.
15
16// Under Section 7 of GPL version 3, you are granted additional
17// permissions described in the GCC Runtime Library Exception, version
18// 3.1, as published by the Free Software Foundation.
19
20// You should have received a copy of the GNU General Public License and
21// a copy of the GCC Runtime Library Exception along with this program;
22// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23// <http://www.gnu.org/licenses/>.
24
25/*
26 * Copyright (c) 1997-1999
27 * Silicon Graphics Computer Systems, Inc.
28 *
29 * Permission to use, copy, modify, distribute and sell this software
30 * and its documentation for any purpose is hereby granted without fee,
31 * provided that the above copyright notice appear in all copies and
32 * that both that copyright notice and this permission notice appear
33 * in supporting documentation. Silicon Graphics makes no
34 * representations about the suitability of this software for any
35 * purpose. It is provided "as is" without express or implied warranty.
36 *
37 */
38
39/** @file include/memory
40 * This is a Standard C++ Library header.
41 * @ingroup memory
42 */
43
44#ifndef _GLIBCXX_MEMORY
45#define _GLIBCXX_MEMORY 1
46
47#pragma GCC system_header
48
49/**
50 * @defgroup memory Memory
51 * @ingroup utilities
52 *
53 * Components for memory allocation, deallocation, and management.
54 */
55
56/**
57 * @defgroup pointer_abstractions Pointer Abstractions
58 * @ingroup memory
59 *
60 * Smart pointers, etc.
61 */
62
63#include <bits/allocator.h>
64#include <bits/stl_construct.h>
65#include <bits/stl_uninitialized.h>
66#include <bits/stl_tempbuf.h>
67#include <bits/stl_raw_storage_iter.h>
68
69#if __cplusplus >= 201103L
70# include <type_traits>
71# include <bits/align.h>
72# include <bits/uses_allocator.h>
73# include <bits/alloc_traits.h>
74# include <debug/debug.h>
75# include <bits/unique_ptr.h>
76# include <bits/shared_ptr.h>
77# include <bits/shared_ptr_atomic.h>
78#endif
79
80#if __cplusplus < 201103L || _GLIBCXX_USE_DEPRECATED
81# include <backward/auto_ptr.h>
82#endif
83
84#if __cplusplus > 201703L
85# include <bits/ranges_uninitialized.h>
86# include <bits/uses_allocator_args.h>
87#endif
88
89#if __cplusplus >= 201103L && __cplusplus <= 202002L
90namespace std _GLIBCXX_VISIBILITY(default)
91{
92_GLIBCXX_BEGIN_NAMESPACE_VERSION
93
94/** @defgroup ptr_safety Pointer Safety and Garbage Collection
95 * @ingroup memory
96 *
97 * Utilities to assist with garbage collection in an implementation
98 * that supports <em>strict pointer safety</em>.
99 * This implementation only supports <em>relaxed pointer safety</em>
100 * and so these functions have no effect.
101 *
102 * C++11 20.6.4 [util.dynamic.safety], Pointer safety
103 *
104 * @{
105 */
106
107/// Constants representing the different types of pointer safety.
108enum class pointer_safety { relaxed, preferred, strict };
109
110/// Inform a garbage collector that an object is still in use.
111inline void
112declare_reachable(void*) { }
113
114/// Unregister an object previously registered with declare_reachable.
115template <typename _Tp>
116 inline _Tp*
117 undeclare_reachable(_Tp* __p) { return __p; }
118
119/// Inform a garbage collector that a region of memory need not be traced.
120inline void
121declare_no_pointers(char*, size_t) { }
122
123/// Unregister a range previously registered with declare_no_pointers.
124inline void
125undeclare_no_pointers(char*, size_t) { }
126
127/// The type of pointer safety supported by the implementation.
128inline pointer_safety
129get_pointer_safety() noexcept { return pointer_safety::relaxed; }
130/// @}
131
132_GLIBCXX_END_NAMESPACE_VERSION
133} // namespace
134#endif // C++11 to C++20
135
136#if __cplusplus >= 201703L
137// Parallel STL algorithms
138# if _PSTL_EXECUTION_POLICIES_DEFINED
139// If <execution> has already been included, pull in implementations
140# include <pstl/glue_memory_impl.h>
141# else
142// Otherwise just pull in forward declarations
143# include <pstl/glue_memory_defs.h>
144# endif
145
146// Feature test macro for parallel algorithms
147# define __cpp_lib_parallel_algorithm 201603L
148#endif // C++17
149
150#endif /* _GLIBCXX_MEMORY */