1 /*
2  * Copyright (C) 2014 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_ACCOUNTING_REMEMBERED_SET_H_
18 #define ART_RUNTIME_GC_ACCOUNTING_REMEMBERED_SET_H_
19 
20 #include "base/allocator.h"
21 #include "base/locks.h"
22 #include "base/safe_map.h"
23 #include "runtime_globals.h"
24 
25 #include <set>
26 #include <vector>
27 
28 namespace art {
29 namespace gc {
30 
31 namespace collector {
32 class GarbageCollector;
33 class MarkSweep;
34 }  // namespace collector
35 namespace space {
36 class ContinuousSpace;
37 }  // namespace space
38 
39 class Heap;
40 
41 namespace accounting {
42 
43 // The remembered set keeps track of cards that may contain references
44 // from the free list spaces to the bump pointer spaces.
45 class RememberedSet {
46  public:
47   typedef std::set<uint8_t*, std::less<uint8_t*>,
48                    TrackingAllocator<uint8_t*, kAllocatorTagRememberedSet>> CardSet;
49 
RememberedSet(const std::string & name,Heap * heap,space::ContinuousSpace * space)50   explicit RememberedSet(const std::string& name, Heap* heap, space::ContinuousSpace* space)
51       : name_(name), heap_(heap), space_(space) {}
52 
53   // Clear dirty cards and add them to the dirty card set.
54   void ClearCards();
55 
56   // Mark through all references to the target space.
57   void UpdateAndMarkReferences(space::ContinuousSpace* target_space,
58                                collector::GarbageCollector* collector)
59       REQUIRES(Locks::heap_bitmap_lock_)
60       REQUIRES_SHARED(Locks::mutator_lock_);
61 
62   void Dump(std::ostream& os);
63 
GetSpace()64   space::ContinuousSpace* GetSpace() {
65     return space_;
66   }
GetHeap()67   Heap* GetHeap() const {
68     return heap_;
69   }
GetName()70   const std::string& GetName() const {
71     return name_;
72   }
73   void AssertAllDirtyCardsAreWithinSpace() const;
74 
75  private:
76   const std::string name_;
77   Heap* const heap_;
78   space::ContinuousSpace* const space_;
79 
80   CardSet dirty_cards_;
81 };
82 
83 }  // namespace accounting
84 }  // namespace gc
85 }  // namespace art
86 
87 #endif  // ART_RUNTIME_GC_ACCOUNTING_REMEMBERED_SET_H_
88