blob: d700cf2d537f45c78d02923b4e8bd45d29b67b13 [file] [log] [blame]
Andreas Gampe04bbb5b2017-01-19 17:49:03 +00001/*
2 * Copyright (C) 2017 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_RUNTIME_CALLBACKS_H_
18#define ART_RUNTIME_RUNTIME_CALLBACKS_H_
19
20#include <vector>
21
22#include "base/macros.h"
23#include "base/mutex.h"
Andreas Gampe0f01b582017-01-18 15:22:37 -080024#include "handle.h"
Andreas Gampe04bbb5b2017-01-19 17:49:03 +000025
26namespace art {
27
Andreas Gampe0f01b582017-01-18 15:22:37 -080028namespace mirror {
29class Class;
30} // namespace mirror
31
32class ClassLoadCallback;
Andreas Gampe04bbb5b2017-01-19 17:49:03 +000033class Thread;
34class ThreadLifecycleCallback;
35
36// Note: RuntimeCallbacks uses the mutator lock to synchronize the callback lists. A thread must
37// hold the exclusive lock to add or remove a listener. A thread must hold the shared lock
38// to dispatch an event. This setup is chosen as some clients may want to suspend the
39// dispatching thread or all threads.
40//
41// To make this safe, the following restrictions apply:
42// * Only the owner of a listener may ever add or remove said listener.
43// * A listener must never add or remove itself or any other listener while running.
44// * It is the responsibility of the owner to not remove the listener while it is running
45// (and suspended).
46//
47// The simplest way to satisfy these restrictions is to never remove a listener, and to do
48// any state checking (is the listener enabled) in the listener itself. For an example, see
49// Dbg.
50
Andreas Gampea5814f92017-01-18 21:43:16 -080051class RuntimeSigQuitCallback {
52 public:
53 virtual ~RuntimeSigQuitCallback() {}
54
55 virtual void SigQuit() REQUIRES_SHARED(Locks::mutator_lock_) = 0;
56};
57
Andreas Gampe04bbb5b2017-01-19 17:49:03 +000058class RuntimeCallbacks {
59 public:
Andreas Gampe0f01b582017-01-18 15:22:37 -080060 void AddThreadLifecycleCallback(ThreadLifecycleCallback* cb) REQUIRES(Locks::mutator_lock_);
61 void RemoveThreadLifecycleCallback(ThreadLifecycleCallback* cb) REQUIRES(Locks::mutator_lock_);
Andreas Gampe04bbb5b2017-01-19 17:49:03 +000062
Andreas Gampe0f01b582017-01-18 15:22:37 -080063 void ThreadStart(Thread* self) REQUIRES_SHARED(Locks::mutator_lock_);
64 void ThreadDeath(Thread* self) REQUIRES_SHARED(Locks::mutator_lock_);
65
66 void AddClassLoadCallback(ClassLoadCallback* cb) REQUIRES(Locks::mutator_lock_);
67 void RemoveClassLoadCallback(ClassLoadCallback* cb) REQUIRES(Locks::mutator_lock_);
68
69 void ClassLoad(Handle<mirror::Class> klass) REQUIRES_SHARED(Locks::mutator_lock_);
70 void ClassPrepare(Handle<mirror::Class> temp_klass, Handle<mirror::Class> klass)
Andreas Gampe04bbb5b2017-01-19 17:49:03 +000071 REQUIRES_SHARED(Locks::mutator_lock_);
72
Andreas Gampea5814f92017-01-18 21:43:16 -080073 void AddRuntimeSigQuitCallback(RuntimeSigQuitCallback* cb)
74 REQUIRES(Locks::mutator_lock_);
75 void RemoveRuntimeSigQuitCallback(RuntimeSigQuitCallback* cb)
76 REQUIRES(Locks::mutator_lock_);
77
78 void SigQuit() REQUIRES_SHARED(Locks::mutator_lock_);
79
Andreas Gampe04bbb5b2017-01-19 17:49:03 +000080 private:
81 std::vector<ThreadLifecycleCallback*> thread_callbacks_
82 GUARDED_BY(Locks::mutator_lock_);
Andreas Gampe0f01b582017-01-18 15:22:37 -080083 std::vector<ClassLoadCallback*> class_callbacks_
84 GUARDED_BY(Locks::mutator_lock_);
Andreas Gampea5814f92017-01-18 21:43:16 -080085 std::vector<RuntimeSigQuitCallback*> sigquit_callbacks_
86 GUARDED_BY(Locks::mutator_lock_);
Andreas Gampe04bbb5b2017-01-19 17:49:03 +000087};
88
89} // namespace art
90
91#endif // ART_RUNTIME_RUNTIME_CALLBACKS_H_