Rework module parsing and execution (#4462)

This patch disables automatic detection of module code, and instead
requires the user to explicitly specify whether to parse a source
as a module or as a script.

To achieve this the jerry_parse API function now takes a new option
which signals that the source should be parsed as a module.

JerryScript-DCO-1.0-Signed-off-by: Dániel Bátyai [email protected]

Author: Dániel Bátyai

docs/02.API-REFERENCE.md

@@ -212,8 +212,10 @@ Option bits for [jerry_parse](#jerry_parse) and
 
  - JERRY_PARSE_NO_OPTS - no options passed
  - JERRY_PARSE_STRICT_MODE - enable strict mode
+ - JERRY_PARSE_MODULE - parse source as an ECMAScript module
 
 *New in version 2.0*.
+*Changed in version 2.4: Added `JERRY_PARSE_MODULE`.*
 
 ## jerry_gc_mode_t
 

jerry-core/api/jerry.c

@@ -246,10 +246,6 @@ jerry_cleanup (void)
     }
   }
 
-#if ENABLED (JERRY_MODULE_SYSTEM)
-  ecma_module_cleanup ();
-#endif /* ENABLED (JERRY_MODULE_SYSTEM) */
-
 #if ENABLED (JERRY_BUILTIN_PROMISE)
   ecma_free_all_enqueued_jobs ();
 #endif /* ENABLED (JERRY_BUILTIN_PROMISE) */
@@ -456,6 +452,15 @@ jerry_parse (const jerry_char_t *resource_name_p, /**< resource name (usually a
   }
 #endif /* ENABLED (JERRY_RESOURCE_NAME) */
 
+  if ((parse_opts & JERRY_PARSE_MODULE) != 0)
+  {
+#if ENABLED (JERRY_MODULE_SYSTEM)
+    ecma_module_initialize_context (ecma_get_string_from_value (resource_name));
+#else /* !ENABLED (JERRY_MODULE_SYSTEM) */
+    return jerry_throw (ecma_raise_syntax_error (ECMA_ERR_MSG ("Module system has been disabled.")));
+#endif /* !ENABLED (JERRY_MODULE_SYSTEM) */
+  }
+
   ecma_compiled_code_t *bytecode_data_p = parser_parse_script (NULL,
                                                                0,
                                                                source_p,
@@ -465,16 +470,54 @@ jerry_parse (const jerry_char_t *resource_name_p, /**< resource name (usually a
 
   if (JERRY_UNLIKELY (bytecode_data_p == NULL))
   {
+#if ENABLED (JERRY_MODULE_SYSTEM)
+    if ((parse_opts & JERRY_PARSE_MODULE) != 0)
+    {
+      ecma_module_cleanup_context ();
+    }
+#endif /* ENABLED (JERRY_MODULE_SYSTEM) */
+
     return ecma_create_error_reference_from_context ();
   }
 
+#if ENABLED (JERRY_MODULE_SYSTEM)
+  if ((parse_opts & JERRY_PARSE_MODULE) != 0)
+  {
+    if (ECMA_IS_VALUE_ERROR (ecma_module_parse_referenced_modules ()))
+    {
+      ecma_bytecode_deref (bytecode_data_p);
+      ecma_module_cleanup_context ();
+
+      return ecma_create_error_reference_from_context ();
+    }
+
+    ecma_object_t *obj_p = ecma_create_object (NULL, sizeof (ecma_extended_object_t), ECMA_OBJECT_TYPE_CLASS);
+
+    ecma_extended_object_t *wrapper_p = (ecma_extended_object_t *) obj_p;
+    wrapper_p->u.class_prop.class_id = LIT_MAGIC_STRING_RUNNABLE_UL;
+    wrapper_p->u.class_prop.extra_info = ECMA_RUNNABLE_FLAGS_MODULE;
+
+    ecma_module_t *root_module_p = JERRY_CONTEXT (module_current_p);
+    root_module_p->compiled_code_p = bytecode_data_p;
+
+    ECMA_SET_INTERNAL_VALUE_POINTER (wrapper_p->u.class_prop.u.value, root_module_p);
+    JERRY_CONTEXT (module_current_p) = NULL;
+    JERRY_CONTEXT (module_list_p) = NULL;
+
+    return ecma_make_object_value (obj_p);
+  }
+#endif /* ENABLED (JERRY_MODULE_SYSTEM) */
+
   ecma_object_t *global_object_p = ecma_builtin_get_global ();
 
 #if ENABLED (JERRY_BUILTIN_REALMS)
   JERRY_ASSERT (global_object_p == (ecma_object_t *) ecma_op_function_get_realm (bytecode_data_p));
 #endif /* ENABLED (JERRY_BUILTIN_REALMS) */
 
   ecma_object_t *lex_env_p = ecma_get_global_environment (global_object_p);
+
+  /* TODO(dbatyai): For now Scripts continue to return Function objects due to backwards compatibility. This should be
+   * changed to also return a Runnable object eventually. */
   ecma_object_t *func_obj_p = ecma_op_create_simple_function_object (lex_env_p, bytecode_data_p);
   ecma_bytecode_deref (bytecode_data_p);
 
@@ -588,15 +631,35 @@ jerry_run (const jerry_value_t func_val) /**< function to run */
     return jerry_throw (ecma_raise_type_error (ECMA_ERR_MSG (wrong_args_msg_p)));
   }
 
-  ecma_object_t *func_obj_p = ecma_get_object_from_value (func_val);
+  ecma_object_t *obj_p = ecma_get_object_from_value (func_val);
+
+#if ENABLED (JERRY_MODULE_SYSTEM)
+  if (ecma_object_class_is (obj_p, LIT_MAGIC_STRING_RUNNABLE_UL))
+  {
+    ecma_extended_object_t *wrapper_p = (ecma_extended_object_t *) obj_p;
+    JERRY_ASSERT (wrapper_p->u.class_prop.extra_info == ECMA_RUNNABLE_FLAGS_MODULE);
+    ecma_module_t *root_module_p = ECMA_GET_INTERNAL_VALUE_POINTER (ecma_module_t, wrapper_p->u.class_prop.u.value);
+
+#if ENABLED (JERRY_BUILTIN_REALMS)
+    ecma_object_t *global_object_p = (ecma_object_t *) ecma_op_function_get_realm (root_module_p->compiled_code_p);
+#else /* !ENABLED (JERRY_BUILTIN_REALMS) */
+    ecma_object_t *global_object_p = ecma_builtin_get_global ();
+#endif /* ENABLED (JERRY_BUILTIN_REALMS) */
+
+    ecma_create_global_lexical_block (global_object_p);
+    root_module_p->scope_p = ecma_get_global_scope (global_object_p);
+
+    return jerry_return (vm_run_module (root_module_p));
+  }
+#endif /* ENABLED (JERRY_MODULE_SYSTEM) */
 
-  if (ecma_get_object_type (func_obj_p) != ECMA_OBJECT_TYPE_FUNCTION
-      || ecma_get_object_is_builtin (func_obj_p))
+  if (ecma_get_object_type (obj_p) != ECMA_OBJECT_TYPE_FUNCTION
+      || ecma_get_object_is_builtin (obj_p))
   {
     return jerry_throw (ecma_raise_type_error (ECMA_ERR_MSG (wrong_args_msg_p)));
   }
 
-  ecma_extended_object_t *ext_func_p = (ecma_extended_object_t *) func_obj_p;
+  ecma_extended_object_t *ext_func_p = (ecma_extended_object_t *) obj_p;
 
   const ecma_compiled_code_t *bytecode_data_p = ecma_op_function_get_compiled_code (ext_func_p);
 

jerry-core/ecma/base/ecma-gc.c

@@ -1630,6 +1630,20 @@ ecma_gc_free_object (ecma_object_t *object_p) /**< object to free */
           break;
         }
 #endif /* ENABLED (JERRY_ESNEXT) */
+#if ENABLED (JERRY_MODULE_SYSTEM)
+        case LIT_MAGIC_STRING_RUNNABLE_UL:
+        {
+          ecma_extended_object_t *wrapper_p = (ecma_extended_object_t *) object_p;
+
+          JERRY_ASSERT (wrapper_p->u.class_prop.extra_info == ECMA_RUNNABLE_FLAGS_MODULE);
+          ecma_module_t *root_module_p = ECMA_GET_INTERNAL_VALUE_POINTER (ecma_module_t,
+                                                                          wrapper_p->u.class_prop.u.value);
+
+          ecma_bytecode_deref (root_module_p->compiled_code_p);
+          ecma_module_cleanup (root_module_p);
+          break;
+        }
+#endif /* ENABLED (JERRY_MODULE_SYSTEM) */
         default:
         {
           /* The undefined id represents an uninitialized class. */

jerry-core/ecma/base/ecma-globals.h

@@ -1059,6 +1059,14 @@ typedef struct
 #endif /* ENABLED (JERRY_SNAPSHOT_EXEC) */
 
 #if ENABLED (JERRY_ESNEXT)
+/**
+ * Flags for runnable objects.
+ */
+typedef enum
+{
+  ECMA_RUNNABLE_FLAGS_EMPTY = (0), /**< empty flags */
+  ECMA_RUNNABLE_FLAGS_MODULE = (1 << 0) /**< runnable is a module */
+} ecma_runnable_flags_t;
 
 /**
  * Description of arrow function objects.