@ohos.hidebug (Debug调试)

说明：

本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

使用hidebug，可以获取应用内存的使用情况，包括应用进程的静态堆内存（native heap）信息、应用进程内存占用PSS（Proportional Set Size）信息等；可以完成虚拟机内存切片导出，虚拟机CPU Profiling采集等操作。

导入模块

import hidebug from '@ohos.hidebug';

hidebug.getNativeHeapSize

getNativeHeapSize(): bigint

获取本应用堆内存的总大小。

系统能力： SystemCapability.HiviewDFX.HiProfiler.HiDebug

返回值：

示例：

let nativeHeapSize: bigint = hidebug.getNativeHeapSize();

hidebug.getNativeHeapAllocatedSize

getNativeHeapAllocatedSize(): bigint

获取本应用堆内存的已分配内存大小。

系统能力： SystemCapability.HiviewDFX.HiProfiler.HiDebug

返回值：

示例：

let nativeHeapAllocatedSize: bigint = hidebug.getNativeHeapAllocatedSize();

hidebug.getNativeHeapFreeSize

getNativeHeapFreeSize(): bigint

获取本应用堆内存的空闲内存大小。

系统能力： SystemCapability.HiviewDFX.HiProfiler.HiDebug

返回值：

示例：

let nativeHeapFreeSize: bigint = hidebug.getNativeHeapFreeSize();

hidebug.getPss

getPss(): bigint

获取应用进程实际使用的物理内存大小。

系统能力： SystemCapability.HiviewDFX.HiProfiler.HiDebug

返回值：

示例：

let pss: bigint = hidebug.getPss();

hidebug.getSharedDirty

getSharedDirty(): bigint

获取进程的共享脏内存大小。

系统能力： SystemCapability.HiviewDFX.HiProfiler.HiDebug

返回值：

示例：

let sharedDirty: bigint = hidebug.getSharedDirty();

hidebug.getPrivateDirty⁹⁺

getPrivateDirty(): bigint

获取进程的私有脏内存大小。

系统能力： SystemCapability.HiviewDFX.HiProfiler.HiDebug

返回值：

示例：

let privateDirty: bigint = hidebug.getPrivateDirty();

hidebug.getCpuUsage⁹⁺

getCpuUsage(): number

获取进程的CPU使用率。

如占用率为50%，则返回0.5。

系统能力： SystemCapability.HiviewDFX.HiProfiler.HiDebug

返回值：

示例：

let cpuUsage: number = hidebug.getCpuUsage();

hidebug.getServiceDump⁹⁺

getServiceDump(serviceid : number, fd : number, args : Array<string>) : void

获取系统服务信息。

需要权限: ohos.permission.DUMP

系统能力： SystemCapability.HiviewDFX.HiProfiler.HiDebug

参数：

错误码：

以下错误码的详细介绍请参见Hidebug错误码。

示例：

import UIAbility from '@ohos.app.ability.UIAbility';
import fs from '@ohos.file.fs';
import hidebug from '@ohos.hidebug';
import common from '@ohos.app.ability.common';
import { BusinessError } from '@ohos.base';

export default class HidebugTest extends UIAbility {
  public testfunc() {
    let applicationContext: common.Context | null = null;
    try {
      applicationContext = this.context.getApplicationContext();
    } catch (error) {
      console.info(`error code: ${(error as BusinessError).code}, error msg: ${(error as BusinessError).message}`);
    }

    let filesDir: string = applicationContext!.filesDir;
    let path: string = filesDir + "/serviceInfo.txt";
    console.info("output path: " + path);
    let file = fs.openSync(path, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
    let serviceId: number = 10;
    let args: Array<string> = new Array("allInfo");

    try {
      hidebug.getServiceDump(serviceId, file.fd, args);
    } catch (error) {
      console.info(`error code: ${(error as BusinessError).code}, error msg: ${(error as BusinessError).message}`);
    }
    fs.closeSync(file);
  }
}

let t = new HidebugTest();
t.testfunc();

hidebug.startJsCpuProfiling⁹⁺

startJsCpuProfiling(filename : string) : void

启动虚拟机Profiling方法跟踪，startJsCpuProfiling()方法的调用需要与stopJsCpuProfiling()方法的调用一一对应，先开启后关闭，严禁使用start->start->stop，start->stop->stop，start->start->stop->stop等类似的顺序调用。

系统能力： SystemCapability.HiviewDFX.HiProfiler.HiDebug

参数：

错误码：

以下错误码的详细介绍请参见通用错误码。

示例：

import hidebug from '@ohos.hidebug';
import { BusinessError } from '@ohos.base';

try {
  hidebug.startJsCpuProfiling("cpu_profiling");
  // ...
  hidebug.stopJsCpuProfiling();
} catch (error) {
  console.info(`error code: ${(error as BusinessError).code}, error msg: ${(error as BusinessError).message}`);
}

hidebug.stopJsCpuProfiling⁹⁺

stopJsCpuProfiling() : void

停止虚拟机Profiling方法跟踪，startJsCpuProfiling()方法的调用需要与stopJsCpuProfiling()方法的调用一一对应，先开启后关闭，严禁使用start->start->stop，start->stop->stop，start->start->stop->stop等类似的顺序调用。

系统能力： SystemCapability.HiviewDFX.HiProfiler.HiDebug

参数：

示例：

import hidebug from '@ohos.hidebug';
import { BusinessError } from '@ohos.base';

try {
  hidebug.startJsCpuProfiling("cpu_profiling");
  // ...
  hidebug.stopJsCpuProfiling();
} catch (error) {
  console.info(`error code: ${(error as BusinessError).code}, error msg: ${(error as BusinessError).message}`);
}

hidebug.dumpJsHeapData⁹⁺

dumpJsHeapData(filename : string) : void

虚拟机堆导出。

系统能力： SystemCapability.HiviewDFX.HiProfiler.HiDebug

参数：

错误码：

以下错误码的详细介绍请参见通用错误码。

示例：

import hidebug from '@ohos.hidebug';
import { BusinessError } from '@ohos.base';

try {
  hidebug.dumpJsHeapData("heapData");
} catch (error) {
  console.info(`error code: ${(error as BusinessError).code}, error msg: ${(error as BusinessError).message}`);
}

hidebug.startProfiling^(deprecated)

startProfiling(filename : string) : void

说明： 从 API Version 9 开始废弃，建议使用hidebug.startJsCpuProfiling替代。

启动虚拟机Profiling方法跟踪，startProfiling()方法的调用需要与stopProfiling()方法的调用一一对应，先开启后关闭，严禁使用start->start->stop，start->stop->stop，start->start->stop->stop等类似的顺序调用。

系统能力： SystemCapability.HiviewDFX.HiProfiler.HiDebug

参数：

示例：

hidebug.startProfiling("cpuprofiler-20220216");
// code block
// ...
// code block
hidebug.stopProfiling();

hidebug.stopProfiling^(deprecated)

stopProfiling() : void

说明： 从 API Version 9 开始废弃，建议使用hidebug.stopJsCpuProfiling替代。

停止虚拟机Profiling方法跟踪，stopProfiling()方法的调用需要与startProfiling()方法的调用一一对应，先开启后关闭，严禁使用start->start->stop，start->stop->stop，start->start->stop->stop等类似的顺序调用。

系统能力： SystemCapability.HiviewDFX.HiProfiler.HiDebug

示例：

hidebug.startProfiling("cpuprofiler-20220216");
// code block
// ...
// code block
hidebug.stopProfiling();

hidebug.dumpHeapData^(deprecated)

dumpHeapData(filename : string) : void

说明： 从 API Version 9 开始废弃，建议使用hidebug.dumpJsHeapData替代。

虚拟机堆导出。

系统能力： SystemCapability.HiviewDFX.HiProfiler.HiDebug

参数：

示例：

hidebug.dumpHeapData("heap-20220216");