ECMAScriptFunctionObject.cpp 40 KB

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