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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
|
/* -*- 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/. */
#include "vm/ArrayBufferObject-inl.h"
#include "vm/ArrayBufferObject.h"
#include "mozilla/Assertions.h"
#include "mozilla/Attributes.h"
#include "mozilla/DebugOnly.h"
#include "mozilla/Likely.h"
#include "mozilla/Maybe.h"
#include "mozilla/ScopeExit.h"
#include "mozilla/TaggedAnonymousMemory.h"
#include <algorithm> // std::max, std::min
#include <memory> // std::uninitialized_copy_n
#include <string.h>
#if !defined(XP_WIN) && !defined(__wasi__)
# include <sys/mman.h>
#endif
#include <tuple> // std::tuple
#include <type_traits>
#ifdef MOZ_VALGRIND
# include <valgrind/memcheck.h>
#endif
#include "jsnum.h"
#include "jstypes.h"
#include "gc/Barrier.h"
#include "gc/Memory.h"
#include "js/ArrayBuffer.h"
#include "js/Conversions.h"
#include "js/experimental/TypedData.h" // JS_IsArrayBufferViewObject
#include "js/friend/ErrorMessages.h" // js::GetErrorMessage, JSMSG_*
#include "js/MemoryMetrics.h"
#include "js/PropertySpec.h"
#include "js/SharedArrayBuffer.h"
#include "js/Wrapper.h"
#include "util/WindowsWrapper.h"
#include "vm/GlobalObject.h"
#include "vm/JSContext.h"
#include "vm/JSObject.h"
#include "vm/SharedArrayObject.h"
#include "vm/Warnings.h" // js::WarnNumberASCII
#include "wasm/WasmConstants.h"
#include "wasm/WasmLog.h"
#include "wasm/WasmModuleTypes.h"
#include "wasm/WasmProcess.h"
#include "gc/GCContext-inl.h"
#include "gc/Marking-inl.h"
#include "vm/NativeObject-inl.h"
#include "vm/Realm-inl.h" // js::AutoRealm
using JS::ToInt32;
using js::wasm::IndexType;
using js::wasm::Pages;
using mozilla::Atomic;
using mozilla::CheckedInt;
using mozilla::DebugOnly;
using mozilla::Maybe;
using mozilla::Nothing;
using mozilla::Some;
using namespace js;
// If there are too many wasm memory buffers (typically 6GB each) live we run up
// against system resource exhaustion (address space or number of memory map
// descriptors), see bug 1068684, bug 1073934, bug 1517412, bug 1502733 for
// details. The limiting case seems to be Android on ARM64, where the
// per-process address space is limited to 4TB (39 bits) by the organization of
// the page tables. An earlier problem was Windows Vista Home 64-bit, where the
// per-process address space is limited to 8TB (40 bits).
//
// Thus we track the number of live objects if we are using large mappings, and
// set a limit of the number of live buffer objects per process. We trigger GC
// work when we approach the limit and we throw an OOM error if the per-process
// limit is exceeded. The limit (MaximumLiveMappedBuffers) is specific to
// architecture, OS, and OS configuration.
//
// Since the MaximumLiveMappedBuffers limit is not generally accounted for by
// any existing GC-trigger heuristics, we need an extra heuristic for triggering
// GCs when the caller is allocating memories rapidly without other garbage.
// Thus, once the live buffer count crosses the threshold
// StartTriggeringAtLiveBufferCount, we start triggering GCs every
// AllocatedBuffersPerTrigger allocations. Once we reach
// StartSyncFullGCAtLiveBufferCount live buffers, we perform expensive
// non-incremental full GCs as a last-ditch effort to avoid unnecessary failure.
// Once we reach MaximumLiveMappedBuffers, we perform further full GCs before
// giving up.
#if defined(JS_CODEGEN_ARM64) && defined(ANDROID)
// With 6GB mappings, the hard limit is 84 buffers. 75 cuts it close.
static const int32_t MaximumLiveMappedBuffers = 75;
#elif defined(MOZ_TSAN) || defined(MOZ_ASAN)
// ASAN and TSAN use a ton of vmem for bookkeeping leaving a lot less for the
// program so use a lower limit.
static const int32_t MaximumLiveMappedBuffers = 500;
#else
static const int32_t MaximumLiveMappedBuffers = 1000;
#endif
// StartTriggeringAtLiveBufferCount + AllocatedBuffersPerTrigger must be well
// below StartSyncFullGCAtLiveBufferCount in order to provide enough time for
// incremental GC to do its job.
#if defined(JS_CODEGEN_ARM64) && defined(ANDROID)
static const int32_t StartTriggeringAtLiveBufferCount = 15;
static const int32_t StartSyncFullGCAtLiveBufferCount =
MaximumLiveMappedBuffers - 15;
static const int32_t AllocatedBuffersPerTrigger = 15;
#else
static const int32_t StartTriggeringAtLiveBufferCount = 100;
static const int32_t StartSyncFullGCAtLiveBufferCount =
MaximumLiveMappedBuffers - 100;
static const int32_t AllocatedBuffersPerTrigger = 100;
#endif
static Atomic<int32_t, mozilla::ReleaseAcquire> liveBufferCount(0);
static Atomic<int32_t, mozilla::ReleaseAcquire> allocatedSinceLastTrigger(0);
int32_t js::LiveMappedBufferCount() { return liveBufferCount; }
[[nodiscard]] static bool CheckArrayBufferTooLarge(JSContext* cx,
uint64_t nbytes) {
// Refuse to allocate too large buffers.
if (MOZ_UNLIKELY(nbytes > ArrayBufferObject::MaxByteLength)) {
JS_ReportErrorNumberASCII(cx, GetErrorMessage, nullptr,
JSMSG_BAD_ARRAY_LENGTH);
return false;
}
return true;
}
void* js::MapBufferMemory(wasm::IndexType t, size_t mappedSize,
size_t initialCommittedSize) {
MOZ_ASSERT(mappedSize % gc::SystemPageSize() == 0);
MOZ_ASSERT(initialCommittedSize % gc::SystemPageSize() == 0);
MOZ_ASSERT(initialCommittedSize <= mappedSize);
auto decrement = mozilla::MakeScopeExit([&] { liveBufferCount--; });
// Testing just IsHugeMemoryEnabled() here will overestimate the number of
// live buffers, as asm.js buffers are not huge. This is OK in practice.
if (wasm::IsHugeMemoryEnabled(t)) {
liveBufferCount++;
} else {
decrement.release();
}
// Test >= to guard against the case where multiple extant runtimes
// race to allocate.
if (liveBufferCount >= MaximumLiveMappedBuffers) {
if (OnLargeAllocationFailure) {
OnLargeAllocationFailure();
}
if (liveBufferCount >= MaximumLiveMappedBuffers) {
return nullptr;
}
}
#ifdef XP_WIN
void* data = VirtualAlloc(nullptr, mappedSize, MEM_RESERVE, PAGE_NOACCESS);
if (!data) {
return nullptr;
}
if (!VirtualAlloc(data, initialCommittedSize, MEM_COMMIT, PAGE_READWRITE)) {
VirtualFree(data, 0, MEM_RELEASE);
return nullptr;
}
#elif defined(__wasi__)
void* data = nullptr;
if (int err = posix_memalign(&data, gc::SystemPageSize(), mappedSize)) {
MOZ_ASSERT(err == ENOMEM);
return nullptr;
}
MOZ_ASSERT(data);
memset(data, 0, mappedSize);
#else // !XP_WIN && !__wasi__
void* data =
MozTaggedAnonymousMmap(nullptr, mappedSize, PROT_NONE,
MAP_PRIVATE | MAP_ANON, -1, 0, "wasm-reserved");
if (data == MAP_FAILED) {
return nullptr;
}
// Note we will waste a page on zero-sized memories here
if (mprotect(data, initialCommittedSize, PROT_READ | PROT_WRITE)) {
munmap(data, mappedSize);
return nullptr;
}
#endif // !XP_WIN && !__wasi__
#if defined(MOZ_VALGRIND) && \
defined(VALGRIND_DISABLE_ADDR_ERROR_REPORTING_IN_RANGE)
VALGRIND_DISABLE_ADDR_ERROR_REPORTING_IN_RANGE(
(unsigned char*)data + initialCommittedSize,
mappedSize - initialCommittedSize);
#endif
decrement.release();
return data;
}
bool js::CommitBufferMemory(void* dataEnd, size_t delta) {
MOZ_ASSERT(delta);
MOZ_ASSERT(delta % gc::SystemPageSize() == 0);
#ifdef XP_WIN
if (!VirtualAlloc(dataEnd, delta, MEM_COMMIT, PAGE_READWRITE)) {
return false;
}
#elif defined(__wasi__)
// posix_memalign'd memory is already committed
return true;
#else
if (mprotect(dataEnd, delta, PROT_READ | PROT_WRITE)) {
return false;
}
#endif // XP_WIN
#if defined(MOZ_VALGRIND) && \
defined(VALGRIND_DISABLE_ADDR_ERROR_REPORTING_IN_RANGE)
VALGRIND_ENABLE_ADDR_ERROR_REPORTING_IN_RANGE((unsigned char*)dataEnd, delta);
#endif
return true;
}
bool js::ExtendBufferMapping(void* dataPointer, size_t mappedSize,
size_t newMappedSize) {
MOZ_ASSERT(mappedSize % gc::SystemPageSize() == 0);
MOZ_ASSERT(newMappedSize % gc::SystemPageSize() == 0);
MOZ_ASSERT(newMappedSize >= mappedSize);
#ifdef XP_WIN
void* mappedEnd = (char*)dataPointer + mappedSize;
uint32_t delta = newMappedSize - mappedSize;
if (!VirtualAlloc(mappedEnd, delta, MEM_RESERVE, PAGE_NOACCESS)) {
return false;
}
return true;
#elif defined(__wasi__)
return false;
#elif defined(XP_LINUX)
// Note this will not move memory (no MREMAP_MAYMOVE specified)
if (MAP_FAILED == mremap(dataPointer, mappedSize, newMappedSize, 0)) {
return false;
}
return true;
#else
// No mechanism for remapping on MacOS and other Unices. Luckily
// shouldn't need it here as most of these are 64-bit.
return false;
#endif
}
void js::UnmapBufferMemory(wasm::IndexType t, void* base, size_t mappedSize) {
MOZ_ASSERT(mappedSize % gc::SystemPageSize() == 0);
#ifdef XP_WIN
VirtualFree(base, 0, MEM_RELEASE);
#elif defined(__wasi__)
free(base);
#else
munmap(base, mappedSize);
#endif // XP_WIN
#if defined(MOZ_VALGRIND) && \
defined(VALGRIND_ENABLE_ADDR_ERROR_REPORTING_IN_RANGE)
VALGRIND_ENABLE_ADDR_ERROR_REPORTING_IN_RANGE((unsigned char*)base,
mappedSize);
#endif
if (wasm::IsHugeMemoryEnabled(t)) {
// Decrement the buffer counter at the end -- otherwise, a race condition
// could enable the creation of unlimited buffers.
//
// Also see comment in MapBufferMemory about overestimation due to the
// imprecision of the above guard.
--liveBufferCount;
}
}
/*
* ArrayBufferObject
*
* This class holds the underlying raw buffer that the TypedArrayObject classes
* access. It can be created explicitly and passed to a TypedArrayObject, or
* can be created implicitly by constructing a TypedArrayObject with a size.
*/
/*
* ArrayBufferObject (base)
*/
static const JSClassOps ArrayBufferObjectClassOps = {
nullptr, // addProperty
nullptr, // delProperty
nullptr, // enumerate
nullptr, // newEnumerate
nullptr, // resolve
nullptr, // mayResolve
ArrayBufferObject::finalize, // finalize
nullptr, // call
nullptr, // construct
nullptr, // trace
};
static const JSFunctionSpec arraybuffer_functions[] = {
JS_FN("isView", ArrayBufferObject::fun_isView, 1, 0), JS_FS_END};
static const JSPropertySpec arraybuffer_properties[] = {
JS_SELF_HOSTED_SYM_GET(species, "$ArrayBufferSpecies", 0), JS_PS_END};
static const JSFunctionSpec arraybuffer_proto_functions[] = {
JS_SELF_HOSTED_FN("slice", "ArrayBufferSlice", 2, 0), JS_FS_END};
static const JSPropertySpec arraybuffer_proto_properties[] = {
JS_PSG("byteLength", ArrayBufferObject::byteLengthGetter, 0),
JS_STRING_SYM_PS(toStringTag, "ArrayBuffer", JSPROP_READONLY), JS_PS_END};
static const ClassSpec ArrayBufferObjectClassSpec = {
GenericCreateConstructor<ArrayBufferObject::class_constructor, 1,
gc::AllocKind::FUNCTION>,
GenericCreatePrototype<ArrayBufferObject>,
arraybuffer_functions,
arraybuffer_properties,
arraybuffer_proto_functions,
arraybuffer_proto_properties};
static const ClassExtension ArrayBufferObjectClassExtension = {
ArrayBufferObject::objectMoved, // objectMovedOp
};
const JSClass ArrayBufferObject::class_ = {
"ArrayBuffer",
JSCLASS_DELAY_METADATA_BUILDER |
JSCLASS_HAS_RESERVED_SLOTS(RESERVED_SLOTS) |
JSCLASS_HAS_CACHED_PROTO(JSProto_ArrayBuffer) |
JSCLASS_BACKGROUND_FINALIZE,
&ArrayBufferObjectClassOps, &ArrayBufferObjectClassSpec,
&ArrayBufferObjectClassExtension};
const JSClass ArrayBufferObject::protoClass_ = {
"ArrayBuffer.prototype", JSCLASS_HAS_CACHED_PROTO(JSProto_ArrayBuffer),
JS_NULL_CLASS_OPS, &ArrayBufferObjectClassSpec};
static bool IsArrayBuffer(HandleValue v) {
return v.isObject() && v.toObject().is<ArrayBufferObject>();
}
MOZ_ALWAYS_INLINE bool ArrayBufferObject::byteLengthGetterImpl(
JSContext* cx, const CallArgs& args) {
MOZ_ASSERT(IsArrayBuffer(args.thisv()));
auto* buffer = &args.thisv().toObject().as<ArrayBufferObject>();
args.rval().setNumber(buffer->byteLength());
return true;
}
bool ArrayBufferObject::byteLengthGetter(JSContext* cx, unsigned argc,
Value* vp) {
CallArgs args = CallArgsFromVp(argc, vp);
return CallNonGenericMethod<IsArrayBuffer, byteLengthGetterImpl>(cx, args);
}
/*
* ArrayBuffer.isView(obj); ES6 (Dec 2013 draft) 24.1.3.1
*/
bool ArrayBufferObject::fun_isView(JSContext* cx, unsigned argc, Value* vp) {
CallArgs args = CallArgsFromVp(argc, vp);
args.rval().setBoolean(args.get(0).isObject() &&
JS_IsArrayBufferViewObject(&args.get(0).toObject()));
return true;
}
// ES2017 draft 24.1.2.1
bool ArrayBufferObject::class_constructor(JSContext* cx, unsigned argc,
Value* vp) {
CallArgs args = CallArgsFromVp(argc, vp);
// Step 1.
if (!ThrowIfNotConstructing(cx, args, "ArrayBuffer")) {
return false;
}
// Step 2.
uint64_t byteLength;
if (!ToIndex(cx, args.get(0), &byteLength)) {
return false;
}
// Step 3 (Inlined 24.1.1.1 AllocateArrayBuffer).
// 24.1.1.1, step 1 (Inlined 9.1.14 OrdinaryCreateFromConstructor).
RootedObject proto(cx);
if (!GetPrototypeFromBuiltinConstructor(cx, args, JSProto_ArrayBuffer,
&proto)) {
return false;
}
// 24.1.1.1, step 3 (Inlined 6.2.6.1 CreateByteDataBlock, step 2).
if (!CheckArrayBufferTooLarge(cx, byteLength)) {
return false;
}
// 24.1.1.1, steps 1 and 4-6.
JSObject* bufobj = createZeroed(cx, byteLength, proto);
if (!bufobj) {
return false;
}
args.rval().setObject(*bufobj);
return true;
}
using ArrayBufferContents = UniquePtr<uint8_t[], JS::FreePolicy>;
static ArrayBufferContents AllocateUninitializedArrayBufferContents(
JSContext* cx, size_t nbytes) {
// First attempt a normal allocation.
uint8_t* p =
cx->maybe_pod_arena_malloc<uint8_t>(js::ArrayBufferContentsArena, nbytes);
if (MOZ_UNLIKELY(!p)) {
// Otherwise attempt a large allocation, calling the
// large-allocation-failure callback if necessary.
p = static_cast<uint8_t*>(cx->runtime()->onOutOfMemoryCanGC(
js::AllocFunction::Malloc, js::ArrayBufferContentsArena, nbytes));
if (!p) {
ReportOutOfMemory(cx);
}
}
return ArrayBufferContents(p);
}
static ArrayBufferContents AllocateArrayBufferContents(JSContext* cx,
size_t nbytes) {
// First attempt a normal allocation.
uint8_t* p =
cx->maybe_pod_arena_calloc<uint8_t>(js::ArrayBufferContentsArena, nbytes);
if (MOZ_UNLIKELY(!p)) {
// Otherwise attempt a large allocation, calling the
// large-allocation-failure callback if necessary.
p = static_cast<uint8_t*>(cx->runtime()->onOutOfMemoryCanGC(
js::AllocFunction::Calloc, js::ArrayBufferContentsArena, nbytes));
if (!p) {
ReportOutOfMemory(cx);
}
}
return ArrayBufferContents(p);
}
static ArrayBufferContents NewCopiedBufferContents(
JSContext* cx, Handle<ArrayBufferObject*> buffer) {
ArrayBufferContents dataCopy =
AllocateUninitializedArrayBufferContents(cx, buffer->byteLength());
if (dataCopy) {
if (auto count = buffer->byteLength()) {
memcpy(dataCopy.get(), buffer->dataPointer(), count);
}
}
return dataCopy;
}
/* static */
void ArrayBufferObject::detach(JSContext* cx,
Handle<ArrayBufferObject*> buffer) {
cx->check(buffer);
MOZ_ASSERT(!buffer->isPreparedForAsmJS());
// Update all views of the buffer to account for the buffer having been
// detached, and clear the buffer's data and list of views.
//
// Typed object buffers are not exposed and cannot be detached.
auto& innerViews = ObjectRealm::get(buffer).innerViews.get();
if (InnerViewTable::ViewVector* views =
innerViews.maybeViewsUnbarriered(buffer)) {
for (size_t i = 0; i < views->length(); i++) {
JSObject* view = (*views)[i];
view->as<ArrayBufferViewObject>().notifyBufferDetached();
}
innerViews.removeViews(buffer);
}
if (JSObject* view = buffer->firstView()) {
view->as<ArrayBufferViewObject>().notifyBufferDetached();
buffer->setFirstView(nullptr);
}
if (buffer->dataPointer()) {
buffer->releaseData(cx->gcContext());
buffer->setDataPointer(BufferContents::createNoData());
}
buffer->setByteLength(0);
buffer->setIsDetached();
}
/* clang-format off */
/*
* [SMDOC] WASM Linear Memory structure
*
* Wasm Raw Buf Linear Memory Structure
*
* The linear heap in Wasm is an mmaped array buffer. Several constants manage
* its lifetime:
*
* - byteLength - the wasm-visible current length of the buffer in
* bytes. Accesses in the range [0, byteLength] succeed. May only increase.
*
* - boundsCheckLimit - the size against which we perform bounds checks. The
* value of this depends on the bounds checking strategy chosen for the array
* buffer and the specific bounds checking semantics. For asm.js code and
* for wasm code running with explicit bounds checking, it is the always the
* same as the byteLength. For wasm code using the huge-memory trick, it is
* always wasm::GuardSize smaller than mappedSize.
*
* See also "Linear memory addresses and bounds checking" in
* wasm/WasmMemory.cpp.
*
* See also WasmMemoryObject::boundsCheckLimit().
*
* - sourceMaxSize - the optional declared limit on how far byteLength can grow
* in pages. This is the unmodified maximum size from the source module or
* JS-API invocation. This may not be representable in byte lengths, nor
* feasible for a module to actually grow to due to implementation limits.
* It is used for correct linking checks and js-types reflection.
*
* - clampedMaxSize - the maximum size on how far the byteLength can grow in
* pages. This value respects implementation limits and is always
* representable as a byte length. Every memory has a clampedMaxSize, even if
* no maximum was specified in source. When a memory has no sourceMaxSize,
* the clampedMaxSize will be the maximum amount of memory that can be grown
* to while still respecting implementation limits.
*
* - mappedSize - the actual mmapped size. Access in the range [0, mappedSize]
* will either succeed, or be handled by the wasm signal handlers. If
* sourceMaxSize is present at initialization, then we attempt to map the
* whole clampedMaxSize. Otherwise we only map the region needed for the
* initial size.
*
* The below diagram shows the layout of the wasm heap. The wasm-visible portion
* of the heap starts at 0. There is one extra page prior to the start of the
* wasm heap which contains the WasmArrayRawBuffer struct at its end (i.e. right
* before the start of the WASM heap).
*
* WasmArrayRawBuffer
* \ ArrayBufferObject::dataPointer()
* \ /
* \ |
* ______|_|______________________________________________________
* |______|_|______________|___________________|___________________|
* 0 byteLength clampedMaxSize mappedSize
*
* \_______________________/
* COMMITED
* \_____________________________________/
* SLOP
* \______________________________________________________________/
* MAPPED
*
* Invariants on byteLength, clampedMaxSize, and mappedSize:
* - byteLength only increases
* - 0 <= byteLength <= clampedMaxSize <= mappedSize
* - if sourceMaxSize is not specified, mappedSize may grow.
* It is otherwise constant.
* - initialLength <= clampedMaxSize <= sourceMaxSize (if present)
* - clampedMaxSize <= wasm::MaxMemoryPages()
*
* Invariants on boundsCheckLimit:
* - for wasm code with the huge-memory trick,
* clampedMaxSize <= boundsCheckLimit <= mappedSize
* - for asm.js code or wasm with explicit bounds checking,
* byteLength == boundsCheckLimit <= clampedMaxSize
* - on ARM, boundsCheckLimit must be a valid ARM immediate.
* - if sourceMaxSize is not specified, boundsCheckLimit may grow as
* mappedSize grows. They are otherwise constant.
* NOTE: For asm.js on 32-bit platforms and on all platforms when running with
* explicit bounds checking, we guarantee that
*
* byteLength == maxSize == boundsCheckLimit == mappedSize
*
* That is, signal handlers will not be invoked.
*
* The region between byteLength and mappedSize is the SLOP - an area where we use
* signal handlers to catch things that slip by bounds checks. Logically it has
* two parts:
*
* - from byteLength to boundsCheckLimit - this part of the SLOP serves to catch
* accesses to memory we have reserved but not yet grown into. This allows us
* to grow memory up to max (when present) without having to patch/update the
* bounds checks.
*
* - from boundsCheckLimit to mappedSize - this part of the SLOP allows us to
* bounds check against base pointers and fold some constant offsets inside
* loads. This enables better Bounds Check Elimination. See "Linear memory
* addresses and bounds checking" in wasm/WasmMemory.cpp.
*
*/
/* clang-format on */
[[nodiscard]] bool WasmArrayRawBuffer::growToPagesInPlace(Pages newPages) {
size_t newSize = newPages.byteLength();
size_t oldSize = byteLength();
MOZ_ASSERT(newSize >= oldSize);
MOZ_ASSERT(newPages <= clampedMaxPages());
MOZ_ASSERT(newSize <= mappedSize());
size_t delta = newSize - oldSize;
MOZ_ASSERT(delta % wasm::PageSize == 0);
uint8_t* dataEnd = dataPointer() + oldSize;
MOZ_ASSERT(uintptr_t(dataEnd) % gc::SystemPageSize() == 0);
if (delta && !CommitBufferMemory(dataEnd, delta)) {
return false;
}
length_ = newSize;
return true;
}
bool WasmArrayRawBuffer::extendMappedSize(Pages maxPages) {
size_t newMappedSize = wasm::ComputeMappedSize(maxPages);
MOZ_ASSERT(mappedSize_ <= newMappedSize);
if (mappedSize_ == newMappedSize) {
return true;
}
if (!ExtendBufferMapping(dataPointer(), mappedSize_, newMappedSize)) {
return false;
}
mappedSize_ = newMappedSize;
return true;
}
void WasmArrayRawBuffer::tryGrowMaxPagesInPlace(Pages deltaMaxPages) {
Pages newMaxPages = clampedMaxPages_;
DebugOnly<bool> valid = newMaxPages.checkedIncrement(deltaMaxPages);
// Caller must ensure increment does not overflow or increase over the
// specified maximum pages.
MOZ_ASSERT(valid);
MOZ_ASSERT_IF(sourceMaxPages_.isSome(), newMaxPages <= *sourceMaxPages_);
if (!extendMappedSize(newMaxPages)) {
return;
}
clampedMaxPages_ = newMaxPages;
}
/* static */
WasmArrayRawBuffer* WasmArrayRawBuffer::AllocateWasm(
IndexType indexType, Pages initialPages, Pages clampedMaxPages,
const Maybe<Pages>& sourceMaxPages, const Maybe<size_t>& mapped) {
// Prior code has asserted that initial pages is within our implementation
// limits (wasm::MaxMemoryPages) and we can assume it is a valid size_t.
MOZ_ASSERT(initialPages.hasByteLength());
size_t numBytes = initialPages.byteLength();
// If there is a specified maximum, attempt to map the whole range for
// clampedMaxPages. Or else map only what's required for initialPages.
Pages initialMappedPages =
sourceMaxPages.isSome() ? clampedMaxPages : initialPages;
// Use an override mapped size, or else compute the mapped size from
// initialMappedPages.
size_t mappedSize =
mapped.isSome() ? *mapped : wasm::ComputeMappedSize(initialMappedPages);
MOZ_RELEASE_ASSERT(mappedSize <= SIZE_MAX - gc::SystemPageSize());
MOZ_RELEASE_ASSERT(numBytes <= SIZE_MAX - gc::SystemPageSize());
MOZ_RELEASE_ASSERT(initialPages <= clampedMaxPages);
MOZ_ASSERT(numBytes % gc::SystemPageSize() == 0);
MOZ_ASSERT(mappedSize % gc::SystemPageSize() == 0);
uint64_t mappedSizeWithHeader = mappedSize + gc::SystemPageSize();
uint64_t numBytesWithHeader = numBytes + gc::SystemPageSize();
void* data = MapBufferMemory(indexType, (size_t)mappedSizeWithHeader,
(size_t)numBytesWithHeader);
if (!data) {
return nullptr;
}
uint8_t* base = reinterpret_cast<uint8_t*>(data) + gc::SystemPageSize();
uint8_t* header = base - sizeof(WasmArrayRawBuffer);
auto rawBuf = new (header) WasmArrayRawBuffer(
indexType, base, clampedMaxPages, sourceMaxPages, mappedSize, numBytes);
return rawBuf;
}
/* static */
void WasmArrayRawBuffer::Release(void* mem) {
WasmArrayRawBuffer* header =
(WasmArrayRawBuffer*)((uint8_t*)mem - sizeof(WasmArrayRawBuffer));
MOZ_RELEASE_ASSERT(header->mappedSize() <= SIZE_MAX - gc::SystemPageSize());
size_t mappedSizeWithHeader = header->mappedSize() + gc::SystemPageSize();
static_assert(std::is_trivially_destructible_v<WasmArrayRawBuffer>,
"no need to call the destructor");
UnmapBufferMemory(header->indexType(), header->basePointer(),
mappedSizeWithHeader);
}
WasmArrayRawBuffer* ArrayBufferObject::BufferContents::wasmBuffer() const {
MOZ_RELEASE_ASSERT(kind_ == WASM);
return (WasmArrayRawBuffer*)(data_ - sizeof(WasmArrayRawBuffer));
}
template <typename ObjT, typename RawbufT>
static bool CreateSpecificWasmBuffer(
JSContext* cx, const wasm::MemoryDesc& memory,
MutableHandleArrayBufferObjectMaybeShared maybeSharedObject) {
bool useHugeMemory = wasm::IsHugeMemoryEnabled(memory.indexType());
Pages initialPages = memory.initialPages();
Maybe<Pages> sourceMaxPages = memory.maximumPages();
Pages clampedMaxPages = wasm::ClampedMaxPages(
memory.indexType(), initialPages, sourceMaxPages, useHugeMemory);
Maybe<size_t> mappedSize;
#ifdef WASM_SUPPORTS_HUGE_MEMORY
// Override the mapped size if we are using huge memory. If we are not, then
// it will be calculated by the raw buffer we are using.
if (useHugeMemory) {
mappedSize = Some(wasm::HugeMappedSize);
}
#endif
RawbufT* buffer =
RawbufT::AllocateWasm(memory.limits.indexType, initialPages,
clampedMaxPages, sourceMaxPages, mappedSize);
if (!buffer) {
if (useHugeMemory) {
WarnNumberASCII(cx, JSMSG_WASM_HUGE_MEMORY_FAILED);
if (cx->isExceptionPending()) {
cx->clearPendingException();
}
ReportOutOfMemory(cx);
return false;
}
// If we fail, and have a sourceMaxPages, try to reserve the biggest
// chunk in the range [initialPages, clampedMaxPages) using log backoff.
if (!sourceMaxPages) {
wasm::Log(cx, "new Memory({initial=%" PRIu64 " pages}) failed",
initialPages.value());
ReportOutOfMemory(cx);
return false;
}
uint64_t cur = clampedMaxPages.value() / 2;
for (; Pages(cur) > initialPages; cur /= 2) {
buffer = RawbufT::AllocateWasm(memory.limits.indexType, initialPages,
Pages(cur), sourceMaxPages, mappedSize);
if (buffer) {
break;
}
}
if (!buffer) {
wasm::Log(cx, "new Memory({initial=%" PRIu64 " pages}) failed",
initialPages.value());
ReportOutOfMemory(cx);
return false;
}
// Try to grow our chunk as much as possible.
for (size_t d = cur / 2; d >= 1; d /= 2) {
buffer->tryGrowMaxPagesInPlace(Pages(d));
}
}
// ObjT::createFromNewRawBuffer assumes ownership of |buffer| even in case
// of failure.
RootedArrayBufferObjectMaybeShared object(
cx, ObjT::createFromNewRawBuffer(cx, buffer, initialPages.byteLength()));
if (!object) {
return false;
}
maybeSharedObject.set(object);
// See MaximumLiveMappedBuffers comment above.
if (liveBufferCount > StartSyncFullGCAtLiveBufferCount) {
JS::PrepareForFullGC(cx);
JS::NonIncrementalGC(cx, JS::GCOptions::Normal,
JS::GCReason::TOO_MUCH_WASM_MEMORY);
allocatedSinceLastTrigger = 0;
} else if (liveBufferCount > StartTriggeringAtLiveBufferCount) {
allocatedSinceLastTrigger++;
if (allocatedSinceLastTrigger > AllocatedBuffersPerTrigger) {
(void)cx->runtime()->gc.triggerGC(JS::GCReason::TOO_MUCH_WASM_MEMORY);
allocatedSinceLastTrigger = 0;
}
} else {
allocatedSinceLastTrigger = 0;
}
// Log the result with details on the memory allocation
if (sourceMaxPages) {
if (useHugeMemory) {
wasm::Log(cx,
"new Memory({initial:%" PRIu64 " pages, maximum:%" PRIu64
" pages}) succeeded",
initialPages.value(), sourceMaxPages->value());
} else {
wasm::Log(cx,
"new Memory({initial:%" PRIu64 " pages, maximum:%" PRIu64
" pages}) succeeded "
"with internal maximum of %" PRIu64 " pages",
initialPages.value(), sourceMaxPages->value(),
object->wasmClampedMaxPages().value());
}
} else {
wasm::Log(cx, "new Memory({initial:%" PRIu64 " pages}) succeeded",
initialPages.value());
}
return true;
}
bool js::CreateWasmBuffer(JSContext* cx, const wasm::MemoryDesc& memory,
MutableHandleArrayBufferObjectMaybeShared buffer) {
MOZ_RELEASE_ASSERT(memory.initialPages() <=
wasm::MaxMemoryPages(memory.indexType()));
MOZ_RELEASE_ASSERT(cx->wasm().haveSignalHandlers);
if (memory.isShared()) {
if (!cx->realm()->creationOptions().getSharedMemoryAndAtomicsEnabled()) {
JS_ReportErrorNumberASCII(cx, GetErrorMessage, nullptr,
JSMSG_WASM_NO_SHMEM_LINK);
return false;
}
return CreateSpecificWasmBuffer<SharedArrayBufferObject,
WasmSharedArrayRawBuffer>(cx, memory,
buffer);
}
return CreateSpecificWasmBuffer<ArrayBufferObject, WasmArrayRawBuffer>(
cx, memory, buffer);
}
bool ArrayBufferObject::prepareForAsmJS() {
MOZ_ASSERT(byteLength() % wasm::PageSize == 0,
"prior size checking should have guaranteed page-size multiple");
MOZ_ASSERT(byteLength() > 0,
"prior size checking should have excluded empty buffers");
switch (bufferKind()) {
case MALLOCED:
case MAPPED:
case EXTERNAL:
// It's okay if this uselessly sets the flag a second time.
setIsPreparedForAsmJS();
return true;
case INLINE_DATA:
static_assert(wasm::PageSize > MaxInlineBytes,
"inline data must be too small to be a page size multiple");
MOZ_ASSERT_UNREACHABLE(
"inline-data buffers should be implicitly excluded by size checks");
return false;
case NO_DATA:
MOZ_ASSERT_UNREACHABLE(
"size checking should have excluded detached or empty buffers");
return false;
// asm.js code and associated buffers are potentially long-lived. Yet a
// buffer of user-owned data *must* be detached by the user before the
// user-owned data is disposed. No caller wants to use a user-owned
// ArrayBuffer with asm.js, so just don't support this and avoid a mess of
// complexity.
case USER_OWNED:
// wasm buffers can be detached at any time.
case WASM:
MOZ_ASSERT(!isPreparedForAsmJS());
return false;
case BAD1:
MOZ_ASSERT_UNREACHABLE("invalid bufferKind() encountered");
return false;
}
MOZ_ASSERT_UNREACHABLE("non-exhaustive kind-handling switch?");
return false;
}
ArrayBufferObject::BufferContents ArrayBufferObject::createMappedContents(
int fd, size_t offset, size_t length) {
void* data =
gc::AllocateMappedContent(fd, offset, length, ARRAY_BUFFER_ALIGNMENT);
return BufferContents::createMapped(data);
}
uint8_t* ArrayBufferObject::inlineDataPointer() const {
return static_cast<uint8_t*>(fixedData(JSCLASS_RESERVED_SLOTS(&class_)));
}
uint8_t* ArrayBufferObject::dataPointer() const {
return static_cast<uint8_t*>(getFixedSlot(DATA_SLOT).toPrivate());
}
SharedMem<uint8_t*> ArrayBufferObject::dataPointerShared() const {
return SharedMem<uint8_t*>::unshared(getFixedSlot(DATA_SLOT).toPrivate());
}
ArrayBufferObject::FreeInfo* ArrayBufferObject::freeInfo() const {
MOZ_ASSERT(isExternal());
return reinterpret_cast<FreeInfo*>(inlineDataPointer());
}
void ArrayBufferObject::releaseData(JS::GCContext* gcx) {
switch (bufferKind()) {
case INLINE_DATA:
// Inline data doesn't require releasing.
break;
case MALLOCED:
gcx->free_(this, dataPointer(), byteLength(),
MemoryUse::ArrayBufferContents);
break;
case NO_DATA:
// There's nothing to release if there's no data.
MOZ_ASSERT(dataPointer() == nullptr);
break;
case USER_OWNED:
// User-owned data is released by, well, the user.
break;
case MAPPED:
gc::DeallocateMappedContent(dataPointer(), byteLength());
gcx->removeCellMemory(this, associatedBytes(),
MemoryUse::ArrayBufferContents);
break;
case WASM:
WasmArrayRawBuffer::Release(dataPointer());
gcx->removeCellMemory(this, byteLength(), MemoryUse::ArrayBufferContents);
break;
case EXTERNAL:
if (freeInfo()->freeFunc) {
// The analyzer can't know for sure whether the embedder-supplied
// free function will GC. We give the analyzer a hint here.
// (Doing a GC in the free function is considered a programmer
// error.)
JS::AutoSuppressGCAnalysis nogc;
freeInfo()->freeFunc(dataPointer(), freeInfo()->freeUserData);
}
break;
case BAD1:
MOZ_CRASH("invalid BufferKind encountered");
break;
}
}
void ArrayBufferObject::setDataPointer(BufferContents contents) {
setFixedSlot(DATA_SLOT, PrivateValue(contents.data()));
setFlags((flags() & ~KIND_MASK) | contents.kind());
if (isExternal()) {
auto info = freeInfo();
info->freeFunc = contents.freeFunc();
info->freeUserData = contents.freeUserData();
}
}
size_t ArrayBufferObject::byteLength() const {
return size_t(getFixedSlot(BYTE_LENGTH_SLOT).toPrivate());
}
inline size_t ArrayBufferObject::associatedBytes() const {
if (bufferKind() == MALLOCED) {
return byteLength();
}
if (bufferKind() == MAPPED) {
return RoundUp(byteLength(), js::gc::SystemPageSize());
}
MOZ_CRASH("Unexpected buffer kind");
}
void ArrayBufferObject::setByteLength(size_t length) {
MOZ_ASSERT(length <= ArrayBufferObject::MaxByteLength);
setFixedSlot(BYTE_LENGTH_SLOT, PrivateValue(length));
}
size_t ArrayBufferObject::wasmMappedSize() const {
if (isWasm()) {
return contents().wasmBuffer()->mappedSize();
}
return byteLength();
}
IndexType ArrayBufferObject::wasmIndexType() const {
if (isWasm()) {
return contents().wasmBuffer()->indexType();
}
MOZ_ASSERT(isPreparedForAsmJS());
return wasm::IndexType::I32;
}
Pages ArrayBufferObject::wasmPages() const {
if (isWasm()) {
return contents().wasmBuffer()->pages();
}
MOZ_ASSERT(isPreparedForAsmJS());
return Pages::fromByteLengthExact(byteLength());
}
Pages ArrayBufferObject::wasmClampedMaxPages() const {
if (isWasm()) {
return contents().wasmBuffer()->clampedMaxPages();
}
MOZ_ASSERT(isPreparedForAsmJS());
return Pages::fromByteLengthExact(byteLength());
}
Maybe<Pages> ArrayBufferObject::wasmSourceMaxPages() const {
if (isWasm()) {
return contents().wasmBuffer()->sourceMaxPages();
}
MOZ_ASSERT(isPreparedForAsmJS());
return Some<Pages>(Pages::fromByteLengthExact(byteLength()));
}
size_t js::WasmArrayBufferMappedSize(const ArrayBufferObjectMaybeShared* buf) {
if (buf->is<ArrayBufferObject>()) {
return buf->as<ArrayBufferObject>().wasmMappedSize();
}
return buf->as<SharedArrayBufferObject>().wasmMappedSize();
}
IndexType js::WasmArrayBufferIndexType(
const ArrayBufferObjectMaybeShared* buf) {
if (buf->is<ArrayBufferObject>()) {
return buf->as<ArrayBufferObject>().wasmIndexType();
}
return buf->as<SharedArrayBufferObject>().wasmIndexType();
}
Pages js::WasmArrayBufferPages(const ArrayBufferObjectMaybeShared* buf) {
if (buf->is<ArrayBufferObject>()) {
return buf->as<ArrayBufferObject>().wasmPages();
}
return buf->as<SharedArrayBufferObject>().volatileWasmPages();
}
Pages js::WasmArrayBufferClampedMaxPages(
const ArrayBufferObjectMaybeShared* buf) {
if (buf->is<ArrayBufferObject>()) {
return buf->as<ArrayBufferObject>().wasmClampedMaxPages();
}
return buf->as<SharedArrayBufferObject>().wasmClampedMaxPages();
}
Maybe<Pages> js::WasmArrayBufferSourceMaxPages(
const ArrayBufferObjectMaybeShared* buf) {
if (buf->is<ArrayBufferObject>()) {
return buf->as<ArrayBufferObject>().wasmSourceMaxPages();
}
return Some(buf->as<SharedArrayBufferObject>().wasmSourceMaxPages());
}
static void CheckStealPreconditions(Handle<ArrayBufferObject*> buffer,
JSContext* cx) {
cx->check(buffer);
MOZ_ASSERT(!buffer->isDetached(), "can't steal from a detached buffer");
MOZ_ASSERT(!buffer->isPreparedForAsmJS(),
"asm.js-prepared buffers don't have detachable/stealable data");
}
/* static */
bool ArrayBufferObject::wasmGrowToPagesInPlace(
wasm::IndexType t, Pages newPages, HandleArrayBufferObject oldBuf,
MutableHandleArrayBufferObject newBuf, JSContext* cx) {
CheckStealPreconditions(oldBuf, cx);
MOZ_ASSERT(oldBuf->isWasm());
// Check that the new pages is within our allowable range. This will
// simultaneously check against the maximum specified in source and our
// implementation limits.
if (newPages > oldBuf->wasmClampedMaxPages()) {
return false;
}
MOZ_ASSERT(newPages <= wasm::MaxMemoryPages(t) &&
newPages.byteLength() <= ArrayBufferObject::MaxByteLength);
// We have checked against the clamped maximum and so we know we can convert
// to byte lengths now.
size_t newSize = newPages.byteLength();
// On failure, do not throw and ensure that the original buffer is
// unmodified and valid. After WasmArrayRawBuffer::growToPagesInPlace(), the
// wasm-visible length of the buffer has been increased so it must be the
// last fallible operation.
newBuf.set(ArrayBufferObject::createEmpty(cx));
if (!newBuf) {
cx->clearPendingException();
return false;
}
MOZ_ASSERT(newBuf->isNoData());
if (!oldBuf->contents().wasmBuffer()->growToPagesInPlace(newPages)) {
return false;
}
// Extract the grown contents from |oldBuf|.
BufferContents oldContents = oldBuf->contents();
// Overwrite |oldBuf|'s data pointer *without* releasing old data.
oldBuf->setDataPointer(BufferContents::createNoData());
// Detach |oldBuf| now that doing so won't release |oldContents|.
RemoveCellMemory(oldBuf, oldBuf->byteLength(),
MemoryUse::ArrayBufferContents);
ArrayBufferObject::detach(cx, oldBuf);
// Set |newBuf|'s contents to |oldBuf|'s original contents.
newBuf->initialize(newSize, oldContents);
AddCellMemory(newBuf, newSize, MemoryUse::ArrayBufferContents);
return true;
}
/* static */
bool ArrayBufferObject::wasmMovingGrowToPages(
IndexType t, Pages newPages, HandleArrayBufferObject oldBuf,
MutableHandleArrayBufferObject newBuf, JSContext* cx) {
// On failure, do not throw and ensure that the original buffer is
// unmodified and valid.
// Check that the new pages is within our allowable range. This will
// simultaneously check against the maximum specified in source and our
// implementation limits.
if (newPages > oldBuf->wasmClampedMaxPages()) {
return false;
}
MOZ_ASSERT(newPages <= wasm::MaxMemoryPages(t) &&
newPages.byteLength() < ArrayBufferObject::MaxByteLength);
// We have checked against the clamped maximum and so we know we can convert
// to byte lengths now.
size_t newSize = newPages.byteLength();
if (wasm::ComputeMappedSize(newPages) <= oldBuf->wasmMappedSize() ||
oldBuf->contents().wasmBuffer()->extendMappedSize(newPages)) {
return wasmGrowToPagesInPlace(t, newPages, oldBuf, newBuf, cx);
}
newBuf.set(ArrayBufferObject::createEmpty(cx));
if (!newBuf) {
cx->clearPendingException();
return false;
}
Pages clampedMaxPages =
wasm::ClampedMaxPages(t, newPages, Nothing(), /* hugeMemory */ false);
WasmArrayRawBuffer* newRawBuf = WasmArrayRawBuffer::AllocateWasm(
oldBuf->wasmIndexType(), newPages, clampedMaxPages, Nothing(), Nothing());
if (!newRawBuf) {
return false;
}
AddCellMemory(newBuf, newSize, MemoryUse::ArrayBufferContents);
BufferContents contents =
BufferContents::createWasm(newRawBuf->dataPointer());
newBuf->initialize(newSize, contents);
memcpy(newBuf->dataPointer(), oldBuf->dataPointer(), oldBuf->byteLength());
ArrayBufferObject::detach(cx, oldBuf);
return true;
}
uint32_t ArrayBufferObject::flags() const {
return uint32_t(getFixedSlot(FLAGS_SLOT).toInt32());
}
void ArrayBufferObject::setFlags(uint32_t flags) {
setFixedSlot(FLAGS_SLOT, Int32Value(flags));
}
static inline js::gc::AllocKind GetArrayBufferGCObjectKind(size_t numSlots) {
if (numSlots <= 4) {
return js::gc::AllocKind::ARRAYBUFFER4;
}
if (numSlots <= 8) {
return js::gc::AllocKind::ARRAYBUFFER8;
}
if (numSlots <= 12) {
return js::gc::AllocKind::ARRAYBUFFER12;
}
return js::gc::AllocKind::ARRAYBUFFER16;
}
static ArrayBufferObject* NewArrayBufferObject(JSContext* cx,
HandleObject proto_,
gc::AllocKind allocKind) {
MOZ_ASSERT(allocKind == gc::AllocKind::ARRAYBUFFER4 ||
allocKind == gc::AllocKind::ARRAYBUFFER8 ||
allocKind == gc::AllocKind::ARRAYBUFFER12 ||
allocKind == gc::AllocKind::ARRAYBUFFER16);
RootedObject proto(cx, proto_);
if (!proto) {
proto = GlobalObject::getOrCreatePrototype(cx, JSProto_ArrayBuffer);
if (!proto) {
return nullptr;
}
}
const JSClass* clasp = &ArrayBufferObject::class_;
// Array buffers can store data inline so we only use fixed slots to cover the
// reserved slots, ignoring the AllocKind.
MOZ_ASSERT(ClassCanHaveFixedData(clasp));
constexpr size_t nfixed = ArrayBufferObject::RESERVED_SLOTS;
static_assert(nfixed <= NativeObject::MAX_FIXED_SLOTS);
Rooted<SharedShape*> shape(
cx,
SharedShape::getInitialShape(cx, clasp, cx->realm(), AsTaggedProto(proto),
nfixed, ObjectFlags()));
if (!shape) {
return nullptr;
}
// Array buffers can't be nursery allocated but can be background-finalized.
MOZ_ASSERT(IsBackgroundFinalized(allocKind));
MOZ_ASSERT(!CanNurseryAllocateFinalizedClass(clasp));
constexpr gc::InitialHeap heap = gc::TenuredHeap;
NativeObject* obj = NativeObject::create(cx, allocKind, heap, shape);
if (!obj) {
return nullptr;
}
return &obj->as<ArrayBufferObject>();
}
// Creates a new ArrayBufferObject with %ArrayBuffer.prototype% as proto and no
// space for inline data.
static ArrayBufferObject* NewArrayBufferObject(JSContext* cx) {
static_assert(ArrayBufferObject::RESERVED_SLOTS == 4);
return NewArrayBufferObject(cx, nullptr, gc::AllocKind::ARRAYBUFFER4);
}
ArrayBufferObject* ArrayBufferObject::createForContents(
JSContext* cx, size_t nbytes, BufferContents contents) {
MOZ_ASSERT(contents);
MOZ_ASSERT(contents.kind() != INLINE_DATA);
MOZ_ASSERT(contents.kind() != NO_DATA);
MOZ_ASSERT(contents.kind() != WASM);
// 24.1.1.1, step 3 (Inlined 6.2.6.1 CreateByteDataBlock, step 2).
if (!CheckArrayBufferTooLarge(cx, nbytes)) {
return nullptr;
}
// Some |contents| kinds need to store extra data in the ArrayBuffer beyond a
// data pointer. If needed for the particular kind, add extra fixed slots to
// the ArrayBuffer for use as raw storage to store such information.
constexpr size_t reservedSlots = ArrayBufferObject::RESERVED_SLOTS;
size_t nAllocated = 0;
size_t nslots = reservedSlots;
if (contents.kind() == USER_OWNED) {
// No accounting to do in this case.
} else if (contents.kind() == EXTERNAL) {
// Store the FreeInfo in the inline data slots so that we
// don't use up slots for it in non-refcounted array buffers.
size_t freeInfoSlots = HowMany(sizeof(FreeInfo), sizeof(Value));
MOZ_ASSERT(reservedSlots + freeInfoSlots <= NativeObject::MAX_FIXED_SLOTS,
"FreeInfo must fit in inline slots");
nslots += freeInfoSlots;
} else {
// The ABO is taking ownership, so account the bytes against the zone.
nAllocated = nbytes;
if (contents.kind() == MAPPED) {
nAllocated = RoundUp(nbytes, js::gc::SystemPageSize());
} else {
MOZ_ASSERT(contents.kind() == MALLOCED,
"should have handled all possible callers' kinds");
}
}
gc::AllocKind allocKind = GetArrayBufferGCObjectKind(nslots);
AutoSetNewObjectMetadata metadata(cx);
Rooted<ArrayBufferObject*> buffer(
cx, NewArrayBufferObject(cx, nullptr, allocKind));
if (!buffer) {
return nullptr;
}
MOZ_ASSERT(!gc::IsInsideNursery(buffer),
"ArrayBufferObject has a finalizer that must be called to not "
"leak in some cases, so it can't be nursery-allocated");
buffer->initialize(nbytes, contents);
if (contents.kind() == MAPPED || contents.kind() == MALLOCED) {
AddCellMemory(buffer, nAllocated, MemoryUse::ArrayBufferContents);
}
return buffer;
}
template <ArrayBufferObject::FillContents FillType>
/* static */ std::tuple<ArrayBufferObject*, uint8_t*>
ArrayBufferObject::createBufferAndData(
JSContext* cx, size_t nbytes, AutoSetNewObjectMetadata&,
JS::Handle<JSObject*> proto /* = nullptr */) {
MOZ_ASSERT(nbytes <= ArrayBufferObject::MaxByteLength,
"caller must validate the byte count it passes");
// Try fitting the data inline with the object by repurposing fixed-slot
// storage. Add extra fixed slots if necessary to accomplish this, but don't
// exceed the maximum number of fixed slots!
size_t nslots = ArrayBufferObject::RESERVED_SLOTS;
ArrayBufferContents data;
if (nbytes <= MaxInlineBytes) {
int newSlots = HowMany(nbytes, sizeof(Value));
MOZ_ASSERT(int(nbytes) <= newSlots * int(sizeof(Value)));
nslots += newSlots;
} else {
data = FillType == FillContents::Uninitialized
? AllocateUninitializedArrayBufferContents(cx, nbytes)
: AllocateArrayBufferContents(cx, nbytes);
if (!data) {
return {nullptr, nullptr};
}
}
gc::AllocKind allocKind = GetArrayBufferGCObjectKind(nslots);
ArrayBufferObject* buffer = NewArrayBufferObject(cx, proto, allocKind);
if (!buffer) {
return {nullptr, nullptr};
}
MOZ_ASSERT(!gc::IsInsideNursery(buffer),
"ArrayBufferObject has a finalizer that must be called to not "
"leak in some cases, so it can't be nursery-allocated");
uint8_t* toFill;
if (data) {
toFill = data.release();
buffer->initialize(nbytes, BufferContents::createMalloced(toFill));
AddCellMemory(buffer, nbytes, MemoryUse::ArrayBufferContents);
} else {
toFill = static_cast<uint8_t*>(buffer->initializeToInlineData(nbytes));
if constexpr (FillType == FillContents::Zero) {
memset(toFill, 0, nbytes);
}
}
return {buffer, toFill};
}
/* static */ ArrayBufferObject* ArrayBufferObject::copy(
JSContext* cx, JS::Handle<ArrayBufferObject*> unwrappedArrayBuffer) {
if (unwrappedArrayBuffer->isDetached()) {
JS_ReportErrorNumberASCII(cx, GetErrorMessage, nullptr,
JSMSG_TYPED_ARRAY_DETACHED);
return nullptr;
}
size_t nbytes = unwrappedArrayBuffer->byteLength();
AutoSetNewObjectMetadata metadata(cx);
auto [buffer, toFill] = createBufferAndData<FillContents::Uninitialized>(
cx, nbytes, metadata, nullptr);
if (!buffer) {
return nullptr;
}
std::uninitialized_copy_n(unwrappedArrayBuffer->dataPointer(), nbytes,
toFill);
return buffer;
}
ArrayBufferObject* ArrayBufferObject::createZeroed(
JSContext* cx, size_t nbytes, HandleObject proto /* = nullptr */) {
// 24.1.1.1, step 3 (Inlined 6.2.6.1 CreateByteDataBlock, step 2).
if (!CheckArrayBufferTooLarge(cx, nbytes)) {
return nullptr;
}
AutoSetNewObjectMetadata metadata(cx);
auto [buffer, toFill] =
createBufferAndData<FillContents::Zero>(cx, nbytes, metadata, proto);
(void)toFill;
return buffer;
}
ArrayBufferObject* ArrayBufferObject::createEmpty(JSContext* cx) {
AutoSetNewObjectMetadata metadata(cx);
ArrayBufferObject* obj = NewArrayBufferObject(cx);
if (!obj) {
return nullptr;
}
obj->initialize(0, BufferContents::createNoData());
return obj;
}
ArrayBufferObject* ArrayBufferObject::createFromNewRawBuffer(
JSContext* cx, WasmArrayRawBuffer* rawBuffer, size_t initialSize) {
AutoSetNewObjectMetadata metadata(cx);
ArrayBufferObject* buffer = NewArrayBufferObject(cx);
if (!buffer) {
WasmArrayRawBuffer::Release(rawBuffer->dataPointer());
return nullptr;
}
MOZ_ASSERT(initialSize == rawBuffer->byteLength());
buffer->setByteLength(initialSize);
buffer->setFlags(0);
buffer->setFirstView(nullptr);
auto contents = BufferContents::createWasm(rawBuffer->dataPointer());
buffer->setDataPointer(contents);
AddCellMemory(buffer, initialSize, MemoryUse::ArrayBufferContents);
return buffer;
}
/* static */ uint8_t* ArrayBufferObject::stealMallocedContents(
JSContext* cx, Handle<ArrayBufferObject*> buffer) {
CheckStealPreconditions(buffer, cx);
switch (buffer->bufferKind()) {
case MALLOCED: {
uint8_t* stolenData = buffer->dataPointer();
MOZ_ASSERT(stolenData);
RemoveCellMemory(buffer, buffer->byteLength(),
MemoryUse::ArrayBufferContents);
// Overwrite the old data pointer *without* releasing the contents
// being stolen.
buffer->setDataPointer(BufferContents::createNoData());
// Detach |buffer| now that doing so won't free |stolenData|.
ArrayBufferObject::detach(cx, buffer);
return stolenData;
}
case INLINE_DATA:
case NO_DATA:
case USER_OWNED:
case MAPPED:
case EXTERNAL: {
// We can't use these data types directly. Make a copy to return.
ArrayBufferContents copiedData = NewCopiedBufferContents(cx, buffer);
if (!copiedData) {
return nullptr;
}
// Detach |buffer|. This immediately releases the currently owned
// contents, freeing or unmapping data in the MAPPED and EXTERNAL cases.
ArrayBufferObject::detach(cx, buffer);
return copiedData.release();
}
case WASM:
MOZ_ASSERT_UNREACHABLE(
"wasm buffers aren't stealable except by a "
"memory.grow operation that shouldn't call this "
"function");
return nullptr;
case BAD1:
MOZ_ASSERT_UNREACHABLE("bad kind when stealing malloc'd data");
return nullptr;
}
MOZ_ASSERT_UNREACHABLE("garbage kind computed");
return nullptr;
}
/* static */ ArrayBufferObject::BufferContents
ArrayBufferObject::extractStructuredCloneContents(
JSContext* cx, Handle<ArrayBufferObject*> buffer) {
CheckStealPreconditions(buffer, cx);
BufferContents contents = buffer->contents();
switch (contents.kind()) {
case INLINE_DATA:
case NO_DATA:
case USER_OWNED: {
ArrayBufferContents copiedData = NewCopiedBufferContents(cx, buffer);
if (!copiedData) {
return BufferContents::createFailed();
}
ArrayBufferObject::detach(cx, buffer);
return BufferContents::createMalloced(copiedData.release());
}
case MALLOCED:
case MAPPED: {
MOZ_ASSERT(contents);
RemoveCellMemory(buffer, buffer->associatedBytes(),
MemoryUse::ArrayBufferContents);
// Overwrite the old data pointer *without* releasing old data.
buffer->setDataPointer(BufferContents::createNoData());
// Detach |buffer| now that doing so won't release |oldContents|.
ArrayBufferObject::detach(cx, buffer);
return contents;
}
case WASM:
JS_ReportErrorNumberASCII(cx, GetErrorMessage, nullptr,
JSMSG_WASM_NO_TRANSFER);
return BufferContents::createFailed();
case EXTERNAL:
MOZ_ASSERT_UNREACHABLE(
"external ArrayBuffer shouldn't have passed the "
"structured-clone preflighting");
break;
case BAD1:
MOZ_ASSERT_UNREACHABLE("bad kind when stealing malloc'd data");
break;
}
MOZ_ASSERT_UNREACHABLE("garbage kind computed");
return BufferContents::createFailed();
}
/* static */
void ArrayBufferObject::addSizeOfExcludingThis(
JSObject* obj, mozilla::MallocSizeOf mallocSizeOf, JS::ClassInfo* info,
JS::RuntimeSizes* runtimeSizes) {
auto& buffer = obj->as<ArrayBufferObject>();
switch (buffer.bufferKind()) {
case INLINE_DATA:
// Inline data's size should be reported by this object's size-class
// reporting.
break;
case MALLOCED:
if (buffer.isPreparedForAsmJS()) {
info->objectsMallocHeapElementsAsmJS +=
mallocSizeOf(buffer.dataPointer());
} else {
info->objectsMallocHeapElementsNormal +=
mallocSizeOf(buffer.dataPointer());
}
break;
case NO_DATA:
// No data is no memory.
MOZ_ASSERT(buffer.dataPointer() == nullptr);
break;
case USER_OWNED:
// User-owned data should be accounted for by the user.
break;
case EXTERNAL:
// External data will be accounted for by the owner of the buffer,
// not this view.
break;
case MAPPED:
info->objectsNonHeapElementsNormal += buffer.byteLength();
break;
case WASM:
if (!buffer.isDetached()) {
info->objectsNonHeapElementsWasm += buffer.byteLength();
if (runtimeSizes) {
MOZ_ASSERT(buffer.wasmMappedSize() >= buffer.byteLength());
runtimeSizes->wasmGuardPages +=
buffer.wasmMappedSize() - buffer.byteLength();
}
}
break;
case BAD1:
MOZ_CRASH("bad bufferKind()");
}
}
/* static */
void ArrayBufferObject::finalize(JS::GCContext* gcx, JSObject* obj) {
obj->as<ArrayBufferObject>().releaseData(gcx);
}
/* static */
void ArrayBufferObject::copyData(Handle<ArrayBufferObject*> toBuffer,
size_t toIndex,
Handle<ArrayBufferObject*> fromBuffer,
size_t fromIndex, size_t count) {
MOZ_ASSERT(toBuffer->byteLength() >= count);
MOZ_ASSERT(toBuffer->byteLength() >= toIndex + count);
MOZ_ASSERT(fromBuffer->byteLength() >= fromIndex);
MOZ_ASSERT(fromBuffer->byteLength() >= fromIndex + count);
memcpy(toBuffer->dataPointer() + toIndex,
fromBuffer->dataPointer() + fromIndex, count);
}
/* static */
size_t ArrayBufferObject::objectMoved(JSObject* obj, JSObject* old) {
ArrayBufferObject& dst = obj->as<ArrayBufferObject>();
const ArrayBufferObject& src = old->as<ArrayBufferObject>();
// Fix up possible inline data pointer.
if (src.hasInlineData()) {
dst.setFixedSlot(DATA_SLOT, PrivateValue(dst.inlineDataPointer()));
}
return 0;
}
JSObject* ArrayBufferObject::firstView() {
return getFixedSlot(FIRST_VIEW_SLOT).isObject()
? &getFixedSlot(FIRST_VIEW_SLOT).toObject()
: nullptr;
}
void ArrayBufferObject::setFirstView(ArrayBufferViewObject* view) {
setFixedSlot(FIRST_VIEW_SLOT, ObjectOrNullValue(view));
}
bool ArrayBufferObject::addView(JSContext* cx, ArrayBufferViewObject* view) {
if (!firstView()) {
setFirstView(view);
return true;
}
return ObjectRealm::get(this).innerViews.get().addView(cx, this, view);
}
/*
* InnerViewTable
*/
constexpr size_t VIEW_LIST_MAX_LENGTH = 500;
bool InnerViewTable::addView(JSContext* cx, ArrayBufferObject* buffer,
JSObject* view) {
// ArrayBufferObject entries are only added when there are multiple views.
MOZ_ASSERT(buffer->firstView());
Map::AddPtr p = map.lookupForAdd(buffer);
MOZ_ASSERT(!gc::IsInsideNursery(buffer));
bool addToNursery = nurseryKeysValid && gc::IsInsideNursery(view);
if (p) {
ViewVector& views = p->value();
MOZ_ASSERT(!views.empty());
if (addToNursery) {
// Only add the entry to |nurseryKeys| if it isn't already there.
if (views.length() >= VIEW_LIST_MAX_LENGTH) {
// To avoid quadratic blowup, skip the loop below if we end up
// adding enormous numbers of views for the same object.
nurseryKeysValid = false;
} else {
for (size_t i = 0; i < views.length(); i++) {
if (gc::IsInsideNursery(views[i])) {
addToNursery = false;
break;
}
}
}
}
if (!views.append(view)) {
ReportOutOfMemory(cx);
return false;
}
} else {
if (!map.add(p, buffer, ViewVector(cx->zone()))) {
ReportOutOfMemory(cx);
return false;
}
// ViewVector has one inline element, so the first insertion is
// guaranteed to succeed.
MOZ_ALWAYS_TRUE(p->value().append(view));
}
if (addToNursery && !nurseryKeys.append(buffer)) {
nurseryKeysValid = false;
}
return true;
}
InnerViewTable::ViewVector* InnerViewTable::maybeViewsUnbarriered(
ArrayBufferObject* buffer) {
Map::Ptr p = map.lookup(buffer);
if (p) {
return &p->value();
}
return nullptr;
}
void InnerViewTable::removeViews(ArrayBufferObject* buffer) {
Map::Ptr p = map.lookup(buffer);
MOZ_ASSERT(p);
map.remove(p);
}
bool InnerViewTable::traceWeak(JSTracer* trc) { return map.traceWeak(trc); }
void InnerViewTable::sweepAfterMinorGC(JSTracer* trc) {
MOZ_ASSERT(needsSweepAfterMinorGC());
if (nurseryKeysValid) {
for (size_t i = 0; i < nurseryKeys.length(); i++) {
JSObject* buffer = MaybeForwarded(nurseryKeys[i]);
Map::Ptr p = map.lookup(buffer);
if (p &&
!Map::EntryGCPolicy::traceWeak(trc, &p->mutableKey(), &p->value())) {
map.remove(p);
}
}
} else {
// Do the required sweeping by looking at every map entry.
map.traceWeak(trc);
}
nurseryKeys.clear();
nurseryKeysValid = true;
}
size_t InnerViewTable::sizeOfExcludingThis(mozilla::MallocSizeOf mallocSizeOf) {
size_t vectorSize = 0;
for (Map::Enum e(map); !e.empty(); e.popFront()) {
vectorSize += e.front().value().sizeOfExcludingThis(mallocSizeOf);
}
return vectorSize + map.shallowSizeOfExcludingThis(mallocSizeOf) +
nurseryKeys.sizeOfExcludingThis(mallocSizeOf);
}
template <>
bool JSObject::is<js::ArrayBufferObjectMaybeShared>() const {
return is<ArrayBufferObject>() || is<SharedArrayBufferObject>();
}
JS_PUBLIC_API size_t JS::GetArrayBufferByteLength(JSObject* obj) {
ArrayBufferObject* aobj = obj->maybeUnwrapAs<ArrayBufferObject>();
return aobj ? aobj->byteLength() : 0;
}
JS_PUBLIC_API uint8_t* JS::GetArrayBufferData(JSObject* obj,
bool* isSharedMemory,
const JS::AutoRequireNoGC&) {
ArrayBufferObject* aobj = obj->maybeUnwrapIf<ArrayBufferObject>();
if (!aobj) {
return nullptr;
}
*isSharedMemory = false;
return aobj->dataPointer();
}
static ArrayBufferObject* UnwrapOrReportArrayBuffer(
JSContext* cx, JS::Handle<JSObject*> maybeArrayBuffer) {
JSObject* obj = CheckedUnwrapStatic(maybeArrayBuffer);
if (!obj) {
ReportAccessDenied(cx);
return nullptr;
}
if (!obj->is<ArrayBufferObject>()) {
JS_ReportErrorNumberASCII(cx, GetErrorMessage, nullptr,
JSMSG_ARRAYBUFFER_REQUIRED);
return nullptr;
}
return &obj->as<ArrayBufferObject>();
}
JS_PUBLIC_API bool JS::DetachArrayBuffer(JSContext* cx, HandleObject obj) {
AssertHeapIsIdle();
CHECK_THREAD(cx);
cx->check(obj);
Rooted<ArrayBufferObject*> unwrappedBuffer(
cx, UnwrapOrReportArrayBuffer(cx, obj));
if (!unwrappedBuffer) {
return false;
}
if (unwrappedBuffer->isWasm() || unwrappedBuffer->isPreparedForAsmJS()) {
JS_ReportErrorNumberASCII(cx, GetErrorMessage, nullptr,
JSMSG_WASM_NO_TRANSFER);
return false;
}
AutoRealm ar(cx, unwrappedBuffer);
ArrayBufferObject::detach(cx, unwrappedBuffer);
return true;
}
JS_PUBLIC_API bool JS::HasDefinedArrayBufferDetachKey(JSContext* cx,
HandleObject obj,
bool* isDefined) {
Rooted<ArrayBufferObject*> unwrappedBuffer(
cx, UnwrapOrReportArrayBuffer(cx, obj));
if (!unwrappedBuffer) {
return false;
}
if (unwrappedBuffer->isWasm() || unwrappedBuffer->isPreparedForAsmJS()) {
*isDefined = true;
}
return true;
}
JS_PUBLIC_API bool JS::IsDetachedArrayBufferObject(JSObject* obj) {
ArrayBufferObject* aobj = obj->maybeUnwrapIf<ArrayBufferObject>();
if (!aobj) {
return false;
}
return aobj->isDetached();
}
JS_PUBLIC_API JSObject* JS::NewArrayBuffer(JSContext* cx, size_t nbytes) {
AssertHeapIsIdle();
CHECK_THREAD(cx);
return ArrayBufferObject::createZeroed(cx, nbytes);
}
JS_PUBLIC_API JSObject* JS::NewArrayBufferWithContents(JSContext* cx,
size_t nbytes,
void* data) {
AssertHeapIsIdle();
CHECK_THREAD(cx);
MOZ_ASSERT_IF(!data, nbytes == 0);
if (!data) {
// Don't pass nulled contents to |createForContents|.
return ArrayBufferObject::createZeroed(cx, 0);
}
using BufferContents = ArrayBufferObject::BufferContents;
BufferContents contents = BufferContents::createMalloced(data);
return ArrayBufferObject::createForContents(cx, nbytes, contents);
}
JS_PUBLIC_API JSObject* JS::CopyArrayBuffer(JSContext* cx,
Handle<JSObject*> arrayBuffer) {
AssertHeapIsIdle();
CHECK_THREAD(cx);
MOZ_ASSERT(arrayBuffer != nullptr);
Rooted<ArrayBufferObject*> unwrappedSource(
cx, UnwrapOrReportArrayBuffer(cx, arrayBuffer));
if (!unwrappedSource) {
return nullptr;
}
return ArrayBufferObject::copy(cx, unwrappedSource);
}
JS_PUBLIC_API JSObject* JS::NewExternalArrayBuffer(
JSContext* cx, size_t nbytes, void* data,
JS::BufferContentsFreeFunc freeFunc, void* freeUserData) {
AssertHeapIsIdle();
CHECK_THREAD(cx);
MOZ_ASSERT(data);
using BufferContents = ArrayBufferObject::BufferContents;
BufferContents contents =
BufferContents::createExternal(data, freeFunc, freeUserData);
return ArrayBufferObject::createForContents(cx, nbytes, contents);
}
JS_PUBLIC_API JSObject* JS::NewArrayBufferWithUserOwnedContents(JSContext* cx,
size_t nbytes,
void* data) {
AssertHeapIsIdle();
CHECK_THREAD(cx);
MOZ_ASSERT(data);
using BufferContents = ArrayBufferObject::BufferContents;
BufferContents contents = BufferContents::createUserOwned(data);
return ArrayBufferObject::createForContents(cx, nbytes, contents);
}
JS_PUBLIC_API bool JS::IsArrayBufferObject(JSObject* obj) {
return obj->canUnwrapAs<ArrayBufferObject>();
}
JS_PUBLIC_API bool JS::ArrayBufferHasData(JSObject* obj) {
return !obj->unwrapAs<ArrayBufferObject>().isDetached();
}
JS_PUBLIC_API JSObject* JS::UnwrapArrayBuffer(JSObject* obj) {
return obj->maybeUnwrapIf<ArrayBufferObject>();
}
JS_PUBLIC_API JSObject* JS::UnwrapSharedArrayBuffer(JSObject* obj) {
return obj->maybeUnwrapIf<SharedArrayBufferObject>();
}
JS_PUBLIC_API void* JS::StealArrayBufferContents(JSContext* cx,
HandleObject obj) {
AssertHeapIsIdle();
CHECK_THREAD(cx);
cx->check(obj);
Rooted<ArrayBufferObject*> unwrappedBuffer(
cx, UnwrapOrReportArrayBuffer(cx, obj));
if (!unwrappedBuffer) {
return nullptr;
}
if (unwrappedBuffer->isDetached()) {
JS_ReportErrorNumberASCII(cx, GetErrorMessage, nullptr,
JSMSG_TYPED_ARRAY_DETACHED);
return nullptr;
}
if (unwrappedBuffer->isWasm() || unwrappedBuffer->isPreparedForAsmJS()) {
JS_ReportErrorNumberASCII(cx, GetErrorMessage, nullptr,
JSMSG_WASM_NO_TRANSFER);
return nullptr;
}
AutoRealm ar(cx, unwrappedBuffer);
return ArrayBufferObject::stealMallocedContents(cx, unwrappedBuffer);
}
JS_PUBLIC_API JSObject* JS::NewMappedArrayBufferWithContents(JSContext* cx,
size_t nbytes,
void* data) {
AssertHeapIsIdle();
CHECK_THREAD(cx);
MOZ_ASSERT(data);
using BufferContents = ArrayBufferObject::BufferContents;
BufferContents contents = BufferContents::createMapped(data);
return ArrayBufferObject::createForContents(cx, nbytes, contents);
}
JS_PUBLIC_API void* JS::CreateMappedArrayBufferContents(int fd, size_t offset,
size_t length) {
return ArrayBufferObject::createMappedContents(fd, offset, length).data();
}
JS_PUBLIC_API void JS::ReleaseMappedArrayBufferContents(void* contents,
size_t length) {
gc::DeallocateMappedContent(contents, length);
}
JS_PUBLIC_API bool JS::IsMappedArrayBufferObject(JSObject* obj) {
ArrayBufferObject* aobj = obj->maybeUnwrapIf<ArrayBufferObject>();
if (!aobj) {
return false;
}
return aobj->isMapped();
}
JS_PUBLIC_API JSObject* JS::GetObjectAsArrayBuffer(JSObject* obj,
size_t* length,
uint8_t** data) {
ArrayBufferObject* aobj = obj->maybeUnwrapIf<ArrayBufferObject>();
if (!aobj) {
return nullptr;
}
*length = aobj->byteLength();
*data = aobj->dataPointer();
return aobj;
}
JS_PUBLIC_API void JS::GetArrayBufferLengthAndData(JSObject* obj,
size_t* length,
bool* isSharedMemory,
uint8_t** data) {
auto& aobj = obj->as<ArrayBufferObject>();
*length = aobj.byteLength();
*data = aobj.dataPointer();
*isSharedMemory = false;
}
const JSClass* const JS::ArrayBuffer::UnsharedClass =
&ArrayBufferObject::class_;
const JSClass* const JS::ArrayBuffer::SharedClass =
&SharedArrayBufferObject::class_;
/* static */ JS::ArrayBuffer JS::ArrayBuffer::create(JSContext* cx,
size_t nbytes) {
AssertHeapIsIdle();
CHECK_THREAD(cx);
return JS::ArrayBuffer(ArrayBufferObject::createZeroed(cx, nbytes));
}
uint8_t* JS::ArrayBuffer::getLengthAndData(size_t* length, bool* isSharedMemory,
const JS::AutoRequireNoGC& nogc) {
auto* buffer = obj->maybeUnwrapAs<ArrayBufferObjectMaybeShared>();
if (!buffer) {
return nullptr;
}
*length = buffer->byteLength();
if (buffer->is<SharedArrayBufferObject>()) {
*isSharedMemory = true;
return buffer->dataPointerEither().unwrap();
}
*isSharedMemory = false;
return buffer->as<ArrayBufferObject>().dataPointer();
};
JS::ArrayBuffer JS::ArrayBuffer::unwrap(JSObject* maybeWrapped) {
if (!maybeWrapped) {
return JS::ArrayBuffer(nullptr);
}
auto* ab = maybeWrapped->maybeUnwrapIf<ArrayBufferObjectMaybeShared>();
return fromObject(ab);
}
bool JS::ArrayBufferCopyData(JSContext* cx, Handle<JSObject*> toBlock,
size_t toIndex, Handle<JSObject*> fromBlock,
size_t fromIndex, size_t count) {
Rooted<ArrayBufferObjectMaybeShared*> unwrappedToBlock(
cx, toBlock->maybeUnwrapIf<ArrayBufferObjectMaybeShared>());
if (!unwrappedToBlock) {
ReportAccessDenied(cx);
return false;
}
Rooted<ArrayBufferObjectMaybeShared*> unwrappedFromBlock(
cx, fromBlock->maybeUnwrapIf<ArrayBufferObjectMaybeShared>());
if (!unwrappedFromBlock) {
ReportAccessDenied(cx);
return false;
}
// Verify that lengths still make sense and throw otherwise.
if (toIndex + count < toIndex || // size_t overflow
fromIndex + count < fromIndex || // size_t overflow
toIndex + count > unwrappedToBlock->byteLength() ||
fromIndex + count > unwrappedFromBlock->byteLength()) {
JS_ReportErrorNumberASCII(cx, GetErrorMessage, nullptr,
JSMSG_ARRAYBUFFER_COPY_RANGE);
return false;
}
// If both are array buffers, can use ArrayBufferCopyData
if (unwrappedToBlock->is<ArrayBufferObject>() &&
unwrappedFromBlock->is<ArrayBufferObject>()) {
Rooted<ArrayBufferObject*> toArray(
cx, &unwrappedToBlock->as<ArrayBufferObject>());
Rooted<ArrayBufferObject*> fromArray(
cx, &unwrappedFromBlock->as<ArrayBufferObject>());
ArrayBufferObject::copyData(toArray, toIndex, fromArray, fromIndex, count);
return true;
}
Rooted<ArrayBufferObjectMaybeShared*> toArray(
cx, &unwrappedToBlock->as<ArrayBufferObjectMaybeShared>());
Rooted<ArrayBufferObjectMaybeShared*> fromArray(
cx, &unwrappedFromBlock->as<ArrayBufferObjectMaybeShared>());
SharedArrayBufferObject::copyData(toArray, toIndex, fromArray, fromIndex,
count);
return true;
}
// https://tc39.es/ecma262/#sec-clonearraybuffer
// We only support the case where cloneConstructor is %ArrayBuffer%. Note,
// this means that cloning a SharedArrayBuffer will produce an ArrayBuffer
JSObject* JS::ArrayBufferClone(JSContext* cx, Handle<JSObject*> srcBuffer,
size_t srcByteOffset, size_t srcLength) {
MOZ_ASSERT(srcBuffer->is<ArrayBufferObjectMaybeShared>());
// 2. (reordered) If IsDetachedBuffer(srcBuffer) is true, throw a TypeError
// exception.
if (IsDetachedArrayBufferObject(srcBuffer)) {
JS_ReportErrorNumberASCII(cx, GetErrorMessage, nullptr,
JSMSG_TYPED_ARRAY_DETACHED);
return nullptr;
}
// 1. Let targetBuffer be ? AllocateArrayBuffer(cloneConstructor, srcLength).
JS::RootedObject targetBuffer(cx, JS::NewArrayBuffer(cx, srcLength));
if (!targetBuffer) {
return nullptr;
}
// 3. Let srcBlock be srcBuffer.[[ArrayBufferData]].
// 4. Let targetBlock be targetBuffer.[[ArrayBufferData]].
// 5. Perform CopyDataBlockBytes(targetBlock, 0, srcBlock, srcByteOffset,
// srcLength).
if (!ArrayBufferCopyData(cx, targetBuffer, 0, srcBuffer, srcByteOffset,
srcLength)) {
return nullptr;
}
// 6. Return targetBuffer.
return targetBuffer;
}
|