rsCpuScript.h revision da0f069871343119251d6b0586be356dc2146a62 
1/*
2 * Copyright (C) 2011-2012 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 RSD_BCC_H
18#define RSD_BCC_H
19
20#include <rs_hal.h>
21#include <rsRuntime.h>
22
23#ifndef RS_COMPATIBILITY_LIB
24#include <utility>
25#endif
26
27#include "rsCpuCore.h"
28
29#include <vector>
30
31namespace bcc {
32    class BCCContext;
33    class RSCompilerDriver;
34}
35
36namespace bcinfo {
37    class MetadataExtractor;
38}
39
40namespace android {
41namespace renderscript {
42
43class SharedLibraryUtils {
44 public:
45#ifndef RS_COMPATIBILITY_LIB
46  static bool createSharedLibrary(const char* cacheDir, const char* resName);
47#endif
48
49  // Load the shared library referred to by cacheDir and resName. If we have
50  // already loaded this library, we instead create a new copy (in the
51  // cache dir) and then load that. We then immediately destroy the copy.
52  // This is required behavior to implement script instancing for the support
53  // library, since shared objects are loaded and de-duped by name only.
54  static void* loadSharedLibrary(const char* cacheDir, const char* resName);
55
56 private:
57  // Attempt to load the shared library from origName, but then fall back to
58  // creating a copy of the shared library if necessary (to ensure instancing).
59  // This function returns the dlopen()-ed handle if successful.
60  static void *loadSOHelper(const char *origName, const char *cacheDir,
61                            const char *resName);
62
63  static const char* LD_EXE_PATH;
64  static const char* RS_CACHE_DIR;
65};
66
67class ScriptExecutable {
68 public:
69  ScriptExecutable(Context* RSContext,
70                   void** fieldAddress, bool* fieldIsObject, size_t varCount,
71                   InvokeFunc_t* invokeFunctions, size_t funcCount,
72                   ForEachFunc_t* forEachFunctions, uint32_t* forEachSignatures,
73                   size_t forEachCount,
74                   const char ** pragmaKeys, const char ** pragmaValues,
75                   size_t pragmaCount,
76                   bool isThreadable) :
77      mFieldAddress(fieldAddress), mFieldIsObject(fieldIsObject),
78      mExportedVarCount(varCount),
79      mInvokeFunctions(invokeFunctions), mFuncCount(funcCount),
80      mForEachFunctions(forEachFunctions), mForEachSignatures(forEachSignatures),
81      mForEachCount(forEachCount),
82      mPragmaKeys(pragmaKeys), mPragmaValues(pragmaValues),
83      mPragmaCount(pragmaCount),
84      mIsThreadable(isThreadable), mRS(RSContext) {
85  }
86
87  ~ScriptExecutable() {
88      for (size_t i = 0; i < mExportedVarCount; ++i) {
89          if (mFieldIsObject[i]) {
90              if (mFieldAddress[i] != nullptr) {
91                  rs_object_base *obj_addr =
92                      reinterpret_cast<rs_object_base *>(mFieldAddress[i]);
93                  rsrClearObject(mRS, obj_addr);
94              }
95          }
96      }
97
98      for (size_t i = 0; i < mPragmaCount; ++i) {
99          delete [] mPragmaKeys[i];
100          delete [] mPragmaValues[i];
101      }
102
103      delete[] mPragmaValues;
104      delete[] mPragmaKeys;
105      delete[] mForEachSignatures;
106      delete[] mForEachFunctions;
107      delete[] mInvokeFunctions;
108      delete[] mFieldIsObject;
109      delete[] mFieldAddress;
110  }
111
112  static ScriptExecutable*
113  createFromSharedObject(Context* RSContext, void* sharedObj);
114
115  size_t getExportedVariableCount() const { return mExportedVarCount; }
116  size_t getExportedFunctionCount() const { return mFuncCount; }
117  size_t getExportedForEachCount() const { return mForEachCount; }
118  size_t getPragmaCount() const { return mPragmaCount; }
119
120  void* getFieldAddress(int slot) const { return mFieldAddress[slot]; }
121  bool getFieldIsObject(int slot) const { return mFieldIsObject[slot]; }
122  InvokeFunc_t getInvokeFunction(int slot) const { return mInvokeFunctions[slot]; }
123  ForEachFunc_t getForEachFunction(int slot) const { return mForEachFunctions[slot]; }
124  uint32_t getForEachSignature(int slot) const { return mForEachSignatures[slot]; }
125
126  const char ** getPragmaKeys() const { return mPragmaKeys; }
127  const char ** getPragmaValues() const { return mPragmaValues; }
128
129  bool getThreadable() const { return mIsThreadable; }
130
131 private:
132  void** mFieldAddress;
133  bool* mFieldIsObject;
134  size_t mExportedVarCount;
135
136  InvokeFunc_t* mInvokeFunctions;
137  size_t mFuncCount;
138
139  ForEachFunc_t* mForEachFunctions;
140  uint32_t* mForEachSignatures;
141  size_t mForEachCount;
142
143  const char ** mPragmaKeys;
144  const char ** mPragmaValues;
145  size_t mPragmaCount;
146
147  bool mIsThreadable;
148
149  Context* mRS;
150};
151
152class RsdCpuScriptImpl : public RsdCpuReferenceImpl::CpuScript {
153public:
154    typedef void (*outer_foreach_t)(
155        const RsExpandKernelParams *,
156        uint32_t x1, uint32_t x2,
157        uint32_t outstep);
158
159    typedef void (* InvokeFunc_t)(void);
160    typedef void (* ForEachFunc_t)(void);
161    typedef int (* RootFunc_t)(void);
162#ifdef RS_COMPATIBILITY_LIB
163    typedef void (*WorkerCallback_t)(void *usr, uint32_t idx);
164#endif
165
166    bool init(char const *resName, char const *cacheDir,
167              uint8_t const *bitcode, size_t bitcodeSize, uint32_t flags,
168              char const *bccPluginName = nullptr);
169    virtual void populateScript(Script *);
170
171    virtual void invokeFunction(uint32_t slot, const void *params, size_t paramLength);
172    virtual int invokeRoot();
173    virtual void preLaunch(uint32_t slot, const Allocation ** ains,
174                           uint32_t inLen, Allocation * aout, const void * usr,
175                           uint32_t usrLen, const RsScriptCall *sc);
176    virtual void postLaunch(uint32_t slot, const Allocation ** ains,
177                            uint32_t inLen, Allocation * aout,
178                            const void * usr, uint32_t usrLen,
179                            const RsScriptCall *sc);
180
181    virtual void invokeForEach(uint32_t slot,
182                               const Allocation ** ains,
183                               uint32_t inLen,
184                               Allocation* aout,
185                               const void* usr,
186                               uint32_t usrLen,
187                               const RsScriptCall* sc);
188
189    virtual void invokeInit();
190    virtual void invokeFreeChildren();
191
192    virtual void setGlobalVar(uint32_t slot, const void *data, size_t dataLength);
193    virtual void getGlobalVar(uint32_t slot, void *data, size_t dataLength);
194    virtual void setGlobalVarWithElemDims(uint32_t slot, const void *data, size_t dataLength,
195                                  const Element *e, const uint32_t *dims, size_t dimLength);
196    virtual void setGlobalBind(uint32_t slot, Allocation *data);
197    virtual void setGlobalObj(uint32_t slot, ObjectBase *data);
198
199
200    virtual ~RsdCpuScriptImpl();
201    RsdCpuScriptImpl(RsdCpuReferenceImpl *ctx, const Script *s);
202
203    const Script * getScript() {return mScript;}
204
205    bool forEachMtlsSetup(const Allocation ** ains, uint32_t inLen,
206                          Allocation * aout, const void * usr, uint32_t usrLen,
207                          const RsScriptCall *sc, MTLaunchStruct *mtls);
208
209    virtual void forEachKernelSetup(uint32_t slot, MTLaunchStruct *mtls);
210
211
212    const RsdCpuReference::CpuSymbol * lookupSymbolMath(const char *sym);
213    static void * lookupRuntimeStub(void* pContext, char const* name);
214
215    virtual Allocation * getAllocationForPointer(const void *ptr) const;
216    bool storeRSInfoFromSO();
217
218protected:
219    RsdCpuReferenceImpl *mCtx;
220    const Script *mScript;
221    void *mScriptSO;
222
223#ifndef RS_COMPATIBILITY_LIB
224    // Returns the path to the core library we'll use.
225    const char* findCoreLib(const bcinfo::MetadataExtractor& bitCodeMetaData, const char* bitcode,
226                            size_t bitcodeSize);
227
228    bcc::RSCompilerDriver *mCompilerDriver;
229#endif
230
231    RootFunc_t mRoot;
232    RootFunc_t mRootExpand;
233    InvokeFunc_t mInit;
234    InvokeFunc_t mFreeChildren;
235    ScriptExecutable* mScriptExec;
236
237    Allocation **mBoundAllocs;
238    void * mIntrinsicData;
239    bool mIsThreadable;
240
241 public:
242  static const char* BCC_EXE_PATH;
243  const std::string& getBitcodeFilePath() const { return mBitcodeFilePath; }
244
245 private:
246  std::string mBitcodeFilePath;
247};
248
249Allocation * rsdScriptGetAllocationForPointer(
250                        const Context *dc,
251                        const Script *script,
252                        const void *);
253
254}
255
256#ifdef __LP64__
257#define SYSLIBPATH "/system/lib64"
258#else
259#define SYSLIBPATH "/system/lib"
260#endif
261
262}
263
264#endif
265