blob: 3b03a1427d1b5dc662077cacc31423d48d31c047 [file] [log] [blame]
Dave Allisonb373e092014-02-20 16:06:36 -08001/*
2 * Copyright (C) 2008 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
18#ifndef ART_RUNTIME_FAULT_HANDLER_H_
19#define ART_RUNTIME_FAULT_HANDLER_H_
20
21#include <signal.h>
22#include <vector>
23#include <setjmp.h>
24#include <stdint.h>
25
26#include "base/mutex.h" // For annotalysis.
27
28namespace art {
Mathieu Chartierc751fdc2014-03-30 15:25:44 -070029
Mathieu Chartierc751fdc2014-03-30 15:25:44 -070030class ArtMethod;
Dave Allisonb373e092014-02-20 16:06:36 -080031class FaultHandler;
32
33class FaultManager {
34 public:
35 FaultManager();
36 ~FaultManager();
37
38 void Init();
Andreas Gampe928f72b2014-09-09 19:53:48 -070039
40 // Unclaim signals.
41 void Release();
42
43 // Unclaim signals and delete registered handlers.
Dave Allison1f8ef6f2014-08-20 17:38:41 -070044 void Shutdown();
Mathieu Chartierd0004802014-10-15 16:59:47 -070045 void EnsureArtActionInFrontOfSignalChain();
Dave Allisonb373e092014-02-20 16:06:36 -080046
47 void HandleFault(int sig, siginfo_t* info, void* context);
Dave Allison8ce6b902014-08-26 11:07:58 -070048 void HandleNestedSignal(int sig, siginfo_t* info, void* context);
Andreas Gampe928f72b2014-09-09 19:53:48 -070049
50 // Added handlers are owned by the fault handler and will be freed on Shutdown().
Mathieu Chartierc751fdc2014-03-30 15:25:44 -070051 void AddHandler(FaultHandler* handler, bool generated_code);
Dave Allisonb373e092014-02-20 16:06:36 -080052 void RemoveHandler(FaultHandler* handler);
Dave Allisondfd3b472014-07-16 16:04:32 -070053
54 // Note that the following two functions are called in the context of a signal handler.
55 // The IsInGeneratedCode() function checks that the mutator lock is held before it
56 // calls GetMethodAndReturnPCAndSP().
57 // TODO: think about adding lock assertions and fake lock and unlock functions.
Mathieu Chartiere401d142015-04-22 13:56:20 -070058 void GetMethodAndReturnPcAndSp(siginfo_t* siginfo, void* context, ArtMethod** out_method,
Dave Allisondfd3b472014-07-16 16:04:32 -070059 uintptr_t* out_return_pc, uintptr_t* out_sp)
60 NO_THREAD_SAFETY_ANALYSIS;
Dave Allison69dfe512014-07-11 17:11:58 +000061 bool IsInGeneratedCode(siginfo_t* siginfo, void *context, bool check_dex_pc)
62 NO_THREAD_SAFETY_ANALYSIS;
Dave Allisonb373e092014-02-20 16:06:36 -080063
64 private:
Mathieu Chartierc751fdc2014-03-30 15:25:44 -070065 std::vector<FaultHandler*> generated_code_handlers_;
66 std::vector<FaultHandler*> other_handlers_;
Dave Allisonb373e092014-02-20 16:06:36 -080067 struct sigaction oldaction_;
Dave Allison1f8ef6f2014-08-20 17:38:41 -070068 bool initialized_;
Mathieu Chartierc751fdc2014-03-30 15:25:44 -070069 DISALLOW_COPY_AND_ASSIGN(FaultManager);
Dave Allisonb373e092014-02-20 16:06:36 -080070};
71
72class FaultHandler {
73 public:
Mathieu Chartierc751fdc2014-03-30 15:25:44 -070074 explicit FaultHandler(FaultManager* manager);
Dave Allisonb373e092014-02-20 16:06:36 -080075 virtual ~FaultHandler() {}
Mathieu Chartierc751fdc2014-03-30 15:25:44 -070076 FaultManager* GetFaultManager() {
77 return manager_;
78 }
Dave Allisonb373e092014-02-20 16:06:36 -080079
80 virtual bool Action(int sig, siginfo_t* siginfo, void* context) = 0;
Mathieu Chartierc751fdc2014-03-30 15:25:44 -070081
Dave Allisonb373e092014-02-20 16:06:36 -080082 protected:
83 FaultManager* const manager_;
Mathieu Chartierc751fdc2014-03-30 15:25:44 -070084
85 private:
86 DISALLOW_COPY_AND_ASSIGN(FaultHandler);
Dave Allisonb373e092014-02-20 16:06:36 -080087};
88
89class NullPointerHandler FINAL : public FaultHandler {
90 public:
Dave Allisonb373e092014-02-20 16:06:36 -080091 explicit NullPointerHandler(FaultManager* manager);
92
93 bool Action(int sig, siginfo_t* siginfo, void* context) OVERRIDE;
Mathieu Chartierc751fdc2014-03-30 15:25:44 -070094
95 private:
96 DISALLOW_COPY_AND_ASSIGN(NullPointerHandler);
Dave Allisonb373e092014-02-20 16:06:36 -080097};
98
99class SuspensionHandler FINAL : public FaultHandler {
100 public:
Dave Allisonb373e092014-02-20 16:06:36 -0800101 explicit SuspensionHandler(FaultManager* manager);
102
103 bool Action(int sig, siginfo_t* siginfo, void* context) OVERRIDE;
Mathieu Chartierc751fdc2014-03-30 15:25:44 -0700104
105 private:
106 DISALLOW_COPY_AND_ASSIGN(SuspensionHandler);
Dave Allisonb373e092014-02-20 16:06:36 -0800107};
108
109class StackOverflowHandler FINAL : public FaultHandler {
110 public:
Dave Allisonb373e092014-02-20 16:06:36 -0800111 explicit StackOverflowHandler(FaultManager* manager);
112
113 bool Action(int sig, siginfo_t* siginfo, void* context) OVERRIDE;
Mathieu Chartierc751fdc2014-03-30 15:25:44 -0700114
115 private:
116 DISALLOW_COPY_AND_ASSIGN(StackOverflowHandler);
Dave Allisonb373e092014-02-20 16:06:36 -0800117};
118
Mathieu Chartierc751fdc2014-03-30 15:25:44 -0700119class JavaStackTraceHandler FINAL : public FaultHandler {
120 public:
121 explicit JavaStackTraceHandler(FaultManager* manager);
122
123 bool Action(int sig, siginfo_t* siginfo, void* context) OVERRIDE NO_THREAD_SAFETY_ANALYSIS;
124
125 private:
126 DISALLOW_COPY_AND_ASSIGN(JavaStackTraceHandler);
127};
128
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700129// Statically allocated so the the signal handler can Get access to it.
Dave Allisonb373e092014-02-20 16:06:36 -0800130extern FaultManager fault_manager;
131
132} // namespace art
133#endif // ART_RUNTIME_FAULT_HANDLER_H_
134