-
Notifications
You must be signed in to change notification settings - Fork 1.9k
/
NativeObject.h
1922 lines (1625 loc) · 70.7 KB
/
NativeObject.h
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
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
* vim: set ts=8 sts=2 et sw=2 tw=80:
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef vm_NativeObject_h
#define vm_NativeObject_h
#include "mozilla/Assertions.h"
#include "mozilla/Attributes.h"
#include "mozilla/Maybe.h"
#include <algorithm>
#include <stdint.h>
#include "NamespaceImports.h"
#include "gc/Barrier.h"
#include "gc/MaybeRooted.h"
#include "gc/ZoneAllocator.h"
#include "js/shadow/Object.h" // JS::shadow::Object
#include "js/shadow/Zone.h" // JS::shadow::Zone
#include "js/Value.h"
#include "vm/GetterSetter.h"
#include "vm/JSAtomUtils.h" // AtomIsMarked
#include "vm/JSObject.h"
#include "vm/Shape.h"
#include "vm/StringType.h"
namespace js {
class JS_PUBLIC_API GenericPrinter;
class PropertyResult;
namespace gc {
class TenuringTracer;
} // namespace gc
#ifdef ENABLE_RECORD_TUPLE
// Defined in vm/RecordTupleShared.{h,cpp}. We cannot include that file
// because it causes circular dependencies.
extern bool IsExtendedPrimitiveWrapper(const JSObject& obj);
#endif
/*
* To really poison a set of values, using 'magic' or 'undefined' isn't good
* enough since often these will just be ignored by buggy code (see bug 629974)
* in debug builds and crash in release builds. Instead, we use a safe-for-crash
* pointer.
*/
static MOZ_ALWAYS_INLINE void Debug_SetValueRangeToCrashOnTouch(Value* beg,
Value* end) {
#ifdef DEBUG
for (Value* v = beg; v != end; ++v) {
*v = js::PoisonedObjectValue(0x48);
}
#endif
}
static MOZ_ALWAYS_INLINE void Debug_SetValueRangeToCrashOnTouch(Value* vec,
size_t len) {
#ifdef DEBUG
Debug_SetValueRangeToCrashOnTouch(vec, vec + len);
#endif
}
static MOZ_ALWAYS_INLINE void Debug_SetValueRangeToCrashOnTouch(
GCPtr<Value>* vec, size_t len) {
#ifdef DEBUG
Debug_SetValueRangeToCrashOnTouch((Value*)vec, len);
#endif
}
static MOZ_ALWAYS_INLINE void Debug_SetSlotRangeToCrashOnTouch(HeapSlot* vec,
uint32_t len) {
#ifdef DEBUG
Debug_SetValueRangeToCrashOnTouch((Value*)vec, len);
#endif
}
static MOZ_ALWAYS_INLINE void Debug_SetSlotRangeToCrashOnTouch(HeapSlot* begin,
HeapSlot* end) {
#ifdef DEBUG
Debug_SetValueRangeToCrashOnTouch((Value*)begin, end - begin);
#endif
}
class ArrayObject;
/*
* ES6 20130308 draft 8.4.2.4 ArraySetLength.
*
* |id| must be "length", |desc| is the new non-accessor descriptor, and
* |result| receives an error code if the change is invalid.
*/
extern bool ArraySetLength(JSContext* cx, Handle<ArrayObject*> obj, HandleId id,
Handle<PropertyDescriptor> desc,
ObjectOpResult& result);
/*
* [SMDOC] NativeObject Elements layout
*
* Elements header used for native objects. The elements component of such
* objects offers an efficient representation for all or some of the indexed
* properties of the object, using a flat array of Values rather than a shape
* hierarchy stored in the object's slots. This structure is immediately
* followed by an array of elements, with the elements member in an object
* pointing to the beginning of that array (the end of this structure). See
* below for usage of this structure.
*
* The sets of properties represented by an object's elements and slots
* are disjoint. The elements contain only indexed properties, while the slots
* can contain both named and indexed properties; any indexes in the slots are
* distinct from those in the elements. If isIndexed() is false for an object,
* all indexed properties (if any) are stored in the dense elements.
*
* Indexes will be stored in the object's slots instead of its elements in
* the following case:
* - there are more than MIN_SPARSE_INDEX slots total and the load factor
* (COUNT / capacity) is less than 0.25
* - a property is defined that has non-default property attributes.
*
* We track these pieces of metadata for dense elements:
* - The length property as a uint32_t, accessible for array objects with
* ArrayObject::{length,setLength}(). This is unused for non-arrays.
* - The number of element slots (capacity), gettable with
* getDenseCapacity().
* - The array's initialized length, accessible with
* getDenseInitializedLength().
*
* Holes in the array are represented by MagicValue(JS_ELEMENTS_HOLE) values.
* These indicate indexes which are not dense properties of the array. The
* property may, however, be held by the object's properties.
*
* The capacity and length of an object's elements are almost entirely
* unrelated! In general the length may be greater than, less than, or equal
* to the capacity. The first case occurs with |new Array(100)|. The length
* is 100, but the capacity remains 0 (indices below length and above capacity
* must be treated as holes) until elements between capacity and length are
* set. The other two cases are common, depending upon the number of elements
* in an array and the underlying allocator used for element storage.
*
* The only case in which the capacity and length of an object's elements are
* related is when the object is an array with non-writable length. In this
* case the capacity is always less than or equal to the length. This permits
* JIT code to optimize away the check for non-writable length when assigning
* to possibly out-of-range elements: such code already has to check for
* |index < capacity|, and fallback code checks for non-writable length.
*
* The initialized length of an object specifies the number of elements that
* have been initialized. All elements above the initialized length are
* holes in the object, and the memory for all elements between the initialized
* length and capacity is left uninitialized. The initialized length is some
* value less than or equal to both the object's length and the object's
* capacity.
*
* There is flexibility in exactly the value the initialized length must hold,
* e.g. if an array has length 5, capacity 10, completely empty, it is valid
* for the initialized length to be any value between zero and 5, as long as
* the in memory values below the initialized length have been initialized with
* a hole value. However, in such cases we want to keep the initialized length
* as small as possible: if the object is known to have no hole values below
* its initialized length, then it is "packed" and can be accessed much faster
* by JIT code.
*
* Elements do not track property creation order, so enumerating the elements
* of an object does not necessarily visit indexes in the order they were
* created.
*
*
* [SMDOC] NativeObject shifted elements optimization
*
* Shifted elements
* ----------------
* It's pretty common to use an array as a queue, like this:
*
* while (arr.length > 0)
* foo(arr.shift());
*
* To ensure we don't get quadratic behavior on this, elements can be 'shifted'
* in memory. tryShiftDenseElements does this by incrementing elements_ to point
* to the next element and moving the ObjectElements header in memory (so it's
* stored where the shifted Value used to be).
*
* Shifted elements can be moved when we grow the array, when the array is
* made non-extensible (for simplicity, shifted elements are not supported on
* objects that are non-extensible, have copy-on-write elements, or on arrays
* with non-writable length).
*/
class ObjectElements {
public:
enum Flags : uint16_t {
// Elements are stored inline in the object allocation.
// An object allocated with the FIXED flag set can have the flag unset later
// if `growElements()` is called to increase the capacity beyond what was
// initially allocated. Once the flag is unset, it will remain so for the
// rest of the lifetime of the object.
FIXED = 0x1,
// Present only if these elements correspond to an array with
// non-writable length; never present for non-arrays.
NONWRITABLE_ARRAY_LENGTH = 0x2,
#ifdef ENABLE_RECORD_TUPLE
// Records, Tuples and Boxes must be atomized before being hashed. We store
// the "is atomized" flag here for tuples, and in fixed slots for records
// and boxes.
TUPLE_IS_ATOMIZED = 0x4,
#endif
// For TypedArrays only: this TypedArray's storage is mapping shared
// memory. This is a static property of the TypedArray, set when it
// is created and never changed.
SHARED_MEMORY = 0x8,
// These elements are not extensible. If this flag is set, the object's
// Shape must also have the NotExtensible flag. This exists on
// ObjectElements in addition to Shape to simplify JIT code.
NOT_EXTENSIBLE = 0x10,
// These elements are set to integrity level "sealed". If this flag is
// set, the NOT_EXTENSIBLE flag must be set as well.
SEALED = 0x20,
// These elements are set to integrity level "frozen". If this flag is
// set, the SEALED flag must be set as well.
//
// This flag must only be set if the Shape has the FrozenElements flag.
// The Shape flag ensures a shape guard can be used to guard against frozen
// elements. The ObjectElements flag is convenient for JIT code and
// ObjectElements assertions.
FROZEN = 0x40,
// If this flag is not set, the elements are guaranteed to contain no hole
// values (the JS_ELEMENTS_HOLE MagicValue) in [0, initializedLength).
NON_PACKED = 0x80,
// If this flag is not set, there's definitely no for-in iterator that
// covers these dense elements so elements can be deleted without calling
// SuppressDeletedProperty. This is used by fast paths for various Array
// builtins. See also NativeObject::denseElementsMaybeInIteration.
MAYBE_IN_ITERATION = 0x100,
};
// The flags word stores both the flags and the number of shifted elements.
// Allow shifting 2047 elements before actually moving the elements.
static const size_t NumShiftedElementsBits = 11;
static const size_t MaxShiftedElements = (1 << NumShiftedElementsBits) - 1;
static const size_t NumShiftedElementsShift = 32 - NumShiftedElementsBits;
static const size_t FlagsMask = (1 << NumShiftedElementsShift) - 1;
static_assert(MaxShiftedElements == 2047,
"MaxShiftedElements should match the comment");
private:
friend class ::JSObject;
friend class ArrayObject;
friend class NativeObject;
friend class gc::TenuringTracer;
#ifdef ENABLE_RECORD_TUPLE
friend class TupleType;
#endif
friend bool js::SetIntegrityLevel(JSContext* cx, HandleObject obj,
IntegrityLevel level);
friend bool ArraySetLength(JSContext* cx, Handle<ArrayObject*> obj,
HandleId id, Handle<PropertyDescriptor> desc,
ObjectOpResult& result);
// The NumShiftedElementsBits high bits of this are used to store the
// number of shifted elements, the other bits are available for the flags.
// See Flags enum above.
uint32_t flags;
/*
* Number of initialized elements. This is <= the capacity, and for arrays
* is <= the length. Memory for elements above the initialized length is
* uninitialized, but values between the initialized length and the proper
* length are conceptually holes.
*/
uint32_t initializedLength;
/* Number of allocated slots. */
uint32_t capacity;
/* 'length' property of array objects, unused for other objects. */
uint32_t length;
bool hasNonwritableArrayLength() const {
return flags & NONWRITABLE_ARRAY_LENGTH;
}
void setNonwritableArrayLength() {
// See ArrayObject::setNonWritableLength.
MOZ_ASSERT(capacity == initializedLength);
MOZ_ASSERT(numShiftedElements() == 0);
flags |= NONWRITABLE_ARRAY_LENGTH;
}
#ifdef ENABLE_RECORD_TUPLE
void setTupleIsAtomized() { flags |= TUPLE_IS_ATOMIZED; }
bool tupleIsAtomized() const { return flags & TUPLE_IS_ATOMIZED; }
#endif
void addShiftedElements(uint32_t count) {
MOZ_ASSERT(count < capacity);
MOZ_ASSERT(count < initializedLength);
MOZ_ASSERT(!(
flags & (NONWRITABLE_ARRAY_LENGTH | NOT_EXTENSIBLE | SEALED | FROZEN)));
uint32_t numShifted = numShiftedElements() + count;
MOZ_ASSERT(numShifted <= MaxShiftedElements);
flags = (numShifted << NumShiftedElementsShift) | (flags & FlagsMask);
capacity -= count;
initializedLength -= count;
}
void unshiftShiftedElements(uint32_t count) {
MOZ_ASSERT(count > 0);
MOZ_ASSERT(!(
flags & (NONWRITABLE_ARRAY_LENGTH | NOT_EXTENSIBLE | SEALED | FROZEN)));
uint32_t numShifted = numShiftedElements();
MOZ_ASSERT(count <= numShifted);
numShifted -= count;
flags = (numShifted << NumShiftedElementsShift) | (flags & FlagsMask);
capacity += count;
initializedLength += count;
}
void clearShiftedElements() {
flags &= FlagsMask;
MOZ_ASSERT(numShiftedElements() == 0);
}
void markNonPacked() { flags |= NON_PACKED; }
void markMaybeInIteration() { flags |= MAYBE_IN_ITERATION; }
bool maybeInIteration() { return flags & MAYBE_IN_ITERATION; }
void setNotExtensible() {
MOZ_ASSERT(!isNotExtensible());
flags |= NOT_EXTENSIBLE;
}
bool isNotExtensible() { return flags & NOT_EXTENSIBLE; }
void seal() {
MOZ_ASSERT(isNotExtensible());
MOZ_ASSERT(!isSealed());
MOZ_ASSERT(!isFrozen());
flags |= SEALED;
}
void freeze() {
MOZ_ASSERT(isNotExtensible());
MOZ_ASSERT(isSealed());
MOZ_ASSERT(!isFrozen());
flags |= FROZEN;
}
bool isFrozen() const { return flags & FROZEN; }
public:
constexpr ObjectElements(uint32_t capacity, uint32_t length)
: flags(0), initializedLength(0), capacity(capacity), length(length) {}
enum class SharedMemory { IsShared };
constexpr ObjectElements(uint32_t capacity, uint32_t length,
SharedMemory shmem)
: flags(SHARED_MEMORY),
initializedLength(0),
capacity(capacity),
length(length) {}
HeapSlot* elements() {
return reinterpret_cast<HeapSlot*>(uintptr_t(this) +
sizeof(ObjectElements));
}
const HeapSlot* elements() const {
return reinterpret_cast<const HeapSlot*>(uintptr_t(this) +
sizeof(ObjectElements));
}
static ObjectElements* fromElements(HeapSlot* elems) {
return reinterpret_cast<ObjectElements*>(uintptr_t(elems) -
sizeof(ObjectElements));
}
bool isSharedMemory() const { return flags & SHARED_MEMORY; }
static int offsetOfFlags() {
return int(offsetof(ObjectElements, flags)) - int(sizeof(ObjectElements));
}
static int offsetOfInitializedLength() {
return int(offsetof(ObjectElements, initializedLength)) -
int(sizeof(ObjectElements));
}
static int offsetOfCapacity() {
return int(offsetof(ObjectElements, capacity)) -
int(sizeof(ObjectElements));
}
static int offsetOfLength() {
return int(offsetof(ObjectElements, length)) - int(sizeof(ObjectElements));
}
static void PrepareForPreventExtensions(JSContext* cx, NativeObject* obj);
static void PreventExtensions(NativeObject* obj);
[[nodiscard]] static bool FreezeOrSeal(JSContext* cx,
Handle<NativeObject*> obj,
IntegrityLevel level);
bool isSealed() const { return flags & SEALED; }
bool isPacked() const { return !(flags & NON_PACKED); }
JS::PropertyAttributes elementAttributes() const {
if (isFrozen()) {
return {JS::PropertyAttribute::Enumerable};
}
if (isSealed()) {
return {JS::PropertyAttribute::Enumerable,
JS::PropertyAttribute::Writable};
}
return {JS::PropertyAttribute::Configurable,
JS::PropertyAttribute::Enumerable, JS::PropertyAttribute::Writable};
}
uint32_t numShiftedElements() const {
uint32_t numShifted = flags >> NumShiftedElementsShift;
MOZ_ASSERT_IF(numShifted > 0,
!(flags & (NONWRITABLE_ARRAY_LENGTH | NOT_EXTENSIBLE |
SEALED | FROZEN)));
return numShifted;
}
uint32_t numAllocatedElements() const {
return VALUES_PER_HEADER + capacity + numShiftedElements();
}
// This is enough slots to store an object of this class. See the static
// assertion below.
static const size_t VALUES_PER_HEADER = 2;
#if defined(DEBUG) || defined(JS_JITSPEW)
void dumpStringContent(js::GenericPrinter& out) const;
#endif
};
static_assert(ObjectElements::VALUES_PER_HEADER * sizeof(HeapSlot) ==
sizeof(ObjectElements),
"ObjectElements doesn't fit in the given number of slots");
/*
* Slots header used for native objects. The header stores the capacity and the
* slot data follows in memory.
*/
class alignas(HeapSlot) ObjectSlots {
uint32_t capacity_;
uint32_t dictionarySlotSpan_;
uint64_t maybeUniqueId_;
public:
// Special values for maybeUniqueId_ to indicate no unique ID is present.
static constexpr uint64_t NoUniqueIdInDynamicSlots = 0;
static constexpr uint64_t NoUniqueIdInSharedEmptySlots = 1;
static constexpr uint64_t LastNoUniqueIdValue = NoUniqueIdInSharedEmptySlots;
static constexpr size_t VALUES_PER_HEADER = 2;
static inline size_t allocCount(size_t slotCount) {
static_assert(sizeof(ObjectSlots) ==
ObjectSlots::VALUES_PER_HEADER * sizeof(HeapSlot));
#ifdef MOZ_VALGRIND
if (slotCount == 0) {
// Add an extra unused slot so that NativeObject::slots_ always points
// into the allocation otherwise valgrind thinks this is a leak.
slotCount = 1;
}
#endif
return slotCount + VALUES_PER_HEADER;
}
static inline size_t allocSize(size_t slotCount) {
return allocCount(slotCount) * sizeof(HeapSlot);
}
static ObjectSlots* fromSlots(HeapSlot* slots) {
MOZ_ASSERT(slots);
return reinterpret_cast<ObjectSlots*>(uintptr_t(slots) -
sizeof(ObjectSlots));
}
static constexpr size_t offsetOfCapacity() {
return offsetof(ObjectSlots, capacity_);
}
static constexpr size_t offsetOfDictionarySlotSpan() {
return offsetof(ObjectSlots, dictionarySlotSpan_);
}
static constexpr size_t offsetOfMaybeUniqueId() {
return offsetof(ObjectSlots, maybeUniqueId_);
}
static constexpr size_t offsetOfSlots() { return sizeof(ObjectSlots); }
constexpr explicit ObjectSlots(uint32_t capacity, uint32_t dictionarySlotSpan,
uint64_t maybeUniqueId);
constexpr uint32_t capacity() const { return capacity_; }
constexpr uint32_t dictionarySlotSpan() const { return dictionarySlotSpan_; }
bool isSharedEmptySlots() const {
return maybeUniqueId_ == NoUniqueIdInSharedEmptySlots;
}
constexpr bool hasUniqueId() const {
return maybeUniqueId_ > LastNoUniqueIdValue;
}
uint64_t uniqueId() const {
MOZ_ASSERT(hasUniqueId());
return maybeUniqueId_;
}
uintptr_t maybeUniqueId() const { return hasUniqueId() ? maybeUniqueId_ : 0; }
void setUniqueId(uint64_t uid) {
MOZ_ASSERT(uid > LastNoUniqueIdValue);
MOZ_ASSERT(!isSharedEmptySlots());
maybeUniqueId_ = uid;
}
void setDictionarySlotSpan(uint32_t span) { dictionarySlotSpan_ = span; }
HeapSlot* slots() const {
return reinterpret_cast<HeapSlot*>(uintptr_t(this) + sizeof(ObjectSlots));
}
};
/*
* Shared singletons for objects with no elements.
* emptyObjectElementsShared is used only for TypedArrays, when the TA
* maps shared memory.
*/
extern HeapSlot* const emptyObjectElements;
extern HeapSlot* const emptyObjectElementsShared;
/*
* Shared singletons for objects with no dynamic slots.
*/
extern HeapSlot* const emptyObjectSlots;
extern HeapSlot* const emptyObjectSlotsForDictionaryObject[];
class AutoCheckShapeConsistency;
class GCMarker;
// Operations which change an object's dense elements can either succeed, fail,
// or be unable to complete. The latter is used when the object's elements must
// become sparse instead. The enum below is used for such operations.
enum class DenseElementResult { Failure, Success, Incomplete };
// Stores a slot offset in bytes relative to either the NativeObject* address
// (if isFixedSlot) or to NativeObject::slots_ (if !isFixedSlot).
class TaggedSlotOffset {
uint32_t bits_ = 0;
public:
static constexpr size_t OffsetShift = 1;
static constexpr size_t IsFixedSlotFlag = 0b1;
static constexpr size_t MaxOffset = SHAPE_MAXIMUM_SLOT * sizeof(Value);
static_assert((uint64_t(MaxOffset) << OffsetShift) <= UINT32_MAX,
"maximum slot offset must fit in TaggedSlotOffset");
constexpr TaggedSlotOffset() = default;
TaggedSlotOffset(uint32_t offset, bool isFixedSlot)
: bits_((offset << OffsetShift) | isFixedSlot) {
MOZ_ASSERT(offset <= MaxOffset);
}
uint32_t offset() const { return bits_ >> OffsetShift; }
bool isFixedSlot() const { return bits_ & IsFixedSlotFlag; }
bool operator==(const TaggedSlotOffset& other) const {
return bits_ == other.bits_;
}
bool operator!=(const TaggedSlotOffset& other) const {
return !(*this == other);
}
};
enum class CanReuseShape {
// The Shape can be reused. This implies CanReusePropMap.
CanReuseShape,
// Only the PropMap can be reused.
CanReusePropMap,
// Neither the PropMap nor Shape can be reused.
NoReuse,
};
/*
* [SMDOC] NativeObject layout
*
* NativeObject specifies the internal implementation of a native object.
*
* Native objects use ShapedObject::shape to record property information. Two
* native objects with the same shape are guaranteed to have the same number of
* fixed slots.
*
* Native objects extend the base implementation of an object with storage for
* the object's named properties and indexed elements.
*
* These are stored separately from one another. Objects are followed by a
* variable-sized array of values for inline storage, which may be used by
* either properties of native objects (fixed slots), by elements (fixed
* elements), or by other data for certain kinds of objects, such as
* ArrayBufferObjects and TypedArrayObjects.
*
* Named property storage can be split between fixed slots and a dynamically
* allocated array (the slots member). For an object with N fixed slots, shapes
* with slots [0..N-1] are stored in the fixed slots, and the remainder are
* stored in the dynamic array. If all properties fit in the fixed slots, the
* 'slots_' member is nullptr.
*
* Elements are indexed via the 'elements_' member. This member can point to
* either the shared emptyObjectElements and emptyObjectElementsShared
* singletons, into the inline value array (the address of the third value, to
* leave room for a ObjectElements header;in this case numFixedSlots() is zero)
* or to a dynamically allocated array.
*
* Slots and elements may both be non-empty. The slots may be either names or
* indexes; no indexed property will be in both the slots and elements.
*/
class NativeObject : public JSObject {
protected:
/* Slots for object properties. */
js::HeapSlot* slots_;
/* Slots for object dense elements. */
js::HeapSlot* elements_;
friend class ::JSObject;
private:
static void staticAsserts() {
static_assert(sizeof(NativeObject) == sizeof(JSObject_Slots0),
"native object size must match GC thing size");
static_assert(sizeof(NativeObject) == sizeof(JS::shadow::Object),
"shadow interface must match actual implementation");
static_assert(sizeof(NativeObject) % sizeof(Value) == 0,
"fixed slots after an object must be aligned");
static_assert(offsetOfShape() == offsetof(JS::shadow::Object, shape),
"shadow type must match actual type");
static_assert(
offsetof(NativeObject, slots_) == offsetof(JS::shadow::Object, slots),
"shadow slots must match actual slots");
static_assert(
offsetof(NativeObject, elements_) == offsetof(JS::shadow::Object, _1),
"shadow placeholder must match actual elements");
static_assert(MAX_FIXED_SLOTS <= Shape::FIXED_SLOTS_MAX,
"verify numFixedSlots() bitfield is big enough");
static_assert(sizeof(NativeObject) + MAX_FIXED_SLOTS * sizeof(Value) ==
JSObject::MAX_BYTE_SIZE,
"inconsistent maximum object size");
// Sanity check NativeObject size is what we expect.
#ifdef JS_64BIT
static_assert(sizeof(NativeObject) == 3 * sizeof(void*));
#else
static_assert(sizeof(NativeObject) == 4 * sizeof(void*));
#endif
}
public:
NativeShape* shape() const { return &JSObject::shape()->asNative(); }
SharedShape* sharedShape() const { return &shape()->asShared(); }
DictionaryShape* dictionaryShape() const { return &shape()->asDictionary(); }
PropertyInfoWithKey getLastProperty() const {
return shape()->lastProperty();
}
HeapSlotArray getDenseElements() const { return HeapSlotArray(elements_); }
const Value& getDenseElement(uint32_t idx) const {
MOZ_ASSERT(idx < getDenseInitializedLength());
return elements_[idx];
}
bool containsDenseElement(uint32_t idx) const {
return idx < getDenseInitializedLength() &&
!elements_[idx].isMagic(JS_ELEMENTS_HOLE);
}
uint32_t getDenseInitializedLength() const {
return getElementsHeader()->initializedLength;
}
uint32_t getDenseCapacity() const { return getElementsHeader()->capacity; }
bool isSharedMemory() const { return getElementsHeader()->isSharedMemory(); }
// Update the object's shape and allocate slots if needed to match the shape's
// slot span.
MOZ_ALWAYS_INLINE bool setShapeAndAddNewSlots(JSContext* cx,
SharedShape* newShape,
uint32_t oldSpan,
uint32_t newSpan);
// Methods optimized for adding/removing a single slot. Must only be used for
// non-dictionary objects.
MOZ_ALWAYS_INLINE bool setShapeAndAddNewSlot(JSContext* cx,
SharedShape* newShape,
uint32_t slot);
void setShapeAndRemoveLastSlot(JSContext* cx, SharedShape* newShape,
uint32_t slot);
MOZ_ALWAYS_INLINE CanReuseShape
canReuseShapeForNewProperties(NativeShape* newShape) const {
NativeShape* oldShape = shape();
MOZ_ASSERT(oldShape->propMapLength() == 0,
"object must have no properties");
MOZ_ASSERT(newShape->propMapLength() > 0,
"new shape must have at least one property");
if (oldShape->isDictionary() || newShape->isDictionary()) {
return CanReuseShape::NoReuse;
}
// We only handle the common case where the old shape has no object flags
// (expected because it's an empty object) and the new shape has just the
// HasEnumerable flag that we can copy safely.
if (!oldShape->objectFlags().isEmpty()) {
return CanReuseShape::NoReuse;
}
MOZ_ASSERT(newShape->hasObjectFlag(ObjectFlag::HasEnumerable));
if (newShape->objectFlags() != ObjectFlags({ObjectFlag::HasEnumerable})) {
return CanReuseShape::NoReuse;
}
// If the number of fixed slots or the BaseShape is different, we can't
// reuse the Shape but we can still reuse the PropMap.
if (oldShape->numFixedSlots() != newShape->numFixedSlots() ||
oldShape->base() != newShape->base()) {
return CanReuseShape::CanReusePropMap;
}
MOZ_ASSERT(oldShape->getObjectClass() == newShape->getObjectClass());
MOZ_ASSERT(oldShape->proto() == newShape->proto());
MOZ_ASSERT(oldShape->realm() == newShape->realm());
return CanReuseShape::CanReuseShape;
}
// Newly-created TypedArrays that map a SharedArrayBuffer are
// marked as shared by giving them an ObjectElements that has the
// ObjectElements::SHARED_MEMORY flag set.
void setIsSharedMemory() {
MOZ_ASSERT(elements_ == emptyObjectElements);
elements_ = emptyObjectElementsShared;
}
inline bool isInWholeCellBuffer() const;
static inline NativeObject* create(JSContext* cx, gc::AllocKind kind,
gc::Heap heap, Handle<SharedShape*> shape,
gc::AllocSite* site = nullptr);
template <typename T>
static inline T* create(JSContext* cx, gc::AllocKind kind, gc::Heap heap,
Handle<SharedShape*> shape,
gc::AllocSite* site = nullptr) {
NativeObject* nobj = create(cx, kind, heap, shape, site);
return nobj ? &nobj->as<T>() : nullptr;
}
#ifdef DEBUG
static void enableShapeConsistencyChecks();
#endif
protected:
#ifdef DEBUG
friend class js::AutoCheckShapeConsistency;
void checkShapeConsistency();
#else
void checkShapeConsistency() {}
#endif
void maybeFreeDictionaryPropSlots(JSContext* cx, DictionaryPropMap* map,
uint32_t mapLength);
[[nodiscard]] static bool toDictionaryMode(JSContext* cx,
Handle<NativeObject*> obj);
private:
inline void setEmptyDynamicSlots(uint32_t dictonarySlotSpan);
inline void setDictionaryModeSlotSpan(uint32_t span);
friend class gc::TenuringTracer;
// Given a slot range from |start| to |end| exclusive, call |fun| with
// pointers to the corresponding fixed slot and/or dynamic slot ranges.
template <typename Fun>
void forEachSlotRangeUnchecked(uint32_t start, uint32_t end, const Fun& fun) {
MOZ_ASSERT(end >= start);
uint32_t nfixed = numFixedSlots();
if (start < nfixed) {
HeapSlot* fixedStart = &fixedSlots()[start];
HeapSlot* fixedEnd = &fixedSlots()[std::min(nfixed, end)];
fun(fixedStart, fixedEnd);
start = nfixed;
}
if (end > nfixed) {
HeapSlot* dynStart = &slots_[start - nfixed];
HeapSlot* dynEnd = &slots_[end - nfixed];
fun(dynStart, dynEnd);
}
}
template <typename Fun>
void forEachSlotRange(uint32_t start, uint32_t end, const Fun& fun) {
MOZ_ASSERT(slotInRange(end, SENTINEL_ALLOWED));
forEachSlotRangeUnchecked(start, end, fun);
}
protected:
friend class DictionaryPropMap;
friend class GCMarker;
friend class Shape;
void invalidateSlotRange(uint32_t start, uint32_t end) {
#ifdef DEBUG
forEachSlotRange(start, end, [](HeapSlot* slotsStart, HeapSlot* slotsEnd) {
Debug_SetSlotRangeToCrashOnTouch(slotsStart, slotsEnd);
});
#endif /* DEBUG */
}
void initFixedSlots(uint32_t numSlots) {
MOZ_ASSERT(numSlots == numUsedFixedSlots());
HeapSlot* slots = fixedSlots();
for (uint32_t i = 0; i < numSlots; i++) {
slots[i].initAsUndefined();
}
}
void initDynamicSlots(uint32_t numSlots) {
MOZ_ASSERT(numSlots == sharedShape()->slotSpan() - numFixedSlots());
HeapSlot* slots = slots_;
for (uint32_t i = 0; i < numSlots; i++) {
slots[i].initAsUndefined();
}
}
void initSlots(uint32_t nfixed, uint32_t slotSpan) {
initFixedSlots(std::min(nfixed, slotSpan));
if (slotSpan > nfixed) {
initDynamicSlots(slotSpan - nfixed);
}
}
#ifdef DEBUG
enum SentinelAllowed{SENTINEL_NOT_ALLOWED, SENTINEL_ALLOWED};
/*
* Check that slot is in range for the object's allocated slots.
* If sentinelAllowed then slot may equal the slot capacity.
*/
bool slotInRange(uint32_t slot,
SentinelAllowed sentinel = SENTINEL_NOT_ALLOWED) const;
/*
* Check whether a slot is a fixed slot.
*/
bool slotIsFixed(uint32_t slot) const;
/*
* Check whether the supplied number of fixed slots is correct.
*/
bool isNumFixedSlots(uint32_t nfixed) const;
#endif
/*
* Minimum size for dynamically allocated slots in normal Objects.
* ArrayObjects don't use this limit and can have a lower slot capacity,
* since they normally don't have a lot of slots.
*/
static const uint32_t SLOT_CAPACITY_MIN = 8 - ObjectSlots::VALUES_PER_HEADER;
/*
* Minimum size for dynamically allocated elements in normal Objects.
*/
static const uint32_t ELEMENT_CAPACITY_MIN =
8 - ObjectElements::VALUES_PER_HEADER;
HeapSlot* fixedSlots() const {
return reinterpret_cast<HeapSlot*>(uintptr_t(this) + sizeof(NativeObject));
}
public:
inline void initEmptyDynamicSlots();
[[nodiscard]] static bool generateNewDictionaryShape(
JSContext* cx, Handle<NativeObject*> obj);
// The maximum number of slots in an object.
// |MAX_SLOTS_COUNT * sizeof(JS::Value)| shouldn't overflow
// int32_t (see slotsSizeMustNotOverflow).
static const uint32_t MAX_SLOTS_COUNT = (1 << 28) - 1;
static void slotsSizeMustNotOverflow() {
static_assert(
NativeObject::MAX_SLOTS_COUNT <= INT32_MAX / sizeof(JS::Value),
"every caller of this method requires that a slot "
"number (or slot count) count multiplied by "
"sizeof(Value) can't overflow uint32_t (and sometimes "
"int32_t, too)");
}
uint32_t numFixedSlots() const {
return reinterpret_cast<const JS::shadow::Object*>(this)->numFixedSlots();
}
// Get the number of fixed slots when the shape pointer may have been
// forwarded by a moving GC. You need to use this rather that
// numFixedSlots() in a trace hook if you access an object that is not the
// object being traced, since it may have a stale shape pointer.
inline uint32_t numFixedSlotsMaybeForwarded() const;
uint32_t numUsedFixedSlots() const {
uint32_t nslots = sharedShape()->slotSpan();
return std::min(nslots, numFixedSlots());
}
uint32_t slotSpan() const {
if (inDictionaryMode()) {
return dictionaryModeSlotSpan();
}
MOZ_ASSERT(getSlotsHeader()->dictionarySlotSpan() == 0);
return sharedShape()->slotSpan();
}
uint32_t dictionaryModeSlotSpan() const {
MOZ_ASSERT(inDictionaryMode());
return getSlotsHeader()->dictionarySlotSpan();
}
/* Whether a slot is at a fixed offset from this object. */
bool isFixedSlot(size_t slot) { return slot < numFixedSlots(); }
/* Index into the dynamic slots array to use for a dynamic slot. */
size_t dynamicSlotIndex(size_t slot) {
MOZ_ASSERT(slot >= numFixedSlots());
return slot - numFixedSlots();
}
// Native objects are never proxies. Call isExtensible instead.
bool nonProxyIsExtensible() const = delete;
bool isExtensible() const {
#ifdef ENABLE_RECORD_TUPLE
if (IsExtendedPrimitiveWrapper(*this)) {
return false;
}
#endif
return !hasFlag(ObjectFlag::NotExtensible);
}
/*
* Whether there may be indexed properties on this object, excluding any in
* the object's elements.
*/
bool isIndexed() const { return hasFlag(ObjectFlag::Indexed); }
bool hasInterestingSymbol() const {
return hasFlag(ObjectFlag::HasInterestingSymbol);
}
bool hasEnumerableProperty() const {
return hasFlag(ObjectFlag::HasEnumerable);
}
static bool setHadGetterSetterChange(JSContext* cx,
Handle<NativeObject*> obj) {
return setFlag(cx, obj, ObjectFlag::HadGetterSetterChange);
}
bool hadGetterSetterChange() const {
return hasFlag(ObjectFlag::HadGetterSetterChange);
}
bool allocateInitialSlots(JSContext* cx, uint32_t capacity);
/*
* Grow or shrink slots immediately before changing the slot span.
* The number of allocated slots is not stored explicitly, and changes to
* the slots must track changes in the slot span.
*/
bool growSlots(JSContext* cx, uint32_t oldCapacity, uint32_t newCapacity);
bool growSlotsForNewSlot(JSContext* cx, uint32_t numFixed, uint32_t slot);
void shrinkSlots(JSContext* cx, uint32_t oldCapacity, uint32_t newCapacity);
bool allocateSlots(Nursery& nursery, uint32_t newCapacity);
/*
* This method is static because it's called from JIT code. On OOM, returns
* false without leaving a pending exception on the context.
*/
static bool growSlotsPure(JSContext* cx, NativeObject* obj,
uint32_t newCapacity);
/*
* Like growSlotsPure but for dense elements. This will return