ECMAScriptFunctionObject.cpp 62 KB

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