From 7a3b5eacbd05134db26d06533125977e4672d2a4 Mon Sep 17 00:00:00 2001
From: greensue <shulin3@huawei.com>
Date: Fri, 15 Nov 2024 09:29:35 +0800
Subject: [PATCH] =?UTF-8?q?jsvm=E6=96=B0=E5=A2=9EAPI--OH=5FJSVM=5FTraceSta?=
 =?UTF-8?q?rt=E5=92=8COH=5FJSVM=5FTraceStop?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: greensue <shulin3@huawei.com>
---
 ark_runtime/jsvm/jsvm.h           | 29 +++++++++++++++++++++++++++++
 ark_runtime/jsvm/jsvm_types.h     | 22 ++++++++++++++++++++++
 ark_runtime/jsvm/libjsvm.ndk.json |  8 ++++++++
 3 files changed, 59 insertions(+)

diff --git a/ark_runtime/jsvm/jsvm.h b/ark_runtime/jsvm/jsvm.h
index 3f47366b4..d5a02c5fb 100644
--- a/ark_runtime/jsvm/jsvm.h
+++ b/ark_runtime/jsvm/jsvm.h
@@ -3045,6 +3045,35 @@ JSVM_EXTERN JSVM_Status OH_JSVM_CreateWasmCache(JSVM_Env env,
 JSVM_EXTERN JSVM_Status OH_JSVM_ReleaseCache(JSVM_Env env,
                                              const uint8_t* cacheData,
                                              JSVM_CacheType cacheType);
+
+/**
+ * @brief Trace start with specified categories for all JSVM VM.(Non-thread-safe)
+ *
+ * @param count The count of trace categories.
+ * @param categories Select internal trace events for tracing by categories.
+ * @param tag User-defined tag of trace data.
+ * @param eventsCount Number of trace events.
+ * @return Returns JSVM funtions result code.
+ *         {@link JSVM_OK } if the function executed successfully.\n
+ *         {@link JSVM_INVALID_ARG } if categories or count is illegal.\n
+ *
+ * @since 16
+ */
+JSVM_EXTERN JSVM_Status OH_JSVM_TraceStart(size_t count, const JSVM_TraceCategory* categories,
+                                           const char* tag, size_t eventsCount);
+
+/**
+ * @brief Trace stop for specified categories for all JSVM VM.(Non-thread-safe)
+ *
+ * @param stream The output stream callback for receiving the data.
+ * @param streamData Data passed to the stream callback.
+ * @return Returns JSVM funtions result code.
+ *         {@link JSVM_OK } if the function executed successfully.\n
+ *         {@link JSVM_INVALID_ARG } if stream or streamData is NULL\n
+ *
+ * @since 16
+ */
+JSVM_EXTERN JSVM_Status OH_JSVM_TraceStop(JSVM_OutputStream stream, void* streamData);
 EXTERN_C_END
 /** @} */
 #endif /* ARK_RUNTIME_JSVM_JSVM_H */
diff --git a/ark_runtime/jsvm/jsvm_types.h b/ark_runtime/jsvm/jsvm_types.h
index 1141b051f..edbcdc3db 100644
--- a/ark_runtime/jsvm/jsvm_types.h
+++ b/ark_runtime/jsvm/jsvm_types.h
@@ -770,5 +770,27 @@ typedef enum {
     /** WebAssembly cache, generated by OH_JSVM_CreateWasmCache */
     JSVM_CACHE_TYPE_WASM,
 } JSVM_CacheType;
+
+/**
+ * @brief Trace category for jsvm internal trace events.
+ *
+ * @since 16
+ */
+typedef enum {
+    /** Tracing Main Interface Invoking of JSVM, such as run scripts. */
+    JSVM_TRACE_VM,
+    /** Tracing interface invoking about compilation, such as CompileCodeBackground. */
+    JSVM_TRACE_COMPILE,
+    /** Tracing interface invoking about execution status, such as Interrupts and Microtasks. */
+    JSVM_TRACE_EXECUTE,
+    /** Tracing external callback */
+    JSVM_TRACE_RUNTIME,
+    /** Tracing stack trace in JSVM. */
+    JSVM_TRACE_STACK_TRACE,
+    /** Tracing Main interface invoking of WASM, such as Compile Wasm Module and Instantiate. */
+    JSVM_TRACE_WASM,
+    /** Traceing more detailed interface invoking of WASM, such as background compilation and wrappers. */
+    JSVM_TRACE_WASM_DETAILED
+} JSVM_TraceCategory;
 /** @} */
 #endif /* ARK_RUNTIME_JSVM_JSVM_TYPE_H */
diff --git a/ark_runtime/jsvm/libjsvm.ndk.json b/ark_runtime/jsvm/libjsvm.ndk.json
index e0157b772..574bd76d1 100644
--- a/ark_runtime/jsvm/libjsvm.ndk.json
+++ b/ark_runtime/jsvm/libjsvm.ndk.json
@@ -734,5 +734,13 @@
     {
         "first_introduced": "12",
         "name": "OH_JSVM_ReleaseCache"
+    },
+    {
+        "first_introduced": "16",
+        "name": "OH_JSVM_TraceStart"
+    },
+    {
+        "first_introduced": "16",
+        "name": "OH_JSVM_TraceStop"
     }
 ]
-- 
Gitee