ECMAScriptFunctionObject.cpp 41 KB

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