rsCpuScript.h revision 68173de001c5d41c74828a426651e07cfd9e8710 
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                   std::vector<void*>& fieldAddress,
71                   std::vector<bool>& fieldIsObject,
72                   std::vector<InvokeFunc_t>& invokeFunctions,
73                   std::vector<ForEachFunc_t>& forEachFunctions,
74                   std::vector<uint32_t>& forEachSignatures,
75                   std::vector<const char *> &pragmaKeys,
76                   std::vector<const char *> &pragmaValues,
77                   bool isThreadable)
78                   : mIsThreadable(isThreadable), mRS(RSContext) {
79      mFieldAddress.swap(fieldAddress);
80      mFieldIsObject.swap(fieldIsObject);
81      mInvokeFunctions.swap(invokeFunctions);
82      mForEachFunctions.swap(forEachFunctions);
83      mForEachSignatures.swap(forEachSignatures);
84      mPragmaKeys.swap(pragmaKeys);
85      mPragmaValues.swap(pragmaValues);
86  }
87
88  ~ScriptExecutable() {
89      for (size_t i = 0; i < mFieldAddress.size(); ++i) {
90          if (mFieldIsObject[i]) {
91              if (mFieldAddress[i] != nullptr) {
92                  rs_object_base *obj_addr =
93                      reinterpret_cast<rs_object_base *>(mFieldAddress[i]);
94                  rsrClearObject(mRS, obj_addr);
95              }
96          }
97      }
98
99      for (size_t i = 0; i < mPragmaKeys.size(); ++i) {
100          delete [] mPragmaKeys[i];
101          delete [] mPragmaValues[i];
102      }
103  }
104
105  static ScriptExecutable*
106  createFromSharedObject(Context* RSContext, void* sharedObj);
107
108  size_t getExportedVariableCount() const { return mFieldAddress.size(); }
109  size_t getExportedFunctionCount() const { return mInvokeFunctions.size(); }
110  size_t getExportedForEachCount() const { return mForEachFunctions.size(); }
111  size_t getPragmaCount() const { return mPragmaKeys.size(); }
112
113  void* getFieldAddress(int slot) const { return mFieldAddress[slot]; }
114  bool getFieldIsObject(int slot) const { return mFieldIsObject[slot]; }
115  InvokeFunc_t getInvokeFunction(int slot) const { return mInvokeFunctions[slot]; }
116  ForEachFunc_t getForEachFunction(int slot) const { return mForEachFunctions[slot]; }
117  uint32_t getForEachSignature(int slot) const { return mForEachSignatures[slot]; }
118
119  const std::vector<const char *> & getPragmaKeys() const { return mPragmaKeys; }
120  const std::vector<const char *> & getPragmaValues() const { return mPragmaValues; }
121
122  bool getThreadable() const { return mIsThreadable; }
123
124 private:
125  std::vector<void*> mFieldAddress;
126  std::vector<bool> mFieldIsObject;
127  std::vector<InvokeFunc_t> mInvokeFunctions;
128  std::vector<ForEachFunc_t> mForEachFunctions;
129  std::vector<uint32_t> mForEachSignatures;
130  std::vector<const char *> mPragmaKeys;
131  std::vector<const char *> mPragmaValues;
132
133  bool mIsThreadable;
134
135  Context* mRS;
136};
137
138class RsdCpuScriptImpl : public RsdCpuReferenceImpl::CpuScript {
139public:
140    typedef void (*outer_foreach_t)(
141        const RsExpandKernelParams *,
142        uint32_t x1, uint32_t x2,
143        uint32_t outstep);
144
145    typedef void (* InvokeFunc_t)(void);
146    typedef void (* ForEachFunc_t)(void);
147    typedef int (* RootFunc_t)(void);
148#ifdef RS_COMPATIBILITY_LIB
149    typedef void (*WorkerCallback_t)(void *usr, uint32_t idx);
150#endif
151
152    bool init(char const *resName, char const *cacheDir,
153              uint8_t const *bitcode, size_t bitcodeSize, uint32_t flags,
154              char const *bccPluginName = nullptr);
155    virtual void populateScript(Script *);
156
157    virtual void invokeFunction(uint32_t slot, const void *params, size_t paramLength);
158    virtual int invokeRoot();
159    virtual void preLaunch(uint32_t slot, const Allocation ** ains,
160                           uint32_t inLen, Allocation * aout, const void * usr,
161                           uint32_t usrLen, const RsScriptCall *sc);
162    virtual void postLaunch(uint32_t slot, const Allocation ** ains,
163                            uint32_t inLen, Allocation * aout,
164                            const void * usr, uint32_t usrLen,
165                            const RsScriptCall *sc);
166
167    virtual void invokeForEach(uint32_t slot,
168                               const Allocation ** ains,
169                               uint32_t inLen,
170                               Allocation* aout,
171                               const void* usr,
172                               uint32_t usrLen,
173                               const RsScriptCall* sc);
174
175    virtual void invokeInit();
176    virtual void invokeFreeChildren();
177
178    virtual void setGlobalVar(uint32_t slot, const void *data, size_t dataLength);
179    virtual void getGlobalVar(uint32_t slot, void *data, size_t dataLength);
180    virtual void setGlobalVarWithElemDims(uint32_t slot, const void *data, size_t dataLength,
181                                  const Element *e, const uint32_t *dims, size_t dimLength);
182    virtual void setGlobalBind(uint32_t slot, Allocation *data);
183    virtual void setGlobalObj(uint32_t slot, ObjectBase *data);
184
185
186    virtual ~RsdCpuScriptImpl();
187    RsdCpuScriptImpl(RsdCpuReferenceImpl *ctx, const Script *s);
188
189    const Script * getScript() {return mScript;}
190
191    bool forEachMtlsSetup(const Allocation ** ains, uint32_t inLen,
192                          Allocation * aout, const void * usr, uint32_t usrLen,
193                          const RsScriptCall *sc, MTLaunchStruct *mtls);
194
195    virtual void forEachKernelSetup(uint32_t slot, MTLaunchStruct *mtls);
196
197
198    const RsdCpuReference::CpuSymbol * lookupSymbolMath(const char *sym);
199    static void * lookupRuntimeStub(void* pContext, char const* name);
200
201    virtual Allocation * getAllocationForPointer(const void *ptr) const;
202    bool storeRSInfoFromSO();
203
204protected:
205    RsdCpuReferenceImpl *mCtx;
206    const Script *mScript;
207    void *mScriptSO;
208
209#ifndef RS_COMPATIBILITY_LIB
210    // Returns the path to the core library we'll use.
211    const char* findCoreLib(const bcinfo::MetadataExtractor& bitCodeMetaData, const char* bitcode,
212                            size_t bitcodeSize);
213
214    bcc::RSCompilerDriver *mCompilerDriver;
215#endif
216
217    RootFunc_t mRoot;
218    RootFunc_t mRootExpand;
219    InvokeFunc_t mInit;
220    InvokeFunc_t mFreeChildren;
221    ScriptExecutable* mScriptExec;
222
223    Allocation **mBoundAllocs;
224    void * mIntrinsicData;
225    bool mIsThreadable;
226};
227
228Allocation * rsdScriptGetAllocationForPointer(
229                        const Context *dc,
230                        const Script *script,
231                        const void *);
232
233
234
235}
236
237}
238
239#endif
240