ArrayInstance.cs 42 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309
  1. using System.Collections;
  2. using System.Diagnostics.CodeAnalysis;
  3. using System.Runtime.CompilerServices;
  4. using Jint.Native.Object;
  5. using Jint.Native.Symbol;
  6. using Jint.Runtime;
  7. using Jint.Runtime.Descriptors;
  8. namespace Jint.Native.Array
  9. {
  10. public class ArrayInstance : ObjectInstance, IEnumerable<JsValue>
  11. {
  12. internal PropertyDescriptor? _length;
  13. private const int MaxDenseArrayLength = 10_000_000;
  14. // we have dense and sparse, we usually can start with dense and fall back to sparse when necessary
  15. // entries are lazy and can be either of type PropertyDescriptor or plain JsValue while there is no need for extra info
  16. internal object?[]? _dense;
  17. private Dictionary<uint, object?>? _sparse;
  18. private ObjectChangeFlags _objectChangeFlags;
  19. private protected ArrayInstance(Engine engine, InternalTypes type) : base(engine, type: type)
  20. {
  21. _dense = System.Array.Empty<object?>();
  22. }
  23. private protected ArrayInstance(Engine engine, uint capacity = 0, uint length = 0) : base(engine)
  24. {
  25. _prototype = engine.Realm.Intrinsics.Array.PrototypeObject;
  26. if (capacity > engine.Options.Constraints.MaxArraySize)
  27. {
  28. ThrowMaximumArraySizeReachedException(engine, capacity);
  29. }
  30. if (capacity < MaxDenseArrayLength)
  31. {
  32. _dense = capacity > 0 ? new object?[capacity] : System.Array.Empty<object?>();
  33. }
  34. else
  35. {
  36. _sparse = new Dictionary<uint, object?>(1024);
  37. }
  38. _length = new PropertyDescriptor(length, PropertyFlag.OnlyWritable);
  39. }
  40. private protected ArrayInstance(Engine engine, object[] items) : base(engine)
  41. {
  42. _prototype = engine.Realm.Intrinsics.Array.PrototypeObject;
  43. int length;
  44. if (items == null || items.Length == 0)
  45. {
  46. _dense = System.Array.Empty<object>();
  47. length = 0;
  48. }
  49. else
  50. {
  51. if (items.GetType() != typeof(object[]))
  52. {
  53. ExceptionHelper.ThrowArgumentException("Supplied array must be of type object[] and should only contain values that inherit from JsValue or PropertyDescriptor or are null");
  54. }
  55. _dense = items;
  56. length = items.Length;
  57. }
  58. _length = new PropertyDescriptor(length, PropertyFlag.OnlyWritable);
  59. }
  60. private protected ArrayInstance(Engine engine, PropertyDescriptor[] items) : base(engine)
  61. {
  62. int length;
  63. if (items == null || items.Length == 0)
  64. {
  65. _dense = System.Array.Empty<object>();
  66. length = 0;
  67. }
  68. else
  69. {
  70. _dense = items;
  71. length = items.Length;
  72. }
  73. _length = new PropertyDescriptor(length, PropertyFlag.OnlyWritable);
  74. }
  75. public sealed override bool IsArrayLike => true;
  76. public sealed override bool IsArray() => true;
  77. internal sealed override bool HasOriginalIterator
  78. => ReferenceEquals(Get(GlobalSymbolRegistry.Iterator), _engine.Realm.Intrinsics.Array.PrototypeObject._originalIteratorFunction);
  79. /// <summary>
  80. /// Checks whether there have been changes to object prototype chain which could render fast access patterns impossible.
  81. /// </summary>
  82. internal bool CanUseFastAccess
  83. {
  84. get
  85. {
  86. if ((_objectChangeFlags & ObjectChangeFlags.NonDefaultDataDescriptorUsage) != 0)
  87. {
  88. // could be a mutating property for example, length might change, not safe anymore
  89. return false;
  90. }
  91. if (_prototype is not ArrayPrototype arrayPrototype
  92. || !ReferenceEquals(_prototype, _engine.Realm.Intrinsics.Array.PrototypeObject))
  93. {
  94. // somebody has switched prototype
  95. return false;
  96. }
  97. if ((arrayPrototype._objectChangeFlags & ObjectChangeFlags.ArrayIndex) != 0)
  98. {
  99. // maybe somebody moved integer property to prototype? not safe anymore
  100. return false;
  101. }
  102. if (arrayPrototype.Prototype is not ObjectPrototype arrayPrototypePrototype
  103. || !ReferenceEquals(arrayPrototypePrototype, _engine.Realm.Intrinsics.Array.PrototypeObject.Prototype))
  104. {
  105. return false;
  106. }
  107. return (arrayPrototypePrototype._objectChangeFlags & ObjectChangeFlags.ArrayIndex) == 0;
  108. }
  109. }
  110. public sealed override bool DefineOwnProperty(JsValue property, PropertyDescriptor desc)
  111. {
  112. var isArrayIndex = IsArrayIndex(property, out var index);
  113. TrackChanges(property, desc, isArrayIndex);
  114. if (isArrayIndex)
  115. {
  116. return DefineOwnProperty(index, desc);
  117. }
  118. if (property == CommonProperties.Length)
  119. {
  120. var value = desc.Value;
  121. if (ReferenceEquals(value, null))
  122. {
  123. return base.DefineOwnProperty(CommonProperties.Length, desc);
  124. }
  125. var newLenDesc = new PropertyDescriptor(desc);
  126. uint newLen = TypeConverter.ToUint32(value);
  127. if (newLen != TypeConverter.ToNumber(value))
  128. {
  129. ExceptionHelper.ThrowRangeError(_engine.Realm);
  130. }
  131. var oldLenDesc = _length;
  132. var oldLen = (uint) TypeConverter.ToNumber(oldLenDesc!.Value);
  133. newLenDesc.Value = newLen;
  134. if (newLen >= oldLen)
  135. {
  136. return base.DefineOwnProperty(CommonProperties.Length, newLenDesc);
  137. }
  138. if (!oldLenDesc.Writable)
  139. {
  140. return false;
  141. }
  142. bool newWritable;
  143. if (!newLenDesc.WritableSet || newLenDesc.Writable)
  144. {
  145. newWritable = true;
  146. }
  147. else
  148. {
  149. newWritable = false;
  150. newLenDesc.Writable = true;
  151. }
  152. var succeeded = base.DefineOwnProperty(CommonProperties.Length, newLenDesc);
  153. if (!succeeded)
  154. {
  155. return false;
  156. }
  157. var count = _dense?.Length ?? _sparse!.Count;
  158. if (count < oldLen - newLen)
  159. {
  160. if (_dense != null)
  161. {
  162. for (uint keyIndex = 0; keyIndex < _dense.Length; ++keyIndex)
  163. {
  164. if (_dense[keyIndex] == null)
  165. {
  166. continue;
  167. }
  168. // is it the index of the array
  169. if (keyIndex >= newLen && keyIndex < oldLen)
  170. {
  171. var deleteSucceeded = Delete(keyIndex);
  172. if (!deleteSucceeded)
  173. {
  174. newLenDesc.Value = keyIndex + 1;
  175. if (!newWritable)
  176. {
  177. newLenDesc.Writable = false;
  178. }
  179. base.DefineOwnProperty(CommonProperties.Length, newLenDesc);
  180. return false;
  181. }
  182. }
  183. }
  184. }
  185. else
  186. {
  187. // in the case of sparse arrays, treat each concrete element instead of
  188. // iterating over all indexes
  189. var keys = new List<uint>(_sparse!.Keys);
  190. var keysCount = keys.Count;
  191. for (var i = 0; i < keysCount; i++)
  192. {
  193. var keyIndex = keys[i];
  194. // is it the index of the array
  195. if (keyIndex >= newLen && keyIndex < oldLen)
  196. {
  197. var deleteSucceeded = Delete(TypeConverter.ToString(keyIndex));
  198. if (!deleteSucceeded)
  199. {
  200. newLenDesc.Value = JsNumber.Create(keyIndex + 1);
  201. if (!newWritable)
  202. {
  203. newLenDesc.Writable = false;
  204. }
  205. base.DefineOwnProperty(CommonProperties.Length, newLenDesc);
  206. return false;
  207. }
  208. }
  209. }
  210. }
  211. }
  212. else
  213. {
  214. while (newLen < oldLen)
  215. {
  216. // algorithm as per the spec
  217. oldLen--;
  218. var deleteSucceeded = Delete(oldLen);
  219. if (!deleteSucceeded)
  220. {
  221. newLenDesc.Value = oldLen + 1;
  222. if (!newWritable)
  223. {
  224. newLenDesc.Writable = false;
  225. }
  226. base.DefineOwnProperty(CommonProperties.Length, newLenDesc);
  227. return false;
  228. }
  229. }
  230. }
  231. if (!newWritable)
  232. {
  233. base.DefineOwnProperty(CommonProperties.Length, new PropertyDescriptor(value: null, PropertyFlag.WritableSet));
  234. }
  235. return true;
  236. }
  237. return base.DefineOwnProperty(property, desc);
  238. }
  239. private bool DefineOwnProperty(uint index, PropertyDescriptor desc)
  240. {
  241. var oldLenDesc = _length;
  242. var oldLen = (uint) TypeConverter.ToNumber(oldLenDesc!.Value);
  243. if (index >= oldLen && !oldLenDesc.Writable)
  244. {
  245. return false;
  246. }
  247. var succeeded = base.DefineOwnProperty(index, desc);
  248. if (!succeeded)
  249. {
  250. return false;
  251. }
  252. if (index >= oldLen)
  253. {
  254. oldLenDesc.Value = index + 1;
  255. base.DefineOwnProperty(CommonProperties.Length, oldLenDesc);
  256. }
  257. return true;
  258. }
  259. [MethodImpl(MethodImplOptions.AggressiveInlining)]
  260. internal uint GetLength()
  261. {
  262. if (_length is null)
  263. {
  264. return 0;
  265. }
  266. return (uint) ((JsNumber) _length._value!)._value;
  267. }
  268. protected sealed override void AddProperty(JsValue property, PropertyDescriptor descriptor)
  269. {
  270. if (property == CommonProperties.Length)
  271. {
  272. _length = descriptor;
  273. return;
  274. }
  275. base.AddProperty(property, descriptor);
  276. }
  277. protected sealed override bool TryGetProperty(JsValue property, [NotNullWhen(true)] out PropertyDescriptor? descriptor)
  278. {
  279. if (property == CommonProperties.Length)
  280. {
  281. descriptor = _length;
  282. return _length != null;
  283. }
  284. return base.TryGetProperty(property, out descriptor);
  285. }
  286. public sealed override List<JsValue> GetOwnPropertyKeys(Types types = Types.None | Types.String | Types.Symbol)
  287. {
  288. if ((types & Types.String) == 0)
  289. {
  290. return base.GetOwnPropertyKeys(types);
  291. }
  292. var temp = _dense;
  293. var properties = new List<JsValue>(temp?.Length ?? 0 + 1);
  294. if (temp != null)
  295. {
  296. var length = System.Math.Min(temp.Length, GetLength());
  297. for (var i = 0; i < length; i++)
  298. {
  299. if (temp[i] != null)
  300. {
  301. properties.Add(JsString.Create(i));
  302. }
  303. }
  304. }
  305. else
  306. {
  307. foreach (var entry in _sparse!)
  308. {
  309. properties.Add(JsString.Create(entry.Key));
  310. }
  311. }
  312. if (_length != null)
  313. {
  314. properties.Add(CommonProperties.Length);
  315. }
  316. properties.AddRange(base.GetOwnPropertyKeys(types));
  317. return properties;
  318. }
  319. /// <summary>
  320. /// Returns key and value pairs for actual array entries, excludes parent and optionally length.
  321. /// </summary>
  322. /// <param name="includeLength">Whether to return length and it's value.</param>
  323. public IEnumerable<KeyValuePair<string, JsValue>> GetEntries(bool includeLength = false)
  324. {
  325. foreach (var (index, value) in this.Enumerate())
  326. {
  327. yield return new KeyValuePair<string, JsValue>(TypeConverter.ToString(index), value);
  328. }
  329. if (includeLength && _length != null)
  330. {
  331. yield return new KeyValuePair<string, JsValue>(CommonProperties.Length._value, _length.Value);
  332. }
  333. }
  334. public sealed override IEnumerable<KeyValuePair<JsValue, PropertyDescriptor>> GetOwnProperties()
  335. {
  336. var temp = _dense;
  337. if (temp != null)
  338. {
  339. var length = System.Math.Min(temp.Length, GetLength());
  340. for (var i = 0; i < length; i++)
  341. {
  342. var value = temp[i];
  343. if (value != null)
  344. {
  345. if (value is not PropertyDescriptor descriptor)
  346. {
  347. temp[i] = descriptor = new PropertyDescriptor((JsValue) value, PropertyFlag.ConfigurableEnumerableWritable);
  348. }
  349. yield return new KeyValuePair<JsValue, PropertyDescriptor>(TypeConverter.ToString(i), descriptor);
  350. }
  351. }
  352. }
  353. else
  354. {
  355. foreach (var entry in _sparse!)
  356. {
  357. var value = entry.Value;
  358. if (value is not null)
  359. {
  360. if (value is not PropertyDescriptor descriptor)
  361. {
  362. _sparse[entry.Key] = descriptor = new PropertyDescriptor((JsValue) value, PropertyFlag.ConfigurableEnumerableWritable);
  363. }
  364. yield return new KeyValuePair<JsValue, PropertyDescriptor>(TypeConverter.ToString(entry.Key), descriptor);
  365. }
  366. }
  367. }
  368. if (_length != null)
  369. {
  370. yield return new KeyValuePair<JsValue, PropertyDescriptor>(CommonProperties.Length, _length);
  371. }
  372. foreach (var entry in base.GetOwnProperties())
  373. {
  374. yield return entry;
  375. }
  376. }
  377. public sealed override PropertyDescriptor GetOwnProperty(JsValue property)
  378. {
  379. if (property == CommonProperties.Length)
  380. {
  381. return _length ?? PropertyDescriptor.Undefined;
  382. }
  383. if (IsArrayIndex(property, out var index))
  384. {
  385. if (TryGetDescriptor(index, out var result))
  386. {
  387. return result;
  388. }
  389. return PropertyDescriptor.Undefined;
  390. }
  391. return base.GetOwnProperty(property);
  392. }
  393. internal JsValue Get(uint index)
  394. {
  395. if (!TryGetValue(index, out var value))
  396. {
  397. value = UnwrapJsValue(Prototype?.GetProperty(JsString.Create(index)) ?? PropertyDescriptor.Undefined);
  398. }
  399. return value;
  400. }
  401. public sealed override JsValue Get(JsValue property, JsValue receiver)
  402. {
  403. if (IsSafeSelfTarget(receiver) && IsArrayIndex(property, out var index) && TryGetValue(index, out var value))
  404. {
  405. return value;
  406. }
  407. return base.Get(property, receiver);
  408. }
  409. public sealed override bool Set(JsValue property, JsValue value, JsValue receiver)
  410. {
  411. var isSafeSelfTarget = IsSafeSelfTarget(receiver);
  412. if (isSafeSelfTarget && IsArrayIndex(property, out var index))
  413. {
  414. if (TryGetDescriptor(index, out var descriptor))
  415. {
  416. if (descriptor.IsDefaultArrayValueDescriptor())
  417. {
  418. // fast path with direct write without allocations
  419. descriptor.Value = value;
  420. return true;
  421. }
  422. }
  423. else if (CanUseFastAccess)
  424. {
  425. // we know it's to be written to own array backing field as new value
  426. SetIndexValue(index, value, true);
  427. return true;
  428. }
  429. }
  430. // slow path
  431. return base.Set(property, value, receiver);
  432. }
  433. private bool IsSafeSelfTarget(JsValue receiver) => ReferenceEquals(receiver, this) && Extensible;
  434. public sealed override bool HasProperty(JsValue property)
  435. {
  436. if (IsArrayIndex(property, out var index) && GetValue(index, unwrapFromNonDataDescriptor: false) is not null)
  437. {
  438. return true;
  439. }
  440. return base.HasProperty(property);
  441. }
  442. protected internal sealed override void SetOwnProperty(JsValue property, PropertyDescriptor desc)
  443. {
  444. var isArrayIndex = IsArrayIndex(property, out var index);
  445. TrackChanges(property, desc, isArrayIndex);
  446. if (isArrayIndex)
  447. {
  448. WriteArrayValue(index, desc);
  449. }
  450. else if (property == CommonProperties.Length)
  451. {
  452. _length = desc;
  453. }
  454. else
  455. {
  456. base.SetOwnProperty(property, desc);
  457. }
  458. }
  459. private void TrackChanges(JsValue property, PropertyDescriptor desc, bool isArrayIndex)
  460. {
  461. EnsureInitialized();
  462. if (isArrayIndex)
  463. {
  464. if (!desc.IsDefaultArrayValueDescriptor())
  465. {
  466. _objectChangeFlags |= ObjectChangeFlags.NonDefaultDataDescriptorUsage;
  467. }
  468. _objectChangeFlags |= ObjectChangeFlags.ArrayIndex;
  469. }
  470. else
  471. {
  472. _objectChangeFlags |= property.IsSymbol() ? ObjectChangeFlags.Symbol : ObjectChangeFlags.Property;
  473. }
  474. }
  475. public sealed override void RemoveOwnProperty(JsValue p)
  476. {
  477. if (IsArrayIndex(p, out var index))
  478. {
  479. Delete(index);
  480. }
  481. if (p == CommonProperties.Length)
  482. {
  483. _length = null;
  484. }
  485. base.RemoveOwnProperty(p);
  486. }
  487. [MethodImpl(MethodImplOptions.AggressiveInlining)]
  488. internal static bool IsArrayIndex(JsValue p, out uint index)
  489. {
  490. if (p is JsNumber number)
  491. {
  492. var value = number._value;
  493. var intValue = (uint) value;
  494. index = intValue;
  495. return value == intValue && intValue != uint.MaxValue;
  496. }
  497. index = ParseArrayIndex(p.ToString());
  498. return index != uint.MaxValue;
  499. // 15.4 - Use an optimized version of the specification
  500. // return TypeConverter.ToString(index) == TypeConverter.ToString(p) && index != uint.MaxValue;
  501. }
  502. internal static uint ParseArrayIndex(string p)
  503. {
  504. if (p.Length == 0)
  505. {
  506. return uint.MaxValue;
  507. }
  508. if (p.Length > 1 && p[0] == '0')
  509. {
  510. // If p is a number that start with '0' and is not '0' then
  511. // its ToString representation can't be the same a p. This is
  512. // not a valid array index. '01' !== ToString(ToUInt32('01'))
  513. // http://www.ecma-international.org/ecma-262/5.1/#sec-15.4
  514. return uint.MaxValue;
  515. }
  516. if (!uint.TryParse(p, out var d))
  517. {
  518. return uint.MaxValue;
  519. }
  520. return d;
  521. }
  522. [MethodImpl(MethodImplOptions.AggressiveInlining)]
  523. internal void SetIndexValue(uint index, JsValue? value, bool updateLength)
  524. {
  525. if (updateLength)
  526. {
  527. EnsureCorrectLength(index);
  528. }
  529. WriteArrayValue(index, value);
  530. }
  531. [MethodImpl(MethodImplOptions.AggressiveInlining)]
  532. private void EnsureCorrectLength(uint index)
  533. {
  534. var length = GetLength();
  535. if (index >= length)
  536. {
  537. SetLength(index + 1);
  538. }
  539. }
  540. [MethodImpl(MethodImplOptions.AggressiveInlining)]
  541. internal void SetLength(ulong length)
  542. {
  543. var number = JsNumber.Create(length);
  544. if (Extensible && _length!._flags == PropertyFlag.OnlyWritable)
  545. {
  546. _length!.Value = number;
  547. }
  548. else
  549. {
  550. // slow path
  551. Set(CommonProperties.Length, number, true);
  552. }
  553. }
  554. internal uint GetSmallestIndex()
  555. {
  556. if (_dense != null)
  557. {
  558. return 0;
  559. }
  560. uint smallest = 0;
  561. // only try to help if collection reasonable small
  562. if (_sparse!.Count > 0 && _sparse.Count < 100 && !_sparse.ContainsKey(0))
  563. {
  564. smallest = uint.MaxValue;
  565. foreach (var key in _sparse.Keys)
  566. {
  567. smallest = System.Math.Min(key, smallest);
  568. }
  569. }
  570. return smallest;
  571. }
  572. internal bool DeletePropertyOrThrow(uint index)
  573. {
  574. if (!Delete(index))
  575. {
  576. ExceptionHelper.ThrowTypeError(_engine.Realm);
  577. }
  578. return true;
  579. }
  580. internal bool Delete(uint index)
  581. {
  582. // check fast path
  583. var temp = _dense;
  584. if (temp != null)
  585. {
  586. if (index < (uint) temp.Length)
  587. {
  588. var value = temp[index];
  589. if (value is JsValue || value is PropertyDescriptor { Configurable: true })
  590. {
  591. temp[index] = null;
  592. return true;
  593. }
  594. }
  595. }
  596. if (!TryGetDescriptor(index, out var desc))
  597. {
  598. return true;
  599. }
  600. if (desc.Configurable)
  601. {
  602. DeleteAt(index);
  603. return true;
  604. }
  605. return false;
  606. }
  607. internal bool DeleteAt(uint index)
  608. {
  609. var temp = _dense;
  610. if (temp != null)
  611. {
  612. if (index < (uint) temp.Length)
  613. {
  614. temp[index] = null;
  615. return true;
  616. }
  617. }
  618. else
  619. {
  620. return _sparse!.Remove(index);
  621. }
  622. return false;
  623. }
  624. private bool TryGetDescriptor(uint index, [NotNullWhen(true)] out PropertyDescriptor? descriptor)
  625. {
  626. descriptor = null;
  627. var temp = _dense;
  628. if (temp != null)
  629. {
  630. if (index < (uint) temp.Length)
  631. {
  632. var value = temp[index];
  633. if (value is JsValue jsValue)
  634. {
  635. temp[index] = descriptor = new PropertyDescriptor(jsValue, PropertyFlag.ConfigurableEnumerableWritable);
  636. }
  637. else if (value is PropertyDescriptor propertyDescriptor)
  638. {
  639. descriptor = propertyDescriptor;
  640. }
  641. }
  642. return descriptor != null;
  643. }
  644. if (_sparse!.TryGetValue(index, out var sparseValue))
  645. {
  646. if (sparseValue is JsValue jsValue)
  647. {
  648. _sparse[index] = descriptor = new PropertyDescriptor(jsValue, PropertyFlag.ConfigurableEnumerableWritable);
  649. }
  650. else if (sparseValue is PropertyDescriptor propertyDescriptor)
  651. {
  652. descriptor = propertyDescriptor;
  653. }
  654. }
  655. return descriptor is not null;
  656. }
  657. internal bool TryGetValue(uint index, out JsValue value)
  658. {
  659. value = GetValue(index, unwrapFromNonDataDescriptor: true)!;
  660. if (value is not null)
  661. {
  662. return true;
  663. }
  664. if (!CanUseFastAccess)
  665. {
  666. // slow path must be checked for prototype
  667. var prototype = Prototype;
  668. JsValue key = index;
  669. while (prototype is not null)
  670. {
  671. var desc = prototype.GetOwnProperty(key);
  672. if (desc != PropertyDescriptor.Undefined)
  673. {
  674. value = UnwrapJsValue(desc);
  675. return true;
  676. }
  677. prototype = prototype.Prototype;
  678. }
  679. }
  680. value = Undefined;
  681. return false;
  682. }
  683. private JsValue? GetValue(uint index, bool unwrapFromNonDataDescriptor)
  684. {
  685. object? value = null;
  686. var temp = _dense;
  687. if (temp != null)
  688. {
  689. if (index < (uint) temp.Length)
  690. {
  691. value = temp[index];
  692. }
  693. }
  694. else
  695. {
  696. _sparse!.TryGetValue(index, out value);
  697. }
  698. if (value is JsValue jsValue)
  699. {
  700. return jsValue;
  701. }
  702. if (value is PropertyDescriptor propertyDescriptor)
  703. {
  704. return propertyDescriptor.IsDataDescriptor() || unwrapFromNonDataDescriptor ? UnwrapJsValue(propertyDescriptor) : null;
  705. }
  706. return null;
  707. }
  708. [MethodImpl(MethodImplOptions.AggressiveInlining)]
  709. internal void WriteArrayValue(uint index, object? value)
  710. {
  711. var dense = _dense;
  712. if (dense != null && index < (uint) dense.Length)
  713. {
  714. dense[index] = value;
  715. }
  716. else
  717. {
  718. WriteArrayValueUnlikely(index, value);
  719. }
  720. }
  721. private void WriteArrayValueUnlikely(uint index, object? value)
  722. {
  723. // calculate eagerly so we know if we outgrow
  724. var dense = _dense;
  725. var newSize = dense != null && index >= (uint) dense.Length
  726. ? System.Math.Max(index, System.Math.Max(dense.Length, 2)) * 2
  727. : 0;
  728. var canUseDense = dense != null
  729. && index < MaxDenseArrayLength
  730. && newSize < MaxDenseArrayLength
  731. && index < dense.Length + 50; // looks sparse
  732. if (canUseDense)
  733. {
  734. EnsureCapacity((uint) newSize);
  735. _dense![index] = value;
  736. }
  737. else
  738. {
  739. if (dense != null)
  740. {
  741. ConvertToSparse();
  742. }
  743. _sparse![index] = value;
  744. }
  745. }
  746. private void ConvertToSparse()
  747. {
  748. _sparse = new Dictionary<uint, object?>(_dense!.Length <= 1024 ? _dense.Length : 0);
  749. // need to move data
  750. for (uint i = 0; i < (uint) _dense.Length; ++i)
  751. {
  752. if (_dense[i] != null)
  753. {
  754. _sparse[i] = _dense[i];
  755. }
  756. }
  757. _dense = null;
  758. }
  759. internal void EnsureCapacity(uint capacity)
  760. {
  761. if (capacity > MaxDenseArrayLength || _dense is null || capacity <= (uint) _dense.Length)
  762. {
  763. return;
  764. }
  765. if (capacity > _engine.Options.Constraints.MaxArraySize)
  766. {
  767. ThrowMaximumArraySizeReachedException(_engine, capacity);
  768. }
  769. // need to grow
  770. var newArray = new object[capacity];
  771. System.Array.Copy(_dense, newArray, _dense.Length);
  772. _dense = newArray;
  773. }
  774. public JsValue[] ToArray()
  775. {
  776. var length = GetLength();
  777. var array = new JsValue[length];
  778. for (uint i = 0; i < length; i++)
  779. {
  780. TryGetValue(i, out var outValue);
  781. array[i] = outValue;
  782. }
  783. return array;
  784. }
  785. IEnumerator IEnumerable.GetEnumerator()
  786. {
  787. return GetEnumerator();
  788. }
  789. public IEnumerator<JsValue> GetEnumerator()
  790. {
  791. foreach (var (_, value) in this.Enumerate())
  792. {
  793. yield return value;
  794. }
  795. }
  796. private readonly record struct IndexedEntry(int Index, JsValue Value);
  797. private IEnumerable<IndexedEntry> Enumerate()
  798. {
  799. if (!CanUseFastAccess)
  800. {
  801. // slow path where prototype is also checked
  802. var length = GetLength();
  803. for (uint i = 0; i < length; i++)
  804. {
  805. TryGetValue(i, out var outValue);
  806. yield return new IndexedEntry((int) i, outValue);
  807. }
  808. yield break;
  809. }
  810. var temp = _dense;
  811. if (temp != null)
  812. {
  813. var length = System.Math.Min(temp.Length, GetLength());
  814. for (var i = 0; i < length; i++)
  815. {
  816. var value = temp[i];
  817. if (value != null)
  818. {
  819. if (value is not PropertyDescriptor descriptor)
  820. {
  821. yield return new IndexedEntry(i, (JsValue) value);
  822. }
  823. else
  824. {
  825. yield return new IndexedEntry(i, descriptor.Value);
  826. }
  827. }
  828. }
  829. }
  830. else
  831. {
  832. foreach (var entry in _sparse!)
  833. {
  834. var value = entry.Value;
  835. if (value is not null)
  836. {
  837. if (value is not PropertyDescriptor descriptor)
  838. {
  839. yield return new IndexedEntry((int) entry.Key, (JsValue) value);
  840. }
  841. else
  842. {
  843. yield return new IndexedEntry((int) entry.Key, descriptor.Value);
  844. }
  845. }
  846. }
  847. }
  848. }
  849. /// <summary>
  850. /// Pushes the value to the end of the array instance.
  851. /// </summary>
  852. public void Push(JsValue value)
  853. {
  854. var initialLength = GetLength();
  855. var newLength = initialLength + 1;
  856. var temp = _dense;
  857. var canUseDirectIndexSet = temp != null && newLength <= temp.Length;
  858. double n = initialLength;
  859. var desc = new PropertyDescriptor(value, PropertyFlag.ConfigurableEnumerableWritable);
  860. if (canUseDirectIndexSet)
  861. {
  862. temp![(uint) n] = desc;
  863. }
  864. else
  865. {
  866. WriteValueSlow(n, desc);
  867. }
  868. // check if we can set length fast without breaking ECMA specification
  869. if (n < uint.MaxValue && CanSetLength())
  870. {
  871. _length!.Value = newLength;
  872. }
  873. else
  874. {
  875. if (!Set(CommonProperties.Length, newLength))
  876. {
  877. ExceptionHelper.ThrowTypeError(_engine.Realm);
  878. }
  879. }
  880. }
  881. /// <summary>
  882. /// Pushes the given values to the end of the array.
  883. /// </summary>
  884. public uint Push(JsValue[] values)
  885. {
  886. var initialLength = GetLength();
  887. var newLength = initialLength + values.Length;
  888. // if we see that we are bringing more than normal growth algorithm handles, ensure capacity eagerly
  889. if (_dense != null
  890. && initialLength != 0
  891. && values.Length > initialLength * 2
  892. && newLength <= MaxDenseArrayLength)
  893. {
  894. EnsureCapacity((uint) newLength);
  895. }
  896. var temp = _dense;
  897. ulong n = initialLength;
  898. foreach (var argument in values)
  899. {
  900. if (n < ArrayOperations.MaxArrayLength)
  901. {
  902. WriteArrayValue((uint) n, argument);
  903. }
  904. else
  905. {
  906. DefineOwnProperty(n, new PropertyDescriptor(argument, PropertyFlag.ConfigurableEnumerableWritable));
  907. }
  908. n++;
  909. }
  910. // check if we can set length fast without breaking ECMA specification
  911. if (n < ArrayOperations.MaxArrayLength && CanSetLength())
  912. {
  913. _length!.Value = n;
  914. }
  915. else
  916. {
  917. if (!Set(CommonProperties.Length, newLength))
  918. {
  919. ExceptionHelper.ThrowTypeError(_engine.Realm);
  920. }
  921. }
  922. return (uint) n;
  923. }
  924. private bool CanSetLength()
  925. {
  926. if (!_length!.IsAccessorDescriptor())
  927. {
  928. return _length.Writable;
  929. }
  930. var set = _length.Set;
  931. return set is not null && !set.IsUndefined();
  932. }
  933. [MethodImpl(MethodImplOptions.NoInlining)]
  934. private void WriteValueSlow(double n, PropertyDescriptor desc)
  935. {
  936. if (n < uint.MaxValue)
  937. {
  938. WriteArrayValue((uint) n, desc);
  939. }
  940. else
  941. {
  942. DefinePropertyOrThrow((uint) n, desc);
  943. }
  944. }
  945. internal JsArray Map(JsValue[] arguments)
  946. {
  947. var callbackfn = arguments.At(0);
  948. var thisArg = arguments.At(1);
  949. var len = GetLength();
  950. var callable = GetCallable(callbackfn);
  951. var a = Engine.Realm.Intrinsics.Array.ArrayCreate(len);
  952. var args = _engine._jsValueArrayPool.RentArray(3);
  953. args[2] = this;
  954. for (uint k = 0; k < len; k++)
  955. {
  956. if (TryGetValue(k, out var kvalue))
  957. {
  958. args[0] = kvalue;
  959. args[1] = k;
  960. var mappedValue = callable.Call(thisArg, args);
  961. if (a._dense != null && k < (uint) a._dense.Length)
  962. {
  963. a._dense[k] = mappedValue;
  964. }
  965. else
  966. {
  967. a.WriteArrayValue(k, mappedValue);
  968. }
  969. }
  970. }
  971. _engine._jsValueArrayPool.ReturnArray(args);
  972. return a;
  973. }
  974. /// <inheritdoc />
  975. internal sealed override bool FindWithCallback(
  976. JsValue[] arguments,
  977. out uint index,
  978. out JsValue value,
  979. bool visitUnassigned,
  980. bool fromEnd = false)
  981. {
  982. var thisArg = arguments.At(1);
  983. var callbackfn = arguments.At(0);
  984. var callable = GetCallable(callbackfn);
  985. var len = GetLength();
  986. if (len == 0)
  987. {
  988. index = 0;
  989. value = Undefined;
  990. return false;
  991. }
  992. var args = _engine._jsValueArrayPool.RentArray(3);
  993. args[2] = this;
  994. if (!fromEnd)
  995. {
  996. for (uint k = 0; k < len; k++)
  997. {
  998. if (TryGetValue(k, out var kvalue) || visitUnassigned)
  999. {
  1000. kvalue ??= Undefined;
  1001. args[0] = kvalue;
  1002. args[1] = k;
  1003. var testResult = callable.Call(thisArg, args);
  1004. if (TypeConverter.ToBoolean(testResult))
  1005. {
  1006. index = k;
  1007. value = kvalue;
  1008. return true;
  1009. }
  1010. }
  1011. }
  1012. }
  1013. else
  1014. {
  1015. for (long k = len - 1; k >= 0; k--)
  1016. {
  1017. var idx = (uint) k;
  1018. if (TryGetValue(idx, out var kvalue) || visitUnassigned)
  1019. {
  1020. kvalue ??= Undefined;
  1021. args[0] = kvalue;
  1022. args[1] = idx;
  1023. var testResult = callable.Call(thisArg, args);
  1024. if (TypeConverter.ToBoolean(testResult))
  1025. {
  1026. index = idx;
  1027. value = kvalue;
  1028. return true;
  1029. }
  1030. }
  1031. }
  1032. }
  1033. _engine._jsValueArrayPool.ReturnArray(args);
  1034. index = 0;
  1035. value = Undefined;
  1036. return false;
  1037. }
  1038. public sealed override uint Length => GetLength();
  1039. internal sealed override bool IsIntegerIndexedArray => true;
  1040. public JsValue this[uint index]
  1041. {
  1042. get
  1043. {
  1044. TryGetValue(index, out var kValue);
  1045. return kValue;
  1046. }
  1047. }
  1048. public JsValue this[int index]
  1049. {
  1050. get
  1051. {
  1052. JsValue? kValue;
  1053. if (index >= 0)
  1054. {
  1055. TryGetValue((uint) index, out kValue);
  1056. }
  1057. else
  1058. {
  1059. // slow path
  1060. TryGetValue(JsNumber.Create(index), out kValue);
  1061. }
  1062. return kValue;
  1063. }
  1064. }
  1065. /// <summary>
  1066. /// Fast path for concatenating sane-sized arrays, we assume size has been calculated.
  1067. /// </summary>
  1068. internal void CopyValues(JsArray source, uint sourceStartIndex, uint targetStartIndex, uint length)
  1069. {
  1070. if (length == 0)
  1071. {
  1072. return;
  1073. }
  1074. var sourceDense = source._dense;
  1075. if (sourceDense is not null)
  1076. {
  1077. EnsureCapacity((uint) (targetStartIndex + sourceDense.LongLength));
  1078. }
  1079. var dense = _dense;
  1080. if (dense != null && sourceDense != null
  1081. && (uint) dense.Length >= targetStartIndex + length
  1082. && dense[targetStartIndex] is null)
  1083. {
  1084. uint j = 0;
  1085. for (var i = sourceStartIndex; i < sourceStartIndex + length; ++i, j++)
  1086. {
  1087. object? sourceValue;
  1088. if (i < (uint) sourceDense.Length && sourceDense[i] != null)
  1089. {
  1090. sourceValue = sourceDense[i];
  1091. if (sourceValue is PropertyDescriptor propertyDescriptor)
  1092. {
  1093. sourceValue = UnwrapJsValue(propertyDescriptor);
  1094. }
  1095. }
  1096. else
  1097. {
  1098. if (!source.TryGetValue(i, out var temp))
  1099. {
  1100. sourceValue = source.Prototype?.Get(JsString.Create(i));
  1101. }
  1102. else
  1103. {
  1104. sourceValue = temp;
  1105. }
  1106. }
  1107. dense[targetStartIndex + j] = sourceValue;
  1108. }
  1109. }
  1110. else
  1111. {
  1112. // slower version
  1113. for (uint k = sourceStartIndex; k < length; k++)
  1114. {
  1115. if (source.TryGetValue(k, out var subElement))
  1116. {
  1117. SetIndexValue(targetStartIndex, subElement, updateLength: false);
  1118. }
  1119. targetStartIndex++;
  1120. }
  1121. }
  1122. }
  1123. public sealed override string ToString()
  1124. {
  1125. // debugger can make things hard when evaluates computed values
  1126. return "(" + (_length?._value!.AsNumber() ?? 0) + ")[]";
  1127. }
  1128. private static void ThrowMaximumArraySizeReachedException(Engine engine, uint capacity)
  1129. {
  1130. ExceptionHelper.ThrowMemoryLimitExceededException(
  1131. $"The array size {capacity} is larger than maximum allowed ({engine.Options.Constraints.MaxArraySize})"
  1132. );
  1133. }
  1134. }
  1135. internal static class ArrayPropertyDescriptorExtensions
  1136. {
  1137. [MethodImpl(MethodImplOptions.AggressiveInlining)]
  1138. internal static bool IsDefaultArrayValueDescriptor(this PropertyDescriptor propertyDescriptor)
  1139. => propertyDescriptor.Flags == PropertyFlag.ConfigurableEnumerableWritable && propertyDescriptor.IsDataDescriptor();
  1140. }
  1141. }