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 | |
Mathieu Chartier | b666f48 | 2015-02-18 14:33:14 -0800 | [diff] [blame] | 17 | #ifndef ART_RUNTIME_BASE_ARENA_ALLOCATOR_H_ |
| 18 | #define ART_RUNTIME_BASE_ARENA_ALLOCATOR_H_ |
buzbee | 862a760 | 2013-04-05 10:58:54 -0700 | [diff] [blame] | 19 | |
| 20 | #include <stdint.h> |
| 21 | #include <stddef.h> |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 22 | |
Mathieu Chartier | b666f48 | 2015-02-18 14:33:14 -0800 | [diff] [blame] | 23 | #include "debug_stack.h" |
| 24 | #include "macros.h" |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 25 | #include "mem_map.h" |
Mathieu Chartier | b666f48 | 2015-02-18 14:33:14 -0800 | [diff] [blame] | 26 | #include "mutex.h" |
Andreas Gampe | 6601882 | 2014-05-05 20:47:19 -0700 | [diff] [blame] | 27 | #include "utils.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, |
| 46 | kArenaAllocBB, |
Vladimir Marko | e39c54e | 2014-09-22 14:50:02 +0100 | [diff] [blame] | 47 | kArenaAllocBBList, |
| 48 | kArenaAllocBBPredecessors, |
| 49 | kArenaAllocDfsPreOrder, |
| 50 | kArenaAllocDfsPostOrder, |
| 51 | kArenaAllocDomPostOrder, |
| 52 | kArenaAllocTopologicalSortOrder, |
| 53 | kArenaAllocLoweringInfo, |
Vladimir Marko | 83cc7ae | 2014-02-12 18:02:05 +0000 | [diff] [blame] | 54 | kArenaAllocLIR, |
Vladimir Marko | 8dea81c | 2014-06-06 14:50:36 +0100 | [diff] [blame] | 55 | kArenaAllocLIRResourceMask, |
Vladimir Marko | e39c54e | 2014-09-22 14:50:02 +0100 | [diff] [blame] | 56 | kArenaAllocSwitchTable, |
| 57 | kArenaAllocFillArrayData, |
| 58 | kArenaAllocSlowPaths, |
Vladimir Marko | 83cc7ae | 2014-02-12 18:02:05 +0000 | [diff] [blame] | 59 | kArenaAllocMIR, |
| 60 | kArenaAllocDFInfo, |
| 61 | kArenaAllocGrowableArray, |
| 62 | kArenaAllocGrowableBitMap, |
Vladimir Marko | e39c54e | 2014-09-22 14:50:02 +0100 | [diff] [blame] | 63 | kArenaAllocSSAToDalvikMap, |
Vladimir Marko | 83cc7ae | 2014-02-12 18:02:05 +0000 | [diff] [blame] | 64 | kArenaAllocDalvikToSSAMap, |
| 65 | kArenaAllocDebugInfo, |
| 66 | kArenaAllocSuccessor, |
| 67 | kArenaAllocRegAlloc, |
| 68 | kArenaAllocData, |
| 69 | kArenaAllocPredecessors, |
| 70 | kArenaAllocSTL, |
| 71 | kNumArenaAllocKinds |
| 72 | }; |
| 73 | |
| 74 | template <bool kCount> |
| 75 | class ArenaAllocatorStatsImpl; |
| 76 | |
| 77 | template <> |
| 78 | class ArenaAllocatorStatsImpl<false> { |
| 79 | public: |
| 80 | ArenaAllocatorStatsImpl() = default; |
| 81 | ArenaAllocatorStatsImpl(const ArenaAllocatorStatsImpl& other) = default; |
| 82 | ArenaAllocatorStatsImpl& operator = (const ArenaAllocatorStatsImpl& other) = delete; |
| 83 | |
| 84 | void Copy(const ArenaAllocatorStatsImpl& other) { UNUSED(other); } |
Ian Rogers | 6a3c1fc | 2014-10-31 00:33:20 -0700 | [diff] [blame] | 85 | void RecordAlloc(size_t bytes, ArenaAllocKind kind) { UNUSED(bytes, kind); } |
Vladimir Marko | 83cc7ae | 2014-02-12 18:02:05 +0000 | [diff] [blame] | 86 | size_t NumAllocations() const { return 0u; } |
| 87 | size_t BytesAllocated() const { return 0u; } |
| 88 | void Dump(std::ostream& os, const Arena* first, ssize_t lost_bytes_adjustment) const { |
| 89 | UNUSED(os); UNUSED(first); UNUSED(lost_bytes_adjustment); |
| 90 | } |
| 91 | }; |
| 92 | |
| 93 | template <bool kCount> |
| 94 | class ArenaAllocatorStatsImpl { |
| 95 | public: |
| 96 | ArenaAllocatorStatsImpl(); |
| 97 | ArenaAllocatorStatsImpl(const ArenaAllocatorStatsImpl& other) = default; |
| 98 | ArenaAllocatorStatsImpl& operator = (const ArenaAllocatorStatsImpl& other) = delete; |
| 99 | |
| 100 | void Copy(const ArenaAllocatorStatsImpl& other); |
| 101 | void RecordAlloc(size_t bytes, ArenaAllocKind kind); |
| 102 | size_t NumAllocations() const; |
| 103 | size_t BytesAllocated() const; |
| 104 | void Dump(std::ostream& os, const Arena* first, ssize_t lost_bytes_adjustment) const; |
| 105 | |
| 106 | private: |
| 107 | size_t num_allocations_; |
| 108 | // TODO: Use std::array<size_t, kNumArenaAllocKinds> from C++11 when we upgrade the STL. |
| 109 | size_t alloc_stats_[kNumArenaAllocKinds]; // Bytes used by various allocation kinds. |
Vladimir Marko | bd9e9db | 2014-03-07 19:41:05 +0000 | [diff] [blame] | 110 | |
Vladimir Marko | 8dea81c | 2014-06-06 14:50:36 +0100 | [diff] [blame] | 111 | static const char* const kAllocNames[]; |
Vladimir Marko | 83cc7ae | 2014-02-12 18:02:05 +0000 | [diff] [blame] | 112 | }; |
| 113 | |
| 114 | typedef ArenaAllocatorStatsImpl<kArenaAllocatorCountAllocations> ArenaAllocatorStats; |
buzbee | 862a760 | 2013-04-05 10:58:54 -0700 | [diff] [blame] | 115 | |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 116 | class Arena { |
| 117 | public: |
| 118 | static constexpr size_t kDefaultSize = 128 * KB; |
Mathieu Chartier | c6201fa | 2015-03-12 10:06:33 -0700 | [diff] [blame] | 119 | Arena(); |
| 120 | virtual ~Arena() { } |
Mathieu Chartier | 9b34b24 | 2015-03-09 11:30:17 -0700 | [diff] [blame] | 121 | // Reset is for pre-use and uses memset for performance. |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 122 | void Reset(); |
Mathieu Chartier | 9b34b24 | 2015-03-09 11:30:17 -0700 | [diff] [blame] | 123 | // Release is used inbetween uses and uses madvise for memory usage. |
Mathieu Chartier | c6201fa | 2015-03-12 10:06:33 -0700 | [diff] [blame] | 124 | virtual void Release() { } |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 125 | uint8_t* Begin() { |
| 126 | return memory_; |
buzbee | 862a760 | 2013-04-05 10:58:54 -0700 | [diff] [blame] | 127 | } |
| 128 | |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 129 | uint8_t* End() { |
| 130 | return memory_ + size_; |
| 131 | } |
| 132 | |
| 133 | size_t Size() const { |
| 134 | return size_; |
| 135 | } |
| 136 | |
| 137 | size_t RemainingSpace() const { |
| 138 | return Size() - bytes_allocated_; |
| 139 | } |
| 140 | |
Mathieu Chartier | 49285c5 | 2014-12-02 15:43:48 -0800 | [diff] [blame] | 141 | size_t GetBytesAllocated() const { |
| 142 | return bytes_allocated_; |
| 143 | } |
| 144 | |
Mathieu Chartier | c6201fa | 2015-03-12 10:06:33 -0700 | [diff] [blame] | 145 | protected: |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 146 | size_t bytes_allocated_; |
| 147 | uint8_t* memory_; |
| 148 | size_t size_; |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 149 | Arena* next_; |
| 150 | friend class ArenaPool; |
| 151 | friend class ArenaAllocator; |
Vladimir Marko | 83cc7ae | 2014-02-12 18:02:05 +0000 | [diff] [blame] | 152 | friend class ArenaStack; |
| 153 | friend class ScopedArenaAllocator; |
| 154 | template <bool kCount> friend class ArenaAllocatorStatsImpl; |
Mathieu Chartier | c6201fa | 2015-03-12 10:06:33 -0700 | [diff] [blame] | 155 | |
| 156 | private: |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 157 | DISALLOW_COPY_AND_ASSIGN(Arena); |
| 158 | }; |
| 159 | |
Mathieu Chartier | c6201fa | 2015-03-12 10:06:33 -0700 | [diff] [blame] | 160 | class MallocArena FINAL : public Arena { |
| 161 | public: |
| 162 | explicit MallocArena(size_t size = Arena::kDefaultSize); |
| 163 | virtual ~MallocArena(); |
| 164 | }; |
| 165 | |
| 166 | class MemMapArena FINAL : public Arena { |
| 167 | public: |
| 168 | explicit MemMapArena(size_t size = Arena::kDefaultSize); |
| 169 | virtual ~MemMapArena() { } |
| 170 | void Release() OVERRIDE; |
| 171 | |
| 172 | private: |
| 173 | std::unique_ptr<MemMap> map_; |
| 174 | }; |
| 175 | |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 176 | class ArenaPool { |
| 177 | public: |
Mathieu Chartier | c6201fa | 2015-03-12 10:06:33 -0700 | [diff] [blame] | 178 | explicit ArenaPool(bool use_malloc = true); |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 179 | ~ArenaPool(); |
Mathieu Chartier | 49285c5 | 2014-12-02 15:43:48 -0800 | [diff] [blame] | 180 | Arena* AllocArena(size_t size) LOCKS_EXCLUDED(lock_); |
| 181 | void FreeArenaChain(Arena* first) LOCKS_EXCLUDED(lock_); |
| 182 | size_t GetBytesAllocated() const LOCKS_EXCLUDED(lock_); |
Mathieu Chartier | c6201fa | 2015-03-12 10:06:33 -0700 | [diff] [blame] | 183 | // Trim the maps in arenas by madvising, used by JIT to reduce memory usage. This only works |
| 184 | // use_malloc is false. |
Mathieu Chartier | 9b34b24 | 2015-03-09 11:30:17 -0700 | [diff] [blame] | 185 | void TrimMaps() LOCKS_EXCLUDED(lock_); |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 186 | |
| 187 | private: |
Mathieu Chartier | c6201fa | 2015-03-12 10:06:33 -0700 | [diff] [blame] | 188 | const bool use_malloc_; |
Mathieu Chartier | 49285c5 | 2014-12-02 15:43:48 -0800 | [diff] [blame] | 189 | mutable Mutex lock_ DEFAULT_MUTEX_ACQUIRED_AFTER; |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 190 | Arena* free_arenas_ GUARDED_BY(lock_); |
| 191 | DISALLOW_COPY_AND_ASSIGN(ArenaPool); |
| 192 | }; |
| 193 | |
Vladimir Marko | 8081d2b | 2014-07-31 15:33:43 +0100 | [diff] [blame] | 194 | class ArenaAllocator : private DebugStackRefCounter, private ArenaAllocatorStats { |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 195 | public: |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 196 | explicit ArenaAllocator(ArenaPool* pool); |
| 197 | ~ArenaAllocator(); |
| 198 | |
Vladimir Marko | 8081d2b | 2014-07-31 15:33:43 +0100 | [diff] [blame] | 199 | // Get adapter for use in STL containers. See arena_containers.h . |
| 200 | ArenaAllocatorAdapter<void> Adapter(ArenaAllocKind kind = kArenaAllocSTL); |
| 201 | |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 202 | // Returns zeroed memory. |
Vladimir Marko | e4fcc5b | 2015-02-13 10:28:29 +0000 | [diff] [blame] | 203 | void* Alloc(size_t bytes, ArenaAllocKind kind = kArenaAllocMisc) ALWAYS_INLINE { |
Mathieu Chartier | 75165d0 | 2013-09-12 14:00:31 -0700 | [diff] [blame] | 204 | if (UNLIKELY(running_on_valgrind_)) { |
| 205 | return AllocValgrind(bytes, kind); |
| 206 | } |
Mathieu Chartier | b666f48 | 2015-02-18 14:33:14 -0800 | [diff] [blame] | 207 | bytes = RoundUp(bytes, kAlignment); |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 208 | if (UNLIKELY(ptr_ + bytes > end_)) { |
| 209 | // Obtain a new block. |
| 210 | ObtainNewArenaForAllocation(bytes); |
| 211 | if (UNLIKELY(ptr_ == nullptr)) { |
| 212 | return nullptr; |
| 213 | } |
| 214 | } |
Vladimir Marko | 83cc7ae | 2014-02-12 18:02:05 +0000 | [diff] [blame] | 215 | ArenaAllocatorStats::RecordAlloc(bytes, kind); |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 216 | uint8_t* ret = ptr_; |
| 217 | ptr_ += bytes; |
| 218 | return ret; |
| 219 | } |
| 220 | |
Vladimir Marko | e4fcc5b | 2015-02-13 10:28:29 +0000 | [diff] [blame] | 221 | template <typename T> |
| 222 | T* AllocArray(size_t length, ArenaAllocKind kind = kArenaAllocMisc) { |
| 223 | return static_cast<T*>(Alloc(length * sizeof(T), kind)); |
Nicolas Geoffray | a7062e0 | 2014-05-22 12:50:17 +0100 | [diff] [blame] | 224 | } |
| 225 | |
Mathieu Chartier | 75165d0 | 2013-09-12 14:00:31 -0700 | [diff] [blame] | 226 | void* AllocValgrind(size_t bytes, ArenaAllocKind kind); |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 227 | void ObtainNewArenaForAllocation(size_t allocation_size); |
| 228 | size_t BytesAllocated() const; |
Vladimir Marko | 83cc7ae | 2014-02-12 18:02:05 +0000 | [diff] [blame] | 229 | MemStats GetMemStats() const; |
buzbee | 862a760 | 2013-04-05 10:58:54 -0700 | [diff] [blame] | 230 | |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 231 | private: |
Mathieu Chartier | b666f48 | 2015-02-18 14:33:14 -0800 | [diff] [blame] | 232 | static constexpr size_t kAlignment = 8; |
| 233 | |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 234 | void UpdateBytesAllocated(); |
buzbee | 862a760 | 2013-04-05 10:58:54 -0700 | [diff] [blame] | 235 | |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 236 | ArenaPool* pool_; |
| 237 | uint8_t* begin_; |
| 238 | uint8_t* end_; |
| 239 | uint8_t* ptr_; |
| 240 | Arena* arena_head_; |
Mathieu Chartier | 75165d0 | 2013-09-12 14:00:31 -0700 | [diff] [blame] | 241 | bool running_on_valgrind_; |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 242 | |
Vladimir Marko | 8081d2b | 2014-07-31 15:33:43 +0100 | [diff] [blame] | 243 | template <typename U> |
| 244 | friend class ArenaAllocatorAdapter; |
| 245 | |
Mathieu Chartier | f6c4b3b | 2013-08-24 16:11:37 -0700 | [diff] [blame] | 246 | DISALLOW_COPY_AND_ASSIGN(ArenaAllocator); |
buzbee | 862a760 | 2013-04-05 10:58:54 -0700 | [diff] [blame] | 247 | }; // ArenaAllocator |
| 248 | |
Vladimir Marko | 83cc7ae | 2014-02-12 18:02:05 +0000 | [diff] [blame] | 249 | class MemStats { |
| 250 | public: |
| 251 | MemStats(const char* name, const ArenaAllocatorStats* stats, const Arena* first_arena, |
| 252 | ssize_t lost_bytes_adjustment = 0); |
| 253 | void Dump(std::ostream& os) const; |
| 254 | |
| 255 | private: |
| 256 | const char* const name_; |
| 257 | const ArenaAllocatorStats* const stats_; |
| 258 | const Arena* const first_arena_; |
| 259 | const ssize_t lost_bytes_adjustment_; |
Brian Carlstrom | 7934ac2 | 2013-07-26 10:54:15 -0700 | [diff] [blame] | 260 | }; // MemStats |
buzbee | 862a760 | 2013-04-05 10:58:54 -0700 | [diff] [blame] | 261 | |
| 262 | } // namespace art |
| 263 | |
Mathieu Chartier | b666f48 | 2015-02-18 14:33:14 -0800 | [diff] [blame] | 264 | #endif // ART_RUNTIME_BASE_ARENA_ALLOCATOR_H_ |