rosalloc_space.h revision 31f441464c0c8f840aba37e236ad133f30308d70 
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
17#ifndef ART_RUNTIME_GC_SPACE_ROSALLOC_SPACE_H_
18#define ART_RUNTIME_GC_SPACE_ROSALLOC_SPACE_H_
19
20#include "gc/allocator/rosalloc.h"
21#include "malloc_space.h"
22#include "space.h"
23
24namespace art {
25namespace gc {
26
27namespace collector {
28  class MarkSweep;
29}  // namespace collector
30
31namespace space {
32
33// An alloc space implemented using a runs-of-slots memory allocator. Not final as may be
34// overridden by a ValgrindMallocSpace.
35class RosAllocSpace : public MallocSpace {
36 public:
37  // Create a RosAllocSpace with the requested sizes. The requested
38  // base address is not guaranteed to be granted, if it is required,
39  // the caller should call Begin on the returned space to confirm the
40  // request was granted.
41  static RosAllocSpace* Create(const std::string& name, size_t initial_size, size_t growth_limit,
42                               size_t capacity, byte* requested_begin, bool low_memory_mode,
43                               bool can_move_objects);
44  static RosAllocSpace* CreateFromMemMap(MemMap* mem_map, const std::string& name,
45                                         size_t starting_size, size_t initial_size,
46                                         size_t growth_limit, size_t capacity,
47                                         bool low_memory_mode, bool can_move_objects);
48
49  mirror::Object* AllocWithGrowth(Thread* self, size_t num_bytes, size_t* bytes_allocated,
50                                  size_t* usable_size) OVERRIDE LOCKS_EXCLUDED(lock_);
51  mirror::Object* Alloc(Thread* self, size_t num_bytes, size_t* bytes_allocated,
52                        size_t* usable_size) OVERRIDE {
53    return AllocNonvirtual(self, num_bytes, bytes_allocated, usable_size);
54  }
55  size_t AllocationSize(mirror::Object* obj, size_t* usable_size) OVERRIDE {
56    return AllocationSizeNonvirtual(obj, usable_size);
57  }
58  size_t Free(Thread* self, mirror::Object* ptr) OVERRIDE
59      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
60  size_t FreeList(Thread* self, size_t num_ptrs, mirror::Object** ptrs) OVERRIDE
61      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
62
63  mirror::Object* AllocNonvirtual(Thread* self, size_t num_bytes, size_t* bytes_allocated,
64                                  size_t* usable_size) {
65    // RosAlloc zeroes memory internally.
66    return AllocCommon(self, num_bytes, bytes_allocated, usable_size);
67  }
68
69  // TODO: NO_THREAD_SAFETY_ANALYSIS because SizeOf() requires that mutator_lock is held.
70  size_t AllocationSizeNonvirtual(mirror::Object* obj, size_t* usable_size)
71      NO_THREAD_SAFETY_ANALYSIS;
72
73  allocator::RosAlloc* GetRosAlloc() const {
74    return rosalloc_;
75  }
76
77  size_t Trim() OVERRIDE;
78  void Walk(WalkCallback callback, void* arg) OVERRIDE LOCKS_EXCLUDED(lock_);
79  size_t GetFootprint() OVERRIDE;
80  size_t GetFootprintLimit() OVERRIDE;
81  void SetFootprintLimit(size_t limit) OVERRIDE;
82
83  void Clear() OVERRIDE;
84
85  MallocSpace* CreateInstance(const std::string& name, MemMap* mem_map, void* allocator,
86                              byte* begin, byte* end, byte* limit, size_t growth_limit,
87                              bool can_move_objects) OVERRIDE;
88
89  uint64_t GetBytesAllocated() OVERRIDE;
90  uint64_t GetObjectsAllocated() OVERRIDE;
91
92  void RevokeThreadLocalBuffers(Thread* thread);
93  void RevokeAllThreadLocalBuffers();
94  void AssertAllThreadLocalBuffersAreRevoked();
95
96  // Returns the class of a recently freed object.
97  mirror::Class* FindRecentFreedObject(const mirror::Object* obj);
98
99  bool IsRosAllocSpace() const OVERRIDE {
100    return true;
101  }
102
103  RosAllocSpace* AsRosAllocSpace() OVERRIDE {
104    return this;
105  }
106
107  void Verify() EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_) {
108    rosalloc_->Verify();
109  }
110
111  virtual ~RosAllocSpace();
112
113 protected:
114  RosAllocSpace(const std::string& name, MemMap* mem_map, allocator::RosAlloc* rosalloc,
115                byte* begin, byte* end, byte* limit, size_t growth_limit, bool can_move_objects,
116                size_t starting_size, size_t initial_size, bool low_memory_mode);
117
118 private:
119  mirror::Object* AllocCommon(Thread* self, size_t num_bytes, size_t* bytes_allocated,
120                              size_t* usable_size);
121
122  void* CreateAllocator(void* base, size_t morecore_start, size_t initial_size,
123                        size_t maximum_size, bool low_memory_mode) OVERRIDE {
124    return CreateRosAlloc(base, morecore_start, initial_size, maximum_size, low_memory_mode);
125  }
126  static allocator::RosAlloc* CreateRosAlloc(void* base, size_t morecore_start, size_t initial_size,
127                                             size_t maximum_size, bool low_memory_mode);
128
129  void InspectAllRosAlloc(void (*callback)(void *start, void *end, size_t num_bytes, void* callback_arg),
130                          void* arg, bool do_null_callback_at_end)
131      LOCKS_EXCLUDED(Locks::runtime_shutdown_lock_, Locks::thread_list_lock_);
132  void InspectAllRosAllocWithSuspendAll(
133      void (*callback)(void *start, void *end, size_t num_bytes, void* callback_arg),
134      void* arg, bool do_null_callback_at_end)
135      LOCKS_EXCLUDED(Locks::runtime_shutdown_lock_, Locks::thread_list_lock_);
136
137  // Underlying rosalloc.
138  allocator::RosAlloc* rosalloc_;
139
140  const bool low_memory_mode_;
141
142  friend class collector::MarkSweep;
143
144  DISALLOW_COPY_AND_ASSIGN(RosAllocSpace);
145};
146
147}  // namespace space
148}  // namespace gc
149}  // namespace art
150
151#endif  // ART_RUNTIME_GC_SPACE_ROSALLOC_SPACE_H_
152