From 2740d304f649b393e64206242e6548ae9bef9685 Mon Sep 17 00:00:00 2001
From: j30012456 <jiangyuan29@huawei.com>
Date: Wed, 16 Feb 2022 18:19:31 +0800
Subject: [PATCH] add hidebug js api

Signed-off-by: j30012456 <jiangyuan29@huawei.com>
---
 .../reference/apis/js-apis-hidebug.md         | 171 ++++++++++++++++++
 1 file changed, 171 insertions(+)
 create mode 100644 zh-cn/application-dev/reference/apis/js-apis-hidebug.md

diff --git a/zh-cn/application-dev/reference/apis/js-apis-hidebug.md b/zh-cn/application-dev/reference/apis/js-apis-hidebug.md
new file mode 100644
index 0000000000..26465fc223
--- /dev/null
+++ b/zh-cn/application-dev/reference/apis/js-apis-hidebug.md
@@ -0,0 +1,171 @@
+# Debug调试
+
+> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
+> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
+
+使用hidebug，可以获取应用内存的使用情况，包括应用进程的静态堆内存（native heap）信息、应用进程内存占用PSS（Proportional Set Size）信息等；可以完成虚拟机内存切片导出，虚拟机CPU Profiling采集等操作。
+
+## 导入模块
+
+```
+import hidebug from '@ohos.hidebug';
+```
+
+
+## 系统能力
+SystemCapability.HiviewDFX.HiProfiler.HiDebug
+
+
+## hidebug.getNativeHeapSize
+
+getNativeHeapSize(): bigint
+
+获取native heap内存的总大小。
+
+
+- **返回值**：
+  | 类型 | 说明 |
+  | -------- | -------- |
+  | bigint | 返回native heap内存总大小。 |
+
+
+- 示例：
+  ```
+  let nativeHeapSize = hidebug.getNativeHeapSize();
+  ```
+
+
+## hidebug.getNativeHeapAllocatedSize
+
+getNativeHeapAllocatedSize(): bigint
+
+获取native heap内存的已分配内存大小。
+
+
+- **返回值**：
+  | 类型 | 说明 |
+  | -------- | -------- |
+  | bigint | 返回native heap内存的已分配内存。 |
+
+
+- 示例：
+  ```
+  let nativeHeapAllocatedSize = hidebug.getNativeHeapAllocatedSize();
+  ```
+
+
+## hidebug.getNativeHeapFreeSize
+
+getNativeHeapFreeSize(): bigint
+
+获取native heap内存的空闲内存大小。
+
+
+- **返回值**：
+  | 类型 | 说明 |
+  | -------- | -------- |
+  | bigint | 返回native heap内存的空闲内存。 |
+
+
+- 示例：
+  ```
+  let nativeHeapFreeSize = hidebug.getNativeHeapFreeSize();
+  ```
+
+
+## hidebug.getPss
+
+getPss(): bigint
+
+获取应用进程PSS内存大小。
+
+
+- **返回值**：
+  | 类型 | 说明 |
+  | -------- | -------- |
+  | bigint | 返回应用进程PSS内存大小。 |
+
+
+- 示例：
+  ```
+  let pss = hidebug.getPss();
+  ```
+
+
+## hidebug.getSharedDirty
+
+getSharedDirty(): bigint
+
+获取进程的共享脏内存大小。
+
+
+- **返回值**：
+  | 类型 | 说明 |
+  | -------- | -------- |
+  | bigint | 返回进程的共享脏内存大小。 |
+
+
+- 示例：
+  ```
+  let sharedDirty = hidebug.getSharedDirty());
+  ```
+
+
+## hidebug.startProfiling
+
+startProfiling(filename : string) : void
+
+启动虚拟机Profiling方法跟踪，`startProfiling()`方法的调用需要与`stopProfiling()`方法的调用一一对应，先开启后关闭，严禁使用`start->start->stop`，`start->stop->stop`，`start->start->stop->stop`等顺序的调用方式。
+
+* **参数**：
+
+| 参数名   | 类型   | 必填 | 说明                                                         |
+| -------- | ------ | ---- | ------------------------------------------------------------ |
+| filename | string | 是   | 用户自定义的profiling文件名，根据传入的`filename`，将在应用的`files`目录生成`filename.json`文件。 |
+
+* **示例**：
+
+```js
+hidebug.startProfiling("cpuprofiler-20220216");
+// code block
+// ...
+// code block
+hidebug.stopProfiling();
+```
+
+
+
+## hidebug.stopProfiling
+
+stopProfiling() : void
+
+停止虚拟机Profiling方法跟踪，`stopProfiling()`方法的调用需要与`startProfiling()`方法的调用一一对应，先开启后关闭，严禁使用`start->start->stop`，`start->stop->stop`，`start->start->stop->stop`等顺序的调用方式。
+
+* **示例**：
+
+```js
+hidebug.startProfiling("cpuprofiler-20220216");
+// code block
+// ...
+// code block
+hidebug.stopProfiling();
+```
+
+## hidebug.dumpHeapData
+
+dumpHeapData(filename : string) : void
+
+虚拟机堆导出。
+
+* **参数**：
+
+| 参数名   | 类型   | 必填 | 说明                                                         |
+| -------- | ------ | ---- | ------------------------------------------------------------ |
+| filename | string | 是   | 用户自定义的虚拟机堆文件名，根据传入的`filename`，将在应用的`files`目录生成`filename.heapsnapshot`文件。 |
+
+* **示例**：
+
+```js
+hidebug.dumpHeapData("heap-20220216");
+```
+
-- 
GitLab