bump_pointer_space.h revision cbb2d20bea2861f244da2e2318d8c088300a3710
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 20590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier#include "space.h" 21590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 22590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartiernamespace art { 23590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartiernamespace gc { 24590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 25590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartiernamespace collector { 26590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier class MarkSweep; 27590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier} // namespace collector 28590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 29590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartiernamespace space { 30590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 31590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier// A bump pointer space is a space where objects may be allocated and garbage collected. 32590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartierclass BumpPointerSpace : public ContinuousMemMapAllocSpace { 33590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier public: 34590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier typedef void(*WalkCallback)(void *start, void *end, size_t num_bytes, void* callback_arg); 35590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 36590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier SpaceType GetType() const { 37590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return kSpaceTypeBumpPointerSpace; 38590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 39590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 40590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Create a bump pointer space with the requested sizes. The requested base address is not 41590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // guaranteed to be granted, if it is required, the caller should call Begin on the returned 42590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // space to confirm the request was granted. 43590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier static BumpPointerSpace* Create(const std::string& name, size_t capacity, byte* requested_begin); 44590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 45590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Allocate num_bytes, returns nullptr if the space is full. 46590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier virtual mirror::Object* Alloc(Thread* self, size_t num_bytes, size_t* bytes_allocated); 47590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier mirror::Object* AllocNonvirtual(size_t num_bytes); 48590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 49590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Return the storage space required by obj. 50590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier virtual size_t AllocationSize(const mirror::Object* obj) 51590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 52590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 53590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Nos unless we support free lists. 54590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier virtual size_t Free(Thread*, mirror::Object*) { 55590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return 0; 56590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 57590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier virtual size_t FreeList(Thread*, size_t, mirror::Object**) { 58590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return 0; 59590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 60590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 61590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier size_t AllocationSizeNonvirtual(const mirror::Object* obj) 62590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 63590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return obj->SizeOf(); 64590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 65590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 66590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Removes the fork time growth limit on capacity, allowing the application to allocate up to the 67590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // maximum reserved size of the heap. 68590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier void ClearGrowthLimit() { 69590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier growth_end_ = Limit(); 70590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 71590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 72590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Override capacity so that we only return the possibly limited capacity 73590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier size_t Capacity() const { 74590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return growth_end_ - begin_; 75590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 76590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 77590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // The total amount of memory reserved for the space. 78590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier size_t NonGrowthLimitCapacity() const { 79590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return GetMemMap()->Size(); 80590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 81590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 82590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier accounting::SpaceBitmap* GetLiveBitmap() const { 83590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return nullptr; 84590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 85590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 86590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier accounting::SpaceBitmap* GetMarkBitmap() const { 87590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return nullptr; 88590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 89590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 90590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Clear the memory and reset the pointer to the start of the space. 91590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier void Clear(); 92590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 93590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier void Dump(std::ostream& os) const; 94590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 95590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier uint64_t GetBytesAllocated() { 96590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return Size(); 97590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 98590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 99590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier uint64_t GetObjectsAllocated() { 100590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return num_objects_allocated_; 101590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 102590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 103590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier uint64_t GetTotalBytesAllocated() { 104590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return total_bytes_allocated_; 105590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 106590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 107590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier uint64_t GetTotalObjectsAllocated() { 108590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return total_objects_allocated_; 109590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 110590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 111590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier bool Contains(const mirror::Object* obj) const { 112590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier const byte* byte_obj = reinterpret_cast<const byte*>(obj); 113590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier return byte_obj >= Begin() && byte_obj < End(); 114590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier } 115590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 116590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // TODO: Change this? Mainly used for compacting to a particular region of memory. 117590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier BumpPointerSpace(const std::string& name, byte* begin, byte* limit); 118590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 119590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Return the object which comes after obj, while ensuring alignment. 120590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier static mirror::Object* GetNextObject(mirror::Object* obj) 121590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 122590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 123cbb2d20bea2861f244da2e2318d8c088300a3710Mathieu Chartier // Alignment. 124cbb2d20bea2861f244da2e2318d8c088300a3710Mathieu Chartier static constexpr size_t kAlignment = 8; 125cbb2d20bea2861f244da2e2318d8c088300a3710Mathieu Chartier 126590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier protected: 127590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier BumpPointerSpace(const std::string& name, MemMap* mem_map); 128590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 129590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier size_t InternalAllocationSize(const mirror::Object* obj); 130590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier mirror::Object* AllocWithoutGrowthLocked(size_t num_bytes, size_t* bytes_allocated) 131590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier EXCLUSIVE_LOCKS_REQUIRED(lock_); 132590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 133590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier // Approximate number of bytes which have been allocated into the space. 134590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier AtomicInteger num_objects_allocated_; 135590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier AtomicInteger total_bytes_allocated_; 136590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier AtomicInteger total_objects_allocated_; 137590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 138590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier byte* growth_end_; 139590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 140590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier private: 141590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier friend class collector::MarkSweep; 142590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier DISALLOW_COPY_AND_ASSIGN(BumpPointerSpace); 143590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier}; 144590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 145590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier} // namespace space 146590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier} // namespace gc 147590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier} // namespace art 148590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier 149590fee9e8972f872301c2d16a575d579ee564beeMathieu Chartier#endif // ART_RUNTIME_GC_SPACE_BUMP_POINTER_SPACE_H_ 150