CommonImplementations.h 40 KB

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