ArrayInstance.cs 45 KB

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