CommonImplementations.h 42 KB

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