remembered_set.h revision 5369c40f75fdcb1be7a7c06db212ce965c83a164 
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 "globals.h"
22#include "object_callbacks.h"
23#include "safe_map.h"
24
25#include <set>
26#include <vector>
27
28namespace art {
29namespace gc {
30
31namespace collector {
32  class MarkSweep;
33}  // namespace collector
34namespace space {
35  class ContinuousSpace;
36}  // namespace space
37
38class Heap;
39
40namespace accounting {
41
42// The remembered set keeps track of cards that may contain references
43// from the free list spaces to the bump pointer spaces.
44class RememberedSet {
45 public:
46  typedef std::set<byte*, std::less<byte*>,
47                   TrackingAllocator<byte*, kAllocatorTagRememberedSet>> CardSet;
48
49  explicit RememberedSet(const std::string& name, Heap* heap, space::ContinuousSpace* space)
50      : name_(name), heap_(heap), space_(space) {}
51
52  // Clear dirty cards and add them to the dirty card set.
53  void ClearCards();
54
55  // Mark through all references to the target space.
56  void UpdateAndMarkReferences(MarkHeapReferenceCallback* callback,
57                               DelayReferenceReferentCallback* ref_callback,
58                               space::ContinuousSpace* target_space, void* arg)
59      EXCLUSIVE_LOCKS_REQUIRED(Locks::heap_bitmap_lock_)
60      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
61
62  void Dump(std::ostream& os);
63
64  space::ContinuousSpace* GetSpace() {
65    return space_;
66  }
67  Heap* GetHeap() const {
68    return heap_;
69  }
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