ArrayInstance.cs 45 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394
  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. var dense = _dense;
  818. if (dense is null)
  819. {
  820. return;
  821. }
  822. if (!force && (capacity > MaxDenseArrayLength || capacity <= (uint) dense.Length))
  823. {
  824. return;
  825. }
  826. if (capacity > _engine.Options.Constraints.MaxArraySize)
  827. {
  828. ThrowMaximumArraySizeReachedException(_engine, capacity);
  829. }
  830. // need to grow
  831. var newArray = new object[capacity];
  832. System.Array.Copy(dense, newArray, dense.Length);
  833. _dense = newArray;
  834. _isObjectArray = true;
  835. }
  836. public JsValue[] ToArray()
  837. {
  838. var length = GetLength();
  839. var array = new JsValue[length];
  840. for (uint i = 0; i < length; i++)
  841. {
  842. TryGetValue(i, out var outValue);
  843. array[i] = outValue;
  844. }
  845. return array;
  846. }
  847. IEnumerator IEnumerable.GetEnumerator()
  848. {
  849. return GetEnumerator();
  850. }
  851. public IEnumerator<JsValue> GetEnumerator()
  852. {
  853. foreach (var (_, value) in this.Enumerate())
  854. {
  855. yield return value;
  856. }
  857. }
  858. private readonly record struct IndexedEntry(int Index, JsValue Value);
  859. private IEnumerable<IndexedEntry> Enumerate()
  860. {
  861. if (!CanUseFastAccess)
  862. {
  863. // slow path where prototype is also checked
  864. var length = GetLength();
  865. for (uint i = 0; i < length; i++)
  866. {
  867. TryGetValue(i, out var outValue);
  868. yield return new IndexedEntry((int) i, outValue);
  869. }
  870. yield break;
  871. }
  872. var temp = _dense;
  873. if (temp != null)
  874. {
  875. var length = System.Math.Min(temp.Length, GetLength());
  876. for (var i = 0; i < length; i++)
  877. {
  878. var value = temp[i];
  879. if (value != null)
  880. {
  881. if (value is not PropertyDescriptor descriptor)
  882. {
  883. yield return new IndexedEntry(i, (JsValue) value);
  884. }
  885. else
  886. {
  887. yield return new IndexedEntry(i, descriptor.Value);
  888. }
  889. }
  890. }
  891. }
  892. else
  893. {
  894. foreach (var entry in _sparse!)
  895. {
  896. var value = entry.Value;
  897. if (value is not null)
  898. {
  899. if (value is not PropertyDescriptor descriptor)
  900. {
  901. yield return new IndexedEntry((int) entry.Key, (JsValue) value);
  902. }
  903. else
  904. {
  905. yield return new IndexedEntry((int) entry.Key, descriptor.Value);
  906. }
  907. }
  908. }
  909. }
  910. }
  911. /// <summary>
  912. /// Pushes the value to the end of the array instance.
  913. /// </summary>
  914. public void Push(JsValue value)
  915. {
  916. var initialLength = GetLength();
  917. var newLength = initialLength + 1;
  918. var temp = _dense;
  919. var canUseDirectIndexSet = temp != null && newLength <= temp.Length;
  920. double n = initialLength;
  921. if (canUseDirectIndexSet)
  922. {
  923. temp![(uint) n] = value;
  924. }
  925. else
  926. {
  927. WriteValueSlow(n, new PropertyDescriptor(value, PropertyFlag.ConfigurableEnumerableWritable));
  928. }
  929. // check if we can set length fast without breaking ECMA specification
  930. if (n < uint.MaxValue && CanSetLength())
  931. {
  932. _length!.Value = newLength;
  933. }
  934. else
  935. {
  936. if (!Set(CommonProperties.Length, newLength))
  937. {
  938. ExceptionHelper.ThrowTypeError(_engine.Realm);
  939. }
  940. }
  941. }
  942. /// <summary>
  943. /// Pushes the given values to the end of the array.
  944. /// </summary>
  945. public uint Push(JsValue[] values)
  946. {
  947. var initialLength = GetLength();
  948. var newLength = initialLength + values.Length;
  949. // if we see that we are bringing more than normal growth algorithm handles, ensure capacity eagerly
  950. if (_dense != null
  951. && initialLength != 0
  952. && values.Length > initialLength * 2
  953. && newLength <= MaxDenseArrayLength)
  954. {
  955. EnsureCapacity((uint) newLength);
  956. }
  957. var temp = _dense;
  958. ulong n = initialLength;
  959. foreach (var argument in values)
  960. {
  961. if (n < ArrayOperations.MaxArrayLength)
  962. {
  963. WriteArrayValue((uint) n, argument);
  964. }
  965. else
  966. {
  967. DefineOwnProperty(n, new PropertyDescriptor(argument, PropertyFlag.ConfigurableEnumerableWritable));
  968. }
  969. n++;
  970. }
  971. // check if we can set length fast without breaking ECMA specification
  972. if (n < ArrayOperations.MaxArrayLength && CanSetLength())
  973. {
  974. _length!.Value = n;
  975. }
  976. else
  977. {
  978. if (!Set(CommonProperties.Length, newLength))
  979. {
  980. ExceptionHelper.ThrowTypeError(_engine.Realm);
  981. }
  982. }
  983. return (uint) n;
  984. }
  985. private bool CanSetLength()
  986. {
  987. if (!_length!.IsAccessorDescriptor())
  988. {
  989. return _length.Writable;
  990. }
  991. var set = _length.Set;
  992. return set is not null && !set.IsUndefined();
  993. }
  994. [MethodImpl(MethodImplOptions.NoInlining)]
  995. private void WriteValueSlow(double n, PropertyDescriptor desc)
  996. {
  997. if (n < uint.MaxValue)
  998. {
  999. WriteArrayValue((uint) n, desc);
  1000. }
  1001. else
  1002. {
  1003. DefinePropertyOrThrow((uint) n, desc);
  1004. }
  1005. }
  1006. internal JsArray Map(JsValue[] arguments)
  1007. {
  1008. var callbackfn = arguments.At(0);
  1009. var thisArg = arguments.At(1);
  1010. var len = GetLength();
  1011. var callable = GetCallable(callbackfn);
  1012. var a = Engine.Realm.Intrinsics.Array.ArrayCreate(len);
  1013. var args = _engine._jsValueArrayPool.RentArray(3);
  1014. args[2] = this;
  1015. for (uint k = 0; k < len; k++)
  1016. {
  1017. if (TryGetValue(k, out var kvalue))
  1018. {
  1019. args[0] = kvalue;
  1020. args[1] = k;
  1021. var mappedValue = callable.Call(thisArg, args);
  1022. if (a._dense != null && k < (uint) a._dense.Length)
  1023. {
  1024. a._dense[k] = mappedValue;
  1025. }
  1026. else
  1027. {
  1028. a.WriteArrayValue(k, mappedValue);
  1029. }
  1030. }
  1031. }
  1032. _engine._jsValueArrayPool.ReturnArray(args);
  1033. return a;
  1034. }
  1035. /// <inheritdoc />
  1036. internal sealed override bool FindWithCallback(
  1037. JsValue[] arguments,
  1038. out ulong index,
  1039. out JsValue value,
  1040. bool visitUnassigned,
  1041. bool fromEnd = false)
  1042. {
  1043. var thisArg = arguments.At(1);
  1044. var callbackfn = arguments.At(0);
  1045. var callable = GetCallable(callbackfn);
  1046. var len = GetLength();
  1047. if (len == 0)
  1048. {
  1049. index = 0;
  1050. value = Undefined;
  1051. return false;
  1052. }
  1053. var args = _engine._jsValueArrayPool.RentArray(3);
  1054. args[2] = this;
  1055. if (!fromEnd)
  1056. {
  1057. for (uint k = 0; k < len; k++)
  1058. {
  1059. if (TryGetValue(k, out var kvalue) || visitUnassigned)
  1060. {
  1061. kvalue ??= Undefined;
  1062. args[0] = kvalue;
  1063. args[1] = k;
  1064. var testResult = callable.Call(thisArg, args);
  1065. if (TypeConverter.ToBoolean(testResult))
  1066. {
  1067. index = k;
  1068. value = kvalue;
  1069. return true;
  1070. }
  1071. }
  1072. }
  1073. }
  1074. else
  1075. {
  1076. for (long k = len - 1; k >= 0; k--)
  1077. {
  1078. var idx = (uint) k;
  1079. if (TryGetValue(idx, out var kvalue) || visitUnassigned)
  1080. {
  1081. kvalue ??= Undefined;
  1082. args[0] = kvalue;
  1083. args[1] = idx;
  1084. var testResult = callable.Call(thisArg, args);
  1085. if (TypeConverter.ToBoolean(testResult))
  1086. {
  1087. index = idx;
  1088. value = kvalue;
  1089. return true;
  1090. }
  1091. }
  1092. }
  1093. }
  1094. _engine._jsValueArrayPool.ReturnArray(args);
  1095. index = 0;
  1096. value = Undefined;
  1097. return false;
  1098. }
  1099. public sealed override uint Length => GetLength();
  1100. internal sealed override bool IsIntegerIndexedArray => true;
  1101. public JsValue this[uint index]
  1102. {
  1103. get
  1104. {
  1105. TryGetValue(index, out var kValue);
  1106. return kValue;
  1107. }
  1108. set
  1109. {
  1110. SetIndexValue(index, value, updateLength: true);
  1111. }
  1112. }
  1113. public JsValue this[int index]
  1114. {
  1115. get
  1116. {
  1117. JsValue? kValue;
  1118. if (index >= 0)
  1119. {
  1120. TryGetValue((uint) index, out kValue);
  1121. }
  1122. else
  1123. {
  1124. // slow path
  1125. TryGetValue(JsNumber.Create(index), out kValue);
  1126. }
  1127. return kValue;
  1128. }
  1129. set
  1130. {
  1131. if (index >= 0)
  1132. {
  1133. SetIndexValue((uint) index, value, updateLength: true);
  1134. }
  1135. else
  1136. {
  1137. Set(index, value);
  1138. }
  1139. }
  1140. }
  1141. /// <summary>
  1142. /// Fast path for concatenating sane-sized arrays, we assume size has been calculated.
  1143. /// </summary>
  1144. internal void CopyValues(JsArray source, uint sourceStartIndex, uint targetStartIndex, uint length)
  1145. {
  1146. if (length == 0)
  1147. {
  1148. return;
  1149. }
  1150. var sourceDense = source._dense;
  1151. if (sourceDense is not null)
  1152. {
  1153. EnsureCapacity((uint) (targetStartIndex + sourceDense.LongLength));
  1154. }
  1155. var dense = _dense;
  1156. if (dense != null && sourceDense != null
  1157. && (uint) dense.Length >= targetStartIndex + length
  1158. && dense[targetStartIndex] is null)
  1159. {
  1160. uint j = 0;
  1161. for (var i = sourceStartIndex; i < sourceStartIndex + length; ++i, j++)
  1162. {
  1163. object? sourceValue;
  1164. if (i < (uint) sourceDense.Length && sourceDense[i] != null)
  1165. {
  1166. sourceValue = sourceDense[i];
  1167. if (sourceValue is PropertyDescriptor propertyDescriptor)
  1168. {
  1169. sourceValue = UnwrapJsValue(propertyDescriptor);
  1170. }
  1171. }
  1172. else
  1173. {
  1174. if (!source.TryGetValue(i, out var temp))
  1175. {
  1176. sourceValue = source.Prototype?.Get(JsString.Create(i));
  1177. }
  1178. else
  1179. {
  1180. sourceValue = temp;
  1181. }
  1182. }
  1183. dense[targetStartIndex + j] = sourceValue;
  1184. }
  1185. }
  1186. else
  1187. {
  1188. // slower version
  1189. for (uint k = sourceStartIndex; k < length; k++)
  1190. {
  1191. if (source.TryGetValue(k, out var subElement))
  1192. {
  1193. SetIndexValue(targetStartIndex, subElement, updateLength: false);
  1194. }
  1195. targetStartIndex++;
  1196. }
  1197. }
  1198. }
  1199. public sealed override string ToString()
  1200. {
  1201. // debugger can make things hard when evaluates computed values
  1202. return "(" + (_length?._value!.AsNumber() ?? 0) + ")[]";
  1203. }
  1204. private static void ThrowMaximumArraySizeReachedException(Engine engine, uint capacity)
  1205. {
  1206. ExceptionHelper.ThrowMemoryLimitExceededException(
  1207. $"The array size {capacity} is larger than maximum allowed ({engine.Options.Constraints.MaxArraySize})"
  1208. );
  1209. }
  1210. }
  1211. internal static class ArrayPropertyDescriptorExtensions
  1212. {
  1213. [MethodImpl(MethodImplOptions.AggressiveInlining)]
  1214. internal static bool IsDefaultArrayValueDescriptor(this PropertyDescriptor propertyDescriptor)
  1215. => propertyDescriptor.Flags == PropertyFlag.ConfigurableEnumerableWritable && propertyDescriptor.IsDataDescriptor();
  1216. }
  1217. }