Hiroshi Yamauchi | 624468c | 2014-03-31 15:14:47 -0700 | [diff] [blame] | 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_READ_BARRIER_H_ |
| 18 | #define ART_RUNTIME_READ_BARRIER_H_ |
| 19 | |
Hiroshi Yamauchi | 800ac2d | 2014-04-02 17:32:54 -0700 | [diff] [blame] | 20 | #include "base/mutex.h" |
| 21 | #include "base/macros.h" |
Hiroshi Yamauchi | 3f64f25 | 2015-06-12 18:35:06 -0700 | [diff] [blame] | 22 | #include "gc_root.h" |
Hiroshi Yamauchi | 2cd334a | 2015-01-09 14:03:35 -0800 | [diff] [blame] | 23 | #include "jni.h" |
Mathieu Chartier | bb87e0f | 2015-04-03 11:21:55 -0700 | [diff] [blame] | 24 | #include "mirror/object_reference.h" |
Hiroshi Yamauchi | 800ac2d | 2014-04-02 17:32:54 -0700 | [diff] [blame] | 25 | #include "offsets.h" |
| 26 | #include "read_barrier_c.h" |
Hiroshi Yamauchi | 624468c | 2014-03-31 15:14:47 -0700 | [diff] [blame] | 27 | |
Hiroshi Yamauchi | 800ac2d | 2014-04-02 17:32:54 -0700 | [diff] [blame] | 28 | // This is a C++ (not C) header file, separate from read_barrier_c.h |
| 29 | // which needs to be a C header file for asm_support.h. |
Hiroshi Yamauchi | 624468c | 2014-03-31 15:14:47 -0700 | [diff] [blame] | 30 | |
Hiroshi Yamauchi | 800ac2d | 2014-04-02 17:32:54 -0700 | [diff] [blame] | 31 | namespace art { |
| 32 | namespace mirror { |
| 33 | class Object; |
| 34 | template<typename MirrorType> class HeapReference; |
| 35 | } // namespace mirror |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 36 | class ArtMethod; |
Hiroshi Yamauchi | 624468c | 2014-03-31 15:14:47 -0700 | [diff] [blame] | 37 | |
Hiroshi Yamauchi | 800ac2d | 2014-04-02 17:32:54 -0700 | [diff] [blame] | 38 | class ReadBarrier { |
| 39 | public: |
Hiroshi Yamauchi | 2cd334a | 2015-01-09 14:03:35 -0800 | [diff] [blame] | 40 | // TODO: disable thse flags for production use. |
| 41 | // Enable the to-space invariant checks. |
| 42 | static constexpr bool kEnableToSpaceInvariantChecks = true; |
| 43 | // Enable the read barrier checks. |
| 44 | static constexpr bool kEnableReadBarrierInvariantChecks = true; |
| 45 | |
Hiroshi Yamauchi | ea2e1bd | 2014-06-18 13:47:35 -0700 | [diff] [blame] | 46 | // It's up to the implementation whether the given field gets |
| 47 | // updated whereas the return value must be an updated reference. |
Hiroshi Yamauchi | 2cd334a | 2015-01-09 14:03:35 -0800 | [diff] [blame] | 48 | template <typename MirrorType, ReadBarrierOption kReadBarrierOption = kWithReadBarrier, |
| 49 | bool kMaybeDuringStartup = false> |
Hiroshi Yamauchi | 800ac2d | 2014-04-02 17:32:54 -0700 | [diff] [blame] | 50 | ALWAYS_INLINE static MirrorType* Barrier( |
| 51 | mirror::Object* obj, MemberOffset offset, mirror::HeapReference<MirrorType>* ref_addr) |
| 52 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Hiroshi Yamauchi | 4cba0d9 | 2014-05-21 21:10:23 -0700 | [diff] [blame] | 53 | |
Hiroshi Yamauchi | ea2e1bd | 2014-06-18 13:47:35 -0700 | [diff] [blame] | 54 | // It's up to the implementation whether the given root gets updated |
| 55 | // whereas the return value must be an updated reference. |
Hiroshi Yamauchi | 2cd334a | 2015-01-09 14:03:35 -0800 | [diff] [blame] | 56 | template <typename MirrorType, ReadBarrierOption kReadBarrierOption = kWithReadBarrier, |
| 57 | bool kMaybeDuringStartup = false> |
Hiroshi Yamauchi | 3f64f25 | 2015-06-12 18:35:06 -0700 | [diff] [blame] | 58 | ALWAYS_INLINE static MirrorType* BarrierForRoot(MirrorType** root, |
| 59 | GcRootSource* gc_root_source = nullptr) |
Hiroshi Yamauchi | 4cba0d9 | 2014-05-21 21:10:23 -0700 | [diff] [blame] | 60 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Hiroshi Yamauchi | 2cd334a | 2015-01-09 14:03:35 -0800 | [diff] [blame] | 61 | |
Mathieu Chartier | bb87e0f | 2015-04-03 11:21:55 -0700 | [diff] [blame] | 62 | // It's up to the implementation whether the given root gets updated |
| 63 | // whereas the return value must be an updated reference. |
| 64 | template <typename MirrorType, ReadBarrierOption kReadBarrierOption = kWithReadBarrier, |
| 65 | bool kMaybeDuringStartup = false> |
Hiroshi Yamauchi | 3f64f25 | 2015-06-12 18:35:06 -0700 | [diff] [blame] | 66 | ALWAYS_INLINE static MirrorType* BarrierForRoot(mirror::CompressedReference<MirrorType>* root, |
| 67 | GcRootSource* gc_root_source = nullptr) |
Mathieu Chartier | bb87e0f | 2015-04-03 11:21:55 -0700 | [diff] [blame] | 68 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 69 | |
Hiroshi Yamauchi | 2cd334a | 2015-01-09 14:03:35 -0800 | [diff] [blame] | 70 | static bool IsDuringStartup(); |
| 71 | |
| 72 | // Without the holder object. |
| 73 | static void AssertToSpaceInvariant(mirror::Object* ref) |
| 74 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { |
| 75 | AssertToSpaceInvariant(nullptr, MemberOffset(0), ref); |
| 76 | } |
| 77 | // With the holder object. |
| 78 | static void AssertToSpaceInvariant(mirror::Object* obj, MemberOffset offset, |
| 79 | mirror::Object* ref) |
| 80 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Hiroshi Yamauchi | 3f64f25 | 2015-06-12 18:35:06 -0700 | [diff] [blame] | 81 | // With GcRootSource. |
| 82 | static void AssertToSpaceInvariant(GcRootSource* gc_root_source, mirror::Object* ref) |
| 83 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Hiroshi Yamauchi | 2cd334a | 2015-01-09 14:03:35 -0800 | [diff] [blame] | 84 | |
| 85 | static mirror::Object* Mark(mirror::Object* obj) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 86 | |
| 87 | static mirror::Object* WhitePtr() { |
| 88 | return reinterpret_cast<mirror::Object*>(white_ptr_); |
| 89 | } |
| 90 | static mirror::Object* GrayPtr() { |
| 91 | return reinterpret_cast<mirror::Object*>(gray_ptr_); |
| 92 | } |
| 93 | static mirror::Object* BlackPtr() { |
| 94 | return reinterpret_cast<mirror::Object*>(black_ptr_); |
| 95 | } |
| 96 | |
| 97 | ALWAYS_INLINE static bool HasGrayReadBarrierPointer(mirror::Object* obj, |
| 98 | uintptr_t* out_rb_ptr_high_bits) |
| 99 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 100 | |
| 101 | // Note: These couldn't be constexpr pointers as reinterpret_cast isn't compatible with them. |
| 102 | static constexpr uintptr_t white_ptr_ = 0x0; // Not marked. |
| 103 | static constexpr uintptr_t gray_ptr_ = 0x1; // Marked, but not marked through. On mark stack. |
| 104 | static constexpr uintptr_t black_ptr_ = 0x2; // Marked through. Used for non-moving objects. |
| 105 | static constexpr uintptr_t rb_ptr_mask_ = 0x3; // The low 2 bits for white|gray|black. |
Hiroshi Yamauchi | 800ac2d | 2014-04-02 17:32:54 -0700 | [diff] [blame] | 106 | }; |
Hiroshi Yamauchi | 624468c | 2014-03-31 15:14:47 -0700 | [diff] [blame] | 107 | |
Hiroshi Yamauchi | 800ac2d | 2014-04-02 17:32:54 -0700 | [diff] [blame] | 108 | } // namespace art |
Hiroshi Yamauchi | 624468c | 2014-03-31 15:14:47 -0700 | [diff] [blame] | 109 | |
| 110 | #endif // ART_RUNTIME_READ_BARRIER_H_ |