Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2015 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 ANDROID_RENDERSCRIPT_EXECUTABLE_H |
| 18 | #define ANDROID_RENDERSCRIPT_EXECUTABLE_H |
| 19 | |
| 20 | #include <stdlib.h> |
| 21 | |
| 22 | #include "rsCpuScript.h" |
| 23 | |
| 24 | namespace android { |
| 25 | namespace renderscript { |
| 26 | |
| 27 | class Context; |
| 28 | |
| 29 | class SharedLibraryUtils { |
| 30 | public: |
| 31 | #ifndef RS_COMPATIBILITY_LIB |
Stephen Hines | 4c368af | 2015-05-06 00:43:02 -0700 | [diff] [blame] | 32 | static bool createSharedLibrary(const char* driverName, |
| 33 | const char* cacheDir, |
| 34 | const char* resName); |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 35 | #endif |
| 36 | |
| 37 | // Load the shared library referred to by cacheDir and resName. If we have |
| 38 | // already loaded this library, we instead create a new copy (in the |
| 39 | // cache dir) and then load that. We then immediately destroy the copy. |
| 40 | // This is required behavior to implement script instancing for the support |
| 41 | // library, since shared objects are loaded and de-duped by name only. |
| 42 | |
| 43 | // For 64bit RS Support Lib, the shared lib path cannot be constructed from |
| 44 | // cacheDir, so nativeLibDir is needed to load shared libs. |
| 45 | static void* loadSharedLibrary(const char *cacheDir, const char *resName, |
Yang Ni | 1efae29 | 2015-06-27 15:45:18 -0700 | [diff] [blame] | 46 | const char *nativeLibDir = nullptr, |
| 47 | bool *alreadyLoaded = nullptr); |
| 48 | |
| 49 | // Create a len length string containing random characters from [A-Za-z0-9]. |
| 50 | static String8 getRandomString(size_t len); |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 51 | |
| 52 | private: |
| 53 | // Attempt to load the shared library from origName, but then fall back to |
| 54 | // creating a copy of the shared library if necessary (to ensure instancing). |
| 55 | // This function returns the dlopen()-ed handle if successful. |
| 56 | static void *loadSOHelper(const char *origName, const char *cacheDir, |
Yang Ni | 1efae29 | 2015-06-27 15:45:18 -0700 | [diff] [blame] | 57 | const char *resName, bool* alreadyLoaded = nullptr); |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 58 | |
| 59 | static const char* LD_EXE_PATH; |
| 60 | static const char* RS_CACHE_DIR; |
| 61 | }; |
| 62 | |
| 63 | class ScriptExecutable { |
| 64 | public: |
| 65 | ScriptExecutable(Context* RSContext, |
Yang Ni | 062c287 | 2015-02-20 15:20:00 -0800 | [diff] [blame] | 66 | void** fieldAddress, bool* fieldIsObject, |
| 67 | const char* const * fieldName, size_t varCount, |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 68 | InvokeFunc_t* invokeFunctions, size_t funcCount, |
| 69 | ForEachFunc_t* forEachFunctions, uint32_t* forEachSignatures, |
| 70 | size_t forEachCount, |
Matt Wala | 14ce007 | 2015-07-30 17:30:25 -0700 | [diff] [blame] | 71 | ReduceFunc_t* reduceFunctions, size_t reduceCount, |
Yang Ni | 062c287 | 2015-02-20 15:20:00 -0800 | [diff] [blame] | 72 | const char** pragmaKeys, const char** pragmaValues, |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 73 | size_t pragmaCount, |
Stephen Hines | 8409d64 | 2015-04-28 18:49:56 -0700 | [diff] [blame] | 74 | const char **globalNames, const void **globalAddresses, |
Stephen Hines | 5aa018c | 2015-05-20 18:09:57 -0700 | [diff] [blame] | 75 | const size_t *globalSizes, |
| 76 | const uint32_t *globalProperties, size_t globalEntries, |
Yang Ni | cb17015 | 2015-04-16 10:27:02 -0700 | [diff] [blame] | 77 | bool isThreadable, uint32_t buildChecksum) : |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 78 | mFieldAddress(fieldAddress), mFieldIsObject(fieldIsObject), |
Yang Ni | 062c287 | 2015-02-20 15:20:00 -0800 | [diff] [blame] | 79 | mFieldName(fieldName), mExportedVarCount(varCount), |
| 80 | mInvokeFunctions(invokeFunctions), mFuncCount(funcCount), |
| 81 | mForEachFunctions(forEachFunctions), mForEachSignatures(forEachSignatures), |
| 82 | mForEachCount(forEachCount), |
Matt Wala | 14ce007 | 2015-07-30 17:30:25 -0700 | [diff] [blame] | 83 | mReduceFunctions(reduceFunctions), mReduceCount(reduceCount), |
Yang Ni | 062c287 | 2015-02-20 15:20:00 -0800 | [diff] [blame] | 84 | mPragmaKeys(pragmaKeys), mPragmaValues(pragmaValues), |
Stephen Hines | 8409d64 | 2015-04-28 18:49:56 -0700 | [diff] [blame] | 85 | mPragmaCount(pragmaCount), mGlobalNames(globalNames), |
| 86 | mGlobalAddresses(globalAddresses), mGlobalSizes(globalSizes), |
Stephen Hines | 5aa018c | 2015-05-20 18:09:57 -0700 | [diff] [blame] | 87 | mGlobalProperties(globalProperties), mGlobalEntries(globalEntries), |
| 88 | mIsThreadable(isThreadable), mBuildChecksum(buildChecksum), |
| 89 | mRS(RSContext) { |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 90 | } |
| 91 | |
| 92 | ~ScriptExecutable() { |
| 93 | for (size_t i = 0; i < mExportedVarCount; ++i) { |
| 94 | if (mFieldIsObject[i]) { |
| 95 | if (mFieldAddress[i] != nullptr) { |
| 96 | rs_object_base *obj_addr = |
| 97 | reinterpret_cast<rs_object_base *>(mFieldAddress[i]); |
| 98 | rsrClearObject(mRS, obj_addr); |
| 99 | } |
| 100 | } |
| 101 | } |
| 102 | |
| 103 | for (size_t i = 0; i < mPragmaCount; ++i) { |
| 104 | delete [] mPragmaKeys[i]; |
| 105 | delete [] mPragmaValues[i]; |
| 106 | } |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 107 | delete[] mPragmaValues; |
| 108 | delete[] mPragmaKeys; |
Yang Ni | 062c287 | 2015-02-20 15:20:00 -0800 | [diff] [blame] | 109 | |
Matt Wala | 14ce007 | 2015-07-30 17:30:25 -0700 | [diff] [blame] | 110 | delete[] mReduceFunctions; |
| 111 | |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 112 | delete[] mForEachSignatures; |
| 113 | delete[] mForEachFunctions; |
Yang Ni | 062c287 | 2015-02-20 15:20:00 -0800 | [diff] [blame] | 114 | |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 115 | delete[] mInvokeFunctions; |
Yang Ni | 062c287 | 2015-02-20 15:20:00 -0800 | [diff] [blame] | 116 | |
| 117 | for (size_t i = 0; i < mExportedVarCount; i++) { |
| 118 | delete[] mFieldName[i]; |
| 119 | } |
| 120 | delete[] mFieldName; |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 121 | delete[] mFieldIsObject; |
| 122 | delete[] mFieldAddress; |
| 123 | } |
| 124 | |
Yang Ni | cb17015 | 2015-04-16 10:27:02 -0700 | [diff] [blame] | 125 | // Create an ScriptExecutable object from a shared object. |
| 126 | // If expectedChecksum is not zero, it will be compared to the checksum |
| 127 | // embedded in the shared object. A mismatch will cause a failure. |
| 128 | // If succeeded, returns the new object. Otherwise, returns nullptr. |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 129 | static ScriptExecutable* |
Yang Ni | cb17015 | 2015-04-16 10:27:02 -0700 | [diff] [blame] | 130 | createFromSharedObject(Context* RSContext, void* sharedObj, |
| 131 | uint32_t expectedChecksum = 0); |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 132 | |
| 133 | size_t getExportedVariableCount() const { return mExportedVarCount; } |
| 134 | size_t getExportedFunctionCount() const { return mFuncCount; } |
| 135 | size_t getExportedForEachCount() const { return mForEachCount; } |
Matt Wala | 14ce007 | 2015-07-30 17:30:25 -0700 | [diff] [blame] | 136 | size_t getExportedReduceCount() const { return mReduceCount; } |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 137 | size_t getPragmaCount() const { return mPragmaCount; } |
| 138 | |
| 139 | void* getFieldAddress(int slot) const { return mFieldAddress[slot]; } |
Yang Ni | 062c287 | 2015-02-20 15:20:00 -0800 | [diff] [blame] | 140 | void* getFieldAddress(const char* name) const; |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 141 | bool getFieldIsObject(int slot) const { return mFieldIsObject[slot]; } |
Yang Ni | 062c287 | 2015-02-20 15:20:00 -0800 | [diff] [blame] | 142 | const char* getFieldName(int slot) const { return mFieldName[slot]; } |
| 143 | |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 144 | InvokeFunc_t getInvokeFunction(int slot) const { return mInvokeFunctions[slot]; } |
Yang Ni | 062c287 | 2015-02-20 15:20:00 -0800 | [diff] [blame] | 145 | |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 146 | ForEachFunc_t getForEachFunction(int slot) const { return mForEachFunctions[slot]; } |
| 147 | uint32_t getForEachSignature(int slot) const { return mForEachSignatures[slot]; } |
| 148 | |
Matt Wala | 14ce007 | 2015-07-30 17:30:25 -0700 | [diff] [blame] | 149 | ReduceFunc_t getReduceFunction(int slot) const { return mReduceFunctions[slot]; } |
| 150 | |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 151 | const char ** getPragmaKeys() const { return mPragmaKeys; } |
| 152 | const char ** getPragmaValues() const { return mPragmaValues; } |
| 153 | |
Stephen Hines | 8409d64 | 2015-04-28 18:49:56 -0700 | [diff] [blame] | 154 | const char* getGlobalName(int i) const { |
| 155 | if (i < mGlobalEntries) { |
| 156 | return mGlobalNames[i]; |
| 157 | } else { |
| 158 | return nullptr; |
| 159 | } |
| 160 | } |
| 161 | const void* getGlobalAddress(int i) const { |
| 162 | if (i < mGlobalEntries) { |
| 163 | return mGlobalAddresses[i]; |
| 164 | } else { |
| 165 | return nullptr; |
| 166 | } |
| 167 | } |
| 168 | size_t getGlobalSize(int i) const { |
| 169 | if (i < mGlobalEntries) { |
| 170 | return mGlobalSizes[i]; |
| 171 | } else { |
| 172 | return 0; |
| 173 | } |
| 174 | } |
Stephen Hines | 5aa018c | 2015-05-20 18:09:57 -0700 | [diff] [blame] | 175 | uint32_t getGlobalProperties(int i) const { |
| 176 | if (i < mGlobalEntries) { |
| 177 | return mGlobalProperties[i]; |
| 178 | } else { |
| 179 | return 0; |
| 180 | } |
| 181 | } |
Stephen Hines | 8409d64 | 2015-04-28 18:49:56 -0700 | [diff] [blame] | 182 | int getGlobalEntries() const { return mGlobalEntries; } |
| 183 | |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 184 | bool getThreadable() const { return mIsThreadable; } |
| 185 | |
Yang Ni | cb17015 | 2015-04-16 10:27:02 -0700 | [diff] [blame] | 186 | uint32_t getBuildChecksum() const { return mBuildChecksum; } |
Pirama Arumuga Nainar | aa6757f | 2015-02-13 20:02:50 -0800 | [diff] [blame] | 187 | |
Stephen Hines | 8409d64 | 2015-04-28 18:49:56 -0700 | [diff] [blame] | 188 | bool dumpGlobalInfo() const; |
| 189 | |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 190 | private: |
| 191 | void** mFieldAddress; |
| 192 | bool* mFieldIsObject; |
Yang Ni | 062c287 | 2015-02-20 15:20:00 -0800 | [diff] [blame] | 193 | const char* const * mFieldName; |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 194 | size_t mExportedVarCount; |
| 195 | |
| 196 | InvokeFunc_t* mInvokeFunctions; |
| 197 | size_t mFuncCount; |
| 198 | |
| 199 | ForEachFunc_t* mForEachFunctions; |
| 200 | uint32_t* mForEachSignatures; |
| 201 | size_t mForEachCount; |
| 202 | |
Matt Wala | 14ce007 | 2015-07-30 17:30:25 -0700 | [diff] [blame] | 203 | ReduceFunc_t* mReduceFunctions; |
| 204 | size_t mReduceCount; |
| 205 | |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 206 | const char ** mPragmaKeys; |
| 207 | const char ** mPragmaValues; |
| 208 | size_t mPragmaCount; |
| 209 | |
Stephen Hines | 8409d64 | 2015-04-28 18:49:56 -0700 | [diff] [blame] | 210 | const char ** mGlobalNames; |
| 211 | const void ** mGlobalAddresses; |
| 212 | const size_t * mGlobalSizes; |
Stephen Hines | 5aa018c | 2015-05-20 18:09:57 -0700 | [diff] [blame] | 213 | const uint32_t * mGlobalProperties; |
Stephen Hines | 8409d64 | 2015-04-28 18:49:56 -0700 | [diff] [blame] | 214 | int mGlobalEntries; |
| 215 | |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 216 | bool mIsThreadable; |
Yang Ni | cb17015 | 2015-04-16 10:27:02 -0700 | [diff] [blame] | 217 | uint32_t mBuildChecksum; |
Yang Ni | 2abfcc6 | 2015-02-17 16:05:19 -0800 | [diff] [blame] | 218 | |
| 219 | Context* mRS; |
| 220 | }; |
| 221 | |
| 222 | } // namespace renderscript |
| 223 | } // namespace android |
| 224 | |
| 225 | #endif // ANDROID_RENDERSCRIPT_EXECUTABLE_H |