Home | History | Annotate | Download | only in android_runtime
      1 /*
      2  * Copyright (C) 2005 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 
     19 #ifndef _RUNTIME_ANDROID_RUNTIME_H
     20 #define _RUNTIME_ANDROID_RUNTIME_H
     21 
     22 #include <utils/Errors.h>
     23 #include <binder/IBinder.h>
     24 #include <utils/String8.h>
     25 #include <utils/String16.h>
     26 #include <utils/Vector.h>
     27 #include <utils/threads.h>
     28 #include <pthread.h>
     29 #include <jni.h>
     30 
     31 
     32 namespace android {
     33 
     34 class AndroidRuntime
     35 {
     36 public:
     37     AndroidRuntime(char* argBlockStart, size_t argBlockSize);
     38     virtual ~AndroidRuntime();
     39 
     40     enum StartMode {
     41         Zygote,
     42         SystemServer,
     43         Application,
     44         Tool,
     45     };
     46 
     47     void setArgv0(const char* argv0, bool setProcName = false);
     48     void addOption(const char* optionString, void* extra_info = NULL);
     49 
     50     /**
     51      * Register a set of methods in the specified class.
     52      */
     53     static int registerNativeMethods(JNIEnv* env,
     54         const char* className, const JNINativeMethod* gMethods, int numMethods);
     55 
     56     /**
     57      * Call a class's static main method with the given arguments,
     58      */
     59     status_t callMain(const String8& className, jclass clazz, const Vector<String8>& args);
     60 
     61     /**
     62      * Find a class, with the input either of the form
     63      * "package/class" or "package.class".
     64      */
     65     static jclass findClass(JNIEnv* env, const char* className);
     66 
     67     void start(const char *classname, const Vector<String8>& options, bool zygote);
     68 
     69     void exit(int code);
     70 
     71     void setExitWithoutCleanup(bool exitWithoutCleanup) {
     72         mExitWithoutCleanup = exitWithoutCleanup;
     73     }
     74 
     75     static AndroidRuntime* getRuntime();
     76 
     77     /**
     78      * This gets called after the VM has been created, but before we
     79      * run any code. Override it to make any FindClass calls that need
     80      * to use CLASSPATH.
     81      */
     82     virtual void onVmCreated(JNIEnv* env);
     83 
     84     /**
     85      * This gets called after the JavaVM has initialized.  Override it
     86      * with the system's native entry point.
     87      */
     88     virtual void onStarted() = 0;
     89 
     90     /**
     91      * This gets called after the JavaVM has initialized after a Zygote
     92      * fork. Override it to initialize threads, etc. Upon return, the
     93      * correct static main will be invoked.
     94      */
     95     virtual void onZygoteInit() { }
     96 
     97     /**
     98      * Called when the Java application exits to perform additional cleanup actions
     99      * before the process is terminated.
    100      */
    101     virtual void onExit(int /*code*/) { }
    102 
    103     /** create a new thread that is visible from Java */
    104     static android_thread_id_t createJavaThread(const char* name, void (*start)(void *),
    105         void* arg);
    106 
    107     /** return a pointer to the VM running in this process */
    108     static JavaVM* getJavaVM() { return mJavaVM; }
    109 
    110     /** return a pointer to the JNIEnv pointer for this thread */
    111     static JNIEnv* getJNIEnv();
    112 
    113     /** return a new string corresponding to 'className' with all '.'s replaced by '/'s. */
    114     static char* toSlashClassName(const char* className);
    115 
    116     /** Create a Java string from an ASCII or Latin-1 string */
    117     static jstring NewStringLatin1(JNIEnv* env, const char* bytes);
    118 
    119 private:
    120     static int startReg(JNIEnv* env);
    121     bool parseRuntimeOption(const char* property,
    122                             char* buffer,
    123                             const char* runtimeArg,
    124                             const char* defaultArg = "");
    125     bool parseCompilerOption(const char* property,
    126                              char* buffer,
    127                              const char* compilerArg,
    128                              const char* quotingArg);
    129     bool parseCompilerRuntimeOption(const char* property,
    130                                     char* buffer,
    131                                     const char* runtimeArg,
    132                                     const char* quotingArg);
    133     void parseExtraOpts(char* extraOptsBuf, const char* quotingArg);
    134     int startVm(JavaVM** pJavaVM, JNIEnv** pEnv, bool zygote);
    135 
    136     Vector<JavaVMOption> mOptions;
    137     bool mExitWithoutCleanup;
    138     char* const mArgBlockStart;
    139     const size_t mArgBlockLength;
    140 
    141     /* JNI JavaVM pointer */
    142     static JavaVM* mJavaVM;
    143 
    144     /*
    145      * Thread creation helpers.
    146      */
    147     static int javaCreateThreadEtc(
    148                                 android_thread_func_t entryFunction,
    149                                 void* userData,
    150                                 const char* threadName,
    151                                 int32_t threadPriority,
    152                                 size_t threadStackSize,
    153                                 android_thread_id_t* threadId);
    154     static int javaThreadShell(void* args);
    155 };
    156 
    157 }
    158 
    159 #endif
    160