CommonImplementations.h 43 KB

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