Mathieu Chartier | 78f7b4c | 2014-05-06 10:57:27 -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_GC_REFERENCE_PROCESSOR_H_ |
| 18 | #define ART_RUNTIME_GC_REFERENCE_PROCESSOR_H_ |
| 19 | |
| 20 | #include "base/mutex.h" |
| 21 | #include "globals.h" |
| 22 | #include "jni.h" |
| 23 | #include "object_callbacks.h" |
| 24 | #include "reference_queue.h" |
| 25 | |
| 26 | namespace art { |
| 27 | |
| 28 | class TimingLogger; |
| 29 | |
| 30 | namespace mirror { |
Mathieu Chartier | a5a53ef | 2014-09-12 12:58:05 -0700 | [diff] [blame] | 31 | class FinalizerReference; |
Mathieu Chartier | 78f7b4c | 2014-05-06 10:57:27 -0700 | [diff] [blame] | 32 | class Object; |
| 33 | class Reference; |
| 34 | } // namespace mirror |
| 35 | |
| 36 | namespace gc { |
| 37 | |
| 38 | class Heap; |
| 39 | |
| 40 | // Used to process java.lang.References concurrently or paused. |
| 41 | class ReferenceProcessor { |
| 42 | public: |
| 43 | explicit ReferenceProcessor(); |
Mathieu Chartier | 308351a | 2014-06-15 12:39:02 -0700 | [diff] [blame] | 44 | static bool PreserveSoftReferenceCallback(mirror::HeapReference<mirror::Object>* obj, void* arg) |
| 45 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Mathieu Chartier | 78f7b4c | 2014-05-06 10:57:27 -0700 | [diff] [blame] | 46 | void ProcessReferences(bool concurrent, TimingLogger* timings, bool clear_soft_references, |
Mathieu Chartier | 308351a | 2014-06-15 12:39:02 -0700 | [diff] [blame] | 47 | IsHeapReferenceMarkedCallback* is_marked_callback, |
Mathieu Chartier | 78f7b4c | 2014-05-06 10:57:27 -0700 | [diff] [blame] | 48 | MarkObjectCallback* mark_object_callback, |
| 49 | ProcessMarkStackCallback* process_mark_stack_callback, void* arg) |
| 50 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 51 | EXCLUSIVE_LOCKS_REQUIRED(Locks::heap_bitmap_lock_) |
Mathieu Chartier | a5a53ef | 2014-09-12 12:58:05 -0700 | [diff] [blame] | 52 | LOCKS_EXCLUDED(Locks::reference_processor_lock_); |
Fred Shih | 4ee7a66 | 2014-07-11 09:59:27 -0700 | [diff] [blame] | 53 | // The slow path bool is contained in the reference class object, can only be set once |
Mathieu Chartier | 78f7b4c | 2014-05-06 10:57:27 -0700 | [diff] [blame] | 54 | // Only allow setting this with mutators suspended so that we can avoid using a lock in the |
| 55 | // GetReferent fast path as an optimization. |
| 56 | void EnableSlowPath() EXCLUSIVE_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 57 | // Decode the referent, may block if references are being processed. |
| 58 | mirror::Object* GetReferent(Thread* self, mirror::Reference* reference) |
Mathieu Chartier | a5a53ef | 2014-09-12 12:58:05 -0700 | [diff] [blame] | 59 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) LOCKS_EXCLUDED(Locks::reference_processor_lock_); |
Mathieu Chartier | 308351a | 2014-06-15 12:39:02 -0700 | [diff] [blame] | 60 | void EnqueueClearedReferences(Thread* self) LOCKS_EXCLUDED(Locks::mutator_lock_); |
Mathieu Chartier | 78f7b4c | 2014-05-06 10:57:27 -0700 | [diff] [blame] | 61 | void DelayReferenceReferent(mirror::Class* klass, mirror::Reference* ref, |
Mathieu Chartier | 308351a | 2014-06-15 12:39:02 -0700 | [diff] [blame] | 62 | IsHeapReferenceMarkedCallback* is_marked_callback, void* arg) |
Mathieu Chartier | 78f7b4c | 2014-05-06 10:57:27 -0700 | [diff] [blame] | 63 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Mathieu Chartier | 52e4b43 | 2014-06-10 11:22:31 -0700 | [diff] [blame] | 64 | void UpdateRoots(IsMarkedCallback* callback, void* arg) |
Fred Shih | 4ee7a66 | 2014-07-11 09:59:27 -0700 | [diff] [blame] | 65 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_, Locks::heap_bitmap_lock_); |
Mathieu Chartier | a5a53ef | 2014-09-12 12:58:05 -0700 | [diff] [blame] | 66 | // Make a circular list with reference if it is not enqueued. Uses the finalizer queue lock. |
| 67 | bool MakeCircularListIfUnenqueued(mirror::FinalizerReference* reference) |
| 68 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) |
| 69 | LOCKS_EXCLUDED(Locks::reference_processor_lock_, |
| 70 | Locks::reference_queue_finalizer_references_lock_); |
Mathieu Chartier | 78f7b4c | 2014-05-06 10:57:27 -0700 | [diff] [blame] | 71 | |
| 72 | private: |
| 73 | class ProcessReferencesArgs { |
| 74 | public: |
Mathieu Chartier | 308351a | 2014-06-15 12:39:02 -0700 | [diff] [blame] | 75 | ProcessReferencesArgs(IsHeapReferenceMarkedCallback* is_marked_callback, |
Mathieu Chartier | 78f7b4c | 2014-05-06 10:57:27 -0700 | [diff] [blame] | 76 | MarkObjectCallback* mark_callback, void* arg) |
| 77 | : is_marked_callback_(is_marked_callback), mark_callback_(mark_callback), arg_(arg) { |
| 78 | } |
| 79 | |
| 80 | // The is marked callback is null when the args aren't set up. |
Mathieu Chartier | 308351a | 2014-06-15 12:39:02 -0700 | [diff] [blame] | 81 | IsHeapReferenceMarkedCallback* is_marked_callback_; |
Mathieu Chartier | 78f7b4c | 2014-05-06 10:57:27 -0700 | [diff] [blame] | 82 | MarkObjectCallback* mark_callback_; |
| 83 | void* arg_; |
| 84 | }; |
Fred Shih | 4ee7a66 | 2014-07-11 09:59:27 -0700 | [diff] [blame] | 85 | bool SlowPathEnabled() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Mathieu Chartier | 78f7b4c | 2014-05-06 10:57:27 -0700 | [diff] [blame] | 86 | // Called by ProcessReferences. |
Mathieu Chartier | a5a53ef | 2014-09-12 12:58:05 -0700 | [diff] [blame] | 87 | void DisableSlowPath(Thread* self) EXCLUSIVE_LOCKS_REQUIRED(Locks::reference_processor_lock_) |
Fred Shih | 4ee7a66 | 2014-07-11 09:59:27 -0700 | [diff] [blame] | 88 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Mathieu Chartier | 78f7b4c | 2014-05-06 10:57:27 -0700 | [diff] [blame] | 89 | // If we are preserving references it means that some dead objects may become live, we use start |
| 90 | // and stop preserving to block mutators using GetReferrent from getting access to these |
| 91 | // referents. |
Mathieu Chartier | a5a53ef | 2014-09-12 12:58:05 -0700 | [diff] [blame] | 92 | void StartPreservingReferences(Thread* self) LOCKS_EXCLUDED(Locks::reference_processor_lock_); |
| 93 | void StopPreservingReferences(Thread* self) LOCKS_EXCLUDED(Locks::reference_processor_lock_); |
Mathieu Chartier | 78f7b4c | 2014-05-06 10:57:27 -0700 | [diff] [blame] | 94 | // Process args, used by the GetReferent to return referents which are already marked. |
Mathieu Chartier | a5a53ef | 2014-09-12 12:58:05 -0700 | [diff] [blame] | 95 | ProcessReferencesArgs process_references_args_ GUARDED_BY(Locks::reference_processor_lock_); |
Mathieu Chartier | 78f7b4c | 2014-05-06 10:57:27 -0700 | [diff] [blame] | 96 | // Boolean for whether or not we are preserving references (either soft references or finalizers). |
| 97 | // If this is true, then we cannot return a referent (see comment in GetReferent). |
Mathieu Chartier | a5a53ef | 2014-09-12 12:58:05 -0700 | [diff] [blame] | 98 | bool preserving_references_ GUARDED_BY(Locks::reference_processor_lock_); |
Mathieu Chartier | 78f7b4c | 2014-05-06 10:57:27 -0700 | [diff] [blame] | 99 | // Condition that people wait on if they attempt to get the referent of a reference while |
| 100 | // processing is in progress. |
Mathieu Chartier | a5a53ef | 2014-09-12 12:58:05 -0700 | [diff] [blame] | 101 | ConditionVariable condition_ GUARDED_BY(Locks::reference_processor_lock_); |
Mathieu Chartier | 78f7b4c | 2014-05-06 10:57:27 -0700 | [diff] [blame] | 102 | // Reference queues used by the GC. |
| 103 | ReferenceQueue soft_reference_queue_; |
| 104 | ReferenceQueue weak_reference_queue_; |
| 105 | ReferenceQueue finalizer_reference_queue_; |
| 106 | ReferenceQueue phantom_reference_queue_; |
| 107 | ReferenceQueue cleared_references_; |
| 108 | }; |
| 109 | |
| 110 | } // namespace gc |
| 111 | } // namespace art |
| 112 | |
| 113 | #endif // ART_RUNTIME_GC_REFERENCE_PROCESSOR_H_ |