cpu_ref/rsCpuScript.h

/*
 * Copyright (C) 2011-2012 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef RSD_BCC_H
#define RSD_BCC_H

#include <rs_hal.h>
#include <rsRuntime.h>

#ifndef RS_COMPATIBILITY_LIB
#include <utility>
#endif

#include "rsCpuCore.h"

namespace bcc {
    class BCCContext;
    class RSCompilerDriver;
}

namespace bcinfo {
    class MetadataExtractor;
}

namespace android {
namespace renderscript {

class SharedLibraryUtils {
 public:
#ifndef RS_COMPATIBILITY_LIB
  static bool createSharedLibrary(const char* cacheDir, const char* resName);
#endif

  // Load the shared library referred to by cacheDir and resName. If we have
  // already loaded this library, we instead create a new copy (in the
  // cache dir) and then load that. We then immediately destroy the copy.
  // This is required behavior to implement script instancing for the support
  // library, since shared objects are loaded and de-duped by name only.

  // For 64bit RS Support Lib, the shared lib path cannot be constructed from
  // cacheDir, so nativeLibDir is needed to load shared libs.
  static void* loadSharedLibrary(const char *cacheDir, const char *resName,
                                 const char *nativeLibDir = nullptr);

 private:
  // Attempt to load the shared library from origName, but then fall back to
  // creating a copy of the shared library if necessary (to ensure instancing).
  // This function returns the dlopen()-ed handle if successful.
  static void *loadSOHelper(const char *origName, const char *cacheDir,
                            const char *resName);

  static const char* LD_EXE_PATH;
  static const char* RS_CACHE_DIR;
};

class ScriptExecutable {
 public:
  ScriptExecutable(Context* RSContext,
                   void** fieldAddress, bool* fieldIsObject, size_t varCount,
                   InvokeFunc_t* invokeFunctions, size_t funcCount,
                   ForEachFunc_t* forEachFunctions, uint32_t* forEachSignatures,
                   size_t forEachCount,
                   const char ** pragmaKeys, const char ** pragmaValues,
                   size_t pragmaCount,
                   bool isThreadable) :
      mFieldAddress(fieldAddress), mFieldIsObject(fieldIsObject),
      mExportedVarCount(varCount),
      mInvokeFunctions(invokeFunctions), mFuncCount(funcCount),
      mForEachFunctions(forEachFunctions), mForEachSignatures(forEachSignatures),
      mForEachCount(forEachCount),
      mPragmaKeys(pragmaKeys), mPragmaValues(pragmaValues),
      mPragmaCount(pragmaCount),
      mIsThreadable(isThreadable), mRS(RSContext) {
  }

  ~ScriptExecutable() {
      for (size_t i = 0; i < mExportedVarCount; ++i) {
          if (mFieldIsObject[i]) {
              if (mFieldAddress[i] != nullptr) {
                  rs_object_base *obj_addr =
                      reinterpret_cast<rs_object_base *>(mFieldAddress[i]);
                  rsrClearObject(mRS, obj_addr);
              }
          }
      }

      for (size_t i = 0; i < mPragmaCount; ++i) {
          delete [] mPragmaKeys[i];
          delete [] mPragmaValues[i];
      }

      delete[] mPragmaValues;
      delete[] mPragmaKeys;
      delete[] mForEachSignatures;
      delete[] mForEachFunctions;
      delete[] mInvokeFunctions;
      delete[] mFieldIsObject;
      delete[] mFieldAddress;
  }

  static ScriptExecutable*
  createFromSharedObject(Context* RSContext, void* sharedObj);

  size_t getExportedVariableCount() const { return mExportedVarCount; }
  size_t getExportedFunctionCount() const { return mFuncCount; }
  size_t getExportedForEachCount() const { return mForEachCount; }
  size_t getPragmaCount() const { return mPragmaCount; }

  void* getFieldAddress(int slot) const { return mFieldAddress[slot]; }
  bool getFieldIsObject(int slot) const { return mFieldIsObject[slot]; }
  InvokeFunc_t getInvokeFunction(int slot) const { return mInvokeFunctions[slot]; }
  ForEachFunc_t getForEachFunction(int slot) const { return mForEachFunctions[slot]; }
  uint32_t getForEachSignature(int slot) const { return mForEachSignatures[slot]; }

  const char ** getPragmaKeys() const { return mPragmaKeys; }
  const char ** getPragmaValues() const { return mPragmaValues; }

  bool getThreadable() const { return mIsThreadable; }

 private:
  void** mFieldAddress;
  bool* mFieldIsObject;
  size_t mExportedVarCount;

  InvokeFunc_t* mInvokeFunctions;
  size_t mFuncCount;

  ForEachFunc_t* mForEachFunctions;
  uint32_t* mForEachSignatures;
  size_t mForEachCount;

  const char ** mPragmaKeys;
  const char ** mPragmaValues;
  size_t mPragmaCount;

  bool mIsThreadable;

  Context* mRS;
};

class RsdCpuScriptImpl : public RsdCpuReferenceImpl::CpuScript {
public:
    typedef void (*outer_foreach_t)(
        const RsExpandKernelParams *,
        uint32_t x1, uint32_t x2,
        uint32_t outstep);

    typedef void (* InvokeFunc_t)(void);
    typedef void (* ForEachFunc_t)(void);
    typedef int (* RootFunc_t)(void);
#ifdef RS_COMPATIBILITY_LIB
    typedef void (*WorkerCallback_t)(void *usr, uint32_t idx);
#endif

    bool init(char const *resName, char const *cacheDir,
              uint8_t const *bitcode, size_t bitcodeSize, uint32_t flags,
              char const *bccPluginName = nullptr);
    virtual void populateScript(Script *);

    virtual void invokeFunction(uint32_t slot, const void *params, size_t paramLength);
    virtual int invokeRoot();
    virtual void preLaunch(uint32_t slot, const Allocation ** ains,
                           uint32_t inLen, Allocation * aout, const void * usr,
                           uint32_t usrLen, const RsScriptCall *sc);
    virtual void postLaunch(uint32_t slot, const Allocation ** ains,
                            uint32_t inLen, Allocation * aout,
                            const void * usr, uint32_t usrLen,
                            const RsScriptCall *sc);

    virtual void invokeForEach(uint32_t slot,
                               const Allocation ** ains,
                               uint32_t inLen,
                               Allocation* aout,
                               const void* usr,
                               uint32_t usrLen,
                               const RsScriptCall* sc);

    virtual void invokeInit();
    virtual void invokeFreeChildren();

    virtual void setGlobalVar(uint32_t slot, const void *data, size_t dataLength);
    virtual void getGlobalVar(uint32_t slot, void *data, size_t dataLength);
    virtual void setGlobalVarWithElemDims(uint32_t slot, const void *data, size_t dataLength,
                                  const Element *e, const uint32_t *dims, size_t dimLength);
    virtual void setGlobalBind(uint32_t slot, Allocation *data);
    virtual void setGlobalObj(uint32_t slot, ObjectBase *data);


    virtual ~RsdCpuScriptImpl();
    RsdCpuScriptImpl(RsdCpuReferenceImpl *ctx, const Script *s);

    const Script * getScript() {return mScript;}

    bool forEachMtlsSetup(const Allocation ** ains, uint32_t inLen,
                          Allocation * aout, const void * usr, uint32_t usrLen,
                          const RsScriptCall *sc, MTLaunchStruct *mtls);

    virtual void forEachKernelSetup(uint32_t slot, MTLaunchStruct *mtls);


    const RsdCpuReference::CpuSymbol * lookupSymbolMath(const char *sym);
    static void * lookupRuntimeStub(void* pContext, char const* name);

    virtual Allocation * getAllocationForPointer(const void *ptr) const;
    bool storeRSInfoFromSO();

protected:
    RsdCpuReferenceImpl *mCtx;
    const Script *mScript;
    void *mScriptSO;

#ifndef RS_COMPATIBILITY_LIB
    // Returns the path to the core library we'll use.
    const char* findCoreLib(const bcinfo::MetadataExtractor& bitCodeMetaData, const char* bitcode,
                            size_t bitcodeSize);

    bcc::RSCompilerDriver *mCompilerDriver;
#endif

    RootFunc_t mRoot;
    RootFunc_t mRootExpand;
    InvokeFunc_t mInit;
    InvokeFunc_t mFreeChildren;
    ScriptExecutable* mScriptExec;

    Allocation **mBoundAllocs;
    void * mIntrinsicData;
    bool mIsThreadable;

 public:
  static const char* BCC_EXE_PATH;
  const char* getBitcodeFilePath() const { return mBitcodeFilePath.string(); }

 private:
  String8 mBitcodeFilePath;
};

Allocation * rsdScriptGetAllocationForPointer(
                        const Context *dc,
                        const Script *script,
                        const void *);

}

#ifdef __LP64__
#define SYSLIBPATH "/system/lib64"
#else
#define SYSLIBPATH "/system/lib"
#endif

}

#endif