ECMAScriptFunctionObject.cpp 61 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248
  1. /*
  2. * Copyright (c) 2020, Stephan Unverwerth <s.unverwerth@serenityos.org>
  3. * Copyright (c) 2020-2023, Linus Groh <linusg@serenityos.org>
  4. * Copyright (c) 2023, Andreas Kling <kling@serenityos.org>
  5. * Copyright (c) 2023, Shannon Booth <shannon@serenityos.org>
  6. *
  7. * SPDX-License-Identifier: BSD-2-Clause
  8. */
  9. #include <AK/Debug.h>
  10. #include <AK/Function.h>
  11. #include <LibJS/AST.h>
  12. #include <LibJS/Bytecode/BasicBlock.h>
  13. #include <LibJS/Bytecode/Generator.h>
  14. #include <LibJS/Bytecode/Interpreter.h>
  15. #include <LibJS/Runtime/AbstractOperations.h>
  16. #include <LibJS/Runtime/Array.h>
  17. #include <LibJS/Runtime/AsyncFunctionDriverWrapper.h>
  18. #include <LibJS/Runtime/AsyncGenerator.h>
  19. #include <LibJS/Runtime/ECMAScriptFunctionObject.h>
  20. #include <LibJS/Runtime/Error.h>
  21. #include <LibJS/Runtime/ExecutionContext.h>
  22. #include <LibJS/Runtime/FunctionEnvironment.h>
  23. #include <LibJS/Runtime/GeneratorObject.h>
  24. #include <LibJS/Runtime/GlobalEnvironment.h>
  25. #include <LibJS/Runtime/GlobalObject.h>
  26. #include <LibJS/Runtime/NativeFunction.h>
  27. #include <LibJS/Runtime/PromiseCapability.h>
  28. #include <LibJS/Runtime/PromiseConstructor.h>
  29. #include <LibJS/Runtime/Value.h>
  30. namespace JS {
  31. JS_DEFINE_ALLOCATOR(ECMAScriptFunctionObject);
  32. NonnullGCPtr<ECMAScriptFunctionObject> ECMAScriptFunctionObject::create(Realm& realm, DeprecatedFlyString name, DeprecatedString source_text, Statement const& ecmascript_code, Vector<FunctionParameter> parameters, i32 m_function_length, Vector<DeprecatedFlyString> local_variables_names, Environment* parent_environment, PrivateEnvironment* private_environment, FunctionKind kind, bool is_strict, bool might_need_arguments_object, bool contains_direct_call_to_eval, bool is_arrow_function, Variant<PropertyKey, PrivateName, Empty> class_field_initializer_name)
  33. {
  34. Object* prototype = nullptr;
  35. switch (kind) {
  36. case FunctionKind::Normal:
  37. prototype = realm.intrinsics().function_prototype();
  38. break;
  39. case FunctionKind::Generator:
  40. prototype = realm.intrinsics().generator_function_prototype();
  41. break;
  42. case FunctionKind::Async:
  43. prototype = realm.intrinsics().async_function_prototype();
  44. break;
  45. case FunctionKind::AsyncGenerator:
  46. prototype = realm.intrinsics().async_generator_function_prototype();
  47. break;
  48. }
  49. return realm.heap().allocate<ECMAScriptFunctionObject>(realm, move(name), move(source_text), ecmascript_code, move(parameters), m_function_length, move(local_variables_names), parent_environment, private_environment, *prototype, kind, is_strict, might_need_arguments_object, contains_direct_call_to_eval, is_arrow_function, move(class_field_initializer_name));
  50. }
  51. NonnullGCPtr<ECMAScriptFunctionObject> ECMAScriptFunctionObject::create(Realm& realm, DeprecatedFlyString name, Object& prototype, DeprecatedString source_text, Statement const& ecmascript_code, Vector<FunctionParameter> parameters, i32 m_function_length, Vector<DeprecatedFlyString> local_variables_names, Environment* parent_environment, PrivateEnvironment* private_environment, FunctionKind kind, bool is_strict, bool might_need_arguments_object, bool contains_direct_call_to_eval, bool is_arrow_function, Variant<PropertyKey, PrivateName, Empty> class_field_initializer_name)
  52. {
  53. return realm.heap().allocate<ECMAScriptFunctionObject>(realm, move(name), move(source_text), ecmascript_code, move(parameters), m_function_length, move(local_variables_names), parent_environment, private_environment, prototype, kind, is_strict, might_need_arguments_object, contains_direct_call_to_eval, is_arrow_function, move(class_field_initializer_name));
  54. }
  55. ECMAScriptFunctionObject::ECMAScriptFunctionObject(DeprecatedFlyString name, DeprecatedString source_text, Statement const& ecmascript_code, Vector<FunctionParameter> formal_parameters, i32 function_length, Vector<DeprecatedFlyString> local_variables_names, Environment* parent_environment, PrivateEnvironment* private_environment, Object& prototype, FunctionKind kind, bool strict, bool might_need_arguments_object, bool contains_direct_call_to_eval, bool is_arrow_function, Variant<PropertyKey, PrivateName, Empty> class_field_initializer_name)
  56. : FunctionObject(prototype)
  57. , m_name(move(name))
  58. , m_function_length(function_length)
  59. , m_local_variables_names(move(local_variables_names))
  60. , m_environment(parent_environment)
  61. , m_private_environment(private_environment)
  62. , m_formal_parameters(move(formal_parameters))
  63. , m_ecmascript_code(ecmascript_code)
  64. , m_realm(&prototype.shape().realm())
  65. , m_source_text(move(source_text))
  66. , m_class_field_initializer_name(move(class_field_initializer_name))
  67. , m_strict(strict)
  68. , m_might_need_arguments_object(might_need_arguments_object)
  69. , m_contains_direct_call_to_eval(contains_direct_call_to_eval)
  70. , m_is_arrow_function(is_arrow_function)
  71. , m_kind(kind)
  72. {
  73. // NOTE: This logic is from OrdinaryFunctionCreate, https://tc39.es/ecma262/#sec-ordinaryfunctioncreate
  74. // 9. If thisMode is lexical-this, set F.[[ThisMode]] to lexical.
  75. if (m_is_arrow_function)
  76. m_this_mode = ThisMode::Lexical;
  77. // 10. Else if Strict is true, set F.[[ThisMode]] to strict.
  78. else if (m_strict)
  79. m_this_mode = ThisMode::Strict;
  80. else
  81. // 11. Else, set F.[[ThisMode]] to global.
  82. m_this_mode = ThisMode::Global;
  83. // 15. Set F.[[ScriptOrModule]] to GetActiveScriptOrModule().
  84. m_script_or_module = vm().get_active_script_or_module();
  85. // 15.1.3 Static Semantics: IsSimpleParameterList, https://tc39.es/ecma262/#sec-static-semantics-issimpleparameterlist
  86. m_has_simple_parameter_list = all_of(m_formal_parameters, [&](auto& parameter) {
  87. if (parameter.is_rest)
  88. return false;
  89. if (parameter.default_value)
  90. return false;
  91. if (!parameter.binding.template has<NonnullRefPtr<Identifier const>>())
  92. return false;
  93. return true;
  94. });
  95. // NOTE: The following steps are from FunctionDeclarationInstantiation that could be executed once
  96. // and then reused in all subsequent function instantiations.
  97. // 2. Let code be func.[[ECMAScriptCode]].
  98. ScopeNode const* scope_body = nullptr;
  99. if (is<ScopeNode>(*m_ecmascript_code))
  100. scope_body = static_cast<ScopeNode const*>(m_ecmascript_code.ptr());
  101. // 3. Let strict be func.[[Strict]].
  102. // 4. Let formals be func.[[FormalParameters]].
  103. auto const& formals = m_formal_parameters;
  104. // 5. Let parameterNames be the BoundNames of formals.
  105. // 6. If parameterNames has any duplicate entries, let hasDuplicates be true. Otherwise, let hasDuplicates be false.
  106. // NOTE: This loop performs step 5, 6, and 8.
  107. for (auto const& parameter : formals) {
  108. if (parameter.default_value)
  109. m_has_parameter_expressions = true;
  110. parameter.binding.visit(
  111. [&](Identifier const& identifier) {
  112. if (m_parameter_names.set(identifier.string()) != AK::HashSetResult::InsertedNewEntry)
  113. m_has_duplicates = true;
  114. },
  115. [&](NonnullRefPtr<BindingPattern const> const& pattern) {
  116. if (pattern->contains_expression())
  117. m_has_parameter_expressions = true;
  118. // NOTE: Nothing in the callback throws an exception.
  119. MUST(pattern->for_each_bound_identifier([&](auto& identifier) {
  120. if (m_parameter_names.set(identifier.string()) != AK::HashSetResult::InsertedNewEntry)
  121. m_has_duplicates = true;
  122. }));
  123. });
  124. }
  125. // 15. Let argumentsObjectNeeded be true.
  126. m_arguments_object_needed = m_might_need_arguments_object;
  127. // 16. If func.[[ThisMode]] is lexical, then
  128. if (this_mode() == ThisMode::Lexical) {
  129. // a. NOTE: Arrow functions never have an arguments object.
  130. // b. Set argumentsObjectNeeded to false.
  131. m_arguments_object_needed = false;
  132. }
  133. // 17. Else if parameterNames contains "arguments", then
  134. else if (m_parameter_names.contains(vm().names.arguments.as_string())) {
  135. // a. Set argumentsObjectNeeded to false.
  136. m_arguments_object_needed = false;
  137. }
  138. HashTable<DeprecatedFlyString> function_names;
  139. // 18. Else if hasParameterExpressions is false, then
  140. // a. If functionNames contains "arguments" or lexicalNames contains "arguments", then
  141. // i. Set argumentsObjectNeeded to false.
  142. // NOTE: The block below is a combination of step 14 and step 18.
  143. if (scope_body) {
  144. // NOTE: Nothing in the callback throws an exception.
  145. MUST(scope_body->for_each_var_function_declaration_in_reverse_order([&](FunctionDeclaration const& function) {
  146. if (function_names.set(function.name()) == AK::HashSetResult::InsertedNewEntry)
  147. m_functions_to_initialize.append(function);
  148. }));
  149. auto const& arguments_name = vm().names.arguments.as_string();
  150. if (!m_has_parameter_expressions && function_names.contains(arguments_name))
  151. m_arguments_object_needed = false;
  152. if (!m_has_parameter_expressions && m_arguments_object_needed) {
  153. // NOTE: Nothing in the callback throws an exception.
  154. MUST(scope_body->for_each_lexically_declared_identifier([&](auto const& identifier) {
  155. if (identifier.string() == arguments_name)
  156. m_arguments_object_needed = false;
  157. }));
  158. }
  159. } else {
  160. m_arguments_object_needed = false;
  161. }
  162. size_t* environment_size = nullptr;
  163. size_t parameter_environment_bindings_count = 0;
  164. // 19. If strict is true or hasParameterExpressions is false, then
  165. if (m_strict || !m_has_parameter_expressions) {
  166. // a. NOTE: Only a single Environment Record is needed for the parameters, since calls to eval in strict mode code cannot create new bindings which are visible outside of the eval.
  167. // b. Let env be the LexicalEnvironment of calleeContext
  168. // NOTE: Here we are only interested in the size of the environment.
  169. environment_size = &m_function_environment_bindings_count;
  170. }
  171. // 20. Else,
  172. else {
  173. // a. NOTE: A separate Environment Record is needed to ensure that bindings created by direct eval calls in the formal parameter list are outside the environment where parameters are declared.
  174. // b. Let calleeEnv be the LexicalEnvironment of calleeContext.
  175. // c. Let env be NewDeclarativeEnvironment(calleeEnv).
  176. environment_size = &parameter_environment_bindings_count;
  177. }
  178. *environment_size += m_parameter_names.size();
  179. HashTable<DeprecatedFlyString> parameter_bindings;
  180. // 22. If argumentsObjectNeeded is true, then
  181. if (m_arguments_object_needed) {
  182. // f. Let parameterBindings be the list-concatenation of parameterNames and « "arguments" ».
  183. parameter_bindings = m_parameter_names;
  184. parameter_bindings.set(vm().names.arguments.as_string());
  185. (*environment_size)++;
  186. } else {
  187. parameter_bindings = m_parameter_names;
  188. // a. Let parameterBindings be parameterNames.
  189. }
  190. HashTable<DeprecatedFlyString> instantiated_var_names;
  191. size_t* var_environment_size = nullptr;
  192. // 27. If hasParameterExpressions is false, then
  193. if (!m_has_parameter_expressions) {
  194. // b. Let instantiatedVarNames be a copy of the List parameterBindings.
  195. instantiated_var_names = parameter_bindings;
  196. if (scope_body) {
  197. // c. For each element n of varNames, do
  198. MUST(scope_body->for_each_var_declared_identifier([&](auto const& id) {
  199. // i. If instantiatedVarNames does not contain n, then
  200. if (instantiated_var_names.set(id.string()) == AK::HashSetResult::InsertedNewEntry) {
  201. // 1. Append n to instantiatedVarNames.
  202. // Following steps will be executed in function_declaration_instantiation:
  203. // 2. Perform ! env.CreateMutableBinding(n, false).
  204. // 3. Perform ! env.InitializeBinding(n, undefined).
  205. m_var_names_to_initialize_binding.append({
  206. .identifier = id,
  207. .parameter_binding = parameter_bindings.contains(id.string()),
  208. .function_name = function_names.contains(id.string()),
  209. });
  210. if (!id.is_local())
  211. (*environment_size)++;
  212. }
  213. }));
  214. }
  215. // d. Let varEnv be env
  216. var_environment_size = environment_size;
  217. } else {
  218. // a. NOTE: A separate Environment Record is needed to ensure that closures created by expressions in the formal parameter list do not have visibility of declarations in the function body.
  219. // b. Let varEnv be NewDeclarativeEnvironment(env).
  220. // NOTE: Here we are only interested in the size of the environment.
  221. var_environment_size = &m_var_environment_bindings_count;
  222. // 28. Else,
  223. // NOTE: Steps a, b, c and d are executed in function_declaration_instantiation.
  224. // e. For each element n of varNames, do
  225. if (scope_body) {
  226. MUST(scope_body->for_each_var_declared_identifier([&](auto const& id) {
  227. // 1. Append n to instantiatedVarNames.
  228. // Following steps will be executed in function_declaration_instantiation:
  229. // 2. Perform ! env.CreateMutableBinding(n, false).
  230. // 3. Perform ! env.InitializeBinding(n, undefined).
  231. if (instantiated_var_names.set(id.string()) == AK::HashSetResult::InsertedNewEntry) {
  232. m_var_names_to_initialize_binding.append({
  233. .identifier = id,
  234. .parameter_binding = parameter_bindings.contains(id.string()),
  235. .function_name = function_names.contains(id.string()),
  236. });
  237. if (!id.is_local())
  238. (*var_environment_size)++;
  239. }
  240. }));
  241. }
  242. }
  243. // 29. NOTE: Annex B.3.2.1 adds additional steps at this point.
  244. // B.3.2.1 Changes to FunctionDeclarationInstantiation, https://tc39.es/ecma262/#sec-web-compat-functiondeclarationinstantiation
  245. if (!m_strict && scope_body) {
  246. MUST(scope_body->for_each_function_hoistable_with_annexB_extension([&](FunctionDeclaration& function_declaration) {
  247. auto function_name = function_declaration.name();
  248. if (parameter_bindings.contains(function_name))
  249. return;
  250. if (!instantiated_var_names.contains(function_name) && function_name != vm().names.arguments.as_string()) {
  251. m_function_names_to_initialize_binding.append(function_name);
  252. instantiated_var_names.set(function_name);
  253. (*var_environment_size)++;
  254. }
  255. function_declaration.set_should_do_additional_annexB_steps();
  256. }));
  257. }
  258. size_t* lex_environment_size = nullptr;
  259. // 30. If strict is false, then
  260. if (!m_strict) {
  261. bool can_elide_declarative_environment = !m_contains_direct_call_to_eval && (!scope_body || !scope_body->has_lexical_declarations());
  262. if (can_elide_declarative_environment) {
  263. lex_environment_size = var_environment_size;
  264. } else {
  265. // a. Let lexEnv be NewDeclarativeEnvironment(varEnv).
  266. lex_environment_size = &m_lex_environment_bindings_count;
  267. }
  268. } else {
  269. // a. let lexEnv be varEnv.
  270. // NOTE: Here we are only interested in the size of the environment.
  271. lex_environment_size = var_environment_size;
  272. }
  273. if (scope_body) {
  274. MUST(scope_body->for_each_lexically_declared_identifier([&](auto const& id) {
  275. if (!id.is_local())
  276. (*lex_environment_size)++;
  277. }));
  278. }
  279. }
  280. void ECMAScriptFunctionObject::initialize(Realm& realm)
  281. {
  282. auto& vm = this->vm();
  283. Base::initialize(realm);
  284. // Note: The ordering of these properties must be: length, name, prototype which is the order
  285. // they are defined in the spec: https://tc39.es/ecma262/#sec-function-instances .
  286. // This is observable through something like: https://tc39.es/ecma262/#sec-ordinaryownpropertykeys
  287. // which must give the properties in chronological order which in this case is the order they
  288. // are defined in the spec.
  289. MUST(define_property_or_throw(vm.names.length, { .value = Value(m_function_length), .writable = false, .enumerable = false, .configurable = true }));
  290. MUST(define_property_or_throw(vm.names.name, { .value = PrimitiveString::create(vm, m_name.is_null() ? "" : m_name), .writable = false, .enumerable = false, .configurable = true }));
  291. if (!m_is_arrow_function) {
  292. Object* prototype = nullptr;
  293. switch (m_kind) {
  294. case FunctionKind::Normal:
  295. prototype = vm.heap().allocate<Object>(realm, realm.intrinsics().new_ordinary_function_prototype_object_shape());
  296. MUST(prototype->define_property_or_throw(vm.names.constructor, { .value = this, .writable = true, .enumerable = false, .configurable = true }));
  297. break;
  298. case FunctionKind::Generator:
  299. // prototype is "g1.prototype" in figure-2 (https://tc39.es/ecma262/img/figure-2.png)
  300. prototype = Object::create(realm, realm.intrinsics().generator_function_prototype_prototype());
  301. break;
  302. case FunctionKind::Async:
  303. break;
  304. case FunctionKind::AsyncGenerator:
  305. prototype = Object::create(realm, realm.intrinsics().async_generator_function_prototype_prototype());
  306. break;
  307. }
  308. // 27.7.4 AsyncFunction Instances, https://tc39.es/ecma262/#sec-async-function-instances
  309. // AsyncFunction instances do not have a prototype property as they are not constructible.
  310. if (m_kind != FunctionKind::Async)
  311. define_direct_property(vm.names.prototype, prototype, Attribute::Writable);
  312. }
  313. }
  314. // 10.2.1 [[Call]] ( thisArgument, argumentsList ), https://tc39.es/ecma262/#sec-ecmascript-function-objects-call-thisargument-argumentslist
  315. ThrowCompletionOr<Value> ECMAScriptFunctionObject::internal_call(Value this_argument, ReadonlySpan<Value> arguments_list)
  316. {
  317. auto& vm = this->vm();
  318. // 1. Let callerContext be the running execution context.
  319. // NOTE: No-op, kept by the VM in its execution context stack.
  320. ExecutionContext callee_context(heap());
  321. callee_context.local_variables.resize(m_local_variables_names.size());
  322. // Non-standard
  323. callee_context.arguments.append(arguments_list.data(), arguments_list.size());
  324. callee_context.instruction_stream_iterator = vm.bytecode_interpreter().instruction_stream_iterator();
  325. // 2. Let calleeContext be PrepareForOrdinaryCall(F, undefined).
  326. // NOTE: We throw if the end of the native stack is reached, so unlike in the spec this _does_ need an exception check.
  327. TRY(prepare_for_ordinary_call(callee_context, nullptr));
  328. // 3. Assert: calleeContext is now the running execution context.
  329. VERIFY(&vm.running_execution_context() == &callee_context);
  330. // 4. If F.[[IsClassConstructor]] is true, then
  331. if (m_is_class_constructor) {
  332. // a. Let error be a newly created TypeError object.
  333. // b. NOTE: error is created in calleeContext with F's associated Realm Record.
  334. auto throw_completion = vm.throw_completion<TypeError>(ErrorType::ClassConstructorWithoutNew, m_name);
  335. // c. Remove calleeContext from the execution context stack and restore callerContext as the running execution context.
  336. vm.pop_execution_context();
  337. // d. Return ThrowCompletion(error).
  338. return throw_completion;
  339. }
  340. // 5. Perform OrdinaryCallBindThis(F, calleeContext, thisArgument).
  341. ordinary_call_bind_this(callee_context, this_argument);
  342. // 6. Let result be Completion(OrdinaryCallEvaluateBody(F, argumentsList)).
  343. auto result = ordinary_call_evaluate_body();
  344. // 7. Remove calleeContext from the execution context stack and restore callerContext as the running execution context.
  345. vm.pop_execution_context();
  346. // 8. If result.[[Type]] is return, return result.[[Value]].
  347. if (result.type() == Completion::Type::Return)
  348. return *result.value();
  349. // 9. ReturnIfAbrupt(result).
  350. if (result.is_abrupt()) {
  351. VERIFY(result.is_error());
  352. return result;
  353. }
  354. // 10. Return undefined.
  355. return js_undefined();
  356. }
  357. // 10.2.2 [[Construct]] ( argumentsList, newTarget ), https://tc39.es/ecma262/#sec-ecmascript-function-objects-construct-argumentslist-newtarget
  358. ThrowCompletionOr<NonnullGCPtr<Object>> ECMAScriptFunctionObject::internal_construct(ReadonlySpan<Value> arguments_list, FunctionObject& new_target)
  359. {
  360. auto& vm = this->vm();
  361. // 1. Let callerContext be the running execution context.
  362. // NOTE: No-op, kept by the VM in its execution context stack.
  363. // 2. Let kind be F.[[ConstructorKind]].
  364. auto kind = m_constructor_kind;
  365. GCPtr<Object> this_argument;
  366. // 3. If kind is base, then
  367. if (kind == ConstructorKind::Base) {
  368. // a. Let thisArgument be ? OrdinaryCreateFromConstructor(newTarget, "%Object.prototype%").
  369. this_argument = TRY(ordinary_create_from_constructor<Object>(vm, new_target, &Intrinsics::object_prototype, ConstructWithPrototypeTag::Tag));
  370. }
  371. ExecutionContext callee_context(heap());
  372. callee_context.local_variables.resize(m_local_variables_names.size());
  373. // Non-standard
  374. callee_context.arguments.append(arguments_list.data(), arguments_list.size());
  375. callee_context.instruction_stream_iterator = vm.bytecode_interpreter().instruction_stream_iterator();
  376. // 4. Let calleeContext be PrepareForOrdinaryCall(F, newTarget).
  377. // NOTE: We throw if the end of the native stack is reached, so unlike in the spec this _does_ need an exception check.
  378. TRY(prepare_for_ordinary_call(callee_context, &new_target));
  379. // 5. Assert: calleeContext is now the running execution context.
  380. VERIFY(&vm.running_execution_context() == &callee_context);
  381. // 6. If kind is base, then
  382. if (kind == ConstructorKind::Base) {
  383. // a. Perform OrdinaryCallBindThis(F, calleeContext, thisArgument).
  384. ordinary_call_bind_this(callee_context, this_argument);
  385. // b. Let initializeResult be Completion(InitializeInstanceElements(thisArgument, F)).
  386. auto initialize_result = this_argument->initialize_instance_elements(*this);
  387. // c. If initializeResult is an abrupt completion, then
  388. if (initialize_result.is_throw_completion()) {
  389. // i. Remove calleeContext from the execution context stack and restore callerContext as the running execution context.
  390. vm.pop_execution_context();
  391. // ii. Return ? initializeResult.
  392. return initialize_result.throw_completion();
  393. }
  394. }
  395. // 7. Let constructorEnv be the LexicalEnvironment of calleeContext.
  396. auto constructor_env = callee_context.lexical_environment;
  397. // 8. Let result be Completion(OrdinaryCallEvaluateBody(F, argumentsList)).
  398. auto result = ordinary_call_evaluate_body();
  399. // 9. Remove calleeContext from the execution context stack and restore callerContext as the running execution context.
  400. vm.pop_execution_context();
  401. // 10. If result.[[Type]] is return, then
  402. if (result.type() == Completion::Type::Return) {
  403. // FIXME: This is leftover from untangling the call/construct mess - doesn't belong here in any way, but removing it breaks derived classes.
  404. // Likely fixed by making ClassDefinitionEvaluation fully spec compliant.
  405. if (kind == ConstructorKind::Derived && result.value()->is_object()) {
  406. auto prototype = TRY(new_target.get(vm.names.prototype));
  407. if (prototype.is_object())
  408. TRY(result.value()->as_object().internal_set_prototype_of(&prototype.as_object()));
  409. }
  410. // EOF (End of FIXME)
  411. // a. If Type(result.[[Value]]) is Object, return result.[[Value]].
  412. if (result.value()->is_object())
  413. return result.value()->as_object();
  414. // b. If kind is base, return thisArgument.
  415. if (kind == ConstructorKind::Base)
  416. return *this_argument;
  417. // c. If result.[[Value]] is not undefined, throw a TypeError exception.
  418. if (!result.value()->is_undefined())
  419. return vm.throw_completion<TypeError>(ErrorType::DerivedConstructorReturningInvalidValue);
  420. }
  421. // 11. Else, ReturnIfAbrupt(result).
  422. else if (result.is_abrupt()) {
  423. VERIFY(result.is_error());
  424. return result;
  425. }
  426. // 12. Let thisBinding be ? constructorEnv.GetThisBinding().
  427. auto this_binding = TRY(constructor_env->get_this_binding(vm));
  428. // 13. Assert: Type(thisBinding) is Object.
  429. VERIFY(this_binding.is_object());
  430. // 14. Return thisBinding.
  431. return this_binding.as_object();
  432. }
  433. void ECMAScriptFunctionObject::visit_edges(Visitor& visitor)
  434. {
  435. Base::visit_edges(visitor);
  436. visitor.visit(m_environment);
  437. visitor.visit(m_private_environment);
  438. visitor.visit(m_realm);
  439. visitor.visit(m_home_object);
  440. visitor.visit(m_bytecode_executable);
  441. for (auto& executable : m_default_parameter_bytecode_executables)
  442. visitor.visit(executable);
  443. for (auto& field : m_fields) {
  444. if (auto* property_key_ptr = field.name.get_pointer<PropertyKey>(); property_key_ptr && property_key_ptr->is_symbol())
  445. visitor.visit(property_key_ptr->as_symbol());
  446. }
  447. m_script_or_module.visit(
  448. [](Empty) {},
  449. [&](auto& script_or_module) {
  450. visitor.visit(script_or_module);
  451. });
  452. }
  453. // 10.2.7 MakeMethod ( F, homeObject ), https://tc39.es/ecma262/#sec-makemethod
  454. void ECMAScriptFunctionObject::make_method(Object& home_object)
  455. {
  456. // 1. Set F.[[HomeObject]] to homeObject.
  457. m_home_object = &home_object;
  458. // 2. Return unused.
  459. }
  460. // 10.2.11 FunctionDeclarationInstantiation ( func, argumentsList ), https://tc39.es/ecma262/#sec-functiondeclarationinstantiation
  461. ThrowCompletionOr<void> ECMAScriptFunctionObject::function_declaration_instantiation()
  462. {
  463. auto& vm = this->vm();
  464. auto& realm = *vm.current_realm();
  465. // 1. Let calleeContext be the running execution context.
  466. auto& callee_context = vm.running_execution_context();
  467. // 2. Let code be func.[[ECMAScriptCode]].
  468. ScopeNode const* scope_body = nullptr;
  469. if (is<ScopeNode>(*m_ecmascript_code))
  470. scope_body = static_cast<ScopeNode const*>(m_ecmascript_code.ptr());
  471. // NOTE: Following steps were executed in ECMAScriptFunctionObject constructor.
  472. // 3. Let strict be func.[[Strict]].
  473. // 4. Let formals be func.[[FormalParameters]].
  474. // 5. Let parameterNames be the BoundNames of formals.
  475. // 6. If parameterNames has any duplicate entries, let hasDuplicates be true. Otherwise, let hasDuplicates be false.
  476. // 7. Let simpleParameterList be IsSimpleParameterList of formals.
  477. bool const simple_parameter_list = has_simple_parameter_list();
  478. // NOTE: Following steps were executed in ECMAScriptFunctionObject constructor.
  479. // 8. Let hasParameterExpressions be ContainsExpression of formals.
  480. // 9. Let varNames be the VarDeclaredNames of code.
  481. // 10. Let varDeclarations be the VarScopedDeclarations of code.
  482. // 11. Let lexicalNames be the LexicallyDeclaredNames of code.
  483. // 12. Let functionNames be a new empty List.
  484. // 13. Let functionsToInitialize be a new empty List.
  485. // 14. For each element d of varDeclarations, in reverse List order, do
  486. // 15. Let argumentsObjectNeeded be true.
  487. // 16. If func.[[ThisMode]] is lexical, then
  488. // 17. Else if parameterNames contains "arguments", then
  489. // 18. Else if hasParameterExpressions is false, then
  490. GCPtr<Environment> environment;
  491. // 19. If strict is true or hasParameterExpressions is false, then
  492. if (m_strict || !m_has_parameter_expressions) {
  493. // a. NOTE: Only a single Environment Record is needed for the parameters, since calls to eval in strict mode code cannot create new bindings which are visible outside of the eval.
  494. // b. Let env be the LexicalEnvironment of calleeContext.
  495. environment = callee_context.lexical_environment;
  496. }
  497. // 20. Else,
  498. else {
  499. // a. NOTE: A separate Environment Record is needed to ensure that bindings created by direct eval calls in the formal parameter list are outside the environment where parameters are declared.
  500. // b. Let calleeEnv be the LexicalEnvironment of calleeContext.
  501. auto callee_env = callee_context.lexical_environment;
  502. // c. Let env be NewDeclarativeEnvironment(calleeEnv).
  503. environment = new_declarative_environment(*callee_env);
  504. // d. Assert: The VariableEnvironment of calleeContext is calleeEnv.
  505. VERIFY(callee_context.variable_environment == callee_context.lexical_environment);
  506. // e. Set the LexicalEnvironment of calleeContext to env.
  507. callee_context.lexical_environment = environment;
  508. }
  509. // 21. For each String paramName of parameterNames, do
  510. for (auto const& parameter_name : m_parameter_names) {
  511. // a. Let alreadyDeclared be ! env.HasBinding(paramName).
  512. // b. NOTE: Early errors ensure that duplicate parameter names can only occur in non-strict functions that do not have parameter default values or rest parameters.
  513. // c. If alreadyDeclared is false, then
  514. // NOTE: alreadyDeclared is always false because we use hash table for parameterNames
  515. // i. Perform ! env.CreateMutableBinding(paramName, false).
  516. MUST(environment->create_mutable_binding(vm, parameter_name, false));
  517. // ii. If hasDuplicates is true, then
  518. if (m_has_duplicates) {
  519. // 1. Perform ! env.InitializeBinding(paramName, undefined).
  520. MUST(environment->initialize_binding(vm, parameter_name, js_undefined(), Environment::InitializeBindingHint::Normal));
  521. }
  522. }
  523. // 22. If argumentsObjectNeeded is true, then
  524. if (m_arguments_object_needed) {
  525. Object* arguments_object;
  526. // a. If strict is true or simpleParameterList is false, then
  527. if (m_strict || !simple_parameter_list) {
  528. // i. Let ao be CreateUnmappedArgumentsObject(argumentsList).
  529. arguments_object = create_unmapped_arguments_object(vm, vm.running_execution_context().arguments);
  530. }
  531. // b. Else,
  532. else {
  533. // i. NOTE: A mapped argument object is only provided for non-strict functions that don't have a rest parameter, any parameter default value initializers, or any destructured parameters.
  534. // ii. Let ao be CreateMappedArgumentsObject(func, formals, argumentsList, env).
  535. arguments_object = create_mapped_arguments_object(vm, *this, formal_parameters(), vm.running_execution_context().arguments, *environment);
  536. }
  537. // c. If strict is true, then
  538. if (m_strict) {
  539. // i. Perform ! env.CreateImmutableBinding("arguments", false).
  540. MUST(environment->create_immutable_binding(vm, vm.names.arguments.as_string(), false));
  541. // ii. NOTE: In strict mode code early errors prevent attempting to assign to this binding, so its mutability is not observable.
  542. }
  543. // b. Else,
  544. else {
  545. // i. Perform ! env.CreateMutableBinding("arguments", false).
  546. MUST(environment->create_mutable_binding(vm, vm.names.arguments.as_string(), false));
  547. }
  548. // c. Perform ! env.InitializeBinding("arguments", ao).
  549. MUST(environment->initialize_binding(vm, vm.names.arguments.as_string(), arguments_object, Environment::InitializeBindingHint::Normal));
  550. // f. Let parameterBindings be the list-concatenation of parameterNames and « "arguments" ».
  551. }
  552. // 23. Else,
  553. else {
  554. // a. Let parameterBindings be parameterNames.
  555. }
  556. // NOTE: We now treat parameterBindings as parameterNames.
  557. // 24. Let iteratorRecord be CreateListIteratorRecord(argumentsList).
  558. // 25. If hasDuplicates is true, then
  559. // a. Perform ? IteratorBindingInitialization of formals with arguments iteratorRecord and undefined.
  560. // 26. Else,
  561. // a. Perform ? IteratorBindingInitialization of formals with arguments iteratorRecord and env.
  562. // NOTE: The spec makes an iterator here to do IteratorBindingInitialization but we just do it manually
  563. auto& execution_context_arguments = vm.running_execution_context().arguments;
  564. size_t default_parameter_index = 0;
  565. for (size_t i = 0; i < m_formal_parameters.size(); ++i) {
  566. auto& parameter = m_formal_parameters[i];
  567. if (parameter.default_value)
  568. ++default_parameter_index;
  569. TRY(parameter.binding.visit(
  570. [&](auto const& param) -> ThrowCompletionOr<void> {
  571. Value argument_value;
  572. if (parameter.is_rest) {
  573. auto array = MUST(Array::create(realm, 0));
  574. for (size_t rest_index = i; rest_index < execution_context_arguments.size(); ++rest_index)
  575. array->indexed_properties().append(execution_context_arguments[rest_index]);
  576. argument_value = array;
  577. } else if (i < execution_context_arguments.size() && !execution_context_arguments[i].is_undefined()) {
  578. argument_value = execution_context_arguments[i];
  579. } else if (parameter.default_value) {
  580. auto value_and_frame = vm.bytecode_interpreter().run_and_return_frame(*m_default_parameter_bytecode_executables[default_parameter_index - 1], nullptr);
  581. if (value_and_frame.value.is_error())
  582. return value_and_frame.value.release_error();
  583. // Resulting value is in the accumulator.
  584. argument_value = value_and_frame.frame->registers.at(0);
  585. } else {
  586. argument_value = js_undefined();
  587. }
  588. Environment* used_environment = m_has_duplicates ? nullptr : environment;
  589. if constexpr (IsSame<NonnullRefPtr<Identifier const> const&, decltype(param)>) {
  590. if (param->is_local()) {
  591. callee_context.local_variables[param->local_variable_index()] = argument_value;
  592. return {};
  593. }
  594. Reference reference = TRY(vm.resolve_binding(param->string(), used_environment));
  595. // Here the difference from hasDuplicates is important
  596. if (m_has_duplicates)
  597. return reference.put_value(vm, argument_value);
  598. return reference.initialize_referenced_binding(vm, argument_value);
  599. }
  600. if constexpr (IsSame<NonnullRefPtr<BindingPattern const> const&, decltype(param)>) {
  601. // Here the difference from hasDuplicates is important
  602. return vm.binding_initialization(param, argument_value, used_environment);
  603. }
  604. }));
  605. }
  606. GCPtr<Environment> var_environment;
  607. // 27. If hasParameterExpressions is false, then
  608. if (!m_has_parameter_expressions) {
  609. // a. NOTE: Only a single Environment Record is needed for the parameters and top-level vars.
  610. // b. Let instantiatedVarNames be a copy of the List parameterBindings.
  611. // NOTE: Done in implementation of step 27.c.i.1 below
  612. if (scope_body) {
  613. // NOTE: Due to the use of MUST with `create_mutable_binding` and `initialize_binding` below,
  614. // an exception should not result from `for_each_var_declared_name`.
  615. // c. For each element n of varNames, do
  616. for (auto const& variable_to_initialize : m_var_names_to_initialize_binding) {
  617. auto const& id = variable_to_initialize.identifier;
  618. // NOTE: Following steps were executed in ECMAScriptFunctionObject constructor.
  619. // i. If instantiatedVarNames does not contain n, then
  620. // 1. Append n to instantiatedVarNames.
  621. if (id.is_local()) {
  622. callee_context.local_variables[id.local_variable_index()] = js_undefined();
  623. } else {
  624. // 2. Perform ! env.CreateMutableBinding(n, false).
  625. // 3. Perform ! env.InitializeBinding(n, undefined).
  626. MUST(environment->create_mutable_binding(vm, id.string(), false));
  627. MUST(environment->initialize_binding(vm, id.string(), js_undefined(), Environment::InitializeBindingHint::Normal));
  628. }
  629. }
  630. }
  631. // d.Let varEnv be env
  632. var_environment = environment;
  633. }
  634. // 28. Else,
  635. else {
  636. // a. NOTE: A separate Environment Record is needed to ensure that closures created by expressions in the formal parameter list do not have visibility of declarations in the function body.
  637. // b. Let varEnv be NewDeclarativeEnvironment(env).
  638. var_environment = new_declarative_environment(*environment);
  639. static_cast<DeclarativeEnvironment*>(var_environment.ptr())->ensure_capacity(m_var_environment_bindings_count);
  640. // c. Set the VariableEnvironment of calleeContext to varEnv.
  641. callee_context.variable_environment = var_environment;
  642. // d. Let instantiatedVarNames be a new empty List.
  643. // NOTE: Already done above.
  644. if (scope_body) {
  645. // NOTE: Due to the use of MUST with `create_mutable_binding`, `get_binding_value` and `initialize_binding` below,
  646. // an exception should not result from `for_each_var_declared_name`.
  647. // e. For each element n of varNames, do
  648. for (auto const& variable_to_initialize : m_var_names_to_initialize_binding) {
  649. auto const& id = variable_to_initialize.identifier;
  650. // NOTE: Following steps were executed in ECMAScriptFunctionObject constructor.
  651. // i. If instantiatedVarNames does not contain n, then
  652. // 1. Append n to instantiatedVarNames.
  653. // 2. Perform ! varEnv.CreateMutableBinding(n, false).
  654. // NOTE: We ignore locals because they are stored in ExecutionContext instead of environment.
  655. if (!id.is_local())
  656. MUST(var_environment->create_mutable_binding(vm, id.string(), false));
  657. Value initial_value;
  658. // 3. If parameterBindings does not contain n, or if functionNames contains n, then
  659. if (!variable_to_initialize.parameter_binding || variable_to_initialize.function_name) {
  660. // a. Let initialValue be undefined.
  661. initial_value = js_undefined();
  662. }
  663. // 4. Else,
  664. else {
  665. // a. Let initialValue be ! env.GetBindingValue(n, false).
  666. if (id.is_local()) {
  667. initial_value = callee_context.local_variables[id.local_variable_index()];
  668. } else {
  669. initial_value = MUST(environment->get_binding_value(vm, id.string(), false));
  670. }
  671. }
  672. // 5. Perform ! varEnv.InitializeBinding(n, initialValue).
  673. if (id.is_local()) {
  674. // NOTE: Local variables are supported only in bytecode interpreter
  675. callee_context.local_variables[id.local_variable_index()] = initial_value;
  676. } else {
  677. MUST(var_environment->initialize_binding(vm, id.string(), initial_value, Environment::InitializeBindingHint::Normal));
  678. }
  679. // 6. NOTE: A var with the same name as a formal parameter initially has the same value as the corresponding initialized parameter.
  680. }
  681. }
  682. }
  683. // 29. NOTE: Annex B.3.2.1 adds additional steps at this point.
  684. // B.3.2.1 Changes to FunctionDeclarationInstantiation, https://tc39.es/ecma262/#sec-web-compat-functiondeclarationinstantiation
  685. if (!m_strict && scope_body) {
  686. // NOTE: Due to the use of MUST with `create_mutable_binding` and `initialize_binding` below,
  687. // an exception should not result from `for_each_function_hoistable_with_annexB_extension`.
  688. for (auto const& function_name : m_function_names_to_initialize_binding) {
  689. MUST(var_environment->create_mutable_binding(vm, function_name, false));
  690. MUST(var_environment->initialize_binding(vm, function_name, js_undefined(), Environment::InitializeBindingHint::Normal));
  691. }
  692. }
  693. GCPtr<Environment> lex_environment;
  694. // 30. If strict is false, then
  695. if (!m_strict) {
  696. // Optimization: We avoid creating empty top-level declarative environments in non-strict mode, if both of these conditions are true:
  697. // 1. there is no direct call to eval() within this function
  698. // 2. there are no lexical declarations that would go into the environment
  699. bool can_elide_declarative_environment = !m_contains_direct_call_to_eval && (!scope_body || !scope_body->has_lexical_declarations());
  700. if (can_elide_declarative_environment) {
  701. lex_environment = var_environment;
  702. } else {
  703. // a. Let lexEnv be NewDeclarativeEnvironment(varEnv).
  704. // b. NOTE: Non-strict functions use a separate Environment Record for top-level lexical declarations so that a direct eval
  705. // can determine whether any var scoped declarations introduced by the eval code conflict with pre-existing top-level
  706. // lexically scoped declarations. This is not needed for strict functions because a strict direct eval always places
  707. // all declarations into a new Environment Record.
  708. lex_environment = new_declarative_environment(*var_environment);
  709. static_cast<DeclarativeEnvironment*>(lex_environment.ptr())->ensure_capacity(m_lex_environment_bindings_count);
  710. }
  711. }
  712. // 31. Else,
  713. else {
  714. // a. let lexEnv be varEnv.
  715. lex_environment = var_environment;
  716. }
  717. // 32. Set the LexicalEnvironment of calleeContext to lexEnv.
  718. callee_context.lexical_environment = lex_environment;
  719. if (!scope_body)
  720. return {};
  721. // 33. Let lexDeclarations be the LexicallyScopedDeclarations of code.
  722. // 34. For each element d of lexDeclarations, do
  723. // NOTE: Due to the use of MUST in the callback, an exception should not result from `for_each_lexically_scoped_declaration`.
  724. MUST(scope_body->for_each_lexically_scoped_declaration([&](Declaration const& declaration) {
  725. // NOTE: Due to the use of MUST with `create_immutable_binding` and `create_mutable_binding` below,
  726. // an exception should not result from `for_each_bound_name`.
  727. // a. NOTE: A lexically declared name cannot be the same as a function/generator declaration, formal parameter, or a var name. Lexically declared names are only instantiated here but not initialized.
  728. // b. For each element dn of the BoundNames of d, do
  729. MUST(declaration.for_each_bound_identifier([&](auto const& id) {
  730. if (id.is_local()) {
  731. // NOTE: Local variables are supported only in bytecode interpreter
  732. return;
  733. }
  734. // i. If IsConstantDeclaration of d is true, then
  735. if (declaration.is_constant_declaration()) {
  736. // 1. Perform ! lexEnv.CreateImmutableBinding(dn, true).
  737. MUST(lex_environment->create_immutable_binding(vm, id.string(), true));
  738. }
  739. // ii. Else,
  740. else {
  741. // 1. Perform ! lexEnv.CreateMutableBinding(dn, false).
  742. MUST(lex_environment->create_mutable_binding(vm, id.string(), false));
  743. }
  744. }));
  745. }));
  746. // 35. Let privateEnv be the PrivateEnvironment of calleeContext.
  747. auto private_environment = callee_context.private_environment;
  748. // 36. For each Parse Node f of functionsToInitialize, do
  749. for (auto& declaration : m_functions_to_initialize) {
  750. // a. Let fn be the sole element of the BoundNames of f.
  751. // b. Let fo be InstantiateFunctionObject of f with arguments lexEnv and privateEnv.
  752. auto function = ECMAScriptFunctionObject::create(realm, declaration.name(), declaration.source_text(), declaration.body(), declaration.parameters(), declaration.function_length(), declaration.local_variables_names(), lex_environment, private_environment, declaration.kind(), declaration.is_strict_mode(), declaration.might_need_arguments_object(), declaration.contains_direct_call_to_eval());
  753. // c. Perform ! varEnv.SetMutableBinding(fn, fo, false).
  754. if (declaration.name_identifier()->is_local()) {
  755. callee_context.local_variables[declaration.name_identifier()->local_variable_index()] = function;
  756. } else {
  757. MUST(var_environment->set_mutable_binding(vm, declaration.name(), function, false));
  758. }
  759. }
  760. if (is<DeclarativeEnvironment>(*lex_environment))
  761. static_cast<DeclarativeEnvironment*>(lex_environment.ptr())->shrink_to_fit();
  762. if (is<DeclarativeEnvironment>(*var_environment))
  763. static_cast<DeclarativeEnvironment*>(var_environment.ptr())->shrink_to_fit();
  764. // 37. Return unused.
  765. return {};
  766. }
  767. // 10.2.1.1 PrepareForOrdinaryCall ( F, newTarget ), https://tc39.es/ecma262/#sec-prepareforordinarycall
  768. ThrowCompletionOr<void> ECMAScriptFunctionObject::prepare_for_ordinary_call(ExecutionContext& callee_context, Object* new_target)
  769. {
  770. auto& vm = this->vm();
  771. // Non-standard
  772. callee_context.is_strict_mode = m_strict;
  773. // 1. Let callerContext be the running execution context.
  774. // 2. Let calleeContext be a new ECMAScript code execution context.
  775. // NOTE: In the specification, PrepareForOrdinaryCall "returns" a new callee execution context.
  776. // To avoid heap allocations, we put our ExecutionContext objects on the C++ stack instead.
  777. // Whoever calls us should put an ExecutionContext on their stack and pass that as the `callee_context`.
  778. // 3. Set the Function of calleeContext to F.
  779. callee_context.function = this;
  780. callee_context.function_name = m_name;
  781. // 4. Let calleeRealm be F.[[Realm]].
  782. auto callee_realm = m_realm;
  783. // NOTE: This non-standard fallback is needed until we can guarantee that literally
  784. // every function has a realm - especially in LibWeb that's sometimes not the case
  785. // when a function is created while no JS is running, as we currently need to rely on
  786. // that (:acid2:, I know - see set_event_handler_attribute() for an example).
  787. // If there's no 'current realm' either, we can't continue and crash.
  788. if (!callee_realm)
  789. callee_realm = vm.current_realm();
  790. VERIFY(callee_realm);
  791. // 5. Set the Realm of calleeContext to calleeRealm.
  792. callee_context.realm = callee_realm;
  793. // 6. Set the ScriptOrModule of calleeContext to F.[[ScriptOrModule]].
  794. callee_context.script_or_module = m_script_or_module;
  795. // 7. Let localEnv be NewFunctionEnvironment(F, newTarget).
  796. auto local_environment = new_function_environment(*this, new_target);
  797. local_environment->ensure_capacity(m_function_environment_bindings_count);
  798. // 8. Set the LexicalEnvironment of calleeContext to localEnv.
  799. callee_context.lexical_environment = local_environment;
  800. // 9. Set the VariableEnvironment of calleeContext to localEnv.
  801. callee_context.variable_environment = local_environment;
  802. // 10. Set the PrivateEnvironment of calleeContext to F.[[PrivateEnvironment]].
  803. callee_context.private_environment = m_private_environment;
  804. // 11. If callerContext is not already suspended, suspend callerContext.
  805. // FIXME: We don't have this concept yet.
  806. // 12. Push calleeContext onto the execution context stack; calleeContext is now the running execution context.
  807. TRY(vm.push_execution_context(callee_context, {}));
  808. // 13. NOTE: Any exception objects produced after this point are associated with calleeRealm.
  809. // 14. Return calleeContext.
  810. // NOTE: See the comment after step 2 above about how contexts are allocated on the C++ stack.
  811. return {};
  812. }
  813. // 10.2.1.2 OrdinaryCallBindThis ( F, calleeContext, thisArgument ), https://tc39.es/ecma262/#sec-ordinarycallbindthis
  814. void ECMAScriptFunctionObject::ordinary_call_bind_this(ExecutionContext& callee_context, Value this_argument)
  815. {
  816. auto& vm = this->vm();
  817. // 1. Let thisMode be F.[[ThisMode]].
  818. auto this_mode = m_this_mode;
  819. // If thisMode is lexical, return unused.
  820. if (this_mode == ThisMode::Lexical)
  821. return;
  822. // 3. Let calleeRealm be F.[[Realm]].
  823. auto callee_realm = m_realm;
  824. // NOTE: This non-standard fallback is needed until we can guarantee that literally
  825. // every function has a realm - especially in LibWeb that's sometimes not the case
  826. // when a function is created while no JS is running, as we currently need to rely on
  827. // that (:acid2:, I know - see set_event_handler_attribute() for an example).
  828. // If there's no 'current realm' either, we can't continue and crash.
  829. if (!callee_realm)
  830. callee_realm = vm.current_realm();
  831. VERIFY(callee_realm);
  832. // 4. Let localEnv be the LexicalEnvironment of calleeContext.
  833. auto local_env = callee_context.lexical_environment;
  834. Value this_value;
  835. // 5. If thisMode is strict, let thisValue be thisArgument.
  836. if (this_mode == ThisMode::Strict) {
  837. this_value = this_argument;
  838. }
  839. // 6. Else,
  840. else {
  841. // a. If thisArgument is undefined or null, then
  842. if (this_argument.is_nullish()) {
  843. // i. Let globalEnv be calleeRealm.[[GlobalEnv]].
  844. // ii. Assert: globalEnv is a global Environment Record.
  845. auto& global_env = callee_realm->global_environment();
  846. // iii. Let thisValue be globalEnv.[[GlobalThisValue]].
  847. this_value = &global_env.global_this_value();
  848. }
  849. // b. Else,
  850. else {
  851. // i. Let thisValue be ! ToObject(thisArgument).
  852. this_value = MUST(this_argument.to_object(vm));
  853. // ii. NOTE: ToObject produces wrapper objects using calleeRealm.
  854. VERIFY(vm.current_realm() == callee_realm);
  855. }
  856. }
  857. // 7. Assert: localEnv is a function Environment Record.
  858. // 8. Assert: The next step never returns an abrupt completion because localEnv.[[ThisBindingStatus]] is not initialized.
  859. // 9. Perform ! localEnv.BindThisValue(thisValue).
  860. MUST(verify_cast<FunctionEnvironment>(*local_env).bind_this_value(vm, this_value));
  861. // 10. Return unused.
  862. }
  863. // 27.7.5.1 AsyncFunctionStart ( promiseCapability, asyncFunctionBody ), https://tc39.es/ecma262/#sec-async-functions-abstract-operations-async-function-start
  864. template<typename T>
  865. void async_function_start(VM& vm, PromiseCapability const& promise_capability, T const& async_function_body)
  866. {
  867. // 1. Let runningContext be the running execution context.
  868. auto& running_context = vm.running_execution_context();
  869. // 2. Let asyncContext be a copy of runningContext.
  870. auto async_context = running_context.copy();
  871. // 3. NOTE: Copying the execution state is required for AsyncBlockStart to resume its execution. It is ill-defined to resume a currently executing context.
  872. // 4. Perform AsyncBlockStart(promiseCapability, asyncFunctionBody, asyncContext).
  873. async_block_start(vm, async_function_body, promise_capability, async_context);
  874. // 5. Return unused.
  875. }
  876. // 27.7.5.2 AsyncBlockStart ( promiseCapability, asyncBody, asyncContext ), https://tc39.es/ecma262/#sec-asyncblockstart
  877. // 12.7.1.1 AsyncBlockStart ( promiseCapability, asyncBody, asyncContext ), https://tc39.es/proposal-explicit-resource-management/#sec-asyncblockstart
  878. // 1.2.1.1 AsyncBlockStart ( promiseCapability, asyncBody, asyncContext ), https://tc39.es/proposal-array-from-async/#sec-asyncblockstart
  879. template<typename T>
  880. void async_block_start(VM& vm, T const& async_body, PromiseCapability const& promise_capability, ExecutionContext& async_context)
  881. {
  882. // NOTE: This function is a combination between two proposals, so does not exactly match spec steps of either.
  883. auto& realm = *vm.current_realm();
  884. // 1. Assert: promiseCapability is a PromiseCapability Record.
  885. // 2. Let runningContext be the running execution context.
  886. auto& running_context = vm.running_execution_context();
  887. // 3. Set the code evaluation state of asyncContext such that when evaluation is resumed for that execution context the following steps will be performed:
  888. auto execution_steps = NativeFunction::create(realm, "", [&async_body, &promise_capability, &async_context](auto& vm) -> ThrowCompletionOr<Value> {
  889. Completion result;
  890. // a. If asyncBody is a Parse Node, then
  891. if constexpr (!IsCallableWithArguments<T, Completion>) {
  892. // a. Let result be the result of evaluating asyncBody.
  893. // FIXME: Cache this executable somewhere.
  894. auto maybe_executable = Bytecode::compile(vm, async_body, FunctionKind::Async, "AsyncBlockStart"sv);
  895. if (maybe_executable.is_error())
  896. result = maybe_executable.release_error();
  897. else
  898. result = vm.bytecode_interpreter().run_and_return_frame(*maybe_executable.value(), nullptr).value;
  899. }
  900. // b. Else,
  901. else {
  902. // i. Assert: asyncBody is an Abstract Closure with no parameters.
  903. static_assert(IsCallableWithArguments<T, Completion>);
  904. // ii. Let result be asyncBody().
  905. result = async_body();
  906. }
  907. // c. Assert: If we return here, the async function either threw an exception or performed an implicit or explicit return; all awaiting is done.
  908. // d. Remove asyncContext from the execution context stack and restore the execution context that is at the top of the execution context stack as the running execution context.
  909. vm.pop_execution_context();
  910. // NOTE: This does not work for Array.fromAsync, likely due to conflicts between that proposal and Explicit Resource Management proposal.
  911. if constexpr (!IsCallableWithArguments<T, Completion>) {
  912. // e. Let env be asyncContext's LexicalEnvironment.
  913. auto env = async_context.lexical_environment;
  914. // f. Set result to DisposeResources(env, result).
  915. result = dispose_resources(vm, verify_cast<DeclarativeEnvironment>(env.ptr()), result);
  916. } else {
  917. (void)async_context;
  918. }
  919. // g. If result.[[Type]] is normal, then
  920. if (result.type() == Completion::Type::Normal) {
  921. // i. Perform ! Call(promiseCapability.[[Resolve]], undefined, « undefined »).
  922. MUST(call(vm, *promise_capability.resolve(), js_undefined(), js_undefined()));
  923. }
  924. // h. Else if result.[[Type]] is return, then
  925. else if (result.type() == Completion::Type::Return) {
  926. // i. Perform ! Call(promiseCapability.[[Resolve]], undefined, « result.[[Value]] »).
  927. MUST(call(vm, *promise_capability.resolve(), js_undefined(), *result.value()));
  928. }
  929. // i. Else,
  930. else {
  931. // i. Assert: result.[[Type]] is throw.
  932. VERIFY(result.type() == Completion::Type::Throw);
  933. // ii. Perform ! Call(promiseCapability.[[Reject]], undefined, « result.[[Value]] »).
  934. MUST(call(vm, *promise_capability.reject(), js_undefined(), *result.value()));
  935. }
  936. // j. Return unused.
  937. // NOTE: We don't support returning an empty/optional/unused value here.
  938. return js_undefined();
  939. });
  940. // 4. Push asyncContext onto the execution context stack; asyncContext is now the running execution context.
  941. auto push_result = vm.push_execution_context(async_context, {});
  942. if (push_result.is_error())
  943. return;
  944. // 5. Resume the suspended evaluation of asyncContext. Let result be the value returned by the resumed computation.
  945. auto result = call(vm, *execution_steps, async_context.this_value.is_empty() ? js_undefined() : async_context.this_value);
  946. // 6. Assert: When we return here, asyncContext has already been removed from the execution context stack and runningContext is the currently running execution context.
  947. VERIFY(&vm.running_execution_context() == &running_context);
  948. // 7. Assert: result is a normal completion with a value of unused. The possible sources of this value are Await or, if the async function doesn't await anything, step 3.g above.
  949. VERIFY(result.has_value() && result.value().is_undefined());
  950. // 8. Return unused.
  951. }
  952. template void async_block_start(VM&, NonnullRefPtr<Statement const> const& async_body, PromiseCapability const&, ExecutionContext&);
  953. template void async_function_start(VM&, PromiseCapability const&, NonnullRefPtr<Statement const> const& async_function_body);
  954. template void async_block_start(VM&, SafeFunction<Completion()> const& async_body, PromiseCapability const&, ExecutionContext&);
  955. template void async_function_start(VM&, PromiseCapability const&, SafeFunction<Completion()> const& async_function_body);
  956. // 10.2.1.4 OrdinaryCallEvaluateBody ( F, argumentsList ), https://tc39.es/ecma262/#sec-ordinarycallevaluatebody
  957. // 15.8.4 Runtime Semantics: EvaluateAsyncFunctionBody, https://tc39.es/ecma262/#sec-runtime-semantics-evaluatefunctionbody
  958. Completion ECMAScriptFunctionObject::ordinary_call_evaluate_body()
  959. {
  960. auto& vm = this->vm();
  961. auto& realm = *vm.current_realm();
  962. // NOTE: There's a subtle ordering issue here:
  963. // - We have to compile the default parameter values before instantiating the function.
  964. // - We have to instantiate the function before compiling the function body.
  965. // This is why FunctionDeclarationInstantiation is invoked in the middle.
  966. // The issue is that FunctionDeclarationInstantiation may mark certain functions as hoisted
  967. // per Annex B. This affects code generation for FunctionDeclaration nodes.
  968. if (!m_bytecode_executable) {
  969. size_t default_parameter_index = 0;
  970. for (auto& parameter : m_formal_parameters) {
  971. if (!parameter.default_value)
  972. continue;
  973. if (parameter.bytecode_executable.is_null()) {
  974. auto executable = TRY(Bytecode::compile(vm, *parameter.default_value, FunctionKind::Normal, DeprecatedString::formatted("default parameter #{} for {}", default_parameter_index++, m_name)));
  975. const_cast<FunctionParameter&>(parameter).bytecode_executable = executable;
  976. m_default_parameter_bytecode_executables.append(move(executable));
  977. } else {
  978. m_default_parameter_bytecode_executables.append(*parameter.bytecode_executable);
  979. }
  980. }
  981. }
  982. auto declaration_result = function_declaration_instantiation();
  983. if (m_kind == FunctionKind::Normal || m_kind == FunctionKind::Generator || m_kind == FunctionKind::AsyncGenerator) {
  984. if (declaration_result.is_error())
  985. return declaration_result.release_error();
  986. }
  987. if (!m_bytecode_executable) {
  988. if (!m_ecmascript_code->bytecode_executable())
  989. const_cast<Statement&>(*m_ecmascript_code).set_bytecode_executable(TRY(Bytecode::compile(vm, *m_ecmascript_code, m_kind, m_name)));
  990. m_bytecode_executable = m_ecmascript_code->bytecode_executable();
  991. }
  992. if (m_kind == FunctionKind::Async) {
  993. if (declaration_result.is_throw_completion()) {
  994. auto promise_capability = MUST(new_promise_capability(vm, realm.intrinsics().promise_constructor()));
  995. MUST(call(vm, *promise_capability->reject(), js_undefined(), *declaration_result.throw_completion().value()));
  996. return Completion { Completion::Type::Return, promise_capability->promise(), {} };
  997. }
  998. }
  999. auto result_and_frame = vm.bytecode_interpreter().run_and_return_frame(*m_bytecode_executable, nullptr);
  1000. VERIFY(result_and_frame.frame != nullptr);
  1001. if (result_and_frame.value.is_error())
  1002. return result_and_frame.value.release_error();
  1003. auto result = result_and_frame.value.release_value();
  1004. // NOTE: Running the bytecode should eventually return a completion.
  1005. // Until it does, we assume "return" and include the undefined fallback from the call site.
  1006. if (m_kind == FunctionKind::Normal)
  1007. return { Completion::Type::Return, result.value_or(js_undefined()), {} };
  1008. if (m_kind == FunctionKind::AsyncGenerator) {
  1009. auto async_generator_object = TRY(AsyncGenerator::create(realm, result, this, vm.running_execution_context().copy(), move(*result_and_frame.frame)));
  1010. return { Completion::Type::Return, async_generator_object, {} };
  1011. }
  1012. auto generator_object = TRY(GeneratorObject::create(realm, result, this, vm.running_execution_context().copy(), move(*result_and_frame.frame)));
  1013. // NOTE: Async functions are entirely transformed to generator functions, and wrapped in a custom driver that returns a promise
  1014. // See AwaitExpression::generate_bytecode() for the transformation.
  1015. if (m_kind == FunctionKind::Async)
  1016. return { Completion::Type::Return, AsyncFunctionDriverWrapper::create(realm, generator_object), {} };
  1017. VERIFY(m_kind == FunctionKind::Generator);
  1018. return { Completion::Type::Return, generator_object, {} };
  1019. }
  1020. void ECMAScriptFunctionObject::set_name(DeprecatedFlyString const& name)
  1021. {
  1022. VERIFY(!name.is_null());
  1023. auto& vm = this->vm();
  1024. m_name = name;
  1025. MUST(define_property_or_throw(vm.names.name, { .value = PrimitiveString::create(vm, m_name), .writable = false, .enumerable = false, .configurable = true }));
  1026. }
  1027. }