CommonImplementations.cpp 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851
  1. /*
  2. * Copyright (c) 2021-2023, Andreas Kling <kling@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include <LibJS/Bytecode/CommonImplementations.h>
  7. #include <LibJS/Bytecode/Interpreter.h>
  8. #include <LibJS/Bytecode/Op.h>
  9. #include <LibJS/Runtime/Array.h>
  10. #include <LibJS/Runtime/DeclarativeEnvironment.h>
  11. #include <LibJS/Runtime/ECMAScriptFunctionObject.h>
  12. #include <LibJS/Runtime/FunctionEnvironment.h>
  13. #include <LibJS/Runtime/GlobalEnvironment.h>
  14. #include <LibJS/Runtime/NativeFunction.h>
  15. #include <LibJS/Runtime/ObjectEnvironment.h>
  16. #include <LibJS/Runtime/RegExpObject.h>
  17. #include <LibJS/Runtime/TypedArray.h>
  18. #include <LibJS/Runtime/ValueInlines.h>
  19. namespace JS::Bytecode {
  20. // NOTE: This function assumes that the index is valid within the TypedArray,
  21. // and that the TypedArray is not detached.
  22. template<typename T>
  23. inline Value fast_integer_indexed_element_get(TypedArrayBase& typed_array, u32 index)
  24. {
  25. Checked<u32> offset_into_array_buffer = index;
  26. offset_into_array_buffer *= sizeof(T);
  27. offset_into_array_buffer += typed_array.byte_offset();
  28. if (offset_into_array_buffer.has_overflow()) [[unlikely]] {
  29. return js_undefined();
  30. }
  31. auto const& array_buffer = *typed_array.viewed_array_buffer();
  32. auto const* slot = reinterpret_cast<T const*>(array_buffer.buffer().offset_pointer(offset_into_array_buffer.value()));
  33. return Value { *slot };
  34. }
  35. // NOTE: This function assumes that the index is valid within the TypedArray,
  36. // and that the TypedArray is not detached.
  37. template<typename T>
  38. inline void fast_integer_indexed_element_set(TypedArrayBase& typed_array, u32 index, T value)
  39. {
  40. Checked<u32> offset_into_array_buffer = index;
  41. offset_into_array_buffer *= sizeof(T);
  42. offset_into_array_buffer += typed_array.byte_offset();
  43. if (offset_into_array_buffer.has_overflow()) [[unlikely]] {
  44. return;
  45. }
  46. auto& array_buffer = *typed_array.viewed_array_buffer();
  47. auto* slot = reinterpret_cast<T*>(array_buffer.buffer().offset_pointer(offset_into_array_buffer.value()));
  48. *slot = value;
  49. }
  50. ThrowCompletionOr<NonnullGCPtr<Object>> base_object_for_get(VM& vm, Value base_value)
  51. {
  52. if (base_value.is_object())
  53. return base_value.as_object();
  54. // OPTIMIZATION: For various primitives we can avoid actually creating a new object for them.
  55. if (base_value.is_string())
  56. return vm.current_realm()->intrinsics().string_prototype();
  57. if (base_value.is_number())
  58. return vm.current_realm()->intrinsics().number_prototype();
  59. if (base_value.is_boolean())
  60. return vm.current_realm()->intrinsics().boolean_prototype();
  61. return base_value.to_object(vm);
  62. }
  63. ThrowCompletionOr<Value> get_by_id(VM& vm, DeprecatedFlyString const& property, Value base_value, Value this_value, PropertyLookupCache& cache)
  64. {
  65. if (base_value.is_string()) {
  66. auto string_value = TRY(base_value.as_string().get(vm, property));
  67. if (string_value.has_value())
  68. return *string_value;
  69. }
  70. auto base_obj = TRY(base_object_for_get(vm, base_value));
  71. // OPTIMIZATION: If the shape of the object hasn't changed, we can use the cached property offset.
  72. // NOTE: Unique shapes don't change identity, so we compare their serial numbers instead.
  73. auto& shape = base_obj->shape();
  74. if (&shape == cache.shape
  75. && (!shape.is_unique() || shape.unique_shape_serial_number() == cache.unique_shape_serial_number)) {
  76. return base_obj->get_direct(cache.property_offset.value());
  77. }
  78. CacheablePropertyMetadata cacheable_metadata;
  79. auto value = TRY(base_obj->internal_get(property, this_value, &cacheable_metadata));
  80. if (cacheable_metadata.type == CacheablePropertyMetadata::Type::OwnProperty) {
  81. cache.shape = shape;
  82. cache.property_offset = cacheable_metadata.property_offset.value();
  83. cache.unique_shape_serial_number = shape.unique_shape_serial_number();
  84. }
  85. return value;
  86. }
  87. ThrowCompletionOr<Value> get_by_value(VM& vm, Value base_value, Value property_key_value)
  88. {
  89. // OPTIMIZATION: Fast path for simple Int32 indexes in array-like objects.
  90. if (base_value.is_object() && property_key_value.is_int32() && property_key_value.as_i32() >= 0) {
  91. auto& object = base_value.as_object();
  92. auto index = static_cast<u32>(property_key_value.as_i32());
  93. // For "non-typed arrays":
  94. if (!object.may_interfere_with_indexed_property_access()
  95. && object.indexed_properties().has_index(index)) {
  96. auto value = object.indexed_properties().get(index)->value;
  97. if (!value.is_accessor())
  98. return value;
  99. }
  100. // For typed arrays:
  101. if (object.is_typed_array()) {
  102. auto& typed_array = static_cast<TypedArrayBase&>(object);
  103. if (!typed_array.viewed_array_buffer()->is_detached() && index < typed_array.array_length()) {
  104. switch (typed_array.kind()) {
  105. case TypedArrayBase::Kind::Uint8Array:
  106. return fast_integer_indexed_element_get<u8>(typed_array, index);
  107. case TypedArrayBase::Kind::Uint16Array:
  108. return fast_integer_indexed_element_get<u16>(typed_array, index);
  109. case TypedArrayBase::Kind::Uint32Array:
  110. return fast_integer_indexed_element_get<u32>(typed_array, index);
  111. case TypedArrayBase::Kind::Int8Array:
  112. return fast_integer_indexed_element_get<i8>(typed_array, index);
  113. case TypedArrayBase::Kind::Int16Array:
  114. return fast_integer_indexed_element_get<i16>(typed_array, index);
  115. case TypedArrayBase::Kind::Int32Array:
  116. return fast_integer_indexed_element_get<i32>(typed_array, index);
  117. default:
  118. // FIXME: Support more TypedArray kinds.
  119. break;
  120. }
  121. }
  122. auto canonical_index = CanonicalIndex { CanonicalIndex::Type::Index, index };
  123. switch (typed_array.kind()) {
  124. #define __JS_ENUMERATE(ClassName, snake_name, PrototypeName, ConstructorName, Type) \
  125. case TypedArrayBase::Kind::ClassName: \
  126. return integer_indexed_element_get<Type>(typed_array, canonical_index);
  127. JS_ENUMERATE_TYPED_ARRAYS
  128. #undef __JS_ENUMERATE
  129. }
  130. }
  131. }
  132. auto object = TRY(base_object_for_get(vm, base_value));
  133. auto property_key = TRY(property_key_value.to_property_key(vm));
  134. if (base_value.is_string()) {
  135. auto string_value = TRY(base_value.as_string().get(vm, property_key));
  136. if (string_value.has_value())
  137. return *string_value;
  138. }
  139. return TRY(object->internal_get(property_key, base_value));
  140. }
  141. ThrowCompletionOr<Value> get_global(Bytecode::Interpreter& interpreter, DeprecatedFlyString const& identifier, GlobalVariableCache& cache)
  142. {
  143. auto& vm = interpreter.vm();
  144. auto& realm = *vm.current_realm();
  145. auto& binding_object = realm.global_environment().object_record().binding_object();
  146. auto& declarative_record = realm.global_environment().declarative_record();
  147. // OPTIMIZATION: If the shape of the object hasn't changed, we can use the cached property offset.
  148. // NOTE: Unique shapes don't change identity, so we compare their serial numbers instead.
  149. auto& shape = binding_object.shape();
  150. if (cache.environment_serial_number == declarative_record.environment_serial_number()
  151. && &shape == cache.shape
  152. && (!shape.is_unique() || shape.unique_shape_serial_number() == cache.unique_shape_serial_number)) {
  153. return binding_object.get_direct(cache.property_offset.value());
  154. }
  155. cache.environment_serial_number = declarative_record.environment_serial_number();
  156. if (vm.running_execution_context().script_or_module.has<NonnullGCPtr<Module>>()) {
  157. // NOTE: GetGlobal is used to access variables stored in the module environment and global environment.
  158. // The module environment is checked first since it precedes the global environment in the environment chain.
  159. auto& module_environment = *vm.running_execution_context().script_or_module.get<NonnullGCPtr<Module>>()->environment();
  160. if (TRY(module_environment.has_binding(identifier))) {
  161. // TODO: Cache offset of binding value
  162. return TRY(module_environment.get_binding_value(vm, identifier, vm.in_strict_mode()));
  163. }
  164. }
  165. if (TRY(declarative_record.has_binding(identifier))) {
  166. // TODO: Cache offset of binding value
  167. return TRY(declarative_record.get_binding_value(vm, identifier, vm.in_strict_mode()));
  168. }
  169. if (TRY(binding_object.has_property(identifier))) {
  170. CacheablePropertyMetadata cacheable_metadata;
  171. auto value = TRY(binding_object.internal_get(identifier, js_undefined(), &cacheable_metadata));
  172. if (cacheable_metadata.type == CacheablePropertyMetadata::Type::OwnProperty) {
  173. cache.shape = shape;
  174. cache.property_offset = cacheable_metadata.property_offset.value();
  175. cache.unique_shape_serial_number = shape.unique_shape_serial_number();
  176. }
  177. return value;
  178. }
  179. return vm.throw_completion<ReferenceError>(ErrorType::UnknownIdentifier, identifier);
  180. }
  181. ThrowCompletionOr<void> put_by_property_key(VM& vm, Value base, Value this_value, Value value, PropertyKey name, Op::PropertyKind kind, PropertyLookupCache* cache)
  182. {
  183. // Better error message than to_object would give
  184. if (vm.in_strict_mode() && base.is_nullish())
  185. return vm.throw_completion<TypeError>(ErrorType::ReferenceNullishSetProperty, name, base.to_string_without_side_effects());
  186. // a. Let baseObj be ? ToObject(V.[[Base]]).
  187. auto object = TRY(base.to_object(vm));
  188. if (kind == Op::PropertyKind::Getter || kind == Op::PropertyKind::Setter) {
  189. // The generator should only pass us functions for getters and setters.
  190. VERIFY(value.is_function());
  191. }
  192. switch (kind) {
  193. case Op::PropertyKind::Getter: {
  194. auto& function = value.as_function();
  195. if (function.name().is_empty() && is<ECMAScriptFunctionObject>(function))
  196. static_cast<ECMAScriptFunctionObject*>(&function)->set_name(DeprecatedString::formatted("get {}", name));
  197. object->define_direct_accessor(name, &function, nullptr, Attribute::Configurable | Attribute::Enumerable);
  198. break;
  199. }
  200. case Op::PropertyKind::Setter: {
  201. auto& function = value.as_function();
  202. if (function.name().is_empty() && is<ECMAScriptFunctionObject>(function))
  203. static_cast<ECMAScriptFunctionObject*>(&function)->set_name(DeprecatedString::formatted("set {}", name));
  204. object->define_direct_accessor(name, nullptr, &function, Attribute::Configurable | Attribute::Enumerable);
  205. break;
  206. }
  207. case Op::PropertyKind::KeyValue: {
  208. if (cache
  209. && cache->shape == &object->shape()
  210. && (!object->shape().is_unique() || object->shape().unique_shape_serial_number() == cache->unique_shape_serial_number)) {
  211. object->put_direct(*cache->property_offset, value);
  212. return {};
  213. }
  214. CacheablePropertyMetadata cacheable_metadata;
  215. bool succeeded = TRY(object->internal_set(name, value, this_value, &cacheable_metadata));
  216. if (succeeded && cache && cacheable_metadata.type == CacheablePropertyMetadata::Type::OwnProperty) {
  217. cache->shape = object->shape();
  218. cache->property_offset = cacheable_metadata.property_offset.value();
  219. cache->unique_shape_serial_number = object->shape().unique_shape_serial_number();
  220. }
  221. if (!succeeded && vm.in_strict_mode()) {
  222. if (base.is_object())
  223. return vm.throw_completion<TypeError>(ErrorType::ReferenceNullishSetProperty, name, base.to_string_without_side_effects());
  224. return vm.throw_completion<TypeError>(ErrorType::ReferencePrimitiveSetProperty, name, base.typeof(), base.to_string_without_side_effects());
  225. }
  226. break;
  227. }
  228. case Op::PropertyKind::DirectKeyValue:
  229. object->define_direct_property(name, value, Attribute::Enumerable | Attribute::Writable | Attribute::Configurable);
  230. break;
  231. case Op::PropertyKind::Spread:
  232. TRY(object->copy_data_properties(vm, value, {}));
  233. break;
  234. case Op::PropertyKind::ProtoSetter:
  235. if (value.is_object() || value.is_null())
  236. MUST(object->internal_set_prototype_of(value.is_object() ? &value.as_object() : nullptr));
  237. break;
  238. }
  239. return {};
  240. }
  241. ThrowCompletionOr<Value> perform_call(Interpreter& interpreter, Value this_value, Op::CallType call_type, Value callee, ReadonlySpan<Value> argument_values)
  242. {
  243. auto& vm = interpreter.vm();
  244. auto& function = callee.as_function();
  245. Value return_value;
  246. if (call_type == Op::CallType::DirectEval) {
  247. if (callee == interpreter.realm().intrinsics().eval_function())
  248. return_value = TRY(perform_eval(vm, !argument_values.is_empty() ? argument_values[0].value_or(JS::js_undefined()) : js_undefined(), vm.in_strict_mode() ? CallerMode::Strict : CallerMode::NonStrict, EvalMode::Direct));
  249. else
  250. return_value = TRY(JS::call(vm, function, this_value, argument_values));
  251. } else if (call_type == Op::CallType::Call)
  252. return_value = TRY(JS::call(vm, function, this_value, argument_values));
  253. else
  254. return_value = TRY(construct(vm, function, argument_values));
  255. return return_value;
  256. }
  257. static Completion throw_type_error_for_callee(Bytecode::Interpreter& interpreter, Value callee, StringView callee_type, Optional<StringTableIndex> const& expression_string)
  258. {
  259. auto& vm = interpreter.vm();
  260. if (expression_string.has_value())
  261. return vm.throw_completion<TypeError>(ErrorType::IsNotAEvaluatedFrom, callee.to_string_without_side_effects(), callee_type, interpreter.current_executable().get_string(expression_string->value()));
  262. return vm.throw_completion<TypeError>(ErrorType::IsNotA, callee.to_string_without_side_effects(), callee_type);
  263. }
  264. ThrowCompletionOr<void> throw_if_needed_for_call(Interpreter& interpreter, Value callee, Op::CallType call_type, Optional<StringTableIndex> const& expression_string)
  265. {
  266. if ((call_type == Op::CallType::Call || call_type == Op::CallType::DirectEval)
  267. && !callee.is_function())
  268. return throw_type_error_for_callee(interpreter, callee, "function"sv, expression_string);
  269. if (call_type == Op::CallType::Construct && !callee.is_constructor())
  270. return throw_type_error_for_callee(interpreter, callee, "constructor"sv, expression_string);
  271. return {};
  272. }
  273. ThrowCompletionOr<Value> typeof_variable(VM& vm, DeprecatedFlyString const& string)
  274. {
  275. // 1. Let val be the result of evaluating UnaryExpression.
  276. auto reference = TRY(vm.resolve_binding(string));
  277. // 2. If val is a Reference Record, then
  278. // a. If IsUnresolvableReference(val) is true, return "undefined".
  279. if (reference.is_unresolvable())
  280. return PrimitiveString::create(vm, "undefined"_string);
  281. // 3. Set val to ? GetValue(val).
  282. auto value = TRY(reference.get_value(vm));
  283. // 4. NOTE: This step is replaced in section B.3.6.3.
  284. // 5. Return a String according to Table 41.
  285. return PrimitiveString::create(vm, value.typeof());
  286. }
  287. ThrowCompletionOr<void> set_variable(
  288. VM& vm,
  289. DeprecatedFlyString const& name,
  290. Value value,
  291. Op::EnvironmentMode mode,
  292. Op::SetVariable::InitializationMode initialization_mode,
  293. EnvironmentVariableCache& cache)
  294. {
  295. auto environment = mode == Op::EnvironmentMode::Lexical ? vm.running_execution_context().lexical_environment : vm.running_execution_context().variable_environment;
  296. auto reference = TRY(vm.resolve_binding(name, environment));
  297. if (reference.environment_coordinate().has_value())
  298. cache = reference.environment_coordinate();
  299. switch (initialization_mode) {
  300. case Op::SetVariable::InitializationMode::Initialize:
  301. TRY(reference.initialize_referenced_binding(vm, value));
  302. break;
  303. case Op::SetVariable::InitializationMode::Set:
  304. TRY(reference.put_value(vm, value));
  305. break;
  306. }
  307. return {};
  308. }
  309. Value new_function(VM& vm, FunctionExpression const& function_node, Optional<IdentifierTableIndex> const& lhs_name, Optional<Register> const& home_object)
  310. {
  311. Value value;
  312. if (!function_node.has_name()) {
  313. DeprecatedFlyString name = {};
  314. if (lhs_name.has_value())
  315. name = vm.bytecode_interpreter().current_executable().get_identifier(lhs_name.value());
  316. value = function_node.instantiate_ordinary_function_expression(vm, name);
  317. } else {
  318. value = ECMAScriptFunctionObject::create(*vm.current_realm(), function_node.name(), function_node.source_text(), function_node.body(), function_node.parameters(), function_node.function_length(), function_node.local_variables_names(), vm.lexical_environment(), vm.running_execution_context().private_environment, function_node.kind(), function_node.is_strict_mode(), function_node.might_need_arguments_object(), function_node.contains_direct_call_to_eval(), function_node.is_arrow_function());
  319. }
  320. if (home_object.has_value()) {
  321. auto home_object_value = vm.bytecode_interpreter().reg(home_object.value());
  322. static_cast<ECMAScriptFunctionObject&>(value.as_function()).set_home_object(&home_object_value.as_object());
  323. }
  324. return value;
  325. }
  326. ThrowCompletionOr<void> put_by_value(VM& vm, Value base, Value property_key_value, Value value, Op::PropertyKind kind)
  327. {
  328. // OPTIMIZATION: Fast path for simple Int32 indexes in array-like objects.
  329. if ((kind == Op::PropertyKind::KeyValue || kind == Op::PropertyKind::DirectKeyValue)
  330. && base.is_object() && property_key_value.is_int32() && property_key_value.as_i32() >= 0) {
  331. auto& object = base.as_object();
  332. auto* storage = object.indexed_properties().storage();
  333. auto index = static_cast<u32>(property_key_value.as_i32());
  334. // For "non-typed arrays":
  335. if (storage
  336. && storage->is_simple_storage()
  337. && !object.may_interfere_with_indexed_property_access()
  338. && storage->has_index(index)) {
  339. auto existing_value = storage->get(index)->value;
  340. if (!existing_value.is_accessor()) {
  341. storage->put(index, value);
  342. return {};
  343. }
  344. }
  345. // For typed arrays:
  346. if (object.is_typed_array()) {
  347. auto& typed_array = static_cast<TypedArrayBase&>(object);
  348. if (!typed_array.viewed_array_buffer()->is_detached() && index < typed_array.array_length() && value.is_int32()) {
  349. switch (typed_array.kind()) {
  350. case TypedArrayBase::Kind::Uint8Array:
  351. fast_integer_indexed_element_set<u8>(typed_array, index, static_cast<u8>(value.as_i32()));
  352. return {};
  353. case TypedArrayBase::Kind::Uint16Array:
  354. fast_integer_indexed_element_set<u16>(typed_array, index, static_cast<u16>(value.as_i32()));
  355. return {};
  356. case TypedArrayBase::Kind::Uint32Array:
  357. fast_integer_indexed_element_set<u32>(typed_array, index, static_cast<u32>(value.as_i32()));
  358. return {};
  359. case TypedArrayBase::Kind::Int8Array:
  360. fast_integer_indexed_element_set<i8>(typed_array, index, static_cast<i8>(value.as_i32()));
  361. return {};
  362. case TypedArrayBase::Kind::Int16Array:
  363. fast_integer_indexed_element_set<i16>(typed_array, index, static_cast<i16>(value.as_i32()));
  364. return {};
  365. case TypedArrayBase::Kind::Int32Array:
  366. fast_integer_indexed_element_set<i32>(typed_array, index, value.as_i32());
  367. return {};
  368. default:
  369. // FIXME: Support more TypedArray kinds.
  370. break;
  371. }
  372. }
  373. auto canonical_index = CanonicalIndex { CanonicalIndex::Type::Index, index };
  374. switch (typed_array.kind()) {
  375. #define __JS_ENUMERATE(ClassName, snake_name, PrototypeName, ConstructorName, Type) \
  376. case TypedArrayBase::Kind::ClassName: \
  377. return integer_indexed_element_set<Type>(typed_array, canonical_index, value);
  378. JS_ENUMERATE_TYPED_ARRAYS
  379. #undef __JS_ENUMERATE
  380. }
  381. return {};
  382. }
  383. }
  384. auto property_key = kind != Op::PropertyKind::Spread ? TRY(property_key_value.to_property_key(vm)) : PropertyKey {};
  385. TRY(put_by_property_key(vm, base, base, value, property_key, kind));
  386. return {};
  387. }
  388. ThrowCompletionOr<Value> get_variable(Bytecode::Interpreter& interpreter, DeprecatedFlyString const& name, EnvironmentVariableCache& cache)
  389. {
  390. auto& vm = interpreter.vm();
  391. if (cache.has_value()) {
  392. auto environment = vm.running_execution_context().lexical_environment;
  393. for (size_t i = 0; i < cache->hops; ++i)
  394. environment = environment->outer_environment();
  395. VERIFY(environment);
  396. VERIFY(environment->is_declarative_environment());
  397. if (!environment->is_permanently_screwed_by_eval()) {
  398. return TRY(verify_cast<DeclarativeEnvironment>(*environment).get_binding_value_direct(vm, cache.value().index, vm.in_strict_mode()));
  399. }
  400. cache = {};
  401. }
  402. auto reference = TRY(vm.resolve_binding(name));
  403. if (reference.environment_coordinate().has_value())
  404. cache = reference.environment_coordinate();
  405. return TRY(reference.get_value(vm));
  406. }
  407. ThrowCompletionOr<CalleeAndThis> get_callee_and_this_from_environment(Bytecode::Interpreter& interpreter, DeprecatedFlyString const& name, EnvironmentVariableCache& cache)
  408. {
  409. auto& vm = interpreter.vm();
  410. Value callee = js_undefined();
  411. Value this_value = js_undefined();
  412. if (cache.has_value()) {
  413. auto environment = vm.running_execution_context().lexical_environment;
  414. for (size_t i = 0; i < cache->hops; ++i)
  415. environment = environment->outer_environment();
  416. VERIFY(environment);
  417. VERIFY(environment->is_declarative_environment());
  418. if (!environment->is_permanently_screwed_by_eval()) {
  419. callee = TRY(verify_cast<DeclarativeEnvironment>(*environment).get_binding_value_direct(vm, cache.value().index, vm.in_strict_mode()));
  420. this_value = js_undefined();
  421. if (auto base_object = environment->with_base_object())
  422. this_value = base_object;
  423. return CalleeAndThis {
  424. .callee = callee,
  425. .this_value = this_value,
  426. };
  427. }
  428. cache = {};
  429. }
  430. auto reference = TRY(vm.resolve_binding(name));
  431. if (reference.environment_coordinate().has_value())
  432. cache = reference.environment_coordinate();
  433. callee = TRY(reference.get_value(vm));
  434. if (reference.is_property_reference()) {
  435. this_value = reference.get_this_value();
  436. } else {
  437. if (reference.is_environment_reference()) {
  438. if (auto base_object = reference.base_environment().with_base_object(); base_object != nullptr)
  439. this_value = base_object;
  440. }
  441. }
  442. return CalleeAndThis {
  443. .callee = callee,
  444. .this_value = this_value,
  445. };
  446. }
  447. // 13.2.7.3 Runtime Semantics: Evaluation, https://tc39.es/ecma262/#sec-regular-expression-literals-runtime-semantics-evaluation
  448. Value new_regexp(VM& vm, ParsedRegex const& parsed_regex, DeprecatedString const& pattern, DeprecatedString const& flags)
  449. {
  450. // 1. Let pattern be CodePointsToString(BodyText of RegularExpressionLiteral).
  451. // 2. Let flags be CodePointsToString(FlagText of RegularExpressionLiteral).
  452. // 3. Return ! RegExpCreate(pattern, flags).
  453. auto& realm = *vm.current_realm();
  454. Regex<ECMA262> regex(parsed_regex.regex, parsed_regex.pattern, parsed_regex.flags);
  455. // NOTE: We bypass RegExpCreate and subsequently RegExpAlloc as an optimization to use the already parsed values.
  456. auto regexp_object = RegExpObject::create(realm, move(regex), pattern, flags);
  457. // RegExpAlloc has these two steps from the 'Legacy RegExp features' proposal.
  458. regexp_object->set_realm(realm);
  459. // We don't need to check 'If SameValue(newTarget, thisRealm.[[Intrinsics]].[[%RegExp%]]) is true'
  460. // here as we know RegExpCreate calls RegExpAlloc with %RegExp% for newTarget.
  461. regexp_object->set_legacy_features_enabled(true);
  462. return regexp_object;
  463. }
  464. // 13.3.8.1 https://tc39.es/ecma262/#sec-runtime-semantics-argumentlistevaluation
  465. MarkedVector<Value> argument_list_evaluation(VM& vm, Value arguments)
  466. {
  467. // Note: Any spreading and actual evaluation is handled in preceding opcodes
  468. // Note: The spec uses the concept of a list, while we create a temporary array
  469. // in the preceding opcodes, so we have to convert in a manner that is not
  470. // visible to the user
  471. MarkedVector<Value> argument_values { vm.heap() };
  472. auto& argument_array = arguments.as_array();
  473. auto array_length = argument_array.indexed_properties().array_like_size();
  474. argument_values.ensure_capacity(array_length);
  475. for (size_t i = 0; i < array_length; ++i) {
  476. if (auto maybe_value = argument_array.indexed_properties().get(i); maybe_value.has_value())
  477. argument_values.append(maybe_value.release_value().value);
  478. else
  479. argument_values.append(js_undefined());
  480. }
  481. return argument_values;
  482. }
  483. ThrowCompletionOr<void> create_variable(VM& vm, DeprecatedFlyString const& name, Op::EnvironmentMode mode, bool is_global, bool is_immutable, bool is_strict)
  484. {
  485. if (mode == Op::EnvironmentMode::Lexical) {
  486. VERIFY(!is_global);
  487. // Note: This is papering over an issue where "FunctionDeclarationInstantiation" creates these bindings for us.
  488. // Instead of crashing in there, we'll just raise an exception here.
  489. if (TRY(vm.lexical_environment()->has_binding(name)))
  490. return vm.throw_completion<InternalError>(TRY_OR_THROW_OOM(vm, String::formatted("Lexical environment already has binding '{}'", name)));
  491. if (is_immutable)
  492. return vm.lexical_environment()->create_immutable_binding(vm, name, is_strict);
  493. return vm.lexical_environment()->create_mutable_binding(vm, name, is_strict);
  494. }
  495. if (!is_global) {
  496. if (is_immutable)
  497. return vm.variable_environment()->create_immutable_binding(vm, name, is_strict);
  498. return vm.variable_environment()->create_mutable_binding(vm, name, is_strict);
  499. }
  500. // NOTE: CreateVariable with m_is_global set to true is expected to only be used in GlobalDeclarationInstantiation currently, which only uses "false" for "can_be_deleted".
  501. // The only area that sets "can_be_deleted" to true is EvalDeclarationInstantiation, which is currently fully implemented in C++ and not in Bytecode.
  502. return verify_cast<GlobalEnvironment>(vm.variable_environment())->create_global_var_binding(name, false);
  503. }
  504. ThrowCompletionOr<ECMAScriptFunctionObject*> new_class(VM& vm, Value super_class, ClassExpression const& class_expression, Optional<IdentifierTableIndex> const& lhs_name)
  505. {
  506. auto& interpreter = vm.bytecode_interpreter();
  507. auto name = class_expression.name();
  508. // NOTE: NewClass expects classEnv to be active lexical environment
  509. auto* class_environment = vm.lexical_environment();
  510. vm.running_execution_context().lexical_environment = interpreter.saved_lexical_environment_stack().take_last();
  511. DeprecatedFlyString binding_name;
  512. DeprecatedFlyString class_name;
  513. if (!class_expression.has_name() && lhs_name.has_value()) {
  514. class_name = interpreter.current_executable().get_identifier(lhs_name.value());
  515. } else {
  516. binding_name = name;
  517. class_name = name.is_null() ? ""sv : name;
  518. }
  519. return TRY(class_expression.create_class_constructor(vm, class_environment, vm.lexical_environment(), super_class, binding_name, class_name));
  520. }
  521. // 13.3.7.1 Runtime Semantics: Evaluation, https://tc39.es/ecma262/#sec-super-keyword-runtime-semantics-evaluation
  522. ThrowCompletionOr<NonnullGCPtr<Object>> super_call_with_argument_array(VM& vm, Value argument_array, bool is_synthetic)
  523. {
  524. // 1. Let newTarget be GetNewTarget().
  525. auto new_target = vm.get_new_target();
  526. // 2. Assert: Type(newTarget) is Object.
  527. VERIFY(new_target.is_object());
  528. // 3. Let func be GetSuperConstructor().
  529. auto* func = get_super_constructor(vm);
  530. // 4. Let argList be ? ArgumentListEvaluation of Arguments.
  531. MarkedVector<Value> arg_list { vm.heap() };
  532. if (is_synthetic) {
  533. VERIFY(argument_array.is_object() && is<Array>(argument_array.as_object()));
  534. auto const& array_value = static_cast<Array const&>(argument_array.as_object());
  535. auto length = MUST(length_of_array_like(vm, array_value));
  536. for (size_t i = 0; i < length; ++i)
  537. arg_list.append(array_value.get_without_side_effects(PropertyKey { i }));
  538. } else {
  539. arg_list = argument_list_evaluation(vm, argument_array);
  540. }
  541. // 5. If IsConstructor(func) is false, throw a TypeError exception.
  542. if (!Value(func).is_constructor())
  543. return vm.throw_completion<TypeError>(ErrorType::NotAConstructor, "Super constructor");
  544. // 6. Let result be ? Construct(func, argList, newTarget).
  545. auto result = TRY(construct(vm, static_cast<FunctionObject&>(*func), arg_list.span(), &new_target.as_function()));
  546. // 7. Let thisER be GetThisEnvironment().
  547. auto& this_environment = verify_cast<FunctionEnvironment>(*get_this_environment(vm));
  548. // 8. Perform ? thisER.BindThisValue(result).
  549. TRY(this_environment.bind_this_value(vm, result));
  550. // 9. Let F be thisER.[[FunctionObject]].
  551. auto& f = this_environment.function_object();
  552. // 10. Assert: F is an ECMAScript function object.
  553. // NOTE: This is implied by the strong C++ type.
  554. // 11. Perform ? InitializeInstanceElements(result, F).
  555. TRY(result->initialize_instance_elements(f));
  556. // 12. Return result.
  557. return result;
  558. }
  559. ThrowCompletionOr<NonnullGCPtr<Array>> iterator_to_array(VM& vm, Value iterator)
  560. {
  561. auto& iterator_record = verify_cast<IteratorRecord>(iterator.as_object());
  562. auto array = MUST(Array::create(*vm.current_realm(), 0));
  563. size_t index = 0;
  564. while (true) {
  565. auto iterator_result = TRY(iterator_next(vm, iterator_record));
  566. auto complete = TRY(iterator_complete(vm, iterator_result));
  567. if (complete)
  568. return array;
  569. auto value = TRY(iterator_value(vm, iterator_result));
  570. MUST(array->create_data_property_or_throw(index, value));
  571. index++;
  572. }
  573. }
  574. ThrowCompletionOr<void> append(VM& vm, Value lhs, Value rhs, bool is_spread)
  575. {
  576. // Note: This OpCode is used to construct array literals and argument arrays for calls,
  577. // containing at least one spread element,
  578. // Iterating over such a spread element to unpack it has to be visible by
  579. // the user courtesy of
  580. // (1) https://tc39.es/ecma262/#sec-runtime-semantics-arrayaccumulation
  581. // SpreadElement : ... AssignmentExpression
  582. // 1. Let spreadRef be ? Evaluation of AssignmentExpression.
  583. // 2. Let spreadObj be ? GetValue(spreadRef).
  584. // 3. Let iteratorRecord be ? GetIterator(spreadObj).
  585. // 4. Repeat,
  586. // a. Let next be ? IteratorStep(iteratorRecord).
  587. // b. If next is false, return nextIndex.
  588. // c. Let nextValue be ? IteratorValue(next).
  589. // d. Perform ! CreateDataPropertyOrThrow(array, ! ToString(𝔽(nextIndex)), nextValue).
  590. // e. Set nextIndex to nextIndex + 1.
  591. // (2) https://tc39.es/ecma262/#sec-runtime-semantics-argumentlistevaluation
  592. // ArgumentList : ... AssignmentExpression
  593. // 1. Let list be a new empty List.
  594. // 2. Let spreadRef be ? Evaluation of AssignmentExpression.
  595. // 3. Let spreadObj be ? GetValue(spreadRef).
  596. // 4. Let iteratorRecord be ? GetIterator(spreadObj).
  597. // 5. Repeat,
  598. // a. Let next be ? IteratorStep(iteratorRecord).
  599. // b. If next is false, return list.
  600. // c. Let nextArg be ? IteratorValue(next).
  601. // d. Append nextArg to list.
  602. // ArgumentList : ArgumentList , ... AssignmentExpression
  603. // 1. Let precedingArgs be ? ArgumentListEvaluation of ArgumentList.
  604. // 2. Let spreadRef be ? Evaluation of AssignmentExpression.
  605. // 3. Let iteratorRecord be ? GetIterator(? GetValue(spreadRef)).
  606. // 4. Repeat,
  607. // a. Let next be ? IteratorStep(iteratorRecord).
  608. // b. If next is false, return precedingArgs.
  609. // c. Let nextArg be ? IteratorValue(next).
  610. // d. Append nextArg to precedingArgs.
  611. // Note: We know from codegen, that lhs is a plain array with only indexed properties
  612. auto& lhs_array = lhs.as_array();
  613. auto lhs_size = lhs_array.indexed_properties().array_like_size();
  614. if (is_spread) {
  615. // ...rhs
  616. size_t i = lhs_size;
  617. TRY(get_iterator_values(vm, rhs, [&i, &lhs_array](Value iterator_value) -> Optional<Completion> {
  618. lhs_array.indexed_properties().put(i, iterator_value, default_attributes);
  619. ++i;
  620. return {};
  621. }));
  622. } else {
  623. lhs_array.indexed_properties().put(lhs_size, rhs, default_attributes);
  624. }
  625. return {};
  626. }
  627. ThrowCompletionOr<Value> delete_by_id(Bytecode::Interpreter& interpreter, Value base, IdentifierTableIndex property)
  628. {
  629. auto& vm = interpreter.vm();
  630. auto const& identifier = interpreter.current_executable().get_identifier(property);
  631. bool strict = vm.in_strict_mode();
  632. auto reference = Reference { base, identifier, {}, strict };
  633. return TRY(reference.delete_(vm));
  634. }
  635. ThrowCompletionOr<Value> delete_by_value(Bytecode::Interpreter& interpreter, Value base, Value property_key_value)
  636. {
  637. auto& vm = interpreter.vm();
  638. auto property_key = TRY(property_key_value.to_property_key(vm));
  639. bool strict = vm.in_strict_mode();
  640. auto reference = Reference { base, property_key, {}, strict };
  641. return Value(TRY(reference.delete_(vm)));
  642. }
  643. ThrowCompletionOr<Value> delete_by_value_with_this(Bytecode::Interpreter& interpreter, Value base, Value property_key_value, Value this_value)
  644. {
  645. auto& vm = interpreter.vm();
  646. auto property_key = TRY(property_key_value.to_property_key(vm));
  647. bool strict = vm.in_strict_mode();
  648. auto reference = Reference { base, property_key, this_value, strict };
  649. return Value(TRY(reference.delete_(vm)));
  650. }
  651. // 14.7.5.9 EnumerateObjectProperties ( O ), https://tc39.es/ecma262/#sec-enumerate-object-properties
  652. ThrowCompletionOr<Object*> get_object_property_iterator(VM& vm, Value value)
  653. {
  654. // While the spec does provide an algorithm, it allows us to implement it ourselves so long as we meet the following invariants:
  655. // 1- Returned property keys do not include keys that are Symbols
  656. // 2- Properties of the target object may be deleted during enumeration. A property that is deleted before it is processed by the iterator's next method is ignored
  657. // 3- If new properties are added to the target object during enumeration, the newly added properties are not guaranteed to be processed in the active enumeration
  658. // 4- A property name will be returned by the iterator's next method at most once in any enumeration.
  659. // 5- Enumerating the properties of the target object includes enumerating properties of its prototype, and the prototype of the prototype, and so on, recursively;
  660. // but a property of a prototype is not processed if it has the same name as a property that has already been processed by the iterator's next method.
  661. // 6- The values of [[Enumerable]] attributes are not considered when determining if a property of a prototype object has already been processed.
  662. // 7- The enumerable property names of prototype objects must be obtained by invoking EnumerateObjectProperties passing the prototype object as the argument.
  663. // 8- EnumerateObjectProperties must obtain the own property keys of the target object by calling its [[OwnPropertyKeys]] internal method.
  664. // 9- Property attributes of the target object must be obtained by calling its [[GetOwnProperty]] internal method
  665. // Invariant 3 effectively allows the implementation to ignore newly added keys, and we do so (similar to other implementations).
  666. auto object = TRY(value.to_object(vm));
  667. // Note: While the spec doesn't explicitly require these to be ordered, it says that the values should be retrieved via OwnPropertyKeys,
  668. // so we just keep the order consistent anyway.
  669. OrderedHashTable<PropertyKey> properties;
  670. OrderedHashTable<PropertyKey> non_enumerable_properties;
  671. HashTable<NonnullGCPtr<Object>> seen_objects;
  672. // Collect all keys immediately (invariant no. 5)
  673. for (auto object_to_check = GCPtr { object.ptr() }; object_to_check && !seen_objects.contains(*object_to_check); object_to_check = TRY(object_to_check->internal_get_prototype_of())) {
  674. seen_objects.set(*object_to_check);
  675. for (auto& key : TRY(object_to_check->internal_own_property_keys())) {
  676. if (key.is_symbol())
  677. continue;
  678. auto property_key = TRY(PropertyKey::from_value(vm, key));
  679. // If there is a non-enumerable property higher up the prototype chain with the same key,
  680. // we mustn't include this property even if it's enumerable (invariant no. 5 and 6)
  681. if (non_enumerable_properties.contains(property_key))
  682. continue;
  683. if (properties.contains(property_key))
  684. continue;
  685. auto descriptor = TRY(object_to_check->internal_get_own_property(property_key));
  686. if (!*descriptor->enumerable)
  687. non_enumerable_properties.set(move(property_key));
  688. else
  689. properties.set(move(property_key));
  690. }
  691. }
  692. auto& realm = *vm.current_realm();
  693. auto callback = NativeFunction::create(
  694. *vm.current_realm(), [items = move(properties)](VM& vm) mutable -> ThrowCompletionOr<Value> {
  695. auto& realm = *vm.current_realm();
  696. auto iterated_object_value = vm.this_value();
  697. if (!iterated_object_value.is_object())
  698. return vm.throw_completion<InternalError>("Invalid state for GetObjectPropertyIterator.next"sv);
  699. auto& iterated_object = iterated_object_value.as_object();
  700. auto result_object = Object::create(realm, nullptr);
  701. while (true) {
  702. if (items.is_empty()) {
  703. result_object->define_direct_property(vm.names.done, JS::Value(true), default_attributes);
  704. return result_object;
  705. }
  706. auto key = items.take_first();
  707. // If the property is deleted, don't include it (invariant no. 2)
  708. if (!TRY(iterated_object.has_property(key)))
  709. continue;
  710. result_object->define_direct_property(vm.names.done, JS::Value(false), default_attributes);
  711. if (key.is_number())
  712. result_object->define_direct_property(vm.names.value, PrimitiveString::create(vm, TRY_OR_THROW_OOM(vm, String::number(key.as_number()))), default_attributes);
  713. else if (key.is_string())
  714. result_object->define_direct_property(vm.names.value, PrimitiveString::create(vm, key.as_string()), default_attributes);
  715. else
  716. VERIFY_NOT_REACHED(); // We should not have non-string/number keys.
  717. return result_object;
  718. }
  719. },
  720. 1, vm.names.next);
  721. return vm.heap().allocate<IteratorRecord>(realm, realm, object, callback, false).ptr();
  722. }
  723. }