From d50b421ab3df5a71faf90a158c3eb301c66d224d Mon Sep 17 00:00:00 2001
From: chenraozhong <chenraozhong1@huawei.com>
Date: Fri, 15 Nov 2024 10:32:35 +0800
Subject: [PATCH] Add OH_JSVM_AddHandlerForGC

Signed-off-by: chenraozhong <chenraozhong1@huawei.com>
---
 ark_runtime/jsvm/jsvm.h       | 39 +++++++++++++++++++
 ark_runtime/jsvm/jsvm_types.h | 71 +++++++++++++++++++++++++++++++++++
 2 files changed, 110 insertions(+)

diff --git a/ark_runtime/jsvm/jsvm.h b/ark_runtime/jsvm/jsvm.h
index 3f47366b4..0b4ff66ae 100644
--- a/ark_runtime/jsvm/jsvm.h
+++ b/ark_runtime/jsvm/jsvm.h
@@ -3045,6 +3045,45 @@ 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 Add VM GC Callback.
+ *
+ * @param vm The environment that the API is invoked under.
+ * @param triggerTime The timing of GC callback trigger.
+ * @param handler When Trigger gc, the callback function will be called.
+ * @param gcType The type of gc.
+ * @param userData The native pointer data.
+ * @return Returns JSVM funtions result code.
+ *         {@link JSVM_OK } if the function executed successfully.\n
+ *         {@link JSVM_INVALID_ARG } if the vm or the handler is NULL or the handler has been added before.\n
+ *
+ * @since 16
+ */
+JSVM_EXTERN JSVM_Status OH_JSVM_AddHandlerForGC(JSVM_VM vm,
+                                                JSVM_CBTriggerTimeForGC triggerTime,
+                                                JSVM_HandlerForGC handler,
+                                                JSVM_GCType gcType,
+                                                void* userData);
+
+/**
+ * @brief Remove VM GC Callback.
+ *
+ * @param vm The environment that the API is invoked under.
+ * @param triggerTime The timing of GC callback trigger.
+ * @param handler When Trigger gc, the callback function will be called.
+ * @param userData The native pointer data.
+ * @return Returns JSVM funtions result code.
+ *         {@link JSVM_OK } if the function executed successfully.\n
+ *         {@link JSVM_INVALID_ARG } if the vm or the handler is NULL, or the handler has been removed,
+ * or the handler has nerver been added.\n
+ *
+ * @since 16
+ */
+JSVM_EXTERN JSVM_Status OH_JSVM_RemoveHandlerForGC(JSVM_VM vm,
+                                                   JSVM_CBTriggerTimeForGC triggerTime,
+                                                   JSVM_HandlerForGC handler,
+                                                   void* userData);
 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..da7fc84ca 100644
--- a/ark_runtime/jsvm/jsvm_types.h
+++ b/ark_runtime/jsvm/jsvm_types.h
@@ -770,5 +770,76 @@ typedef enum {
     /** WebAssembly cache, generated by OH_JSVM_CreateWasmCache */
     JSVM_CACHE_TYPE_WASM,
 } JSVM_CacheType;
+
+/**
+ * @brief The timing of GC callback trigger.
+ *
+ * @since 16
+ */
+typedef enum {
+    /** Trigger GC callback before GC. */
+    JSVM_CB_TRIGGER_BEFORE_GC,
+    /** Trigger GC callback after GC. */
+    JSVM_CB_TRIGGER_AFTER_GC,
+} JSVM_CBTriggerTimeForGC;
+
+/**
+ * @brief The GC type.
+ *
+ * @since 16
+ */
+typedef enum {
+    /** The GC algorithm is Scavenge. */
+    JSVM_GC_TYPE_SCAVENGE = 1 << 0,
+    /** The GC algorithm is Minor-Mark-Compact. */
+    JSVM_GC_TYPE_MINOR_MARK_COMPACT = 1 << 1,
+    /** The GC algorithm is Mark-Sweep-Compact. */
+    JSVM_GC_TYPE_MARK_SWEEP_COMPACT = 1 << 2,
+    /** The GC algorithm is Incremental-Marking. */
+    JSVM_GC_TYPE_INCREMENTAL_MARKING = 1 << 3,
+    /** The GC algorithm is Weak-Callbacks. */
+    JSVM_GC_TYPE_PROCESS_WEAK_CALLBACKS = 1 << 4,
+    /** All GC algorithm. */
+    JSVM_GC_TYPE_ALL = JSVM_GC_TYPE_SCAVENGE | JSVM_GC_TYPE_MINOR_MARK_COMPACT |
+                       JSVM_GC_TYPE_MARK_SWEEP_COMPACT | JSVM_GC_TYPE_INCREMENTAL_MARKING |
+                       JSVM_GC_TYPE_PROCESS_WEAK_CALLBACKS,
+} JSVM_GCType;
+
+/**
+ * @brief The GC callback flags.
+ *
+ * @since 16
+ */
+typedef enum {
+    /** No GC callback falgs. */
+    JSVM_NO_GC_CALLBACK_FLAGS,
+    /** Reserved object information will be built in the garbage collection callback. */
+    JSVM_GC_CALLBACK_CONSTRUCT_RETAINED_OBJECT_INFOS,
+    /** Enforce Garbage Collection Callback. */
+    JSVM_GC_CALLBACK_FORCED,
+    /** Synchronous phantom callback processing. */
+    JSVM_GC_CALLBACK_SYNCHRONOUS_PHANTOM_CALLBACK_PROCESSING,
+    /** All available garbage objects are collected during garbage collection. */
+    JSVM_GC_CALLBACK_COLLECT_ALL_AVAILABLE_GARBAGE,
+    /** Garbage collection collects all external memory. */
+    JSVM_GC_CALLBACK_COLLECT_ALL_EXTERNAL_MEMORY,
+    /** Schedule Garbage Collection at Idle Time. */
+    JSVM_GC_CALLBACK_SCHEDULE_IDLE_GARBAGE_COLLECTION,
+} JSVM_GCCallbackFlags;
+
+/**
+ * @brief Function pointer type of GC callback.
+ *
+ * @param vm The VM instance that the JSVM-API call is invoked under.
+ * @param gcType The gc type.
+ * @param flags The GC callback flags.
+ * @param data The native pointer data.
+ *
+ * @since 16
+ */
+typedef void(JSVM_CDECL* JSVM_HandlerForGC)(JSVM_VM vm,
+                                            JSVM_GCType gcType,
+                                            JSVM_GCCallbackFlags flags,
+                                            void* data);
 /** @} */
 #endif /* ARK_RUNTIME_JSVM_JSVM_TYPE_H */
-- 
Gitee