Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 1 | /* |
Elliott Hughes | 2faa5f1 | 2012-01-30 14:42:07 -0800 | [diff] [blame] | 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. |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 15 | */ |
| 16 | |
Mathieu Chartier | 7469ebf | 2012-09-24 16:28:36 -0700 | [diff] [blame] | 17 | #ifndef ART_SRC_GC_CARDTABLE_H_ |
| 18 | #define ART_SRC_GC_CARDTABLE_H_ |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 19 | |
| 20 | #include "globals.h" |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 21 | #include "locks.h" |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 22 | #include "mem_map.h" |
| 23 | #include "UniquePtr.h" |
| 24 | |
| 25 | namespace art { |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 26 | namespace mirror { |
| 27 | class Object; |
| 28 | } // namespace mirror |
Mathieu Chartier | 262e5ff | 2012-06-01 17:35:38 -0700 | [diff] [blame] | 29 | class Heap; |
Mathieu Chartier | 2fde533 | 2012-09-14 14:51:54 -0700 | [diff] [blame] | 30 | class ContinuousSpace; |
Mathieu Chartier | b062fdd | 2012-07-03 09:51:48 -0700 | [diff] [blame] | 31 | class SpaceBitmap; |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 32 | |
Elliott Hughes | 2faa5f1 | 2012-01-30 14:42:07 -0800 | [diff] [blame] | 33 | // Maintain a card table from the the write barrier. All writes of |
| 34 | // non-NULL values to heap addresses should go through an entry in |
| 35 | // WriteBarrier, and from there to here. |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 36 | class CardTable { |
| 37 | public: |
Mathieu Chartier | 7469ebf | 2012-09-24 16:28:36 -0700 | [diff] [blame] | 38 | static const size_t kCardShift = 7; |
| 39 | static const size_t kCardSize = (1 << kCardShift); |
| 40 | static const uint8_t kCardClean = 0x0; |
| 41 | static const uint8_t kCardDirty = 0x70; |
| 42 | |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 43 | static CardTable* Create(const byte* heap_begin, size_t heap_capacity); |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 44 | |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 45 | // Set the card associated with the given address to GC_CARD_DIRTY. |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 46 | void MarkCard(const void *addr) { |
Elliott Hughes | 24edeb5 | 2012-06-18 15:29:46 -0700 | [diff] [blame] | 47 | byte* card_addr = CardFromAddr(addr); |
Mathieu Chartier | 7469ebf | 2012-09-24 16:28:36 -0700 | [diff] [blame] | 48 | *card_addr = kCardDirty; |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 49 | } |
| 50 | |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 51 | // Is the object on a dirty card? |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 52 | bool IsDirty(const mirror::Object* obj) const { |
Mathieu Chartier | 4da7f2f | 2012-11-13 12:51:01 -0800 | [diff] [blame] | 53 | return GetCard(obj) == kCardDirty; |
| 54 | } |
| 55 | |
| 56 | // Return the state of the card at an address. |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 57 | byte GetCard(const mirror::Object* obj) const { |
Mathieu Chartier | 4da7f2f | 2012-11-13 12:51:01 -0800 | [diff] [blame] | 58 | return *CardFromAddr(obj); |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 59 | } |
| 60 | |
Mathieu Chartier | 7469ebf | 2012-09-24 16:28:36 -0700 | [diff] [blame] | 61 | // Visit and clear cards within memory range, only visits dirty cards. |
Mathieu Chartier | b43b7d4 | 2012-06-19 13:15:09 -0700 | [diff] [blame] | 62 | template <typename Visitor> |
| 63 | void VisitClear(const void* start, const void* end, const Visitor& visitor) { |
| 64 | byte* card_start = CardFromAddr(start); |
| 65 | byte* card_end = CardFromAddr(end); |
Mathieu Chartier | 7469ebf | 2012-09-24 16:28:36 -0700 | [diff] [blame] | 66 | for (byte* it = card_start; it != card_end; ++it) { |
| 67 | if (*it == kCardDirty) { |
| 68 | *it = kCardClean; |
| 69 | visitor(it); |
Mathieu Chartier | b43b7d4 | 2012-06-19 13:15:09 -0700 | [diff] [blame] | 70 | } |
| 71 | } |
| 72 | } |
| 73 | |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 74 | // Returns a value that when added to a heap address >> GC_CARD_SHIFT will address the appropriate |
| 75 | // card table byte. For convenience this value is cached in every Thread |
| 76 | byte* GetBiasedBegin() const { |
| 77 | return biased_begin_; |
jeffhao | 39da035 | 2011-11-04 14:58:55 -0700 | [diff] [blame] | 78 | } |
| 79 | |
Mathieu Chartier | d22d548 | 2012-11-06 17:14:12 -0800 | [diff] [blame] | 80 | /* |
| 81 | * Visitor is expected to take in a card and return the new value. When a value is modified, the |
| 82 | * modify visitor is called. |
| 83 | * visitor: The visitor which modifies the cards. Returns the new value for a card given an old |
| 84 | * value. |
| 85 | * modified: Whenever the visitor modifies a card, this visitor is called on the card. Enables |
| 86 | * us to know which cards got cleared. |
| 87 | */ |
| 88 | template <typename Visitor, typename ModifiedVisitor> |
| 89 | void ModifyCardsAtomic(byte* scan_begin, byte* scan_end, const Visitor& visitor, |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 90 | const ModifiedVisitor& modified); |
Mathieu Chartier | d22d548 | 2012-11-06 17:14:12 -0800 | [diff] [blame] | 91 | |
| 92 | // For every dirty at least minumum age between begin and end invoke the visitor with the |
| 93 | // specified argument. |
Mathieu Chartier | 357e9be | 2012-08-01 11:00:14 -0700 | [diff] [blame] | 94 | template <typename Visitor, typename FingerVisitor> |
| 95 | void Scan(SpaceBitmap* bitmap, byte* scan_begin, byte* scan_end, |
Mathieu Chartier | d22d548 | 2012-11-06 17:14:12 -0800 | [diff] [blame] | 96 | const Visitor& visitor, const FingerVisitor& finger_visitor, |
| 97 | const byte minimum_age = kCardDirty) const |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 98 | EXCLUSIVE_LOCKS_REQUIRED(Locks::heap_bitmap_lock_) |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 99 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 100 | |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 101 | // Assertion used to check the given address is covered by the card table |
| 102 | void CheckAddrIsInCardTable(const byte* addr) const; |
| 103 | |
Mathieu Chartier | 262e5ff | 2012-06-01 17:35:38 -0700 | [diff] [blame] | 104 | // Resets all of the bytes in the card table to clean. |
| 105 | void ClearCardTable(); |
| 106 | |
Mathieu Chartier | b43b7d4 | 2012-06-19 13:15:09 -0700 | [diff] [blame] | 107 | // Resets all of the bytes in the card table which do not map to the image space. |
Mathieu Chartier | 2fde533 | 2012-09-14 14:51:54 -0700 | [diff] [blame] | 108 | void ClearSpaceCards(ContinuousSpace* space); |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 109 | |
Mathieu Chartier | b43b7d4 | 2012-06-19 13:15:09 -0700 | [diff] [blame] | 110 | // Returns the first address in the heap which maps to this card. |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 111 | void* AddrFromCard(const byte *card_addr) const; |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 112 | |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 113 | // Returns the address of the relevant byte in the card table, given an address on the heap. |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 114 | byte* CardFromAddr(const void *addr) const; |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 115 | |
Mathieu Chartier | 7469ebf | 2012-09-24 16:28:36 -0700 | [diff] [blame] | 116 | bool AddrIsInCardTable(const void* addr) const; |
| 117 | |
Mathieu Chartier | cc236d7 | 2012-07-20 10:29:05 -0700 | [diff] [blame] | 118 | private: |
| 119 | CardTable(MemMap* begin, byte* biased_begin, size_t offset); |
| 120 | |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 121 | // Returns true iff the card table address is within the bounds of the card table. |
Elliott Hughes | 24edeb5 | 2012-06-18 15:29:46 -0700 | [diff] [blame] | 122 | bool IsValidCard(const byte* card_addr) const { |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 123 | byte* begin = mem_map_->Begin() + offset_; |
| 124 | byte* end = mem_map_->End(); |
Elliott Hughes | 24edeb5 | 2012-06-18 15:29:46 -0700 | [diff] [blame] | 125 | return card_addr >= begin && card_addr < end; |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 126 | } |
| 127 | |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 128 | void CheckCardValid(byte* card) const; |
Mathieu Chartier | d22d548 | 2012-11-06 17:14:12 -0800 | [diff] [blame] | 129 | |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 130 | // Verifies that all gray objects are on a dirty card. |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 131 | void VerifyCardTable(); |
| 132 | |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 133 | // Mmapped pages for the card table |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 134 | UniquePtr<MemMap> mem_map_; |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 135 | // Value used to compute card table addresses from object addresses, see GetBiasedBegin |
| 136 | byte* const biased_begin_; |
| 137 | // Card table doesn't begin at the beginning of the mem_map_, instead it is displaced by offset |
| 138 | // to allow the byte value of biased_begin_ to equal GC_CARD_DIRTY |
| 139 | const size_t offset_; |
Ian Rogers | 5d76c43 | 2011-10-31 21:42:49 -0700 | [diff] [blame] | 140 | }; |
| 141 | |
| 142 | } // namespace art |
Mathieu Chartier | 858f1c5 | 2012-10-17 17:45:55 -0700 | [diff] [blame] | 143 | #endif // ART_SRC_GC_CARDTABLE_H_ |