ECMAScriptFunctionObject.cpp 40 KB

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