ECMAScriptFunctionObject.cpp 61 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244
  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, MarkedVector<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.extend(move(arguments_list));
  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(MarkedVector<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.extend(move(arguments_list));
  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. for (auto& field : m_fields) {
  441. if (auto* property_key_ptr = field.name.get_pointer<PropertyKey>(); property_key_ptr && property_key_ptr->is_symbol())
  442. visitor.visit(property_key_ptr->as_symbol());
  443. }
  444. m_script_or_module.visit(
  445. [](Empty) {},
  446. [&](auto& script_or_module) {
  447. visitor.visit(script_or_module);
  448. });
  449. }
  450. // 10.2.7 MakeMethod ( F, homeObject ), https://tc39.es/ecma262/#sec-makemethod
  451. void ECMAScriptFunctionObject::make_method(Object& home_object)
  452. {
  453. // 1. Set F.[[HomeObject]] to homeObject.
  454. m_home_object = &home_object;
  455. // 2. Return unused.
  456. }
  457. // 10.2.11 FunctionDeclarationInstantiation ( func, argumentsList ), https://tc39.es/ecma262/#sec-functiondeclarationinstantiation
  458. ThrowCompletionOr<void> ECMAScriptFunctionObject::function_declaration_instantiation()
  459. {
  460. auto& vm = this->vm();
  461. auto& realm = *vm.current_realm();
  462. // 1. Let calleeContext be the running execution context.
  463. auto& callee_context = vm.running_execution_context();
  464. // 2. Let code be func.[[ECMAScriptCode]].
  465. ScopeNode const* scope_body = nullptr;
  466. if (is<ScopeNode>(*m_ecmascript_code))
  467. scope_body = static_cast<ScopeNode const*>(m_ecmascript_code.ptr());
  468. // NOTE: Following steps were executed in ECMAScriptFunctionObject constructor.
  469. // 3. Let strict be func.[[Strict]].
  470. // 4. Let formals be func.[[FormalParameters]].
  471. // 5. Let parameterNames be the BoundNames of formals.
  472. // 6. If parameterNames has any duplicate entries, let hasDuplicates be true. Otherwise, let hasDuplicates be false.
  473. // 7. Let simpleParameterList be IsSimpleParameterList of formals.
  474. bool const simple_parameter_list = has_simple_parameter_list();
  475. // NOTE: Following steps were executed in ECMAScriptFunctionObject constructor.
  476. // 8. Let hasParameterExpressions be ContainsExpression of formals.
  477. // 9. Let varNames be the VarDeclaredNames of code.
  478. // 10. Let varDeclarations be the VarScopedDeclarations of code.
  479. // 11. Let lexicalNames be the LexicallyDeclaredNames of code.
  480. // 12. Let functionNames be a new empty List.
  481. // 13. Let functionsToInitialize be a new empty List.
  482. // 14. For each element d of varDeclarations, in reverse List order, do
  483. // 15. Let argumentsObjectNeeded be true.
  484. // 16. If func.[[ThisMode]] is lexical, then
  485. // 17. Else if parameterNames contains "arguments", then
  486. // 18. Else if hasParameterExpressions is false, then
  487. GCPtr<Environment> environment;
  488. // 19. If strict is true or hasParameterExpressions is false, then
  489. if (m_strict || !m_has_parameter_expressions) {
  490. // 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.
  491. // b. Let env be the LexicalEnvironment of calleeContext.
  492. environment = callee_context.lexical_environment;
  493. }
  494. // 20. Else,
  495. else {
  496. // 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.
  497. // b. Let calleeEnv be the LexicalEnvironment of calleeContext.
  498. auto callee_env = callee_context.lexical_environment;
  499. // c. Let env be NewDeclarativeEnvironment(calleeEnv).
  500. environment = new_declarative_environment(*callee_env);
  501. // d. Assert: The VariableEnvironment of calleeContext is calleeEnv.
  502. VERIFY(callee_context.variable_environment == callee_context.lexical_environment);
  503. // e. Set the LexicalEnvironment of calleeContext to env.
  504. callee_context.lexical_environment = environment;
  505. }
  506. // 21. For each String paramName of parameterNames, do
  507. for (auto const& parameter_name : m_parameter_names) {
  508. // a. Let alreadyDeclared be ! env.HasBinding(paramName).
  509. // 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.
  510. // c. If alreadyDeclared is false, then
  511. // NOTE: alreadyDeclared is always false because we use hash table for parameterNames
  512. // i. Perform ! env.CreateMutableBinding(paramName, false).
  513. MUST(environment->create_mutable_binding(vm, parameter_name, false));
  514. // ii. If hasDuplicates is true, then
  515. if (m_has_duplicates) {
  516. // 1. Perform ! env.InitializeBinding(paramName, undefined).
  517. MUST(environment->initialize_binding(vm, parameter_name, js_undefined(), Environment::InitializeBindingHint::Normal));
  518. }
  519. }
  520. // 22. If argumentsObjectNeeded is true, then
  521. if (m_arguments_object_needed) {
  522. Object* arguments_object;
  523. // a. If strict is true or simpleParameterList is false, then
  524. if (m_strict || !simple_parameter_list) {
  525. // i. Let ao be CreateUnmappedArgumentsObject(argumentsList).
  526. arguments_object = create_unmapped_arguments_object(vm, vm.running_execution_context().arguments);
  527. }
  528. // b. Else,
  529. else {
  530. // 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.
  531. // ii. Let ao be CreateMappedArgumentsObject(func, formals, argumentsList, env).
  532. arguments_object = create_mapped_arguments_object(vm, *this, formal_parameters(), vm.running_execution_context().arguments, *environment);
  533. }
  534. // c. If strict is true, then
  535. if (m_strict) {
  536. // i. Perform ! env.CreateImmutableBinding("arguments", false).
  537. MUST(environment->create_immutable_binding(vm, vm.names.arguments.as_string(), false));
  538. // ii. NOTE: In strict mode code early errors prevent attempting to assign to this binding, so its mutability is not observable.
  539. }
  540. // b. Else,
  541. else {
  542. // i. Perform ! env.CreateMutableBinding("arguments", false).
  543. MUST(environment->create_mutable_binding(vm, vm.names.arguments.as_string(), false));
  544. }
  545. // c. Perform ! env.InitializeBinding("arguments", ao).
  546. MUST(environment->initialize_binding(vm, vm.names.arguments.as_string(), arguments_object, Environment::InitializeBindingHint::Normal));
  547. // f. Let parameterBindings be the list-concatenation of parameterNames and « "arguments" ».
  548. }
  549. // 23. Else,
  550. else {
  551. // a. Let parameterBindings be parameterNames.
  552. }
  553. // NOTE: We now treat parameterBindings as parameterNames.
  554. // 24. Let iteratorRecord be CreateListIteratorRecord(argumentsList).
  555. // 25. If hasDuplicates is true, then
  556. // a. Perform ? IteratorBindingInitialization of formals with arguments iteratorRecord and undefined.
  557. // 26. Else,
  558. // a. Perform ? IteratorBindingInitialization of formals with arguments iteratorRecord and env.
  559. // NOTE: The spec makes an iterator here to do IteratorBindingInitialization but we just do it manually
  560. auto& execution_context_arguments = vm.running_execution_context().arguments;
  561. size_t default_parameter_index = 0;
  562. for (size_t i = 0; i < m_formal_parameters.size(); ++i) {
  563. auto& parameter = m_formal_parameters[i];
  564. if (parameter.default_value)
  565. ++default_parameter_index;
  566. TRY(parameter.binding.visit(
  567. [&](auto const& param) -> ThrowCompletionOr<void> {
  568. Value argument_value;
  569. if (parameter.is_rest) {
  570. auto array = MUST(Array::create(realm, 0));
  571. for (size_t rest_index = i; rest_index < execution_context_arguments.size(); ++rest_index)
  572. array->indexed_properties().append(execution_context_arguments[rest_index]);
  573. argument_value = array;
  574. } else if (i < execution_context_arguments.size() && !execution_context_arguments[i].is_undefined()) {
  575. argument_value = execution_context_arguments[i];
  576. } else if (parameter.default_value) {
  577. auto value_and_frame = vm.bytecode_interpreter().run_and_return_frame(*m_default_parameter_bytecode_executables[default_parameter_index - 1], nullptr);
  578. if (value_and_frame.value.is_error())
  579. return value_and_frame.value.release_error();
  580. // Resulting value is in the accumulator.
  581. argument_value = value_and_frame.frame->registers.at(0);
  582. } else {
  583. argument_value = js_undefined();
  584. }
  585. Environment* used_environment = m_has_duplicates ? nullptr : environment;
  586. if constexpr (IsSame<NonnullRefPtr<Identifier const> const&, decltype(param)>) {
  587. if (param->is_local()) {
  588. callee_context.local_variables[param->local_variable_index()] = argument_value;
  589. return {};
  590. }
  591. Reference reference = TRY(vm.resolve_binding(param->string(), used_environment));
  592. // Here the difference from hasDuplicates is important
  593. if (m_has_duplicates)
  594. return reference.put_value(vm, argument_value);
  595. return reference.initialize_referenced_binding(vm, argument_value);
  596. }
  597. if constexpr (IsSame<NonnullRefPtr<BindingPattern const> const&, decltype(param)>) {
  598. // Here the difference from hasDuplicates is important
  599. return vm.binding_initialization(param, argument_value, used_environment);
  600. }
  601. }));
  602. }
  603. GCPtr<Environment> var_environment;
  604. // 27. If hasParameterExpressions is false, then
  605. if (!m_has_parameter_expressions) {
  606. // a. NOTE: Only a single Environment Record is needed for the parameters and top-level vars.
  607. // b. Let instantiatedVarNames be a copy of the List parameterBindings.
  608. // NOTE: Done in implementation of step 27.c.i.1 below
  609. if (scope_body) {
  610. // NOTE: Due to the use of MUST with `create_mutable_binding` and `initialize_binding` below,
  611. // an exception should not result from `for_each_var_declared_name`.
  612. // c. For each element n of varNames, do
  613. for (auto const& variable_to_initialize : m_var_names_to_initialize_binding) {
  614. auto const& id = variable_to_initialize.identifier;
  615. // NOTE: Following steps were executed in ECMAScriptFunctionObject constructor.
  616. // i. If instantiatedVarNames does not contain n, then
  617. // 1. Append n to instantiatedVarNames.
  618. if (id.is_local()) {
  619. callee_context.local_variables[id.local_variable_index()] = js_undefined();
  620. } else {
  621. // 2. Perform ! env.CreateMutableBinding(n, false).
  622. // 3. Perform ! env.InitializeBinding(n, undefined).
  623. MUST(environment->create_mutable_binding(vm, id.string(), false));
  624. MUST(environment->initialize_binding(vm, id.string(), js_undefined(), Environment::InitializeBindingHint::Normal));
  625. }
  626. }
  627. }
  628. // d.Let varEnv be env
  629. var_environment = environment;
  630. }
  631. // 28. Else,
  632. else {
  633. // 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.
  634. // b. Let varEnv be NewDeclarativeEnvironment(env).
  635. var_environment = new_declarative_environment(*environment);
  636. static_cast<DeclarativeEnvironment*>(var_environment.ptr())->ensure_capacity(m_var_environment_bindings_count);
  637. // c. Set the VariableEnvironment of calleeContext to varEnv.
  638. callee_context.variable_environment = var_environment;
  639. // d. Let instantiatedVarNames be a new empty List.
  640. // NOTE: Already done above.
  641. if (scope_body) {
  642. // NOTE: Due to the use of MUST with `create_mutable_binding`, `get_binding_value` and `initialize_binding` below,
  643. // an exception should not result from `for_each_var_declared_name`.
  644. // e. For each element n of varNames, do
  645. for (auto const& variable_to_initialize : m_var_names_to_initialize_binding) {
  646. auto const& id = variable_to_initialize.identifier;
  647. // NOTE: Following steps were executed in ECMAScriptFunctionObject constructor.
  648. // i. If instantiatedVarNames does not contain n, then
  649. // 1. Append n to instantiatedVarNames.
  650. // 2. Perform ! varEnv.CreateMutableBinding(n, false).
  651. // NOTE: We ignore locals because they are stored in ExecutionContext instead of environment.
  652. if (!id.is_local())
  653. MUST(var_environment->create_mutable_binding(vm, id.string(), false));
  654. Value initial_value;
  655. // 3. If parameterBindings does not contain n, or if functionNames contains n, then
  656. if (!variable_to_initialize.parameter_binding || variable_to_initialize.function_name) {
  657. // a. Let initialValue be undefined.
  658. initial_value = js_undefined();
  659. }
  660. // 4. Else,
  661. else {
  662. // a. Let initialValue be ! env.GetBindingValue(n, false).
  663. if (id.is_local()) {
  664. initial_value = callee_context.local_variables[id.local_variable_index()];
  665. } else {
  666. initial_value = MUST(environment->get_binding_value(vm, id.string(), false));
  667. }
  668. }
  669. // 5. Perform ! varEnv.InitializeBinding(n, initialValue).
  670. if (id.is_local()) {
  671. // NOTE: Local variables are supported only in bytecode interpreter
  672. callee_context.local_variables[id.local_variable_index()] = initial_value;
  673. } else {
  674. MUST(var_environment->initialize_binding(vm, id.string(), initial_value, Environment::InitializeBindingHint::Normal));
  675. }
  676. // 6. NOTE: A var with the same name as a formal parameter initially has the same value as the corresponding initialized parameter.
  677. }
  678. }
  679. }
  680. // 29. NOTE: Annex B.3.2.1 adds additional steps at this point.
  681. // B.3.2.1 Changes to FunctionDeclarationInstantiation, https://tc39.es/ecma262/#sec-web-compat-functiondeclarationinstantiation
  682. if (!m_strict && scope_body) {
  683. // NOTE: Due to the use of MUST with `create_mutable_binding` and `initialize_binding` below,
  684. // an exception should not result from `for_each_function_hoistable_with_annexB_extension`.
  685. for (auto const& function_name : m_function_names_to_initialize_binding) {
  686. MUST(var_environment->create_mutable_binding(vm, function_name, false));
  687. MUST(var_environment->initialize_binding(vm, function_name, js_undefined(), Environment::InitializeBindingHint::Normal));
  688. }
  689. }
  690. GCPtr<Environment> lex_environment;
  691. // 30. If strict is false, then
  692. if (!m_strict) {
  693. // Optimization: We avoid creating empty top-level declarative environments in non-strict mode, if both of these conditions are true:
  694. // 1. there is no direct call to eval() within this function
  695. // 2. there are no lexical declarations that would go into the environment
  696. bool can_elide_declarative_environment = !m_contains_direct_call_to_eval && (!scope_body || !scope_body->has_lexical_declarations());
  697. if (can_elide_declarative_environment) {
  698. lex_environment = var_environment;
  699. } else {
  700. // a. Let lexEnv be NewDeclarativeEnvironment(varEnv).
  701. // b. NOTE: Non-strict functions use a separate Environment Record for top-level lexical declarations so that a direct eval
  702. // can determine whether any var scoped declarations introduced by the eval code conflict with pre-existing top-level
  703. // lexically scoped declarations. This is not needed for strict functions because a strict direct eval always places
  704. // all declarations into a new Environment Record.
  705. lex_environment = new_declarative_environment(*var_environment);
  706. static_cast<DeclarativeEnvironment*>(lex_environment.ptr())->ensure_capacity(m_lex_environment_bindings_count);
  707. }
  708. }
  709. // 31. Else,
  710. else {
  711. // a. let lexEnv be varEnv.
  712. lex_environment = var_environment;
  713. }
  714. // 32. Set the LexicalEnvironment of calleeContext to lexEnv.
  715. callee_context.lexical_environment = lex_environment;
  716. if (!scope_body)
  717. return {};
  718. // 33. Let lexDeclarations be the LexicallyScopedDeclarations of code.
  719. // 34. For each element d of lexDeclarations, do
  720. // NOTE: Due to the use of MUST in the callback, an exception should not result from `for_each_lexically_scoped_declaration`.
  721. MUST(scope_body->for_each_lexically_scoped_declaration([&](Declaration const& declaration) {
  722. // NOTE: Due to the use of MUST with `create_immutable_binding` and `create_mutable_binding` below,
  723. // an exception should not result from `for_each_bound_name`.
  724. // 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.
  725. // b. For each element dn of the BoundNames of d, do
  726. MUST(declaration.for_each_bound_identifier([&](auto const& id) {
  727. if (id.is_local()) {
  728. // NOTE: Local variables are supported only in bytecode interpreter
  729. return;
  730. }
  731. // i. If IsConstantDeclaration of d is true, then
  732. if (declaration.is_constant_declaration()) {
  733. // 1. Perform ! lexEnv.CreateImmutableBinding(dn, true).
  734. MUST(lex_environment->create_immutable_binding(vm, id.string(), true));
  735. }
  736. // ii. Else,
  737. else {
  738. // 1. Perform ! lexEnv.CreateMutableBinding(dn, false).
  739. MUST(lex_environment->create_mutable_binding(vm, id.string(), false));
  740. }
  741. }));
  742. }));
  743. // 35. Let privateEnv be the PrivateEnvironment of calleeContext.
  744. auto private_environment = callee_context.private_environment;
  745. // 36. For each Parse Node f of functionsToInitialize, do
  746. for (auto& declaration : m_functions_to_initialize) {
  747. // a. Let fn be the sole element of the BoundNames of f.
  748. // b. Let fo be InstantiateFunctionObject of f with arguments lexEnv and privateEnv.
  749. 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());
  750. // c. Perform ! varEnv.SetMutableBinding(fn, fo, false).
  751. if (declaration.name_identifier()->is_local()) {
  752. callee_context.local_variables[declaration.name_identifier()->local_variable_index()] = function;
  753. } else {
  754. MUST(var_environment->set_mutable_binding(vm, declaration.name(), function, false));
  755. }
  756. }
  757. if (is<DeclarativeEnvironment>(*lex_environment))
  758. static_cast<DeclarativeEnvironment*>(lex_environment.ptr())->shrink_to_fit();
  759. if (is<DeclarativeEnvironment>(*var_environment))
  760. static_cast<DeclarativeEnvironment*>(var_environment.ptr())->shrink_to_fit();
  761. // 37. Return unused.
  762. return {};
  763. }
  764. // 10.2.1.1 PrepareForOrdinaryCall ( F, newTarget ), https://tc39.es/ecma262/#sec-prepareforordinarycall
  765. ThrowCompletionOr<void> ECMAScriptFunctionObject::prepare_for_ordinary_call(ExecutionContext& callee_context, Object* new_target)
  766. {
  767. auto& vm = this->vm();
  768. // Non-standard
  769. callee_context.is_strict_mode = m_strict;
  770. // 1. Let callerContext be the running execution context.
  771. // 2. Let calleeContext be a new ECMAScript code execution context.
  772. // NOTE: In the specification, PrepareForOrdinaryCall "returns" a new callee execution context.
  773. // To avoid heap allocations, we put our ExecutionContext objects on the C++ stack instead.
  774. // Whoever calls us should put an ExecutionContext on their stack and pass that as the `callee_context`.
  775. // 3. Set the Function of calleeContext to F.
  776. callee_context.function = this;
  777. callee_context.function_name = m_name;
  778. // 4. Let calleeRealm be F.[[Realm]].
  779. auto callee_realm = m_realm;
  780. // NOTE: This non-standard fallback is needed until we can guarantee that literally
  781. // every function has a realm - especially in LibWeb that's sometimes not the case
  782. // when a function is created while no JS is running, as we currently need to rely on
  783. // that (:acid2:, I know - see set_event_handler_attribute() for an example).
  784. // If there's no 'current realm' either, we can't continue and crash.
  785. if (!callee_realm)
  786. callee_realm = vm.current_realm();
  787. VERIFY(callee_realm);
  788. // 5. Set the Realm of calleeContext to calleeRealm.
  789. callee_context.realm = callee_realm;
  790. // 6. Set the ScriptOrModule of calleeContext to F.[[ScriptOrModule]].
  791. callee_context.script_or_module = m_script_or_module;
  792. // 7. Let localEnv be NewFunctionEnvironment(F, newTarget).
  793. auto local_environment = new_function_environment(*this, new_target);
  794. local_environment->ensure_capacity(m_function_environment_bindings_count);
  795. // 8. Set the LexicalEnvironment of calleeContext to localEnv.
  796. callee_context.lexical_environment = local_environment;
  797. // 9. Set the VariableEnvironment of calleeContext to localEnv.
  798. callee_context.variable_environment = local_environment;
  799. // 10. Set the PrivateEnvironment of calleeContext to F.[[PrivateEnvironment]].
  800. callee_context.private_environment = m_private_environment;
  801. // 11. If callerContext is not already suspended, suspend callerContext.
  802. // FIXME: We don't have this concept yet.
  803. // 12. Push calleeContext onto the execution context stack; calleeContext is now the running execution context.
  804. TRY(vm.push_execution_context(callee_context, {}));
  805. // 13. NOTE: Any exception objects produced after this point are associated with calleeRealm.
  806. // 14. Return calleeContext.
  807. // NOTE: See the comment after step 2 above about how contexts are allocated on the C++ stack.
  808. return {};
  809. }
  810. // 10.2.1.2 OrdinaryCallBindThis ( F, calleeContext, thisArgument ), https://tc39.es/ecma262/#sec-ordinarycallbindthis
  811. void ECMAScriptFunctionObject::ordinary_call_bind_this(ExecutionContext& callee_context, Value this_argument)
  812. {
  813. auto& vm = this->vm();
  814. // 1. Let thisMode be F.[[ThisMode]].
  815. auto this_mode = m_this_mode;
  816. // If thisMode is lexical, return unused.
  817. if (this_mode == ThisMode::Lexical)
  818. return;
  819. // 3. Let calleeRealm be F.[[Realm]].
  820. auto callee_realm = m_realm;
  821. // NOTE: This non-standard fallback is needed until we can guarantee that literally
  822. // every function has a realm - especially in LibWeb that's sometimes not the case
  823. // when a function is created while no JS is running, as we currently need to rely on
  824. // that (:acid2:, I know - see set_event_handler_attribute() for an example).
  825. // If there's no 'current realm' either, we can't continue and crash.
  826. if (!callee_realm)
  827. callee_realm = vm.current_realm();
  828. VERIFY(callee_realm);
  829. // 4. Let localEnv be the LexicalEnvironment of calleeContext.
  830. auto local_env = callee_context.lexical_environment;
  831. Value this_value;
  832. // 5. If thisMode is strict, let thisValue be thisArgument.
  833. if (this_mode == ThisMode::Strict) {
  834. this_value = this_argument;
  835. }
  836. // 6. Else,
  837. else {
  838. // a. If thisArgument is undefined or null, then
  839. if (this_argument.is_nullish()) {
  840. // i. Let globalEnv be calleeRealm.[[GlobalEnv]].
  841. // ii. Assert: globalEnv is a global Environment Record.
  842. auto& global_env = callee_realm->global_environment();
  843. // iii. Let thisValue be globalEnv.[[GlobalThisValue]].
  844. this_value = &global_env.global_this_value();
  845. }
  846. // b. Else,
  847. else {
  848. // i. Let thisValue be ! ToObject(thisArgument).
  849. this_value = MUST(this_argument.to_object(vm));
  850. // ii. NOTE: ToObject produces wrapper objects using calleeRealm.
  851. VERIFY(vm.current_realm() == callee_realm);
  852. }
  853. }
  854. // 7. Assert: localEnv is a function Environment Record.
  855. // 8. Assert: The next step never returns an abrupt completion because localEnv.[[ThisBindingStatus]] is not initialized.
  856. // 9. Perform ! localEnv.BindThisValue(thisValue).
  857. MUST(verify_cast<FunctionEnvironment>(*local_env).bind_this_value(vm, this_value));
  858. // 10. Return unused.
  859. }
  860. // 27.7.5.1 AsyncFunctionStart ( promiseCapability, asyncFunctionBody ), https://tc39.es/ecma262/#sec-async-functions-abstract-operations-async-function-start
  861. template<typename T>
  862. void async_function_start(VM& vm, PromiseCapability const& promise_capability, T const& async_function_body)
  863. {
  864. // 1. Let runningContext be the running execution context.
  865. auto& running_context = vm.running_execution_context();
  866. // 2. Let asyncContext be a copy of runningContext.
  867. auto async_context = running_context.copy();
  868. // 3. NOTE: Copying the execution state is required for AsyncBlockStart to resume its execution. It is ill-defined to resume a currently executing context.
  869. // 4. Perform AsyncBlockStart(promiseCapability, asyncFunctionBody, asyncContext).
  870. async_block_start(vm, async_function_body, promise_capability, async_context);
  871. // 5. Return unused.
  872. }
  873. // 27.7.5.2 AsyncBlockStart ( promiseCapability, asyncBody, asyncContext ), https://tc39.es/ecma262/#sec-asyncblockstart
  874. // 12.7.1.1 AsyncBlockStart ( promiseCapability, asyncBody, asyncContext ), https://tc39.es/proposal-explicit-resource-management/#sec-asyncblockstart
  875. // 1.2.1.1 AsyncBlockStart ( promiseCapability, asyncBody, asyncContext ), https://tc39.es/proposal-array-from-async/#sec-asyncblockstart
  876. template<typename T>
  877. void async_block_start(VM& vm, T const& async_body, PromiseCapability const& promise_capability, ExecutionContext& async_context)
  878. {
  879. // NOTE: This function is a combination between two proposals, so does not exactly match spec steps of either.
  880. auto& realm = *vm.current_realm();
  881. // 1. Assert: promiseCapability is a PromiseCapability Record.
  882. // 2. Let runningContext be the running execution context.
  883. auto& running_context = vm.running_execution_context();
  884. // 3. Set the code evaluation state of asyncContext such that when evaluation is resumed for that execution context the following steps will be performed:
  885. auto execution_steps = NativeFunction::create(realm, "", [&async_body, &promise_capability, &async_context](auto& vm) -> ThrowCompletionOr<Value> {
  886. Completion result;
  887. // a. If asyncBody is a Parse Node, then
  888. if constexpr (!IsCallableWithArguments<T, Completion>) {
  889. // a. Let result be the result of evaluating asyncBody.
  890. // FIXME: Cache this executable somewhere.
  891. auto maybe_executable = Bytecode::compile(vm, async_body, FunctionKind::Async, "AsyncBlockStart"sv);
  892. if (maybe_executable.is_error())
  893. result = maybe_executable.release_error();
  894. else
  895. result = vm.bytecode_interpreter().run_and_return_frame(*maybe_executable.value(), nullptr).value;
  896. }
  897. // b. Else,
  898. else {
  899. // i. Assert: asyncBody is an Abstract Closure with no parameters.
  900. static_assert(IsCallableWithArguments<T, Completion>);
  901. // ii. Let result be asyncBody().
  902. result = async_body();
  903. }
  904. // c. Assert: If we return here, the async function either threw an exception or performed an implicit or explicit return; all awaiting is done.
  905. // 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.
  906. vm.pop_execution_context();
  907. // NOTE: This does not work for Array.fromAsync, likely due to conflicts between that proposal and Explicit Resource Management proposal.
  908. if constexpr (!IsCallableWithArguments<T, Completion>) {
  909. // e. Let env be asyncContext's LexicalEnvironment.
  910. auto env = async_context.lexical_environment;
  911. // f. Set result to DisposeResources(env, result).
  912. result = dispose_resources(vm, verify_cast<DeclarativeEnvironment>(env.ptr()), result);
  913. } else {
  914. (void)async_context;
  915. }
  916. // g. If result.[[Type]] is normal, then
  917. if (result.type() == Completion::Type::Normal) {
  918. // i. Perform ! Call(promiseCapability.[[Resolve]], undefined, « undefined »).
  919. MUST(call(vm, *promise_capability.resolve(), js_undefined(), js_undefined()));
  920. }
  921. // h. Else if result.[[Type]] is return, then
  922. else if (result.type() == Completion::Type::Return) {
  923. // i. Perform ! Call(promiseCapability.[[Resolve]], undefined, « result.[[Value]] »).
  924. MUST(call(vm, *promise_capability.resolve(), js_undefined(), *result.value()));
  925. }
  926. // i. Else,
  927. else {
  928. // i. Assert: result.[[Type]] is throw.
  929. VERIFY(result.type() == Completion::Type::Throw);
  930. // ii. Perform ! Call(promiseCapability.[[Reject]], undefined, « result.[[Value]] »).
  931. MUST(call(vm, *promise_capability.reject(), js_undefined(), *result.value()));
  932. }
  933. // j. Return unused.
  934. // NOTE: We don't support returning an empty/optional/unused value here.
  935. return js_undefined();
  936. });
  937. // 4. Push asyncContext onto the execution context stack; asyncContext is now the running execution context.
  938. auto push_result = vm.push_execution_context(async_context, {});
  939. if (push_result.is_error())
  940. return;
  941. // 5. Resume the suspended evaluation of asyncContext. Let result be the value returned by the resumed computation.
  942. auto result = call(vm, *execution_steps, async_context.this_value.is_empty() ? js_undefined() : async_context.this_value);
  943. // 6. Assert: When we return here, asyncContext has already been removed from the execution context stack and runningContext is the currently running execution context.
  944. VERIFY(&vm.running_execution_context() == &running_context);
  945. // 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.
  946. VERIFY(result.has_value() && result.value().is_undefined());
  947. // 8. Return unused.
  948. }
  949. template void async_block_start(VM&, NonnullRefPtr<Statement const> const& async_body, PromiseCapability const&, ExecutionContext&);
  950. template void async_function_start(VM&, PromiseCapability const&, NonnullRefPtr<Statement const> const& async_function_body);
  951. template void async_block_start(VM&, SafeFunction<Completion()> const& async_body, PromiseCapability const&, ExecutionContext&);
  952. template void async_function_start(VM&, PromiseCapability const&, SafeFunction<Completion()> const& async_function_body);
  953. // 10.2.1.4 OrdinaryCallEvaluateBody ( F, argumentsList ), https://tc39.es/ecma262/#sec-ordinarycallevaluatebody
  954. // 15.8.4 Runtime Semantics: EvaluateAsyncFunctionBody, https://tc39.es/ecma262/#sec-runtime-semantics-evaluatefunctionbody
  955. Completion ECMAScriptFunctionObject::ordinary_call_evaluate_body()
  956. {
  957. auto& vm = this->vm();
  958. auto& realm = *vm.current_realm();
  959. // NOTE: There's a subtle ordering issue here:
  960. // - We have to compile the default parameter values before instantiating the function.
  961. // - We have to instantiate the function before compiling the function body.
  962. // This is why FunctionDeclarationInstantiation is invoked in the middle.
  963. // The issue is that FunctionDeclarationInstantiation may mark certain functions as hoisted
  964. // per Annex B. This affects code generation for FunctionDeclaration nodes.
  965. if (!m_bytecode_executable) {
  966. size_t default_parameter_index = 0;
  967. for (auto& parameter : m_formal_parameters) {
  968. if (!parameter.default_value)
  969. continue;
  970. if (parameter.bytecode_executable.is_null()) {
  971. auto executable = TRY(Bytecode::compile(vm, *parameter.default_value, FunctionKind::Normal, DeprecatedString::formatted("default parameter #{} for {}", default_parameter_index++, m_name)));
  972. const_cast<FunctionParameter&>(parameter).bytecode_executable = executable;
  973. m_default_parameter_bytecode_executables.append(move(executable));
  974. } else {
  975. m_default_parameter_bytecode_executables.append(*parameter.bytecode_executable);
  976. }
  977. }
  978. }
  979. auto declaration_result = function_declaration_instantiation();
  980. if (m_kind == FunctionKind::Normal || m_kind == FunctionKind::Generator || m_kind == FunctionKind::AsyncGenerator) {
  981. if (declaration_result.is_error())
  982. return declaration_result.release_error();
  983. }
  984. if (!m_bytecode_executable) {
  985. if (!m_ecmascript_code->bytecode_executable())
  986. const_cast<Statement&>(*m_ecmascript_code).set_bytecode_executable(TRY(Bytecode::compile(vm, *m_ecmascript_code, m_kind, m_name)));
  987. m_bytecode_executable = m_ecmascript_code->bytecode_executable();
  988. }
  989. if (m_kind == FunctionKind::Async) {
  990. if (declaration_result.is_throw_completion()) {
  991. auto promise_capability = MUST(new_promise_capability(vm, realm.intrinsics().promise_constructor()));
  992. MUST(call(vm, *promise_capability->reject(), js_undefined(), *declaration_result.throw_completion().value()));
  993. return Completion { Completion::Type::Return, promise_capability->promise(), {} };
  994. }
  995. }
  996. auto result_and_frame = vm.bytecode_interpreter().run_and_return_frame(*m_bytecode_executable, nullptr);
  997. VERIFY(result_and_frame.frame != nullptr);
  998. if (result_and_frame.value.is_error())
  999. return result_and_frame.value.release_error();
  1000. auto result = result_and_frame.value.release_value();
  1001. // NOTE: Running the bytecode should eventually return a completion.
  1002. // Until it does, we assume "return" and include the undefined fallback from the call site.
  1003. if (m_kind == FunctionKind::Normal)
  1004. return { Completion::Type::Return, result.value_or(js_undefined()), {} };
  1005. if (m_kind == FunctionKind::AsyncGenerator) {
  1006. auto async_generator_object = TRY(AsyncGenerator::create(realm, result, this, vm.running_execution_context().copy(), move(*result_and_frame.frame)));
  1007. return { Completion::Type::Return, async_generator_object, {} };
  1008. }
  1009. auto generator_object = TRY(GeneratorObject::create(realm, result, this, vm.running_execution_context().copy(), move(*result_and_frame.frame)));
  1010. // NOTE: Async functions are entirely transformed to generator functions, and wrapped in a custom driver that returns a promise
  1011. // See AwaitExpression::generate_bytecode() for the transformation.
  1012. if (m_kind == FunctionKind::Async)
  1013. return { Completion::Type::Return, AsyncFunctionDriverWrapper::create(realm, generator_object), {} };
  1014. VERIFY(m_kind == FunctionKind::Generator);
  1015. return { Completion::Type::Return, generator_object, {} };
  1016. }
  1017. void ECMAScriptFunctionObject::set_name(DeprecatedFlyString const& name)
  1018. {
  1019. VERIFY(!name.is_null());
  1020. auto& vm = this->vm();
  1021. m_name = name;
  1022. MUST(define_property_or_throw(vm.names.name, { .value = PrimitiveString::create(vm, m_name), .writable = false, .enumerable = false, .configurable = true }));
  1023. }
  1024. }