Implement basic per-context module data

Given an expected number of modules (JERRY_CONTEXT_MODULE_COUNT) which
can be defined at compile time, reserve two pointers in each context for
module-specific data: one void * for the data, and a function pointer
for the deleter to be called when the context is discarded.

The modules receive an index into the data array when they register.
They can later use the index to store data in the context.

Re #1717

JerryScript-DCO-1.0-Signed-off-by: Gabriel Schulhof [email protected]

Author: Gabriel Schulhof

jerry-core/CMakeLists.txt

@@ -32,6 +32,7 @@ set(FEATURE_SNAPSHOT_SAVE    OFF     CACHE BOOL   "Enable saving snapshot files?
 set(FEATURE_SYSTEM_ALLOCATOR OFF     CACHE BOOL   "Enable system allocator?")
 set(FEATURE_VALGRIND         OFF     CACHE BOOL   "Enable Valgrind support?")
 set(FEATURE_VALGRIND_FREYA   OFF     CACHE BOOL   "Enable Valgrind-Freya support?")
+set(FEATURE_MODULE_REGISTER  OFF     CACHE BOOL   "Enable module registration support?")
 set(MEM_HEAP_SIZE_KB         "512"   CACHE STRING "Size of memory heap, in kilobytes")
 
 if(FEATURE_SYSTEM_ALLOCATOR)
@@ -54,6 +55,7 @@ message(STATUS "FEATURE_SNAPSHOT_SAVE     " ${FEATURE_SNAPSHOT_SAVE})
 message(STATUS "FEATURE_SYSTEM_ALLOCATOR  " ${FEATURE_SYSTEM_ALLOCATOR})
 message(STATUS "FEATURE_VALGRIND          " ${FEATURE_VALGRIND})
 message(STATUS "FEATURE_VALGRIND_FREYA    " ${FEATURE_VALGRIND_FREYA})
+message(STATUS "FEATURE_MODULE_REGISTER   " ${FEATURE_MODULE_REGISTER})
 message(STATUS "MEM_HEAP_SIZE_KB          " ${MEM_HEAP_SIZE_KB})
 
 # Include directories
@@ -241,6 +243,11 @@ if(FEATURE_VALGRIND_FREYA)
   set(INCLUDE_CORE ${INCLUDE_CORE} ${INCLUDE_THIRD_PARTY_VALGRIND})
 endif()
 
+# Module registration
+if(FEATURE_MODULE_REGISTER)
+  set(DEFINES_JERRY ${DEFINES_JERRY} JERRY_MODULE_REGISTER)
+endif()
+
 # Size of heap
 math(EXPR MEM_HEAP_AREA_SIZE "${MEM_HEAP_SIZE_KB} * 1024")
 set(DEFINES_JERRY ${DEFINES_JERRY} CONFIG_MEM_HEAP_AREA_SIZE=${MEM_HEAP_AREA_SIZE})

jerry-core/jcontext/jcontext.h

@@ -34,6 +34,16 @@
  */
 #define JERRY_CONTEXT_FIRST_MEMBER ecma_builtin_objects
 
+#ifndef JERRY_CONTEXT_MODULE_COUNT
+#define JERRY_CONTEXT_MODULE_COUNT 8
+#endif /* ndef JERRY_CONTEXT_MODULE_COUNT */
+
+typedef struct
+{
+  void (*deleter)(void *);
+  void *data;
+} jerry_module_data_t;
+
 /**
  * JerryScript context
  *
@@ -103,6 +113,9 @@ typedef struct
   uint8_t valgrind_freya_mempool_request; /**< Tells whether a pool manager
                                            *   allocator request is in progress */
 #endif /* JERRY_VALGRIND_FREYA */
+#ifdef JERRY_MODULE_REGISTER
+  jerry_module_data_t module_data[JERRY_CONTEXT_MODULE_COUNT];
+#endif /* JERRY_MODULE_REGISTER */
 } jerry_context_t;
 
 /**

jerry-core/jerry.c

@@ -2087,3 +2087,55 @@ jerry_dispatch_object_free_callback (ecma_external_pointer_t freecb_p, /**< poin
 
   jerry_make_api_available ();
 } /* jerry_dispatch_object_free_callback */
+
+#ifdef JERRY_MODULE_REGISTER
+/**
+ * Reserve a slot in the context for a module
+ *
+ * Returns: 0 or positive on success, -1 on failure.
+ */
+
+/* This value is context-independent */
+static int module_index = -1;
+int
+jerry_register_module (void)
+{
+  if (module_index == JERRY_CONTEXT_MODULE_COUNT - 1)
+  {
+    return -1;
+  }
+  return (++module_index);
+} /* jerry_register_module */
+
+/**
+ * Retrieve the module's data from the context
+ *
+ * Returns: The module's data on success, NULL of failure.
+ */
+void *
+jerry_get_module_data (int index)
+{
+  void *return_value = NULL;
+
+  if (index >= 0 && index < JERRY_CONTEXT_MODULE_COUNT)
+  {
+    return_value = (JERRY_CONTEXT (module_data)[index]).data;
+  }
+
+  return return_value;
+} /* jerry_get_module_data */
+
+/**
+ * Set the module's data for the context
+ */
+void
+jerry_set_module_data (int index, void *data, void (*deleter)(void *))
+{
+  if (index >= 0 && index < JERRY_CONTEXT_MODULE_COUNT)
+  {
+    (JERRY_CONTEXT (module_data)[index]).data = data;
+    (JERRY_CONTEXT (module_data)[index]).deleter = deleter;
+  }
+} /* jerry_set_module_data */
+
+#endif /* JERRY_MODULE_REGISTER */

jerry-core/jerryscript.h

@@ -343,6 +343,13 @@ jerry_value_t jerry_exec_snapshot (const uint32_t *snapshot_p, size_t snapshot_s
 size_t jerry_parse_and_save_literals (const jerry_char_t *source_p, size_t source_size, bool is_strict,
                                       uint32_t *buffer_p, size_t buffer_size, bool is_c_format);
 
+/**
+ * Module management
+ */
+int jerry_register_module (void);
+void *jerry_get_module_data (int index);
+void jerry_set_module_data (int index, void *data, void (*deleter)(void *));
+
 /**
  * @}
  */

targets/particle/Makefile.particle

@@ -56,6 +56,7 @@ jerrycore:
 	 -DFEATURE_ERROR_MESSAGES=OFF \
 	 -DFEATURE_VALGRIND=OFF \
 	 -DFEATURE_VALGRIND_FREYA=OFF \
+	 -DFEATURE_MODULE_REGISTER=OFF \
 	 -DFEATURE_CPOINTER_32_BIT=OFF \
 	 -DFEATURE_MEM_STRESS_TEST=OFF \
 	 -DFEATURE_MEM_STATS=OFF \

tools/build.py

@@ -126,6 +126,8 @@ def devhelp(helpstring):
                           help=devhelp('enable Valgrind support (%(choices)s; default: %(default)s)'))
     devgroup.add_argument('--valgrind-freya', metavar='X', choices=['ON', 'OFF'], default='OFF', type=str.upper,
                           help=devhelp('enable Valgrind-Freya support (%(choices)s; default: %(default)s)'))
+    devgroup.add_argument('--module-registration', metavar='X', choices=['ON', 'OFF'], default='OFF', type=str.upper,
+                          help=devhelp('enable module registration support (%(choices)s; default: %(default)s)'))
 
     arguments = parser.parse_args(args)
     if arguments.devhelp:
@@ -177,6 +179,7 @@ def generate_build_options(arguments):
     build_options.append('-DFEATURE_REGEXP_DUMP=%s' % arguments.show_regexp_opcodes)
     build_options.append('-DFEATURE_VALGRIND=%s' % arguments.valgrind)
     build_options.append('-DFEATURE_VALGRIND_FREYA=%s' % arguments.valgrind_freya)
+    build_options.append('-DFEATURE_MODULE_REGISTER=%s' % arguments.module_registration)
 
     return build_options