blob: e7ad7316bd445837aca792b081cd3d01c7d83e18 [file] [log] [blame]
Hiroshi Yamauchi624468c2014-03-31 15:14:47 -07001/*
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 Yamauchi800ac2d2014-04-02 17:32:54 -070020#include "base/mutex.h"
21#include "base/macros.h"
Hiroshi Yamauchi3f64f252015-06-12 18:35:06 -070022#include "gc_root.h"
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -080023#include "jni.h"
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -070024#include "mirror/object_reference.h"
Hiroshi Yamauchi800ac2d2014-04-02 17:32:54 -070025#include "offsets.h"
26#include "read_barrier_c.h"
Hiroshi Yamauchi624468c2014-03-31 15:14:47 -070027
Hiroshi Yamauchi800ac2d2014-04-02 17:32:54 -070028// 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 Yamauchi624468c2014-03-31 15:14:47 -070030
Hiroshi Yamauchi800ac2d2014-04-02 17:32:54 -070031namespace art {
32namespace mirror {
33 class Object;
34 template<typename MirrorType> class HeapReference;
35} // namespace mirror
Mathieu Chartiere401d142015-04-22 13:56:20 -070036class ArtMethod;
Hiroshi Yamauchi624468c2014-03-31 15:14:47 -070037
Hiroshi Yamauchi800ac2d2014-04-02 17:32:54 -070038class ReadBarrier {
39 public:
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -080040 // 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 Yamauchiea2e1bd2014-06-18 13:47:35 -070046 // It's up to the implementation whether the given field gets
47 // updated whereas the return value must be an updated reference.
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -080048 template <typename MirrorType, ReadBarrierOption kReadBarrierOption = kWithReadBarrier,
49 bool kMaybeDuringStartup = false>
Hiroshi Yamauchi800ac2d2014-04-02 17:32:54 -070050 ALWAYS_INLINE static MirrorType* Barrier(
51 mirror::Object* obj, MemberOffset offset, mirror::HeapReference<MirrorType>* ref_addr)
Mathieu Chartier90443472015-07-16 20:32:27 -070052 SHARED_REQUIRES(Locks::mutator_lock_);
Hiroshi Yamauchi4cba0d92014-05-21 21:10:23 -070053
Hiroshi Yamauchiea2e1bd2014-06-18 13:47:35 -070054 // It's up to the implementation whether the given root gets updated
55 // whereas the return value must be an updated reference.
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -080056 template <typename MirrorType, ReadBarrierOption kReadBarrierOption = kWithReadBarrier,
57 bool kMaybeDuringStartup = false>
Hiroshi Yamauchi3f64f252015-06-12 18:35:06 -070058 ALWAYS_INLINE static MirrorType* BarrierForRoot(MirrorType** root,
59 GcRootSource* gc_root_source = nullptr)
Mathieu Chartier90443472015-07-16 20:32:27 -070060 SHARED_REQUIRES(Locks::mutator_lock_);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -080061
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -070062 // 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 Yamauchi3f64f252015-06-12 18:35:06 -070066 ALWAYS_INLINE static MirrorType* BarrierForRoot(mirror::CompressedReference<MirrorType>* root,
67 GcRootSource* gc_root_source = nullptr)
Mathieu Chartier90443472015-07-16 20:32:27 -070068 SHARED_REQUIRES(Locks::mutator_lock_);
Mathieu Chartierbb87e0f2015-04-03 11:21:55 -070069
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -080070 static bool IsDuringStartup();
71
72 // Without the holder object.
73 static void AssertToSpaceInvariant(mirror::Object* ref)
Mathieu Chartier90443472015-07-16 20:32:27 -070074 SHARED_REQUIRES(Locks::mutator_lock_) {
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -080075 AssertToSpaceInvariant(nullptr, MemberOffset(0), ref);
76 }
77 // With the holder object.
78 static void AssertToSpaceInvariant(mirror::Object* obj, MemberOffset offset,
79 mirror::Object* ref)
Mathieu Chartier90443472015-07-16 20:32:27 -070080 SHARED_REQUIRES(Locks::mutator_lock_);
Hiroshi Yamauchi3f64f252015-06-12 18:35:06 -070081 // With GcRootSource.
82 static void AssertToSpaceInvariant(GcRootSource* gc_root_source, mirror::Object* ref)
Mathieu Chartier90443472015-07-16 20:32:27 -070083 SHARED_REQUIRES(Locks::mutator_lock_);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -080084
Mathieu Chartier90443472015-07-16 20:32:27 -070085 static mirror::Object* Mark(mirror::Object* obj) SHARED_REQUIRES(Locks::mutator_lock_);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -080086
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)
Mathieu Chartier90443472015-07-16 20:32:27 -070099 SHARED_REQUIRES(Locks::mutator_lock_);
Hiroshi Yamauchi2cd334a2015-01-09 14:03:35 -0800100
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 Yamauchi800ac2d2014-04-02 17:32:54 -0700106};
Hiroshi Yamauchi624468c2014-03-31 15:14:47 -0700107
Hiroshi Yamauchi800ac2d2014-04-02 17:32:54 -0700108} // namespace art
Hiroshi Yamauchi624468c2014-03-31 15:14:47 -0700109
110#endif // ART_RUNTIME_READ_BARRIER_H_