bump_pointer_space.h revision fc4c27e4d68707271bd7578ae5c8bef93a3ea66b
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 32590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier// A bump pointer space is a space where objects may be allocated and garbage collected. 33590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartierclass BumpPointerSpace : public ContinuousMemMapAllocSpace { 34590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier public: 35590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier typedef void(*WalkCallback)(void *start, void *end, size_t num_bytes, void* callback_arg); 36590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 37590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier SpaceType GetType() const { 38590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return kSpaceTypeBumpPointerSpace; 39590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 40590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 41590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Create a bump pointer space with the requested sizes. The requested base address is not 42590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // guaranteed to be granted, if it is required, the caller should call Begin on the returned 43590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // space to confirm the request was granted. 44590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier static BumpPointerSpace* Create(const std::string& name, size_t capacity, byte* requested_begin); 45590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 46590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Allocate num_bytes, returns nullptr if the space is full. 47590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier virtual mirror::Object* Alloc(Thread* self, size_t num_bytes, size_t* bytes_allocated); 48590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier mirror::Object* AllocNonvirtual(size_t num_bytes); 49692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier mirror::Object* AllocNonvirtualWithoutAccounting(size_t num_bytes); 50590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 51590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Return the storage space required by obj. 52ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers virtual size_t AllocationSize(mirror::Object* obj) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 53590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 54692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // NOPS unless we support free lists. 55590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier virtual size_t Free(Thread*, mirror::Object*) { 56590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return 0; 57590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 58590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier virtual size_t FreeList(Thread*, size_t, mirror::Object**) { 59590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return 0; 60590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 61590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 62ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers size_t AllocationSizeNonvirtual(mirror::Object* obj) 63590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 64590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return obj->SizeOf(); 65590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 66590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 67590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Removes the fork time growth limit on capacity, allowing the application to allocate up to the 68590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // maximum reserved size of the heap. 69590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier void ClearGrowthLimit() { 70590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier growth_end_ = Limit(); 71590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 72590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 73590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Override capacity so that we only return the possibly limited capacity 74590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier size_t Capacity() const { 75590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return growth_end_ - begin_; 76590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 77590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 78590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // The total amount of memory reserved for the space. 79590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier size_t NonGrowthLimitCapacity() const { 80590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return GetMemMap()->Size(); 81590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 82590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 83590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier accounting::SpaceBitmap* GetLiveBitmap() const { 84590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return nullptr; 85590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 86590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 87590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier accounting::SpaceBitmap* GetMarkBitmap() const { 88590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return nullptr; 89590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 90590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 91590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Clear the memory and reset the pointer to the start of the space. 92e6da9af8dfe0a3e3fbc2be700554f6478380e7b9Mathieu Chartier void Clear() LOCKS_EXCLUDED(block_lock_); 93590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 94590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier void Dump(std::ostream& os) const; 95590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 96e6da9af8dfe0a3e3fbc2be700554f6478380e7b9Mathieu Chartier void RevokeThreadLocalBuffers(Thread* thread) LOCKS_EXCLUDED(block_lock_); 97e6da9af8dfe0a3e3fbc2be700554f6478380e7b9Mathieu Chartier void RevokeAllThreadLocalBuffers() LOCKS_EXCLUDED(Locks::runtime_shutdown_lock_, 98e6da9af8dfe0a3e3fbc2be700554f6478380e7b9Mathieu Chartier Locks::thread_list_lock_); 99590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 100692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier uint64_t GetBytesAllocated() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 101692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier uint64_t GetObjectsAllocated() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 102692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier bool IsEmpty() const; 103590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 104590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier bool Contains(const mirror::Object* obj) const { 105590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier const byte* byte_obj = reinterpret_cast<const byte*>(obj); 106590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return byte_obj >= Begin() && byte_obj < End(); 107590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 108590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 109590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // TODO: Change this? Mainly used for compacting to a particular region of memory. 110590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier BumpPointerSpace(const std::string& name, byte* begin, byte* limit); 111590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 112590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Return the object which comes after obj, while ensuring alignment. 113590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier static mirror::Object* GetNextObject(mirror::Object* obj) 114590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 115590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 116692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // Allocate a new TLAB, returns false if the allocation failed. 117e6da9af8dfe0a3e3fbc2be700554f6478380e7b9Mathieu Chartier bool AllocNewTlab(Thread* self, size_t bytes); 118692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier 1197410f29b4dae223befac036ea567d7f33351dad1Mathieu Chartier virtual BumpPointerSpace* AsBumpPointerSpace() { 1207410f29b4dae223befac036ea567d7f33351dad1Mathieu Chartier return this; 1217410f29b4dae223befac036ea567d7f33351dad1Mathieu Chartier } 1227410f29b4dae223befac036ea567d7f33351dad1Mathieu Chartier 123692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // Go through all of the blocks and visit the continuous objects. 12483c8ee000d525017ead8753fce6bc1020249b96aMathieu Chartier void Walk(ObjectCallback* callback, void* arg) 125692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 126692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier 1277410f29b4dae223befac036ea567d7f33351dad1Mathieu Chartier // Object alignment within the space. 128cbb2d20bea2861f244da2e2318d8c088300a3710Mathieu Chartier static constexpr size_t kAlignment = 8; 129cbb2d20bea2861f244da2e2318d8c088300a3710Mathieu Chartier 130590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier protected: 131590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier BumpPointerSpace(const std::string& name, MemMap* mem_map); 132590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 133692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // Allocate a raw block of bytes. 134692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier byte* AllocBlock(size_t bytes) EXCLUSIVE_LOCKS_REQUIRED(block_lock_); 135692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier void RevokeThreadLocalBuffersLocked(Thread* thread) EXCLUSIVE_LOCKS_REQUIRED(block_lock_); 136692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier 137590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier mirror::Object* AllocWithoutGrowthLocked(size_t num_bytes, size_t* bytes_allocated) 138590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier EXCLUSIVE_LOCKS_REQUIRED(lock_); 139590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 140692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // The main block is an unbounded block where objects go when there are no other blocks. This 141692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // enables us to maintain tightly packed objects when you are not using thread local buffers for 142fc4c27e4d68707271bd7578ae5c8bef93a3ea66bMathieu Chartier // allocation. The main block starts at the space Begin(). 143692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier void UpdateMainBlock() EXCLUSIVE_LOCKS_REQUIRED(block_lock_); 144590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 145590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier byte* growth_end_; 146692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier AtomicInteger objects_allocated_; // Accumulated from revoked thread local regions. 147692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier AtomicInteger bytes_allocated_; // Accumulated from revoked thread local regions. 148e6da9af8dfe0a3e3fbc2be700554f6478380e7b9Mathieu Chartier Mutex block_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER; 149fc4c27e4d68707271bd7578ae5c8bef93a3ea66bMathieu Chartier // The objects at the start of the space are stored in the main block. The main block doesn't 150fc4c27e4d68707271bd7578ae5c8bef93a3ea66bMathieu Chartier // have a header, this lets us walk empty spaces which are mprotected. 151fc4c27e4d68707271bd7578ae5c8bef93a3ea66bMathieu Chartier size_t main_block_size_ GUARDED_BY(block_lock_); 152692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // The number of blocks in the space, if it is 0 then the space has one long continuous block 153692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // which doesn't have an updated header. 154692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier size_t num_blocks_ GUARDED_BY(block_lock_); 155590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 156590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier private: 157692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier struct BlockHeader { 158692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier size_t size_; // Size of the block in bytes, does not include the header. 159692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier size_t unused_; // Ensures alignment of kAlignment. 160692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier }; 161692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier 162692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier COMPILE_ASSERT(sizeof(BlockHeader) % kAlignment == 0, 163692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier continuous_block_must_be_kAlignment_aligned); 164692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier 165590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier friend class collector::MarkSweep; 166590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier DISALLOW_COPY_AND_ASSIGN(BumpPointerSpace); 167590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier}; 168590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 169590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier} // namespace space 170590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier} // namespace gc 171590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier} // namespace art 172590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 173590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier#endif // ART_RUNTIME_GC_SPACE_BUMP_POINTER_SPACE_H_ 174