VM.cpp 53 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174
  1. /*
  2. * Copyright (c) 2020-2023, Andreas Kling <kling@serenityos.org>
  3. * Copyright (c) 2020-2023, Linus Groh <linusg@serenityos.org>
  4. * Copyright (c) 2021-2022, David Tuin <davidot@serenityos.org>
  5. *
  6. * SPDX-License-Identifier: BSD-2-Clause
  7. */
  8. #include <AK/Array.h>
  9. #include <AK/Debug.h>
  10. #include <AK/LexicalPath.h>
  11. #include <AK/ScopeGuard.h>
  12. #include <AK/String.h>
  13. #include <AK/StringBuilder.h>
  14. #include <LibFileSystem/FileSystem.h>
  15. #include <LibJS/AST.h>
  16. #include <LibJS/Bytecode/Interpreter.h>
  17. #include <LibJS/JIT/NativeExecutable.h>
  18. #include <LibJS/Runtime/AbstractOperations.h>
  19. #include <LibJS/Runtime/Array.h>
  20. #include <LibJS/Runtime/BoundFunction.h>
  21. #include <LibJS/Runtime/Completion.h>
  22. #include <LibJS/Runtime/ECMAScriptFunctionObject.h>
  23. #include <LibJS/Runtime/Error.h>
  24. #include <LibJS/Runtime/FinalizationRegistry.h>
  25. #include <LibJS/Runtime/FunctionEnvironment.h>
  26. #include <LibJS/Runtime/Iterator.h>
  27. #include <LibJS/Runtime/NativeFunction.h>
  28. #include <LibJS/Runtime/PromiseCapability.h>
  29. #include <LibJS/Runtime/Reference.h>
  30. #include <LibJS/Runtime/Symbol.h>
  31. #include <LibJS/Runtime/VM.h>
  32. #include <LibJS/SourceTextModule.h>
  33. #include <LibJS/SyntheticModule.h>
  34. namespace JS {
  35. ErrorOr<NonnullRefPtr<VM>> VM::create(OwnPtr<CustomData> custom_data)
  36. {
  37. ErrorMessages error_messages {};
  38. error_messages[to_underlying(ErrorMessage::OutOfMemory)] = TRY(String::from_utf8(ErrorType::OutOfMemory.message()));
  39. auto vm = adopt_ref(*new VM(move(custom_data), move(error_messages)));
  40. WellKnownSymbols well_known_symbols {
  41. #define __JS_ENUMERATE(SymbolName, snake_name) \
  42. Symbol::create(*vm, "Symbol." #SymbolName##_string, false),
  43. JS_ENUMERATE_WELL_KNOWN_SYMBOLS
  44. #undef __JS_ENUMERATE
  45. };
  46. vm->set_well_known_symbols(move(well_known_symbols));
  47. return vm;
  48. }
  49. template<u32... code_points>
  50. static constexpr auto make_single_ascii_character_strings(IndexSequence<code_points...>)
  51. {
  52. return AK::Array { (String::from_code_point(code_points))... };
  53. }
  54. static constexpr auto single_ascii_character_strings = make_single_ascii_character_strings(MakeIndexSequence<128>());
  55. VM::VM(OwnPtr<CustomData> custom_data, ErrorMessages error_messages)
  56. : m_heap(*this)
  57. , m_error_messages(move(error_messages))
  58. , m_custom_data(move(custom_data))
  59. {
  60. m_bytecode_interpreter = make<Bytecode::Interpreter>(*this);
  61. m_empty_string = m_heap.allocate_without_realm<PrimitiveString>(String {});
  62. for (size_t i = 0; i < single_ascii_character_strings.size(); ++i)
  63. m_single_ascii_character_strings[i] = m_heap.allocate_without_realm<PrimitiveString>(single_ascii_character_strings[i]);
  64. // Default hook implementations. These can be overridden by the host, for example, LibWeb overrides the default hooks to place promise jobs on the microtask queue.
  65. host_promise_rejection_tracker = [this](Promise& promise, Promise::RejectionOperation operation) {
  66. promise_rejection_tracker(promise, operation);
  67. };
  68. host_call_job_callback = [this](JobCallback& job_callback, Value this_value, ReadonlySpan<Value> arguments) {
  69. return call_job_callback(*this, job_callback, this_value, arguments);
  70. };
  71. host_enqueue_finalization_registry_cleanup_job = [this](FinalizationRegistry& finalization_registry) {
  72. enqueue_finalization_registry_cleanup_job(finalization_registry);
  73. };
  74. host_enqueue_promise_job = [this](Function<ThrowCompletionOr<Value>()> job, Realm* realm) {
  75. enqueue_promise_job(move(job), realm);
  76. };
  77. host_make_job_callback = [](FunctionObject& function_object) {
  78. return make_job_callback(function_object);
  79. };
  80. host_resolve_imported_module = [&](ScriptOrModule referencing_script_or_module, ModuleRequest const& specifier) {
  81. return resolve_imported_module(move(referencing_script_or_module), specifier);
  82. };
  83. host_import_module_dynamically = [&](ScriptOrModule, ModuleRequest const&, PromiseCapability const& promise_capability) -> ThrowCompletionOr<void> {
  84. // By default, we throw on dynamic imports this is to prevent arbitrary file access by scripts.
  85. VERIFY(current_realm());
  86. auto& realm = *current_realm();
  87. auto promise = Promise::create(realm);
  88. // If you are here because you want to enable dynamic module importing make sure it won't be a security problem
  89. // by checking the default implementation of HostImportModuleDynamically and creating your own hook or calling
  90. // vm.enable_default_host_import_module_dynamically_hook().
  91. promise->reject(Error::create(realm, ErrorType::DynamicImportNotAllowed.message()));
  92. promise->perform_then(
  93. NativeFunction::create(realm, "", [](auto&) -> ThrowCompletionOr<Value> {
  94. VERIFY_NOT_REACHED();
  95. }),
  96. NativeFunction::create(realm, "", [&promise_capability](auto& vm) -> ThrowCompletionOr<Value> {
  97. auto error = vm.argument(0);
  98. // a. Perform ! Call(promiseCapability.[[Reject]], undefined, « error »).
  99. MUST(call(vm, *promise_capability.reject(), js_undefined(), error));
  100. // b. Return undefined.
  101. return js_undefined();
  102. }),
  103. {});
  104. return {};
  105. };
  106. host_finish_dynamic_import = [&](ScriptOrModule referencing_script_or_module, ModuleRequest const& specifier, PromiseCapability const& promise_capability, Promise* promise) {
  107. return finish_dynamic_import(move(referencing_script_or_module), specifier, promise_capability, promise);
  108. };
  109. host_get_import_meta_properties = [&](SourceTextModule const&) -> HashMap<PropertyKey, Value> {
  110. return {};
  111. };
  112. host_finalize_import_meta = [&](Object*, SourceTextModule const&) {
  113. };
  114. host_get_supported_import_assertions = [&] {
  115. return Vector<DeprecatedString> { "type" };
  116. };
  117. // 19.2.1.2 HostEnsureCanCompileStrings ( callerRealm, calleeRealm ), https://tc39.es/ecma262/#sec-hostensurecancompilestrings
  118. host_ensure_can_compile_strings = [](Realm&) -> ThrowCompletionOr<void> {
  119. // The host-defined abstract operation HostEnsureCanCompileStrings takes argument calleeRealm (a Realm Record)
  120. // and returns either a normal completion containing unused or a throw completion.
  121. // It allows host environments to block certain ECMAScript functions which allow developers to compile strings into ECMAScript code.
  122. // An implementation of HostEnsureCanCompileStrings must conform to the following requirements:
  123. // - If the returned Completion Record is a normal completion, it must be a normal completion containing unused.
  124. // The default implementation of HostEnsureCanCompileStrings is to return NormalCompletion(unused).
  125. return {};
  126. };
  127. host_ensure_can_add_private_element = [](Object&) -> ThrowCompletionOr<void> {
  128. // The host-defined abstract operation HostEnsureCanAddPrivateElement takes argument O (an Object)
  129. // and returns either a normal completion containing unused or a throw completion.
  130. // It allows host environments to prevent the addition of private elements to particular host-defined exotic objects.
  131. // An implementation of HostEnsureCanAddPrivateElement must conform to the following requirements:
  132. // - If O is not a host-defined exotic object, this abstract operation must return NormalCompletion(unused) and perform no other steps.
  133. // - Any two calls of this abstract operation with the same argument must return the same kind of Completion Record.
  134. // The default implementation of HostEnsureCanAddPrivateElement is to return NormalCompletion(unused).
  135. return {};
  136. // This abstract operation is only invoked by ECMAScript hosts that are web browsers.
  137. // NOTE: Since LibJS has no way of knowing whether the current environment is a browser we always
  138. // call HostEnsureCanAddPrivateElement when needed.
  139. };
  140. }
  141. VM::~VM() = default;
  142. String const& VM::error_message(ErrorMessage type) const
  143. {
  144. VERIFY(type < ErrorMessage::__Count);
  145. auto const& message = m_error_messages[to_underlying(type)];
  146. VERIFY(!message.is_empty());
  147. return message;
  148. }
  149. void VM::enable_default_host_import_module_dynamically_hook()
  150. {
  151. host_import_module_dynamically = [&](ScriptOrModule referencing_script_or_module, ModuleRequest const& specifier, PromiseCapability const& promise_capability) {
  152. return import_module_dynamically(move(referencing_script_or_module), specifier, promise_capability);
  153. };
  154. }
  155. Bytecode::Interpreter& VM::bytecode_interpreter()
  156. {
  157. return *m_bytecode_interpreter;
  158. }
  159. void VM::gather_roots(HashMap<Cell*, HeapRoot>& roots)
  160. {
  161. roots.set(m_empty_string, HeapRoot { .type = HeapRoot::Type::VM });
  162. for (auto string : m_single_ascii_character_strings)
  163. roots.set(string, HeapRoot { .type = HeapRoot::Type::VM });
  164. #define __JS_ENUMERATE(SymbolName, snake_name) \
  165. roots.set(m_well_known_symbols.snake_name, HeapRoot { .type = HeapRoot::Type::VM });
  166. JS_ENUMERATE_WELL_KNOWN_SYMBOLS
  167. #undef __JS_ENUMERATE
  168. for (auto& symbol : m_global_symbol_registry)
  169. roots.set(symbol.value, HeapRoot { .type = HeapRoot::Type::VM });
  170. for (auto finalization_registry : m_finalization_registry_cleanup_jobs)
  171. roots.set(finalization_registry, HeapRoot { .type = HeapRoot::Type::VM });
  172. }
  173. ThrowCompletionOr<Value> VM::named_evaluation_if_anonymous_function(ASTNode const& expression, DeprecatedFlyString const& name)
  174. {
  175. // 8.3.3 Static Semantics: IsAnonymousFunctionDefinition ( expr ), https://tc39.es/ecma262/#sec-isanonymousfunctiondefinition
  176. // And 8.3.5 Runtime Semantics: NamedEvaluation, https://tc39.es/ecma262/#sec-runtime-semantics-namedevaluation
  177. if (is<FunctionExpression>(expression)) {
  178. auto& function = static_cast<FunctionExpression const&>(expression);
  179. if (!function.has_name()) {
  180. return function.instantiate_ordinary_function_expression(*this, name);
  181. }
  182. } else if (is<ClassExpression>(expression)) {
  183. auto& class_expression = static_cast<ClassExpression const&>(expression);
  184. if (!class_expression.has_name()) {
  185. return TRY(class_expression.class_definition_evaluation(*this, {}, name));
  186. }
  187. }
  188. return execute_ast_node(expression);
  189. }
  190. // 8.5.2 Runtime Semantics: BindingInitialization, https://tc39.es/ecma262/#sec-runtime-semantics-bindinginitialization
  191. ThrowCompletionOr<void> VM::binding_initialization(DeprecatedFlyString const& target, Value value, Environment* environment)
  192. {
  193. // 1. Let name be StringValue of Identifier.
  194. // 2. Return ? InitializeBoundName(name, value, environment).
  195. return initialize_bound_name(*this, target, value, environment);
  196. }
  197. // 8.5.2 Runtime Semantics: BindingInitialization, https://tc39.es/ecma262/#sec-runtime-semantics-bindinginitialization
  198. ThrowCompletionOr<void> VM::binding_initialization(NonnullRefPtr<BindingPattern const> const& target, Value value, Environment* environment)
  199. {
  200. auto& vm = *this;
  201. // BindingPattern : ObjectBindingPattern
  202. if (target->kind == BindingPattern::Kind::Object) {
  203. // 1. Perform ? RequireObjectCoercible(value).
  204. TRY(require_object_coercible(vm, value));
  205. // 2. Return ? BindingInitialization of ObjectBindingPattern with arguments value and environment.
  206. // BindingInitialization of ObjectBindingPattern
  207. // 1. Perform ? PropertyBindingInitialization of BindingPropertyList with arguments value and environment.
  208. TRY(property_binding_initialization(*target, value, environment));
  209. // 2. Return unused.
  210. return {};
  211. }
  212. // BindingPattern : ArrayBindingPattern
  213. else {
  214. // 1. Let iteratorRecord be ? GetIterator(value, sync).
  215. auto iterator_record = TRY(get_iterator(vm, value, IteratorHint::Sync));
  216. // 2. Let result be Completion(IteratorBindingInitialization of ArrayBindingPattern with arguments iteratorRecord and environment).
  217. auto result = iterator_binding_initialization(*target, iterator_record, environment);
  218. // 3. If iteratorRecord.[[Done]] is false, return ? IteratorClose(iteratorRecord, result).
  219. if (!iterator_record.done) {
  220. // iterator_close() always returns a Completion, which ThrowCompletionOr will interpret as a throw
  221. // completion. So only return the result of iterator_close() if it is indeed a throw completion.
  222. auto completion = result.is_throw_completion() ? result.release_error() : normal_completion({});
  223. if (completion = iterator_close(vm, iterator_record, move(completion)); completion.is_error())
  224. return completion.release_error();
  225. }
  226. // 4. Return ? result.
  227. return result;
  228. }
  229. }
  230. ThrowCompletionOr<Value> VM::execute_ast_node(ASTNode const& node)
  231. {
  232. auto executable = TRY(Bytecode::compile(*this, node, FunctionKind::Normal, ""sv));
  233. auto result_or_error = bytecode_interpreter().run_and_return_frame(*executable, nullptr);
  234. if (result_or_error.value.is_error())
  235. return result_or_error.value.release_error();
  236. return result_or_error.frame->registers()[0];
  237. }
  238. // 13.15.5.3 Runtime Semantics: PropertyDestructuringAssignmentEvaluation, https://tc39.es/ecma262/#sec-runtime-semantics-propertydestructuringassignmentevaluation
  239. // 14.3.3.1 Runtime Semantics: PropertyBindingInitialization, https://tc39.es/ecma262/#sec-destructuring-binding-patterns-runtime-semantics-propertybindinginitialization
  240. ThrowCompletionOr<void> VM::property_binding_initialization(BindingPattern const& binding, Value value, Environment* environment)
  241. {
  242. auto& vm = *this;
  243. auto& realm = *vm.current_realm();
  244. auto object = TRY(value.to_object(vm));
  245. HashTable<PropertyKey> seen_names;
  246. for (auto& property : binding.entries) {
  247. VERIFY(!property.is_elision());
  248. if (property.is_rest) {
  249. Reference assignment_target;
  250. if (auto identifier_ptr = property.name.get_pointer<NonnullRefPtr<Identifier const>>()) {
  251. assignment_target = TRY(resolve_binding((*identifier_ptr)->string(), environment));
  252. } else {
  253. VERIFY_NOT_REACHED();
  254. }
  255. auto rest_object = Object::create(realm, realm.intrinsics().object_prototype());
  256. VERIFY(rest_object);
  257. TRY(rest_object->copy_data_properties(vm, object, seen_names));
  258. if (!environment)
  259. return assignment_target.put_value(vm, rest_object);
  260. else
  261. return assignment_target.initialize_referenced_binding(vm, rest_object);
  262. }
  263. auto name = TRY(property.name.visit(
  264. [&](Empty) -> ThrowCompletionOr<PropertyKey> { VERIFY_NOT_REACHED(); },
  265. [&](NonnullRefPtr<Identifier const> const& identifier) -> ThrowCompletionOr<PropertyKey> {
  266. return identifier->string();
  267. },
  268. [&](NonnullRefPtr<Expression const> const& expression) -> ThrowCompletionOr<PropertyKey> {
  269. auto result = TRY(execute_ast_node(*expression));
  270. return result.to_property_key(vm);
  271. }));
  272. seen_names.set(name);
  273. if (property.name.has<NonnullRefPtr<Identifier const>>() && property.alias.has<Empty>()) {
  274. // FIXME: this branch and not taking this have a lot in common we might want to unify it more (like it was before).
  275. auto& identifier = *property.name.get<NonnullRefPtr<Identifier const>>();
  276. auto reference = TRY(resolve_binding(identifier.string(), environment));
  277. auto value_to_assign = TRY(object->get(name));
  278. if (property.initializer && value_to_assign.is_undefined()) {
  279. value_to_assign = TRY(named_evaluation_if_anonymous_function(*property.initializer, identifier.string()));
  280. }
  281. if (!environment)
  282. TRY(reference.put_value(vm, value_to_assign));
  283. else
  284. TRY(reference.initialize_referenced_binding(vm, value_to_assign));
  285. continue;
  286. }
  287. auto reference_to_assign_to = TRY(property.alias.visit(
  288. [&](Empty) -> ThrowCompletionOr<Optional<Reference>> { return Optional<Reference> {}; },
  289. [&](NonnullRefPtr<Identifier const> const& identifier) -> ThrowCompletionOr<Optional<Reference>> {
  290. return TRY(resolve_binding(identifier->string(), environment));
  291. },
  292. [&](NonnullRefPtr<BindingPattern const> const&) -> ThrowCompletionOr<Optional<Reference>> { return Optional<Reference> {}; },
  293. [&](NonnullRefPtr<MemberExpression const> const&) -> ThrowCompletionOr<Optional<Reference>> {
  294. VERIFY_NOT_REACHED();
  295. }));
  296. auto value_to_assign = TRY(object->get(name));
  297. if (property.initializer && value_to_assign.is_undefined()) {
  298. if (auto* identifier_ptr = property.alias.get_pointer<NonnullRefPtr<Identifier const>>())
  299. value_to_assign = TRY(named_evaluation_if_anonymous_function(*property.initializer, (*identifier_ptr)->string()));
  300. else
  301. value_to_assign = TRY(execute_ast_node(*property.initializer));
  302. }
  303. if (auto* binding_ptr = property.alias.get_pointer<NonnullRefPtr<BindingPattern const>>()) {
  304. TRY(binding_initialization(*binding_ptr, value_to_assign, environment));
  305. } else {
  306. VERIFY(reference_to_assign_to.has_value());
  307. if (!environment)
  308. TRY(reference_to_assign_to->put_value(vm, value_to_assign));
  309. else
  310. TRY(reference_to_assign_to->initialize_referenced_binding(vm, value_to_assign));
  311. }
  312. }
  313. return {};
  314. }
  315. // 13.15.5.5 Runtime Semantics: IteratorDestructuringAssignmentEvaluation, https://tc39.es/ecma262/#sec-runtime-semantics-iteratordestructuringassignmentevaluation
  316. // 8.5.3 Runtime Semantics: IteratorBindingInitialization, https://tc39.es/ecma262/#sec-runtime-semantics-iteratorbindinginitialization
  317. ThrowCompletionOr<void> VM::iterator_binding_initialization(BindingPattern const& binding, IteratorRecord& iterator_record, Environment* environment)
  318. {
  319. auto& vm = *this;
  320. auto& realm = *vm.current_realm();
  321. // FIXME: this method is nearly identical to destructuring assignment!
  322. for (size_t i = 0; i < binding.entries.size(); i++) {
  323. auto& entry = binding.entries[i];
  324. Value value;
  325. auto assignment_target = TRY(entry.alias.visit(
  326. [&](Empty) -> ThrowCompletionOr<Optional<Reference>> { return Optional<Reference> {}; },
  327. [&](NonnullRefPtr<Identifier const> const& identifier) -> ThrowCompletionOr<Optional<Reference>> {
  328. return TRY(resolve_binding(identifier->string(), environment));
  329. },
  330. [&](NonnullRefPtr<BindingPattern const> const&) -> ThrowCompletionOr<Optional<Reference>> { return Optional<Reference> {}; },
  331. [&](NonnullRefPtr<MemberExpression const> const&) -> ThrowCompletionOr<Optional<Reference>> {
  332. VERIFY_NOT_REACHED();
  333. }));
  334. // BindingRestElement : ... BindingIdentifier
  335. // BindingRestElement : ... BindingPattern
  336. if (entry.is_rest) {
  337. VERIFY(i == binding.entries.size() - 1);
  338. // 2. Let A be ! ArrayCreate(0).
  339. auto array = MUST(Array::create(realm, 0));
  340. // 3. Let n be 0.
  341. // 4. Repeat,
  342. while (true) {
  343. ThrowCompletionOr<GCPtr<Object>> next { nullptr };
  344. // a. If iteratorRecord.[[Done]] is false, then
  345. if (!iterator_record.done) {
  346. // i. Let next be Completion(IteratorStep(iteratorRecord)).
  347. next = iterator_step(vm, iterator_record);
  348. // ii. If next is an abrupt completion, set iteratorRecord.[[Done]] to true.
  349. // iii. ReturnIfAbrupt(next).
  350. if (next.is_error()) {
  351. iterator_record.done = true;
  352. return next.release_error();
  353. }
  354. // iv. If next is false, set iteratorRecord.[[Done]] to true.
  355. if (!next.value())
  356. iterator_record.done = true;
  357. }
  358. // b. If iteratorRecord.[[Done]] is true, then
  359. if (iterator_record.done) {
  360. // NOTE: Step i. and ii. are handled below.
  361. break;
  362. }
  363. // c. Let nextValue be Completion(IteratorValue(next)).
  364. auto next_value = iterator_value(vm, *next.value());
  365. // d. If nextValue is an abrupt completion, set iteratorRecord.[[Done]] to true.
  366. // e. ReturnIfAbrupt(nextValue).
  367. if (next_value.is_error()) {
  368. iterator_record.done = true;
  369. return next_value.release_error();
  370. }
  371. // f. Perform ! CreateDataPropertyOrThrow(A, ! ToString(𝔽(n)), nextValue).
  372. array->indexed_properties().append(next_value.value());
  373. // g. Set n to n + 1.
  374. }
  375. value = array;
  376. }
  377. // SingleNameBinding : BindingIdentifier Initializer[opt]
  378. // BindingElement : BindingPattern Initializer[opt]
  379. else {
  380. // 1. Let v be undefined.
  381. value = js_undefined();
  382. // 2. If iteratorRecord.[[Done]] is false, then
  383. if (!iterator_record.done) {
  384. // a. Let next be Completion(IteratorStep(iteratorRecord)).
  385. auto next = iterator_step(vm, iterator_record);
  386. // b. If next is an abrupt completion, set iteratorRecord.[[Done]] to true.
  387. // c. ReturnIfAbrupt(next).
  388. if (next.is_error()) {
  389. iterator_record.done = true;
  390. return next.release_error();
  391. }
  392. // d. If next is false, set iteratorRecord.[[Done]] to true.
  393. if (!next.value()) {
  394. iterator_record.done = true;
  395. }
  396. // e. Else,
  397. else {
  398. // i. Set v to Completion(IteratorValue(next)).
  399. auto value_or_error = iterator_value(vm, *next.value());
  400. // ii. If v is an abrupt completion, set iteratorRecord.[[Done]] to true.
  401. // iii. ReturnIfAbrupt(v).
  402. if (value_or_error.is_throw_completion()) {
  403. iterator_record.done = true;
  404. return value_or_error.release_error();
  405. }
  406. value = value_or_error.release_value();
  407. }
  408. }
  409. // NOTE: Step 3. and 4. are handled below.
  410. }
  411. if (value.is_undefined() && entry.initializer) {
  412. VERIFY(!entry.is_rest);
  413. if (auto* identifier_ptr = entry.alias.get_pointer<NonnullRefPtr<Identifier const>>())
  414. value = TRY(named_evaluation_if_anonymous_function(*entry.initializer, (*identifier_ptr)->string()));
  415. else
  416. value = TRY(execute_ast_node(*entry.initializer));
  417. }
  418. if (auto* binding_ptr = entry.alias.get_pointer<NonnullRefPtr<BindingPattern const>>()) {
  419. TRY(binding_initialization(*binding_ptr, value, environment));
  420. } else if (!entry.alias.has<Empty>()) {
  421. VERIFY(assignment_target.has_value());
  422. if (!environment)
  423. TRY(assignment_target->put_value(vm, value));
  424. else
  425. TRY(assignment_target->initialize_referenced_binding(vm, value));
  426. }
  427. }
  428. return {};
  429. }
  430. // 9.1.2.1 GetIdentifierReference ( env, name, strict ), https://tc39.es/ecma262/#sec-getidentifierreference
  431. ThrowCompletionOr<Reference> VM::get_identifier_reference(Environment* environment, DeprecatedFlyString name, bool strict, size_t hops)
  432. {
  433. // 1. If env is the value null, then
  434. if (!environment) {
  435. // a. Return the Reference Record { [[Base]]: unresolvable, [[ReferencedName]]: name, [[Strict]]: strict, [[ThisValue]]: empty }.
  436. return Reference { Reference::BaseType::Unresolvable, move(name), strict };
  437. }
  438. // 2. Let exists be ? env.HasBinding(name).
  439. Optional<size_t> index;
  440. auto exists = TRY(environment->has_binding(name, &index));
  441. // Note: This is an optimization for looking up the same reference.
  442. Optional<EnvironmentCoordinate> environment_coordinate;
  443. if (index.has_value()) {
  444. VERIFY(hops <= NumericLimits<u32>::max());
  445. VERIFY(index.value() <= NumericLimits<u32>::max());
  446. environment_coordinate = EnvironmentCoordinate { .hops = static_cast<u32>(hops), .index = static_cast<u32>(index.value()) };
  447. }
  448. // 3. If exists is true, then
  449. if (exists) {
  450. // a. Return the Reference Record { [[Base]]: env, [[ReferencedName]]: name, [[Strict]]: strict, [[ThisValue]]: empty }.
  451. return Reference { *environment, move(name), strict, environment_coordinate };
  452. }
  453. // 4. Else,
  454. else {
  455. // a. Let outer be env.[[OuterEnv]].
  456. // b. Return ? GetIdentifierReference(outer, name, strict).
  457. return get_identifier_reference(environment->outer_environment(), move(name), strict, hops + 1);
  458. }
  459. }
  460. // 9.4.2 ResolveBinding ( name [ , env ] ), https://tc39.es/ecma262/#sec-resolvebinding
  461. ThrowCompletionOr<Reference> VM::resolve_binding(DeprecatedFlyString const& name, Environment* environment)
  462. {
  463. // 1. If env is not present or if env is undefined, then
  464. if (!environment) {
  465. // a. Set env to the running execution context's LexicalEnvironment.
  466. environment = running_execution_context().lexical_environment;
  467. }
  468. // 2. Assert: env is an Environment Record.
  469. VERIFY(environment);
  470. // 3. If the source text matched by the syntactic production that is being evaluated is contained in strict mode code, let strict be true; else let strict be false.
  471. bool strict = in_strict_mode();
  472. // 4. Return ? GetIdentifierReference(env, name, strict).
  473. return get_identifier_reference(environment, name, strict);
  474. // NOTE: The spec says:
  475. // Note: The result of ResolveBinding is always a Reference Record whose [[ReferencedName]] field is name.
  476. // But this is not actually correct as GetIdentifierReference (or really the methods it calls) can throw.
  477. }
  478. // 9.4.4 ResolveThisBinding ( ), https://tc39.es/ecma262/#sec-resolvethisbinding
  479. ThrowCompletionOr<Value> VM::resolve_this_binding()
  480. {
  481. auto& vm = *this;
  482. // 1. Let envRec be GetThisEnvironment().
  483. auto environment = get_this_environment(vm);
  484. // 2. Return ? envRec.GetThisBinding().
  485. return TRY(environment->get_this_binding(vm));
  486. }
  487. // 9.4.5 GetNewTarget ( ), https://tc39.es/ecma262/#sec-getnewtarget
  488. Value VM::get_new_target()
  489. {
  490. // 1. Let envRec be GetThisEnvironment().
  491. auto env = get_this_environment(*this);
  492. // 2. Assert: envRec has a [[NewTarget]] field.
  493. // 3. Return envRec.[[NewTarget]].
  494. return verify_cast<FunctionEnvironment>(*env).new_target();
  495. }
  496. // 13.3.12.1 Runtime Semantics: Evaluation, https://tc39.es/ecma262/#sec-meta-properties-runtime-semantics-evaluation
  497. // ImportMeta branch only
  498. Object* VM::get_import_meta()
  499. {
  500. // 1. Let module be GetActiveScriptOrModule().
  501. auto script_or_module = get_active_script_or_module();
  502. // 2. Assert: module is a Source Text Module Record.
  503. auto& module = verify_cast<SourceTextModule>(*script_or_module.get<NonnullGCPtr<Module>>());
  504. // 3. Let importMeta be module.[[ImportMeta]].
  505. auto* import_meta = module.import_meta();
  506. // 4. If importMeta is empty, then
  507. if (import_meta == nullptr) {
  508. // a. Set importMeta to OrdinaryObjectCreate(null).
  509. import_meta = Object::create(*current_realm(), nullptr);
  510. // b. Let importMetaValues be HostGetImportMetaProperties(module).
  511. auto import_meta_values = host_get_import_meta_properties(module);
  512. // c. For each Record { [[Key]], [[Value]] } p of importMetaValues, do
  513. for (auto& entry : import_meta_values) {
  514. // i. Perform ! CreateDataPropertyOrThrow(importMeta, p.[[Key]], p.[[Value]]).
  515. MUST(import_meta->create_data_property_or_throw(entry.key, entry.value));
  516. }
  517. // d. Perform HostFinalizeImportMeta(importMeta, module).
  518. host_finalize_import_meta(import_meta, module);
  519. // e. Set module.[[ImportMeta]] to importMeta.
  520. module.set_import_meta({}, import_meta);
  521. // f. Return importMeta.
  522. return import_meta;
  523. }
  524. // 5. Else,
  525. else {
  526. // a. Assert: Type(importMeta) is Object.
  527. // Note: This is always true by the type.
  528. // b. Return importMeta.
  529. return import_meta;
  530. }
  531. }
  532. // 9.4.5 GetGlobalObject ( ), https://tc39.es/ecma262/#sec-getglobalobject
  533. Object& VM::get_global_object()
  534. {
  535. // 1. Let currentRealm be the current Realm Record.
  536. auto& current_realm = *this->current_realm();
  537. // 2. Return currentRealm.[[GlobalObject]].
  538. return current_realm.global_object();
  539. }
  540. bool VM::in_strict_mode() const
  541. {
  542. if (execution_context_stack().is_empty())
  543. return false;
  544. return running_execution_context().is_strict_mode;
  545. }
  546. void VM::run_queued_promise_jobs()
  547. {
  548. dbgln_if(PROMISE_DEBUG, "Running queued promise jobs");
  549. while (!m_promise_jobs.is_empty()) {
  550. auto job = m_promise_jobs.take_first();
  551. dbgln_if(PROMISE_DEBUG, "Calling promise job function");
  552. [[maybe_unused]] auto result = job();
  553. }
  554. }
  555. // 9.5.4 HostEnqueuePromiseJob ( job, realm ), https://tc39.es/ecma262/#sec-hostenqueuepromisejob
  556. void VM::enqueue_promise_job(Function<ThrowCompletionOr<Value>()> job, Realm*)
  557. {
  558. // An implementation of HostEnqueuePromiseJob must conform to the requirements in 9.5 as well as the following:
  559. // - FIXME: If realm is not null, each time job is invoked the implementation must perform implementation-defined steps such that execution is prepared to evaluate ECMAScript code at the time of job's invocation.
  560. // - FIXME: Let scriptOrModule be GetActiveScriptOrModule() at the time HostEnqueuePromiseJob is invoked. If realm is not null, each time job is invoked the implementation must perform implementation-defined steps
  561. // such that scriptOrModule is the active script or module at the time of job's invocation.
  562. // - Jobs must run in the same order as the HostEnqueuePromiseJob invocations that scheduled them.
  563. m_promise_jobs.append(move(job));
  564. }
  565. void VM::run_queued_finalization_registry_cleanup_jobs()
  566. {
  567. while (!m_finalization_registry_cleanup_jobs.is_empty()) {
  568. auto registry = m_finalization_registry_cleanup_jobs.take_first();
  569. // FIXME: Handle any uncatched exceptions here.
  570. (void)registry->cleanup();
  571. }
  572. }
  573. // 9.10.4.1 HostEnqueueFinalizationRegistryCleanupJob ( finalizationRegistry ), https://tc39.es/ecma262/#sec-host-cleanup-finalization-registry
  574. void VM::enqueue_finalization_registry_cleanup_job(FinalizationRegistry& registry)
  575. {
  576. m_finalization_registry_cleanup_jobs.append(&registry);
  577. }
  578. // 27.2.1.9 HostPromiseRejectionTracker ( promise, operation ), https://tc39.es/ecma262/#sec-host-promise-rejection-tracker
  579. void VM::promise_rejection_tracker(Promise& promise, Promise::RejectionOperation operation) const
  580. {
  581. switch (operation) {
  582. case Promise::RejectionOperation::Reject:
  583. // A promise was rejected without any handlers
  584. if (on_promise_unhandled_rejection)
  585. on_promise_unhandled_rejection(promise);
  586. break;
  587. case Promise::RejectionOperation::Handle:
  588. // A handler was added to an already rejected promise
  589. if (on_promise_rejection_handled)
  590. on_promise_rejection_handled(promise);
  591. break;
  592. default:
  593. VERIFY_NOT_REACHED();
  594. }
  595. }
  596. void VM::dump_backtrace() const
  597. {
  598. for (ssize_t i = m_execution_context_stack.size() - 1; i >= 0; --i) {
  599. auto& frame = m_execution_context_stack[i];
  600. if (frame->instruction_stream_iterator.has_value() && frame->instruction_stream_iterator->source_code()) {
  601. auto source_range = frame->instruction_stream_iterator->source_range().realize();
  602. dbgln("-> {} @ {}:{},{}", frame->function_name ? frame->function_name->utf8_string() : ""_string, source_range.filename(), source_range.start.line, source_range.start.column);
  603. } else {
  604. dbgln("-> {}", frame->function_name ? frame->function_name->utf8_string() : ""_string);
  605. }
  606. }
  607. }
  608. void VM::save_execution_context_stack()
  609. {
  610. m_saved_execution_context_stacks.append(move(m_execution_context_stack));
  611. }
  612. void VM::restore_execution_context_stack()
  613. {
  614. m_execution_context_stack = m_saved_execution_context_stacks.take_last();
  615. }
  616. // 9.4.1 GetActiveScriptOrModule ( ), https://tc39.es/ecma262/#sec-getactivescriptormodule
  617. ScriptOrModule VM::get_active_script_or_module() const
  618. {
  619. // 1. If the execution context stack is empty, return null.
  620. if (m_execution_context_stack.is_empty())
  621. return Empty {};
  622. // 2. Let ec be the topmost execution context on the execution context stack whose ScriptOrModule component is not null.
  623. for (auto i = m_execution_context_stack.size() - 1; i > 0; i--) {
  624. if (!m_execution_context_stack[i]->script_or_module.has<Empty>())
  625. return m_execution_context_stack[i]->script_or_module;
  626. }
  627. // 3. If no such execution context exists, return null. Otherwise, return ec's ScriptOrModule.
  628. // Note: Since it is not empty we have 0 and since we got here all the
  629. // above contexts don't have a non-null ScriptOrModule
  630. return m_execution_context_stack[0]->script_or_module;
  631. }
  632. VM::StoredModule* VM::get_stored_module(ScriptOrModule const&, DeprecatedString const& filename, DeprecatedString const&)
  633. {
  634. // Note the spec says:
  635. // Each time this operation is called with a specific referencingScriptOrModule, specifier pair as arguments
  636. // it must return the same Module Record instance if it completes normally.
  637. // Currently, we ignore the referencing script or module but this might not be correct in all cases.
  638. // Editor's Note from https://tc39.es/proposal-json-modules/#sec-hostresolveimportedmodule
  639. // The above text implies that is recommended but not required that hosts do not use moduleRequest.[[Assertions]]
  640. // as part of the module cache key. In either case, an exception thrown from an import with a given assertion list
  641. // does not rule out success of another import with the same specifier but a different assertion list.
  642. auto end_or_module = m_loaded_modules.find_if([&](StoredModule const& stored_module) {
  643. return stored_module.filename == filename;
  644. });
  645. if (end_or_module.is_end())
  646. return nullptr;
  647. return &(*end_or_module);
  648. }
  649. ThrowCompletionOr<void> VM::link_and_eval_module(Badge<Bytecode::Interpreter>, SourceTextModule& module)
  650. {
  651. return link_and_eval_module(module);
  652. }
  653. ThrowCompletionOr<void> VM::link_and_eval_module(Module& module)
  654. {
  655. auto filename = module.filename();
  656. auto module_or_end = m_loaded_modules.find_if([&](StoredModule const& stored_module) {
  657. return stored_module.module.ptr() == &module;
  658. });
  659. StoredModule* stored_module;
  660. if (module_or_end.is_end()) {
  661. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] Warning introducing module via link_and_eval_module {}", module.filename());
  662. if (m_loaded_modules.size() > 0)
  663. dbgln("Warning: Using multiple modules as entry point can lead to unexpected results");
  664. m_loaded_modules.empend(
  665. NonnullGCPtr(module),
  666. module.filename(),
  667. DeprecatedString {}, // Null type
  668. module,
  669. true);
  670. stored_module = &m_loaded_modules.last();
  671. } else {
  672. stored_module = module_or_end.operator->();
  673. if (stored_module->has_once_started_linking) {
  674. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] Module already has started linking once {}", module.filename());
  675. return {};
  676. }
  677. stored_module->has_once_started_linking = true;
  678. }
  679. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] Linking module {}", filename);
  680. auto linked_or_error = module.link(*this);
  681. if (linked_or_error.is_error())
  682. return linked_or_error.throw_completion();
  683. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] Linking passed, now evaluating module {}", filename);
  684. auto evaluated_or_error = module.evaluate(*this);
  685. if (evaluated_or_error.is_error())
  686. return evaluated_or_error.throw_completion();
  687. auto* evaluated_value = evaluated_or_error.value();
  688. run_queued_promise_jobs();
  689. VERIFY(m_promise_jobs.is_empty());
  690. // FIXME: This will break if we start doing promises actually asynchronously.
  691. VERIFY(evaluated_value->state() != Promise::State::Pending);
  692. if (evaluated_value->state() == Promise::State::Rejected)
  693. return JS::throw_completion(evaluated_value->result());
  694. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] Evaluating passed for module {}", module.filename());
  695. return {};
  696. }
  697. static DeprecatedString resolve_module_filename(StringView filename, StringView module_type)
  698. {
  699. auto extensions = Vector<StringView, 2> { "js"sv, "mjs"sv };
  700. if (module_type == "json"sv)
  701. extensions = { "json"sv };
  702. if (!FileSystem::exists(filename)) {
  703. for (auto extension : extensions) {
  704. // import "./foo" -> import "./foo.ext"
  705. auto resolved_filepath = DeprecatedString::formatted("{}.{}", filename, extension);
  706. if (FileSystem::exists(resolved_filepath))
  707. return resolved_filepath;
  708. }
  709. } else if (FileSystem::is_directory(filename)) {
  710. for (auto extension : extensions) {
  711. // import "./foo" -> import "./foo/index.ext"
  712. auto resolved_filepath = LexicalPath::join(filename, DeprecatedString::formatted("index.{}", extension)).string();
  713. if (FileSystem::exists(resolved_filepath))
  714. return resolved_filepath;
  715. }
  716. }
  717. return filename;
  718. }
  719. // 16.2.1.7 HostResolveImportedModule ( referencingScriptOrModule, specifier ), https://tc39.es/ecma262/#sec-hostresolveimportedmodule
  720. ThrowCompletionOr<NonnullGCPtr<Module>> VM::resolve_imported_module(ScriptOrModule referencing_script_or_module, ModuleRequest const& module_request)
  721. {
  722. // An implementation of HostResolveImportedModule must conform to the following requirements:
  723. // - If it completes normally, the [[Value]] slot of the completion must contain an instance of a concrete subclass of Module Record.
  724. // - If a Module Record corresponding to the pair referencingScriptOrModule, moduleRequest does not exist or cannot be created, an exception must be thrown.
  725. // - Each time this operation is called with a specific referencingScriptOrModule, moduleRequest.[[Specifier]], moduleRequest.[[Assertions]] triple
  726. // as arguments it must return the same Module Record instance if it completes normally.
  727. // * It is recommended but not required that implementations additionally conform to the following stronger constraint:
  728. // each time this operation is called with a specific referencingScriptOrModule, moduleRequest.[[Specifier]] pair as arguments it must return the same Module Record instance if it completes normally.
  729. // - moduleRequest.[[Assertions]] must not influence the interpretation of the module or the module specifier;
  730. // instead, it may be used to determine whether the algorithm completes normally or with an abrupt completion.
  731. // Multiple different referencingScriptOrModule, moduleRequest.[[Specifier]] pairs may map to the same Module Record instance.
  732. // The actual mapping semantic is host-defined but typically a normalization process is applied to specifier as part of the mapping process.
  733. // A typical normalization process would include actions such as alphabetic case folding and expansion of relative and abbreviated path specifiers.
  734. // We only allow "type" as a supported assertion so it is the only valid key that should ever arrive here.
  735. VERIFY(module_request.assertions.is_empty() || (module_request.assertions.size() == 1 && module_request.assertions.first().key == "type"));
  736. auto module_type = module_request.assertions.is_empty() ? DeprecatedString {} : module_request.assertions.first().value;
  737. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] module at {} has type {}", module_request.module_specifier, module_type);
  738. StringView base_filename = referencing_script_or_module.visit(
  739. [&](Empty) {
  740. return "."sv;
  741. },
  742. [&](auto& script_or_module) {
  743. return script_or_module->filename();
  744. });
  745. LexicalPath base_path { base_filename };
  746. auto filename = LexicalPath::absolute_path(base_path.dirname(), module_request.module_specifier);
  747. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] base path: '{}'", base_path);
  748. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] initial filename: '{}'", filename);
  749. filename = resolve_module_filename(filename, module_type);
  750. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] resolved filename: '{}'", filename);
  751. #if JS_MODULE_DEBUG
  752. DeprecatedString referencing_module_string = referencing_script_or_module.visit(
  753. [&](Empty) -> DeprecatedString {
  754. return ".";
  755. },
  756. [&](auto& script_or_module) {
  757. if constexpr (IsSame<Script*, decltype(script_or_module)>) {
  758. return DeprecatedString::formatted("Script @ {}", script_or_module.ptr());
  759. }
  760. return DeprecatedString::formatted("Module @ {}", script_or_module.ptr());
  761. });
  762. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] resolve_imported_module({}, {})", referencing_module_string, filename);
  763. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] resolved {} + {} -> {}", base_path, module_request.module_specifier, filename);
  764. #endif
  765. auto* loaded_module_or_end = get_stored_module(referencing_script_or_module, filename, module_type);
  766. if (loaded_module_or_end != nullptr) {
  767. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] resolve_imported_module({}) already loaded at {}", filename, loaded_module_or_end->module.ptr());
  768. return NonnullGCPtr(*loaded_module_or_end->module);
  769. }
  770. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] reading and parsing module {}", filename);
  771. auto file_or_error = Core::File::open(filename, Core::File::OpenMode::Read);
  772. if (file_or_error.is_error()) {
  773. return throw_completion<SyntaxError>(ErrorType::ModuleNotFound, module_request.module_specifier);
  774. }
  775. // FIXME: Don't read the file in one go.
  776. auto file_content_or_error = file_or_error.value()->read_until_eof();
  777. if (file_content_or_error.is_error()) {
  778. if (file_content_or_error.error().code() == ENOMEM)
  779. return throw_completion<JS::InternalError>(error_message(::JS::VM::ErrorMessage::OutOfMemory));
  780. return throw_completion<SyntaxError>(ErrorType::ModuleNotFound, module_request.module_specifier);
  781. }
  782. StringView const content_view { file_content_or_error.value().bytes() };
  783. auto module = TRY([&]() -> ThrowCompletionOr<NonnullGCPtr<Module>> {
  784. // If assertions has an entry entry such that entry.[[Key]] is "type", let type be entry.[[Value]]. The following requirements apply:
  785. // If type is "json", then this algorithm must either invoke ParseJSONModule and return the resulting Completion Record, or throw an exception.
  786. if (module_type == "json"sv) {
  787. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] reading and parsing JSON module {}", filename);
  788. return parse_json_module(content_view, *current_realm(), filename);
  789. }
  790. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] reading and parsing as SourceTextModule module {}", filename);
  791. // Note: We treat all files as module, so if a script does not have exports it just runs it.
  792. auto module_or_errors = SourceTextModule::parse(content_view, *current_realm(), filename);
  793. if (module_or_errors.is_error()) {
  794. VERIFY(module_or_errors.error().size() > 0);
  795. return throw_completion<SyntaxError>(module_or_errors.error().first().to_deprecated_string());
  796. }
  797. return module_or_errors.release_value();
  798. }());
  799. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] resolve_imported_module(...) parsed {} to {}", filename, module.ptr());
  800. // We have to set it here already in case it references itself.
  801. m_loaded_modules.empend(
  802. referencing_script_or_module,
  803. filename,
  804. module_type,
  805. *module,
  806. false);
  807. return module;
  808. }
  809. // 16.2.1.8 HostImportModuleDynamically ( referencingScriptOrModule, specifier, promiseCapability ), https://tc39.es/ecma262/#sec-hostimportmoduledynamically
  810. ThrowCompletionOr<void> VM::import_module_dynamically(ScriptOrModule referencing_script_or_module, ModuleRequest module_request, PromiseCapability const& promise_capability)
  811. {
  812. auto& realm = *current_realm();
  813. // Success path:
  814. // - At some future time, the host environment must perform FinishDynamicImport(referencingScriptOrModule, moduleRequest, promiseCapability, promise),
  815. // where promise is a Promise resolved with undefined.
  816. // - Any subsequent call to HostResolveImportedModule after FinishDynamicImport has completed,
  817. // given the arguments referencingScriptOrModule and specifier, must return a normal completion
  818. // containing a module which has already been evaluated, i.e. whose Evaluate concrete method has
  819. // already been called and returned a normal completion.
  820. // Failure path:
  821. // - At some future time, the host environment must perform
  822. // FinishDynamicImport(referencingScriptOrModule, moduleRequest, promiseCapability, promise),
  823. // where promise is a Promise rejected with an error representing the cause of failure.
  824. auto promise = Promise::create(realm);
  825. ScopeGuard finish_dynamic_import = [&] {
  826. host_finish_dynamic_import(referencing_script_or_module, module_request, promise_capability, promise);
  827. };
  828. // Generally within ECMA262 we always get a referencing_script_or_module. However, ShadowRealm gives an explicit null.
  829. // To get around this is we attempt to get the active script_or_module otherwise we might start loading "random" files from the working directory.
  830. if (referencing_script_or_module.has<Empty>()) {
  831. referencing_script_or_module = get_active_script_or_module();
  832. // If there is no ScriptOrModule in any of the execution contexts
  833. if (referencing_script_or_module.has<Empty>()) {
  834. // Throw an error for now
  835. promise->reject(InternalError::create(realm, TRY_OR_THROW_OOM(*this, String::formatted(ErrorType::ModuleNotFoundNoReferencingScript.message(), module_request.module_specifier))));
  836. return {};
  837. }
  838. }
  839. // Note: If host_resolve_imported_module returns a module it has been loaded successfully and the next call in finish_dynamic_import will retrieve it again.
  840. auto module_or_error = host_resolve_imported_module(referencing_script_or_module, module_request);
  841. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] HostImportModuleDynamically(..., {}) -> {}", module_request.module_specifier, module_or_error.is_error() ? "failed" : "passed");
  842. if (module_or_error.is_throw_completion()) {
  843. promise->reject(*module_or_error.throw_completion().value());
  844. } else {
  845. auto module = module_or_error.release_value();
  846. auto& source_text_module = static_cast<Module&>(*module);
  847. auto evaluated_or_error = link_and_eval_module(source_text_module);
  848. if (evaluated_or_error.is_throw_completion()) {
  849. promise->reject(*evaluated_or_error.throw_completion().value());
  850. } else {
  851. promise->fulfill(js_undefined());
  852. }
  853. }
  854. // It must return unused.
  855. // Note: Just return void always since the resulting value cannot be accessed by user code.
  856. return {};
  857. }
  858. // 16.2.1.9 FinishDynamicImport ( referencingScriptOrModule, specifier, promiseCapability, innerPromise ), https://tc39.es/ecma262/#sec-finishdynamicimport
  859. void VM::finish_dynamic_import(ScriptOrModule referencing_script_or_module, ModuleRequest module_request, PromiseCapability const& promise_capability, Promise* inner_promise)
  860. {
  861. dbgln_if(JS_MODULE_DEBUG, "[JS MODULE] finish_dynamic_import on {}", module_request.module_specifier);
  862. auto& realm = *current_realm();
  863. // 1. Let fulfilledClosure be a new Abstract Closure with parameters (result) that captures referencingScriptOrModule, specifier, and promiseCapability and performs the following steps when called:
  864. auto fulfilled_closure = [referencing_script_or_module = move(referencing_script_or_module), module_request = move(module_request), &promise_capability](VM& vm) -> ThrowCompletionOr<Value> {
  865. auto result = vm.argument(0);
  866. // a. Assert: result is undefined.
  867. VERIFY(result.is_undefined());
  868. // b. Let moduleRecord be ! HostResolveImportedModule(referencingScriptOrModule, specifier).
  869. auto module_record = MUST(vm.host_resolve_imported_module(referencing_script_or_module, module_request));
  870. // c. Assert: Evaluate has already been invoked on moduleRecord and successfully completed.
  871. // Note: If HostResolveImportedModule returns a module evaluate will have been called on it.
  872. // d. Let namespace be Completion(GetModuleNamespace(moduleRecord)).
  873. auto namespace_ = module_record->get_module_namespace(vm);
  874. // e. If namespace is an abrupt completion, then
  875. if (namespace_.is_throw_completion()) {
  876. // i. Perform ! Call(promiseCapability.[[Reject]], undefined, « namespace.[[Value]] »).
  877. MUST(call(vm, *promise_capability.reject(), js_undefined(), *namespace_.throw_completion().value()));
  878. }
  879. // f. Else,
  880. else {
  881. // i. Perform ! Call(promiseCapability.[[Resolve]], undefined, « namespace.[[Value]] »).
  882. MUST(call(vm, *promise_capability.resolve(), js_undefined(), namespace_.release_value()));
  883. }
  884. // g. Return unused.
  885. // NOTE: We don't support returning an empty/optional/unused value here.
  886. return js_undefined();
  887. };
  888. // 2. Let onFulfilled be CreateBuiltinFunction(fulfilledClosure, 0, "", « »).
  889. auto on_fulfilled = NativeFunction::create(realm, move(fulfilled_closure), 0, "");
  890. // 3. Let rejectedClosure be a new Abstract Closure with parameters (error) that captures promiseCapability and performs the following steps when called:
  891. auto rejected_closure = [&promise_capability](VM& vm) -> ThrowCompletionOr<Value> {
  892. auto error = vm.argument(0);
  893. // a. Perform ! Call(promiseCapability.[[Reject]], undefined, « error »).
  894. MUST(call(vm, *promise_capability.reject(), js_undefined(), error));
  895. // b. Return unused.
  896. // NOTE: We don't support returning an empty/optional/unused value here.
  897. return js_undefined();
  898. };
  899. // 4. Let onRejected be CreateBuiltinFunction(rejectedClosure, 0, "", « »).
  900. auto on_rejected = NativeFunction::create(realm, move(rejected_closure), 0, "");
  901. // 5. Perform PerformPromiseThen(innerPromise, onFulfilled, onRejected).
  902. inner_promise->perform_then(on_fulfilled, on_rejected, {});
  903. // 6. Return unused.
  904. }
  905. void VM::push_execution_context(ExecutionContext& context)
  906. {
  907. if (!m_execution_context_stack.is_empty())
  908. m_execution_context_stack.last()->instruction_stream_iterator = bytecode_interpreter().instruction_stream_iterator();
  909. m_execution_context_stack.append(&context);
  910. }
  911. void VM::pop_execution_context()
  912. {
  913. m_execution_context_stack.take_last();
  914. if (m_execution_context_stack.is_empty() && on_call_stack_emptied)
  915. on_call_stack_emptied();
  916. }
  917. #if ARCH(X86_64)
  918. struct [[gnu::packed]] NativeStackFrame {
  919. NativeStackFrame* prev;
  920. FlatPtr return_address;
  921. };
  922. #endif
  923. Vector<FlatPtr> VM::get_native_stack_trace() const
  924. {
  925. Vector<FlatPtr> buffer;
  926. #if ARCH(X86_64)
  927. // Manually walk the stack, because backtrace() does not traverse through JIT frames.
  928. auto* frame = bit_cast<NativeStackFrame*>(__builtin_frame_address(0));
  929. while (bit_cast<FlatPtr>(frame) < m_stack_info.top() && bit_cast<FlatPtr>(frame) >= m_stack_info.base()) {
  930. buffer.append(frame->return_address);
  931. frame = frame->prev;
  932. }
  933. #endif
  934. return buffer;
  935. }
  936. static Optional<UnrealizedSourceRange> get_source_range(ExecutionContext const* context, Vector<FlatPtr> const& native_stack)
  937. {
  938. // native function
  939. if (!context->executable)
  940. return {};
  941. auto const* native_executable = context->executable->native_executable();
  942. if (!native_executable) {
  943. // Interpreter frame
  944. if (context->instruction_stream_iterator.has_value())
  945. return context->instruction_stream_iterator->source_range();
  946. return {};
  947. }
  948. // JIT frame
  949. for (auto address : native_stack) {
  950. auto range = native_executable->get_source_range(*context->executable, address);
  951. if (range.has_value())
  952. return range;
  953. }
  954. return {};
  955. }
  956. Vector<StackTraceElement> VM::stack_trace() const
  957. {
  958. auto native_stack = get_native_stack_trace();
  959. Vector<StackTraceElement> stack_trace;
  960. for (ssize_t i = m_execution_context_stack.size() - 1; i >= 0; i--) {
  961. auto* context = m_execution_context_stack[i];
  962. stack_trace.append({
  963. .execution_context = context,
  964. .source_range = get_source_range(context, native_stack).value_or({}),
  965. });
  966. }
  967. return stack_trace;
  968. }
  969. }