buzbee | 862a760 | 2013-04-05 10:58:54 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2013 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
David Sehr | 1ce2b3b | 2018-04-05 11:02:03 -0700 | [diff] [blame] | 17 | #ifndef ART_LIBARTBASE_BASE_ARENA_ALLOCATOR_H_ |
| 18 | #define ART_LIBARTBASE_BASE_ARENA_ALLOCATOR_H_ |
buzbee | 862a760 | 2013-04-05 10:58:54 -0700 | [diff] [blame] | 19 | |
buzbee | 862a760 | 2013-04-05 10:58:54 -0700 | [diff] [blame] | 20 | #include <stddef.h> |
Andreas Gampe | 8cf9cb3 | 2017-07-19 09:28:38 -0700 | [diff] [blame] | 21 | #include <stdint.h> |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 22 | |
David Sehr | 1979c64 | 2018-04-26 14:41:18 -0700 | [diff] [blame^] | 23 | #include "bit_utils.h" |
| 24 | #include "debug_stack.h" |
| 25 | #include "dchecked_vector.h" |
| 26 | #include "macros.h" |
| 27 | #include "memory_tool.h" |
buzbee | 862a760 | 2013-04-05 10:58:54 -0700 | [diff] [blame] | 28 | |
| 29 | namespace art { |
| 30 | |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 31 | class Arena; |
| 32 | class ArenaPool; |
| 33 | class ArenaAllocator; |
Vladimir Marko | 83cc7ae | 2014-02-12 18:02:05 +0000 | [diff] [blame] | 34 | class ArenaStack; |
| 35 | class ScopedArenaAllocator; |
| 36 | class MemStats; |
| 37 | |
Vladimir Marko | 8081d2b | 2014-07-31 15:33:43 +0100 | [diff] [blame] | 38 | template <typename T> |
| 39 | class ArenaAllocatorAdapter; |
| 40 | |
Vladimir Marko | 83cc7ae | 2014-02-12 18:02:05 +0000 | [diff] [blame] | 41 | static constexpr bool kArenaAllocatorCountAllocations = false; |
| 42 | |
| 43 | // Type of allocation for memory tuning. |
| 44 | enum ArenaAllocKind { |
| 45 | kArenaAllocMisc, |
Vladimir Marko | e39c54e | 2014-09-22 14:50:02 +0100 | [diff] [blame] | 46 | kArenaAllocSwitchTable, |
Vladimir Marko | e39c54e | 2014-09-22 14:50:02 +0100 | [diff] [blame] | 47 | kArenaAllocSlowPaths, |
Vladimir Marko | 83cc7ae | 2014-02-12 18:02:05 +0000 | [diff] [blame] | 48 | kArenaAllocGrowableBitMap, |
Vladimir Marko | 83cc7ae | 2014-02-12 18:02:05 +0000 | [diff] [blame] | 49 | kArenaAllocSTL, |
Vladimir Marko | 2aaa4b5 | 2015-09-17 17:03:26 +0100 | [diff] [blame] | 50 | kArenaAllocGraphBuilder, |
Vladimir Marko | f9f6441 | 2015-09-02 14:05:49 +0100 | [diff] [blame] | 51 | kArenaAllocGraph, |
| 52 | kArenaAllocBasicBlock, |
Vladimir Marko | fa6b93c | 2015-09-15 10:15:55 +0100 | [diff] [blame] | 53 | kArenaAllocBlockList, |
| 54 | kArenaAllocReversePostOrder, |
| 55 | kArenaAllocLinearOrder, |
| 56 | kArenaAllocConstantsMap, |
Vladimir Marko | 6058455 | 2015-09-03 13:35:12 +0000 | [diff] [blame] | 57 | kArenaAllocPredecessors, |
| 58 | kArenaAllocSuccessors, |
| 59 | kArenaAllocDominated, |
Vladimir Marko | f9f6441 | 2015-09-02 14:05:49 +0100 | [diff] [blame] | 60 | kArenaAllocInstruction, |
Igor Murashkin | d01745e | 2017-04-05 16:40:31 -0700 | [diff] [blame] | 61 | kArenaAllocConstructorFenceInputs, |
Vladimir Marko | fa6b93c | 2015-09-15 10:15:55 +0100 | [diff] [blame] | 62 | kArenaAllocInvokeInputs, |
| 63 | kArenaAllocPhiInputs, |
Vladimir Marko | 175e786 | 2018-03-27 09:03:13 +0000 | [diff] [blame] | 64 | kArenaAllocTypeCheckInputs, |
Vladimir Marko | f9f6441 | 2015-09-02 14:05:49 +0100 | [diff] [blame] | 65 | kArenaAllocLoopInfo, |
Vladimir Marko | fa6b93c | 2015-09-15 10:15:55 +0100 | [diff] [blame] | 66 | kArenaAllocLoopInfoBackEdges, |
Vladimir Marko | f9f6441 | 2015-09-02 14:05:49 +0100 | [diff] [blame] | 67 | kArenaAllocTryCatchInfo, |
| 68 | kArenaAllocUseListNode, |
| 69 | kArenaAllocEnvironment, |
Vladimir Marko | fa6b93c | 2015-09-15 10:15:55 +0100 | [diff] [blame] | 70 | kArenaAllocEnvironmentVRegs, |
| 71 | kArenaAllocEnvironmentLocations, |
Vladimir Marko | 2aaa4b5 | 2015-09-17 17:03:26 +0100 | [diff] [blame] | 72 | kArenaAllocLocationSummary, |
Vladimir Marko | 71bf809 | 2015-09-15 15:33:14 +0100 | [diff] [blame] | 73 | kArenaAllocSsaBuilder, |
Vladimir Marko | f9f6441 | 2015-09-02 14:05:49 +0100 | [diff] [blame] | 74 | kArenaAllocMoveOperands, |
| 75 | kArenaAllocCodeBuffer, |
| 76 | kArenaAllocStackMaps, |
Vladimir Marko | f9f6441 | 2015-09-02 14:05:49 +0100 | [diff] [blame] | 77 | kArenaAllocOptimization, |
Vladimir Marko | 2aaa4b5 | 2015-09-17 17:03:26 +0100 | [diff] [blame] | 78 | kArenaAllocGvn, |
Vladimir Marko | 5233f93 | 2015-09-29 19:01:15 +0100 | [diff] [blame] | 79 | kArenaAllocInductionVarAnalysis, |
| 80 | kArenaAllocBoundsCheckElimination, |
Vladimir Marko | f6a35de | 2016-03-21 12:01:50 +0000 | [diff] [blame] | 81 | kArenaAllocDCE, |
Vladimir Marko | 009d166 | 2017-10-10 13:21:15 +0100 | [diff] [blame] | 82 | kArenaAllocLSA, |
Vladimir Marko | f6a35de | 2016-03-21 12:01:50 +0000 | [diff] [blame] | 83 | kArenaAllocLSE, |
Igor Murashkin | dd018df | 2017-08-09 10:38:31 -0700 | [diff] [blame] | 84 | kArenaAllocCFRE, |
Vladimir Marko | f6a35de | 2016-03-21 12:01:50 +0000 | [diff] [blame] | 85 | kArenaAllocLICM, |
Aart Bik | 9620230 | 2016-10-04 17:33:56 -0700 | [diff] [blame] | 86 | kArenaAllocLoopOptimization, |
Vladimir Marko | 2aaa4b5 | 2015-09-17 17:03:26 +0100 | [diff] [blame] | 87 | kArenaAllocSsaLiveness, |
| 88 | kArenaAllocSsaPhiElimination, |
| 89 | kArenaAllocReferenceTypePropagation, |
Aart Bik | 6d05700 | 2018-04-09 15:39:58 -0700 | [diff] [blame] | 90 | kArenaAllocSelectGenerator, |
Vladimir Marko | 2aaa4b5 | 2015-09-17 17:03:26 +0100 | [diff] [blame] | 91 | kArenaAllocSideEffectsAnalysis, |
| 92 | kArenaAllocRegisterAllocator, |
Vladimir Marko | f6a35de | 2016-03-21 12:01:50 +0000 | [diff] [blame] | 93 | kArenaAllocRegisterAllocatorValidate, |
Vladimir Marko | 225b646 | 2015-09-28 12:17:40 +0100 | [diff] [blame] | 94 | kArenaAllocStackMapStream, |
Aart Bik | 92685a8 | 2017-03-06 11:13:43 -0800 | [diff] [blame] | 95 | kArenaAllocVectorNode, |
Vladimir Marko | 225b646 | 2015-09-28 12:17:40 +0100 | [diff] [blame] | 96 | kArenaAllocCodeGenerator, |
Vladimir Marko | 93205e3 | 2016-04-13 11:59:46 +0100 | [diff] [blame] | 97 | kArenaAllocAssembler, |
Vladimir Marko | 225b646 | 2015-09-28 12:17:40 +0100 | [diff] [blame] | 98 | kArenaAllocParallelMoveResolver, |
Vladimir Marko | 655e585 | 2015-10-12 10:38:28 +0100 | [diff] [blame] | 99 | kArenaAllocGraphChecker, |
Mathieu Chartier | de40d47 | 2015-10-15 17:47:48 -0700 | [diff] [blame] | 100 | kArenaAllocVerifier, |
Vladimir Marko | 93205e3 | 2016-04-13 11:59:46 +0100 | [diff] [blame] | 101 | kArenaAllocCallingConvention, |
Mingyao Yang | 063fc77 | 2016-08-02 11:02:54 -0700 | [diff] [blame] | 102 | kArenaAllocCHA, |
Alexandre Rames | 22aa54b | 2016-10-18 09:32:29 +0100 | [diff] [blame] | 103 | kArenaAllocScheduler, |
Calin Juravle | cc3171a | 2017-05-19 16:47:53 -0700 | [diff] [blame] | 104 | kArenaAllocProfile, |
Artem Serov | 7f4aff6 | 2017-06-21 17:02:18 +0100 | [diff] [blame] | 105 | kArenaAllocSuperblockCloner, |
Vladimir Marko | 83cc7ae | 2014-02-12 18:02:05 +0000 | [diff] [blame] | 106 | kNumArenaAllocKinds |
| 107 | }; |
| 108 | |
| 109 | template <bool kCount> |
| 110 | class ArenaAllocatorStatsImpl; |
| 111 | |
| 112 | template <> |
| 113 | class ArenaAllocatorStatsImpl<false> { |
| 114 | public: |
| 115 | ArenaAllocatorStatsImpl() = default; |
| 116 | ArenaAllocatorStatsImpl(const ArenaAllocatorStatsImpl& other) = default; |
| 117 | ArenaAllocatorStatsImpl& operator = (const ArenaAllocatorStatsImpl& other) = delete; |
| 118 | |
Roland Levillain | 4b8f1ec | 2015-08-26 18:34:03 +0100 | [diff] [blame] | 119 | void Copy(const ArenaAllocatorStatsImpl& other ATTRIBUTE_UNUSED) {} |
| 120 | void RecordAlloc(size_t bytes ATTRIBUTE_UNUSED, ArenaAllocKind kind ATTRIBUTE_UNUSED) {} |
Vladimir Marko | 83cc7ae | 2014-02-12 18:02:05 +0000 | [diff] [blame] | 121 | size_t NumAllocations() const { return 0u; } |
| 122 | size_t BytesAllocated() const { return 0u; } |
Roland Levillain | 4b8f1ec | 2015-08-26 18:34:03 +0100 | [diff] [blame] | 123 | void Dump(std::ostream& os ATTRIBUTE_UNUSED, |
| 124 | const Arena* first ATTRIBUTE_UNUSED, |
| 125 | ssize_t lost_bytes_adjustment ATTRIBUTE_UNUSED) const {} |
Vladimir Marko | 83cc7ae | 2014-02-12 18:02:05 +0000 | [diff] [blame] | 126 | }; |
| 127 | |
| 128 | template <bool kCount> |
| 129 | class ArenaAllocatorStatsImpl { |
| 130 | public: |
| 131 | ArenaAllocatorStatsImpl(); |
| 132 | ArenaAllocatorStatsImpl(const ArenaAllocatorStatsImpl& other) = default; |
| 133 | ArenaAllocatorStatsImpl& operator = (const ArenaAllocatorStatsImpl& other) = delete; |
| 134 | |
| 135 | void Copy(const ArenaAllocatorStatsImpl& other); |
| 136 | void RecordAlloc(size_t bytes, ArenaAllocKind kind); |
| 137 | size_t NumAllocations() const; |
| 138 | size_t BytesAllocated() const; |
| 139 | void Dump(std::ostream& os, const Arena* first, ssize_t lost_bytes_adjustment) const; |
| 140 | |
| 141 | private: |
| 142 | size_t num_allocations_; |
Vladimir Marko | 4e335d0 | 2016-12-19 16:04:33 +0000 | [diff] [blame] | 143 | dchecked_vector<size_t> alloc_stats_; // Bytes used by various allocation kinds. |
Vladimir Marko | bd9e9db | 2014-03-07 19:41:05 +0000 | [diff] [blame] | 144 | |
Vladimir Marko | 8dea81c | 2014-06-06 14:50:36 +0100 | [diff] [blame] | 145 | static const char* const kAllocNames[]; |
Vladimir Marko | 83cc7ae | 2014-02-12 18:02:05 +0000 | [diff] [blame] | 146 | }; |
| 147 | |
| 148 | typedef ArenaAllocatorStatsImpl<kArenaAllocatorCountAllocations> ArenaAllocatorStats; |
buzbee | 862a760 | 2013-04-05 10:58:54 -0700 | [diff] [blame] | 149 | |
Vladimir Marko | 2a408a3 | 2015-09-18 14:11:00 +0100 | [diff] [blame] | 150 | template <bool kAvailable, bool kValgrind> |
| 151 | class ArenaAllocatorMemoryToolCheckImpl { |
| 152 | // This is the generic template but since there is a partial specialization |
| 153 | // for kValgrind == false, this can be instantiated only for kValgrind == true. |
| 154 | static_assert(kValgrind, "This template can be instantiated only for Valgrind."); |
| 155 | static_assert(kAvailable, "Valgrind implies memory tool availability."); |
| 156 | |
| 157 | public: |
| 158 | ArenaAllocatorMemoryToolCheckImpl() : is_running_on_valgrind_(RUNNING_ON_MEMORY_TOOL) { } |
| 159 | bool IsRunningOnMemoryTool() { return is_running_on_valgrind_; } |
| 160 | |
| 161 | private: |
| 162 | const bool is_running_on_valgrind_; |
| 163 | }; |
| 164 | |
| 165 | template <bool kAvailable> |
| 166 | class ArenaAllocatorMemoryToolCheckImpl<kAvailable, false> { |
| 167 | public: |
| 168 | ArenaAllocatorMemoryToolCheckImpl() { } |
| 169 | bool IsRunningOnMemoryTool() { return kAvailable; } |
| 170 | }; |
| 171 | |
| 172 | typedef ArenaAllocatorMemoryToolCheckImpl<kMemoryToolIsAvailable, kMemoryToolIsValgrind> |
| 173 | ArenaAllocatorMemoryToolCheck; |
| 174 | |
| 175 | class ArenaAllocatorMemoryTool : private ArenaAllocatorMemoryToolCheck { |
| 176 | public: |
| 177 | using ArenaAllocatorMemoryToolCheck::IsRunningOnMemoryTool; |
| 178 | |
| 179 | void MakeDefined(void* ptr, size_t size) { |
Vladimir Marko | 7bda3b6 | 2015-10-07 12:44:31 +0000 | [diff] [blame] | 180 | if (UNLIKELY(IsRunningOnMemoryTool())) { |
| 181 | DoMakeDefined(ptr, size); |
Vladimir Marko | 2a408a3 | 2015-09-18 14:11:00 +0100 | [diff] [blame] | 182 | } |
| 183 | } |
| 184 | void MakeUndefined(void* ptr, size_t size) { |
Vladimir Marko | 7bda3b6 | 2015-10-07 12:44:31 +0000 | [diff] [blame] | 185 | if (UNLIKELY(IsRunningOnMemoryTool())) { |
| 186 | DoMakeUndefined(ptr, size); |
Vladimir Marko | 2a408a3 | 2015-09-18 14:11:00 +0100 | [diff] [blame] | 187 | } |
| 188 | } |
| 189 | void MakeInaccessible(void* ptr, size_t size) { |
Vladimir Marko | 7bda3b6 | 2015-10-07 12:44:31 +0000 | [diff] [blame] | 190 | if (UNLIKELY(IsRunningOnMemoryTool())) { |
| 191 | DoMakeInaccessible(ptr, size); |
Vladimir Marko | 2a408a3 | 2015-09-18 14:11:00 +0100 | [diff] [blame] | 192 | } |
| 193 | } |
Vladimir Marko | 7bda3b6 | 2015-10-07 12:44:31 +0000 | [diff] [blame] | 194 | |
| 195 | private: |
| 196 | void DoMakeDefined(void* ptr, size_t size); |
| 197 | void DoMakeUndefined(void* ptr, size_t size); |
| 198 | void DoMakeInaccessible(void* ptr, size_t size); |
Vladimir Marko | 2a408a3 | 2015-09-18 14:11:00 +0100 | [diff] [blame] | 199 | }; |
| 200 | |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 201 | class Arena { |
| 202 | public: |
Mathieu Chartier | c6201fa | 2015-03-12 10:06:33 -0700 | [diff] [blame] | 203 | Arena(); |
| 204 | virtual ~Arena() { } |
Mathieu Chartier | 9b34b24 | 2015-03-09 11:30:17 -0700 | [diff] [blame] | 205 | // Reset is for pre-use and uses memset for performance. |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 206 | void Reset(); |
Mathieu Chartier | 9b34b24 | 2015-03-09 11:30:17 -0700 | [diff] [blame] | 207 | // Release is used inbetween uses and uses madvise for memory usage. |
Mathieu Chartier | c6201fa | 2015-03-12 10:06:33 -0700 | [diff] [blame] | 208 | virtual void Release() { } |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 209 | uint8_t* Begin() { |
| 210 | return memory_; |
buzbee | 862a760 | 2013-04-05 10:58:54 -0700 | [diff] [blame] | 211 | } |
| 212 | |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 213 | uint8_t* End() { |
| 214 | return memory_ + size_; |
| 215 | } |
| 216 | |
| 217 | size_t Size() const { |
| 218 | return size_; |
| 219 | } |
| 220 | |
| 221 | size_t RemainingSpace() const { |
| 222 | return Size() - bytes_allocated_; |
| 223 | } |
| 224 | |
Mathieu Chartier | 49285c5 | 2014-12-02 15:43:48 -0800 | [diff] [blame] | 225 | size_t GetBytesAllocated() const { |
| 226 | return bytes_allocated_; |
| 227 | } |
| 228 | |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 229 | // Return true if ptr is contained in the arena. |
| 230 | bool Contains(const void* ptr) const { |
| 231 | return memory_ <= ptr && ptr < memory_ + bytes_allocated_; |
| 232 | } |
| 233 | |
Mathieu Chartier | c6201fa | 2015-03-12 10:06:33 -0700 | [diff] [blame] | 234 | protected: |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 235 | size_t bytes_allocated_; |
| 236 | uint8_t* memory_; |
| 237 | size_t size_; |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 238 | Arena* next_; |
David Sehr | 3215fff | 2018-04-03 17:10:12 -0700 | [diff] [blame] | 239 | friend class MallocArenaPool; |
| 240 | friend class MemMapArenaPool; |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 241 | friend class ArenaAllocator; |
Vladimir Marko | 83cc7ae | 2014-02-12 18:02:05 +0000 | [diff] [blame] | 242 | friend class ArenaStack; |
| 243 | friend class ScopedArenaAllocator; |
| 244 | template <bool kCount> friend class ArenaAllocatorStatsImpl; |
Mathieu Chartier | c6201fa | 2015-03-12 10:06:33 -0700 | [diff] [blame] | 245 | |
Vladimir Marko | 3e0e717 | 2016-04-22 18:07:13 +0100 | [diff] [blame] | 246 | friend class ArenaAllocatorTest; |
| 247 | |
Mathieu Chartier | c6201fa | 2015-03-12 10:06:33 -0700 | [diff] [blame] | 248 | private: |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 249 | DISALLOW_COPY_AND_ASSIGN(Arena); |
| 250 | }; |
| 251 | |
| 252 | class ArenaPool { |
| 253 | public: |
David Sehr | 3215fff | 2018-04-03 17:10:12 -0700 | [diff] [blame] | 254 | virtual ~ArenaPool() = default; |
| 255 | |
| 256 | virtual Arena* AllocArena(size_t size) = 0; |
| 257 | virtual void FreeArenaChain(Arena* first) = 0; |
| 258 | virtual size_t GetBytesAllocated() const = 0; |
| 259 | virtual void ReclaimMemory() = 0; |
| 260 | virtual void LockReclaimMemory() = 0; |
| 261 | // Trim the maps in arenas by madvising, used by JIT to reduce memory usage. |
| 262 | virtual void TrimMaps() = 0; |
| 263 | |
| 264 | protected: |
| 265 | ArenaPool() = default; |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 266 | |
| 267 | private: |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 268 | DISALLOW_COPY_AND_ASSIGN(ArenaPool); |
| 269 | }; |
| 270 | |
Vladimir Marko | fda0432 | 2015-11-11 18:45:50 +0000 | [diff] [blame] | 271 | // Fast single-threaded allocator for zero-initialized memory chunks. |
| 272 | // |
| 273 | // Memory is allocated from ArenaPool in large chunks and then rationed through |
| 274 | // the ArenaAllocator. It's returned to the ArenaPool only when the ArenaAllocator |
| 275 | // is destroyed. |
Vladimir Marko | 2a408a3 | 2015-09-18 14:11:00 +0100 | [diff] [blame] | 276 | class ArenaAllocator |
| 277 | : private DebugStackRefCounter, private ArenaAllocatorStats, private ArenaAllocatorMemoryTool { |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 278 | public: |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 279 | explicit ArenaAllocator(ArenaPool* pool); |
| 280 | ~ArenaAllocator(); |
| 281 | |
Vladimir Marko | 2a408a3 | 2015-09-18 14:11:00 +0100 | [diff] [blame] | 282 | using ArenaAllocatorMemoryTool::IsRunningOnMemoryTool; |
| 283 | using ArenaAllocatorMemoryTool::MakeDefined; |
| 284 | using ArenaAllocatorMemoryTool::MakeUndefined; |
| 285 | using ArenaAllocatorMemoryTool::MakeInaccessible; |
| 286 | |
Vladimir Marko | 8081d2b | 2014-07-31 15:33:43 +0100 | [diff] [blame] | 287 | // Get adapter for use in STL containers. See arena_containers.h . |
| 288 | ArenaAllocatorAdapter<void> Adapter(ArenaAllocKind kind = kArenaAllocSTL); |
| 289 | |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 290 | // Returns zeroed memory. |
Vladimir Marko | e4fcc5b | 2015-02-13 10:28:29 +0000 | [diff] [blame] | 291 | void* Alloc(size_t bytes, ArenaAllocKind kind = kArenaAllocMisc) ALWAYS_INLINE { |
Vladimir Marko | 2a408a3 | 2015-09-18 14:11:00 +0100 | [diff] [blame] | 292 | if (UNLIKELY(IsRunningOnMemoryTool())) { |
| 293 | return AllocWithMemoryTool(bytes, kind); |
Mathieu Chartier | 75165d0 | 2013-09-12 14:00:31 -0700 | [diff] [blame] | 294 | } |
Mathieu Chartier | b666f48 | 2015-02-18 14:33:14 -0800 | [diff] [blame] | 295 | bytes = RoundUp(bytes, kAlignment); |
Vladimir Marko | 83cc7ae | 2014-02-12 18:02:05 +0000 | [diff] [blame] | 296 | ArenaAllocatorStats::RecordAlloc(bytes, kind); |
Vladimir Marko | 3e0e717 | 2016-04-22 18:07:13 +0100 | [diff] [blame] | 297 | if (UNLIKELY(bytes > static_cast<size_t>(end_ - ptr_))) { |
| 298 | return AllocFromNewArena(bytes); |
| 299 | } |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 300 | uint8_t* ret = ptr_; |
Andreas Gampe | f6dd829 | 2016-08-19 20:22:19 -0700 | [diff] [blame] | 301 | DCHECK_ALIGNED(ret, kAlignment); |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 302 | ptr_ += bytes; |
| 303 | return ret; |
| 304 | } |
| 305 | |
Vladimir Marko | f44d36c | 2017-03-14 14:18:46 +0000 | [diff] [blame] | 306 | // Returns zeroed memory. |
| 307 | void* AllocAlign16(size_t bytes, ArenaAllocKind kind = kArenaAllocMisc) ALWAYS_INLINE { |
| 308 | // It is an error to request 16-byte aligned allocation of unaligned size. |
| 309 | DCHECK_ALIGNED(bytes, 16); |
| 310 | if (UNLIKELY(IsRunningOnMemoryTool())) { |
| 311 | return AllocWithMemoryToolAlign16(bytes, kind); |
| 312 | } |
| 313 | uintptr_t padding = |
| 314 | ((reinterpret_cast<uintptr_t>(ptr_) + 15u) & 15u) - reinterpret_cast<uintptr_t>(ptr_); |
| 315 | ArenaAllocatorStats::RecordAlloc(bytes, kind); |
| 316 | if (UNLIKELY(padding + bytes > static_cast<size_t>(end_ - ptr_))) { |
| 317 | static_assert(kArenaAlignment >= 16, "Expecting sufficient alignment for new Arena."); |
| 318 | return AllocFromNewArena(bytes); |
| 319 | } |
| 320 | ptr_ += padding; |
| 321 | uint8_t* ret = ptr_; |
| 322 | DCHECK_ALIGNED(ret, 16); |
| 323 | ptr_ += bytes; |
| 324 | return ret; |
| 325 | } |
| 326 | |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 327 | // Realloc never frees the input pointer, it is the caller's job to do this if necessary. |
Vladimir Marko | f44d36c | 2017-03-14 14:18:46 +0000 | [diff] [blame] | 328 | void* Realloc(void* ptr, |
| 329 | size_t ptr_size, |
| 330 | size_t new_size, |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 331 | ArenaAllocKind kind = kArenaAllocMisc) ALWAYS_INLINE { |
| 332 | DCHECK_GE(new_size, ptr_size); |
| 333 | DCHECK_EQ(ptr == nullptr, ptr_size == 0u); |
Andreas Gampe | f6dd829 | 2016-08-19 20:22:19 -0700 | [diff] [blame] | 334 | // We always allocate aligned. |
| 335 | const size_t aligned_ptr_size = RoundUp(ptr_size, kAlignment); |
| 336 | auto* end = reinterpret_cast<uint8_t*>(ptr) + aligned_ptr_size; |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 337 | // If we haven't allocated anything else, we can safely extend. |
| 338 | if (end == ptr_) { |
Andreas Gampe | 421dbc2 | 2017-07-11 08:32:29 -0700 | [diff] [blame] | 339 | // Red zone prevents end == ptr_ (unless input = allocator state = null). |
| 340 | DCHECK(!IsRunningOnMemoryTool() || ptr_ == nullptr); |
Andreas Gampe | f6dd829 | 2016-08-19 20:22:19 -0700 | [diff] [blame] | 341 | const size_t aligned_new_size = RoundUp(new_size, kAlignment); |
| 342 | const size_t size_delta = aligned_new_size - aligned_ptr_size; |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 343 | // Check remain space. |
| 344 | const size_t remain = end_ - ptr_; |
| 345 | if (remain >= size_delta) { |
| 346 | ptr_ += size_delta; |
| 347 | ArenaAllocatorStats::RecordAlloc(size_delta, kind); |
Andreas Gampe | f6dd829 | 2016-08-19 20:22:19 -0700 | [diff] [blame] | 348 | DCHECK_ALIGNED(ptr_, kAlignment); |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 349 | return ptr; |
| 350 | } |
| 351 | } |
Andreas Gampe | f6dd829 | 2016-08-19 20:22:19 -0700 | [diff] [blame] | 352 | auto* new_ptr = Alloc(new_size, kind); // Note: Alloc will take care of aligning new_size. |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 353 | memcpy(new_ptr, ptr, ptr_size); |
| 354 | // TODO: Call free on ptr if linear alloc supports free. |
| 355 | return new_ptr; |
| 356 | } |
| 357 | |
Vladimir Marko | e4fcc5b | 2015-02-13 10:28:29 +0000 | [diff] [blame] | 358 | template <typename T> |
Vladimir Marko | f6a35de | 2016-03-21 12:01:50 +0000 | [diff] [blame] | 359 | T* Alloc(ArenaAllocKind kind = kArenaAllocMisc) { |
| 360 | return AllocArray<T>(1, kind); |
| 361 | } |
| 362 | |
| 363 | template <typename T> |
Vladimir Marko | e4fcc5b | 2015-02-13 10:28:29 +0000 | [diff] [blame] | 364 | T* AllocArray(size_t length, ArenaAllocKind kind = kArenaAllocMisc) { |
| 365 | return static_cast<T*>(Alloc(length * sizeof(T), kind)); |
Nicolas Geoffray | a7062e0 | 2014-05-22 12:50:17 +0100 | [diff] [blame] | 366 | } |
| 367 | |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 368 | size_t BytesAllocated() const; |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 369 | |
Vladimir Marko | 83cc7ae | 2014-02-12 18:02:05 +0000 | [diff] [blame] | 370 | MemStats GetMemStats() const; |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 371 | |
Mathieu Chartier | c785344 | 2015-03-27 14:35:38 -0700 | [diff] [blame] | 372 | // The BytesUsed method sums up bytes allocated from arenas in arena_head_ and nodes. |
| 373 | // TODO: Change BytesAllocated to this behavior? |
| 374 | size_t BytesUsed() const; |
buzbee | 862a760 | 2013-04-05 10:58:54 -0700 | [diff] [blame] | 375 | |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 376 | ArenaPool* GetArenaPool() const { |
| 377 | return pool_; |
| 378 | } |
| 379 | |
| 380 | bool Contains(const void* ptr) const; |
| 381 | |
Vladimir Marko | f44d36c | 2017-03-14 14:18:46 +0000 | [diff] [blame] | 382 | // The alignment guaranteed for individual allocations. |
| 383 | static constexpr size_t kAlignment = 8u; |
| 384 | |
| 385 | // The alignment required for the whole Arena rather than individual allocations. |
| 386 | static constexpr size_t kArenaAlignment = 16u; |
Andreas Gampe | f6dd829 | 2016-08-19 20:22:19 -0700 | [diff] [blame] | 387 | |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 388 | private: |
Vladimir Marko | 3e0e717 | 2016-04-22 18:07:13 +0100 | [diff] [blame] | 389 | void* AllocWithMemoryTool(size_t bytes, ArenaAllocKind kind); |
Vladimir Marko | f44d36c | 2017-03-14 14:18:46 +0000 | [diff] [blame] | 390 | void* AllocWithMemoryToolAlign16(size_t bytes, ArenaAllocKind kind); |
Vladimir Marko | 3f84f2c | 2016-04-25 19:40:34 +0100 | [diff] [blame] | 391 | uint8_t* AllocFromNewArena(size_t bytes); |
Vladimir Marko | f44d36c | 2017-03-14 14:18:46 +0000 | [diff] [blame] | 392 | uint8_t* AllocFromNewArenaWithMemoryTool(size_t bytes); |
Mathieu Chartier | b666f48 | 2015-02-18 14:33:14 -0800 | [diff] [blame] | 393 | |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 394 | void UpdateBytesAllocated(); |
buzbee | 862a760 | 2013-04-05 10:58:54 -0700 | [diff] [blame] | 395 | |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 396 | ArenaPool* pool_; |
| 397 | uint8_t* begin_; |
| 398 | uint8_t* end_; |
| 399 | uint8_t* ptr_; |
| 400 | Arena* arena_head_; |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 401 | |
Vladimir Marko | 8081d2b | 2014-07-31 15:33:43 +0100 | [diff] [blame] | 402 | template <typename U> |
| 403 | friend class ArenaAllocatorAdapter; |
| 404 | |
Vladimir Marko | 3e0e717 | 2016-04-22 18:07:13 +0100 | [diff] [blame] | 405 | friend class ArenaAllocatorTest; |
| 406 | |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 407 | DISALLOW_COPY_AND_ASSIGN(ArenaAllocator); |
buzbee | 862a760 | 2013-04-05 10:58:54 -0700 | [diff] [blame] | 408 | }; // ArenaAllocator |
| 409 | |
Vladimir Marko | 83cc7ae | 2014-02-12 18:02:05 +0000 | [diff] [blame] | 410 | class MemStats { |
| 411 | public: |
Vladimir Marko | f44d36c | 2017-03-14 14:18:46 +0000 | [diff] [blame] | 412 | MemStats(const char* name, |
| 413 | const ArenaAllocatorStats* stats, |
| 414 | const Arena* first_arena, |
Vladimir Marko | 83cc7ae | 2014-02-12 18:02:05 +0000 | [diff] [blame] | 415 | ssize_t lost_bytes_adjustment = 0); |
| 416 | void Dump(std::ostream& os) const; |
| 417 | |
| 418 | private: |
| 419 | const char* const name_; |
| 420 | const ArenaAllocatorStats* const stats_; |
| 421 | const Arena* const first_arena_; |
| 422 | const ssize_t lost_bytes_adjustment_; |
Brian Carlstrom | 7934ac2 | 2013-07-26 10:54:15 -0700 | [diff] [blame] | 423 | }; // MemStats |
buzbee | 862a760 | 2013-04-05 10:58:54 -0700 | [diff] [blame] | 424 | |
| 425 | } // namespace art |
| 426 | |
David Sehr | 1ce2b3b | 2018-04-05 11:02:03 -0700 | [diff] [blame] | 427 | #endif // ART_LIBARTBASE_BASE_ARENA_ALLOCATOR_H_ |