xref: /arkcompiler/ets_runtime/ecmascript/napi/include/dfx_jsnapi.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 ECMASCRIPT_NAPI_INCLUDE_DFX_JSNAPI_H
#define ECMASCRIPT_NAPI_INCLUDE_DFX_JSNAPI_H

#include <cassert>
#include <cstdint>
#include <functional>
#include <memory>
#include <string>
#include <vector>

#include "ecmascript/common.h"
#include "ecmascript/dfx/hprof/file_stream.h"
#include "ecmascript/dfx/hprof/heap_profiler_interface.h"

#include "libpandabase/macros.h"

namespace panda {
namespace ecmascript {
class EcmaVM;
class Stream;
class Progress;
struct ProfileInfo;
struct JsFrameInfo;
struct SamplingInfo;
struct TraceEvent;
}
class DFXJSNApi;
class JSValueRef;
template<typename T>
class Local;
using EcmaVM = ecmascript::EcmaVM;
using Stream = ecmascript::Stream;
using Progress = ecmascript::Progress;
using ProfileInfo = ecmascript::ProfileInfo;
using JsFrameInfo = ecmascript::JsFrameInfo;
using SamplingInfo = ecmascript::SamplingInfo;
using DebuggerPostTask = std::function<void(std::function<void()> &&)>;
using TraceEvent = ecmascript::TraceEvent;
using AppFreezeFilterCallback = std::function<bool(const int32_t pid)>;
using DumpSnapShotOption = ecmascript::DumpSnapShotOption;
using DumpFormat = ecmascript::DumpFormat;
struct DumpForSnapShotStruct {
    const EcmaVM *vm;
    DumpSnapShotOption dumpOption;
};

class PUBLIC_API DFXJSNApi {
public:
    // progress pointer is used to report the object number for IDE.
    // isVmMode means the internal class in vm is visible. isPrivate means the number and string is not visible.
    static void DumpHeapSnapshot(const EcmaVM *vm, const std::string &path, const DumpSnapShotOption &dumpOption);
    static void DumpHeapSnapshot(const EcmaVM *vm, Stream *stream, const DumpSnapShotOption &dumpOption,
                                 Progress *progress = nullptr);
    static void DumpCpuProfile(const EcmaVM *vm);
    static void DumpHeapSnapshot(const EcmaVM *vm, const DumpSnapShotOption &dumpOption);
    static void DumpHeapSnapshot(const EcmaVM *vm, const DumpSnapShotOption &dumpOption, uint32_t tid);
    static void GenerateHeapSnapshotByBinFile(const EcmaVM *vm, std::string &inputFilePath, std::string &outputPath);
    static void DumpHeapSnapshotWithVm(const EcmaVM *vm, const DumpSnapShotOption &dumpOption, uint32_t tid);
    static void TriggerGC(const EcmaVM *vm, uint32_t tid);
    static void TriggerGCWithVm(const EcmaVM *vm);
    static void TriggerSharedGCWithVm(const EcmaVM *vm);
    static void DestroyHeapProfiler(const EcmaVM *vm);

    static bool BuildNativeAndJsStackTrace(const EcmaVM *vm, std::string &stackTraceStr);
    static bool BuildJsStackTrace(const EcmaVM *vm, std::string &stackTraceStr);
    static bool StartHeapTracking(const EcmaVM *vm, double timeInterval, bool isVmMode = true,
                                  Stream *stream = nullptr, bool traceAllocation = false, bool newThread = true);
    static bool UpdateHeapTracking(const EcmaVM *vm, Stream *stream);
    static bool StopHeapTracking(const EcmaVM *vm, const std::string &filePath, bool newThread = true);
    static bool StopHeapTracking(const EcmaVM *vm, Stream *stream, Progress *progress = nullptr, bool newThread = true);
    static void PrintStatisticResult(const EcmaVM *vm);
    static void StartRuntimeStat(EcmaVM *vm);
    static void StopRuntimeStat(EcmaVM *vm);
    static size_t GetArrayBufferSize(const EcmaVM *vm);
    static size_t GetHeapTotalSize(const EcmaVM *vm);
    // GetHeapUsedSize only support running on vm thread and provide an accurate value.
    // GetHeapObjectSize provide a rough estimate.
    static size_t GetHeapUsedSize(const EcmaVM *vm);
    static size_t GetHeapObjectSize(const EcmaVM *vm);
    static size_t GetHeapLimitSize(const EcmaVM *vm);
    static size_t GetProcessHeapLimitSize();
    static size_t GetGCCount(const EcmaVM *vm);
    static size_t GetGCDuration(const EcmaVM *vm);
    static size_t GetAccumulatedAllocateSize(const EcmaVM *vm);
    static size_t GetAccumulatedFreeSize(const EcmaVM *vm);
    static size_t GetFullGCLongTimeCount(const EcmaVM *vm);
    static void GetHeapPrepare(const EcmaVM *vm);
    static void NotifyApplicationState(EcmaVM *vm, bool inBackground);
    static void NotifyIdleStatusControl(const EcmaVM *vm, std::function<void(bool)> callback);
    static void NotifyIdleTime(const EcmaVM *vm, int idleMicroSec);
    static void NotifyMemoryPressure(EcmaVM *vm, bool inHighMemoryPressure);
    static void NotifyFinishColdStart(EcmaVM *vm, bool isConvinced);
    static void NotifyHighSensitive(EcmaVM *vm, bool isStart);
    static bool BuildJsStackInfoList(const EcmaVM *hostVm, uint32_t tid, std::vector<JsFrameInfo>& jsFrames);
    static int32_t GetObjectHash(const EcmaVM *vm, Local<JSValueRef> nativeObject);

    // cpuprofiler
    static bool StopCpuProfilerForColdStart(const EcmaVM *vm);
    static bool CpuProfilerSamplingAnyTime(const EcmaVM *vm);
    static void CpuProfilerAnyTimeMainThread(const EcmaVM *vm);
    static void SetJsDumpThresholds(EcmaVM *vm, size_t thresholds);
    static void SetAppFreezeFilterCallback(const EcmaVM *vm, AppFreezeFilterCallback cb);
    static bool StartCpuProfilerForFile(const EcmaVM *vm, const std::string &fileName,
                                        int interval = 500); // 500:Default Sampling interval 500 microseconds
    static void StopCpuProfilerForFile(const EcmaVM *vm);
    static bool StartCpuProfilerForInfo(const EcmaVM *vm,
                                        int interval = 500); // 500:Default Sampling interval 500 microseconds
    static std::unique_ptr<ProfileInfo> StopCpuProfilerForInfo(const EcmaVM *vm);
    static void EnableSeriliazationTimeoutCheck(const EcmaVM *ecmaVM, int32_t threshhold);
    static void DisableSeriliazationTimeoutCheck(const EcmaVM *ecmaVM);

    enum class PUBLIC_API ProfilerType : uint8_t { CPU_PROFILER, HEAP_PROFILER };

    struct ProfilerOption {
        const char *libraryPath;
        int interval = 500; // 500:Default Sampling interval 500 microseconds
        ProfilerType profilerType = ProfilerType::CPU_PROFILER;
    };
    // To be compatible with old process.
    static bool StartProfiler(EcmaVM *vm, const ProfilerOption &option, int tid,
                              int32_t instanceId, const DebuggerPostTask &debuggerPostTask, bool isDebugApp);
    static void SetCpuSamplingInterval(const EcmaVM *vm, int interval);
    static bool StartSampling(const EcmaVM *vm, uint64_t samplingInterval);
    static const SamplingInfo *GetAllocationProfile(const EcmaVM *vm);
    static void StopSampling(const EcmaVM *vm);

    static void ResumeVM(const EcmaVM *vm);
    static bool SuspendVM(const EcmaVM *vm);
    static bool IsSuspended(const EcmaVM *vm);
    static void TerminateExecution(const EcmaVM *vm);
    static bool CheckSafepoint(const EcmaVM *vm);
    static void ResumeVMById(EcmaVM *vm, uint32_t tid);
    static bool SuspendVMById(EcmaVM *vm, uint32_t tid);

    // tracing
    static bool StartTracing(const EcmaVM *vm, std::string &categories);
    static std::unique_ptr<std::vector<TraceEvent>> StopTracing(const EcmaVM *vm);
    static void GetTracingBufferUseage(const EcmaVM *vm, double &percentFull, uint32_t &eventCount, double &value);
    static void TranslateJSStackInfo(const EcmaVM *vm, std::string &url, int32_t &line, int32_t &column);

    static uint32_t GetCurrentThreadId();
};
}
#endif