openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2024-11-23 07:10:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
master
interface_sdk-js/api/@ohos.hidebug.d.ts
yuhaoqiang 076e5849f6 规范修改 
Signed-off-by: yuhaoqiang <yuhaoqiang@huawei.com>
2024-11-18 09:53:13 +08:00

833 lines
24 KiB
TypeScript
Raw Permalink Blame History

/*
* Copyright (C) 2022 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.
*/
/**
* @file
* @kit PerformanceAnalysisKit
*/
/**
* Provide interfaces related to debugger access and obtaining CPU,
* memory and other virtual machine information during runtime for JS programs
*
* @namespace hidebug
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 8
*/
/**
* Provide interfaces related to debugger access and obtaining CPU,
* memory and other virtual machine information during runtime for JS programs
*
* @namespace hidebug
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @atomicservice
* @since 12
*/
declare namespace hidebug {
/**
* Get total native heap memory size
*
* @returns { bigint } Returns total native heap memory size.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 8
*/
function getNativeHeapSize(): bigint;
/**
* Get Native heap memory allocation size.
* @returns { bigint } Returns native heap memory allocation size.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 8
*/
function getNativeHeapAllocatedSize(): bigint;
/**
* Get Native heap memory free size
*
* @returns { bigint } Returns native heap memory free size.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 8
*/
function getNativeHeapFreeSize(): bigint;
/**
* Get the virtual set size memory of the application process
*
* @returns { bigint } Returns application process virtual set size memory information.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 11
*/
function getVss(): bigint;
/**
* Get application process proportional set size memory information
*
* @returns { bigint } Returns application process proportional set size memory information.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 8
*/
function getPss(): bigint;
/**
* Obtains the size of the shared dirty memory of a process.
*
* @returns { bigint } Returns the size of the shared dirty memory.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 8
*/
function getSharedDirty(): bigint;
/**
* Obtains the size of the private dirty memory of a process.
* @returns { bigint } Returns the size of the private dirty memory.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 9
*/
function getPrivateDirty(): bigint;
/**
* Obtains the cpu usage percent of a process.
*
* @returns { number } Returns the cpu usage of a process.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 9
*/
function getCpuUsage(): number;
/**
* Start CPU Profiling.
* The input parameter is a user-defined file name, excluding the file suffix.
* The generated file is in the files folder under the application directory.
* Such as "/data/accounts/account_0/appdata/[package name]/files/cpuprofiler-xxx.json"
*
* @param { string } filename - Indicates the user-defined file name, excluding the file suffix.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 8
* @deprecated since 9
* @useinstead ohos.hidebug/hidebug.startJsCpuProfiling
*/
function startProfiling(filename: string): void;
/**
* Stop CPU Profiling.
* It takes effect only when the CPU profiler is turned on
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 8
* @deprecated since 9
* @useinstead ohos.hidebug/hidebug.stopJsCpuProfiling
*/
function stopProfiling(): void;
/**
* Dump JS Virtual Machine Heap Snapshot.
* The input parameter is a user-defined file name, excluding the file suffix.
* The generated file is in the files folder under the application directory.
* Such as "/data/accounts/account_0/appdata/[package name]/files/xxx.heapsnapshot"
*
* @param { string } filename - Indicates the user-defined file name, excluding the file suffix.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 8
* @deprecated since 9
* @useinstead ohos.hidebug/hidebug.dumpJsHeapData
*/
function dumpHeapData(filename: string): void;
/**
* Start CPU Profiling.
* The input parameter is a user-defined file name, excluding the file suffix.
* The generated file is in the files folder under the application directory.
*
* @param { string } filename - Indicates the user-defined file name, excluding the file suffix.
* @throws {BusinessError} 401 - the parameter check failed, Parameter type error
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 9
*/
function startJsCpuProfiling(filename: string): void;
/**
* Stop CPU Profiling.
* It takes effect only when the CPU profiler is turned on
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 9
*/
function stopJsCpuProfiling(): void;
/**
* Dump JS Virtual Machine Heap Snapshot.
* The input parameter is a user-defined file name, excluding the file suffix.
* The generated file is in the files folder under the application directory.
*
* @param { string } filename - Indicates the user-defined file name, excluding the file suffix.
* @throws {BusinessError} 401 - the parameter check failed, Parameter type error
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 9
*/
function dumpJsHeapData(filename: string): void;
/**
* Get a debugging dump of a system service by service id.
* It need dump permission.
* This API can be called only by system application.
*
* @permission ohos.permission.DUMP
* @param { number } serviceid - Indicates the id of the service ability.
* @param { number } fd - The file descriptor.
* @param { Array<string> } args - The args list of the system ability dump interface.
* @throws {BusinessError} 401 - the parameter check failed, Possible causes:
* 1.the parameter type error
* 2.the args parameter is not string array
* @throws {BusinessError} 11400101 - ServiceId invalid. The system ability does not exist.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 9
*/
function getServiceDump(serviceid: number, fd: number, args: Array<string>): void;
/**
* Obtains the cpu usage of system.
*
* @returns { number } Returns the cpu usage of system.
* @throws { BusinessError } 11400104 - The status of the system CPU usage is abnormal.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
function getSystemCpuUsage(): number;
/**
* Application CPU usage of thread.
*
* @interface ThreadCpuUsage
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
interface ThreadCpuUsage {
/**
* Thread id
*
* @type { number }
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
threadId: number;
/**
* Cpu usage of thread
*
* @type { number }
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
cpuUsage: number;
}
/**
* Get the CPU usage of all threads in the application.
*
* @returns { ThreadCpuUsage[] } Returns the CPU usage of all threads in the application.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
function getAppThreadCpuUsage(): ThreadCpuUsage[];
/**
* System memory information
*
* @interface SystemMemInfo
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
interface SystemMemInfo {
/**
* Total system memory size, in kilobyte
*
* @type { bigint }
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
totalMem: bigint;
/**
* System free memory size, in kilobyte
*
* @type { bigint }
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
freeMem: bigint;
/**
* System available memory size, in kilobyte
*
* @type { bigint }
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
availableMem: bigint;
}
/**
* Obtains the system memory size.
*
* @returns { SystemMemInfo } Returns system memory size.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
function getSystemMemInfo(): SystemMemInfo;
/**
* Application process native memory information.
*
* @interface NativeMemInfo
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
interface NativeMemInfo {
/**
* Process proportional set size memory, in kilobyte
*
* @type { bigint }
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
pss: bigint;
/**
* Virtual set size memory, in kilobyte
*
* @type { bigint }
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
vss: bigint;
/**
* Resident set size, in kilobyte
*
* @type { bigint }
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
rss: bigint;
/**
* The size of the shared dirty memory, in kilobyte
*
* @type { bigint }
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
sharedDirty: bigint;
/**
* The size of the private dirty memory, in kilobyte
*
* @type { bigint }
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
privateDirty: bigint;
/**
* The size of the shared clean memory, in kilobyte
*
* @type { bigint }
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
sharedClean: bigint;
/**
* The size of the private clean memory, in kilobyte
*
* @type { bigint }
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
privateClean: bigint;
}
/**
* Obtains the memory information of application process.
*
* @returns { NativeMemInfo } Returns the native memory of a process.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
function getAppNativeMemInfo(): NativeMemInfo;
/**
* Application process memory limit
*
* @interface MemoryLimit
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
interface MemoryLimit {
/**
* The limit of the application process's resident set, in kilobyte
*
* @type { bigint }
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
rssLimit: bigint;
/**
* The limit of the application process's virtual memory, in kilobyte
*
* @type { bigint }
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
vssLimit: bigint;
/**
* The limit of the js vm heap size of current virtual machine, in kilobyte
*
* @type { bigint }
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
vmHeapLimit: bigint;
/**
* The limit of the total js vm heap size of process, in kilobyte
*
* @type { bigint }
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
vmTotalHeapSize: bigint;
}
/**
* Obtains the memory limit of application process.
*
* @returns { MemoryLimit } Returns memory limit of application.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
function getAppMemoryLimit(): MemoryLimit;
/**
* The memory information of application virtual machine.
*
* @interface VMMemoryInfo
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
interface VMMemoryInfo {
/**
* Total size of current virtual machine Heap, in kilobyte
*
* @type { bigint }
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
totalHeap: bigint;
/**
* Used size of current virtual machine Heap, in kilobyte
*
* @type { bigint }
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
heapUsed: bigint;
/**
* All array object size of current virtual machine, in kilobyte
*
* @type { bigint }
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
allArraySize: bigint;
}
/**
* Obtains the memory information of application virtual machine.
*
* @returns { VMMemoryInfo } Returns memory information of application virtual machine.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
function getAppVMMemoryInfo(): VMMemoryInfo;
/**
* Enum for trace flag
*
* @enum { number }
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
enum TraceFlag {
/**
* Only capture main thread trace
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
MAIN_THREAD = 1,
/**
* Capture all thread trace
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
ALL_THREADS = 2
}
/**
* Provide trace tags
*
* @namespace tags
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
namespace tags {
/**
* Ability Manager tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const ABILITY_MANAGER: number;
/**
* ARKUI development framework tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const ARKUI: number;
/**
* ARK tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const ARK: number;
/**
* Bluetooth tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const BLUETOOTH: number;
/**
* Common library subsystem tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const COMMON_LIBRARY: number;
/**
* Distributed hardware device manager tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const DISTRIBUTED_HARDWARE_DEVICE_MANAGER: number;
/**
* Distributed audio tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const DISTRIBUTED_AUDIO: number;
/**
* Distributed camera tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const DISTRIBUTED_CAMERA: number;
/**
* Distributed data manager module tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const DISTRIBUTED_DATA: number;
/**
* Distributed hardware framework tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const DISTRIBUTED_HARDWARE_FRAMEWORK: number;
/**
* Distributed input tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const DISTRIBUTED_INPUT: number;
/**
* Distributed screen tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const DISTRIBUTED_SCREEN: number;
/**
* Distributed scheduler tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const DISTRIBUTED_SCHEDULER: number;
/**
* FFRT tasks.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const FFRT: number;
/**
* File management tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const FILE_MANAGEMENT: number;
/**
* Global resource manager tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const GLOBAL_RESOURCE_MANAGER: number;
/**
* Graphics module tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const GRAPHICS: number;
/**
* HDF subsystem tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const HDF: number;
/**
* MISC module tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const MISC: number;
/**
* Multimodal input module tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const MULTIMODAL_INPUT: number;
/**
* Net tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const NET: number;
/**
* Notification module tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const NOTIFICATION: number;
/**
* NWeb tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const NWEB: number;
/**
* OHOS generic tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const OHOS: number;
/**
* Power manager tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const POWER_MANAGER: number;
/**
* RPC tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const RPC: number;
/**
* SA tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const SAMGR: number;
/**
* Window manager tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const WINDOW_MANAGER: number;
/**
* Audio module tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const AUDIO: number;
/**
* Camera module tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const CAMERA: number;
/**
* Image module tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const IMAGE: number;
/**
* Media module tag.
*
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
const MEDIA: number;
}
/**
* Start capture application trace.
*
* @param { number[] } tags - Tag of trace.
* @param { TraceFlag } flag - Trace flag.
* @param { number } limitSize - Max size of trace file, in bytes, the max is 500MB.
* @returns { string } Returns absolute path of the trace file.
* @throws { BusinessError } 401 - Invalid argument, Possible causes:
* 1.The limit parameter is too small
* 2.The parameter is not within the enumeration type
* 3.The parameter type error or parameter order error
* @throws { BusinessError } 11400102 - Capture trace already enabled.
* @throws { BusinessError } 11400103 - No write permission on the file.
* @throws { BusinessError } 11400104 - Abnormal trace status.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
function startAppTraceCapture(tags: number[], flag: TraceFlag, limitSize: number): string;
/**
* Stop capture application trace.
*
* @throws { BusinessError } 11400104 - The status of the trace is abnormal
* @throws { BusinessError } 11400105 - No capture trace running
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
function stopAppTraceCapture(): void;
/**
* Collection statistics.
*
* @typedef { Record<string, number> } GcStats
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
type GcStats = Record<string, number>;
/**
* Get the garbage collection statistics.
*
* @returns { GcStats } Returns garbage collection statistics.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
function getVMRuntimeStats(): GcStats;
/**
* Get the garbage collection statistics by statistical item.
*
* @param { string } item - statistical item.
* @returns { number } Returns garbage collection statistics.
* @throws { BusinessError } 401 - Possible causes:
* 1. Invalid parameter, a string parameter required.
* 2. Invalid parameter, unknown property.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
function getVMRuntimeStat(item: string): number;
/**
* Set the resource limitation of application.Please note that this function is only valid
* when the developer options switch of setting is turned on.
*
* @param { string } type - resource type. It could be pss_memory、js_heap、fd、or thread.
* @param { number } value - For different resource type, values could have different meaning:
* 1.For pss_memory, it means the baseline PSS memory size for the application,
* system memory control will be triggered if exceed the value too much.
* 2.For js_heap, it means the percentage of the used JS heap memory to the maximum limit exceed
* which heap dump will be triggered if enableDebugLog set as true, it can be set between 85 and 95.
* 3.For fd, it means the maximum fd number can be opened.
* 4.For thread, it means the maximum thread number can be created.
* @param { boolean } enableDebugLog - Whether to enable external debug log. Default is false, pls make sure set
* it as true only in gray release because collecting debug log will cost too much cpu or memory.
* @throws { BusinessError } 401 - Invalid argument, Possible causes:
* 1.The limit parameter is too small
* 2.The parameter is not in the specified type
* 3.The parameter type error or parameter order error
* @throws { BusinessError } 11400104 - Set limit failed due to remote exception
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @atomicservice
* @since 12
*/
function setAppResourceLimit(type: string, value: number, enableDebugLog: boolean): void;
/**
* Judge if the application is in debugged state, including either in arkui layer or native layer debugged state.
*
* @returns { boolean } true if the application is debugged.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @since 12
*/
function isDebugState(): boolean;
/**
* Get the graphics memory of application
*
* @returns { Promise<number> } Returns the graphics memory of application, in kilobyte.
* @throws { BusinessError } 11400104 - Failed to get the application memory due to a remote exception.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @atomicservice
* @since 14
*/
function getGraphicsMemory(): Promise<number>;
/**
* Get the graphics memory of application
*
* @returns { number } Returns the graphics memory of application, in kilobyte.
* @throws { BusinessError } 11400104 - Failed to get the application memory due to a remote exception.
* @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug
* @atomicservice
* @since 14
*/
function getGraphicsMemorySync(): number;
}
export default hidebug;
Reference in New Issue View Git Blame Copy Permalink