1 /*
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  */
16 
17 #ifndef ART_RUNTIME_RUNTIME_H_
18 #define ART_RUNTIME_RUNTIME_H_
19 
20 #include <jni.h>
21 #include <stdio.h>
22 
23 #include <iosfwd>
24 #include <set>
25 #include <string>
26 #include <utility>
27 #include <vector>
28 
29 #include "arch/instruction_set.h"
30 #include "base/macros.h"
31 #include "experimental_flags.h"
32 #include "gc_root.h"
33 #include "instrumentation.h"
34 #include "jobject_comparator.h"
35 #include "method_reference.h"
36 #include "object_callbacks.h"
37 #include "offsets.h"
38 #include "process_state.h"
39 #include "profiler_options.h"
40 #include "quick/quick_method_frame_info.h"
41 #include "runtime_stats.h"
42 #include "safe_map.h"
43 
44 namespace art {
45 
46 namespace gc {
47   class Heap;
48   namespace collector {
49     class GarbageCollector;
50   }  // namespace collector
51 }  // namespace gc
52 
53 namespace jit {
54   class Jit;
55   class JitOptions;
56 }  // namespace jit
57 
58 namespace lambda {
59   class BoxTable;
60 }  // namespace lambda
61 
62 namespace mirror {
63   class ClassLoader;
64   class Array;
65   template<class T> class ObjectArray;
66   template<class T> class PrimitiveArray;
67   typedef PrimitiveArray<int8_t> ByteArray;
68   class String;
69   class Throwable;
70 }  // namespace mirror
71 namespace verifier {
72   class MethodVerifier;
73   enum class VerifyMode : int8_t;
74 }  // namespace verifier
75 class ArenaPool;
76 class ArtMethod;
77 class ClassLinker;
78 class Closure;
79 class CompilerCallbacks;
80 class DexFile;
81 class InternTable;
82 class JavaVMExt;
83 class LinearAlloc;
84 class MonitorList;
85 class MonitorPool;
86 class NullPointerHandler;
87 class OatFileManager;
88 struct RuntimeArgumentMap;
89 class SignalCatcher;
90 class StackOverflowHandler;
91 class SuspensionHandler;
92 class ThreadList;
93 class Trace;
94 struct TraceConfig;
95 class Transaction;
96 
97 typedef std::vector<std::pair<std::string, const void*>> RuntimeOptions;
98 
99 // Not all combinations of flags are valid. You may not visit all roots as well as the new roots
100 // (no logical reason to do this). You also may not start logging new roots and stop logging new
101 // roots (also no logical reason to do this).
102 enum VisitRootFlags : uint8_t {
103   kVisitRootFlagAllRoots = 0x1,
104   kVisitRootFlagNewRoots = 0x2,
105   kVisitRootFlagStartLoggingNewRoots = 0x4,
106   kVisitRootFlagStopLoggingNewRoots = 0x8,
107   kVisitRootFlagClearRootLog = 0x10,
108   // Non moving means we can have optimizations where we don't visit some roots if they are
109   // definitely reachable from another location. E.g. ArtMethod and ArtField roots.
110   kVisitRootFlagNonMoving = 0x20,
111 };
112 
113 class Runtime {
114  public:
115   // Parse raw runtime options.
116   static bool ParseOptions(const RuntimeOptions& raw_options,
117                            bool ignore_unrecognized,
118                            RuntimeArgumentMap* runtime_options);
119 
120   // Creates and initializes a new runtime.
121   static bool Create(RuntimeArgumentMap&& runtime_options)
122       SHARED_TRYLOCK_FUNCTION(true, Locks::mutator_lock_);
123 
124   // Creates and initializes a new runtime.
125   static bool Create(const RuntimeOptions& raw_options, bool ignore_unrecognized)
126       SHARED_TRYLOCK_FUNCTION(true, Locks::mutator_lock_);
127 
128   // IsAotCompiler for compilers that don't have a running runtime. Only dex2oat currently.
IsAotCompiler()129   bool IsAotCompiler() const {
130     return !UseJitCompilation() && IsCompiler();
131   }
132 
133   // IsCompiler is any runtime which has a running compiler, either dex2oat or JIT.
IsCompiler()134   bool IsCompiler() const {
135     return compiler_callbacks_ != nullptr;
136   }
137 
138   // If a compiler, are we compiling a boot image?
139   bool IsCompilingBootImage() const;
140 
141   bool CanRelocate() const;
142 
ShouldRelocate()143   bool ShouldRelocate() const {
144     return must_relocate_ && CanRelocate();
145   }
146 
MustRelocateIfPossible()147   bool MustRelocateIfPossible() const {
148     return must_relocate_;
149   }
150 
IsDex2OatEnabled()151   bool IsDex2OatEnabled() const {
152     return dex2oat_enabled_ && IsImageDex2OatEnabled();
153   }
154 
IsImageDex2OatEnabled()155   bool IsImageDex2OatEnabled() const {
156     return image_dex2oat_enabled_;
157   }
158 
GetCompilerCallbacks()159   CompilerCallbacks* GetCompilerCallbacks() {
160     return compiler_callbacks_;
161   }
162 
SetCompilerCallbacks(CompilerCallbacks * callbacks)163   void SetCompilerCallbacks(CompilerCallbacks* callbacks) {
164     CHECK(callbacks != nullptr);
165     compiler_callbacks_ = callbacks;
166   }
167 
IsZygote()168   bool IsZygote() const {
169     return is_zygote_;
170   }
171 
IsExplicitGcDisabled()172   bool IsExplicitGcDisabled() const {
173     return is_explicit_gc_disabled_;
174   }
175 
176   std::string GetCompilerExecutable() const;
177   std::string GetPatchoatExecutable() const;
178 
GetCompilerOptions()179   const std::vector<std::string>& GetCompilerOptions() const {
180     return compiler_options_;
181   }
182 
AddCompilerOption(std::string option)183   void AddCompilerOption(std::string option) {
184     compiler_options_.push_back(option);
185   }
186 
GetImageCompilerOptions()187   const std::vector<std::string>& GetImageCompilerOptions() const {
188     return image_compiler_options_;
189   }
190 
GetImageLocation()191   const std::string& GetImageLocation() const {
192     return image_location_;
193   }
194 
GetProfilerOptions()195   const ProfilerOptions& GetProfilerOptions() const {
196     return profiler_options_;
197   }
198 
199   // Starts a runtime, which may cause threads to be started and code to run.
200   bool Start() UNLOCK_FUNCTION(Locks::mutator_lock_);
201 
202   bool IsShuttingDown(Thread* self);
IsShuttingDownLocked()203   bool IsShuttingDownLocked() const REQUIRES(Locks::runtime_shutdown_lock_) {
204     return shutting_down_;
205   }
206 
NumberOfThreadsBeingBorn()207   size_t NumberOfThreadsBeingBorn() const REQUIRES(Locks::runtime_shutdown_lock_) {
208     return threads_being_born_;
209   }
210 
StartThreadBirth()211   void StartThreadBirth() REQUIRES(Locks::runtime_shutdown_lock_) {
212     threads_being_born_++;
213   }
214 
215   void EndThreadBirth() REQUIRES(Locks::runtime_shutdown_lock_);
216 
IsStarted()217   bool IsStarted() const {
218     return started_;
219   }
220 
IsFinishedStarting()221   bool IsFinishedStarting() const {
222     return finished_starting_;
223   }
224 
Current()225   static Runtime* Current() {
226     return instance_;
227   }
228 
229   // Aborts semi-cleanly. Used in the implementation of LOG(FATAL), which most
230   // callers should prefer.
231   NO_RETURN static void Abort() REQUIRES(!Locks::abort_lock_);
232 
233   // Returns the "main" ThreadGroup, used when attaching user threads.
234   jobject GetMainThreadGroup() const;
235 
236   // Returns the "system" ThreadGroup, used when attaching our internal threads.
237   jobject GetSystemThreadGroup() const;
238 
239   // Returns the system ClassLoader which represents the CLASSPATH.
240   jobject GetSystemClassLoader() const;
241 
242   // Attaches the calling native thread to the runtime.
243   bool AttachCurrentThread(const char* thread_name, bool as_daemon, jobject thread_group,
244                            bool create_peer);
245 
246   void CallExitHook(jint status);
247 
248   // Detaches the current native thread from the runtime.
249   void DetachCurrentThread() REQUIRES(!Locks::mutator_lock_);
250 
251   void DumpForSigQuit(std::ostream& os);
252   void DumpLockHolders(std::ostream& os);
253 
254   ~Runtime();
255 
GetBootClassPathString()256   const std::string& GetBootClassPathString() const {
257     return boot_class_path_string_;
258   }
259 
GetClassPathString()260   const std::string& GetClassPathString() const {
261     return class_path_string_;
262   }
263 
GetClassLinker()264   ClassLinker* GetClassLinker() const {
265     return class_linker_;
266   }
267 
GetDefaultStackSize()268   size_t GetDefaultStackSize() const {
269     return default_stack_size_;
270   }
271 
GetHeap()272   gc::Heap* GetHeap() const {
273     return heap_;
274   }
275 
GetInternTable()276   InternTable* GetInternTable() const {
277     DCHECK(intern_table_ != nullptr);
278     return intern_table_;
279   }
280 
GetJavaVM()281   JavaVMExt* GetJavaVM() const {
282     return java_vm_;
283   }
284 
GetMaxSpinsBeforeThinkLockInflation()285   size_t GetMaxSpinsBeforeThinkLockInflation() const {
286     return max_spins_before_thin_lock_inflation_;
287   }
288 
GetMonitorList()289   MonitorList* GetMonitorList() const {
290     return monitor_list_;
291   }
292 
GetMonitorPool()293   MonitorPool* GetMonitorPool() const {
294     return monitor_pool_;
295   }
296 
297   // Is the given object the special object used to mark a cleared JNI weak global?
298   bool IsClearedJniWeakGlobal(mirror::Object* obj) SHARED_REQUIRES(Locks::mutator_lock_);
299 
300   // Get the special object used to mark a cleared JNI weak global.
301   mirror::Object* GetClearedJniWeakGlobal() SHARED_REQUIRES(Locks::mutator_lock_);
302 
303   mirror::Throwable* GetPreAllocatedOutOfMemoryError() SHARED_REQUIRES(Locks::mutator_lock_);
304 
305   mirror::Throwable* GetPreAllocatedNoClassDefFoundError()
306       SHARED_REQUIRES(Locks::mutator_lock_);
307 
GetProperties()308   const std::vector<std::string>& GetProperties() const {
309     return properties_;
310   }
311 
GetThreadList()312   ThreadList* GetThreadList() const {
313     return thread_list_;
314   }
315 
GetVersion()316   static const char* GetVersion() {
317     return "2.1.0";
318   }
319 
320   void DisallowNewSystemWeaks() SHARED_REQUIRES(Locks::mutator_lock_);
321   void AllowNewSystemWeaks() SHARED_REQUIRES(Locks::mutator_lock_);
322   void BroadcastForNewSystemWeaks() SHARED_REQUIRES(Locks::mutator_lock_);
323 
324   // Visit all the roots. If only_dirty is true then non-dirty roots won't be visited. If
325   // clean_dirty is true then dirty roots will be marked as non-dirty after visiting.
326   void VisitRoots(RootVisitor* visitor, VisitRootFlags flags = kVisitRootFlagAllRoots)
327       SHARED_REQUIRES(Locks::mutator_lock_);
328 
329   // Visit image roots, only used for hprof since the GC uses the image space mod union table
330   // instead.
331   void VisitImageRoots(RootVisitor* visitor) SHARED_REQUIRES(Locks::mutator_lock_);
332 
333   // Visit all of the roots we can do safely do concurrently.
334   void VisitConcurrentRoots(RootVisitor* visitor,
335                             VisitRootFlags flags = kVisitRootFlagAllRoots)
336       SHARED_REQUIRES(Locks::mutator_lock_);
337 
338   // Visit all of the non thread roots, we can do this with mutators unpaused.
339   void VisitNonThreadRoots(RootVisitor* visitor)
340       SHARED_REQUIRES(Locks::mutator_lock_);
341 
342   void VisitTransactionRoots(RootVisitor* visitor)
343       SHARED_REQUIRES(Locks::mutator_lock_);
344 
345   // Visit all of the thread roots.
346   void VisitThreadRoots(RootVisitor* visitor) SHARED_REQUIRES(Locks::mutator_lock_);
347 
348   // Flip thread roots from from-space refs to to-space refs.
349   size_t FlipThreadRoots(Closure* thread_flip_visitor, Closure* flip_callback,
350                          gc::collector::GarbageCollector* collector)
351       REQUIRES(!Locks::mutator_lock_);
352 
353   // Visit all other roots which must be done with mutators suspended.
354   void VisitNonConcurrentRoots(RootVisitor* visitor)
355       SHARED_REQUIRES(Locks::mutator_lock_);
356 
357   // Sweep system weaks, the system weak is deleted if the visitor return null. Otherwise, the
358   // system weak is updated to be the visitor's returned value.
359   void SweepSystemWeaks(IsMarkedVisitor* visitor)
360       SHARED_REQUIRES(Locks::mutator_lock_);
361 
362   // Constant roots are the roots which never change after the runtime is initialized, they only
363   // need to be visited once per GC cycle.
364   void VisitConstantRoots(RootVisitor* visitor)
365       SHARED_REQUIRES(Locks::mutator_lock_);
366 
367   // Returns a special method that calls into a trampoline for runtime method resolution
368   ArtMethod* GetResolutionMethod();
369 
HasResolutionMethod()370   bool HasResolutionMethod() const {
371     return resolution_method_ != nullptr;
372   }
373 
374   void SetResolutionMethod(ArtMethod* method) SHARED_REQUIRES(Locks::mutator_lock_);
375 
376   ArtMethod* CreateResolutionMethod() SHARED_REQUIRES(Locks::mutator_lock_);
377 
378   // Returns a special method that calls into a trampoline for runtime imt conflicts.
379   ArtMethod* GetImtConflictMethod();
380   ArtMethod* GetImtUnimplementedMethod();
381 
HasImtConflictMethod()382   bool HasImtConflictMethod() const {
383     return imt_conflict_method_ != nullptr;
384   }
385 
386   void FixupConflictTables();
387   void SetImtConflictMethod(ArtMethod* method) SHARED_REQUIRES(Locks::mutator_lock_);
388   void SetImtUnimplementedMethod(ArtMethod* method) SHARED_REQUIRES(Locks::mutator_lock_);
389 
390   ArtMethod* CreateImtConflictMethod(LinearAlloc* linear_alloc)
391       SHARED_REQUIRES(Locks::mutator_lock_);
392 
393   // Returns a special method that describes all callee saves being spilled to the stack.
394   enum CalleeSaveType {
395     kSaveAll,
396     kRefsOnly,
397     kRefsAndArgs,
398     kLastCalleeSaveType  // Value used for iteration
399   };
400 
HasCalleeSaveMethod(CalleeSaveType type)401   bool HasCalleeSaveMethod(CalleeSaveType type) const {
402     return callee_save_methods_[type] != 0u;
403   }
404 
405   ArtMethod* GetCalleeSaveMethod(CalleeSaveType type)
406       SHARED_REQUIRES(Locks::mutator_lock_);
407 
408   ArtMethod* GetCalleeSaveMethodUnchecked(CalleeSaveType type)
409       SHARED_REQUIRES(Locks::mutator_lock_);
410 
GetCalleeSaveMethodFrameInfo(CalleeSaveType type)411   QuickMethodFrameInfo GetCalleeSaveMethodFrameInfo(CalleeSaveType type) const {
412     return callee_save_method_frame_infos_[type];
413   }
414 
415   QuickMethodFrameInfo GetRuntimeMethodFrameInfo(ArtMethod* method)
416       SHARED_REQUIRES(Locks::mutator_lock_);
417 
GetCalleeSaveMethodOffset(CalleeSaveType type)418   static size_t GetCalleeSaveMethodOffset(CalleeSaveType type) {
419     return OFFSETOF_MEMBER(Runtime, callee_save_methods_[type]);
420   }
421 
GetInstructionSet()422   InstructionSet GetInstructionSet() const {
423     return instruction_set_;
424   }
425 
426   void SetInstructionSet(InstructionSet instruction_set);
427 
428   void SetCalleeSaveMethod(ArtMethod* method, CalleeSaveType type);
429 
430   ArtMethod* CreateCalleeSaveMethod() SHARED_REQUIRES(Locks::mutator_lock_);
431 
432   int32_t GetStat(int kind);
433 
GetStats()434   RuntimeStats* GetStats() {
435     return &stats_;
436   }
437 
HasStatsEnabled()438   bool HasStatsEnabled() const {
439     return stats_enabled_;
440   }
441 
442   void ResetStats(int kinds);
443 
444   void SetStatsEnabled(bool new_state)
445       REQUIRES(!Locks::instrument_entrypoints_lock_, !Locks::mutator_lock_);
446 
447   enum class NativeBridgeAction {  // private
448     kUnload,
449     kInitialize
450   };
451 
GetJit()452   jit::Jit* GetJit() {
453     return jit_.get();
454   }
455 
456   // Returns true if JIT compilations are enabled. GetJit() will be not null in this case.
457   bool UseJitCompilation() const;
458   // Returns true if profile saving is enabled. GetJit() will be not null in this case.
459   bool SaveProfileInfo() const;
460 
461   void PreZygoteFork();
462   bool InitZygote();
463   void InitNonZygoteOrPostFork(
464       JNIEnv* env, bool is_system_server, NativeBridgeAction action, const char* isa);
465 
GetInstrumentation()466   const instrumentation::Instrumentation* GetInstrumentation() const {
467     return &instrumentation_;
468   }
469 
GetInstrumentation()470   instrumentation::Instrumentation* GetInstrumentation() {
471     return &instrumentation_;
472   }
473 
474   void RegisterAppInfo(const std::vector<std::string>& code_paths,
475                        const std::string& profile_output_filename,
476                        const std::string& foreign_dex_profile_path,
477                        const std::string& app_dir);
478   void NotifyDexLoaded(const std::string& dex_location);
479 
480   // Transaction support.
IsActiveTransaction()481   bool IsActiveTransaction() const {
482     return preinitialization_transaction_ != nullptr;
483   }
484   void EnterTransactionMode(Transaction* transaction);
485   void ExitTransactionMode();
486   bool IsTransactionAborted() const;
487 
488   void AbortTransactionAndThrowAbortError(Thread* self, const std::string& abort_message)
489       SHARED_REQUIRES(Locks::mutator_lock_);
490   void ThrowTransactionAbortError(Thread* self)
491       SHARED_REQUIRES(Locks::mutator_lock_);
492 
493   void RecordWriteFieldBoolean(mirror::Object* obj, MemberOffset field_offset, uint8_t value,
494                                bool is_volatile) const;
495   void RecordWriteFieldByte(mirror::Object* obj, MemberOffset field_offset, int8_t value,
496                             bool is_volatile) const;
497   void RecordWriteFieldChar(mirror::Object* obj, MemberOffset field_offset, uint16_t value,
498                             bool is_volatile) const;
499   void RecordWriteFieldShort(mirror::Object* obj, MemberOffset field_offset, int16_t value,
500                           bool is_volatile) const;
501   void RecordWriteField32(mirror::Object* obj, MemberOffset field_offset, uint32_t value,
502                           bool is_volatile) const;
503   void RecordWriteField64(mirror::Object* obj, MemberOffset field_offset, uint64_t value,
504                           bool is_volatile) const;
505   void RecordWriteFieldReference(mirror::Object* obj, MemberOffset field_offset,
506                                  mirror::Object* value, bool is_volatile) const;
507   void RecordWriteArray(mirror::Array* array, size_t index, uint64_t value) const
508       SHARED_REQUIRES(Locks::mutator_lock_);
509   void RecordStrongStringInsertion(mirror::String* s) const
510       REQUIRES(Locks::intern_table_lock_);
511   void RecordWeakStringInsertion(mirror::String* s) const
512       REQUIRES(Locks::intern_table_lock_);
513   void RecordStrongStringRemoval(mirror::String* s) const
514       REQUIRES(Locks::intern_table_lock_);
515   void RecordWeakStringRemoval(mirror::String* s) const
516       REQUIRES(Locks::intern_table_lock_);
517 
518   void SetFaultMessage(const std::string& message) REQUIRES(!fault_message_lock_);
519   // Only read by the signal handler, NO_THREAD_SAFETY_ANALYSIS to prevent lock order violations
520   // with the unexpected_signal_lock_.
GetFaultMessage()521   const std::string& GetFaultMessage() NO_THREAD_SAFETY_ANALYSIS {
522     return fault_message_;
523   }
524 
525   void AddCurrentRuntimeFeaturesAsDex2OatArguments(std::vector<std::string>* arg_vector) const;
526 
ExplicitStackOverflowChecks()527   bool ExplicitStackOverflowChecks() const {
528     return !implicit_so_checks_;
529   }
530 
531   bool IsVerificationEnabled() const;
532   bool IsVerificationSoftFail() const;
533 
IsDexFileFallbackEnabled()534   bool IsDexFileFallbackEnabled() const {
535     return allow_dex_file_fallback_;
536   }
537 
GetCpuAbilist()538   const std::vector<std::string>& GetCpuAbilist() const {
539     return cpu_abilist_;
540   }
541 
IsRunningOnMemoryTool()542   bool IsRunningOnMemoryTool() const {
543     return is_running_on_memory_tool_;
544   }
545 
SetTargetSdkVersion(int32_t version)546   void SetTargetSdkVersion(int32_t version) {
547     target_sdk_version_ = version;
548   }
549 
GetTargetSdkVersion()550   int32_t GetTargetSdkVersion() const {
551     return target_sdk_version_;
552   }
553 
GetZygoteMaxFailedBoots()554   uint32_t GetZygoteMaxFailedBoots() const {
555     return zygote_max_failed_boots_;
556   }
557 
AreExperimentalFlagsEnabled(ExperimentalFlags flags)558   bool AreExperimentalFlagsEnabled(ExperimentalFlags flags) {
559     return (experimental_flags_ & flags) != ExperimentalFlags::kNone;
560   }
561 
GetLambdaBoxTable()562   lambda::BoxTable* GetLambdaBoxTable() const {
563     return lambda_box_table_.get();
564   }
565 
566   // Create the JIT and instrumentation and code cache.
567   void CreateJit();
568 
GetArenaPool()569   ArenaPool* GetArenaPool() {
570     return arena_pool_.get();
571   }
GetJitArenaPool()572   ArenaPool* GetJitArenaPool() {
573     return jit_arena_pool_.get();
574   }
GetArenaPool()575   const ArenaPool* GetArenaPool() const {
576     return arena_pool_.get();
577   }
578 
579   void ReclaimArenaPoolMemory();
580 
GetLinearAlloc()581   LinearAlloc* GetLinearAlloc() {
582     return linear_alloc_.get();
583   }
584 
GetJITOptions()585   jit::JitOptions* GetJITOptions() {
586     return jit_options_.get();
587   }
588 
589   bool IsDebuggable() const;
590 
IsNativeDebuggable()591   bool IsNativeDebuggable() const {
592     return is_native_debuggable_;
593   }
594 
SetNativeDebuggable(bool value)595   void SetNativeDebuggable(bool value) {
596     is_native_debuggable_ = value;
597   }
598 
599   // Returns the build fingerprint, if set. Otherwise an empty string is returned.
GetFingerprint()600   std::string GetFingerprint() {
601     return fingerprint_;
602   }
603 
604   // Called from class linker.
605   void SetSentinel(mirror::Object* sentinel) SHARED_REQUIRES(Locks::mutator_lock_);
606 
607   // Create a normal LinearAlloc or low 4gb version if we are 64 bit AOT compiler.
608   LinearAlloc* CreateLinearAlloc();
609 
GetOatFileManager()610   OatFileManager& GetOatFileManager() const {
611     DCHECK(oat_file_manager_ != nullptr);
612     return *oat_file_manager_;
613   }
614 
615   double GetHashTableMinLoadFactor() const;
616   double GetHashTableMaxLoadFactor() const;
617 
SetSafeMode(bool mode)618   void SetSafeMode(bool mode) {
619     safe_mode_ = mode;
620   }
621 
GetDumpNativeStackOnSigQuit()622   bool GetDumpNativeStackOnSigQuit() const {
623     return dump_native_stack_on_sig_quit_;
624   }
625 
GetPrunedDalvikCache()626   bool GetPrunedDalvikCache() const {
627     return pruned_dalvik_cache_;
628   }
629 
SetPrunedDalvikCache(bool pruned)630   void SetPrunedDalvikCache(bool pruned) {
631     pruned_dalvik_cache_ = pruned;
632   }
633 
634   void UpdateProcessState(ProcessState process_state);
635 
636   // Returns true if we currently care about long mutator pause.
InJankPerceptibleProcessState()637   bool InJankPerceptibleProcessState() const {
638     return process_state_ == kProcessStateJankPerceptible;
639   }
640 
641   void RegisterSensitiveThread() const;
642 
SetZygoteNoThreadSection(bool val)643   void SetZygoteNoThreadSection(bool val) {
644     zygote_no_threads_ = val;
645   }
646 
IsZygoteNoThreadSection()647   bool IsZygoteNoThreadSection() const {
648     return zygote_no_threads_;
649   }
650 
651  private:
652   static void InitPlatformSignalHandlers();
653 
654   Runtime();
655 
656   void BlockSignals();
657 
658   bool Init(RuntimeArgumentMap&& runtime_options)
659       SHARED_TRYLOCK_FUNCTION(true, Locks::mutator_lock_);
660   void InitNativeMethods() REQUIRES(!Locks::mutator_lock_);
661   void InitThreadGroups(Thread* self);
662   void RegisterRuntimeNativeMethods(JNIEnv* env);
663 
664   void StartDaemonThreads();
665   void StartSignalCatcher();
666 
667   void MaybeSaveJitProfilingInfo();
668 
669   // A pointer to the active runtime or null.
670   static Runtime* instance_;
671 
672   // NOTE: these must match the gc::ProcessState values as they come directly from the framework.
673   static constexpr int kProfileForground = 0;
674   static constexpr int kProfileBackground = 1;
675 
676   // 64 bit so that we can share the same asm offsets for both 32 and 64 bits.
677   uint64_t callee_save_methods_[kLastCalleeSaveType];
678   GcRoot<mirror::Throwable> pre_allocated_OutOfMemoryError_;
679   GcRoot<mirror::Throwable> pre_allocated_NoClassDefFoundError_;
680   ArtMethod* resolution_method_;
681   ArtMethod* imt_conflict_method_;
682   // Unresolved method has the same behavior as the conflict method, it is used by the class linker
683   // for differentiating between unfilled imt slots vs conflict slots in superclasses.
684   ArtMethod* imt_unimplemented_method_;
685 
686   // Special sentinel object used to invalid conditions in JNI (cleared weak references) and
687   // JDWP (invalid references).
688   GcRoot<mirror::Object> sentinel_;
689 
690   InstructionSet instruction_set_;
691   QuickMethodFrameInfo callee_save_method_frame_infos_[kLastCalleeSaveType];
692 
693   CompilerCallbacks* compiler_callbacks_;
694   bool is_zygote_;
695   bool must_relocate_;
696   bool is_concurrent_gc_enabled_;
697   bool is_explicit_gc_disabled_;
698   bool dex2oat_enabled_;
699   bool image_dex2oat_enabled_;
700 
701   std::string compiler_executable_;
702   std::string patchoat_executable_;
703   std::vector<std::string> compiler_options_;
704   std::vector<std::string> image_compiler_options_;
705   std::string image_location_;
706 
707   std::string boot_class_path_string_;
708   std::string class_path_string_;
709   std::vector<std::string> properties_;
710 
711   // The default stack size for managed threads created by the runtime.
712   size_t default_stack_size_;
713 
714   gc::Heap* heap_;
715 
716   std::unique_ptr<ArenaPool> jit_arena_pool_;
717   std::unique_ptr<ArenaPool> arena_pool_;
718   // Special low 4gb pool for compiler linear alloc. We need ArtFields to be in low 4gb if we are
719   // compiling using a 32 bit image on a 64 bit compiler in case we resolve things in the image
720   // since the field arrays are int arrays in this case.
721   std::unique_ptr<ArenaPool> low_4gb_arena_pool_;
722 
723   // Shared linear alloc for now.
724   std::unique_ptr<LinearAlloc> linear_alloc_;
725 
726   // The number of spins that are done before thread suspension is used to forcibly inflate.
727   size_t max_spins_before_thin_lock_inflation_;
728   MonitorList* monitor_list_;
729   MonitorPool* monitor_pool_;
730 
731   ThreadList* thread_list_;
732 
733   InternTable* intern_table_;
734 
735   ClassLinker* class_linker_;
736 
737   SignalCatcher* signal_catcher_;
738   std::string stack_trace_file_;
739 
740   JavaVMExt* java_vm_;
741 
742   std::unique_ptr<jit::Jit> jit_;
743   std::unique_ptr<jit::JitOptions> jit_options_;
744 
745   std::unique_ptr<lambda::BoxTable> lambda_box_table_;
746 
747   // Fault message, printed when we get a SIGSEGV.
748   Mutex fault_message_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER;
749   std::string fault_message_ GUARDED_BY(fault_message_lock_);
750 
751   // A non-zero value indicates that a thread has been created but not yet initialized. Guarded by
752   // the shutdown lock so that threads aren't born while we're shutting down.
753   size_t threads_being_born_ GUARDED_BY(Locks::runtime_shutdown_lock_);
754 
755   // Waited upon until no threads are being born.
756   std::unique_ptr<ConditionVariable> shutdown_cond_ GUARDED_BY(Locks::runtime_shutdown_lock_);
757 
758   // Set when runtime shutdown is past the point that new threads may attach.
759   bool shutting_down_ GUARDED_BY(Locks::runtime_shutdown_lock_);
760 
761   // The runtime is starting to shutdown but is blocked waiting on shutdown_cond_.
762   bool shutting_down_started_ GUARDED_BY(Locks::runtime_shutdown_lock_);
763 
764   bool started_;
765 
766   // New flag added which tells us if the runtime has finished starting. If
767   // this flag is set then the Daemon threads are created and the class loader
768   // is created. This flag is needed for knowing if its safe to request CMS.
769   bool finished_starting_;
770 
771   // Hooks supported by JNI_CreateJavaVM
772   jint (*vfprintf_)(FILE* stream, const char* format, va_list ap);
773   void (*exit_)(jint status);
774   void (*abort_)();
775 
776   bool stats_enabled_;
777   RuntimeStats stats_;
778 
779   const bool is_running_on_memory_tool_;
780 
781   std::string profile_output_filename_;
782   ProfilerOptions profiler_options_;
783 
784   std::unique_ptr<TraceConfig> trace_config_;
785 
786   instrumentation::Instrumentation instrumentation_;
787 
788   jobject main_thread_group_;
789   jobject system_thread_group_;
790 
791   // As returned by ClassLoader.getSystemClassLoader().
792   jobject system_class_loader_;
793 
794   // If true, then we dump the GC cumulative timings on shutdown.
795   bool dump_gc_performance_on_shutdown_;
796 
797   // Transaction used for pre-initializing classes at compilation time.
798   Transaction* preinitialization_transaction_;
799 
800   // If kNone, verification is disabled. kEnable by default.
801   verifier::VerifyMode verify_;
802 
803   // If true, the runtime may use dex files directly with the interpreter if an oat file is not
804   // available/usable.
805   bool allow_dex_file_fallback_;
806 
807   // List of supported cpu abis.
808   std::vector<std::string> cpu_abilist_;
809 
810   // Specifies target SDK version to allow workarounds for certain API levels.
811   int32_t target_sdk_version_;
812 
813   // Implicit checks flags.
814   bool implicit_null_checks_;       // NullPointer checks are implicit.
815   bool implicit_so_checks_;         // StackOverflow checks are implicit.
816   bool implicit_suspend_checks_;    // Thread suspension checks are implicit.
817 
818   // Whether or not the sig chain (and implicitly the fault handler) should be
819   // disabled. Tools like dex2oat or patchoat don't need them. This enables
820   // building a statically link version of dex2oat.
821   bool no_sig_chain_;
822 
823   // Force the use of native bridge even if the app ISA matches the runtime ISA.
824   bool force_native_bridge_;
825 
826   // Whether or not a native bridge has been loaded.
827   //
828   // The native bridge allows running native code compiled for a foreign ISA. The way it works is,
829   // if standard dlopen fails to load native library associated with native activity, it calls to
830   // the native bridge to load it and then gets the trampoline for the entry to native activity.
831   //
832   // The option 'native_bridge_library_filename' specifies the name of the native bridge.
833   // When non-empty the native bridge will be loaded from the given file. An empty value means
834   // that there's no native bridge.
835   bool is_native_bridge_loaded_;
836 
837   // Whether we are running under native debugger.
838   bool is_native_debuggable_;
839 
840   // The maximum number of failed boots we allow before pruning the dalvik cache
841   // and trying again. This option is only inspected when we're running as a
842   // zygote.
843   uint32_t zygote_max_failed_boots_;
844 
845   // Enable experimental opcodes that aren't fully specified yet. The intent is to
846   // eventually publish them as public-usable opcodes, but they aren't ready yet.
847   //
848   // Experimental opcodes should not be used by other production code.
849   ExperimentalFlags experimental_flags_;
850 
851   // Contains the build fingerprint, if given as a parameter.
852   std::string fingerprint_;
853 
854   // Oat file manager, keeps track of what oat files are open.
855   OatFileManager* oat_file_manager_;
856 
857   // Whether or not we are on a low RAM device.
858   bool is_low_memory_mode_;
859 
860   // Whether the application should run in safe mode, that is, interpreter only.
861   bool safe_mode_;
862 
863   // Whether threads should dump their native stack on SIGQUIT.
864   bool dump_native_stack_on_sig_quit_;
865 
866   // Whether the dalvik cache was pruned when initializing the runtime.
867   bool pruned_dalvik_cache_;
868 
869   // Whether or not we currently care about pause times.
870   ProcessState process_state_;
871 
872   // Whether zygote code is in a section that should not start threads.
873   bool zygote_no_threads_;
874 
875   DISALLOW_COPY_AND_ASSIGN(Runtime);
876 };
877 std::ostream& operator<<(std::ostream& os, const Runtime::CalleeSaveType& rhs);
878 
879 }  // namespace art
880 
881 #endif  // ART_RUNTIME_RUNTIME_H_
882