xref: /aosp_15_r20/art/runtime/gc/accounting/mod_union_table.cc (revision 795d594fd825385562da6b089ea9b2033f3abf5a)
1*795d594fSAndroid Build Coastguard Worker /*
2*795d594fSAndroid Build Coastguard Worker  * Copyright (C) 2012 The Android Open Source Project
3*795d594fSAndroid Build Coastguard Worker  *
4*795d594fSAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*795d594fSAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*795d594fSAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*795d594fSAndroid Build Coastguard Worker  *
8*795d594fSAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*795d594fSAndroid Build Coastguard Worker  *
10*795d594fSAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*795d594fSAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*795d594fSAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*795d594fSAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*795d594fSAndroid Build Coastguard Worker  * limitations under the License.
15*795d594fSAndroid Build Coastguard Worker  */
16*795d594fSAndroid Build Coastguard Worker 
17*795d594fSAndroid Build Coastguard Worker #include "mod_union_table.h"
18*795d594fSAndroid Build Coastguard Worker 
19*795d594fSAndroid Build Coastguard Worker #include <memory>
20*795d594fSAndroid Build Coastguard Worker 
21*795d594fSAndroid Build Coastguard Worker #include "base/logging.h"  // For VLOG
22*795d594fSAndroid Build Coastguard Worker #include "base/stl_util.h"
23*795d594fSAndroid Build Coastguard Worker #include "bitmap-inl.h"
24*795d594fSAndroid Build Coastguard Worker #include "card_table-inl.h"
25*795d594fSAndroid Build Coastguard Worker #include "gc/accounting/space_bitmap-inl.h"
26*795d594fSAndroid Build Coastguard Worker #include "gc/heap.h"
27*795d594fSAndroid Build Coastguard Worker #include "gc/space/image_space.h"
28*795d594fSAndroid Build Coastguard Worker #include "gc/space/space.h"
29*795d594fSAndroid Build Coastguard Worker #include "mirror/object-inl.h"
30*795d594fSAndroid Build Coastguard Worker #include "mirror/object-refvisitor-inl.h"
31*795d594fSAndroid Build Coastguard Worker #include "object_callbacks.h"
32*795d594fSAndroid Build Coastguard Worker #include "space_bitmap-inl.h"
33*795d594fSAndroid Build Coastguard Worker #include "thread-current-inl.h"
34*795d594fSAndroid Build Coastguard Worker 
35*795d594fSAndroid Build Coastguard Worker namespace art HIDDEN {
36*795d594fSAndroid Build Coastguard Worker namespace gc {
37*795d594fSAndroid Build Coastguard Worker namespace accounting {
38*795d594fSAndroid Build Coastguard Worker 
39*795d594fSAndroid Build Coastguard Worker class ModUnionAddToCardSetVisitor {
40*795d594fSAndroid Build Coastguard Worker  public:
ModUnionAddToCardSetVisitor(ModUnionTable::CardSet * const cleared_cards)41*795d594fSAndroid Build Coastguard Worker   explicit ModUnionAddToCardSetVisitor(ModUnionTable::CardSet* const cleared_cards)
42*795d594fSAndroid Build Coastguard Worker       : cleared_cards_(cleared_cards) {}
43*795d594fSAndroid Build Coastguard Worker 
operator ()(uint8_t * card,uint8_t expected_value,uint8_t new_value) const44*795d594fSAndroid Build Coastguard Worker   inline void operator()(uint8_t* card,
45*795d594fSAndroid Build Coastguard Worker                          uint8_t expected_value,
46*795d594fSAndroid Build Coastguard Worker                          [[maybe_unused]] uint8_t new_value) const {
47*795d594fSAndroid Build Coastguard Worker     if (expected_value == CardTable::kCardDirty) {
48*795d594fSAndroid Build Coastguard Worker       cleared_cards_->insert(card);
49*795d594fSAndroid Build Coastguard Worker     }
50*795d594fSAndroid Build Coastguard Worker   }
51*795d594fSAndroid Build Coastguard Worker 
52*795d594fSAndroid Build Coastguard Worker  private:
53*795d594fSAndroid Build Coastguard Worker   ModUnionTable::CardSet* const cleared_cards_;
54*795d594fSAndroid Build Coastguard Worker };
55*795d594fSAndroid Build Coastguard Worker 
56*795d594fSAndroid Build Coastguard Worker class ModUnionAddToCardBitmapVisitor {
57*795d594fSAndroid Build Coastguard Worker  public:
ModUnionAddToCardBitmapVisitor(ModUnionTable::CardBitmap * bitmap,CardTable * card_table)58*795d594fSAndroid Build Coastguard Worker   ModUnionAddToCardBitmapVisitor(ModUnionTable::CardBitmap* bitmap, CardTable* card_table)
59*795d594fSAndroid Build Coastguard Worker       : bitmap_(bitmap), card_table_(card_table) {}
60*795d594fSAndroid Build Coastguard Worker 
operator ()(uint8_t * card,uint8_t expected_value,uint8_t new_value) const61*795d594fSAndroid Build Coastguard Worker   inline void operator()(uint8_t* card,
62*795d594fSAndroid Build Coastguard Worker                          uint8_t expected_value,
63*795d594fSAndroid Build Coastguard Worker                          [[maybe_unused]] uint8_t new_value) const {
64*795d594fSAndroid Build Coastguard Worker     if (expected_value == CardTable::kCardDirty) {
65*795d594fSAndroid Build Coastguard Worker       // We want the address the card represents, not the address of the card.
66*795d594fSAndroid Build Coastguard Worker       bitmap_->Set(reinterpret_cast<uintptr_t>(card_table_->AddrFromCard(card)));
67*795d594fSAndroid Build Coastguard Worker     }
68*795d594fSAndroid Build Coastguard Worker   }
69*795d594fSAndroid Build Coastguard Worker 
70*795d594fSAndroid Build Coastguard Worker  private:
71*795d594fSAndroid Build Coastguard Worker   ModUnionTable::CardBitmap* const bitmap_;
72*795d594fSAndroid Build Coastguard Worker   CardTable* const card_table_;
73*795d594fSAndroid Build Coastguard Worker };
74*795d594fSAndroid Build Coastguard Worker 
75*795d594fSAndroid Build Coastguard Worker class ModUnionAddToCardVectorVisitor {
76*795d594fSAndroid Build Coastguard Worker  public:
ModUnionAddToCardVectorVisitor(std::vector<uint8_t * > * cleared_cards)77*795d594fSAndroid Build Coastguard Worker   explicit ModUnionAddToCardVectorVisitor(std::vector<uint8_t*>* cleared_cards)
78*795d594fSAndroid Build Coastguard Worker       : cleared_cards_(cleared_cards) {
79*795d594fSAndroid Build Coastguard Worker   }
80*795d594fSAndroid Build Coastguard Worker 
operator ()(uint8_t * card,uint8_t expected_card,uint8_t new_card) const81*795d594fSAndroid Build Coastguard Worker   void operator()(uint8_t* card, uint8_t expected_card, [[maybe_unused]] uint8_t new_card) const {
82*795d594fSAndroid Build Coastguard Worker     if (expected_card == CardTable::kCardDirty) {
83*795d594fSAndroid Build Coastguard Worker       cleared_cards_->push_back(card);
84*795d594fSAndroid Build Coastguard Worker     }
85*795d594fSAndroid Build Coastguard Worker   }
86*795d594fSAndroid Build Coastguard Worker 
87*795d594fSAndroid Build Coastguard Worker  private:
88*795d594fSAndroid Build Coastguard Worker   std::vector<uint8_t*>* const cleared_cards_;
89*795d594fSAndroid Build Coastguard Worker };
90*795d594fSAndroid Build Coastguard Worker 
91*795d594fSAndroid Build Coastguard Worker class ModUnionUpdateObjectReferencesVisitor {
92*795d594fSAndroid Build Coastguard Worker  public:
ModUnionUpdateObjectReferencesVisitor(MarkObjectVisitor * visitor,space::ContinuousSpace * from_space,space::ContinuousSpace * immune_space,bool * contains_reference_to_other_space)93*795d594fSAndroid Build Coastguard Worker   ModUnionUpdateObjectReferencesVisitor(MarkObjectVisitor* visitor,
94*795d594fSAndroid Build Coastguard Worker                                         space::ContinuousSpace* from_space,
95*795d594fSAndroid Build Coastguard Worker                                         space::ContinuousSpace* immune_space,
96*795d594fSAndroid Build Coastguard Worker                                         bool* contains_reference_to_other_space)
97*795d594fSAndroid Build Coastguard Worker     : visitor_(visitor),
98*795d594fSAndroid Build Coastguard Worker       from_space_(from_space),
99*795d594fSAndroid Build Coastguard Worker       immune_space_(immune_space),
100*795d594fSAndroid Build Coastguard Worker       contains_reference_to_other_space_(contains_reference_to_other_space) {}
101*795d594fSAndroid Build Coastguard Worker 
102*795d594fSAndroid Build Coastguard Worker   // Extra parameters are required since we use this same visitor signature for checking objects.
operator ()(mirror::Object * obj,MemberOffset offset,bool is_static) const103*795d594fSAndroid Build Coastguard Worker   void operator()(mirror::Object* obj, MemberOffset offset, [[maybe_unused]] bool is_static) const
104*795d594fSAndroid Build Coastguard Worker       REQUIRES_SHARED(Locks::mutator_lock_) {
105*795d594fSAndroid Build Coastguard Worker     MarkReference(obj->GetFieldObjectReferenceAddr(offset));
106*795d594fSAndroid Build Coastguard Worker   }
107*795d594fSAndroid Build Coastguard Worker 
VisitRootIfNonNull(mirror::CompressedReference<mirror::Object> * root) const108*795d594fSAndroid Build Coastguard Worker   void VisitRootIfNonNull(mirror::CompressedReference<mirror::Object>* root) const
109*795d594fSAndroid Build Coastguard Worker       REQUIRES_SHARED(Locks::mutator_lock_) {
110*795d594fSAndroid Build Coastguard Worker     VisitRoot(root);
111*795d594fSAndroid Build Coastguard Worker   }
112*795d594fSAndroid Build Coastguard Worker 
VisitRoot(mirror::CompressedReference<mirror::Object> * root) const113*795d594fSAndroid Build Coastguard Worker   void VisitRoot(mirror::CompressedReference<mirror::Object>* root) const
114*795d594fSAndroid Build Coastguard Worker       REQUIRES_SHARED(Locks::mutator_lock_) {
115*795d594fSAndroid Build Coastguard Worker     MarkReference(root);
116*795d594fSAndroid Build Coastguard Worker   }
117*795d594fSAndroid Build Coastguard Worker 
118*795d594fSAndroid Build Coastguard Worker  private:
119*795d594fSAndroid Build Coastguard Worker   template<typename CompressedReferenceType>
MarkReference(CompressedReferenceType * obj_ptr) const120*795d594fSAndroid Build Coastguard Worker   void MarkReference(CompressedReferenceType* obj_ptr) const
121*795d594fSAndroid Build Coastguard Worker       REQUIRES_SHARED(Locks::mutator_lock_) {
122*795d594fSAndroid Build Coastguard Worker     // Only add the reference if it is non null and fits our criteria.
123*795d594fSAndroid Build Coastguard Worker     mirror::Object* ref = obj_ptr->AsMirrorPtr();
124*795d594fSAndroid Build Coastguard Worker     if (ref != nullptr && !from_space_->HasAddress(ref) && !immune_space_->HasAddress(ref)) {
125*795d594fSAndroid Build Coastguard Worker       *contains_reference_to_other_space_ = true;
126*795d594fSAndroid Build Coastguard Worker       mirror::Object* new_object = visitor_->MarkObject(ref);
127*795d594fSAndroid Build Coastguard Worker       if (ref != new_object) {
128*795d594fSAndroid Build Coastguard Worker         obj_ptr->Assign(new_object);
129*795d594fSAndroid Build Coastguard Worker       }
130*795d594fSAndroid Build Coastguard Worker     }
131*795d594fSAndroid Build Coastguard Worker   }
132*795d594fSAndroid Build Coastguard Worker 
133*795d594fSAndroid Build Coastguard Worker   MarkObjectVisitor* const visitor_;
134*795d594fSAndroid Build Coastguard Worker   // Space which we are scanning
135*795d594fSAndroid Build Coastguard Worker   space::ContinuousSpace* const from_space_;
136*795d594fSAndroid Build Coastguard Worker   space::ContinuousSpace* const immune_space_;
137*795d594fSAndroid Build Coastguard Worker   // Set if we have any references to another space.
138*795d594fSAndroid Build Coastguard Worker   bool* const contains_reference_to_other_space_;
139*795d594fSAndroid Build Coastguard Worker };
140*795d594fSAndroid Build Coastguard Worker 
141*795d594fSAndroid Build Coastguard Worker class ModUnionScanImageRootVisitor {
142*795d594fSAndroid Build Coastguard Worker  public:
143*795d594fSAndroid Build Coastguard Worker   // Immune space is any other space which we don't care about references to. Currently this is
144*795d594fSAndroid Build Coastguard Worker   // the image space in the case of the zygote mod union table.
ModUnionScanImageRootVisitor(MarkObjectVisitor * visitor,space::ContinuousSpace * from_space,space::ContinuousSpace * immune_space,bool * contains_reference_to_other_space)145*795d594fSAndroid Build Coastguard Worker   ModUnionScanImageRootVisitor(MarkObjectVisitor* visitor,
146*795d594fSAndroid Build Coastguard Worker                                space::ContinuousSpace* from_space,
147*795d594fSAndroid Build Coastguard Worker                                space::ContinuousSpace* immune_space,
148*795d594fSAndroid Build Coastguard Worker                                bool* contains_reference_to_other_space)
149*795d594fSAndroid Build Coastguard Worker       : visitor_(visitor),
150*795d594fSAndroid Build Coastguard Worker         from_space_(from_space),
151*795d594fSAndroid Build Coastguard Worker         immune_space_(immune_space),
152*795d594fSAndroid Build Coastguard Worker         contains_reference_to_other_space_(contains_reference_to_other_space) {}
153*795d594fSAndroid Build Coastguard Worker 
operator ()(mirror::Object * root) const154*795d594fSAndroid Build Coastguard Worker   void operator()(mirror::Object* root) const
155*795d594fSAndroid Build Coastguard Worker       REQUIRES(Locks::heap_bitmap_lock_)
156*795d594fSAndroid Build Coastguard Worker       REQUIRES_SHARED(Locks::mutator_lock_) {
157*795d594fSAndroid Build Coastguard Worker     DCHECK(root != nullptr);
158*795d594fSAndroid Build Coastguard Worker     ModUnionUpdateObjectReferencesVisitor ref_visitor(visitor_,
159*795d594fSAndroid Build Coastguard Worker                                                       from_space_,
160*795d594fSAndroid Build Coastguard Worker                                                       immune_space_,
161*795d594fSAndroid Build Coastguard Worker                                                       contains_reference_to_other_space_);
162*795d594fSAndroid Build Coastguard Worker     root->VisitReferences(ref_visitor, VoidFunctor());
163*795d594fSAndroid Build Coastguard Worker   }
164*795d594fSAndroid Build Coastguard Worker 
165*795d594fSAndroid Build Coastguard Worker  private:
166*795d594fSAndroid Build Coastguard Worker   MarkObjectVisitor* const visitor_;
167*795d594fSAndroid Build Coastguard Worker   // Space which we are scanning
168*795d594fSAndroid Build Coastguard Worker   space::ContinuousSpace* const from_space_;
169*795d594fSAndroid Build Coastguard Worker   space::ContinuousSpace* const immune_space_;
170*795d594fSAndroid Build Coastguard Worker   // Set if we have any references to another space.
171*795d594fSAndroid Build Coastguard Worker   bool* const contains_reference_to_other_space_;
172*795d594fSAndroid Build Coastguard Worker };
173*795d594fSAndroid Build Coastguard Worker 
ProcessCards()174*795d594fSAndroid Build Coastguard Worker void ModUnionTableReferenceCache::ProcessCards() {
175*795d594fSAndroid Build Coastguard Worker   CardTable* card_table = GetHeap()->GetCardTable();
176*795d594fSAndroid Build Coastguard Worker   ModUnionAddToCardSetVisitor visitor(&cleared_cards_);
177*795d594fSAndroid Build Coastguard Worker   // Clear dirty cards in the this space and update the corresponding mod-union bits.
178*795d594fSAndroid Build Coastguard Worker   card_table->ModifyCardsAtomic(space_->Begin(), space_->End(), AgeCardVisitor(), visitor);
179*795d594fSAndroid Build Coastguard Worker }
180*795d594fSAndroid Build Coastguard Worker 
ClearTable()181*795d594fSAndroid Build Coastguard Worker void ModUnionTableReferenceCache::ClearTable() {
182*795d594fSAndroid Build Coastguard Worker   cleared_cards_.clear();
183*795d594fSAndroid Build Coastguard Worker   references_.clear();
184*795d594fSAndroid Build Coastguard Worker }
185*795d594fSAndroid Build Coastguard Worker 
186*795d594fSAndroid Build Coastguard Worker class AddToReferenceArrayVisitor {
187*795d594fSAndroid Build Coastguard Worker  public:
AddToReferenceArrayVisitor(ModUnionTableReferenceCache * mod_union_table,MarkObjectVisitor * visitor,std::vector<mirror::HeapReference<mirror::Object> * > * references,bool * has_target_reference)188*795d594fSAndroid Build Coastguard Worker   AddToReferenceArrayVisitor(ModUnionTableReferenceCache* mod_union_table,
189*795d594fSAndroid Build Coastguard Worker                              MarkObjectVisitor* visitor,
190*795d594fSAndroid Build Coastguard Worker                              std::vector<mirror::HeapReference<mirror::Object>*>* references,
191*795d594fSAndroid Build Coastguard Worker                              bool* has_target_reference)
192*795d594fSAndroid Build Coastguard Worker       : mod_union_table_(mod_union_table),
193*795d594fSAndroid Build Coastguard Worker         visitor_(visitor),
194*795d594fSAndroid Build Coastguard Worker         references_(references),
195*795d594fSAndroid Build Coastguard Worker         has_target_reference_(has_target_reference) {}
196*795d594fSAndroid Build Coastguard Worker 
197*795d594fSAndroid Build Coastguard Worker   // Extra parameters are required since we use this same visitor signature for checking objects.
operator ()(mirror::Object * obj,MemberOffset offset,bool is_static) const198*795d594fSAndroid Build Coastguard Worker   void operator()(mirror::Object* obj, MemberOffset offset, [[maybe_unused]] bool is_static) const
199*795d594fSAndroid Build Coastguard Worker       REQUIRES_SHARED(Locks::mutator_lock_) {
200*795d594fSAndroid Build Coastguard Worker     mirror::HeapReference<mirror::Object>* ref_ptr = obj->GetFieldObjectReferenceAddr(offset);
201*795d594fSAndroid Build Coastguard Worker     mirror::Object* ref = ref_ptr->AsMirrorPtr();
202*795d594fSAndroid Build Coastguard Worker     // Only add the reference if it is non null and fits our criteria.
203*795d594fSAndroid Build Coastguard Worker     if (ref != nullptr && mod_union_table_->ShouldAddReference(ref)) {
204*795d594fSAndroid Build Coastguard Worker       // Push the adddress of the reference.
205*795d594fSAndroid Build Coastguard Worker       references_->push_back(ref_ptr);
206*795d594fSAndroid Build Coastguard Worker     }
207*795d594fSAndroid Build Coastguard Worker   }
208*795d594fSAndroid Build Coastguard Worker 
VisitRootIfNonNull(mirror::CompressedReference<mirror::Object> * root) const209*795d594fSAndroid Build Coastguard Worker   void VisitRootIfNonNull(mirror::CompressedReference<mirror::Object>* root) const
210*795d594fSAndroid Build Coastguard Worker       REQUIRES_SHARED(Locks::mutator_lock_) {
211*795d594fSAndroid Build Coastguard Worker     if (!root->IsNull()) {
212*795d594fSAndroid Build Coastguard Worker       VisitRoot(root);
213*795d594fSAndroid Build Coastguard Worker     }
214*795d594fSAndroid Build Coastguard Worker   }
215*795d594fSAndroid Build Coastguard Worker 
VisitRoot(mirror::CompressedReference<mirror::Object> * root) const216*795d594fSAndroid Build Coastguard Worker   void VisitRoot(mirror::CompressedReference<mirror::Object>* root) const
217*795d594fSAndroid Build Coastguard Worker       REQUIRES_SHARED(Locks::mutator_lock_) {
218*795d594fSAndroid Build Coastguard Worker     if (mod_union_table_->ShouldAddReference(root->AsMirrorPtr())) {
219*795d594fSAndroid Build Coastguard Worker       *has_target_reference_ = true;
220*795d594fSAndroid Build Coastguard Worker       // TODO: Add MarkCompressedReference callback here.
221*795d594fSAndroid Build Coastguard Worker       mirror::Object* old_ref = root->AsMirrorPtr();
222*795d594fSAndroid Build Coastguard Worker       mirror::Object* new_ref = visitor_->MarkObject(old_ref);
223*795d594fSAndroid Build Coastguard Worker       if (old_ref != new_ref) {
224*795d594fSAndroid Build Coastguard Worker         root->Assign(new_ref);
225*795d594fSAndroid Build Coastguard Worker       }
226*795d594fSAndroid Build Coastguard Worker     }
227*795d594fSAndroid Build Coastguard Worker   }
228*795d594fSAndroid Build Coastguard Worker 
229*795d594fSAndroid Build Coastguard Worker  private:
230*795d594fSAndroid Build Coastguard Worker   ModUnionTableReferenceCache* const mod_union_table_;
231*795d594fSAndroid Build Coastguard Worker   MarkObjectVisitor* const visitor_;
232*795d594fSAndroid Build Coastguard Worker   std::vector<mirror::HeapReference<mirror::Object>*>* const references_;
233*795d594fSAndroid Build Coastguard Worker   bool* const has_target_reference_;
234*795d594fSAndroid Build Coastguard Worker };
235*795d594fSAndroid Build Coastguard Worker 
236*795d594fSAndroid Build Coastguard Worker class ModUnionReferenceVisitor {
237*795d594fSAndroid Build Coastguard Worker  public:
ModUnionReferenceVisitor(ModUnionTableReferenceCache * const mod_union_table,MarkObjectVisitor * visitor,std::vector<mirror::HeapReference<mirror::Object> * > * references,bool * has_target_reference)238*795d594fSAndroid Build Coastguard Worker   ModUnionReferenceVisitor(ModUnionTableReferenceCache* const mod_union_table,
239*795d594fSAndroid Build Coastguard Worker                            MarkObjectVisitor* visitor,
240*795d594fSAndroid Build Coastguard Worker                            std::vector<mirror::HeapReference<mirror::Object>*>* references,
241*795d594fSAndroid Build Coastguard Worker                            bool* has_target_reference)
242*795d594fSAndroid Build Coastguard Worker       : mod_union_table_(mod_union_table),
243*795d594fSAndroid Build Coastguard Worker         visitor_(visitor),
244*795d594fSAndroid Build Coastguard Worker         references_(references),
245*795d594fSAndroid Build Coastguard Worker         has_target_reference_(has_target_reference) {}
246*795d594fSAndroid Build Coastguard Worker 
operator ()(mirror::Object * obj) const247*795d594fSAndroid Build Coastguard Worker   void operator()(mirror::Object* obj) const
248*795d594fSAndroid Build Coastguard Worker       REQUIRES_SHARED(Locks::heap_bitmap_lock_, Locks::mutator_lock_) {
249*795d594fSAndroid Build Coastguard Worker     // We don't have an early exit since we use the visitor pattern, an early
250*795d594fSAndroid Build Coastguard Worker     // exit should significantly speed this up.
251*795d594fSAndroid Build Coastguard Worker     AddToReferenceArrayVisitor visitor(mod_union_table_,
252*795d594fSAndroid Build Coastguard Worker                                        visitor_,
253*795d594fSAndroid Build Coastguard Worker                                        references_,
254*795d594fSAndroid Build Coastguard Worker                                        has_target_reference_);
255*795d594fSAndroid Build Coastguard Worker     obj->VisitReferences(visitor, VoidFunctor());
256*795d594fSAndroid Build Coastguard Worker   }
257*795d594fSAndroid Build Coastguard Worker 
258*795d594fSAndroid Build Coastguard Worker  private:
259*795d594fSAndroid Build Coastguard Worker   ModUnionTableReferenceCache* const mod_union_table_;
260*795d594fSAndroid Build Coastguard Worker   MarkObjectVisitor* const visitor_;
261*795d594fSAndroid Build Coastguard Worker   std::vector<mirror::HeapReference<mirror::Object>*>* const references_;
262*795d594fSAndroid Build Coastguard Worker   bool* const has_target_reference_;
263*795d594fSAndroid Build Coastguard Worker };
264*795d594fSAndroid Build Coastguard Worker 
265*795d594fSAndroid Build Coastguard Worker class CheckReferenceVisitor {
266*795d594fSAndroid Build Coastguard Worker  public:
CheckReferenceVisitor(ModUnionTableReferenceCache * mod_union_table,const std::set<mirror::Object * > & references)267*795d594fSAndroid Build Coastguard Worker   CheckReferenceVisitor(ModUnionTableReferenceCache* mod_union_table,
268*795d594fSAndroid Build Coastguard Worker                         const std::set<mirror::Object*>& references)
269*795d594fSAndroid Build Coastguard Worker       : mod_union_table_(mod_union_table),
270*795d594fSAndroid Build Coastguard Worker         references_(references) {}
271*795d594fSAndroid Build Coastguard Worker 
272*795d594fSAndroid Build Coastguard Worker   // Extra parameters are required since we use this same visitor signature for checking objects.
operator ()(mirror::Object * obj,MemberOffset offset,bool is_static) const273*795d594fSAndroid Build Coastguard Worker   void operator()(mirror::Object* obj, MemberOffset offset, [[maybe_unused]] bool is_static) const
274*795d594fSAndroid Build Coastguard Worker       REQUIRES_SHARED(Locks::heap_bitmap_lock_, Locks::mutator_lock_) {
275*795d594fSAndroid Build Coastguard Worker     mirror::Object* ref = obj->GetFieldObject<mirror::Object>(offset);
276*795d594fSAndroid Build Coastguard Worker     if (ref != nullptr &&
277*795d594fSAndroid Build Coastguard Worker         mod_union_table_->ShouldAddReference(ref) &&
278*795d594fSAndroid Build Coastguard Worker         references_.find(ref) == references_.end()) {
279*795d594fSAndroid Build Coastguard Worker       Heap* heap = mod_union_table_->GetHeap();
280*795d594fSAndroid Build Coastguard Worker       space::ContinuousSpace* from_space = heap->FindContinuousSpaceFromObject(obj, false);
281*795d594fSAndroid Build Coastguard Worker       space::ContinuousSpace* to_space = heap->FindContinuousSpaceFromObject(ref, false);
282*795d594fSAndroid Build Coastguard Worker       LOG(INFO) << "Object " << reinterpret_cast<const void*>(obj) << "(" << obj->PrettyTypeOf()
283*795d594fSAndroid Build Coastguard Worker                 << ")" << "References "
284*795d594fSAndroid Build Coastguard Worker                 << reinterpret_cast<const void*>(ref) << "(" << mirror::Object::PrettyTypeOf(ref)
285*795d594fSAndroid Build Coastguard Worker           << ") without being in mod-union table";
286*795d594fSAndroid Build Coastguard Worker       LOG(INFO) << "FromSpace " << from_space->GetName() << " type "
287*795d594fSAndroid Build Coastguard Worker           << from_space->GetGcRetentionPolicy();
288*795d594fSAndroid Build Coastguard Worker       LOG(INFO) << "ToSpace " << to_space->GetName() << " type "
289*795d594fSAndroid Build Coastguard Worker           << to_space->GetGcRetentionPolicy();
290*795d594fSAndroid Build Coastguard Worker       heap->DumpSpaces(LOG_STREAM(INFO));
291*795d594fSAndroid Build Coastguard Worker       LOG(FATAL) << "FATAL ERROR";
292*795d594fSAndroid Build Coastguard Worker     }
293*795d594fSAndroid Build Coastguard Worker   }
294*795d594fSAndroid Build Coastguard Worker 
VisitRootIfNonNull(mirror::CompressedReference<mirror::Object> * root) const295*795d594fSAndroid Build Coastguard Worker   void VisitRootIfNonNull(mirror::CompressedReference<mirror::Object>* root) const
296*795d594fSAndroid Build Coastguard Worker       REQUIRES_SHARED(Locks::mutator_lock_) {
297*795d594fSAndroid Build Coastguard Worker     if (kIsDebugBuild && !root->IsNull()) {
298*795d594fSAndroid Build Coastguard Worker       VisitRoot(root);
299*795d594fSAndroid Build Coastguard Worker     }
300*795d594fSAndroid Build Coastguard Worker   }
301*795d594fSAndroid Build Coastguard Worker 
VisitRoot(mirror::CompressedReference<mirror::Object> * root) const302*795d594fSAndroid Build Coastguard Worker   void VisitRoot(mirror::CompressedReference<mirror::Object>* root) const
303*795d594fSAndroid Build Coastguard Worker       REQUIRES_SHARED(Locks::mutator_lock_) {
304*795d594fSAndroid Build Coastguard Worker     DCHECK(!mod_union_table_->ShouldAddReference(root->AsMirrorPtr()));
305*795d594fSAndroid Build Coastguard Worker   }
306*795d594fSAndroid Build Coastguard Worker 
307*795d594fSAndroid Build Coastguard Worker  private:
308*795d594fSAndroid Build Coastguard Worker   ModUnionTableReferenceCache* const mod_union_table_;
309*795d594fSAndroid Build Coastguard Worker   const std::set<mirror::Object*>& references_;
310*795d594fSAndroid Build Coastguard Worker };
311*795d594fSAndroid Build Coastguard Worker 
312*795d594fSAndroid Build Coastguard Worker class ModUnionCheckReferences {
313*795d594fSAndroid Build Coastguard Worker  public:
ModUnionCheckReferences(ModUnionTableReferenceCache * mod_union_table,const std::set<mirror::Object * > & references)314*795d594fSAndroid Build Coastguard Worker   ModUnionCheckReferences(ModUnionTableReferenceCache* mod_union_table,
315*795d594fSAndroid Build Coastguard Worker                           const std::set<mirror::Object*>& references)
316*795d594fSAndroid Build Coastguard Worker       REQUIRES(Locks::heap_bitmap_lock_)
317*795d594fSAndroid Build Coastguard Worker       : mod_union_table_(mod_union_table), references_(references) {}
318*795d594fSAndroid Build Coastguard Worker 
operator ()(mirror::Object * obj) const319*795d594fSAndroid Build Coastguard Worker   void operator()(mirror::Object* obj) const NO_THREAD_SAFETY_ANALYSIS {
320*795d594fSAndroid Build Coastguard Worker     Locks::heap_bitmap_lock_->AssertSharedHeld(Thread::Current());
321*795d594fSAndroid Build Coastguard Worker     CheckReferenceVisitor visitor(mod_union_table_, references_);
322*795d594fSAndroid Build Coastguard Worker     obj->VisitReferences(visitor, VoidFunctor());
323*795d594fSAndroid Build Coastguard Worker   }
324*795d594fSAndroid Build Coastguard Worker 
325*795d594fSAndroid Build Coastguard Worker  private:
326*795d594fSAndroid Build Coastguard Worker   ModUnionTableReferenceCache* const mod_union_table_;
327*795d594fSAndroid Build Coastguard Worker   const std::set<mirror::Object*>& references_;
328*795d594fSAndroid Build Coastguard Worker };
329*795d594fSAndroid Build Coastguard Worker 
330*795d594fSAndroid Build Coastguard Worker class EmptyMarkObjectVisitor : public MarkObjectVisitor {
331*795d594fSAndroid Build Coastguard Worker  public:
MarkObject(mirror::Object * obj)332*795d594fSAndroid Build Coastguard Worker   mirror::Object* MarkObject(mirror::Object* obj) override {return obj;}
MarkHeapReference(mirror::HeapReference<mirror::Object> *,bool)333*795d594fSAndroid Build Coastguard Worker   void MarkHeapReference(mirror::HeapReference<mirror::Object>*, bool) override {}
334*795d594fSAndroid Build Coastguard Worker };
335*795d594fSAndroid Build Coastguard Worker 
FilterCards()336*795d594fSAndroid Build Coastguard Worker void ModUnionTable::FilterCards() {
337*795d594fSAndroid Build Coastguard Worker   EmptyMarkObjectVisitor visitor;
338*795d594fSAndroid Build Coastguard Worker   // Use empty visitor since filtering is automatically done by UpdateAndMarkReferences.
339*795d594fSAndroid Build Coastguard Worker   UpdateAndMarkReferences(&visitor);
340*795d594fSAndroid Build Coastguard Worker }
341*795d594fSAndroid Build Coastguard Worker 
Verify()342*795d594fSAndroid Build Coastguard Worker void ModUnionTableReferenceCache::Verify() {
343*795d594fSAndroid Build Coastguard Worker   // Start by checking that everything in the mod union table is marked.
344*795d594fSAndroid Build Coastguard Worker   for (const auto& ref_pair : references_) {
345*795d594fSAndroid Build Coastguard Worker     for (mirror::HeapReference<mirror::Object>* ref : ref_pair.second) {
346*795d594fSAndroid Build Coastguard Worker       CHECK(heap_->IsLiveObjectLocked(ref->AsMirrorPtr()));
347*795d594fSAndroid Build Coastguard Worker     }
348*795d594fSAndroid Build Coastguard Worker   }
349*795d594fSAndroid Build Coastguard Worker 
350*795d594fSAndroid Build Coastguard Worker   // Check the references of each clean card which is also in the mod union table.
351*795d594fSAndroid Build Coastguard Worker   CardTable* card_table = heap_->GetCardTable();
352*795d594fSAndroid Build Coastguard Worker   ContinuousSpaceBitmap* live_bitmap = space_->GetLiveBitmap();
353*795d594fSAndroid Build Coastguard Worker   for (const auto& ref_pair : references_) {
354*795d594fSAndroid Build Coastguard Worker     const uint8_t* card = ref_pair.first;
355*795d594fSAndroid Build Coastguard Worker     if (*card == CardTable::kCardClean) {
356*795d594fSAndroid Build Coastguard Worker       std::set<mirror::Object*> reference_set;
357*795d594fSAndroid Build Coastguard Worker       for (mirror::HeapReference<mirror::Object>* obj_ptr : ref_pair.second) {
358*795d594fSAndroid Build Coastguard Worker         reference_set.insert(obj_ptr->AsMirrorPtr());
359*795d594fSAndroid Build Coastguard Worker       }
360*795d594fSAndroid Build Coastguard Worker       ModUnionCheckReferences visitor(this, reference_set);
361*795d594fSAndroid Build Coastguard Worker       uintptr_t start = reinterpret_cast<uintptr_t>(card_table->AddrFromCard(card));
362*795d594fSAndroid Build Coastguard Worker       live_bitmap->VisitMarkedRange(start, start + CardTable::kCardSize, visitor);
363*795d594fSAndroid Build Coastguard Worker     }
364*795d594fSAndroid Build Coastguard Worker   }
365*795d594fSAndroid Build Coastguard Worker }
366*795d594fSAndroid Build Coastguard Worker 
Dump(std::ostream & os)367*795d594fSAndroid Build Coastguard Worker void ModUnionTableReferenceCache::Dump(std::ostream& os) {
368*795d594fSAndroid Build Coastguard Worker   CardTable* card_table = heap_->GetCardTable();
369*795d594fSAndroid Build Coastguard Worker   os << "ModUnionTable cleared cards: [";
370*795d594fSAndroid Build Coastguard Worker   for (uint8_t* card_addr : cleared_cards_) {
371*795d594fSAndroid Build Coastguard Worker     uintptr_t start = reinterpret_cast<uintptr_t>(card_table->AddrFromCard(card_addr));
372*795d594fSAndroid Build Coastguard Worker     uintptr_t end = start + CardTable::kCardSize;
373*795d594fSAndroid Build Coastguard Worker     os << reinterpret_cast<void*>(start) << "-" << reinterpret_cast<void*>(end) << ",";
374*795d594fSAndroid Build Coastguard Worker   }
375*795d594fSAndroid Build Coastguard Worker   os << "]\nModUnionTable references: [";
376*795d594fSAndroid Build Coastguard Worker   for (const auto& ref_pair : references_) {
377*795d594fSAndroid Build Coastguard Worker     const uint8_t* card_addr = ref_pair.first;
378*795d594fSAndroid Build Coastguard Worker     uintptr_t start = reinterpret_cast<uintptr_t>(card_table->AddrFromCard(card_addr));
379*795d594fSAndroid Build Coastguard Worker     uintptr_t end = start + CardTable::kCardSize;
380*795d594fSAndroid Build Coastguard Worker     os << reinterpret_cast<void*>(start) << "-" << reinterpret_cast<void*>(end) << "->{";
381*795d594fSAndroid Build Coastguard Worker     for (mirror::HeapReference<mirror::Object>* ref : ref_pair.second) {
382*795d594fSAndroid Build Coastguard Worker       os << reinterpret_cast<const void*>(ref->AsMirrorPtr()) << ",";
383*795d594fSAndroid Build Coastguard Worker     }
384*795d594fSAndroid Build Coastguard Worker     os << "},";
385*795d594fSAndroid Build Coastguard Worker   }
386*795d594fSAndroid Build Coastguard Worker }
387*795d594fSAndroid Build Coastguard Worker 
VisitObjects(ObjectCallback callback,void * arg)388*795d594fSAndroid Build Coastguard Worker void ModUnionTableReferenceCache::VisitObjects(ObjectCallback callback, void* arg) {
389*795d594fSAndroid Build Coastguard Worker   CardTable* const card_table = heap_->GetCardTable();
390*795d594fSAndroid Build Coastguard Worker   ContinuousSpaceBitmap* live_bitmap = space_->GetLiveBitmap();
391*795d594fSAndroid Build Coastguard Worker   // Use an unordered_set for constant time search of card in the second loop.
392*795d594fSAndroid Build Coastguard Worker   // We don't want to change cleared_cards_ to unordered so that traversals are
393*795d594fSAndroid Build Coastguard Worker   // sequential in address order.
394*795d594fSAndroid Build Coastguard Worker   // TODO: Optimize this.
395*795d594fSAndroid Build Coastguard Worker   std::unordered_set<const uint8_t*> card_lookup_map;
396*795d594fSAndroid Build Coastguard Worker   for (uint8_t* card : cleared_cards_) {
397*795d594fSAndroid Build Coastguard Worker     uintptr_t start = reinterpret_cast<uintptr_t>(card_table->AddrFromCard(card));
398*795d594fSAndroid Build Coastguard Worker     uintptr_t end = start + CardTable::kCardSize;
399*795d594fSAndroid Build Coastguard Worker     live_bitmap->VisitMarkedRange(start,
400*795d594fSAndroid Build Coastguard Worker                                   end,
401*795d594fSAndroid Build Coastguard Worker                                   [callback, arg](mirror::Object* obj) {
402*795d594fSAndroid Build Coastguard Worker       callback(obj, arg);
403*795d594fSAndroid Build Coastguard Worker     });
404*795d594fSAndroid Build Coastguard Worker     card_lookup_map.insert(card);
405*795d594fSAndroid Build Coastguard Worker   }
406*795d594fSAndroid Build Coastguard Worker   for (const auto& pair : references_) {
407*795d594fSAndroid Build Coastguard Worker     const uint8_t* card = pair.first;
408*795d594fSAndroid Build Coastguard Worker     if (card_lookup_map.find(card) != card_lookup_map.end()) {
409*795d594fSAndroid Build Coastguard Worker       continue;
410*795d594fSAndroid Build Coastguard Worker     }
411*795d594fSAndroid Build Coastguard Worker     uintptr_t start = reinterpret_cast<uintptr_t>(card_table->AddrFromCard(card));
412*795d594fSAndroid Build Coastguard Worker     uintptr_t end = start + CardTable::kCardSize;
413*795d594fSAndroid Build Coastguard Worker     live_bitmap->VisitMarkedRange(start,
414*795d594fSAndroid Build Coastguard Worker                                   end,
415*795d594fSAndroid Build Coastguard Worker                                   [callback, arg](mirror::Object* obj) {
416*795d594fSAndroid Build Coastguard Worker       callback(obj, arg);
417*795d594fSAndroid Build Coastguard Worker     });
418*795d594fSAndroid Build Coastguard Worker   }
419*795d594fSAndroid Build Coastguard Worker }
420*795d594fSAndroid Build Coastguard Worker 
UpdateAndMarkReferences(MarkObjectVisitor * visitor)421*795d594fSAndroid Build Coastguard Worker void ModUnionTableReferenceCache::UpdateAndMarkReferences(MarkObjectVisitor* visitor) {
422*795d594fSAndroid Build Coastguard Worker   CardTable* const card_table = heap_->GetCardTable();
423*795d594fSAndroid Build Coastguard Worker   std::vector<mirror::HeapReference<mirror::Object>*> cards_references;
424*795d594fSAndroid Build Coastguard Worker   // If has_target_reference is true then there was a GcRoot compressed reference which wasn't
425*795d594fSAndroid Build Coastguard Worker   // added. In this case we need to keep the card dirty.
426*795d594fSAndroid Build Coastguard Worker   // We don't know if the GcRoot addresses will remain constant, for example, classloaders have a
427*795d594fSAndroid Build Coastguard Worker   // hash set of GcRoot which may be resized or modified.
428*795d594fSAndroid Build Coastguard Worker   bool has_target_reference;
429*795d594fSAndroid Build Coastguard Worker   ModUnionReferenceVisitor add_visitor(this, visitor, &cards_references, &has_target_reference);
430*795d594fSAndroid Build Coastguard Worker   CardSet new_cleared_cards;
431*795d594fSAndroid Build Coastguard Worker   for (uint8_t* card : cleared_cards_) {
432*795d594fSAndroid Build Coastguard Worker     // Clear and re-compute alloc space references associated with this card.
433*795d594fSAndroid Build Coastguard Worker     cards_references.clear();
434*795d594fSAndroid Build Coastguard Worker     has_target_reference = false;
435*795d594fSAndroid Build Coastguard Worker     uintptr_t start = reinterpret_cast<uintptr_t>(card_table->AddrFromCard(card));
436*795d594fSAndroid Build Coastguard Worker     uintptr_t end = start + CardTable::kCardSize;
437*795d594fSAndroid Build Coastguard Worker     space::ContinuousSpace* space =
438*795d594fSAndroid Build Coastguard Worker         heap_->FindContinuousSpaceFromObject(reinterpret_cast<mirror::Object*>(start), false);
439*795d594fSAndroid Build Coastguard Worker     DCHECK(space != nullptr);
440*795d594fSAndroid Build Coastguard Worker     ContinuousSpaceBitmap* live_bitmap = space->GetLiveBitmap();
441*795d594fSAndroid Build Coastguard Worker     live_bitmap->VisitMarkedRange(start, end, add_visitor);
442*795d594fSAndroid Build Coastguard Worker     // Update the corresponding references for the card.
443*795d594fSAndroid Build Coastguard Worker     auto found = references_.find(card);
444*795d594fSAndroid Build Coastguard Worker     if (found == references_.end()) {
445*795d594fSAndroid Build Coastguard Worker       // Don't add card for an empty reference array.
446*795d594fSAndroid Build Coastguard Worker       if (!cards_references.empty()) {
447*795d594fSAndroid Build Coastguard Worker         references_.Put(card, cards_references);
448*795d594fSAndroid Build Coastguard Worker       }
449*795d594fSAndroid Build Coastguard Worker     } else {
450*795d594fSAndroid Build Coastguard Worker       if (cards_references.empty()) {
451*795d594fSAndroid Build Coastguard Worker         references_.erase(found);
452*795d594fSAndroid Build Coastguard Worker       } else {
453*795d594fSAndroid Build Coastguard Worker         found->second = cards_references;
454*795d594fSAndroid Build Coastguard Worker       }
455*795d594fSAndroid Build Coastguard Worker     }
456*795d594fSAndroid Build Coastguard Worker     if (has_target_reference) {
457*795d594fSAndroid Build Coastguard Worker       // Keep this card for next time since it contains a GcRoot which matches the
458*795d594fSAndroid Build Coastguard Worker       // ShouldAddReference criteria. This usually occurs for class loaders.
459*795d594fSAndroid Build Coastguard Worker       new_cleared_cards.insert(card);
460*795d594fSAndroid Build Coastguard Worker     }
461*795d594fSAndroid Build Coastguard Worker   }
462*795d594fSAndroid Build Coastguard Worker   cleared_cards_ = std::move(new_cleared_cards);
463*795d594fSAndroid Build Coastguard Worker   size_t count = 0;
464*795d594fSAndroid Build Coastguard Worker   for (auto it = references_.begin(); it != references_.end();) {
465*795d594fSAndroid Build Coastguard Worker     std::vector<mirror::HeapReference<mirror::Object>*>& references = it->second;
466*795d594fSAndroid Build Coastguard Worker     // Since there is no card mark for setting a reference to null, we check each reference.
467*795d594fSAndroid Build Coastguard Worker     // If all of the references of a card are null then we can remove that card. This is racy
468*795d594fSAndroid Build Coastguard Worker     // with the mutators, but handled by rescanning dirty cards.
469*795d594fSAndroid Build Coastguard Worker     bool all_null = true;
470*795d594fSAndroid Build Coastguard Worker     for (mirror::HeapReference<mirror::Object>* obj_ptr : references) {
471*795d594fSAndroid Build Coastguard Worker       if (obj_ptr->AsMirrorPtr() != nullptr) {
472*795d594fSAndroid Build Coastguard Worker         all_null = false;
473*795d594fSAndroid Build Coastguard Worker         visitor->MarkHeapReference(obj_ptr, /*do_atomic_update=*/ false);
474*795d594fSAndroid Build Coastguard Worker       }
475*795d594fSAndroid Build Coastguard Worker     }
476*795d594fSAndroid Build Coastguard Worker     count += references.size();
477*795d594fSAndroid Build Coastguard Worker     if (!all_null) {
478*795d594fSAndroid Build Coastguard Worker       ++it;
479*795d594fSAndroid Build Coastguard Worker     } else {
480*795d594fSAndroid Build Coastguard Worker       // All null references, erase the array from the set.
481*795d594fSAndroid Build Coastguard Worker       it = references_.erase(it);
482*795d594fSAndroid Build Coastguard Worker     }
483*795d594fSAndroid Build Coastguard Worker   }
484*795d594fSAndroid Build Coastguard Worker   if (VLOG_IS_ON(heap)) {
485*795d594fSAndroid Build Coastguard Worker     VLOG(gc) << "Marked " << count << " references in mod union table";
486*795d594fSAndroid Build Coastguard Worker   }
487*795d594fSAndroid Build Coastguard Worker }
488*795d594fSAndroid Build Coastguard Worker 
ModUnionTableCardCache(const std::string & name,Heap * heap,space::ContinuousSpace * space)489*795d594fSAndroid Build Coastguard Worker ModUnionTableCardCache::ModUnionTableCardCache(const std::string& name,
490*795d594fSAndroid Build Coastguard Worker                                                Heap* heap,
491*795d594fSAndroid Build Coastguard Worker                                                space::ContinuousSpace* space)
492*795d594fSAndroid Build Coastguard Worker     : ModUnionTable(name, heap, space) {
493*795d594fSAndroid Build Coastguard Worker   // Normally here we could use End() instead of Limit(), but for testing we may want to have a
494*795d594fSAndroid Build Coastguard Worker   // mod-union table for a space which can still grow.
495*795d594fSAndroid Build Coastguard Worker   if (!space->IsImageSpace()) {
496*795d594fSAndroid Build Coastguard Worker     CHECK_ALIGNED(reinterpret_cast<uintptr_t>(space->Limit()), CardTable::kCardSize);
497*795d594fSAndroid Build Coastguard Worker   }
498*795d594fSAndroid Build Coastguard Worker   card_bitmap_.reset(CardBitmap::Create(
499*795d594fSAndroid Build Coastguard Worker       "mod union bitmap", reinterpret_cast<uintptr_t>(space->Begin()),
500*795d594fSAndroid Build Coastguard Worker       RoundUp(reinterpret_cast<uintptr_t>(space->Limit()), CardTable::kCardSize)));
501*795d594fSAndroid Build Coastguard Worker }
502*795d594fSAndroid Build Coastguard Worker 
503*795d594fSAndroid Build Coastguard Worker class CardBitVisitor {
504*795d594fSAndroid Build Coastguard Worker  public:
CardBitVisitor(MarkObjectVisitor * visitor,space::ContinuousSpace * space,space::ContinuousSpace * immune_space,ModUnionTable::CardBitmap * card_bitmap)505*795d594fSAndroid Build Coastguard Worker   CardBitVisitor(MarkObjectVisitor* visitor,
506*795d594fSAndroid Build Coastguard Worker                  space::ContinuousSpace* space,
507*795d594fSAndroid Build Coastguard Worker                  space::ContinuousSpace* immune_space,
508*795d594fSAndroid Build Coastguard Worker                  ModUnionTable::CardBitmap* card_bitmap)
509*795d594fSAndroid Build Coastguard Worker       : visitor_(visitor),
510*795d594fSAndroid Build Coastguard Worker         space_(space),
511*795d594fSAndroid Build Coastguard Worker         immune_space_(immune_space),
512*795d594fSAndroid Build Coastguard Worker         bitmap_(space->GetLiveBitmap()),
513*795d594fSAndroid Build Coastguard Worker         card_bitmap_(card_bitmap) {
514*795d594fSAndroid Build Coastguard Worker     DCHECK(immune_space_ != nullptr);
515*795d594fSAndroid Build Coastguard Worker   }
516*795d594fSAndroid Build Coastguard Worker 
operator ()(size_t bit_index) const517*795d594fSAndroid Build Coastguard Worker   void operator()(size_t bit_index) const {
518*795d594fSAndroid Build Coastguard Worker     const uintptr_t start = card_bitmap_->AddrFromBitIndex(bit_index);
519*795d594fSAndroid Build Coastguard Worker     DCHECK(space_->HasAddress(reinterpret_cast<mirror::Object*>(start)))
520*795d594fSAndroid Build Coastguard Worker         << start << " " << *space_;
521*795d594fSAndroid Build Coastguard Worker     bool reference_to_other_space = false;
522*795d594fSAndroid Build Coastguard Worker     ModUnionScanImageRootVisitor scan_visitor(visitor_, space_, immune_space_,
523*795d594fSAndroid Build Coastguard Worker                                               &reference_to_other_space);
524*795d594fSAndroid Build Coastguard Worker     bitmap_->VisitMarkedRange(start, start + CardTable::kCardSize, scan_visitor);
525*795d594fSAndroid Build Coastguard Worker     if (!reference_to_other_space) {
526*795d594fSAndroid Build Coastguard Worker       // No non null reference to another space, clear the bit.
527*795d594fSAndroid Build Coastguard Worker       card_bitmap_->ClearBit(bit_index);
528*795d594fSAndroid Build Coastguard Worker     }
529*795d594fSAndroid Build Coastguard Worker   }
530*795d594fSAndroid Build Coastguard Worker 
531*795d594fSAndroid Build Coastguard Worker  private:
532*795d594fSAndroid Build Coastguard Worker   MarkObjectVisitor* const visitor_;
533*795d594fSAndroid Build Coastguard Worker   space::ContinuousSpace* const space_;
534*795d594fSAndroid Build Coastguard Worker   space::ContinuousSpace* const immune_space_;
535*795d594fSAndroid Build Coastguard Worker   ContinuousSpaceBitmap* const bitmap_;
536*795d594fSAndroid Build Coastguard Worker   ModUnionTable::CardBitmap* const card_bitmap_;
537*795d594fSAndroid Build Coastguard Worker };
538*795d594fSAndroid Build Coastguard Worker 
ProcessCards()539*795d594fSAndroid Build Coastguard Worker void ModUnionTableCardCache::ProcessCards() {
540*795d594fSAndroid Build Coastguard Worker   CardTable* const card_table = GetHeap()->GetCardTable();
541*795d594fSAndroid Build Coastguard Worker   ModUnionAddToCardBitmapVisitor visitor(card_bitmap_.get(), card_table);
542*795d594fSAndroid Build Coastguard Worker   // Clear dirty cards in the this space and update the corresponding mod-union bits.
543*795d594fSAndroid Build Coastguard Worker   card_table->ModifyCardsAtomic(space_->Begin(), space_->End(), AgeCardVisitor(), visitor);
544*795d594fSAndroid Build Coastguard Worker }
545*795d594fSAndroid Build Coastguard Worker 
ClearTable()546*795d594fSAndroid Build Coastguard Worker void ModUnionTableCardCache::ClearTable() {
547*795d594fSAndroid Build Coastguard Worker   card_bitmap_->Bitmap::Clear();
548*795d594fSAndroid Build Coastguard Worker }
549*795d594fSAndroid Build Coastguard Worker 
550*795d594fSAndroid Build Coastguard Worker // Mark all references to the alloc space(s).
UpdateAndMarkReferences(MarkObjectVisitor * visitor)551*795d594fSAndroid Build Coastguard Worker void ModUnionTableCardCache::UpdateAndMarkReferences(MarkObjectVisitor* visitor) {
552*795d594fSAndroid Build Coastguard Worker   // TODO: Needs better support for multi-images? b/26317072
553*795d594fSAndroid Build Coastguard Worker   space::ImageSpace* image_space =
554*795d594fSAndroid Build Coastguard Worker       heap_->GetBootImageSpaces().empty() ? nullptr : heap_->GetBootImageSpaces()[0];
555*795d594fSAndroid Build Coastguard Worker   // If we don't have an image space, just pass in space_ as the immune space. Pass in the same
556*795d594fSAndroid Build Coastguard Worker   // space_ instead of image_space to avoid a null check in ModUnionUpdateObjectReferencesVisitor.
557*795d594fSAndroid Build Coastguard Worker   CardBitVisitor bit_visitor(visitor, space_, image_space != nullptr ? image_space : space_,
558*795d594fSAndroid Build Coastguard Worker       card_bitmap_.get());
559*795d594fSAndroid Build Coastguard Worker   card_bitmap_->VisitSetBits(
560*795d594fSAndroid Build Coastguard Worker       0, RoundUp(space_->Size(), CardTable::kCardSize) / CardTable::kCardSize, bit_visitor);
561*795d594fSAndroid Build Coastguard Worker }
562*795d594fSAndroid Build Coastguard Worker 
VisitObjects(ObjectCallback callback,void * arg)563*795d594fSAndroid Build Coastguard Worker void ModUnionTableCardCache::VisitObjects(ObjectCallback callback, void* arg) {
564*795d594fSAndroid Build Coastguard Worker   card_bitmap_->VisitSetBits(
565*795d594fSAndroid Build Coastguard Worker       0,
566*795d594fSAndroid Build Coastguard Worker       RoundUp(space_->Size(), CardTable::kCardSize) / CardTable::kCardSize,
567*795d594fSAndroid Build Coastguard Worker       [this, callback, arg](size_t bit_index) {
568*795d594fSAndroid Build Coastguard Worker         const uintptr_t start = card_bitmap_->AddrFromBitIndex(bit_index);
569*795d594fSAndroid Build Coastguard Worker         DCHECK(space_->HasAddress(reinterpret_cast<mirror::Object*>(start)))
570*795d594fSAndroid Build Coastguard Worker             << start << " " << *space_;
571*795d594fSAndroid Build Coastguard Worker         space_->GetLiveBitmap()->VisitMarkedRange(start,
572*795d594fSAndroid Build Coastguard Worker                                                   start + CardTable::kCardSize,
573*795d594fSAndroid Build Coastguard Worker                                                   [callback, arg](mirror::Object* obj) {
574*795d594fSAndroid Build Coastguard Worker           callback(obj, arg);
575*795d594fSAndroid Build Coastguard Worker         });
576*795d594fSAndroid Build Coastguard Worker       });
577*795d594fSAndroid Build Coastguard Worker }
578*795d594fSAndroid Build Coastguard Worker 
Dump(std::ostream & os)579*795d594fSAndroid Build Coastguard Worker void ModUnionTableCardCache::Dump(std::ostream& os) {
580*795d594fSAndroid Build Coastguard Worker   os << "ModUnionTable dirty cards: [";
581*795d594fSAndroid Build Coastguard Worker   // TODO: Find cleaner way of doing this.
582*795d594fSAndroid Build Coastguard Worker   for (uint8_t* addr = space_->Begin(); addr < AlignUp(space_->End(), CardTable::kCardSize);
583*795d594fSAndroid Build Coastguard Worker       addr += CardTable::kCardSize) {
584*795d594fSAndroid Build Coastguard Worker     if (card_bitmap_->Test(reinterpret_cast<uintptr_t>(addr))) {
585*795d594fSAndroid Build Coastguard Worker       os << reinterpret_cast<void*>(addr) << "-"
586*795d594fSAndroid Build Coastguard Worker          << reinterpret_cast<void*>(addr + CardTable::kCardSize) << "\n";
587*795d594fSAndroid Build Coastguard Worker     }
588*795d594fSAndroid Build Coastguard Worker   }
589*795d594fSAndroid Build Coastguard Worker   os << "]";
590*795d594fSAndroid Build Coastguard Worker }
591*795d594fSAndroid Build Coastguard Worker 
SetCards()592*795d594fSAndroid Build Coastguard Worker void ModUnionTableCardCache::SetCards() {
593*795d594fSAndroid Build Coastguard Worker   // Only clean up to the end since there cannot be any objects past the End() of the space.
594*795d594fSAndroid Build Coastguard Worker   for (uint8_t* addr = space_->Begin(); addr < AlignUp(space_->End(), CardTable::kCardSize);
595*795d594fSAndroid Build Coastguard Worker        addr += CardTable::kCardSize) {
596*795d594fSAndroid Build Coastguard Worker     card_bitmap_->Set(reinterpret_cast<uintptr_t>(addr));
597*795d594fSAndroid Build Coastguard Worker   }
598*795d594fSAndroid Build Coastguard Worker }
599*795d594fSAndroid Build Coastguard Worker 
ContainsCardFor(uintptr_t addr)600*795d594fSAndroid Build Coastguard Worker bool ModUnionTableCardCache::ContainsCardFor(uintptr_t addr) {
601*795d594fSAndroid Build Coastguard Worker   return card_bitmap_->Test(addr);
602*795d594fSAndroid Build Coastguard Worker }
603*795d594fSAndroid Build Coastguard Worker 
SetCards()604*795d594fSAndroid Build Coastguard Worker void ModUnionTableReferenceCache::SetCards() {
605*795d594fSAndroid Build Coastguard Worker   for (uint8_t* addr = space_->Begin(); addr < AlignUp(space_->End(), CardTable::kCardSize);
606*795d594fSAndroid Build Coastguard Worker        addr += CardTable::kCardSize) {
607*795d594fSAndroid Build Coastguard Worker     cleared_cards_.insert(heap_->GetCardTable()->CardFromAddr(reinterpret_cast<void*>(addr)));
608*795d594fSAndroid Build Coastguard Worker   }
609*795d594fSAndroid Build Coastguard Worker }
610*795d594fSAndroid Build Coastguard Worker 
ContainsCardFor(uintptr_t addr)611*795d594fSAndroid Build Coastguard Worker bool ModUnionTableReferenceCache::ContainsCardFor(uintptr_t addr) {
612*795d594fSAndroid Build Coastguard Worker   auto* card_ptr = heap_->GetCardTable()->CardFromAddr(reinterpret_cast<void*>(addr));
613*795d594fSAndroid Build Coastguard Worker   return cleared_cards_.find(card_ptr) != cleared_cards_.end() ||
614*795d594fSAndroid Build Coastguard Worker       references_.find(card_ptr) != references_.end();
615*795d594fSAndroid Build Coastguard Worker }
616*795d594fSAndroid Build Coastguard Worker 
617*795d594fSAndroid Build Coastguard Worker }  // namespace accounting
618*795d594fSAndroid Build Coastguard Worker }  // namespace gc
619*795d594fSAndroid Build Coastguard Worker }  // namespace art
620