bump_pointer_space.h revision 15d3402bbf8265eb1165694da2e4117eb128f3bc
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. 45590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier static BumpPointerSpace* Create(const std::string& name, size_t capacity, byte* requested_begin); 46590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 47590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Allocate num_bytes, returns nullptr if the space is full. 486fac447555dc94a935b78198479cce645c837b89Ian Rogers mirror::Object* Alloc(Thread* self, size_t num_bytes, size_t* bytes_allocated, 496fac447555dc94a935b78198479cce645c837b89Ian Rogers size_t* usable_size) OVERRIDE; 50590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier mirror::Object* AllocNonvirtual(size_t num_bytes); 51692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier mirror::Object* AllocNonvirtualWithoutAccounting(size_t num_bytes); 52590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 53590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Return the storage space required by obj. 546fac447555dc94a935b78198479cce645c837b89Ian Rogers size_t AllocationSize(mirror::Object* obj, size_t* usable_size) OVERRIDE 556fac447555dc94a935b78198479cce645c837b89Ian Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 566fac447555dc94a935b78198479cce645c837b89Ian Rogers return AllocationSizeNonvirtual(obj, usable_size); 576fac447555dc94a935b78198479cce645c837b89Ian Rogers } 58590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 59692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // NOPS unless we support free lists. 606fac447555dc94a935b78198479cce645c837b89Ian Rogers size_t Free(Thread*, mirror::Object*) OVERRIDE { 61590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return 0; 62590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 636fac447555dc94a935b78198479cce645c837b89Ian Rogers 646fac447555dc94a935b78198479cce645c837b89Ian Rogers size_t FreeList(Thread*, size_t, mirror::Object**) OVERRIDE { 65590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return 0; 66590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 67590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 686fac447555dc94a935b78198479cce645c837b89Ian Rogers size_t AllocationSizeNonvirtual(mirror::Object* obj, size_t* usable_size) 696fac447555dc94a935b78198479cce645c837b89Ian Rogers SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 70590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 71590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Removes the fork time growth limit on capacity, allowing the application to allocate up to the 72590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // maximum reserved size of the heap. 73590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier void ClearGrowthLimit() { 74590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier growth_end_ = Limit(); 75590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 76590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 77590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Override capacity so that we only return the possibly limited capacity 78590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier size_t Capacity() const { 79590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return growth_end_ - begin_; 80590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 81590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 82590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // The total amount of memory reserved for the space. 83590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier size_t NonGrowthLimitCapacity() const { 84590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return GetMemMap()->Size(); 85590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 86590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 876fac447555dc94a935b78198479cce645c837b89Ian Rogers accounting::SpaceBitmap* GetLiveBitmap() const OVERRIDE { 88590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return nullptr; 89590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 90590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 916fac447555dc94a935b78198479cce645c837b89Ian Rogers accounting::SpaceBitmap* GetMarkBitmap() const OVERRIDE { 92590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return nullptr; 93590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 94590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 9515d3402bbf8265eb1165694da2e4117eb128f3bcMathieu Chartier // Madvise the memory back to the OS. 9615d3402bbf8265eb1165694da2e4117eb128f3bcMathieu Chartier void Clear() OVERRIDE; 9715d3402bbf8265eb1165694da2e4117eb128f3bcMathieu Chartier 9815d3402bbf8265eb1165694da2e4117eb128f3bcMathieu Chartier // Reset the pointer to the start of the space. 9915d3402bbf8265eb1165694da2e4117eb128f3bcMathieu Chartier void Reset() OVERRIDE LOCKS_EXCLUDED(block_lock_); 100590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 101590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier void Dump(std::ostream& os) const; 102590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 103e6da9af8dfe0a3e3fbc2be700554f6478380e7b9Mathieu Chartier void RevokeThreadLocalBuffers(Thread* thread) LOCKS_EXCLUDED(block_lock_); 104e6da9af8dfe0a3e3fbc2be700554f6478380e7b9Mathieu Chartier void RevokeAllThreadLocalBuffers() LOCKS_EXCLUDED(Locks::runtime_shutdown_lock_, 105e6da9af8dfe0a3e3fbc2be700554f6478380e7b9Mathieu Chartier Locks::thread_list_lock_); 106590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 107692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier uint64_t GetBytesAllocated() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 108692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier uint64_t GetObjectsAllocated() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 1096fac447555dc94a935b78198479cce645c837b89Ian Rogers bool IsEmpty() const { 1106fac447555dc94a935b78198479cce645c837b89Ian Rogers return Begin() == End(); 1116fac447555dc94a935b78198479cce645c837b89Ian Rogers } 1126fac447555dc94a935b78198479cce645c837b89Ian Rogers 113590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 114590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier bool Contains(const mirror::Object* obj) const { 115590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier const byte* byte_obj = reinterpret_cast<const byte*>(obj); 116590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return byte_obj >= Begin() && byte_obj < End(); 117590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 118590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 119590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // TODO: Change this? Mainly used for compacting to a particular region of memory. 120590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier BumpPointerSpace(const std::string& name, byte* begin, byte* limit); 121590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 122590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Return the object which comes after obj, while ensuring alignment. 123590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier static mirror::Object* GetNextObject(mirror::Object* obj) 124590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 125590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 126692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // Allocate a new TLAB, returns false if the allocation failed. 127e6da9af8dfe0a3e3fbc2be700554f6478380e7b9Mathieu Chartier bool AllocNewTlab(Thread* self, size_t bytes); 128692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier 1296fac447555dc94a935b78198479cce645c837b89Ian Rogers BumpPointerSpace* AsBumpPointerSpace() OVERRIDE { 1307410f29b4dae223befac036ea567d7f33351dad1Mathieu Chartier return this; 1317410f29b4dae223befac036ea567d7f33351dad1Mathieu Chartier } 1327410f29b4dae223befac036ea567d7f33351dad1Mathieu Chartier 133692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // Go through all of the blocks and visit the continuous objects. 13483c8ee000d525017ead8753fce6bc1020249b96aMathieu Chartier void Walk(ObjectCallback* callback, void* arg) 135692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 136692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier 1376fac447555dc94a935b78198479cce645c837b89Ian Rogers accounting::SpaceBitmap::SweepCallback* GetSweepCallback() OVERRIDE; 1386fac447555dc94a935b78198479cce645c837b89Ian Rogers 1397410f29b4dae223befac036ea567d7f33351dad1Mathieu Chartier // Object alignment within the space. 140cbb2d20bea2861f244da2e2318d8c088300a3710Mathieu Chartier static constexpr size_t kAlignment = 8; 141cbb2d20bea2861f244da2e2318d8c088300a3710Mathieu Chartier 142590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier protected: 143590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier BumpPointerSpace(const std::string& name, MemMap* mem_map); 144590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 145692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // Allocate a raw block of bytes. 146692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier byte* AllocBlock(size_t bytes) EXCLUSIVE_LOCKS_REQUIRED(block_lock_); 147692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier void RevokeThreadLocalBuffersLocked(Thread* thread) EXCLUSIVE_LOCKS_REQUIRED(block_lock_); 148692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier 149590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier mirror::Object* AllocWithoutGrowthLocked(size_t num_bytes, size_t* bytes_allocated) 150590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier EXCLUSIVE_LOCKS_REQUIRED(lock_); 151590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 152692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // The main block is an unbounded block where objects go when there are no other blocks. This 153692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // enables us to maintain tightly packed objects when you are not using thread local buffers for 154fc4c27e4d68707271bd7578ae5c8bef93a3ea66bMathieu Chartier // allocation. The main block starts at the space Begin(). 155692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier void UpdateMainBlock() EXCLUSIVE_LOCKS_REQUIRED(block_lock_); 156590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 157590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier byte* growth_end_; 158692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier AtomicInteger objects_allocated_; // Accumulated from revoked thread local regions. 159692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier AtomicInteger bytes_allocated_; // Accumulated from revoked thread local regions. 160e6da9af8dfe0a3e3fbc2be700554f6478380e7b9Mathieu Chartier Mutex block_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER; 161fc4c27e4d68707271bd7578ae5c8bef93a3ea66bMathieu Chartier // The objects at the start of the space are stored in the main block. The main block doesn't 162fc4c27e4d68707271bd7578ae5c8bef93a3ea66bMathieu Chartier // have a header, this lets us walk empty spaces which are mprotected. 163fc4c27e4d68707271bd7578ae5c8bef93a3ea66bMathieu Chartier size_t main_block_size_ GUARDED_BY(block_lock_); 164692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // The number of blocks in the space, if it is 0 then the space has one long continuous block 165692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier // which doesn't have an updated header. 166692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier size_t num_blocks_ GUARDED_BY(block_lock_); 167590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 168590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier private: 169692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier struct BlockHeader { 170692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier size_t size_; // Size of the block in bytes, does not include the header. 171692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier size_t unused_; // Ensures alignment of kAlignment. 172692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier }; 173692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier 174692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier COMPILE_ASSERT(sizeof(BlockHeader) % kAlignment == 0, 175692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier continuous_block_must_be_kAlignment_aligned); 176692fafd9778141fa6ef0048c9569abd7ee0253bfMathieu Chartier 177590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier friend class collector::MarkSweep; 178590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier DISALLOW_COPY_AND_ASSIGN(BumpPointerSpace); 179590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier}; 180590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 181590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier} // namespace space 182590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier} // namespace gc 183590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier} // namespace art 184590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 185590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier#endif // ART_RUNTIME_GC_SPACE_BUMP_POINTER_SPACE_H_ 186