bump_pointer_space.h revision 13735955f39b3b304c37d2b2840663c131262c18
1590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier/* 2590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier * Copyright (C) 2013 The Android Open Source Project 3590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier * 4590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier * Licensed under the Apache License, Version 2.0 (the "License"); 5590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier * you may not use this file except in compliance with the License. 6590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier * You may obtain a copy of the License at 7590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier * 8590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier * http://www.apache.org/licenses/LICENSE-2.0 9590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier * 10590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier * Unless required by applicable law or agreed to in writing, software 11590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier * distributed under the License is distributed on an "AS IS" BASIS, 12590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier * See the License for the specific language governing permissions and 14590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier * limitations under the License. 15590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier */ 16590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 17590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier#ifndef ART_RUNTIME_GC_SPACE_BUMP_POINTER_SPACE_H_ 18590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier#define ART_RUNTIME_GC_SPACE_BUMP_POINTER_SPACE_H_ 19590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 2083c8ee000d525017ead8753fce6bc1020249b96aMathieu Chartier#include "object_callbacks.h" 21590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier#include "space.h" 22590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 23590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartiernamespace art { 24590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartiernamespace gc { 25590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 26590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartiernamespace collector { 27590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier class MarkSweep; 28590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier} // namespace collector 29590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 30590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartiernamespace space { 31590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 326fac447555dc94a935b78198479cce645c837b89Ian Rogers// A bump pointer space allocates by incrementing a pointer, it doesn't provide a free 336fac447555dc94a935b78198479cce645c837b89Ian Rogers// implementation as its intended to be evacuated. 346fac447555dc94a935b78198479cce645c837b89Ian Rogersclass BumpPointerSpace FINAL : public ContinuousMemMapAllocSpace { 35590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier public: 36590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier typedef void(*WalkCallback)(void *start, void *end, size_t num_bytes, void* callback_arg); 37590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 386fac447555dc94a935b78198479cce645c837b89Ian Rogers SpaceType GetType() const OVERRIDE { 39590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return kSpaceTypeBumpPointerSpace; 40590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 41590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 42590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Create a bump pointer space with the requested sizes. The requested base address is not 43590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // guaranteed to be granted, if it is required, the caller should call Begin on the returned 44590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // space to confirm the request was granted. 4513735955f39b3b304c37d2b2840663c131262c18Ian Rogers static BumpPointerSpace* Create(const std::string& name, size_t capacity, uint8_t* requested_begin); 4631f441464c0c8f840aba37e236ad133f30308d70Mathieu Chartier static BumpPointerSpace* CreateFromMemMap(const std::string& name, MemMap* mem_map); 47590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 48590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Allocate num_bytes, returns nullptr if the space is full. 496fac447555dc94a935b78198479cce645c837b89Ian Rogers mirror::Object* Alloc(Thread* self, size_t num_bytes, size_t* bytes_allocated, 506fac447555dc94a935b78198479cce645c837b89Ian Rogers size_t* usable_size) OVERRIDE; 510651d41e41341fb2e9ef3ee41dc1f1bfc832dbbbMathieu Chartier // Thread-unsafe allocation for when mutators are suspended, used by the semispace collector. 520651d41e41341fb2e9ef3ee41dc1f1bfc832dbbbMathieu Chartier mirror::Object* AllocThreadUnsafe(Thread* self, size_t num_bytes, size_t* bytes_allocated, 530651d41e41341fb2e9ef3ee41dc1f1bfc832dbbbMathieu Chartier size_t* usable_size) 540651d41e41341fb2e9ef3ee41dc1f1bfc832dbbbMathieu Chartier OVERRIDE EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_); 550651d41e41341fb2e9ef3ee41dc1f1bfc832dbbbMathieu Chartier 56590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier mirror::Object* AllocNonvirtual(size_t num_bytes); 57692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier mirror::Object* AllocNonvirtualWithoutAccounting(size_t num_bytes); 58590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 59590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Return the storage space required by obj. 606fac447555dc94a935b78198479cce645c837b89Ian Rogers size_t AllocationSize(mirror::Object* obj, size_t* usable_size) OVERRIDE 616fac447555dc94a935b78198479cce645c837b89Ian Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 626fac447555dc94a935b78198479cce645c837b89Ian Rogers return AllocationSizeNonvirtual(obj, usable_size); 636fac447555dc94a935b78198479cce645c837b89Ian Rogers } 64590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 65692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // NOPS unless we support free lists. 666fac447555dc94a935b78198479cce645c837b89Ian Rogers size_t Free(Thread*, mirror::Object*) OVERRIDE { 67590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return 0; 68590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 696fac447555dc94a935b78198479cce645c837b89Ian Rogers 706fac447555dc94a935b78198479cce645c837b89Ian Rogers size_t FreeList(Thread*, size_t, mirror::Object**) OVERRIDE { 71590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return 0; 72590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 73590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 746fac447555dc94a935b78198479cce645c837b89Ian Rogers size_t AllocationSizeNonvirtual(mirror::Object* obj, size_t* usable_size) 756fac447555dc94a935b78198479cce645c837b89Ian Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 76590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 77590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Removes the fork time growth limit on capacity, allowing the application to allocate up to the 78590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // maximum reserved size of the heap. 79590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier void ClearGrowthLimit() { 80590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier growth_end_ = Limit(); 81590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 82590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 83590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Override capacity so that we only return the possibly limited capacity 84590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier size_t Capacity() const { 85590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return growth_end_ - begin_; 86590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 87590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 88590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // The total amount of memory reserved for the space. 89590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier size_t NonGrowthLimitCapacity() const { 90590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return GetMemMap()->Size(); 91590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 92590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 93a8e8f9c0a8e259a807d7b99a148d14104c24209dMathieu Chartier accounting::ContinuousSpaceBitmap* GetLiveBitmap() const OVERRIDE { 94590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return nullptr; 95590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 96590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 97a8e8f9c0a8e259a807d7b99a148d14104c24209dMathieu Chartier accounting::ContinuousSpaceBitmap* GetMarkBitmap() const OVERRIDE { 98590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return nullptr; 99590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 100590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 10131f441464c0c8f840aba37e236ad133f30308d70Mathieu Chartier // Reset the space to empty. 10231f441464c0c8f840aba37e236ad133f30308d70Mathieu Chartier void Clear() OVERRIDE LOCKS_EXCLUDED(block_lock_); 103590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 104590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier void Dump(std::ostream& os) const; 105590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 106e6da9af8dfe0a3e3fbc2be700554f6478380e7b9Mathieu Chartier void RevokeThreadLocalBuffers(Thread* thread) LOCKS_EXCLUDED(block_lock_); 107e6da9af8dfe0a3e3fbc2be700554f6478380e7b9Mathieu Chartier void RevokeAllThreadLocalBuffers() LOCKS_EXCLUDED(Locks::runtime_shutdown_lock_, 108e6da9af8dfe0a3e3fbc2be700554f6478380e7b9Mathieu Chartier Locks::thread_list_lock_); 109c93c530efc175954160c3834c93961a1a946a35aHiroshi Yamauchi void AssertThreadLocalBuffersAreRevoked(Thread* thread) LOCKS_EXCLUDED(block_lock_); 110c93c530efc175954160c3834c93961a1a946a35aHiroshi Yamauchi void AssertAllThreadLocalBuffersAreRevoked() LOCKS_EXCLUDED(Locks::runtime_shutdown_lock_, 111c93c530efc175954160c3834c93961a1a946a35aHiroshi Yamauchi Locks::thread_list_lock_); 112590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 113692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier uint64_t GetBytesAllocated() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 114692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier uint64_t GetObjectsAllocated() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 1156fac447555dc94a935b78198479cce645c837b89Ian Rogers bool IsEmpty() const { 1166fac447555dc94a935b78198479cce645c837b89Ian Rogers return Begin() == End(); 1176fac447555dc94a935b78198479cce645c837b89Ian Rogers } 1186fac447555dc94a935b78198479cce645c837b89Ian Rogers 11931f441464c0c8f840aba37e236ad133f30308d70Mathieu Chartier bool CanMoveObjects() const OVERRIDE { 12031f441464c0c8f840aba37e236ad133f30308d70Mathieu Chartier return true; 12131f441464c0c8f840aba37e236ad133f30308d70Mathieu Chartier } 122590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 123590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier bool Contains(const mirror::Object* obj) const { 12413735955f39b3b304c37d2b2840663c131262c18Ian Rogers const uint8_t* byte_obj = reinterpret_cast<const uint8_t*>(obj); 125590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return byte_obj >= Begin() && byte_obj < End(); 126590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 127590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 128590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // TODO: Change this? Mainly used for compacting to a particular region of memory. 12913735955f39b3b304c37d2b2840663c131262c18Ian Rogers BumpPointerSpace(const std::string& name, uint8_t* begin, uint8_t* limit); 130590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 131590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Return the object which comes after obj, while ensuring alignment. 132590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier static mirror::Object* GetNextObject(mirror::Object* obj) 133590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 134590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 135692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // Allocate a new TLAB, returns false if the allocation failed. 136e6da9af8dfe0a3e3fbc2be700554f6478380e7b9Mathieu Chartier bool AllocNewTlab(Thread* self, size_t bytes); 137692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier 1386fac447555dc94a935b78198479cce645c837b89Ian Rogers BumpPointerSpace* AsBumpPointerSpace() OVERRIDE { 1397410f29b4dae223befac036ea567d7f33351dad1Mathieu Chartier return this; 1407410f29b4dae223befac036ea567d7f33351dad1Mathieu Chartier } 1417410f29b4dae223befac036ea567d7f33351dad1Mathieu Chartier 142692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // Go through all of the blocks and visit the continuous objects. 14383c8ee000d525017ead8753fce6bc1020249b96aMathieu Chartier void Walk(ObjectCallback* callback, void* arg) 144692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 145692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier 146a8e8f9c0a8e259a807d7b99a148d14104c24209dMathieu Chartier accounting::ContinuousSpaceBitmap::SweepCallback* GetSweepCallback() OVERRIDE; 1476fac447555dc94a935b78198479cce645c837b89Ian Rogers 14852e4b43d62896b56f8c2bd041e528472bb4a0d8dMathieu Chartier // Record objects / bytes freed. 14952e4b43d62896b56f8c2bd041e528472bb4a0d8dMathieu Chartier void RecordFree(int32_t objects, int32_t bytes) { 15052e4b43d62896b56f8c2bd041e528472bb4a0d8dMathieu Chartier objects_allocated_.FetchAndSubSequentiallyConsistent(objects); 15152e4b43d62896b56f8c2bd041e528472bb4a0d8dMathieu Chartier bytes_allocated_.FetchAndSubSequentiallyConsistent(bytes); 15252e4b43d62896b56f8c2bd041e528472bb4a0d8dMathieu Chartier } 15352e4b43d62896b56f8c2bd041e528472bb4a0d8dMathieu Chartier 154b363f666883860d40823d5528df3c98c897f74f4Mathieu Chartier void LogFragmentationAllocFailure(std::ostream& os, size_t failed_alloc_bytes) OVERRIDE 155b363f666883860d40823d5528df3c98c897f74f4Mathieu Chartier SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 156b363f666883860d40823d5528df3c98c897f74f4Mathieu Chartier 1577410f29b4dae223befac036ea567d7f33351dad1Mathieu Chartier // Object alignment within the space. 158cbb2d20bea2861f244da2e2318d8c088300a3710Mathieu Chartier static constexpr size_t kAlignment = 8; 159cbb2d20bea2861f244da2e2318d8c088300a3710Mathieu Chartier 160590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier protected: 161590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier BumpPointerSpace(const std::string& name, MemMap* mem_map); 162590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 163692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // Allocate a raw block of bytes. 16413735955f39b3b304c37d2b2840663c131262c18Ian Rogers uint8_t* AllocBlock(size_t bytes) EXCLUSIVE_LOCKS_REQUIRED(block_lock_); 165692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier void RevokeThreadLocalBuffersLocked(Thread* thread) EXCLUSIVE_LOCKS_REQUIRED(block_lock_); 166692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier 167692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // The main block is an unbounded block where objects go when there are no other blocks. This 168692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // enables us to maintain tightly packed objects when you are not using thread local buffers for 169fc4c27e4d68707271bd7578ae5c8bef93a3ea66bMathieu Chartier // allocation. The main block starts at the space Begin(). 170692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier void UpdateMainBlock() EXCLUSIVE_LOCKS_REQUIRED(block_lock_); 171590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 17213735955f39b3b304c37d2b2840663c131262c18Ian Rogers uint8_t* growth_end_; 173692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier AtomicInteger objects_allocated_; // Accumulated from revoked thread local regions. 174692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier AtomicInteger bytes_allocated_; // Accumulated from revoked thread local regions. 175e6da9af8dfe0a3e3fbc2be700554f6478380e7b9Mathieu Chartier Mutex block_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER; 176fc4c27e4d68707271bd7578ae5c8bef93a3ea66bMathieu Chartier // The objects at the start of the space are stored in the main block. The main block doesn't 177fc4c27e4d68707271bd7578ae5c8bef93a3ea66bMathieu Chartier // have a header, this lets us walk empty spaces which are mprotected. 178fc4c27e4d68707271bd7578ae5c8bef93a3ea66bMathieu Chartier size_t main_block_size_ GUARDED_BY(block_lock_); 179692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // The number of blocks in the space, if it is 0 then the space has one long continuous block 180692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // which doesn't have an updated header. 181692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier size_t num_blocks_ GUARDED_BY(block_lock_); 182590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 183590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier private: 184692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier struct BlockHeader { 185692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier size_t size_; // Size of the block in bytes, does not include the header. 186692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier size_t unused_; // Ensures alignment of kAlignment. 187692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier }; 188692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier 189692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier COMPILE_ASSERT(sizeof(BlockHeader) % kAlignment == 0, 190692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier continuous_block_must_be_kAlignment_aligned); 191692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier 192590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier friend class collector::MarkSweep; 193590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier DISALLOW_COPY_AND_ASSIGN(BumpPointerSpace); 194590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier}; 195590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 196590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier} // namespace space 197590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier} // namespace gc 198590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier} // namespace art 199590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 200590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier#endif // ART_RUNTIME_GC_SPACE_BUMP_POINTER_SPACE_H_ 201