forked from WebKit/WebKit
-
Notifications
You must be signed in to change notification settings - Fork 57
Expand file tree
/
Copy pathStructure.h
More file actions
1843 lines (1594 loc) · 84.6 KB
/
Copy pathStructure.h
File metadata and controls
1843 lines (1594 loc) · 84.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (C) 2008-2025 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "ClassInfo.h"
#include "Concurrency.h"
#include "ConcurrentButterfly.h"
#include "ConcurrentJSLock.h"
#include "IndexingType.h"
#include "JSCJSValue.h"
#include "JSCJSValueCell.h"
#include "JSCast.h"
#include "JSTypeInfo.h"
#include "PropertyName.h"
#include "PropertyNameArray.h"
#include "PropertyOffset.h"
#include "PutPropertySlot.h"
#include "StructureRareData.h"
#include "StructureTransitionTable.h"
#include "TypeInfoBlob.h"
#include "Watchpoint.h"
#include <type_traits>
#include <wtf/Atomics.h>
#include <wtf/CompactPointerTuple.h>
#include <wtf/CompactPtr.h>
#include <wtf/CompactRefPtr.h>
namespace WTF {
class UniquedStringImpl;
} // namespace WTF
namespace JSC {
class DeferGC;
class DeferredStructureTransitionWatchpointFire;
class LLIntOffsetsExtractor;
class PropertyNameArrayBuilder;
class PropertyNameArray;
class PropertyTable;
class StructureChain;
class StructureShape;
class JSString;
struct DumpContext;
struct HashTable;
struct HashTableValue;
namespace Integrity {
class Analyzer;
}
class DeferredStructureTransitionWatchpointFire final : public DeferredWatchpointFire {
WTF_MAKE_NONCOPYABLE(DeferredStructureTransitionWatchpointFire);
public:
DeferredStructureTransitionWatchpointFire(VM& vm, Structure* structure)
: DeferredWatchpointFire()
, m_vm(vm)
, m_structure(structure)
{
}
~DeferredStructureTransitionWatchpointFire()
{
if (watchpointsToFire().state() == IsWatched)
fireAllSlow();
}
const Structure* structure() const { return m_structure; }
private:
JS_EXPORT_PRIVATE void fireAllSlow();
VM& m_vm;
const Structure* m_structure;
};
// The out-of-line property storage capacity to use when first allocating out-of-line
// storage. Note that all objects start out without having any out-of-line storage;
// this comes into play only on the first property store that exhausts inline storage.
static constexpr unsigned initialOutOfLineCapacity = 4;
// The factor by which to grow out-of-line storage when it is exhausted, after the
// initial allocation.
static constexpr unsigned outOfLineGrowthFactor = 2;
class PropertyTableEntry;
class CompactPropertyTableEntry {
public:
CompactPropertyTableEntry()
: m_data(nullptr, 0)
{
}
CompactPropertyTableEntry(UniquedStringImpl* key, PropertyOffset offset, unsigned attributes)
: m_data(key, ((offset << 8) | attributes))
{
#ifndef BUN_SKIP_FAILING_ASSERTIONS
ASSERT(this->attributes() == attributes);
#endif
ASSERT(this->offset() == offset);
}
CompactPropertyTableEntry(const PropertyTableEntry&);
UniquedStringImpl* key() const { return m_data.pointer(); }
void setKey(UniquedStringImpl* key) { m_data.setPointer(key); }
PropertyOffset offset() const { return m_data.type() >> 8; }
void setOffset(PropertyOffset offset)
{
m_data.setType((m_data.type() & 0x00ffU) | (offset << 8));
#ifndef BUN_SKIP_FAILING_ASSERTIONS
ASSERT(this->offset() == offset);
#endif
}
uint8_t attributes() const { return m_data.type(); }
void setAttributes(uint8_t attributes)
{
m_data.setType((m_data.type() & 0xff00U) | attributes);
#ifndef BUN_SKIP_FAILING_ASSERTIONS
ASSERT(this->attributes() == attributes);
#endif
}
private:
CompactPointerTuple<UniquedStringImpl*, uint16_t> m_data;
};
class PropertyTableEntry {
public:
PropertyTableEntry() = default;
PropertyTableEntry(UniquedStringImpl* key, PropertyOffset offset, unsigned attributes)
: m_key(key)
, m_offset(offset)
, m_attributes(attributes)
{
#ifndef BUN_SKIP_FAILING_ASSERTIONS
ASSERT(this->attributes() == attributes);
#endif
}
PropertyTableEntry(const CompactPropertyTableEntry& entry)
: m_key(entry.key())
, m_offset(entry.offset())
, m_attributes(entry.attributes())
{
}
UniquedStringImpl* key() const { return m_key; }
void setKey(UniquedStringImpl* key) { m_key = key; }
PropertyOffset offset() const { return m_offset; }
void setOffset(PropertyOffset offset) { m_offset = offset; }
uint8_t attributes() const { return m_attributes; }
void setAttributes(uint8_t attributes) { m_attributes = attributes; }
private:
UniquedStringImpl* m_key { nullptr };
PropertyOffset m_offset { 0 };
uint8_t m_attributes { 0 };
};
inline CompactPropertyTableEntry::CompactPropertyTableEntry(const PropertyTableEntry& entry)
: m_data(entry.key(), ((entry.offset() << 8) | entry.attributes()))
{
}
class StructureFireDetail final : public FireDetail {
public:
StructureFireDetail(const Structure* structure)
: m_structure(structure)
{
}
void dump(PrintStream& out) const final;
private:
explicit StructureFireDetail(ClangVTableWorkaroundTag);
const Structure* m_structure;
};
class Structure : public JSCell {
static constexpr uint16_t shortInvalidOffset = std::numeric_limits<uint16_t>::max() - 1;
static constexpr uint16_t useRareDataFlag = std::numeric_limits<uint16_t>::max();
public:
friend class StructureTransitionTable;
typedef JSCell Base;
static constexpr unsigned StructureFlags = Base::StructureFlags | StructureIsImmortal;
static constexpr uint8_t numberOfLowerTierPreciseCells = 0;
static_assert(JSCell::atomSize >= MarkedBlock::atomSize);
static constexpr int s_maxTransitionLength = 128;
static constexpr int s_maxTransitionLengthForNonEvalPutById = 512;
static constexpr int s_maxTransitionLengthForRemove = 4096; // Picked from benchmarking measurement.
using SeenProperties = TinyBloomFilter<CompactPtr<UniquedStringImpl>::StorageType>;
enum PolyProtoTag { PolyProto };
// SPEC-objectmodel Task 3b (SPEC-vmstate §5.3/N5): ID-creating Structure
// cell allocations are serialized by the process-global
// SharedVMState::StructureAllocationLocker (SAL, heap rank 7a; no-op
// unless Options::useStructureAllocationLock()). The 7-argument create
// and createStructure take it INTERNALLY (StructureCreateInlines.h),
// threading the locker's GCDeferralContext into allocateCell; the
// previous-structure create below is bracketed by its callers in
// Structure.cpp. The lock is non-recursive: never call these while
// already holding the SAL.
inline static Structure* create(VM&, JSGlobalObject*, JSValue prototype, const TypeInfo&, const ClassInfo*, IndexingType = NonArray, unsigned inlineCapacity = 0); // Defined in StructureCreateInlines.h; takes the SAL internally.
static Structure* create(PolyProtoTag, VM&, JSGlobalObject*, JSObject* prototype, const TypeInfo&, const ClassInfo*, IndexingType = NonArray, unsigned inlineCapacity = 0); // Delegates; SAL taken by the delegate.
~Structure();
template<typename CellType, SubspaceAccess>
inline static GCClient::IsoSubspace* subspaceFor(VM&); // Defined in StructureInlines.h
JS_EXPORT_PRIVATE static bool isValidPrototype(JSValue);
protected:
void finishCreation(VM& vm, const Structure* previous, DeferredStructureTransitionWatchpointFire* deferred)
{
this->finishCreation(vm);
if (previous->hasRareData()) {
const StructureRareData* previousRareData = previous->rareData();
if (previousRareData->hasSharedPolyProtoWatchpoint()) {
ensureRareData(vm);
rareData()->setSharedPolyProtoWatchpoint(previousRareData->copySharedPolyProtoWatchpoint());
}
}
previous->fireStructureTransitionWatchpoint(deferred);
}
void finishCreation(VM& vm)
{
Base::finishCreation(vm);
ASSERT(m_prototype.get().isEmpty() || isValidPrototype(m_prototype.get()));
}
private:
inline void finishCreation(VM&, CreatingEarlyCellTag); // Defined in StructureInlines.h
void NODELETE validateFlags();
public:
StructureID id() const { return StructureID::encode(this); }
uint32_t typeInfoBlob() const { return m_blob.blob(); }
bool isProxy() const
{
JSType type = m_blob.type();
return type == GlobalProxyType || type == ProxyObjectType;
}
static void dumpStatistics();
inline bool shouldDoCacheableDictionaryTransitionForAdd(PutPropertySlot::Context context)
{
int maxTransitionLength;
if (context == PutPropertySlot::PutById)
maxTransitionLength = s_maxTransitionLengthForNonEvalPutById;
else
maxTransitionLength = s_maxTransitionLength;
return transitionCountEstimate() > maxTransitionLength;
}
inline bool shouldDoCacheableDictionaryTransitionForRemoveAndAttributeChange()
{
return transitionCountEstimate() > s_maxTransitionLengthForRemove || transitionCountHasOverflowed();
}
ALWAYS_INLINE bool transitionCountHasOverflowed() const
{
int transitionCount = 0;
for (auto* structure = this; structure; structure = structure->previousID()) {
if (++transitionCount > s_maxTransitionLength)
return true;
}
return false;
}
Structure* trySingleTransition() { return m_transitionTable.trySingleTransition(); }
// SPEC-objectmodel L6/I37 (Task 3c) — shared-Structure table protocol,
// flag-on (Options::useJSThreads()):
// (i) MUTATOR transition-table LOOKUPS hold the source's m_lock: the
// plain *ToExistingStructure entry points below route to their
// m_lock-holding *Concurrently variants, and the direct
// m_transitionTable.get sites in Structure.cpp take m_lock in place.
// Inserts already run under m_lock; every insert site additionally
// dual-checks StructureTransitionTable::getMatching under that lock
// and adopts a racing winner (no lost/duplicated transitions).
// (ii) PropertyTable steal/clone/materialize
// (takePropertyTableOrCloneIfPinned, copyPropertyTableForPinning,
// materializePropertyTable) read published tables only under the
// SOURCE's m_lock; a stolen/fresh table is private (mutate lock-free)
// until its new Structure publishes; every table mutation of a
// PUBLISHED Structure (add/remove/attributeChange families) holds ITS
// m_lock — as today. O1: allocation under m_lock only under a
// pre-lock DeferGC (GCSafeConcurrentJSLocker or explicit DeferGC).
// (iii) MUTATOR uncached table WALKS (Structure::get in
// StructureInlinesLight.h, forEachProperty, isSealed/isFrozen,
// getPropertyNamesFromStructure, addOrReplacePropertyWithoutTransition's
// find) hold m_lock across the walk.
// Flag-off, all paths are today's code, bit-identical (I22).
// Compiler-thread Concurrently readers are unchanged.
JS_EXPORT_PRIVATE static Structure* addPropertyTransition(VM&, Structure*, PropertyName, unsigned attributes, PropertyOffset&);
JS_EXPORT_PRIVATE static Structure* addNewPropertyTransition(VM&, Structure*, PropertyName, unsigned attributes, PropertyOffset&, PutPropertySlot::Context = PutPropertySlot::UnknownContext, DeferredStructureTransitionWatchpointFire* = nullptr);
static Structure* addPropertyTransitionToExistingStructureConcurrently(Structure*, UniquedStringImpl* uid, unsigned attributes, PropertyOffset&);
static Structure* addPropertyTransitionToExistingStructure(Structure*, PropertyName, unsigned attributes, PropertyOffset&);
static Structure* removeNewPropertyTransition(VM&, Structure*, PropertyName, PropertyOffset&, DeferredStructureTransitionWatchpointFire* = nullptr);
static Structure* removePropertyTransition(VM&, Structure*, PropertyName, PropertyOffset&, DeferredStructureTransitionWatchpointFire* = nullptr);
// SPEC-objectmodel S6 L3/L4 (flag-on): the pinned dictionary table, for
// the cacheable-dictionary delete staleness guard (deletePropertyNamed-
// Concurrent, JSObject.cpp). Pinned tables are never cleared or replaced,
// so the pointer is stable; pair it with PropertyTable::
// concurrentEditCount() to detect in-place edits since a plan-time clone.
PropertyTable* pinnedPropertyTableForConcurrentDelete() const
{
ASSERT(isPinnedPropertyTable());
return m_propertyTableUnsafe.get();
}
// SCAN-CAS-PROBE-STRUCTURE-SEGV (OM I34/L6, annex-N6/M7 single-snapshot
// discipline): hand the M7(c) lock-free reader (JSObject::
// getOwnNonIndexPropertySlot) the pinned table pointer so it can EXTEND
// the S6 L3/L4 seqlock across its own getDirect() value read — a pinned
// (dictionary) structure's structureID is never re-tagged across in-place
// add/delete/attribute edits, so the M7(c) `structureID()==structure`
// recheck alone cannot detect them and admits a torn {offset, m_butterfly,
// value} triple (CVE A5 mc-df-delete-reuse.CRASH.log; SCAN-RESULTS.md
// residual #5, property-cas-delete-undefined-sentinel-u5.js). Non-pinned
// structures publish a fresh structureID on every table edit, so the
// structureID recheck already suffices and this returns null (no extra
// constraint). Pinned tables are never cleared or replaced (S6), so the
// pointer is stable for the duration of a stamp pair. Non-asserting twin
// of pinnedPropertyTableForConcurrentDelete(): callers branch on null.
PropertyTable* pinnedPropertyTableForConcurrentReadStamp() const
{
return isPinnedPropertyTable() ? m_propertyTableUnsafe.get() : nullptr;
}
// Acquire-load the S6 L3/L4 edit-stamp for the M7(c) reader's
// single-snapshot recheck (0 if non-pinned — see above). Declared here,
// defined in StructureInlines.h (PropertyTable.h is not includable from
// this header; same declare/define split as Structure::get(VM&, ...)).
uint32_t pinnedTableConcurrentEditCountForRead() const;
static Structure* removePropertyTransitionFromExistingStructure(Structure*, PropertyName, PropertyOffset&);
static Structure* removePropertyTransitionFromExistingStructureConcurrently(Structure*, PropertyName, PropertyOffset&);
static Structure* changePrototypeTransition(VM&, Structure*, JSValue prototype, DeferredStructureTransitionWatchpointFire&);
static Structure* changeGlobalProxyTargetTransition(VM&, Structure*, JSGlobalObject*, DeferredStructureTransitionWatchpointFire&);
JS_EXPORT_PRIVATE static Structure* attributeChangeTransition(VM&, Structure*, PropertyName, unsigned attributes, DeferredStructureTransitionWatchpointFire* = nullptr);
static Structure* attributeChangeTransitionToExistingStructureConcurrently(Structure*, PropertyName, unsigned attributes, PropertyOffset&);
JS_EXPORT_PRIVATE static Structure* attributeChangeTransitionToExistingStructure(Structure*, PropertyName, unsigned attributes, PropertyOffset&);
JS_EXPORT_PRIVATE static Structure* toCacheableDictionaryTransition(VM&, Structure*, DeferredStructureTransitionWatchpointFire* = nullptr);
static Structure* toUncacheableDictionaryTransition(VM&, Structure*, DeferredStructureTransitionWatchpointFire* = nullptr);
JS_EXPORT_PRIVATE static Structure* sealTransition(VM&, Structure*, DeferredStructureTransitionWatchpointFire* = nullptr);
JS_EXPORT_PRIVATE static Structure* freezeTransition(VM&, Structure*, DeferredStructureTransitionWatchpointFire* = nullptr);
static Structure* preventExtensionsTransition(VM&, Structure*, DeferredStructureTransitionWatchpointFire* = nullptr);
static Structure* nonPropertyTransition(VM&, Structure*, TransitionKind, DeferredStructureTransitionWatchpointFire*);
static Structure* setBrandTransitionFromExistingStructureConcurrently(Structure*, UniquedStringImpl*);
static Structure* setBrandTransition(VM&, Structure*, Symbol* brand, DeferredStructureTransitionWatchpointFire* = nullptr);
JS_EXPORT_PRIVATE static Structure* becomePrototypeTransition(VM&, Structure*, DeferredStructureTransitionWatchpointFire* = nullptr);
JS_EXPORT_PRIVATE bool isSealed(VM&);
JS_EXPORT_PRIVATE bool isFrozen(VM&);
bool isStructureExtensible() const { return !didPreventExtensions(); }
JS_EXPORT_PRIVATE Structure* flattenDictionaryStructure(VM&, JSObject*);
static constexpr DestructionMode needsDestruction = NeedsDestruction;
static void destroy(JSCell*);
// Versions that take a func will call it after making the change but while still holding
// the lock. The callback is not called if there is no change being made, like if you call
// removePropertyWithoutTransition() and the property is not found.
template<typename Func>
PropertyOffset addPropertyWithoutTransition(VM&, PropertyName, unsigned attributes, const Func&);
template<typename Func>
PropertyOffset removePropertyWithoutTransition(VM&, PropertyName, const Func&);
template<typename Func>
PropertyOffset attributeChangeWithoutTransition(VM&, PropertyName, unsigned attributes, const Func&);
template<typename Func>
auto addOrReplacePropertyWithoutTransition(VM&, PropertyName, unsigned attributes, const Func&) -> decltype(auto);
void setPrototypeWithoutTransition(VM&, JSValue prototype);
bool isDictionary() const { return dictionaryKind() != NoneDictionaryKind; }
bool isUncacheableDictionary() const { return dictionaryKind() == UncachedDictionaryKind; }
bool isCacheableDictionary() const { return dictionaryKind() == CachedDictionaryKind; }
bool prototypeQueriesAreCacheable()
{
return !typeInfo().prohibitsPropertyCaching();
}
bool propertyAccessesAreCacheable()
{
return dictionaryKind() != UncachedDictionaryKind
&& prototypeQueriesAreCacheable()
&& !(typeInfo().getOwnPropertySlotIsImpure() && !typeInfo().newImpurePropertyFiresWatchpoints());
}
bool propertyAccessesAreCacheableForAbsence()
{
return !typeInfo().getOwnPropertySlotIsImpureForPropertyAbsence();
}
bool needImpurePropertyWatchpoint()
{
return propertyAccessesAreCacheable()
&& typeInfo().getOwnPropertySlotIsImpure()
&& typeInfo().newImpurePropertyFiresWatchpoints();
}
bool isImmutablePrototypeExoticObject()
{
return typeInfo().isImmutablePrototypeExoticObject();
}
// We use SlowPath in GetByStatus for structures that may get new impure properties later to prevent
// DFG from inlining property accesses since structures don't transition when a new impure property appears.
bool takesSlowPathInDFGForImpureProperty()
{
return typeInfo().getOwnPropertySlotIsImpure();
}
bool hasNonReifiedStaticProperties() const
{
return typeInfo().hasStaticPropertyTable() && !staticPropertiesReified();
}
bool isNonExtensibleOrHasNonConfigurableProperties() const
{
return didPreventExtensions() || hasNonConfigurableProperties();
}
bool hasAnyOfBitFieldFlags(unsigned flags) const
{
// V7: relaxed read paired with the DEFINE_BITFIELD CAS writers (same codegen as the plain load).
return WTF::atomicLoad(const_cast<uint32_t*>(&m_bitField), std::memory_order_relaxed) & flags;
}
// Type accessors.
// TSAN family structure-fields (§8.9): m_outOfLineTypeFlags/m_classInfo
// are constructor-written words read lock-free by foreign threads (54
// classInfoForCells + 29 typeInfo keys); reader and constructor sides pair
// through the TSAN-build-only relaxed helpers below (plain load non-TSAN).
TypeInfo typeInfo() const { return m_blob.typeInfo(concurrentRelaxedLoad(m_outOfLineTypeFlags)); }
bool isObject() const { return typeInfo().isObject(); }
const ClassInfo* classInfoForCells() const { return concurrentRelaxedLoad(m_classInfo); }
CellState typeInfoDefaultCellState() const { return m_blob.defaultCellState(); }
protected:
// You probably want typeInfo().type()
JSType type() { return JSCell::type(); }
// You probably want classInfoForCell()
const ClassInfo* classInfo() const = delete;
public:
IndexingType indexingType() const { return m_blob.indexingModeIncludingHistory() & AllWritableArrayTypes; }
IndexingType indexingMode() const { return m_blob.indexingModeIncludingHistory() & AllArrayTypes; }
Dependency fencedIndexingMode(IndexingType& indexingType)
{
Dependency dependency = m_blob.fencedIndexingModeIncludingHistory(indexingType);
indexingType &= AllArrayTypes;
return dependency;
}
IndexingType indexingModeIncludingHistory() const { return m_blob.indexingModeIncludingHistory(); }
inline bool mayInterceptIndexedAccesses() const;
inline bool holesMustForwardToPrototype(JSObject*) const;
JSGlobalObject* realm() const LIFETIME_BOUND { return m_realm.get(); }
#if USE(BUN_JSC_ADDITIONS)
// Compat alias: upstream renamed Structure::globalObject() -> realm() in 7d4583947a7b.
JSGlobalObject* globalObject() const LIFETIME_BOUND { return m_realm.get(); }
#endif
// NOTE: This method should only be called during the creation of structures, since the realm
// of a structure is presumed to be immutable in a bunch of places.
void setRealm(VM&, JSGlobalObject*);
ALWAYS_INLINE bool hasMonoProto() const
{
return !m_prototype.get().isEmpty();
}
ALWAYS_INLINE bool hasPolyProto() const
{
return !hasMonoProto();
}
ALWAYS_INLINE JSValue storedPrototype() const
{
ASSERT(hasMonoProto());
return m_prototype.get();
}
JSValue storedPrototype(const JSObject*) const;
JSObject* storedPrototypeObject(const JSObject*) const;
Structure* storedPrototypeStructure(const JSObject*) const;
JSObject* storedPrototypeObject() const;
Structure* storedPrototypeStructure() const;
JSValue prototypeForLookup(JSGlobalObject*) const;
JSValue prototypeForLookup(JSGlobalObject*, JSCell* base) const;
StructureChain* prototypeChain(VM&, JSGlobalObject*, JSObject* base) const;
DECLARE_VISIT_CHILDREN;
// A Structure is cheap to mark during GC if doing so would only add a small and bounded amount
// to our heap footprint. For example, if the structure refers to a global object that is not
// yet marked, then as far as we know, the decision to mark this Structure would lead to a large
// increase in footprint because no other object refers to that global object. This method
// returns true if all user-controlled (and hence unbounded in size) objects referenced from the
// Structure are already marked.
template<typename Visitor> bool isCheapDuringGC(Visitor&);
// Returns true if this structure is now marked.
template<typename Visitor> bool markIfCheap(Visitor&);
// TSAN family structure-fields (OM §5 / UG §K): flag-on, the
// m_previousOrRareData slot is install-raced by allocateRareData()'s
// fence+CAS publish (Structure.cpp) and by clearPreviousID()'s CAS below,
// so every lock-free read of the slot must be an atomic load — a plain
// load against those CASes is C++ UB. Relaxed is sufficient: the install
// CAS is release-or-stronger and the rare-data cell's fields are
// fence-published before the pointer; readers that dereference pair the
// relaxed load with the existing dependent-load fence (consume-style, free
// on every supported target). Codegen is the identical plain mov/ldr, so
// flag-off behavior is unchanged.
ALWAYS_INLINE JSCell* previousOrRareDataConcurrently() const
{
#if TSAN_ENABLED
// §8.9 wave 3: acquire (TSAN builds only) pairs with allocateRareData's
// CAS publish of the freshly constructed StructureRareData, making the
// rare-data constructor stores happen-before every dereference below —
// TSAN cannot see the writer-side storeStoreFence that carries this
// ordering for real hardware. Non-TSAN builds keep the relaxed load
// (consume-style dependent load, identical codegen, I22-safe).
return WTF::atomicLoad(const_cast<WriteBarrier<JSCell>&>(m_previousOrRareData).slot(), std::memory_order_acquire);
#else
return WTF::atomicLoad(const_cast<WriteBarrier<JSCell>&>(m_previousOrRareData).slot(), std::memory_order_relaxed);
#endif
}
bool hasRareData() const
{
return isRareData(previousOrRareDataConcurrently());
}
StructureRareData* rareData()
{
JSCell* cell = previousOrRareDataConcurrently();
ASSERT(isRareData(cell));
return static_cast<StructureRareData*>(cell);
}
StructureRareData* tryRareData()
{
JSCell* value = previousOrRareDataConcurrently();
WTF::dependentLoadLoadFence();
if (isRareData(value))
return static_cast<StructureRareData*>(value);
return nullptr;
}
const StructureRareData* rareData() const
{
JSCell* cell = previousOrRareDataConcurrently();
ASSERT(isRareData(cell));
return static_cast<const StructureRareData*>(cell);
}
const StructureRareData* rareDataConcurrently() const
{
JSCell* cell = previousOrRareDataConcurrently();
WTF::dependentLoadLoadFence();
if (isRareData(cell))
return static_cast<StructureRareData*>(cell);
return nullptr;
}
StructureRareData* ensureRareData(VM& vm)
{
if (!hasRareData())
allocateRareData(vm);
return rareData();
}
inline Structure* previousID() const; // Defined below
inline bool transitivelyTransitionedFrom(Structure* structureToFind); // Defined below
inline PropertyOffset maxOffset() const; // Defined below
inline void setMaxOffset(VM&, PropertyOffset); // Defined below
inline PropertyOffset transitionOffset() const; // Defined below
inline void setTransitionOffset(VM&, PropertyOffset); // Defined below
static unsigned outOfLineCapacity(PropertyOffset maxOffset)
{
unsigned outOfLineSize = Structure::outOfLineSize(maxOffset);
// This algorithm completely determines the out-of-line property storage growth algorithm.
// The JSObject code will only trigger a resize if the value returned by this algorithm
// changed between the new and old structure. So, it's important to keep this simple because
// it's on a fast path.
if (!outOfLineSize)
return 0;
if (outOfLineSize <= initialOutOfLineCapacity)
return initialOutOfLineCapacity;
ASSERT(outOfLineSize > initialOutOfLineCapacity);
static_assert(outOfLineGrowthFactor == 2);
return roundUpToPowerOfTwo(outOfLineSize);
}
static unsigned outOfLineSize(PropertyOffset maxOffset)
{
return numberOfOutOfLineSlotsForMaxOffset(maxOffset);
}
unsigned outOfLineCapacity() const
{
return outOfLineCapacity(maxOffset());
}
unsigned outOfLineSize() const
{
return outOfLineSize(maxOffset());
}
// TSAN family structure-fields: m_inlineCapacity is written only during
// construction but read by concurrent threads holding stale/recycled cell
// references (OM GT: stale reads re-dispatch); the relaxed atomic load is
// the blessed access (identical codegen to the plain byte load).
bool hasInlineStorage() const
{
return !!inlineCapacity();
}
unsigned inlineCapacity() const
{
return WTF::atomicLoad(const_cast<uint8_t*>(&m_inlineCapacity), std::memory_order_relaxed);
}
unsigned inlineSize() const
{
return std::min<unsigned>(maxOffset() + 1, inlineCapacity());
}
unsigned totalStorageCapacity() const
{
ASSERT(structure()->classInfoForCells() == info());
return outOfLineCapacity() + inlineCapacity();
}
bool isValidOffset(PropertyOffset offset) const
{
return JSC::isValidOffset(offset)
&& offset <= maxOffset()
&& (offset < static_cast<PropertyOffset>(inlineCapacity()) || offset >= firstOutOfLineOffset);
}
bool hijacksIndexingHeader() const
{
return isTypedView(m_blob.type());
}
bool couldHaveIndexingHeader() const
{
return hasIndexedProperties(indexingType())
|| hijacksIndexingHeader();
}
bool hasIndexingHeader(const JSCell*) const;
bool masqueradesAsUndefined(JSGlobalObject* lexicalGlobalObject)
{
return typeInfo().masqueradesAsUndefined() && realm() == lexicalGlobalObject;
}
// SPEC-objectmodel L6(iii) (Task 3c): flag-on these route to
// getConcurrently (m_lock-holding chain walk) — do NOT call them while
// holding this structure's m_lock (under-lock code queries the
// PropertyTable directly instead). Flag-off: today's lock-free walk.
PropertyOffset get(VM&, PropertyName);
PropertyOffset get(VM&, PropertyName, unsigned& attributes);
inline bool canPerformFastPropertyEnumerationCommon() const; // Defined below
inline bool canPerformFastPropertyEnumeration() const; // Defined below
// This is a somewhat internalish method. It will call your functor while possibly holding the
// Structure's lock. There is no guarantee whether the lock is held or not in any particular
// call. So, you have to assume the worst. Also, the functor returns true if it wishes for you
// to continue or false if it's done.
template<typename Functor>
void forEachPropertyConcurrently(const Functor&);
template<typename Functor>
void forEachProperty(VM&, const Functor&);
IGNORE_RETURN_TYPE_WARNINGS_BEGIN
ALWAYS_INLINE PropertyOffset get(VM& vm, Concurrency concurrency, UniquedStringImpl* uid, unsigned& attributes)
{
switch (concurrency) {
case Concurrency::MainThread:
ASSERT(!isCompilationThread() && !Thread::mayBeGCThread());
return get(vm, uid, attributes);
case Concurrency::ConcurrentThread:
return getConcurrently(uid, attributes);
}
}
IGNORE_RETURN_TYPE_WARNINGS_END
IGNORE_RETURN_TYPE_WARNINGS_BEGIN
ALWAYS_INLINE PropertyOffset get(VM& vm, Concurrency concurrency, UniquedStringImpl* uid)
{
switch (concurrency) {
case Concurrency::MainThread:
ASSERT(!isCompilationThread() && !Thread::mayBeGCThread());
return get(vm, uid);
case Concurrency::ConcurrentThread:
return getConcurrently(uid);
}
}
IGNORE_RETURN_TYPE_WARNINGS_END
PropertyOffset getConcurrently(UniquedStringImpl* uid)
{
unsigned attributesIgnored;
return getConcurrently(uid, attributesIgnored);
}
PropertyOffset getConcurrently(UniquedStringImpl* uid, unsigned& attributes);
Vector<PropertyTableEntry> getPropertiesConcurrently();
void setHasAnyKindOfGetterSetterPropertiesWithProtoCheck(bool is__proto__)
{
setHasAnyKindOfGetterSetterProperties(true);
if (!is__proto__)
setHasReadOnlyOrGetterSetterPropertiesExcludingProto(true);
}
void setContainsReadOnlyProperties() { setHasReadOnlyOrGetterSetterPropertiesExcludingProto(true); }
void setCachedPropertyNameEnumerator(VM&, JSPropertyNameEnumerator*, StructureChain*);
JSPropertyNameEnumerator* NODELETE cachedPropertyNameEnumerator() const;
uintptr_t NODELETE cachedPropertyNameEnumeratorAndFlag() const;
bool NODELETE canCachePropertyNameEnumerator(VM&) const;
bool NODELETE canAccessPropertiesQuicklyForEnumeration() const;
JSCellButterfly* cachedPropertyNames(CachedPropertyNamesKind kind) const
{
if (!hasRareData())
return nullptr;
return rareData()->cachedPropertyNames(kind);
}
JSCellButterfly* cachedPropertyNamesIgnoringSentinel(CachedPropertyNamesKind kind) const
{
if (!hasRareData())
return nullptr;
return rareData()->cachedPropertyNamesIgnoringSentinel(kind);
}
void setCachedPropertyNames(VM&, CachedPropertyNamesKind, JSCellButterfly*);
bool canCacheOwnPropertyNames() const
{
if (isDictionary())
return false;
if (hasIndexedProperties(indexingType()))
return false;
if (typeInfo().overridesAnyFormOfGetOwnPropertyNames())
return false;
return true;
}
void getPropertyNamesFromStructure(VM&, PropertyNameArrayBuilder&, DontEnumPropertiesMode);
JSValue cachedSpecialProperty(CachedSpecialPropertyKey key)
{
if (!hasRareData())
return JSValue();
return rareData()->cachedSpecialProperty(key);
}
void cacheSpecialProperty(JSGlobalObject*, VM&, JSValue, CachedSpecialPropertyKey, const PropertySlot&);
static constexpr ptrdiff_t prototypeOffset()
{
return OBJECT_OFFSETOF(Structure, m_prototype);
}
static constexpr ptrdiff_t realmOffset()
{
return OBJECT_OFFSETOF(Structure, m_realm);
}
static constexpr ptrdiff_t classInfoOffset()
{
return OBJECT_OFFSETOF(Structure, m_classInfo);
}
static constexpr ptrdiff_t outOfLineTypeFlagsOffset()
{
return OBJECT_OFFSETOF(Structure, m_outOfLineTypeFlags);
}
static constexpr ptrdiff_t indexingModeIncludingHistoryOffset()
{
return OBJECT_OFFSETOF(Structure, m_blob) + TypeInfoBlob::indexingModeIncludingHistoryOffset();
}
static constexpr ptrdiff_t propertyTableUnsafeOffset()
{
return OBJECT_OFFSETOF(Structure, m_propertyTableUnsafe);
}
static constexpr ptrdiff_t inlineCapacityOffset()
{
return OBJECT_OFFSETOF(Structure, m_inlineCapacity);
}
static constexpr ptrdiff_t previousOrRareDataOffset()
{
return OBJECT_OFFSETOF(Structure, m_previousOrRareData);
}
static constexpr ptrdiff_t bitFieldOffset()
{
return OBJECT_OFFSETOF(Structure, m_bitField);
}
static constexpr ptrdiff_t propertyHashOffset()
{
return OBJECT_OFFSETOF(Structure, m_propertyHash);
}
static constexpr ptrdiff_t seenPropertiesOffset()
{
return OBJECT_OFFSETOF(Structure, m_seenProperties) + SeenProperties::offsetOfBits();
}
// SPEC-jit §5.5: the emitted butterfly-less (N1/N2) transition predicate
// compares the R5 thread tag against `Structure::m_transitionThreadLocalTID
// << 48` when not specialized on a concrete Structure, so JIT-emitted code
// needs the field's byte offset (16-bit load). Recorded for the jit
// workstream in INTEGRATE-objectmodel.md.
static constexpr ptrdiff_t transitionThreadLocalTIDOffset()
{
return OBJECT_OFFSETOF(Structure, m_transitionThreadLocalTID);
}
static Structure* createStructure(VM&); // Defined in StructureCreateInlines.h; takes the SAL internally (Task 3b).
bool transitionWatchpointSetHasBeenInvalidated() const
{
return m_transitionWatchpointSet.hasBeenInvalidated();
}
bool transitionWatchpointSetIsStillValid() const
{
return m_transitionWatchpointSet.isStillValid();
}
bool dfgShouldWatchIfPossible() const
{
// FIXME: We would like to not watch things that are unprofitable to watch, like
// dictionaries. Unfortunately, we can't do such things: a dictionary could get flattened,
// in which case it will start to appear watchable and so the DFG will think that it is
// watching it. We should come up with a comprehensive story for not watching things that
// aren't profitable to watch.
// https://bugs.webkit.org/show_bug.cgi?id=133625
// - We don't watch Structures that either decided not to be watched, or whose predecessors
// decided not to be watched. This happens when a transition is fired while being watched.
if (transitionWatchpointIsLikelyToBeFired())
return false;
// - Don't watch Structures that had been dictionaries.
if (hasBeenDictionary())
return false;
return true;
}
bool dfgShouldWatch() const
{
return dfgShouldWatchIfPossible() && transitionWatchpointSetIsStillValid();
}
bool propertyNameEnumeratorShouldWatch() const
{
return dfgShouldWatch() && !hasPolyProto();
}
void addTransitionWatchpoint(Watchpoint* watchpoint) const
{
ASSERT(transitionWatchpointSetIsStillValid());
m_transitionWatchpointSet.add(watchpoint);
}
void NODELETE didTransitionFromThisStructureWithoutFiringWatchpoint() const;
void fireStructureTransitionWatchpoint(DeferredStructureTransitionWatchpointFire*) const;
InlineWatchpointSet& transitionWatchpointSet() const
{
return m_transitionWatchpointSet;
}
// ===== SPEC-objectmodel §9.4 / §5 - TTL watchpoint sets, N1 transition TID,
// E1-E4 elision predicates, I29 re-validation (frozen interface; Task 3) =====
//
// Semantics (§5, monotone, fired only inside a stop-the-world window - I13):
// - transitionThreadLocal: valid <=> no instance of this structure ever
// carried butterfly TID == notTTLTID (I11).
// - writeThreadLocal: valid <=> no instance ever had the SW bit set (I12).
// Both start IsWatched for new structures flag-on; flag-off they are inert
// (ClearWatchpoint, never consulted, never fired - I22).
InlineWatchpointSet& transitionThreadLocalWatchpointSet() const { return m_transitionThreadLocalWatchpointSet; }
InlineWatchpointSet& writeThreadLocalWatchpointSet() const { return m_writeThreadLocalWatchpointSet; }
bool transitionThreadLocalIsStillValid() const { return m_transitionThreadLocalWatchpointSet.isStillValid(); }
bool writeThreadLocalIsStillValid() const { return m_writeThreadLocalWatchpointSet.isStillValid(); }
// §2.1 N1: the sole lock-free BUTTERFLY-LESS transitioner of this shape
// while the TTL sets are valid (creator's TID; copied to transition
// targets). Butterfly-BEARING ownership is keyed on the instance's tag
// (E4); this TID plays no part there.
// TSAN family structure-fields (§8.9): constructor-written, read by
// foreign lock-free transitioners; TSAN-relaxed pair (plain non-TSAN).
// The direct read in StructureInlines.h:transitionThreadLocalIsCurrent
// stays with that header's owning slice.
ButterflyTID transitionThreadLocalTID() const { return concurrentRelaxedLoad(m_transitionThreadLocalTID); }
// E1 (I14): fast paths may omit the TID != notTTLTID check iff this is true
// and a watchpoint is installed on the set. M6: JIT-side state reads need no
// fences - the sets change state only inside a stop.
bool transitionThreadLocalIsValidAndWatched() const { return m_transitionThreadLocalWatchpointSet.state() == IsWatched; }
// E2 (I14): write fast paths may omit the SW branch iff this is true and a
// watchpoint is installed; writes always keep the fused TID compare (jit D9/CS5).
bool writeThreadLocalIsValidAndWatched() const { return m_writeThreadLocalWatchpointSet.state() == IsWatched; }
// E4 (r12, per-object keying) - may an owner transition from this structure
// run today's lock-free code (no cell lock, no (D)CAS, today's nuke order)?
// True iff BOTH source sets are valid+watched AND !isPreciseAllocation(cell)
// (I36) AND: butterfly-bearing => tag == (currentButterflyTID(), SW=0)
// (instance ownership; NO structure-TID compare - foreign-thread shape reuse
// stays lock-free); butterfly-less (incl. N2) => currentButterflyTID() ==
// transitionThreadLocalTID() (N1). Returns true flag-off (E3/I22: today's
// code IS the lock-free path). Sound only with I29 (see below).
// Defined in StructureInlines.h.
bool mayTransitionLockFreeFromThisStructure(const JSCell*, uint64_t taggedButterflyWord) const;
// I29 helper: E4 sites (all tiers) must allocate BEFORE final validation and
// must not poll / allocate / cross a safepoint between the validation and
// the StructureID store. Call this with FRESH re-reads immediately before
// the nuke/StructureID store; false => ownership or elision was lost in the
// window (or an allocation intervened) and the caller must fall back to the
// §4.3 locked protocol. Pair with AssertNoGC across the
// validation->StructureID-store window in debug builds.
bool revalidateLockFreeTransition(const JSCell*, uint64_t freshTaggedButterflyWord) const;
// §9.4 fire functions (F1-F3 triggers). RELEASE_ASSERT(butterflyWorldIsStopped(vm))
// - they may only run inside a §10.6 stop-the-world window (I13). Bodies call
// fireAll on the InlineWatchpointSets (jit §5.6 intercepts do the
// invalidation/jettison/epoch/ISB work). fireTransitionThreadLocal also fires
// writeThreadLocal (§5). Both apply the F4 chain-fire (previousID chain +
// transition-table successors, same stop; monotone => sound).
JS_EXPORT_PRIVATE void fireTransitionThreadLocal(VM&, const char* reason);
JS_EXPORT_PRIVATE void fireWriteThreadLocal(VM&, const char* reason);
WatchpointSet* ensurePropertyReplacementWatchpointSet(VM&, PropertyOffset);
void startWatchingPropertyForReplacements(VM& vm, PropertyOffset offset)
{
ensurePropertyReplacementWatchpointSet(vm, offset);
}
void startWatchingPropertyForReplacements(VM&, PropertyName);
WatchpointSet* propertyReplacementWatchpointSet(PropertyOffset);
// SPEC-jit §5.6 / M6.1: when `deferred` is non-null the set is invalidated