blob: fb1cd039a41f023e25f0282cfd120d2b9819e58f [file] [log] [blame]
Elliott Hughes2faa5f12012-01-30 14:42:07 -08001/*
2 * Copyright (C) 2011 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 */
Carl Shapiro1fb86202011-06-27 17:43:13 -070016
17#ifndef ART_SRC_RUNTIME_H_
18#define ART_SRC_RUNTIME_H_
19
Elliott Hughesc5f7c912011-08-18 14:00:42 -070020#include <stdio.h>
21
Elliott Hughese27955c2011-08-26 15:21:24 -070022#include <iosfwd>
Brian Carlstrom6ea095a2011-08-16 15:26:54 -070023#include <string>
Carl Shapirofc322c72011-07-27 00:20:01 -070024#include <utility>
Brian Carlstrom6ea095a2011-08-16 15:26:54 -070025#include <vector>
Brian Carlstrom578bbdc2011-07-21 14:07:47 -070026
Elliott Hughesc5f7c912011-08-18 14:00:42 -070027#include <jni.h>
28
Ian Rogersff1ed472011-09-20 13:46:24 -070029#include "constants.h"
Brian Carlstrom1f870082011-08-23 16:02:11 -070030#include "heap.h"
Brian Carlstrom578bbdc2011-07-21 14:07:47 -070031#include "globals.h"
32#include "macros.h"
Elliott Hughes9d5ccec2011-09-19 13:19:50 -070033#include "runtime_stats.h"
Brian Carlstrom578bbdc2011-07-21 14:07:47 -070034#include "stringpiece.h"
Carl Shapirob5573532011-07-12 18:22:59 -070035
Carl Shapiro1fb86202011-06-27 17:43:13 -070036namespace art {
37
Brian Carlstrom16192862011-09-12 17:50:06 -070038template<class T> class PrimitiveArray;
39typedef PrimitiveArray<int8_t> ByteArray;
Carl Shapiro61e019d2011-07-14 16:53:09 -070040class ClassLinker;
Brian Carlstromaded5f72011-10-07 17:15:04 -070041class ClassLoader;
Carl Shapirofc322c72011-07-27 00:20:01 -070042class DexFile;
Carl Shapiro61e019d2011-07-14 16:53:09 -070043class Heap;
Elliott Hughescf4c6c42011-09-01 15:16:42 -070044class InternTable;
Elliott Hughesc5f7c912011-08-18 14:00:42 -070045class JavaVMExt;
Ian Rogersff1ed472011-09-20 13:46:24 -070046class Method;
Elliott Hughesc33a32b2011-10-11 18:18:07 -070047class MonitorList;
Elliott Hughese27955c2011-08-26 15:21:24 -070048class SignalCatcher;
Brian Carlstrom6ea095a2011-08-16 15:26:54 -070049class String;
Carl Shapiro61e019d2011-07-14 16:53:09 -070050class ThreadList;
jeffhao2692b572011-12-16 15:42:28 -080051class Trace;
Carl Shapiro61e019d2011-07-14 16:53:09 -070052
Carl Shapiro1fb86202011-06-27 17:43:13 -070053class Runtime {
54 public:
Brian Carlstrom8a436592011-08-15 21:27:23 -070055
Elliott Hughesf1a5adc2012-02-10 18:09:35 -080056 typedef std::vector<std::pair<std::string, const void*> > Options;
Brian Carlstrom8a436592011-08-15 21:27:23 -070057
58 class ParsedOptions {
59 public:
Brian Carlstrom6ea095a2011-08-16 15:26:54 -070060 // returns null if problem parsing and ignore_unrecognized is false
61 static ParsedOptions* Create(const Options& options, bool ignore_unrecognized);
Brian Carlstrom8a436592011-08-15 21:27:23 -070062
Brian Carlstroma004aa92012-02-08 18:05:09 -080063 const std::vector<const DexFile*>* boot_class_path_;
64 std::string boot_class_path_string_;
65 std::string class_path_string_;
Brian Carlstrom58ae9412011-10-04 00:56:06 -070066 std::string host_prefix_;
Brian Carlstrom223f20f2012-02-04 23:06:55 -080067 std::string image_;
Elliott Hughes515a5bc2011-08-17 11:08:34 -070068 bool check_jni_;
Elliott Hughesa0957642011-09-02 14:27:33 -070069 std::string jni_trace_;
Elliott Hughesd9c67be2012-02-02 19:54:06 -080070 bool is_compiler_;
Elliott Hughes9ca7a1f2011-10-11 14:29:52 -070071 bool is_zygote_;
Brian Carlstrom8a436592011-08-15 21:27:23 -070072 size_t heap_initial_size_;
73 size_t heap_maximum_size_;
jeffhaoc1160702011-10-27 15:48:45 -070074 size_t heap_growth_limit_;
Brian Carlstromf734cf52011-08-17 16:28:14 -070075 size_t stack_size_;
Elliott Hughesbb1e8f02011-10-18 14:14:25 -070076 size_t jni_globals_max_;
77 size_t lock_profiling_threshold_;
Elliott Hughes94ce37a2011-10-18 15:07:48 -070078 std::string stack_trace_file_;
Elliott Hughesfc861622011-10-17 17:57:47 -070079 bool (*hook_is_sensitive_thread_)();
Brian Carlstrom6ea095a2011-08-16 15:26:54 -070080 jint (*hook_vfprintf_)(FILE* stream, const char* format, va_list ap);
81 void (*hook_exit_)(jint status);
82 void (*hook_abort_)();
Brian Carlstrom6ea095a2011-08-16 15:26:54 -070083 std::vector<std::string> properties_;
84
85 private:
Ian Rogers0cfe1fb2011-08-26 03:29:44 -070086 ParsedOptions() {}
Brian Carlstrom8a436592011-08-15 21:27:23 -070087 };
Carl Shapiro2ed144c2011-07-26 16:52:08 -070088
Carl Shapiro61e019d2011-07-14 16:53:09 -070089 // Creates and initializes a new runtime.
Carl Shapiro2ed144c2011-07-26 16:52:08 -070090 static Runtime* Create(const Options& options, bool ignore_unrecognized);
Brian Carlstrom69b15fb2011-09-03 12:25:21 -070091
Elliott Hughesd9c67be2012-02-02 19:54:06 -080092 bool IsCompiler() const {
93 return is_compiler_;
94 }
95
Brian Carlstromcaabb1b2011-10-11 18:09:13 -070096 bool IsZygote() const {
97 return is_zygote_;
98 }
99
Brian Carlstrom58ae9412011-10-04 00:56:06 -0700100 const std::string& GetHostPrefix() const {
Elliott Hughes307f75d2011-10-12 18:04:40 -0700101 DCHECK(!IsStarted());
Brian Carlstrom58ae9412011-10-04 00:56:06 -0700102 return host_prefix_;
103 }
104
Brian Carlstrom69b15fb2011-09-03 12:25:21 -0700105 // Starts a runtime, which may cause threads to be started and code to run.
106 void Start();
Carl Shapiro2ed144c2011-07-26 16:52:08 -0700107
Elliott Hughes6b355752012-01-13 16:49:08 -0800108 bool IsShuttingDown() const;
Brian Carlstrom58ae9412011-10-04 00:56:06 -0700109 bool IsStarted() const;
Elliott Hughesdcc24742011-09-07 14:02:44 -0700110
Carl Shapiro2ed144c2011-07-26 16:52:08 -0700111 static Runtime* Current() {
112 return instance_;
113 }
Carl Shapiro1fb86202011-06-27 17:43:13 -0700114
Elliott Hughesffe67362011-07-17 12:09:27 -0700115 // Aborts semi-cleanly. Used in the implementation of LOG(FATAL), which most
116 // callers should prefer.
117 // This isn't marked ((noreturn)) because then gcc will merge multiple calls
118 // in a single function together. This reduces code size slightly, but means
119 // that the native stack trace we get may point at the wrong call site.
120 static void Abort(const char* file, int line);
121
Carl Shapiro61e019d2011-07-14 16:53:09 -0700122 // Attaches the current native thread to the runtime.
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700123 void AttachCurrentThread(const char* name, bool as_daemon);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700124
Elliott Hughesbf86d042011-08-31 17:53:14 -0700125 void CallExitHook(jint status);
126
Carl Shapiro61e019d2011-07-14 16:53:09 -0700127 // Detaches the current native thread from the runtime.
Elliott Hughesd92bec42011-09-02 17:04:36 -0700128 void DetachCurrentThread();
Carl Shapiro61e019d2011-07-14 16:53:09 -0700129
Elliott Hughes8daa0922011-09-11 13:46:25 -0700130 void Dump(std::ostream& os);
Elliott Hughes21a5bf22011-12-07 14:35:20 -0800131 void DumpLockHolders(std::ostream& os);
Elliott Hughese27955c2011-08-26 15:21:24 -0700132
Carl Shapiro61e019d2011-07-14 16:53:09 -0700133 ~Runtime();
Carl Shapirob5573532011-07-12 18:22:59 -0700134
Brian Carlstroma004aa92012-02-08 18:05:09 -0800135 const std::string& GetBootClassPathString() const {
136 return boot_class_path_string_;
137 }
138
139 const std::string& GetClassPathString() const {
140 return class_path_string_;
Brian Carlstromb765be02011-08-17 23:54:10 -0700141 }
142
143 ClassLinker* GetClassLinker() const {
Carl Shapiro7a909592011-07-24 19:21:59 -0700144 return class_linker_;
145 }
146
Elliott Hughes7ede61e2011-09-14 18:18:06 -0700147 size_t GetDefaultStackSize() const {
148 return default_stack_size_;
149 }
150
Elliott Hughescf4c6c42011-09-01 15:16:42 -0700151 InternTable* GetInternTable() const {
152 return intern_table_;
153 }
154
Elliott Hughes0af55432011-08-17 18:37:28 -0700155 JavaVMExt* GetJavaVM() const {
Elliott Hughesc5f7c912011-08-18 14:00:42 -0700156 return java_vm_;
Elliott Hughesf2682d52011-08-15 16:37:04 -0700157 }
158
Elliott Hughes7ede61e2011-09-14 18:18:06 -0700159 const std::vector<std::string>& GetProperties() const {
160 return properties_;
161 }
162
Elliott Hughesc33a32b2011-10-11 18:18:07 -0700163 MonitorList* GetMonitorList() const {
164 return monitor_list_;
165 }
166
Elliott Hughesd92bec42011-09-02 17:04:36 -0700167 ThreadList* GetThreadList() const {
168 return thread_list_;
169 }
170
Elliott Hughes7ede61e2011-09-14 18:18:06 -0700171 const char* GetVersion() const {
172 return "2.0.0";
173 }
174
Elliott Hughes410c0c82011-09-01 17:58:25 -0700175 void VisitRoots(Heap::RootVisitor* visitor, void* arg) const;
Brian Carlstrom1f870082011-08-23 16:02:11 -0700176
Ian Rogers169c9a72011-11-13 20:13:17 -0800177 bool HasJniDlsymLookupStub() const;
178 ByteArray* GetJniDlsymLookupStub() const;
179 void SetJniDlsymLookupStub(ByteArray* jni_stub_array);
Brian Carlstrom16192862011-09-12 17:50:06 -0700180
Brian Carlstrome24fa612011-09-29 00:53:55 -0700181 bool HasAbstractMethodErrorStubArray() const;
182 ByteArray* GetAbstractMethodErrorStubArray() const;
183 void SetAbstractMethodErrorStubArray(ByteArray* abstract_method_error_stub_array);
Ian Rogersff1ed472011-09-20 13:46:24 -0700184
Ian Rogers1cb0a1d2011-10-06 15:24:35 -0700185 enum TrampolineType {
186 kInstanceMethod,
187 kStaticMethod,
188 kUnknownMethod,
Ian Rogers4f0d07c2011-10-06 23:38:47 -0700189 kLastTrampolineMethodType // Value used for iteration
Ian Rogers1cb0a1d2011-10-06 15:24:35 -0700190 };
191 static TrampolineType GetTrampolineType(Method* method);
192 bool HasResolutionStubArray(TrampolineType type) const;
193 ByteArray* GetResolutionStubArray(TrampolineType type) const;
194 void SetResolutionStubArray(ByteArray* resolution_stub_array, TrampolineType type);
Ian Rogersad25ac52011-10-04 19:13:33 -0700195
Ian Rogers19846512012-02-24 11:42:47 -0800196 // Returns a special method to trampoline into runtime resolution
197 Method* CreateResolutionMethod();
198 bool HasResolutionMethod() const;
199 Method* GetResolutionMethod() const;
200 void SetResolutionMethod(Method* method);
201
Ian Rogersff1ed472011-09-20 13:46:24 -0700202 // Returns a special method that describes all callee saves being spilled to the stack.
Ian Rogers4f0d07c2011-10-06 23:38:47 -0700203 enum CalleeSaveType {
204 kSaveAll,
205 kRefsOnly,
206 kRefsAndArgs,
207 kLastCalleeSaveType // Value used for iteration
208 };
Brian Carlstromae826982011-11-09 01:33:42 -0800209 Method* CreateCalleeSaveMethod(InstructionSet instruction_set, CalleeSaveType type);
Ian Rogers4f0d07c2011-10-06 23:38:47 -0700210 bool HasCalleeSaveMethod(CalleeSaveType type) const;
211 Method* GetCalleeSaveMethod(CalleeSaveType type) const;
212 void SetCalleeSaveMethod(Method* method, CalleeSaveType type);
213
Brian Carlstromae826982011-11-09 01:33:42 -0800214 Method* CreateRefOnlyCalleeSaveMethod(InstructionSet instruction_set);
215 Method* CreateRefAndArgsCalleeSaveMethod(InstructionSet instruction_set);
Ian Rogersff1ed472011-09-20 13:46:24 -0700216
Elliott Hughes9d5ccec2011-09-19 13:19:50 -0700217 int32_t GetStat(int kind);
218
219 RuntimeStats* GetStats();
220
221 bool HasStatsEnabled() const {
222 return stats_enabled_;
223 }
224
225 void ResetStats(int kinds);
226
227 void SetStatsEnabled(bool new_state);
228
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700229 void DidForkFromZygote();
230
jeffhao2692b572011-12-16 15:42:28 -0800231 void EnableMethodTracing(Trace* tracer);
232 void DisableMethodTracing();
233 bool IsMethodTracingActive() const;
234 Trace* GetTracer() const;
235
Carl Shapirob5573532011-07-12 18:22:59 -0700236 private:
Elliott Hughesffe67362011-07-17 12:09:27 -0700237 static void PlatformAbort(const char*, int);
238
Elliott Hughesdcc24742011-09-07 14:02:44 -0700239 Runtime();
Carl Shapiro61e019d2011-07-14 16:53:09 -0700240
Elliott Hughesc1674ed2011-08-25 18:09:09 -0700241 void BlockSignals();
242
Brian Carlstrom8a436592011-08-15 21:27:23 -0700243 bool Init(const Options& options, bool ignore_unrecognized);
Elliott Hughes038a8062011-09-18 14:12:41 -0700244 void InitNativeMethods();
Elliott Hughesff17f1f2012-01-24 18:12:29 -0800245 void RegisterRuntimeNativeMethods(JNIEnv* env);
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700246
Elliott Hughes85d15452011-09-16 17:33:01 -0700247 void StartDaemonThreads();
Elliott Hughesd1cc8362011-10-24 16:58:50 -0700248 void StartSignalCatcher();
Carl Shapiro61e019d2011-07-14 16:53:09 -0700249
Elliott Hughesd9c67be2012-02-02 19:54:06 -0800250 bool is_compiler_;
Elliott Hughes9ca7a1f2011-10-11 14:29:52 -0700251 bool is_zygote_;
Brian Carlstrom0a5b14d2011-09-27 13:29:15 -0700252
Brian Carlstrom58ae9412011-10-04 00:56:06 -0700253 // The host prefix is used during cross compilation. It is removed
254 // from the start of host paths such as:
Brian Carlstrom29e7ac72011-12-05 23:42:57 -0800255 // $ANDROID_PRODUCT_OUT/system/framework/boot.oat
Brian Carlstrom34f426c2011-10-04 12:58:02 -0700256 // to produce target paths such as
Brian Carlstrom47a0d5a2011-10-12 21:20:05 -0700257 // /system/framework/boot.oat
Brian Carlstrom58ae9412011-10-04 00:56:06 -0700258 // Similarly it is prepended to target paths to arrive back at a
259 // host past. In both cases this is necessary because image and oat
260 // files embedded expect paths of dependent files (an image points
261 // to an oat file and an oat files to one or more dex files). These
262 // files contain the expected target path.
263 std::string host_prefix_;
264
Brian Carlstroma004aa92012-02-08 18:05:09 -0800265 std::string boot_class_path_string_;
266 std::string class_path_string_;
Elliott Hughes7ede61e2011-09-14 18:18:06 -0700267 std::vector<std::string> properties_;
268
Brian Carlstromb765be02011-08-17 23:54:10 -0700269 // The default stack size for managed threads created by the runtime.
Elliott Hughesbe759c62011-09-08 19:38:21 -0700270 size_t default_stack_size_;
Brian Carlstromb765be02011-08-17 23:54:10 -0700271
Elliott Hughesc33a32b2011-10-11 18:18:07 -0700272 MonitorList* monitor_list_;
273
Carl Shapirob5573532011-07-12 18:22:59 -0700274 ThreadList* thread_list_;
Carl Shapiro61e019d2011-07-14 16:53:09 -0700275
Elliott Hughescf4c6c42011-09-01 15:16:42 -0700276 InternTable* intern_table_;
277
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700278 ClassLinker* class_linker_;
279
Elliott Hughese27955c2011-08-26 15:21:24 -0700280 SignalCatcher* signal_catcher_;
Elliott Hughes94ce37a2011-10-18 15:07:48 -0700281 std::string stack_trace_file_;
Elliott Hughese27955c2011-08-26 15:21:24 -0700282
Elliott Hughesc5f7c912011-08-18 14:00:42 -0700283 JavaVMExt* java_vm_;
Elliott Hughesf2682d52011-08-15 16:37:04 -0700284
Brian Carlstrom16192862011-09-12 17:50:06 -0700285 ByteArray* jni_stub_array_;
286
Brian Carlstrome24fa612011-09-29 00:53:55 -0700287 ByteArray* abstract_method_error_stub_array_;
288
Ian Rogers4f0d07c2011-10-06 23:38:47 -0700289 ByteArray* resolution_stub_array_[kLastTrampolineMethodType];
Ian Rogersad25ac52011-10-04 19:13:33 -0700290
Ian Rogers4f0d07c2011-10-06 23:38:47 -0700291 Method* callee_save_method_[kLastCalleeSaveType];
Ian Rogersff1ed472011-09-20 13:46:24 -0700292
Ian Rogers19846512012-02-24 11:42:47 -0800293 Method* resolution_method_;
294
Brian Carlstromaded5f72011-10-07 17:15:04 -0700295 // As returned by ClassLoader.getSystemClassLoader()
296 ClassLoader* system_class_loader_;
297
Elliott Hughes6b355752012-01-13 16:49:08 -0800298 bool shutting_down_;
Elliott Hughesdcc24742011-09-07 14:02:44 -0700299 bool started_;
300
Brian Carlstrom6ea095a2011-08-16 15:26:54 -0700301 // Hooks supported by JNI_CreateJavaVM
302 jint (*vfprintf_)(FILE* stream, const char* format, va_list ap);
303 void (*exit_)(jint status);
304 void (*abort_)();
305
Elliott Hughes9d5ccec2011-09-19 13:19:50 -0700306 bool stats_enabled_;
307 RuntimeStats stats_;
308
jeffhao2692b572011-12-16 15:42:28 -0800309 Trace* tracer_;
310
Carl Shapiro2ed144c2011-07-26 16:52:08 -0700311 // A pointer to the active runtime or NULL.
312 static Runtime* instance_;
313
Elliott Hughes131aef82012-01-27 11:53:35 -0800314 static Mutex abort_lock_;
315
Carl Shapiro61e019d2011-07-14 16:53:09 -0700316 DISALLOW_COPY_AND_ASSIGN(Runtime);
Carl Shapiro1fb86202011-06-27 17:43:13 -0700317};
318
319} // namespace art
320
Carl Shapiro1fb86202011-06-27 17:43:13 -0700321#endif // ART_SRC_RUNTIME_H_