ECMAScriptFunctionObject.cpp 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864
  1. /*
  2. * Copyright (c) 2020, Stephan Unverwerth <s.unverwerth@serenityos.org>
  3. * Copyright (c) 2020-2022, Linus Groh <linusg@serenityos.org>
  4. *
  5. * SPDX-License-Identifier: BSD-2-Clause
  6. */
  7. #include <AK/Debug.h>
  8. #include <AK/Function.h>
  9. #include <LibJS/AST.h>
  10. #include <LibJS/Bytecode/BasicBlock.h>
  11. #include <LibJS/Bytecode/Generator.h>
  12. #include <LibJS/Bytecode/Interpreter.h>
  13. #include <LibJS/Interpreter.h>
  14. #include <LibJS/Runtime/AbstractOperations.h>
  15. #include <LibJS/Runtime/Array.h>
  16. #include <LibJS/Runtime/AsyncFunctionDriverWrapper.h>
  17. #include <LibJS/Runtime/ECMAScriptFunctionObject.h>
  18. #include <LibJS/Runtime/Error.h>
  19. #include <LibJS/Runtime/ExecutionContext.h>
  20. #include <LibJS/Runtime/FunctionEnvironment.h>
  21. #include <LibJS/Runtime/GeneratorObject.h>
  22. #include <LibJS/Runtime/GeneratorPrototype.h>
  23. #include <LibJS/Runtime/GlobalObject.h>
  24. #include <LibJS/Runtime/NativeFunction.h>
  25. #include <LibJS/Runtime/PromiseConstructor.h>
  26. #include <LibJS/Runtime/PromiseReaction.h>
  27. #include <LibJS/Runtime/Value.h>
  28. namespace JS {
  29. ECMAScriptFunctionObject* ECMAScriptFunctionObject::create(GlobalObject& global_object, FlyString name, String source_text, Statement const& ecmascript_code, Vector<FunctionNode::Parameter> parameters, i32 m_function_length, Environment* parent_scope, PrivateEnvironment* private_scope, FunctionKind kind, bool is_strict, bool might_need_arguments_object, bool contains_direct_call_to_eval, bool is_arrow_function)
  30. {
  31. Object* prototype = nullptr;
  32. switch (kind) {
  33. case FunctionKind::Normal:
  34. prototype = global_object.function_prototype();
  35. break;
  36. case FunctionKind::Generator:
  37. prototype = global_object.generator_function_prototype();
  38. break;
  39. case FunctionKind::Async:
  40. prototype = global_object.async_function_prototype();
  41. break;
  42. case FunctionKind::AsyncGenerator:
  43. prototype = global_object.async_generator_function_prototype();
  44. break;
  45. }
  46. return global_object.heap().allocate<ECMAScriptFunctionObject>(global_object, move(name), move(source_text), ecmascript_code, move(parameters), m_function_length, parent_scope, private_scope, *prototype, kind, is_strict, might_need_arguments_object, contains_direct_call_to_eval, is_arrow_function);
  47. }
  48. ECMAScriptFunctionObject* ECMAScriptFunctionObject::create(GlobalObject& global_object, FlyString name, Object& prototype, String source_text, Statement const& ecmascript_code, Vector<FunctionNode::Parameter> parameters, i32 m_function_length, Environment* parent_scope, PrivateEnvironment* private_scope, FunctionKind kind, bool is_strict, bool might_need_arguments_object, bool contains_direct_call_to_eval, bool is_arrow_function)
  49. {
  50. return global_object.heap().allocate<ECMAScriptFunctionObject>(global_object, move(name), move(source_text), ecmascript_code, move(parameters), m_function_length, parent_scope, private_scope, prototype, kind, is_strict, might_need_arguments_object, contains_direct_call_to_eval, is_arrow_function);
  51. }
  52. ECMAScriptFunctionObject::ECMAScriptFunctionObject(FlyString name, String source_text, Statement const& ecmascript_code, Vector<FunctionNode::Parameter> formal_parameters, i32 function_length, Environment* parent_scope, PrivateEnvironment* private_scope, Object& prototype, FunctionKind kind, bool strict, bool might_need_arguments_object, bool contains_direct_call_to_eval, bool is_arrow_function)
  53. : FunctionObject(prototype)
  54. , m_name(move(name))
  55. , m_function_length(function_length)
  56. , m_environment(parent_scope)
  57. , m_private_environment(private_scope)
  58. , m_formal_parameters(move(formal_parameters))
  59. , m_ecmascript_code(ecmascript_code)
  60. , m_realm(global_object().associated_realm())
  61. , m_source_text(move(source_text))
  62. , m_strict(strict)
  63. , m_might_need_arguments_object(might_need_arguments_object)
  64. , m_contains_direct_call_to_eval(contains_direct_call_to_eval)
  65. , m_is_arrow_function(is_arrow_function)
  66. , m_kind(kind)
  67. {
  68. // NOTE: This logic is from OrdinaryFunctionCreate, https://tc39.es/ecma262/#sec-ordinaryfunctioncreate
  69. // 9. If thisMode is lexical-this, set F.[[ThisMode]] to lexical.
  70. if (m_is_arrow_function)
  71. m_this_mode = ThisMode::Lexical;
  72. // 10. Else if Strict is true, set F.[[ThisMode]] to strict.
  73. else if (m_strict)
  74. m_this_mode = ThisMode::Strict;
  75. else
  76. // 11. Else, set F.[[ThisMode]] to global.
  77. m_this_mode = ThisMode::Global;
  78. // 15. Set F.[[ScriptOrModule]] to GetActiveScriptOrModule().
  79. m_script_or_module = vm().get_active_script_or_module();
  80. // 15.1.3 Static Semantics: IsSimpleParameterList, https://tc39.es/ecma262/#sec-static-semantics-issimpleparameterlist
  81. m_has_simple_parameter_list = all_of(m_formal_parameters, [&](auto& parameter) {
  82. if (parameter.is_rest)
  83. return false;
  84. if (parameter.default_value)
  85. return false;
  86. if (!parameter.binding.template has<FlyString>())
  87. return false;
  88. return true;
  89. });
  90. }
  91. void ECMAScriptFunctionObject::initialize(GlobalObject& global_object)
  92. {
  93. auto& vm = this->vm();
  94. Base::initialize(global_object);
  95. // Note: The ordering of these properties must be: length, name, prototype which is the order
  96. // they are defined in the spec: https://tc39.es/ecma262/#sec-function-instances .
  97. // This is observable through something like: https://tc39.es/ecma262/#sec-ordinaryownpropertykeys
  98. // which must give the properties in chronological order which in this case is the order they
  99. // are defined in the spec.
  100. MUST(define_property_or_throw(vm.names.length, { .value = Value(m_function_length), .writable = false, .enumerable = false, .configurable = true }));
  101. MUST(define_property_or_throw(vm.names.name, { .value = js_string(vm, m_name.is_null() ? "" : m_name), .writable = false, .enumerable = false, .configurable = true }));
  102. if (!m_is_arrow_function) {
  103. Object* prototype = nullptr;
  104. switch (m_kind) {
  105. case FunctionKind::Normal:
  106. prototype = vm.heap().allocate<Object>(global_object, *global_object.new_ordinary_function_prototype_object_shape());
  107. MUST(prototype->define_property_or_throw(vm.names.constructor, { .value = this, .writable = true, .enumerable = false, .configurable = true }));
  108. break;
  109. case FunctionKind::Generator:
  110. // prototype is "g1.prototype" in figure-2 (https://tc39.es/ecma262/img/figure-2.png)
  111. prototype = global_object.generator_prototype();
  112. break;
  113. case FunctionKind::Async:
  114. break;
  115. case FunctionKind::AsyncGenerator:
  116. // FIXME: Add the AsyncGeneratorObject and set it as prototype.
  117. break;
  118. }
  119. define_direct_property(vm.names.prototype, prototype, Attribute::Writable);
  120. }
  121. }
  122. ECMAScriptFunctionObject::~ECMAScriptFunctionObject()
  123. {
  124. }
  125. // 10.2.1 [[Call]] ( thisArgument, argumentsList ), https://tc39.es/ecma262/#sec-ecmascript-function-objects-call-thisargument-argumentslist
  126. ThrowCompletionOr<Value> ECMAScriptFunctionObject::internal_call(Value this_argument, MarkedVector<Value> arguments_list)
  127. {
  128. auto& vm = this->vm();
  129. // 1. Let callerContext be the running execution context.
  130. // NOTE: No-op, kept by the VM in its execution context stack.
  131. ExecutionContext callee_context(heap());
  132. // Non-standard
  133. callee_context.arguments.extend(move(arguments_list));
  134. if (auto* interpreter = vm.interpreter_if_exists())
  135. callee_context.current_node = interpreter->current_node();
  136. // 2. Let calleeContext be PrepareForOrdinaryCall(F, undefined).
  137. // NOTE: We throw if the end of the native stack is reached, so unlike in the spec this _does_ need an exception check.
  138. TRY(prepare_for_ordinary_call(callee_context, nullptr));
  139. // 3. Assert: calleeContext is now the running execution context.
  140. VERIFY(&vm.running_execution_context() == &callee_context);
  141. // 4. If F.[[IsClassConstructor]] is true, then
  142. if (m_is_class_constructor) {
  143. // a. Let error be a newly created TypeError object.
  144. // b. NOTE: error is created in calleeContext with F's associated Realm Record.
  145. auto throw_completion = vm.throw_completion<TypeError>(global_object(), ErrorType::ClassConstructorWithoutNew, m_name);
  146. // c. Remove calleeContext from the execution context stack and restore callerContext as the running execution context.
  147. vm.pop_execution_context();
  148. // d. Return ThrowCompletion(error).
  149. return throw_completion;
  150. }
  151. // 5. Perform OrdinaryCallBindThis(F, calleeContext, thisArgument).
  152. ordinary_call_bind_this(callee_context, this_argument);
  153. // 6. Let result be OrdinaryCallEvaluateBody(F, argumentsList).
  154. auto result = ordinary_call_evaluate_body();
  155. // 7. Remove calleeContext from the execution context stack and restore callerContext as the running execution context.
  156. vm.pop_execution_context();
  157. // 8. If result.[[Type]] is return, return NormalCompletion(result.[[Value]]).
  158. if (result.type() == Completion::Type::Return)
  159. return result.value();
  160. // 9. ReturnIfAbrupt(result).
  161. if (result.is_abrupt()) {
  162. VERIFY(result.is_error());
  163. return result;
  164. }
  165. // 10. Return NormalCompletion(undefined).
  166. return js_undefined();
  167. }
  168. // 10.2.2 [[Construct]] ( argumentsList, newTarget ), https://tc39.es/ecma262/#sec-ecmascript-function-objects-construct-argumentslist-newtarget
  169. ThrowCompletionOr<Object*> ECMAScriptFunctionObject::internal_construct(MarkedVector<Value> arguments_list, FunctionObject& new_target)
  170. {
  171. auto& vm = this->vm();
  172. auto& global_object = this->global_object();
  173. // 1. Let callerContext be the running execution context.
  174. // NOTE: No-op, kept by the VM in its execution context stack.
  175. // 2. Let kind be F.[[ConstructorKind]].
  176. auto kind = m_constructor_kind;
  177. Object* this_argument = nullptr;
  178. // 3. If kind is base, then
  179. if (kind == ConstructorKind::Base) {
  180. // a. Let thisArgument be ? OrdinaryCreateFromConstructor(newTarget, "%Object.prototype%").
  181. this_argument = TRY(ordinary_create_from_constructor<Object>(global_object, new_target, &GlobalObject::object_prototype));
  182. }
  183. ExecutionContext callee_context(heap());
  184. // Non-standard
  185. callee_context.arguments.extend(move(arguments_list));
  186. if (auto* interpreter = vm.interpreter_if_exists())
  187. callee_context.current_node = interpreter->current_node();
  188. // 4. Let calleeContext be PrepareForOrdinaryCall(F, newTarget).
  189. // NOTE: We throw if the end of the native stack is reached, so unlike in the spec this _does_ need an exception check.
  190. TRY(prepare_for_ordinary_call(callee_context, &new_target));
  191. // 5. Assert: calleeContext is now the running execution context.
  192. VERIFY(&vm.running_execution_context() == &callee_context);
  193. // 6. If kind is base, then
  194. if (kind == ConstructorKind::Base) {
  195. // a. Perform OrdinaryCallBindThis(F, calleeContext, thisArgument).
  196. ordinary_call_bind_this(callee_context, this_argument);
  197. // b. Let initializeResult be InitializeInstanceElements(thisArgument, F).
  198. auto initialize_result = vm.initialize_instance_elements(*this_argument, *this);
  199. // c. If initializeResult is an abrupt completion, then
  200. if (initialize_result.is_throw_completion()) {
  201. // i. Remove calleeContext from the execution context stack and restore callerContext as the running execution context.
  202. vm.pop_execution_context();
  203. // ii. Return Completion(initializeResult).
  204. return initialize_result.throw_completion();
  205. }
  206. }
  207. // 7. Let constructorEnv be the LexicalEnvironment of calleeContext.
  208. auto* constructor_env = callee_context.lexical_environment;
  209. // 8. Let result be OrdinaryCallEvaluateBody(F, argumentsList).
  210. auto result = ordinary_call_evaluate_body();
  211. // 9. Remove calleeContext from the execution context stack and restore callerContext as the running execution context.
  212. vm.pop_execution_context();
  213. // 10. If result.[[Type]] is return, then
  214. if (result.type() == Completion::Type::Return) {
  215. // FIXME: This is leftover from untangling the call/construct mess - doesn't belong here in any way, but removing it breaks derived classes.
  216. // Likely fixed by making ClassDefinitionEvaluation fully spec compliant.
  217. if (kind == ConstructorKind::Derived && result.value()->is_object()) {
  218. auto prototype = TRY(new_target.get(vm.names.prototype));
  219. if (prototype.is_object())
  220. TRY(result.value()->as_object().internal_set_prototype_of(&prototype.as_object()));
  221. }
  222. // EOF (End of FIXME)
  223. // a. If Type(result.[[Value]]) is Object, return NormalCompletion(result.[[Value]]).
  224. if (result.value()->is_object())
  225. return &result.value()->as_object();
  226. // b. If kind is base, return NormalCompletion(thisArgument).
  227. if (kind == ConstructorKind::Base)
  228. return this_argument;
  229. // c. If result.[[Value]] is not undefined, throw a TypeError exception.
  230. if (!result.value()->is_undefined())
  231. return vm.throw_completion<TypeError>(global_object, ErrorType::DerivedConstructorReturningInvalidValue);
  232. }
  233. // 11. Else, ReturnIfAbrupt(result).
  234. else if (result.is_abrupt()) {
  235. VERIFY(result.is_error());
  236. return result;
  237. }
  238. // 12. Return ? constructorEnv.GetThisBinding().
  239. auto this_binding = TRY(constructor_env->get_this_binding(global_object));
  240. return &this_binding.as_object();
  241. }
  242. void ECMAScriptFunctionObject::visit_edges(Visitor& visitor)
  243. {
  244. Base::visit_edges(visitor);
  245. visitor.visit(m_environment);
  246. visitor.visit(m_private_environment);
  247. visitor.visit(m_realm);
  248. visitor.visit(m_home_object);
  249. for (auto& field : m_fields) {
  250. if (auto* property_key_ptr = field.name.get_pointer<PropertyKey>(); property_key_ptr && property_key_ptr->is_symbol())
  251. visitor.visit(property_key_ptr->as_symbol());
  252. visitor.visit(field.initializer);
  253. }
  254. }
  255. // 10.2.7 MakeMethod ( F, homeObject ), https://tc39.es/ecma262/#sec-makemethod
  256. void ECMAScriptFunctionObject::make_method(Object& home_object)
  257. {
  258. // 1. Set F.[[HomeObject]] to homeObject.
  259. m_home_object = &home_object;
  260. // 2. Return NormalCompletion(undefined).
  261. }
  262. // 10.2.11 FunctionDeclarationInstantiation ( func, argumentsList ), https://tc39.es/ecma262/#sec-functiondeclarationinstantiation
  263. ThrowCompletionOr<void> ECMAScriptFunctionObject::function_declaration_instantiation(Interpreter* interpreter)
  264. {
  265. auto& vm = this->vm();
  266. auto& callee_context = vm.running_execution_context();
  267. // Needed to extract declarations and functions
  268. ScopeNode const* scope_body = nullptr;
  269. if (is<ScopeNode>(*m_ecmascript_code))
  270. scope_body = static_cast<ScopeNode const*>(m_ecmascript_code.ptr());
  271. bool has_parameter_expressions = false;
  272. // FIXME: Maybe compute has duplicates at parse time? (We need to anyway since it's an error in some cases)
  273. bool has_duplicates = false;
  274. HashTable<FlyString> parameter_names;
  275. for (auto& parameter : m_formal_parameters) {
  276. if (parameter.default_value)
  277. has_parameter_expressions = true;
  278. parameter.binding.visit(
  279. [&](FlyString const& name) {
  280. if (parameter_names.set(name) != AK::HashSetResult::InsertedNewEntry)
  281. has_duplicates = true;
  282. },
  283. [&](NonnullRefPtr<BindingPattern> const& pattern) {
  284. if (pattern->contains_expression())
  285. has_parameter_expressions = true;
  286. pattern->for_each_bound_name([&](auto& name) {
  287. if (parameter_names.set(name) != AK::HashSetResult::InsertedNewEntry)
  288. has_duplicates = true;
  289. });
  290. });
  291. }
  292. auto arguments_object_needed = m_might_need_arguments_object;
  293. if (this_mode() == ThisMode::Lexical)
  294. arguments_object_needed = false;
  295. if (parameter_names.contains(vm.names.arguments.as_string()))
  296. arguments_object_needed = false;
  297. HashTable<FlyString> function_names;
  298. Vector<FunctionDeclaration const&> functions_to_initialize;
  299. if (scope_body) {
  300. scope_body->for_each_var_function_declaration_in_reverse_order([&](FunctionDeclaration const& function) {
  301. if (function_names.set(function.name()) == AK::HashSetResult::InsertedNewEntry)
  302. functions_to_initialize.append(function);
  303. });
  304. auto const& arguments_name = vm.names.arguments.as_string();
  305. if (!has_parameter_expressions && function_names.contains(arguments_name))
  306. arguments_object_needed = false;
  307. if (!has_parameter_expressions && arguments_object_needed) {
  308. scope_body->for_each_lexically_declared_name([&](auto const& name) {
  309. if (name == arguments_name)
  310. arguments_object_needed = false;
  311. });
  312. }
  313. } else {
  314. arguments_object_needed = false;
  315. }
  316. Environment* environment;
  317. if (is_strict_mode() || !has_parameter_expressions) {
  318. environment = callee_context.lexical_environment;
  319. } else {
  320. environment = new_declarative_environment(*callee_context.lexical_environment);
  321. VERIFY(callee_context.variable_environment == callee_context.lexical_environment);
  322. callee_context.lexical_environment = environment;
  323. }
  324. for (auto const& parameter_name : parameter_names) {
  325. if (MUST(environment->has_binding(parameter_name)))
  326. continue;
  327. MUST(environment->create_mutable_binding(global_object(), parameter_name, false));
  328. if (has_duplicates)
  329. MUST(environment->initialize_binding(global_object(), parameter_name, js_undefined()));
  330. }
  331. if (arguments_object_needed) {
  332. Object* arguments_object;
  333. if (is_strict_mode() || !has_simple_parameter_list())
  334. arguments_object = create_unmapped_arguments_object(global_object(), vm.running_execution_context().arguments);
  335. else
  336. arguments_object = create_mapped_arguments_object(global_object(), *this, formal_parameters(), vm.running_execution_context().arguments, *environment);
  337. if (is_strict_mode())
  338. MUST(environment->create_immutable_binding(global_object(), vm.names.arguments.as_string(), false));
  339. else
  340. MUST(environment->create_mutable_binding(global_object(), vm.names.arguments.as_string(), false));
  341. MUST(environment->initialize_binding(global_object(), vm.names.arguments.as_string(), arguments_object));
  342. parameter_names.set(vm.names.arguments.as_string());
  343. }
  344. // We now treat parameterBindings as parameterNames.
  345. // The spec makes an iterator here to do IteratorBindingInitialization but we just do it manually
  346. auto& execution_context_arguments = vm.running_execution_context().arguments;
  347. for (size_t i = 0; i < m_formal_parameters.size(); ++i) {
  348. auto& parameter = m_formal_parameters[i];
  349. TRY(parameter.binding.visit(
  350. [&](auto const& param) -> ThrowCompletionOr<void> {
  351. Value argument_value;
  352. if (parameter.is_rest) {
  353. auto* array = MUST(Array::create(global_object(), 0));
  354. for (size_t rest_index = i; rest_index < execution_context_arguments.size(); ++rest_index)
  355. array->indexed_properties().append(execution_context_arguments[rest_index]);
  356. argument_value = array;
  357. } else if (i < execution_context_arguments.size() && !execution_context_arguments[i].is_undefined()) {
  358. argument_value = execution_context_arguments[i];
  359. } else if (parameter.default_value) {
  360. // FIXME: Support default arguments in the bytecode world!
  361. if (interpreter)
  362. argument_value = TRY(parameter.default_value->execute(*interpreter, global_object())).release_value();
  363. } else {
  364. argument_value = js_undefined();
  365. }
  366. Environment* used_environment = has_duplicates ? nullptr : environment;
  367. if constexpr (IsSame<FlyString const&, decltype(param)>) {
  368. Reference reference = TRY(vm.resolve_binding(param, used_environment));
  369. // Here the difference from hasDuplicates is important
  370. if (has_duplicates)
  371. return reference.put_value(global_object(), argument_value);
  372. else
  373. return reference.initialize_referenced_binding(global_object(), argument_value);
  374. } else if (IsSame<NonnullRefPtr<BindingPattern> const&, decltype(param)>) {
  375. // Here the difference from hasDuplicates is important
  376. return vm.binding_initialization(param, argument_value, used_environment, global_object());
  377. }
  378. }));
  379. }
  380. Environment* var_environment;
  381. HashTable<FlyString> instantiated_var_names;
  382. if (scope_body)
  383. instantiated_var_names.ensure_capacity(scope_body->var_declaration_count());
  384. if (!has_parameter_expressions) {
  385. if (scope_body) {
  386. scope_body->for_each_var_declared_name([&](auto const& name) {
  387. if (!parameter_names.contains(name) && instantiated_var_names.set(name) == AK::HashSetResult::InsertedNewEntry) {
  388. MUST(environment->create_mutable_binding(global_object(), name, false));
  389. MUST(environment->initialize_binding(global_object(), name, js_undefined()));
  390. }
  391. });
  392. }
  393. var_environment = environment;
  394. } else {
  395. var_environment = new_declarative_environment(*environment);
  396. callee_context.variable_environment = var_environment;
  397. if (scope_body) {
  398. scope_body->for_each_var_declared_name([&](auto const& name) {
  399. if (instantiated_var_names.set(name) != AK::HashSetResult::InsertedNewEntry)
  400. return;
  401. MUST(var_environment->create_mutable_binding(global_object(), name, false));
  402. Value initial_value;
  403. if (!parameter_names.contains(name) || function_names.contains(name))
  404. initial_value = js_undefined();
  405. else
  406. initial_value = MUST(environment->get_binding_value(global_object(), name, false));
  407. MUST(var_environment->initialize_binding(global_object(), name, initial_value));
  408. });
  409. }
  410. }
  411. // B.3.2.1 Changes to FunctionDeclarationInstantiation, https://tc39.es/ecma262/#sec-web-compat-functiondeclarationinstantiation
  412. if (!m_strict && scope_body) {
  413. scope_body->for_each_function_hoistable_with_annexB_extension([&](FunctionDeclaration& function_declaration) {
  414. auto& function_name = function_declaration.name();
  415. if (parameter_names.contains(function_name))
  416. return;
  417. // The spec says 'initializedBindings' here but that does not exist and it then adds it to 'instantiatedVarNames' so it probably means 'instantiatedVarNames'.
  418. if (!instantiated_var_names.contains(function_name) && function_name != vm.names.arguments.as_string()) {
  419. MUST(var_environment->create_mutable_binding(global_object(), function_name, false));
  420. MUST(var_environment->initialize_binding(global_object(), function_name, js_undefined()));
  421. instantiated_var_names.set(function_name);
  422. }
  423. function_declaration.set_should_do_additional_annexB_steps();
  424. });
  425. }
  426. Environment* lex_environment;
  427. // 30. If strict is false, then
  428. if (!is_strict_mode()) {
  429. // Optimization: We avoid creating empty top-level declarative environments in non-strict mode, if both of these conditions are true:
  430. // 1. there is no direct call to eval() within this function
  431. // 2. there are no lexical declarations that would go into the environment
  432. bool can_elide_declarative_environment = !m_contains_direct_call_to_eval && (!scope_body || !scope_body->has_lexical_declarations());
  433. if (can_elide_declarative_environment) {
  434. lex_environment = var_environment;
  435. } else {
  436. // a. Let lexEnv be NewDeclarativeEnvironment(varEnv).
  437. // b. NOTE: Non-strict functions use a separate Environment Record for top-level lexical declarations so that a direct eval
  438. // can determine whether any var scoped declarations introduced by the eval code conflict with pre-existing top-level
  439. // lexically scoped declarations. This is not needed for strict functions because a strict direct eval always places
  440. // all declarations into a new Environment Record.
  441. lex_environment = new_declarative_environment(*var_environment);
  442. }
  443. } else {
  444. // 31. Else, let lexEnv be varEnv.
  445. lex_environment = var_environment;
  446. }
  447. // 32. Set the LexicalEnvironment of calleeContext to lexEnv.
  448. callee_context.lexical_environment = lex_environment;
  449. if (!scope_body)
  450. return {};
  451. scope_body->for_each_lexically_scoped_declaration([&](Declaration const& declaration) {
  452. declaration.for_each_bound_name([&](auto const& name) {
  453. if (declaration.is_constant_declaration())
  454. MUST(lex_environment->create_immutable_binding(global_object(), name, true));
  455. else
  456. MUST(lex_environment->create_mutable_binding(global_object(), name, false));
  457. });
  458. });
  459. auto* private_environment = callee_context.private_environment;
  460. for (auto& declaration : functions_to_initialize) {
  461. auto* function = ECMAScriptFunctionObject::create(global_object(), declaration.name(), declaration.source_text(), declaration.body(), declaration.parameters(), declaration.function_length(), lex_environment, private_environment, declaration.kind(), declaration.is_strict_mode(), declaration.might_need_arguments_object(), declaration.contains_direct_call_to_eval());
  462. MUST(var_environment->set_mutable_binding(global_object(), declaration.name(), function, false));
  463. }
  464. return {};
  465. }
  466. // 10.2.1.1 PrepareForOrdinaryCall ( F, newTarget ), https://tc39.es/ecma262/#sec-prepareforordinarycall
  467. ThrowCompletionOr<void> ECMAScriptFunctionObject::prepare_for_ordinary_call(ExecutionContext& callee_context, Object* new_target)
  468. {
  469. auto& vm = this->vm();
  470. // Non-standard
  471. callee_context.is_strict_mode = m_strict;
  472. // 1. Let callerContext be the running execution context.
  473. // 2. Let calleeContext be a new ECMAScript code execution context.
  474. // NOTE: In the specification, PrepareForOrdinaryCall "returns" a new callee execution context.
  475. // To avoid heap allocations, we put our ExecutionContext objects on the C++ stack instead.
  476. // Whoever calls us should put an ExecutionContext on their stack and pass that as the `callee_context`.
  477. // 3. Set the Function of calleeContext to F.
  478. callee_context.function = this;
  479. callee_context.function_name = m_name;
  480. // 4. Let calleeRealm be F.[[Realm]].
  481. auto* callee_realm = m_realm;
  482. // NOTE: This non-standard fallback is needed until we can guarantee that literally
  483. // every function has a realm - especially in LibWeb that's sometimes not the case
  484. // when a function is created while no JS is running, as we currently need to rely on
  485. // that (:acid2:, I know - see set_event_handler_attribute() for an example).
  486. // If there's no 'current realm' either, we can't continue and crash.
  487. if (!callee_realm)
  488. callee_realm = vm.current_realm();
  489. VERIFY(callee_realm);
  490. // 5. Set the Realm of calleeContext to calleeRealm.
  491. callee_context.realm = callee_realm;
  492. // 6. Set the ScriptOrModule of calleeContext to F.[[ScriptOrModule]].
  493. callee_context.script_or_module = m_script_or_module;
  494. // 7. Let localEnv be NewFunctionEnvironment(F, newTarget).
  495. auto* local_environment = new_function_environment(*this, new_target);
  496. // 8. Set the LexicalEnvironment of calleeContext to localEnv.
  497. callee_context.lexical_environment = local_environment;
  498. // 9. Set the VariableEnvironment of calleeContext to localEnv.
  499. callee_context.variable_environment = local_environment;
  500. // 10. Set the PrivateEnvironment of calleeContext to F.[[PrivateEnvironment]].
  501. callee_context.private_environment = m_private_environment;
  502. // 11. If callerContext is not already suspended, suspend callerContext.
  503. // FIXME: We don't have this concept yet.
  504. // 12. Push calleeContext onto the execution context stack; calleeContext is now the running execution context.
  505. TRY(vm.push_execution_context(callee_context, global_object()));
  506. // 13. NOTE: Any exception objects produced after this point are associated with calleeRealm.
  507. // 14. Return calleeContext. (See NOTE above about how contexts are allocated on the C++ stack.)
  508. return {};
  509. }
  510. // 10.2.1.2 OrdinaryCallBindThis ( F, calleeContext, thisArgument ), https://tc39.es/ecma262/#sec-ordinarycallbindthis
  511. void ECMAScriptFunctionObject::ordinary_call_bind_this(ExecutionContext& callee_context, Value this_argument)
  512. {
  513. auto& vm = this->vm();
  514. // 1. Let thisMode be F.[[ThisMode]].
  515. auto this_mode = m_this_mode;
  516. // If thisMode is lexical, return NormalCompletion(undefined).
  517. if (this_mode == ThisMode::Lexical)
  518. return;
  519. // 3. Let calleeRealm be F.[[Realm]].
  520. auto* callee_realm = m_realm;
  521. // NOTE: This non-standard fallback is needed until we can guarantee that literally
  522. // every function has a realm - especially in LibWeb that's sometimes not the case
  523. // when a function is created while no JS is running, as we currently need to rely on
  524. // that (:acid2:, I know - see set_event_handler_attribute() for an example).
  525. // If there's no 'current realm' either, we can't continue and crash.
  526. if (!callee_realm)
  527. callee_realm = vm.current_realm();
  528. VERIFY(callee_realm);
  529. // 4. Let localEnv be the LexicalEnvironment of calleeContext.
  530. auto* local_env = callee_context.lexical_environment;
  531. Value this_value;
  532. // 5. If thisMode is strict, let thisValue be thisArgument.
  533. if (this_mode == ThisMode::Strict) {
  534. this_value = this_argument;
  535. }
  536. // 6. Else,
  537. else {
  538. // a. If thisArgument is undefined or null, then
  539. if (this_argument.is_nullish()) {
  540. // i. Let globalEnv be calleeRealm.[[GlobalEnv]].
  541. // ii. Assert: globalEnv is a global Environment Record.
  542. auto& global_env = callee_realm->global_environment();
  543. // iii. Let thisValue be globalEnv.[[GlobalThisValue]].
  544. this_value = &global_env.global_this_value();
  545. }
  546. // b. Else,
  547. else {
  548. // i. Let thisValue be ! ToObject(thisArgument).
  549. this_value = MUST(this_argument.to_object(global_object()));
  550. // ii. NOTE: ToObject produces wrapper objects using calleeRealm.
  551. // FIXME: It currently doesn't, as we pass the function's global object.
  552. }
  553. }
  554. // 7. Assert: localEnv is a function Environment Record.
  555. // 8. Assert: The next step never returns an abrupt completion because localEnv.[[ThisBindingStatus]] is not initialized.
  556. // 9. Return localEnv.BindThisValue(thisValue).
  557. MUST(verify_cast<FunctionEnvironment>(local_env)->bind_this_value(global_object(), this_value));
  558. }
  559. // 27.7.5.1 AsyncFunctionStart ( promiseCapability, asyncFunctionBody ), https://tc39.es/ecma262/#sec-async-functions-abstract-operations-async-function-start
  560. void ECMAScriptFunctionObject::async_function_start(PromiseCapability const& promise_capability)
  561. {
  562. auto& vm = this->vm();
  563. // 1. Let runningContext be the running execution context.
  564. auto& running_context = vm.running_execution_context();
  565. // 2. Let asyncContext be a copy of runningContext.
  566. auto async_context = running_context.copy();
  567. // 3. NOTE: Copying the execution state is required for AsyncBlockStart to resume its execution. It is ill-defined to resume a currently executing context.
  568. // 4. Perform ! AsyncBlockStart(promiseCapability, asyncFunctionBody, asyncContext).
  569. async_block_start(vm, m_ecmascript_code, promise_capability, async_context);
  570. }
  571. // 27.7.5.2 AsyncBlockStart ( promiseCapability, asyncBody, asyncContext ), https://tc39.es/ecma262/#sec-asyncblockstart
  572. void async_block_start(VM& vm, NonnullRefPtr<Statement> const& async_body, PromiseCapability const& promise_capability, ExecutionContext& async_context)
  573. {
  574. auto& global_object = vm.current_realm()->global_object();
  575. // 1. Assert: promiseCapability is a PromiseCapability Record.
  576. // 2. Let runningContext be the running execution context.
  577. auto& running_context = vm.running_execution_context();
  578. // 3. Set the code evaluation state of asyncContext such that when evaluation is resumed for that execution context the following steps will be performed:
  579. auto* execution_steps = NativeFunction::create(global_object, "", [&async_body, &promise_capability](auto& vm, auto& global_object) -> ThrowCompletionOr<Value> {
  580. // a. Let result be the result of evaluating asyncBody.
  581. auto result = async_body->execute(vm.interpreter(), global_object);
  582. // b. Assert: If we return here, the async function either threw an exception or performed an implicit or explicit return; all awaiting is done.
  583. // c. 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.
  584. vm.pop_execution_context();
  585. // d. If result.[[Type]] is normal, then
  586. if (result.type() == Completion::Type::Normal) {
  587. // i. Perform ! Call(promiseCapability.[[Resolve]], undefined, « undefined »).
  588. MUST(call(global_object, promise_capability.resolve, js_undefined(), js_undefined()));
  589. }
  590. // e. Else if result.[[Type]] is return, then
  591. else if (result.type() == Completion::Type::Return) {
  592. // i. Perform ! Call(promiseCapability.[[Resolve]], undefined, « result.[[Value]] »).
  593. MUST(call(global_object, promise_capability.resolve, js_undefined(), *result.value()));
  594. }
  595. // f. Else,
  596. else {
  597. // i. Assert: result.[[Type]] is throw.
  598. VERIFY(result.type() == Completion::Type::Throw);
  599. // ii. Perform ! Call(promiseCapability.[[Reject]], undefined, « result.[[Value]] »).
  600. MUST(call(global_object, promise_capability.reject, js_undefined(), *result.value()));
  601. }
  602. // g. Return.
  603. return js_undefined();
  604. });
  605. // 4. Push asyncContext onto the execution context stack; asyncContext is now the running execution context.
  606. auto push_result = vm.push_execution_context(async_context, global_object);
  607. if (push_result.is_error())
  608. return;
  609. // 5. Resume the suspended evaluation of asyncContext. Let result be the value returned by the resumed computation.
  610. auto result = call(global_object, *execution_steps, async_context.this_value.is_empty() ? js_undefined() : async_context.this_value);
  611. // 6. Assert: When we return here, asyncContext has already been removed from the execution context stack and runningContext is the currently running execution context.
  612. VERIFY(&vm.running_execution_context() == &running_context);
  613. // 7. Assert: result is a normal completion with a value of undefined. The possible sources of completion values are Await or, if the async function doesn't await anything, step 3.g above.
  614. VERIFY(result.has_value() && result.value().is_undefined());
  615. // 8. Return.
  616. }
  617. // 10.2.1.4 OrdinaryCallEvaluateBody ( F, argumentsList ), https://tc39.es/ecma262/#sec-ordinarycallevaluatebody
  618. // 15.8.4 Runtime Semantics: EvaluateAsyncFunctionBody, https://tc39.es/ecma262/#sec-runtime-semantics-evaluatefunctionbody
  619. Completion ECMAScriptFunctionObject::ordinary_call_evaluate_body()
  620. {
  621. auto& vm = this->vm();
  622. auto* bytecode_interpreter = Bytecode::Interpreter::current();
  623. if (m_kind == FunctionKind::AsyncGenerator)
  624. return vm.throw_completion<InternalError>(global_object(), ErrorType::NotImplemented, "Async Generator function execution");
  625. if (bytecode_interpreter) {
  626. // FIXME: pass something to evaluate default arguments with
  627. TRY(function_declaration_instantiation(nullptr));
  628. if (!m_bytecode_executable) {
  629. m_bytecode_executable = Bytecode::Generator::generate(m_ecmascript_code, m_kind);
  630. m_bytecode_executable->name = m_name;
  631. auto& passes = JS::Bytecode::Interpreter::optimization_pipeline();
  632. passes.perform(*m_bytecode_executable);
  633. if constexpr (JS_BYTECODE_DEBUG) {
  634. dbgln("Optimisation passes took {}us", passes.elapsed());
  635. dbgln("Compiled Bytecode::Block for function '{}':", m_name);
  636. }
  637. if (JS::Bytecode::g_dump_bytecode)
  638. m_bytecode_executable->dump();
  639. }
  640. auto result_and_frame = bytecode_interpreter->run_and_return_frame(*m_bytecode_executable, nullptr);
  641. VERIFY(result_and_frame.frame != nullptr);
  642. if (result_and_frame.value.is_error())
  643. return result_and_frame.value.release_error();
  644. auto result = result_and_frame.value.release_value();
  645. // NOTE: Running the bytecode should eventually return a completion.
  646. // Until it does, we assume "return" and include the undefined fallback from the call site.
  647. if (m_kind == FunctionKind::Normal)
  648. return { Completion::Type::Return, result.value_or(js_undefined()), {} };
  649. auto generator_object = TRY(GeneratorObject::create(global_object(), result, this, vm.running_execution_context().copy(), move(*result_and_frame.frame)));
  650. // NOTE: Async functions are entirely transformed to generator functions, and wrapped in a custom driver that returns a promise
  651. // See AwaitExpression::generate_bytecode() for the transformation.
  652. if (m_kind == FunctionKind::Async)
  653. return { Completion::Type::Return, TRY(AsyncFunctionDriverWrapper::create(global_object(), generator_object)), {} };
  654. VERIFY(m_kind == FunctionKind::Generator);
  655. return { Completion::Type::Return, generator_object, {} };
  656. } else {
  657. if (m_kind == FunctionKind::Generator)
  658. return vm.throw_completion<InternalError>(global_object(), ErrorType::NotImplemented, "Generator function execution in AST interpreter");
  659. OwnPtr<Interpreter> local_interpreter;
  660. Interpreter* ast_interpreter = vm.interpreter_if_exists();
  661. if (!ast_interpreter) {
  662. local_interpreter = Interpreter::create_with_existing_realm(*realm());
  663. ast_interpreter = local_interpreter.ptr();
  664. }
  665. VM::InterpreterExecutionScope scope(*ast_interpreter);
  666. // FunctionBody : FunctionStatementList
  667. if (m_kind == FunctionKind::Normal) {
  668. // 1. Perform ? FunctionDeclarationInstantiation(functionObject, argumentsList).
  669. TRY(function_declaration_instantiation(ast_interpreter));
  670. // 2. Return the result of evaluating FunctionStatementList.
  671. return m_ecmascript_code->execute(*ast_interpreter, global_object());
  672. }
  673. // AsyncFunctionBody : FunctionBody
  674. else if (m_kind == FunctionKind::Async) {
  675. // 1. Let promiseCapability be ! NewPromiseCapability(%Promise%).
  676. auto promise_capability = MUST(new_promise_capability(global_object(), global_object().promise_constructor()));
  677. // 2. Let declResult be FunctionDeclarationInstantiation(functionObject, argumentsList).
  678. auto declaration_result = function_declaration_instantiation(ast_interpreter);
  679. // 3. If declResult is not an abrupt completion, then
  680. if (!declaration_result.is_throw_completion()) {
  681. // a. Perform ! AsyncFunctionStart(promiseCapability, FunctionBody).
  682. async_function_start(promise_capability);
  683. }
  684. // 4. Else,
  685. else {
  686. // a. Perform ! Call(promiseCapability.[[Reject]], undefined, « declResult.[[Value]] »).
  687. MUST(call(global_object(), promise_capability.reject, js_undefined(), *declaration_result.throw_completion().value()));
  688. }
  689. // 5. Return Completion { [[Type]]: return, [[Value]]: promiseCapability.[[Promise]], [[Target]]: empty }.
  690. return Completion { Completion::Type::Return, promise_capability.promise, {} };
  691. }
  692. }
  693. VERIFY_NOT_REACHED();
  694. }
  695. void ECMAScriptFunctionObject::set_name(const FlyString& name)
  696. {
  697. VERIFY(!name.is_null());
  698. auto& vm = this->vm();
  699. m_name = name;
  700. auto success = MUST(define_property_or_throw(vm.names.name, { .value = js_string(vm, m_name), .writable = false, .enumerable = false, .configurable = true }));
  701. VERIFY(success);
  702. }
  703. void ECMAScriptFunctionObject::add_field(ClassElement::ClassElementName property_key, ECMAScriptFunctionObject* initializer)
  704. {
  705. m_fields.empend(property_key, initializer);
  706. }
  707. }