ability_ability_runtime/interfaces/inner_api/runtime/include/runtime.h

/*
 * Copyright (c) 2021-2023 Huawei Device Co., Ltd.
 * 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 OHOS_ABILITY_RUNTIME_RUNTIME_H
#define OHOS_ABILITY_RUNTIME_RUNTIME_H

#include <map>
#include <string>
#include <vector>

class ModuleCheckerDelegate;

namespace OHOS {
namespace AppExecFwk {
class EventRunner;
} // namespace AppExecFwk
namespace AbilityRuntime {
struct CommonHspBundleInfo {
    uint32_t versionCode;
    int32_t aotCompileStatus;
    std::string bundleName;
    std::string moduleName;
    std::string hapPath;
    std::string moduleArkTSMode;
};
namespace {
const std::string CODE_LANGUAGE_ARKTS_1_0 = "dynamic";
const std::string CODE_LANGUAGE_ARKTS_1_2 = "static";
const std::string CODE_LANGUAGE_ARKTS_HYBRID = "hybrid";
const std::string DEBUGGER = "@Debugger";
} // namespace

class Runtime {
public:
    enum class Language {
        JS = 0,
        CJ,
        ETS,
        UNKNOWN,
    };

    struct Options {
        Language lang = Language::JS;
        std::string bundleName;
        std::string moduleName;
        std::string codePath;
        std::string bundleCodeDir;
        std::string hapPath;
        std::string arkNativeFilePath;
        std::string packagePathStr;
        std::vector<std::string> assetBasePathStr;
        std::shared_ptr<AppExecFwk::EventRunner> eventRunner = nullptr;
        std::map<std::string, std::string> hapModulePath;
        std::vector<std::string> staticHapModuleNameList;
        std::vector<std::string> appInnerHspPathList;
        std::vector<OHOS::AbilityRuntime::CommonHspBundleInfo> commonHspBundleInfos;
        bool loadAce = true;
        bool preload = false;
        bool isBundle = true;
        bool isDebugVersion = false;
        bool isJsFramework = false;
        bool isStageModel = true;
        bool isTestFramework = false;
        bool jitEnabled = false;
        bool isMultiThread = false;
        bool isErrorInfoEnhance = false;
        bool allowArkTsLargeHeap = false;
        bool baseLineProfile = false;
        int32_t uid = -1;
        // ArkTsCard start
        bool isUnique = false;
        // ArkTsCard end
        std::shared_ptr<ModuleCheckerDelegate> moduleCheckerDelegate = nullptr;
        int32_t apiTargetVersion = 0;
        std::map<std::string, std::string> pkgContextInfoJsonStringMap;
        std::map<std::string, std::string> packageNameList;
        std::map<std::string, int32_t> aotCompileStatusMap;
        bool isStartWithDebug = false;
        uint32_t versionCode = 0;
        bool enableWarmStartupSmartGC = false;
        std::string arkTSMode;
        bool isMainProcess = true;
        std::vector<std::string> staticPluginHspPathList;
    };

    struct DebugOption {
        std::string bundleName = "";
        std::string perfCmd;
        std::string processName = "";
        std::string appProvisionType = "";
        bool isDebugApp = true;
        bool isStartWithDebug = false;
        bool isStartWithNative = false;
        bool isDebugFromLocal = false;
        bool isDeveloperMode;
        std::string arkTSMode = CODE_LANGUAGE_ARKTS_1_0;
    };

    struct JsHeapDumpParam {
        bool isFullGC = false;
        bool isBinary = false;
        bool isClearNodeIdCache = false;
        bool isProcDump = false;
    };

    static std::unique_ptr<Runtime> Create(Options &options);
    static void SavePreloaded(std::unique_ptr<Runtime> &&instance);
    static std::unique_ptr<Runtime> GetPreloaded(Language key);

    Runtime() = default;
    virtual ~Runtime() = default;

    virtual Language GetLanguage() const = 0;

    virtual void StartDebugMode(const DebugOption debugOption) = 0;
    virtual void SetDebugOption(const DebugOption debugOption) {};
    virtual void StartLocalDebugMode(bool isDebugFromLocal) {};
    virtual void DumpHeapSnapshot(bool isPrivate) = 0;
    virtual void DumpCpuProfile() = 0;
    virtual void DestroyHeapProfiler() = 0;
    virtual void ForceFullGC() = 0;
    virtual void ForceFullGC(uint32_t tid) = 0;
    virtual void DumpHeapSnapshot(uint32_t tid, bool isFullGC, bool isBinary = false) = 0;
    virtual void DumpHeapSnapshot(uint32_t tid, const JsHeapDumpParam &param) {};
    virtual void AllowCrossThreadExecution() = 0;
    virtual void GetHeapPrepare() = 0;
    virtual void NotifyApplicationState(bool isBackground) = 0;
    virtual bool SuspendVM(uint32_t tid) = 0;
    virtual void ResumeVM(uint32_t tid) = 0;
    virtual void PreloadSystemModule(const std::string& moduleName) = 0;
    virtual void PreloadMainAbility(const std::string& moduleName, const std::string& srcPath,
        const std::string& hapPath,  bool isEsMode, const std::string& srcEntrance) = 0;
    virtual void PreloadModule(const std::string& moduleName, const std::string& srcPath,
        const std::string& hapPath, bool isEsMode, bool useCommonTrunk) = 0;
    virtual void PreloadModule(const std::string &moduleName, const std::string &hapPath,
        bool isEsMode, bool useCommonTrunk) {}
    virtual void FinishPreload() = 0;
    virtual bool LoadRepairPatch(const std::string& patchFile, const std::string& baseFile) = 0;
    virtual bool NotifyHotReloadPage() = 0;
    virtual bool UnLoadRepairPatch(const std::string& patchFile) = 0;
    virtual void RegisterQuickFixQueryFunc(const std::map<std::string, std::string>& moduleAndPath) = 0;
    virtual void StartProfiler(const DebugOption debugOption) = 0;
    virtual void SetExtensionApiCheckCallback(
        std::function<bool(const std::string &className, const std::string &fileName)> &cb) {}
    virtual void DoCleanWorkAfterStageCleaned() {}
    virtual void SetModuleLoadChecker(const std::shared_ptr<ModuleCheckerDelegate> moduleCheckerDelegate) const {}
    virtual void SetDeviceDisconnectCallback(const std::function<bool()> &cb) = 0;
    virtual bool PreloadSystemClass(const char *className) { return false; }
    Runtime(const Runtime&) = delete;
    Runtime(Runtime&&) = delete;
    Runtime& operator=(const Runtime&) = delete;
    Runtime& operator=(Runtime&&) = delete;
};
}  // namespace AbilityRuntime
}  // namespace OHOS
#endif  // OHOS_ABILITY_RUNTIME_RUNTIME_H