ArrayInstance.cs 44 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370
  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)
  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)
  42. {
  43. _prototype = engine.Realm.Intrinsics.Array.PrototypeObject;
  44. _isObjectArray = false;
  45. int length;
  46. if (items == null || items.Length == 0)
  47. {
  48. _dense = System.Array.Empty<object>();
  49. length = 0;
  50. }
  51. else
  52. {
  53. _dense = items;
  54. length = items.Length;
  55. }
  56. _length = new PropertyDescriptor(length, PropertyFlag.OnlyWritable);
  57. }
  58. private protected ArrayInstance(Engine engine, PropertyDescriptor[] items) : base(engine)
  59. {
  60. _prototype = engine.Realm.Intrinsics.Array.PrototypeObject;
  61. _isObjectArray = false;
  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. var temp = _dense;
  415. if (temp is not null && CanUseFastAccess)
  416. {
  417. var current = index < temp.Length ? temp[index] : null;
  418. if (current is not PropertyDescriptor p || p.IsDefaultArrayValueDescriptor())
  419. {
  420. SetIndexValue(index, value, true);
  421. return true;
  422. }
  423. }
  424. // slower and more allocating
  425. if (TryGetDescriptor(index, out var descriptor))
  426. {
  427. if (descriptor.IsDefaultArrayValueDescriptor())
  428. {
  429. // fast path with direct write without allocations
  430. descriptor.Value = value;
  431. return true;
  432. }
  433. }
  434. else if (CanUseFastAccess)
  435. {
  436. // we know it's to be written to own array backing field as new value
  437. SetIndexValue(index, value, true);
  438. return true;
  439. }
  440. }
  441. // slow path
  442. return base.Set(property, value, receiver);
  443. }
  444. private bool IsSafeSelfTarget(JsValue receiver) => ReferenceEquals(receiver, this) && Extensible;
  445. public sealed override bool HasProperty(JsValue property)
  446. {
  447. if (IsArrayIndex(property, out var index) && GetValue(index, unwrapFromNonDataDescriptor: false) is not null)
  448. {
  449. return true;
  450. }
  451. return base.HasProperty(property);
  452. }
  453. protected internal sealed override void SetOwnProperty(JsValue property, PropertyDescriptor desc)
  454. {
  455. var isArrayIndex = IsArrayIndex(property, out var index);
  456. TrackChanges(property, desc, isArrayIndex);
  457. if (isArrayIndex)
  458. {
  459. WriteArrayValue(index, desc);
  460. }
  461. else if (property == CommonProperties.Length)
  462. {
  463. _length = desc;
  464. }
  465. else
  466. {
  467. base.SetOwnProperty(property, desc);
  468. }
  469. }
  470. private void TrackChanges(JsValue property, PropertyDescriptor desc, bool isArrayIndex)
  471. {
  472. EnsureInitialized();
  473. if (isArrayIndex)
  474. {
  475. if (!desc.IsDefaultArrayValueDescriptor())
  476. {
  477. _objectChangeFlags |= ObjectChangeFlags.NonDefaultDataDescriptorUsage;
  478. }
  479. _objectChangeFlags |= ObjectChangeFlags.ArrayIndex;
  480. }
  481. else
  482. {
  483. _objectChangeFlags |= property.IsSymbol() ? ObjectChangeFlags.Symbol : ObjectChangeFlags.Property;
  484. }
  485. }
  486. public sealed override void RemoveOwnProperty(JsValue p)
  487. {
  488. if (IsArrayIndex(p, out var index))
  489. {
  490. Delete(index);
  491. }
  492. if (p == CommonProperties.Length)
  493. {
  494. _length = null;
  495. }
  496. base.RemoveOwnProperty(p);
  497. }
  498. [MethodImpl(MethodImplOptions.AggressiveInlining)]
  499. internal static bool IsArrayIndex(JsValue p, out uint index)
  500. {
  501. if (p is JsNumber number)
  502. {
  503. var value = number._value;
  504. var intValue = (uint) value;
  505. index = intValue;
  506. return value == intValue && intValue != uint.MaxValue;
  507. }
  508. index = ParseArrayIndex(p.ToString());
  509. return index != uint.MaxValue;
  510. // 15.4 - Use an optimized version of the specification
  511. // return TypeConverter.ToString(index) == TypeConverter.ToString(p) && index != uint.MaxValue;
  512. }
  513. internal static uint ParseArrayIndex(string p)
  514. {
  515. if (p.Length == 0)
  516. {
  517. return uint.MaxValue;
  518. }
  519. if (p.Length > 1 && p[0] == '0')
  520. {
  521. // If p is a number that start with '0' and is not '0' then
  522. // its ToString representation can't be the same a p. This is
  523. // not a valid array index. '01' !== ToString(ToUInt32('01'))
  524. // http://www.ecma-international.org/ecma-262/5.1/#sec-15.4
  525. return uint.MaxValue;
  526. }
  527. if (!uint.TryParse(p, out var d))
  528. {
  529. return uint.MaxValue;
  530. }
  531. return d;
  532. }
  533. [MethodImpl(MethodImplOptions.AggressiveInlining)]
  534. internal void SetIndexValue(uint index, JsValue? value, bool updateLength)
  535. {
  536. if (updateLength)
  537. {
  538. EnsureCorrectLength(index);
  539. }
  540. WriteArrayValue(index, value);
  541. }
  542. [MethodImpl(MethodImplOptions.AggressiveInlining)]
  543. private void EnsureCorrectLength(uint index)
  544. {
  545. var length = GetLength();
  546. if (index >= length)
  547. {
  548. SetLength(index + 1);
  549. }
  550. }
  551. [MethodImpl(MethodImplOptions.AggressiveInlining)]
  552. internal void SetLength(ulong length)
  553. {
  554. var number = JsNumber.Create(length);
  555. if (Extensible && _length!._flags == PropertyFlag.OnlyWritable)
  556. {
  557. _length!.Value = number;
  558. }
  559. else
  560. {
  561. // slow path
  562. Set(CommonProperties.Length, number, true);
  563. }
  564. }
  565. internal uint GetSmallestIndex()
  566. {
  567. if (_dense != null)
  568. {
  569. return 0;
  570. }
  571. uint smallest = 0;
  572. // only try to help if collection reasonable small
  573. if (_sparse!.Count > 0 && _sparse.Count < 100 && !_sparse.ContainsKey(0))
  574. {
  575. smallest = uint.MaxValue;
  576. foreach (var key in _sparse.Keys)
  577. {
  578. smallest = System.Math.Min(key, smallest);
  579. }
  580. }
  581. return smallest;
  582. }
  583. internal bool DeletePropertyOrThrow(uint index)
  584. {
  585. if (!Delete(index))
  586. {
  587. ExceptionHelper.ThrowTypeError(_engine.Realm);
  588. }
  589. return true;
  590. }
  591. internal bool Delete(uint index)
  592. {
  593. // check fast path
  594. var temp = _dense;
  595. if (temp != null)
  596. {
  597. if (index < (uint) temp.Length)
  598. {
  599. var value = temp[index];
  600. if (value is JsValue || value is PropertyDescriptor { Configurable: true })
  601. {
  602. temp[index] = null;
  603. return true;
  604. }
  605. }
  606. }
  607. if (!TryGetDescriptor(index, out var desc))
  608. {
  609. return true;
  610. }
  611. if (desc.Configurable)
  612. {
  613. DeleteAt(index);
  614. return true;
  615. }
  616. return false;
  617. }
  618. internal bool DeleteAt(uint index)
  619. {
  620. var temp = _dense;
  621. if (temp != null)
  622. {
  623. if (index < (uint) temp.Length)
  624. {
  625. temp[index] = null;
  626. return true;
  627. }
  628. }
  629. else
  630. {
  631. return _sparse!.Remove(index);
  632. }
  633. return false;
  634. }
  635. private bool TryGetDescriptor(uint index, [NotNullWhen(true)] out PropertyDescriptor? descriptor)
  636. {
  637. descriptor = null;
  638. var temp = _dense;
  639. if (temp != null)
  640. {
  641. if (index < (uint) temp.Length)
  642. {
  643. var value = temp[index];
  644. if (value is JsValue jsValue)
  645. {
  646. if (EnsureCompatibleDense(typeof(PropertyDescriptor)))
  647. {
  648. temp = _dense!;
  649. }
  650. temp[index] = descriptor = new PropertyDescriptor(jsValue, PropertyFlag.ConfigurableEnumerableWritable);
  651. }
  652. else if (value is PropertyDescriptor propertyDescriptor)
  653. {
  654. descriptor = propertyDescriptor;
  655. }
  656. }
  657. return descriptor != null;
  658. }
  659. if (_sparse!.TryGetValue(index, out var sparseValue))
  660. {
  661. if (sparseValue is JsValue jsValue)
  662. {
  663. _sparse[index] = descriptor = new PropertyDescriptor(jsValue, PropertyFlag.ConfigurableEnumerableWritable);
  664. }
  665. else if (sparseValue is PropertyDescriptor propertyDescriptor)
  666. {
  667. descriptor = propertyDescriptor;
  668. }
  669. }
  670. return descriptor is not null;
  671. }
  672. internal bool TryGetValue(uint index, out JsValue value)
  673. {
  674. value = GetValue(index, unwrapFromNonDataDescriptor: true)!;
  675. if (value is not null)
  676. {
  677. return true;
  678. }
  679. if (!CanUseFastAccess)
  680. {
  681. // slow path must be checked for prototype
  682. var prototype = Prototype;
  683. JsValue key = index;
  684. while (prototype is not null)
  685. {
  686. var desc = prototype.GetOwnProperty(key);
  687. if (desc != PropertyDescriptor.Undefined)
  688. {
  689. value = UnwrapJsValue(desc);
  690. return true;
  691. }
  692. prototype = prototype.Prototype;
  693. }
  694. }
  695. value = Undefined;
  696. return false;
  697. }
  698. private JsValue? GetValue(uint index, bool unwrapFromNonDataDescriptor)
  699. {
  700. object? value = null;
  701. var temp = _dense;
  702. if (temp != null)
  703. {
  704. if (index < (uint) temp.Length)
  705. {
  706. value = temp[index];
  707. }
  708. }
  709. else
  710. {
  711. _sparse!.TryGetValue(index, out value);
  712. }
  713. if (value is JsValue jsValue)
  714. {
  715. return jsValue;
  716. }
  717. if (value is PropertyDescriptor propertyDescriptor)
  718. {
  719. return propertyDescriptor.IsDataDescriptor() || unwrapFromNonDataDescriptor ? UnwrapJsValue(propertyDescriptor) : null;
  720. }
  721. return null;
  722. }
  723. [MethodImpl(MethodImplOptions.AggressiveInlining)]
  724. private void WriteArrayValue(uint index, object? value)
  725. {
  726. var dense = _dense;
  727. if (dense != null && index < (uint) dense.Length)
  728. {
  729. if (value is not null && !_isObjectArray && EnsureCompatibleDense(value is JsValue ? typeof(JsValue) : typeof(PropertyDescriptor)))
  730. {
  731. dense = _dense;
  732. }
  733. dense![index] = value;
  734. }
  735. else
  736. {
  737. WriteArrayValueUnlikely(index, value);
  738. }
  739. }
  740. private void WriteArrayValueUnlikely(uint index, object? value)
  741. {
  742. // calculate eagerly so we know if we outgrow
  743. var dense = _dense;
  744. var newSize = dense != null && index >= (uint) dense.Length
  745. ? System.Math.Max(index, System.Math.Max(dense.Length, 2)) * 2
  746. : 0;
  747. var canUseDense = dense != null
  748. && index < MaxDenseArrayLength
  749. && newSize < MaxDenseArrayLength
  750. && index < dense.Length + 50; // looks sparse
  751. if (canUseDense)
  752. {
  753. EnsureCapacity((uint) newSize);
  754. _dense![index] = value;
  755. }
  756. else
  757. {
  758. if (dense != null)
  759. {
  760. ConvertToSparse();
  761. }
  762. _sparse![index] = value;
  763. }
  764. }
  765. /// <summary>
  766. /// Converts to object array when needed. Returns true if conversion was made.
  767. /// </summary>
  768. private bool EnsureCompatibleDense(Type expectedElementType)
  769. {
  770. if (!_isObjectArray)
  771. {
  772. return CheckConversionUnlikely(expectedElementType);
  773. }
  774. return false;
  775. }
  776. private bool CheckConversionUnlikely(Type expectedElementType)
  777. {
  778. var currentElementType = _dense!.GetType().GetElementType();
  779. if (currentElementType != typeof(object) && !expectedElementType.IsAssignableFrom(currentElementType))
  780. {
  781. // triggers conversion for array
  782. EnsureCapacity((uint) _dense.Length, force: true);
  783. return true;
  784. }
  785. return false;
  786. }
  787. private void ConvertToSparse()
  788. {
  789. _sparse = new Dictionary<uint, object?>(_dense!.Length <= 1024 ? _dense.Length : 0);
  790. // need to move data
  791. for (uint i = 0; i < (uint) _dense.Length; ++i)
  792. {
  793. if (_dense[i] != null)
  794. {
  795. _sparse[i] = _dense[i];
  796. }
  797. }
  798. _dense = null;
  799. }
  800. internal void EnsureCapacity(uint capacity, bool force = false)
  801. {
  802. if (!force && (capacity > MaxDenseArrayLength || _dense is null || capacity <= (uint) _dense.Length))
  803. {
  804. return;
  805. }
  806. if (capacity > _engine.Options.Constraints.MaxArraySize)
  807. {
  808. ThrowMaximumArraySizeReachedException(_engine, capacity);
  809. }
  810. // need to grow
  811. var newArray = new object[capacity];
  812. System.Array.Copy(_dense, newArray, _dense!.Length);
  813. _dense = newArray;
  814. _isObjectArray = true;
  815. }
  816. public JsValue[] ToArray()
  817. {
  818. var length = GetLength();
  819. var array = new JsValue[length];
  820. for (uint i = 0; i < length; i++)
  821. {
  822. TryGetValue(i, out var outValue);
  823. array[i] = outValue;
  824. }
  825. return array;
  826. }
  827. IEnumerator IEnumerable.GetEnumerator()
  828. {
  829. return GetEnumerator();
  830. }
  831. public IEnumerator<JsValue> GetEnumerator()
  832. {
  833. foreach (var (_, value) in this.Enumerate())
  834. {
  835. yield return value;
  836. }
  837. }
  838. private readonly record struct IndexedEntry(int Index, JsValue Value);
  839. private IEnumerable<IndexedEntry> Enumerate()
  840. {
  841. if (!CanUseFastAccess)
  842. {
  843. // slow path where prototype is also checked
  844. var length = GetLength();
  845. for (uint i = 0; i < length; i++)
  846. {
  847. TryGetValue(i, out var outValue);
  848. yield return new IndexedEntry((int) i, outValue);
  849. }
  850. yield break;
  851. }
  852. var temp = _dense;
  853. if (temp != null)
  854. {
  855. var length = System.Math.Min(temp.Length, GetLength());
  856. for (var i = 0; i < length; i++)
  857. {
  858. var value = temp[i];
  859. if (value != null)
  860. {
  861. if (value is not PropertyDescriptor descriptor)
  862. {
  863. yield return new IndexedEntry(i, (JsValue) value);
  864. }
  865. else
  866. {
  867. yield return new IndexedEntry(i, descriptor.Value);
  868. }
  869. }
  870. }
  871. }
  872. else
  873. {
  874. foreach (var entry in _sparse!)
  875. {
  876. var value = entry.Value;
  877. if (value is not null)
  878. {
  879. if (value is not PropertyDescriptor descriptor)
  880. {
  881. yield return new IndexedEntry((int) entry.Key, (JsValue) value);
  882. }
  883. else
  884. {
  885. yield return new IndexedEntry((int) entry.Key, descriptor.Value);
  886. }
  887. }
  888. }
  889. }
  890. }
  891. /// <summary>
  892. /// Pushes the value to the end of the array instance.
  893. /// </summary>
  894. public void Push(JsValue value)
  895. {
  896. var initialLength = GetLength();
  897. var newLength = initialLength + 1;
  898. var temp = _dense;
  899. var canUseDirectIndexSet = temp != null && newLength <= temp.Length;
  900. double n = initialLength;
  901. if (canUseDirectIndexSet)
  902. {
  903. temp![(uint) n] = value;
  904. }
  905. else
  906. {
  907. WriteValueSlow(n, new PropertyDescriptor(value, PropertyFlag.ConfigurableEnumerableWritable));
  908. }
  909. // check if we can set length fast without breaking ECMA specification
  910. if (n < uint.MaxValue && CanSetLength())
  911. {
  912. _length!.Value = newLength;
  913. }
  914. else
  915. {
  916. if (!Set(CommonProperties.Length, newLength))
  917. {
  918. ExceptionHelper.ThrowTypeError(_engine.Realm);
  919. }
  920. }
  921. }
  922. /// <summary>
  923. /// Pushes the given values to the end of the array.
  924. /// </summary>
  925. public uint Push(JsValue[] values)
  926. {
  927. var initialLength = GetLength();
  928. var newLength = initialLength + values.Length;
  929. // if we see that we are bringing more than normal growth algorithm handles, ensure capacity eagerly
  930. if (_dense != null
  931. && initialLength != 0
  932. && values.Length > initialLength * 2
  933. && newLength <= MaxDenseArrayLength)
  934. {
  935. EnsureCapacity((uint) newLength);
  936. }
  937. var temp = _dense;
  938. ulong n = initialLength;
  939. foreach (var argument in values)
  940. {
  941. if (n < ArrayOperations.MaxArrayLength)
  942. {
  943. WriteArrayValue((uint) n, argument);
  944. }
  945. else
  946. {
  947. DefineOwnProperty(n, new PropertyDescriptor(argument, PropertyFlag.ConfigurableEnumerableWritable));
  948. }
  949. n++;
  950. }
  951. // check if we can set length fast without breaking ECMA specification
  952. if (n < ArrayOperations.MaxArrayLength && CanSetLength())
  953. {
  954. _length!.Value = n;
  955. }
  956. else
  957. {
  958. if (!Set(CommonProperties.Length, newLength))
  959. {
  960. ExceptionHelper.ThrowTypeError(_engine.Realm);
  961. }
  962. }
  963. return (uint) n;
  964. }
  965. private bool CanSetLength()
  966. {
  967. if (!_length!.IsAccessorDescriptor())
  968. {
  969. return _length.Writable;
  970. }
  971. var set = _length.Set;
  972. return set is not null && !set.IsUndefined();
  973. }
  974. [MethodImpl(MethodImplOptions.NoInlining)]
  975. private void WriteValueSlow(double n, PropertyDescriptor desc)
  976. {
  977. if (n < uint.MaxValue)
  978. {
  979. WriteArrayValue((uint) n, desc);
  980. }
  981. else
  982. {
  983. DefinePropertyOrThrow((uint) n, desc);
  984. }
  985. }
  986. internal JsArray Map(JsValue[] arguments)
  987. {
  988. var callbackfn = arguments.At(0);
  989. var thisArg = arguments.At(1);
  990. var len = GetLength();
  991. var callable = GetCallable(callbackfn);
  992. var a = Engine.Realm.Intrinsics.Array.ArrayCreate(len);
  993. var args = _engine._jsValueArrayPool.RentArray(3);
  994. args[2] = this;
  995. for (uint k = 0; k < len; k++)
  996. {
  997. if (TryGetValue(k, out var kvalue))
  998. {
  999. args[0] = kvalue;
  1000. args[1] = k;
  1001. var mappedValue = callable.Call(thisArg, args);
  1002. if (a._dense != null && k < (uint) a._dense.Length)
  1003. {
  1004. a._dense[k] = mappedValue;
  1005. }
  1006. else
  1007. {
  1008. a.WriteArrayValue(k, mappedValue);
  1009. }
  1010. }
  1011. }
  1012. _engine._jsValueArrayPool.ReturnArray(args);
  1013. return a;
  1014. }
  1015. /// <inheritdoc />
  1016. internal sealed override bool FindWithCallback(
  1017. JsValue[] arguments,
  1018. out uint index,
  1019. out JsValue value,
  1020. bool visitUnassigned,
  1021. bool fromEnd = false)
  1022. {
  1023. var thisArg = arguments.At(1);
  1024. var callbackfn = arguments.At(0);
  1025. var callable = GetCallable(callbackfn);
  1026. var len = GetLength();
  1027. if (len == 0)
  1028. {
  1029. index = 0;
  1030. value = Undefined;
  1031. return false;
  1032. }
  1033. var args = _engine._jsValueArrayPool.RentArray(3);
  1034. args[2] = this;
  1035. if (!fromEnd)
  1036. {
  1037. for (uint k = 0; k < len; k++)
  1038. {
  1039. if (TryGetValue(k, out var kvalue) || visitUnassigned)
  1040. {
  1041. kvalue ??= Undefined;
  1042. args[0] = kvalue;
  1043. args[1] = k;
  1044. var testResult = callable.Call(thisArg, args);
  1045. if (TypeConverter.ToBoolean(testResult))
  1046. {
  1047. index = k;
  1048. value = kvalue;
  1049. return true;
  1050. }
  1051. }
  1052. }
  1053. }
  1054. else
  1055. {
  1056. for (long k = len - 1; k >= 0; k--)
  1057. {
  1058. var idx = (uint) k;
  1059. if (TryGetValue(idx, out var kvalue) || visitUnassigned)
  1060. {
  1061. kvalue ??= Undefined;
  1062. args[0] = kvalue;
  1063. args[1] = idx;
  1064. var testResult = callable.Call(thisArg, args);
  1065. if (TypeConverter.ToBoolean(testResult))
  1066. {
  1067. index = idx;
  1068. value = kvalue;
  1069. return true;
  1070. }
  1071. }
  1072. }
  1073. }
  1074. _engine._jsValueArrayPool.ReturnArray(args);
  1075. index = 0;
  1076. value = Undefined;
  1077. return false;
  1078. }
  1079. public sealed override uint Length => GetLength();
  1080. internal sealed override bool IsIntegerIndexedArray => true;
  1081. public JsValue this[uint index]
  1082. {
  1083. get
  1084. {
  1085. TryGetValue(index, out var kValue);
  1086. return kValue;
  1087. }
  1088. set
  1089. {
  1090. SetIndexValue(index, value, updateLength: true);
  1091. }
  1092. }
  1093. public JsValue this[int index]
  1094. {
  1095. get
  1096. {
  1097. JsValue? kValue;
  1098. if (index >= 0)
  1099. {
  1100. TryGetValue((uint) index, out kValue);
  1101. }
  1102. else
  1103. {
  1104. // slow path
  1105. TryGetValue(JsNumber.Create(index), out kValue);
  1106. }
  1107. return kValue;
  1108. }
  1109. set
  1110. {
  1111. if (index >= 0)
  1112. {
  1113. SetIndexValue((uint) index, value, updateLength: true);
  1114. }
  1115. else
  1116. {
  1117. Set(index, value);
  1118. }
  1119. }
  1120. }
  1121. /// <summary>
  1122. /// Fast path for concatenating sane-sized arrays, we assume size has been calculated.
  1123. /// </summary>
  1124. internal void CopyValues(JsArray source, uint sourceStartIndex, uint targetStartIndex, uint length)
  1125. {
  1126. if (length == 0)
  1127. {
  1128. return;
  1129. }
  1130. var sourceDense = source._dense;
  1131. if (sourceDense is not null)
  1132. {
  1133. EnsureCapacity((uint) (targetStartIndex + sourceDense.LongLength));
  1134. }
  1135. var dense = _dense;
  1136. if (dense != null && sourceDense != null
  1137. && (uint) dense.Length >= targetStartIndex + length
  1138. && dense[targetStartIndex] is null)
  1139. {
  1140. uint j = 0;
  1141. for (var i = sourceStartIndex; i < sourceStartIndex + length; ++i, j++)
  1142. {
  1143. object? sourceValue;
  1144. if (i < (uint) sourceDense.Length && sourceDense[i] != null)
  1145. {
  1146. sourceValue = sourceDense[i];
  1147. if (sourceValue is PropertyDescriptor propertyDescriptor)
  1148. {
  1149. sourceValue = UnwrapJsValue(propertyDescriptor);
  1150. }
  1151. }
  1152. else
  1153. {
  1154. if (!source.TryGetValue(i, out var temp))
  1155. {
  1156. sourceValue = source.Prototype?.Get(JsString.Create(i));
  1157. }
  1158. else
  1159. {
  1160. sourceValue = temp;
  1161. }
  1162. }
  1163. dense[targetStartIndex + j] = sourceValue;
  1164. }
  1165. }
  1166. else
  1167. {
  1168. // slower version
  1169. for (uint k = sourceStartIndex; k < length; k++)
  1170. {
  1171. if (source.TryGetValue(k, out var subElement))
  1172. {
  1173. SetIndexValue(targetStartIndex, subElement, updateLength: false);
  1174. }
  1175. targetStartIndex++;
  1176. }
  1177. }
  1178. }
  1179. public sealed override string ToString()
  1180. {
  1181. // debugger can make things hard when evaluates computed values
  1182. return "(" + (_length?._value!.AsNumber() ?? 0) + ")[]";
  1183. }
  1184. private static void ThrowMaximumArraySizeReachedException(Engine engine, uint capacity)
  1185. {
  1186. ExceptionHelper.ThrowMemoryLimitExceededException(
  1187. $"The array size {capacity} is larger than maximum allowed ({engine.Options.Constraints.MaxArraySize})"
  1188. );
  1189. }
  1190. }
  1191. internal static class ArrayPropertyDescriptorExtensions
  1192. {
  1193. [MethodImpl(MethodImplOptions.AggressiveInlining)]
  1194. internal static bool IsDefaultArrayValueDescriptor(this PropertyDescriptor propertyDescriptor)
  1195. => propertyDescriptor.Flags == PropertyFlag.ConfigurableEnumerableWritable && propertyDescriptor.IsDataDescriptor();
  1196. }
  1197. }