1// <memory> -*- C++ -*-
2
3// Copyright (C) 2001-2021 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/stl_algobase.h>
64#include <bits/allocator.h>
65#include <bits/stl_construct.h>
66#include <bits/stl_uninitialized.h>
67#include <bits/stl_tempbuf.h>
68#include <bits/stl_raw_storage_iter.h>
69
70#if __cplusplus >= 201103L
71#  include <type_traits>
72#  include <bits/align.h>
73#  include <bits/uses_allocator.h>
74#  include <bits/alloc_traits.h>
75#  include <debug/debug.h>
76#  include <bits/unique_ptr.h>
77#  include <bits/shared_ptr.h>
78#  include <bits/shared_ptr_atomic.h>
79#endif
80
81#if __cplusplus < 201103L || _GLIBCXX_USE_DEPRECATED
82#  include <backward/auto_ptr.h>
83#endif
84
85#if __cplusplus > 201703L
86#  include <bits/ranges_uninitialized.h>
87#  include <bits/uses_allocator_args.h>
88#endif
89
90#if __cplusplus >= 201103L
91namespace std _GLIBCXX_VISIBILITY(default)
92{
93_GLIBCXX_BEGIN_NAMESPACE_VERSION
94
95/** @defgroup ptr_safety Pointer Safety and Garbage Collection
96 *  @ingroup memory
97 *
98 * Utilities to assist with garbage collection in an implementation
99 * that supports <em>strict pointer safety</em>.
100 * This implementation only supports <em>relaxed pointer safety</em>
101 * and so these functions have no effect.
102 *
103 * C++11 20.6.4 [util.dynamic.safety], Pointer safety
104 *
105 * @{
106 */
107
108/// Constants representing the different types of pointer safety.
109enum class pointer_safety { relaxed, preferred, strict };
110
111/// Inform a garbage collector that an object is still in use.
112inline void
113declare_reachable(void*) { }
114
115/// Unregister an object previously registered with declare_reachable.
116template <typename _Tp>
117  inline _Tp*
118  undeclare_reachable(_Tp* __p) { return __p; }
119
120/// Inform a garbage collector that a region of memory need not be traced.
121inline void
122declare_no_pointers(char*, size_t) { }
123
124/// Unregister a range previously registered with declare_no_pointers.
125inline void
126undeclare_no_pointers(char*, size_t) { }
127
128/// The type of pointer safety supported by the implementation.
129inline pointer_safety
130get_pointer_safety() noexcept { return pointer_safety::relaxed; }
131/// @}
132
133_GLIBCXX_END_NAMESPACE_VERSION
134} // namespace
135#endif // C++11
136
137#if __cplusplus >= 201703L
138// Parallel STL algorithms
139# if _PSTL_EXECUTION_POLICIES_DEFINED
140// If <execution> has already been included, pull in implementations
141#  include <pstl/glue_memory_impl.h>
142# else
143// Otherwise just pull in forward declarations
144#  include <pstl/glue_memory_defs.h>
145# endif
146
147// Feature test macro for parallel algorithms
148# define __cpp_lib_parallel_algorithm 201603L
149#endif // C++17
150
151#endif /* _GLIBCXX_MEMORY */
152