blob: b29523eda72721ac36813192fb5bfddf874a5d48 [file] [log] [blame]
Carl Shapiro1fb86202011-06-27 17:43:13 -07001// Copyright 2011 Google Inc. All Rights Reserved.
2
3#ifndef ART_SRC_RUNTIME_H_
4#define ART_SRC_RUNTIME_H_
5
Elliott Hughesc5f7c912011-08-18 14:00:42 -07006#include <stdio.h>
7
Elliott Hughese27955c2011-08-26 15:21:24 -07008#include <iosfwd>
Brian Carlstrom6ea095a2011-08-16 15:26:54 -07009#include <string>
Carl Shapirofc322c72011-07-27 00:20:01 -070010#include <utility>
Brian Carlstrom6ea095a2011-08-16 15:26:54 -070011#include <vector>
Brian Carlstrom578bbdc2011-07-21 14:07:47 -070012
Elliott Hughesc5f7c912011-08-18 14:00:42 -070013#include <jni.h>
14
Ian Rogersff1ed472011-09-20 13:46:24 -070015#include "constants.h"
Brian Carlstrom1f870082011-08-23 16:02:11 -070016#include "heap.h"
Brian Carlstrom578bbdc2011-07-21 14:07:47 -070017#include "globals.h"
18#include "macros.h"
Elliott Hughes9d5ccec2011-09-19 13:19:50 -070019#include "runtime_stats.h"
Brian Carlstrom578bbdc2011-07-21 14:07:47 -070020#include "stringpiece.h"
Brian Carlstrom44753c32011-08-17 22:22:11 -070021#include "unordered_set.h"
Carl Shapirob5573532011-07-12 18:22:59 -070022
Carl Shapiro1fb86202011-06-27 17:43:13 -070023namespace art {
24
Brian Carlstrom16192862011-09-12 17:50:06 -070025template<class T> class PrimitiveArray;
26typedef PrimitiveArray<int8_t> ByteArray;
Carl Shapiro61e019d2011-07-14 16:53:09 -070027class ClassLinker;
Brian Carlstromaded5f72011-10-07 17:15:04 -070028class ClassLoader;
Carl Shapirofc322c72011-07-27 00:20:01 -070029class DexFile;
Carl Shapiro61e019d2011-07-14 16:53:09 -070030class Heap;
Elliott Hughescf4c6c42011-09-01 15:16:42 -070031class InternTable;
Elliott Hughesc5f7c912011-08-18 14:00:42 -070032class JavaVMExt;
Ian Rogersff1ed472011-09-20 13:46:24 -070033class Method;
Elliott Hughesc33a32b2011-10-11 18:18:07 -070034class MonitorList;
Elliott Hughese27955c2011-08-26 15:21:24 -070035class SignalCatcher;
Brian Carlstrom6ea095a2011-08-16 15:26:54 -070036class String;
Carl Shapiro61e019d2011-07-14 16:53:09 -070037class ThreadList;
38
Carl Shapiro1fb86202011-06-27 17:43:13 -070039class Runtime {
40 public:
Brian Carlstrom8a436592011-08-15 21:27:23 -070041
42 typedef std::vector<std::pair<StringPiece, const void*> > Options;
43
44 class ParsedOptions {
45 public:
Brian Carlstrom6ea095a2011-08-16 15:26:54 -070046 // returns null if problem parsing and ignore_unrecognized is false
47 static ParsedOptions* Create(const Options& options, bool ignore_unrecognized);
Brian Carlstrom8a436592011-08-15 21:27:23 -070048
Brian Carlstrom58ae9412011-10-04 00:56:06 -070049 std::string boot_class_path_;
50 std::string class_path_;
51 std::string host_prefix_;
52 std::vector<std::string> images_;
Elliott Hughes515a5bc2011-08-17 11:08:34 -070053 bool check_jni_;
Elliott Hughesa0957642011-09-02 14:27:33 -070054 std::string jni_trace_;
Elliott Hughes9ca7a1f2011-10-11 14:29:52 -070055 bool is_zygote_;
Brian Carlstrom8a436592011-08-15 21:27:23 -070056 size_t heap_initial_size_;
57 size_t heap_maximum_size_;
Brian Carlstromf734cf52011-08-17 16:28:14 -070058 size_t stack_size_;
Elliott Hughesbb1e8f02011-10-18 14:14:25 -070059 size_t jni_globals_max_;
60 size_t lock_profiling_threshold_;
Elliott Hughesfc861622011-10-17 17:57:47 -070061 bool (*hook_is_sensitive_thread_)();
Brian Carlstrom6ea095a2011-08-16 15:26:54 -070062 jint (*hook_vfprintf_)(FILE* stream, const char* format, va_list ap);
63 void (*hook_exit_)(jint status);
64 void (*hook_abort_)();
Brian Carlstrom44753c32011-08-17 22:22:11 -070065 std::tr1::unordered_set<std::string> verbose_;
Brian Carlstrom6ea095a2011-08-16 15:26:54 -070066 std::vector<std::string> properties_;
67
Elliott Hughesa0957642011-09-02 14:27:33 -070068 bool IsVerbose(const std::string& key) const {
69 return verbose_.find(key) != verbose_.end();
70 }
71
Brian Carlstrom6ea095a2011-08-16 15:26:54 -070072 private:
Ian Rogers0cfe1fb2011-08-26 03:29:44 -070073 ParsedOptions() {}
Brian Carlstrom8a436592011-08-15 21:27:23 -070074 };
Carl Shapiro2ed144c2011-07-26 16:52:08 -070075
Carl Shapiro61e019d2011-07-14 16:53:09 -070076 // Creates and initializes a new runtime.
Carl Shapiro2ed144c2011-07-26 16:52:08 -070077 static Runtime* Create(const Options& options, bool ignore_unrecognized);
Brian Carlstrom69b15fb2011-09-03 12:25:21 -070078
Brian Carlstrom0a5b14d2011-09-27 13:29:15 -070079 bool IsVerboseStartup() const {
80 return verbose_startup_;
81 }
82
Brian Carlstromcaabb1b2011-10-11 18:09:13 -070083 bool IsZygote() const {
84 return is_zygote_;
85 }
86
Brian Carlstrom58ae9412011-10-04 00:56:06 -070087 const std::string& GetHostPrefix() const {
Elliott Hughes307f75d2011-10-12 18:04:40 -070088 DCHECK(!IsStarted());
Brian Carlstrom58ae9412011-10-04 00:56:06 -070089 return host_prefix_;
90 }
91
Brian Carlstrom69b15fb2011-09-03 12:25:21 -070092 // Starts a runtime, which may cause threads to be started and code to run.
93 void Start();
Carl Shapiro2ed144c2011-07-26 16:52:08 -070094
Brian Carlstrom58ae9412011-10-04 00:56:06 -070095 bool IsStarted() const;
Elliott Hughesdcc24742011-09-07 14:02:44 -070096
Carl Shapiro2ed144c2011-07-26 16:52:08 -070097 static Runtime* Current() {
98 return instance_;
99 }
Carl Shapiro1fb86202011-06-27 17:43:13 -0700100
Carl Shapiro61e019d2011-07-14 16:53:09 -0700101 // Compiles a dex file.
102 static void Compile(const StringPiece& filename);
Carl Shapirob5573532011-07-12 18:22:59 -0700103
Elliott Hughesffe67362011-07-17 12:09:27 -0700104 // Aborts semi-cleanly. Used in the implementation of LOG(FATAL), which most
105 // callers should prefer.
106 // This isn't marked ((noreturn)) because then gcc will merge multiple calls
107 // in a single function together. This reduces code size slightly, but means
108 // that the native stack trace we get may point at the wrong call site.
109 static void Abort(const char* file, int line);
110
Carl Shapiro61e019d2011-07-14 16:53:09 -0700111 // Attaches the current native thread to the runtime.
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700112 void AttachCurrentThread(const char* name, bool as_daemon);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700113
Elliott Hughesbf86d042011-08-31 17:53:14 -0700114 void CallExitHook(jint status);
115
Carl Shapiro61e019d2011-07-14 16:53:09 -0700116 // Detaches the current native thread from the runtime.
Elliott Hughesd92bec42011-09-02 17:04:36 -0700117 void DetachCurrentThread();
Carl Shapiro61e019d2011-07-14 16:53:09 -0700118
Elliott Hughes8daa0922011-09-11 13:46:25 -0700119 void Dump(std::ostream& os);
Elliott Hughese27955c2011-08-26 15:21:24 -0700120
Carl Shapiro61e019d2011-07-14 16:53:09 -0700121 ~Runtime();
Carl Shapirob5573532011-07-12 18:22:59 -0700122
Elliott Hughes7ede61e2011-09-14 18:18:06 -0700123 const std::string& GetBootClassPath() const {
124 return boot_class_path_;
Brian Carlstromb765be02011-08-17 23:54:10 -0700125 }
126
127 ClassLinker* GetClassLinker() const {
Carl Shapiro7a909592011-07-24 19:21:59 -0700128 return class_linker_;
129 }
130
Elliott Hughes7ede61e2011-09-14 18:18:06 -0700131 const std::string& GetClassPath() const {
132 return class_path_;
133 }
134
135 size_t GetDefaultStackSize() const {
136 return default_stack_size_;
137 }
138
Elliott Hughescf4c6c42011-09-01 15:16:42 -0700139 InternTable* GetInternTable() const {
140 return intern_table_;
141 }
142
Elliott Hughes0af55432011-08-17 18:37:28 -0700143 JavaVMExt* GetJavaVM() const {
Elliott Hughesc5f7c912011-08-18 14:00:42 -0700144 return java_vm_;
Elliott Hughesf2682d52011-08-15 16:37:04 -0700145 }
146
Elliott Hughes7ede61e2011-09-14 18:18:06 -0700147 const std::vector<std::string>& GetProperties() const {
148 return properties_;
149 }
150
Elliott Hughesc33a32b2011-10-11 18:18:07 -0700151 MonitorList* GetMonitorList() const {
152 return monitor_list_;
153 }
154
Elliott Hughesd92bec42011-09-02 17:04:36 -0700155 ThreadList* GetThreadList() const {
156 return thread_list_;
157 }
158
Elliott Hughes7ede61e2011-09-14 18:18:06 -0700159 const char* GetVersion() const {
160 return "2.0.0";
161 }
162
Elliott Hughes410c0c82011-09-01 17:58:25 -0700163 void VisitRoots(Heap::RootVisitor* visitor, void* arg) const;
Brian Carlstrom1f870082011-08-23 16:02:11 -0700164
Brian Carlstrome24fa612011-09-29 00:53:55 -0700165 bool HasJniStubArray() const;
166 ByteArray* GetJniStubArray() const;
167 void SetJniStubArray(ByteArray* jni_stub_array);
Brian Carlstrom16192862011-09-12 17:50:06 -0700168
Brian Carlstrome24fa612011-09-29 00:53:55 -0700169 bool HasAbstractMethodErrorStubArray() const;
170 ByteArray* GetAbstractMethodErrorStubArray() const;
171 void SetAbstractMethodErrorStubArray(ByteArray* abstract_method_error_stub_array);
Ian Rogersff1ed472011-09-20 13:46:24 -0700172
Ian Rogers1cb0a1d2011-10-06 15:24:35 -0700173 enum TrampolineType {
174 kInstanceMethod,
175 kStaticMethod,
176 kUnknownMethod,
Ian Rogers4f0d07c2011-10-06 23:38:47 -0700177 kLastTrampolineMethodType // Value used for iteration
Ian Rogers1cb0a1d2011-10-06 15:24:35 -0700178 };
179 static TrampolineType GetTrampolineType(Method* method);
180 bool HasResolutionStubArray(TrampolineType type) const;
181 ByteArray* GetResolutionStubArray(TrampolineType type) const;
182 void SetResolutionStubArray(ByteArray* resolution_stub_array, TrampolineType type);
Ian Rogersad25ac52011-10-04 19:13:33 -0700183
Ian Rogersff1ed472011-09-20 13:46:24 -0700184 // Returns a special method that describes all callee saves being spilled to the stack.
Ian Rogers4f0d07c2011-10-06 23:38:47 -0700185 enum CalleeSaveType {
186 kSaveAll,
187 kRefsOnly,
188 kRefsAndArgs,
189 kLastCalleeSaveType // Value used for iteration
190 };
191 Method* CreateCalleeSaveMethod(InstructionSet insns, CalleeSaveType type);
192 bool HasCalleeSaveMethod(CalleeSaveType type) const;
193 Method* GetCalleeSaveMethod(CalleeSaveType type) const;
194 void SetCalleeSaveMethod(Method* method, CalleeSaveType type);
195
196 Method* CreateRefOnlyCalleeSaveMethod(InstructionSet insns);
197 Method* CreateRefAndArgsCalleeSaveMethod(InstructionSet insns);
Ian Rogersff1ed472011-09-20 13:46:24 -0700198
Elliott Hughes9d5ccec2011-09-19 13:19:50 -0700199 int32_t GetStat(int kind);
200
201 RuntimeStats* GetStats();
202
203 bool HasStatsEnabled() const {
204 return stats_enabled_;
205 }
206
207 void ResetStats(int kinds);
208
209 void SetStatsEnabled(bool new_state);
210
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700211 void DidForkFromZygote();
212
Carl Shapirob5573532011-07-12 18:22:59 -0700213 private:
Elliott Hughesffe67362011-07-17 12:09:27 -0700214 static void PlatformAbort(const char*, int);
215
Elliott Hughesdcc24742011-09-07 14:02:44 -0700216 Runtime();
Carl Shapiro61e019d2011-07-14 16:53:09 -0700217
Elliott Hughesc1674ed2011-08-25 18:09:09 -0700218 void BlockSignals();
219
Brian Carlstrom8a436592011-08-15 21:27:23 -0700220 bool Init(const Options& options, bool ignore_unrecognized);
Elliott Hughes038a8062011-09-18 14:12:41 -0700221 void InitNativeMethods();
Elliott Hughesad7c2a32011-08-31 11:58:10 -0700222 void RegisterRuntimeNativeMethods(JNIEnv*);
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700223 void StartSignalCatcher();
Elliott Hughes85d15452011-09-16 17:33:01 -0700224 void StartDaemonThreads();
Carl Shapiro61e019d2011-07-14 16:53:09 -0700225
Brian Carlstrom0a5b14d2011-09-27 13:29:15 -0700226 bool verbose_startup_;
Elliott Hughes9ca7a1f2011-10-11 14:29:52 -0700227 bool is_zygote_;
Brian Carlstrom0a5b14d2011-09-27 13:29:15 -0700228
Brian Carlstrom58ae9412011-10-04 00:56:06 -0700229 // The host prefix is used during cross compilation. It is removed
230 // from the start of host paths such as:
Brian Carlstrom47a0d5a2011-10-12 21:20:05 -0700231 // $ANDROID_PRODUCT_OUT/data/art-cache/boot.oat
Brian Carlstrom34f426c2011-10-04 12:58:02 -0700232 // to produce target paths such as
Brian Carlstrom47a0d5a2011-10-12 21:20:05 -0700233 // /system/framework/boot.oat
Brian Carlstrom58ae9412011-10-04 00:56:06 -0700234 // Similarly it is prepended to target paths to arrive back at a
235 // host past. In both cases this is necessary because image and oat
236 // files embedded expect paths of dependent files (an image points
237 // to an oat file and an oat files to one or more dex files). These
238 // files contain the expected target path.
239 std::string host_prefix_;
240
Elliott Hughes7ede61e2011-09-14 18:18:06 -0700241 std::string boot_class_path_;
242 std::string class_path_;
243 std::vector<std::string> properties_;
244
Brian Carlstromb765be02011-08-17 23:54:10 -0700245 // The default stack size for managed threads created by the runtime.
Elliott Hughesbe759c62011-09-08 19:38:21 -0700246 size_t default_stack_size_;
Brian Carlstromb765be02011-08-17 23:54:10 -0700247
Elliott Hughesc33a32b2011-10-11 18:18:07 -0700248 MonitorList* monitor_list_;
249
Carl Shapirob5573532011-07-12 18:22:59 -0700250 ThreadList* thread_list_;
Carl Shapiro61e019d2011-07-14 16:53:09 -0700251
Elliott Hughescf4c6c42011-09-01 15:16:42 -0700252 InternTable* intern_table_;
253
Brian Carlstromb0460ea2011-07-29 10:08:05 -0700254 ClassLinker* class_linker_;
255
Elliott Hughese27955c2011-08-26 15:21:24 -0700256 SignalCatcher* signal_catcher_;
257
Elliott Hughesc5f7c912011-08-18 14:00:42 -0700258 JavaVMExt* java_vm_;
Elliott Hughesf2682d52011-08-15 16:37:04 -0700259
Brian Carlstrom16192862011-09-12 17:50:06 -0700260 ByteArray* jni_stub_array_;
261
Brian Carlstrome24fa612011-09-29 00:53:55 -0700262 ByteArray* abstract_method_error_stub_array_;
263
Ian Rogers4f0d07c2011-10-06 23:38:47 -0700264 ByteArray* resolution_stub_array_[kLastTrampolineMethodType];
Ian Rogersad25ac52011-10-04 19:13:33 -0700265
Ian Rogers4f0d07c2011-10-06 23:38:47 -0700266 Method* callee_save_method_[kLastCalleeSaveType];
Ian Rogersff1ed472011-09-20 13:46:24 -0700267
Brian Carlstromaded5f72011-10-07 17:15:04 -0700268 // As returned by ClassLoader.getSystemClassLoader()
269 ClassLoader* system_class_loader_;
270
Elliott Hughesdcc24742011-09-07 14:02:44 -0700271 bool started_;
272
Brian Carlstrom6ea095a2011-08-16 15:26:54 -0700273 // Hooks supported by JNI_CreateJavaVM
274 jint (*vfprintf_)(FILE* stream, const char* format, va_list ap);
275 void (*exit_)(jint status);
276 void (*abort_)();
277
Elliott Hughes9d5ccec2011-09-19 13:19:50 -0700278 bool stats_enabled_;
279 RuntimeStats stats_;
280
Carl Shapiro2ed144c2011-07-26 16:52:08 -0700281 // A pointer to the active runtime or NULL.
282 static Runtime* instance_;
283
Carl Shapiro61e019d2011-07-14 16:53:09 -0700284 DISALLOW_COPY_AND_ASSIGN(Runtime);
Carl Shapiro1fb86202011-06-27 17:43:13 -0700285};
286
287} // namespace art
288
Carl Shapiro1fb86202011-06-27 17:43:13 -0700289#endif // ART_SRC_RUNTIME_H_