Elliott Hughes | 2faa5f1 | 2012-01-30 14:42:07 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2011 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 | */ |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 16 | |
| 17 | #ifndef ART_SRC_MARK_SWEEP_H_ |
| 18 | #define ART_SRC_MARK_SWEEP_H_ |
| 19 | |
Brian Carlstrom | 578bbdc | 2011-07-21 14:07:47 -0700 | [diff] [blame] | 20 | #include "macros.h" |
| 21 | #include "mark_stack.h" |
Elliott Hughes | 5e71b52 | 2011-10-20 13:12:32 -0700 | [diff] [blame] | 22 | #include "heap_bitmap.h" |
Mathieu Chartier | b43b7d4 | 2012-06-19 13:15:09 -0700 | [diff] [blame] | 23 | #include "object.h" |
Ian Rogers | 0cfe1fb | 2011-08-26 03:29:44 -0700 | [diff] [blame] | 24 | #include "offsets.h" |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 25 | |
| 26 | namespace art { |
| 27 | |
Mathieu Chartier | b43b7d4 | 2012-06-19 13:15:09 -0700 | [diff] [blame] | 28 | class CheckObjectVisitor; |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 29 | class Class; |
Elliott Hughes | b3bd5f0 | 2012-03-08 21:05:27 -0800 | [diff] [blame] | 30 | class Heap; |
Mathieu Chartier | b43b7d4 | 2012-06-19 13:15:09 -0700 | [diff] [blame] | 31 | class MarkIfReachesAllocspaceVisitor; |
| 32 | class ModUnionClearCardVisitor; |
| 33 | class ModUnionVisitor; |
| 34 | class ModUnionTableBitmap; |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 35 | class Object; |
| 36 | |
| 37 | class MarkSweep { |
| 38 | public: |
Elliott Hughes | 7484741 | 2012-06-20 18:10:21 -0700 | [diff] [blame] | 39 | explicit MarkSweep(MarkStack* mark_stack); |
Carl Shapiro | 58551df | 2011-07-24 03:09:51 -0700 | [diff] [blame] | 40 | |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 41 | ~MarkSweep(); |
| 42 | |
Carl Shapiro | 58551df | 2011-07-24 03:09:51 -0700 | [diff] [blame] | 43 | // Initializes internal structures. |
Jesse Wilson | 078f9b0 | 2011-11-18 17:51:47 -0500 | [diff] [blame] | 44 | void Init(); |
Carl Shapiro | 58551df | 2011-07-24 03:09:51 -0700 | [diff] [blame] | 45 | |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 46 | // Marks the root set at the start of a garbage collection. |
| 47 | void MarkRoots(); |
| 48 | |
Mathieu Chartier | 262e5ff | 2012-06-01 17:35:38 -0700 | [diff] [blame] | 49 | // Marks the roots in the image space on dirty cards. |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 50 | void ScanDirtyImageRoots(); |
| 51 | |
Mathieu Chartier | 262e5ff | 2012-06-01 17:35:38 -0700 | [diff] [blame] | 52 | // Verify that image roots point to only marked objects within the alloc space. |
| 53 | void VerifyImageRoots(); |
| 54 | |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 55 | bool IsMarkStackEmpty() const { |
| 56 | return mark_stack_->IsEmpty(); |
| 57 | } |
| 58 | |
Carl Shapiro | 58551df | 2011-07-24 03:09:51 -0700 | [diff] [blame] | 59 | // Builds a mark stack and recursively mark until it empties. |
| 60 | void RecursiveMark(); |
| 61 | |
Mathieu Chartier | 262e5ff | 2012-06-01 17:35:38 -0700 | [diff] [blame] | 62 | // Builds a mark stack with objects on dirty cards and recursively mark |
| 63 | // until it empties. |
| 64 | void RecursiveMarkDirtyObjects(); |
| 65 | |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 66 | // Remarks the root set after completing the concurrent mark. |
| 67 | void ReMarkRoots(); |
| 68 | |
Carl Shapiro | 58551df | 2011-07-24 03:09:51 -0700 | [diff] [blame] | 69 | void ProcessReferences(bool clear_soft_references) { |
| 70 | ProcessReferences(&soft_reference_list_, clear_soft_references, |
| 71 | &weak_reference_list_, |
| 72 | &finalizer_reference_list_, |
| 73 | &phantom_reference_list_); |
| 74 | } |
| 75 | |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 76 | // Sweeps unmarked objects to complete the garbage collection. |
| 77 | void Sweep(); |
| 78 | |
Elliott Hughes | adb460d | 2011-10-05 17:02:34 -0700 | [diff] [blame] | 79 | Object* GetClearedReferences() { |
| 80 | return cleared_reference_list_; |
| 81 | } |
| 82 | |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 83 | private: |
| 84 | // Returns true if the object has its bit set in the mark bitmap. |
| 85 | bool IsMarked(const Object* object) const { |
| 86 | return mark_bitmap_->Test(object); |
| 87 | } |
| 88 | |
Elliott Hughes | c33a32b | 2011-10-11 18:18:07 -0700 | [diff] [blame] | 89 | static bool IsMarked(const Object* object, void* arg) { |
| 90 | return reinterpret_cast<MarkSweep*>(arg)->IsMarked(object); |
| 91 | } |
| 92 | |
Elliott Hughes | cf4c6c4 | 2011-09-01 15:16:42 -0700 | [diff] [blame] | 93 | static void MarkObjectVisitor(const Object* root, void* arg); |
Brian Carlstrom | 1f87008 | 2011-08-23 16:02:11 -0700 | [diff] [blame] | 94 | |
Mathieu Chartier | 262e5ff | 2012-06-01 17:35:38 -0700 | [diff] [blame] | 95 | static void ReMarkObjectVisitor(const Object* root, void* arg); |
| 96 | |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 97 | static void ScanImageRootVisitor(Object* root, void* arg); |
| 98 | |
Mathieu Chartier | b43b7d4 | 2012-06-19 13:15:09 -0700 | [diff] [blame] | 99 | static void VerifyImageRootVisitor(Object* root, void* arg); |
| 100 | |
Mathieu Chartier | 262e5ff | 2012-06-01 17:35:38 -0700 | [diff] [blame] | 101 | static void ScanDirtyCardCallback(Object* obj, void* arg); |
| 102 | |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 103 | // Marks an object. |
| 104 | void MarkObject(const Object* obj); |
| 105 | |
| 106 | // Yuck. |
| 107 | void MarkObject0(const Object* obj, bool check_finger); |
| 108 | |
Carl Shapiro | 58551df | 2011-07-24 03:09:51 -0700 | [diff] [blame] | 109 | static void ScanBitmapCallback(Object* obj, void* finger, void* arg); |
| 110 | |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 111 | static void CheckBitmapCallback(Object* obj, void* finger, void* arg); |
| 112 | |
Mathieu Chartier | b43b7d4 | 2012-06-19 13:15:09 -0700 | [diff] [blame] | 113 | static void CheckBitmapNoFingerCallback(Object* obj, void* arg); |
| 114 | |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 115 | static void SweepCallback(size_t num_ptrs, Object** ptrs, void* arg); |
Carl Shapiro | 58551df | 2011-07-24 03:09:51 -0700 | [diff] [blame] | 116 | |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 117 | void CheckReference(const Object* obj, const Object* ref, MemberOffset offset, bool is_static); |
| 118 | |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 119 | // Blackens an object. |
| 120 | void ScanObject(const Object* obj); |
| 121 | |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 122 | void CheckObject(const Object* obj); |
| 123 | |
Mathieu Chartier | b43b7d4 | 2012-06-19 13:15:09 -0700 | [diff] [blame] | 124 | template <typename Visitor> |
| 125 | void VisitObjectReferences(const Object* obj, const Visitor& visitor) { |
| 126 | DCHECK(obj != NULL); |
| 127 | DCHECK(obj->GetClass() != NULL); |
| 128 | if (obj->IsClass()) { |
| 129 | VisitClassReferences(obj, visitor); |
| 130 | } else if (obj->IsArrayInstance()) { |
| 131 | VisitArrayReferences(obj, visitor); |
| 132 | } else { |
| 133 | VisitOtherReferences(obj, visitor); |
| 134 | } |
| 135 | } |
| 136 | |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 137 | // Grays references in instance fields. |
| 138 | void ScanInstanceFields(const Object* obj); |
| 139 | |
Mathieu Chartier | b43b7d4 | 2012-06-19 13:15:09 -0700 | [diff] [blame] | 140 | template <typename Visitor> |
| 141 | void VisitInstanceFieldsReferences(const Object* obj, const Visitor& visitor) { |
| 142 | DCHECK(obj != NULL); |
| 143 | Class* klass = obj->GetClass(); |
| 144 | DCHECK(klass != NULL); |
| 145 | VisitFieldsReferences(obj, klass->GetReferenceInstanceOffsets(), false, visitor); |
| 146 | } |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 147 | |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 148 | // Blackens a class object. |
| 149 | void ScanClass(const Object* obj); |
| 150 | |
Mathieu Chartier | b43b7d4 | 2012-06-19 13:15:09 -0700 | [diff] [blame] | 151 | template <typename Visitor> |
| 152 | void VisitClassReferences(const Object* obj, const Visitor& visitor) { |
| 153 | VisitInstanceFieldsReferences(obj, visitor); |
| 154 | VisitStaticFieldsReferences(obj->AsClass(), visitor); |
| 155 | } |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 156 | |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 157 | // Grays references in static fields. |
| 158 | void ScanStaticFields(const Class* klass); |
| 159 | |
Mathieu Chartier | b43b7d4 | 2012-06-19 13:15:09 -0700 | [diff] [blame] | 160 | template <typename Visitor> |
| 161 | void VisitStaticFieldsReferences(const Class* klass, const Visitor& visitor) { |
| 162 | DCHECK(klass != NULL); |
| 163 | VisitFieldsReferences(klass, klass->GetReferenceStaticOffsets(), true, visitor); |
| 164 | } |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 165 | |
Brian Carlstrom | 4873d46 | 2011-08-21 15:23:39 -0700 | [diff] [blame] | 166 | // Used by ScanInstanceFields and ScanStaticFields |
| 167 | void ScanFields(const Object* obj, uint32_t ref_offsets, bool is_static); |
| 168 | |
Mathieu Chartier | b43b7d4 | 2012-06-19 13:15:09 -0700 | [diff] [blame] | 169 | template <typename Visitor> |
| 170 | void VisitFieldsReferences(const Object* obj, uint32_t ref_offsets, bool is_static, const Visitor& visitor) { |
| 171 | if (ref_offsets != CLASS_WALK_SUPER) { |
| 172 | // Found a reference offset bitmap. Mark the specified offsets. |
| 173 | while (ref_offsets != 0) { |
| 174 | size_t right_shift = CLZ(ref_offsets); |
| 175 | MemberOffset field_offset = CLASS_OFFSET_FROM_CLZ(right_shift); |
| 176 | const Object* ref = obj->GetFieldObject<const Object*>(field_offset, false); |
| 177 | visitor(obj, ref, field_offset, is_static); |
| 178 | ref_offsets &= ~(CLASS_HIGH_BIT >> right_shift); |
| 179 | } |
| 180 | } else { |
| 181 | // There is no reference offset bitmap. In the non-static case, |
| 182 | // walk up the class inheritance hierarchy and find reference |
| 183 | // offsets the hard way. In the static case, just consider this |
| 184 | // class. |
| 185 | for (const Class* klass = is_static ? obj->AsClass() : obj->GetClass(); |
| 186 | klass != NULL; |
| 187 | klass = is_static ? NULL : klass->GetSuperClass()) { |
| 188 | size_t num_reference_fields = (is_static |
| 189 | ? klass->NumReferenceStaticFields() |
| 190 | : klass->NumReferenceInstanceFields()); |
| 191 | for (size_t i = 0; i < num_reference_fields; ++i) { |
| 192 | Field* field = (is_static |
| 193 | ? klass->GetStaticField(i) |
| 194 | : klass->GetInstanceField(i)); |
| 195 | MemberOffset field_offset = field->GetOffset(); |
| 196 | const Object* ref = obj->GetFieldObject<const Object*>(field_offset, false); |
| 197 | visitor(obj, ref, field_offset, is_static); |
| 198 | } |
| 199 | } |
| 200 | } |
| 201 | } |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 202 | |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 203 | // Grays references in an array. |
| 204 | void ScanArray(const Object* obj); |
| 205 | |
Mathieu Chartier | b43b7d4 | 2012-06-19 13:15:09 -0700 | [diff] [blame] | 206 | template <typename Visitor> |
| 207 | void VisitArrayReferences(const Object* obj, const Visitor& visitor) { |
| 208 | visitor(obj, obj->GetClass(), Object::ClassOffset(), false); |
| 209 | if (obj->IsObjectArray()) { |
| 210 | const ObjectArray<Object>* array = obj->AsObjectArray<Object>(); |
| 211 | for (int32_t i = 0; i < array->GetLength(); ++i) { |
| 212 | const Object* element = array->GetWithoutChecks(i); |
| 213 | size_t width = sizeof(Object*); |
| 214 | visitor(obj, element, MemberOffset(i * width + Array::DataOffset(width).Int32Value()), false); |
| 215 | } |
| 216 | } |
| 217 | } |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 218 | |
Carl Shapiro | 58551df | 2011-07-24 03:09:51 -0700 | [diff] [blame] | 219 | void ScanOther(const Object* obj); |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 220 | |
Mathieu Chartier | b43b7d4 | 2012-06-19 13:15:09 -0700 | [diff] [blame] | 221 | template <typename Visitor> |
| 222 | void VisitOtherReferences(const Object* obj, const Visitor& visitor) { |
| 223 | return VisitInstanceFieldsReferences(obj, visitor); |
| 224 | } |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 225 | |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 226 | // Blackens objects grayed during a garbage collection. |
Mathieu Chartier | 262e5ff | 2012-06-01 17:35:38 -0700 | [diff] [blame] | 227 | void ScanGrayObjects(); |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 228 | |
| 229 | // Schedules an unmarked object for reference processing. |
| 230 | void DelayReferenceReferent(Object* reference); |
| 231 | |
| 232 | // Recursively blackens objects on the mark stack. |
| 233 | void ProcessMarkStack(); |
| 234 | |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 235 | void EnqueueFinalizerReferences(Object** ref); |
| 236 | |
| 237 | void PreserveSomeSoftReferences(Object** ref); |
| 238 | |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 239 | void ClearWhiteReferences(Object** list); |
| 240 | |
Carl Shapiro | 58551df | 2011-07-24 03:09:51 -0700 | [diff] [blame] | 241 | void ProcessReferences(Object** soft_references, bool clear_soft_references, |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 242 | Object** weak_references, |
| 243 | Object** finalizer_references, |
| 244 | Object** phantom_references); |
| 245 | |
Carl Shapiro | 58551df | 2011-07-24 03:09:51 -0700 | [diff] [blame] | 246 | void SweepSystemWeaks(); |
Elliott Hughes | 410c0c8 | 2011-09-01 17:58:25 -0700 | [diff] [blame] | 247 | void SweepJniWeakGlobals(); |
Carl Shapiro | 58551df | 2011-07-24 03:09:51 -0700 | [diff] [blame] | 248 | |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 249 | MarkStack* mark_stack_; |
| 250 | |
Elliott Hughes | b3bd5f0 | 2012-03-08 21:05:27 -0800 | [diff] [blame] | 251 | Heap* heap_; |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 252 | HeapBitmap* mark_bitmap_; |
Carl Shapiro | 58551df | 2011-07-24 03:09:51 -0700 | [diff] [blame] | 253 | HeapBitmap* live_bitmap_; |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 254 | |
| 255 | Object* finger_; |
| 256 | |
| 257 | Object* condemned_; |
| 258 | |
| 259 | Object* soft_reference_list_; |
| 260 | |
| 261 | Object* weak_reference_list_; |
| 262 | |
| 263 | Object* finalizer_reference_list_; |
| 264 | |
| 265 | Object* phantom_reference_list_; |
| 266 | |
| 267 | Object* cleared_reference_list_; |
| 268 | |
Elliott Hughes | 352a424 | 2011-10-31 15:15:21 -0700 | [diff] [blame] | 269 | size_t class_count_; |
| 270 | size_t array_count_; |
| 271 | size_t other_count_; |
| 272 | |
Mathieu Chartier | b43b7d4 | 2012-06-19 13:15:09 -0700 | [diff] [blame] | 273 | friend class CheckObjectVisitor; |
Elliott Hughes | 410c0c8 | 2011-09-01 17:58:25 -0700 | [diff] [blame] | 274 | friend class InternTableEntryIsUnmarked; |
Mathieu Chartier | b43b7d4 | 2012-06-19 13:15:09 -0700 | [diff] [blame] | 275 | friend class MarkIfReachesAllocspaceVisitor; |
| 276 | friend class ModUnionClearCardVisitor; |
| 277 | friend class ModUnionVisitor; |
| 278 | friend class ModUnionTableBitmap; |
Elliott Hughes | 410c0c8 | 2011-09-01 17:58:25 -0700 | [diff] [blame] | 279 | |
Carl Shapiro | 69759ea | 2011-07-21 18:13:35 -0700 | [diff] [blame] | 280 | DISALLOW_COPY_AND_ASSIGN(MarkSweep); |
| 281 | }; |
| 282 | |
| 283 | } // namespace art |
| 284 | |
| 285 | #endif // ART_SRC_MARK_SWEEP_H_ |