Implement global realm and support realms for built-in objects

JerryScript-DCO-1.0-Signed-off-by: Zoltan Herczeg [email protected]

Author: zherczeg

docs/02.API-REFERENCE.md

@@ -141,6 +141,8 @@ Possible compile time enabled feature types:
  - JERRY_FEATURE_SET - Set support
  - JERRY_FEATURE_WEAKMAP - WeakMap support
  - JERRY_FEATURE_WEAKSET - WeakSet support
+ - JERRY_FEATURE_BIGINT - BigInt support
+ - JERRY_FEATURE_REALM - realm support
 
 *New in version 2.0*.
 
@@ -5969,6 +5971,38 @@ jerry_create_undefined (void);
 - [jerry_release_value](#jerry_release_value)
 
 
+## jerry_create_realm
+
+**Summary**
+
+Creates a `jerry_value_t` representing a new global object.
+
+**Prototype**
+
+```c
+jerry_value_t
+jerry_create_realm (void);
+```
+
+- return value - realm object value
+
+**Example**
+
+```c
+{
+  jerry_value_t realm_value = jerry_create_realm ();
+
+  ... // usage of the value
+
+  jerry_release_value (realm_value);
+}
+```
+
+**See also**
+
+- [jerry_release_value](#jerry_release_value)
+
+
 # General API functions of JS objects
 
 ## jerry_has_property

jerry-core/api/jerry.c

@@ -1341,6 +1341,9 @@ jerry_is_feature_enabled (const jerry_feature_t feature) /**< feature to check *
 #if ENABLED (JERRY_BUILTIN_BIGINT)
           || feature == JERRY_FEATURE_BIGINT
 #endif /* ENABLED (JERRY_BUILTIN_BIGINT) */
+#if ENABLED (JERRY_BUILTIN_REALMS)
+          || feature == JERRY_FEATURE_REALM
+#endif /* ENABLED (JERRY_BUILTIN_REALMS) */
           );
 } /* jerry_is_feature_enabled */
 
@@ -2299,6 +2302,24 @@ jerry_create_regexp_sz (const jerry_char_t *pattern_p, /**< zero-terminated UTF-
 #endif /* ENABLED (JERRY_BUILTIN_REGEXP) */
 } /* jerry_create_regexp_sz */
 
+/**
+ * Creates a new realm (global object).
+ *
+ * @return new realm object
+ */
+jerry_value_t
+jerry_create_realm (void)
+{
+  jerry_assert_api_available ();
+
+#if ENABLED (JERRY_BUILTIN_REALMS)
+  ecma_global_object_t *global_object_p = ecma_builtin_create_global_object ();
+  return ecma_make_object_value ((ecma_object_t *) global_object_p);
+#else /* !ENABLED (JERRY_BUILTIN_REALMS) */
+  return jerry_throw (ecma_raise_type_error (ECMA_ERR_MSG ("Realms are disabled.")));
+#endif /* ENABLED (JERRY_BUILTIN_REALMS) */
+} /* jerry_create_realm */
+
 /**
  * Get length of an array object
  *

jerry-core/config.h

@@ -79,6 +79,10 @@
 # define JERRY_ESNEXT 1
 #endif /* !defined (JERRY_ESNEXT) */
 
+#ifndef JERRY_BUILTIN_REALMS
+# define JERRY_BUILTIN_REALMS JERRY_ESNEXT
+#endif /* !defined (JERRY_BUILTIN_REALMS) */
+
 #ifndef JERRY_BUILTIN_DATAVIEW
 # define JERRY_BUILTIN_DATAVIEW JERRY_ESNEXT
 #endif /* !defined (JERRY_BUILTIN_DATAVIEW) */
@@ -523,6 +527,10 @@
 || ((JERRY_ESNEXT != 0) && (JERRY_ESNEXT != 1))
 # error "Invalid value for JERRY_ESNEXT macro."
 #endif
+#if !defined (JERRY_BUILTIN_REALMS) \
+|| ((JERRY_BUILTIN_REALMS != 0) && (JERRY_BUILTIN_REALMS != 1))
+# error "Invalid value for JERRY_BUILTIN_REALMS macro."
+#endif
 #if !defined (JERRY_BUILTIN_DATAVIEW) \
 || ((JERRY_BUILTIN_DATAVIEW != 0) && (JERRY_BUILTIN_DATAVIEW != 1))
 # error "Invalid value for JERRY_BUILTIN_DATAVIEW macro."

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

@@ -149,6 +149,33 @@ ecma_deref_object (ecma_object_t *object_p) /**< object */
   object_p->type_flags_refs = (uint16_t) (object_p->type_flags_refs - ECMA_OBJECT_REF_ONE);
 } /* ecma_deref_object */
 
+/**
+ * Mark objects referenced by global object
+ */
+static void
+ecma_gc_mark_global_object (ecma_global_object_t *global_object_p) /**< global object */
+{
+  JERRY_ASSERT (global_object_p->extended_object.u.built_in.routine_id == 0);
+
+  ecma_gc_set_object_visited (ECMA_GET_NON_NULL_POINTER (ecma_object_t, global_object_p->global_env_cp));
+
+#if ENABLED (JERRY_ESNEXT)
+  if (global_object_p->global_scope_cp != global_object_p->global_env_cp)
+  {
+    ecma_gc_set_object_visited (ECMA_GET_NON_NULL_POINTER (ecma_object_t, global_object_p->global_scope_cp));
+  }
+#endif /* ENABLED (JERRY_ESNEXT) */
+
+  jmem_cpointer_t *builtin_objects_p = global_object_p->builtin_objects;
+  for (int i = 0; i < ECMA_BUILTIN_OBJECTS_COUNT; i++)
+  {
+    if (builtin_objects_p[i] != JMEM_CP_NULL)
+    {
+      ecma_gc_set_object_visited (ECMA_GET_NON_NULL_POINTER (ecma_object_t, builtin_objects_p[i]));
+    }
+  }
+} /* ecma_gc_mark_global_object */
+
 /**
  * Mark objects referenced by arguments object
  */
@@ -620,14 +647,52 @@ ecma_gc_mark (ecma_object_t *object_p) /**< object to mark from */
     {
       ecma_object_t *binding_object_p = ecma_get_lex_env_binding_object (object_p);
       ecma_gc_set_object_visited (binding_object_p);
-
       return;
     }
   }
   else
   {
-    switch (ecma_get_object_type (object_p))
+    ecma_object_type_t object_type = ecma_get_object_type (object_p);
+
+#if ENABLED (JERRY_BUILTIN_REALMS)
+    if (JERRY_UNLIKELY (ecma_get_object_is_builtin (object_p)))
+    {
+      ecma_value_t realm_value;
+
+      if (ECMA_BUILTIN_IS_EXTENDED_BUILT_IN (object_type))
+      {
+        realm_value = ((ecma_extended_built_in_object_t *) object_p)->built_in.realm_value;
+      }
+      else
+      {
+        ecma_extended_object_t *extended_object_p = (ecma_extended_object_t *) object_p;
+
+        if (object_type == ECMA_OBJECT_TYPE_GENERAL
+            && extended_object_p->u.built_in.id == ECMA_BUILTIN_ID_GLOBAL)
+        {
+          ecma_gc_mark_global_object ((ecma_global_object_t *) object_p);
+        }
+
+        realm_value = extended_object_p->u.built_in.realm_value;
+      }
+
+      ecma_gc_set_object_visited (ECMA_GET_INTERNAL_VALUE_POINTER (ecma_object_t, realm_value));
+    }
+#endif /* ENABLED (JERRY_BUILTIN_REALMS) */
+
+    switch (object_type)
     {
+#if !ENABLED (JERRY_BUILTIN_REALMS)
+      case ECMA_OBJECT_TYPE_GENERAL:
+      {
+        if (JERRY_UNLIKELY (ecma_get_object_is_builtin (object_p))
+            && ((ecma_extended_object_t *) object_p)->u.built_in.id == ECMA_BUILTIN_ID_GLOBAL)
+        {
+          ecma_gc_mark_global_object ((ecma_global_object_t *) object_p);
+        }
+        break;
+      }
+#endif /* !ENABLED (JERRY_BUILTIN_REALMS) */
       case ECMA_OBJECT_TYPE_CLASS:
       {
         ecma_extended_object_t *ext_object_p = (ecma_extended_object_t *) object_p;
@@ -1305,23 +1370,24 @@ ecma_gc_free_object (ecma_object_t *object_p) /**< object to free */
   {
     uint8_t length_and_bitset_size;
 
-    if (object_type == ECMA_OBJECT_TYPE_CLASS || object_type == ECMA_OBJECT_TYPE_ARRAY)
+    if (ECMA_BUILTIN_IS_EXTENDED_BUILT_IN (object_type))
     {
       ext_object_size = sizeof (ecma_extended_built_in_object_t);
       length_and_bitset_size = ((ecma_extended_built_in_object_t *) object_p)->built_in.u.length_and_bitset_size;
       ext_object_size += sizeof (uint64_t) * (length_and_bitset_size >> ECMA_BUILT_IN_BITSET_SHIFT);
     }
     else
     {
-      if (object_type == ECMA_OBJECT_TYPE_NATIVE_FUNCTION
-          && ecma_builtin_function_is_routine (object_p))
+      ecma_extended_object_t *extended_object_p = (ecma_extended_object_t *) object_p;
+
+      if (extended_object_p->u.built_in.routine_id > 0)
       {
-#if ENABLED (JERRY_ESNEXT)
-        ecma_extended_object_t *ext_obj_p = (ecma_extended_object_t *) object_p;
+        JERRY_ASSERT (object_type == ECMA_OBJECT_TYPE_NATIVE_FUNCTION);
 
-        if (ext_obj_p->u.built_in.id == ECMA_BUILTIN_ID_HANDLER)
+#if ENABLED (JERRY_ESNEXT)
+        if (extended_object_p->u.built_in.id == ECMA_BUILTIN_ID_HANDLER)
         {
-          switch (ext_obj_p->u.built_in.routine_id)
+          switch (extended_object_p->u.built_in.routine_id)
           {
             case ECMA_NATIVE_HANDLER_PROMISE_RESOLVE:
             case ECMA_NATIVE_HANDLER_PROMISE_REJECT:
@@ -1367,6 +1433,11 @@ ecma_gc_free_object (ecma_object_t *object_p) /**< object to free */
         }
 #endif /* ENABLED (JERRY_ESNEXT) */
       }
+      else if (extended_object_p->u.built_in.id == ECMA_BUILTIN_ID_GLOBAL)
+      {
+        JERRY_ASSERT (object_type == ECMA_OBJECT_TYPE_GENERAL);
+        ext_object_size = sizeof (ecma_global_object_t);
+      }
       else
       {
         length_and_bitset_size = ((ecma_extended_object_t *) object_p)->u.built_in.u.length_and_bitset_size;

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

@@ -864,14 +864,30 @@ typedef struct
     uint8_t instantiated_bitset[1]; /**< instantiated property bit set for generic built-ins */
     uint8_t routine_flags; /**< flags for built-in routines */
   } u2;
+
+#if ENABLED (JERRY_BUILTIN_REALMS)
+  ecma_value_t realm_value; /**< realm value */
+#else /* !ENABLED (JERRY_BUILTIN_REALMS) */
   uint32_t continue_instantiated_bitset[1]; /**< bit set for instantiated properties */
+#endif /* ENABLED (JERRY_BUILTIN_REALMS) */
 } ecma_built_in_props_t;
 
+#if ENABLED (JERRY_BUILTIN_REALMS)
+
+/**
+ * Number of bits available in the instantiated bitset without allocation
+ */
+#define ECMA_BUILTIN_INSTANTIATED_BITSET_MIN_SIZE (8)
+
+#else /* !ENABLED (JERRY_BUILTIN_REALMS) */
+
 /**
  * Number of bits available in the instantiated bitset without allocation
  */
 #define ECMA_BUILTIN_INSTANTIATED_BITSET_MIN_SIZE (8 + 32)
 
+#endif /* ENABLED (JERRY_BUILTIN_REALMS) */
+
 /**
  * Builtin routine function object status flags
  */
@@ -992,6 +1008,12 @@ typedef struct
   ecma_built_in_props_t built_in; /**< built-in object part */
 } ecma_extended_built_in_object_t;
 
+/**
+ * Checks whether the built-in is an ecma_extended_built_in_object_t
+ */
+#define ECMA_BUILTIN_IS_EXTENDED_BUILT_IN(object_type) \
+  ((object_type) == ECMA_OBJECT_TYPE_CLASS || (object_type) == ECMA_OBJECT_TYPE_ARRAY)
+
 /**
  * Flags for array.length_prop_and_hole_count
  */

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

@@ -250,7 +250,7 @@ ecma_get_object_builtin_id (ecma_object_t *object_p) /**< object */
   ecma_built_in_props_t *built_in_props_p;
   ecma_object_type_t object_type = ecma_get_object_type (object_p);
 
-  if (object_type == ECMA_OBJECT_TYPE_CLASS || object_type == ECMA_OBJECT_TYPE_ARRAY)
+  if (ECMA_BUILTIN_IS_EXTENDED_BUILT_IN (object_type))
   {
     built_in_props_p = &((ecma_extended_built_in_object_t *) object_p)->built_in;
   }

jerry-core/ecma/base/ecma-init-finalize.c

@@ -77,16 +77,17 @@ ecma_finalize (void)
 
   ecma_finalize_global_environment ();
   uint8_t runs = 0;
+
   do
   {
-    ecma_finalize_builtins ();
     ecma_gc_run ();
     if (++runs >= JERRY_GC_LOOP_LIMIT)
     {
       jerry_fatal (ERR_UNTERMINATED_GC_LOOPS);
     }
   }
   while (JERRY_CONTEXT (ecma_gc_new_objects) != 0);
+
   ecma_finalize_lit_storage ();
 } /* ecma_finalize */