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
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
use crate::{
backend::BackendStorage, CpuStorage, DType, Device, Result, Shape, Storage, Tensor, D,
};
use iq_quants::*;
use k_quants::*;
use std::borrow::Cow;
#[cfg(target_feature = "avx2")]
pub mod avx;
mod dummy_cuda;
mod dummy_metal;
pub mod ggml_file;
pub mod gguf_file;
mod iq_grids;
pub mod iq_quants;
pub mod imatrix_file;
pub mod k_quants;
#[cfg(feature = "metal")]
pub mod metal;
#[cfg(not(target_arch = "wasm32"))]
pub mod tokenizer;
#[cfg(not(feature = "metal"))]
mod metal {
pub use super::dummy_metal::*;
}
#[cfg(feature = "cuda")]
pub mod cuda;
#[cfg(feature = "cuda")]
pub mod fast_mmq;
#[cfg(feature = "cuda")]
pub mod fast_mmvq;
#[cfg(not(feature = "cuda"))]
mod cuda {
pub use super::dummy_cuda::*;
}
#[cfg(target_feature = "neon")]
pub mod neon;
#[cfg(target_feature = "simd128")]
pub mod simd128;
pub mod utils;
// Declarative GGUF quant-type formatter (Cut 2). Additive: defines `quant_format!` and a
// `#[cfg(test)]` equivalence proof; does not alter any existing type or wiring.
pub mod quant_format;
use half::{bf16, f16};
pub use k_quants::GgmlType;
// Borrows `data` (does not consume it) so the returned slice stays valid for the caller's lifetime.
// Taking `Cow` by value here was a use-after-free: the Cow dropped at return, dangling the slice for
// Cow::Owned inputs (segfault on large quantized tensors; mmap'd Cow::Borrowed happened to survive).
fn as_t_slice<T>(data: &[u8]) -> &[T] {
let size = std::mem::size_of::<T>();
assert_eq!(
data.len() % size,
0,
"Data length must be a multiple of T's size"
);
let ptr = data.as_ptr();
assert_eq!(
(ptr as usize) % std::mem::align_of::<T>(),
0,
"Data pointer must be aligned to T's alignment"
);
unsafe { std::slice::from_raw_parts(ptr as *const T, data.len() / size) }
}
pub struct QTensor {
storage: QStorage,
shape: Shape,
}
impl Device {
fn qzeros(&self, elem_count: usize, dtype: GgmlDType) -> Result<QStorage> {
match self {
Device::Cpu => {
let storage = dtype.cpu_zeros(elem_count);
Ok(QStorage::Cpu(storage))
}
Device::Metal(metal) => {
let storage = metal::QMetalStorage::zeros(metal, elem_count, dtype)?;
Ok(QStorage::Metal(storage))
}
Device::Cuda(cuda) => {
let storage = cuda::QCudaStorage::zeros(cuda, elem_count, dtype)?;
Ok(QStorage::Cuda(storage))
}
#[cfg(feature = "rocm")]
Device::Rocm(d) => {
// Mirror Vulkan: keep quantized blocks in a CPU box + the device; QMatMul
// dequantizes them to a dense ROCm tensor on use.
let storage = dtype.cpu_zeros(elem_count);
Ok(QStorage::Rocm(storage, d.clone()))
}
#[cfg(feature = "vulkan")]
Device::Vulkan(d) => {
// Keep quantized blocks in a CPU box + the device (same as from_data); QMatMul's
// VulkanQuant path uploads/dequantizes them to the GPU on use.
let storage = dtype.cpu_zeros(elem_count);
Ok(QStorage::Vulkan(storage, d.clone()))
}
#[cfg(feature = "wgpu")]
Device::Wgpu(d) => {
// Same as Vulkan: keep the quantized blocks in a CPU box + the device; QMatMul's
// WgpuQuant path uploads them to the GPU on use.
let storage = dtype.cpu_zeros(elem_count);
Ok(QStorage::Wgpu(storage, d.clone()))
}
}
}
}
pub enum QStorage {
Cpu(Box<dyn QuantizedType>),
Metal(metal::QMetalStorage),
Cuda(cuda::QCudaStorage),
// ROCm mirrors the Vulkan path: quantized blocks held in a CPU box + the device; QMatMul
// dequantizes them to a dense f32 ROCm tensor on demand (rocBLAS matmul). A native HIP quant
// matmul is the bandwidth-win follow-up.
#[cfg(feature = "rocm")]
Rocm(Box<dyn QuantizedType>, crate::RocmDevice),
// Vulkan keeps the quantized blocks in a CPU box and dequantizes to an f32 Vulkan tensor on
// demand (QMatMul forces dequantize for Vulkan). Lets GGUF-quantized models run on the GPU;
// a direct quantized matmul (the Q8 kernel) is the bandwidth-win follow-up.
#[cfg(feature = "vulkan")]
Vulkan(Box<dyn QuantizedType>, crate::VulkanDevice),
// wgpu mirror of the Vulkan path: quantized blocks held in a CPU box + the device. QMatMul's
// WgpuQuant path reads the GGML bytes straight in the native quant matvec kernel (decode), or
// dequantizes to an f32 wgpu tensor on demand.
#[cfg(feature = "wgpu")]
Wgpu(Box<dyn QuantizedType>, crate::WgpuDevice),
}
impl QStorage {
pub fn from_data(data: Cow<'_, [u8]>, device: &Device, dtype: GgmlDType) -> Result<Self> {
match device {
Device::Cpu => Ok(Self::Cpu(dtype.from_data(data))),
Device::Metal(d) => match dtype {
GgmlDType::F32 => metal::load_quantized(d, as_t_slice::<f32>(&data)),
GgmlDType::F16 => metal::load_quantized(d, as_t_slice::<f16>(&data)),
GgmlDType::Q4_0 => metal::load_quantized(d, as_t_slice::<BlockQ4_0>(&data)),
GgmlDType::Q4_1 => metal::load_quantized(d, as_t_slice::<BlockQ4_1>(&data)),
GgmlDType::Q5_0 => metal::load_quantized(d, as_t_slice::<BlockQ5_0>(&data)),
GgmlDType::Q5_1 => metal::load_quantized(d, as_t_slice::<BlockQ5_1>(&data)),
GgmlDType::Q8_0 => metal::load_quantized(d, as_t_slice::<BlockQ8_0>(&data)),
GgmlDType::Q8_1 => metal::load_quantized(d, as_t_slice::<BlockQ8_1>(&data)),
GgmlDType::Q2K => metal::load_quantized(d, as_t_slice::<BlockQ2K>(&data)),
GgmlDType::Q3K => metal::load_quantized(d, as_t_slice::<BlockQ3K>(&data)),
GgmlDType::Q4K => metal::load_quantized(d, as_t_slice::<BlockQ4K>(&data)),
GgmlDType::Q5K => metal::load_quantized(d, as_t_slice::<BlockQ5K>(&data)),
GgmlDType::Q6K => metal::load_quantized(d, as_t_slice::<BlockQ6K>(&data)),
GgmlDType::Q8K => metal::load_quantized(d, as_t_slice::<BlockQ8K>(&data)),
GgmlDType::IQ4_NL => metal::load_quantized(d, as_t_slice::<BlockIQ4nl>(&data)),
GgmlDType::IQ4_XS => metal::load_quantized(d, as_t_slice::<BlockIQ4xs>(&data)),
GgmlDType::MXFP4 => metal::load_quantized(d, as_t_slice::<BlockMXFP4>(&data)),
GgmlDType::BF16 => metal::load_quantized(d, as_t_slice::<bf16>(&data)),
// IQ / ternary / 1-bit / NVFP4 codec types have no native Metal loader (CPU-decode only).
other => crate::bail!("{other:?} is not supported on the Metal backend"),
},
Device::Cuda(d) => match dtype {
GgmlDType::F32 => cuda::load_quantized(d, as_t_slice::<f32>(&data)),
GgmlDType::F16 => cuda::load_quantized(d, as_t_slice::<f16>(&data)),
GgmlDType::Q4_0 => cuda::load_quantized(d, as_t_slice::<BlockQ4_0>(&data)),
GgmlDType::Q4_1 => cuda::load_quantized(d, as_t_slice::<BlockQ4_1>(&data)),
GgmlDType::Q5_0 => cuda::load_quantized(d, as_t_slice::<BlockQ5_0>(&data)),
GgmlDType::Q5_1 => cuda::load_quantized(d, as_t_slice::<BlockQ5_1>(&data)),
GgmlDType::Q8_0 => cuda::load_quantized(d, as_t_slice::<BlockQ8_0>(&data)),
GgmlDType::Q8_1 => cuda::load_quantized(d, as_t_slice::<BlockQ8_1>(&data)),
GgmlDType::Q2K => cuda::load_quantized(d, as_t_slice::<BlockQ2K>(&data)),
GgmlDType::Q3K => cuda::load_quantized(d, as_t_slice::<BlockQ3K>(&data)),
GgmlDType::Q4K => cuda::load_quantized(d, as_t_slice::<BlockQ4K>(&data)),
GgmlDType::Q5K => cuda::load_quantized(d, as_t_slice::<BlockQ5K>(&data)),
GgmlDType::Q6K => cuda::load_quantized(d, as_t_slice::<BlockQ6K>(&data)),
GgmlDType::Q8K => cuda::load_quantized(d, as_t_slice::<BlockQ8K>(&data)),
GgmlDType::IQ4_NL => cuda::load_quantized(d, as_t_slice::<BlockIQ4nl>(&data)),
GgmlDType::IQ4_XS => cuda::load_quantized(d, as_t_slice::<BlockIQ4xs>(&data)),
GgmlDType::MXFP4 => cuda::load_quantized(d, as_t_slice::<BlockMXFP4>(&data)),
GgmlDType::BF16 => cuda::load_quantized(d, as_t_slice::<bf16>(&data)),
// IQ / ternary / 1-bit / NVFP4 codec types: no native on-GPU quant-matmul kernel, but the
// GGML blocks upload to VRAM byte-for-byte like any other quant. QCudaStorage::fwd then
// dequantizes them to f32 (CPU codebook decode + upload) for a dense matmul -- see
// `has_native_q8_1_matmul`. So an i-quant GGUF that used to bail here now LOADS and DECODES
// on CUDA, exact w.r.t. the CPU reference; a native mmvq kernel is the bandwidth follow-up.
// Exhaustive on purpose: a future GgmlDType must be wired here (fail-closed at compile) rather
// than silently bailing at load.
GgmlDType::IQ2_XXS => cuda::load_quantized(d, as_t_slice::<BlockIQ2xxs>(&data)),
GgmlDType::IQ2_XS => cuda::load_quantized(d, as_t_slice::<BlockIQ2xs>(&data)),
GgmlDType::IQ2_S => cuda::load_quantized(d, as_t_slice::<BlockIQ2s>(&data)),
GgmlDType::IQ3_XXS => cuda::load_quantized(d, as_t_slice::<BlockIQ3xxs>(&data)),
GgmlDType::IQ3_S => cuda::load_quantized(d, as_t_slice::<BlockIQ3s>(&data)),
GgmlDType::IQ1_S => cuda::load_quantized(d, as_t_slice::<BlockIQ1s>(&data)),
GgmlDType::IQ1_M => cuda::load_quantized(d, as_t_slice::<BlockIQ1m>(&data)),
GgmlDType::TQ1_0 => cuda::load_quantized(d, as_t_slice::<BlockTQ1_0>(&data)),
GgmlDType::TQ2_0 => cuda::load_quantized(d, as_t_slice::<BlockTQ2_0>(&data)),
GgmlDType::NVFP4 => cuda::load_quantized(d, as_t_slice::<BlockNVFP4>(&data)),
GgmlDType::Q1_0 => cuda::load_quantized(d, as_t_slice::<BlockQ1_0>(&data)),
},
#[cfg(feature = "rocm")]
Device::Rocm(d) => Ok(Self::Rocm(dtype.from_data(data), d.clone())),
#[cfg(feature = "vulkan")]
Device::Vulkan(d) => Ok(Self::Vulkan(dtype.from_data(data), d.clone())),
#[cfg(feature = "wgpu")]
Device::Wgpu(d) => Ok(Self::Wgpu(dtype.from_data(data), d.clone())),
}
}
fn block_size(&self) -> usize {
match self {
QStorage::Cpu(storage) => storage.block_size(),
QStorage::Metal(storage) => storage.dtype().block_size(),
QStorage::Cuda(storage) => storage.dtype().block_size(),
#[cfg(feature = "rocm")]
QStorage::Rocm(storage, _) => storage.block_size(),
#[cfg(feature = "vulkan")]
QStorage::Vulkan(storage, _) => storage.block_size(),
#[cfg(feature = "wgpu")]
QStorage::Wgpu(storage, _) => storage.block_size(),
}
}
fn dtype(&self) -> GgmlDType {
match self {
QStorage::Cpu(storage) => storage.dtype(),
QStorage::Metal(storage) => storage.dtype(),
QStorage::Cuda(storage) => storage.dtype(),
#[cfg(feature = "rocm")]
QStorage::Rocm(storage, _) => storage.dtype(),
#[cfg(feature = "vulkan")]
QStorage::Vulkan(storage, _) => storage.dtype(),
#[cfg(feature = "wgpu")]
QStorage::Wgpu(storage, _) => storage.dtype(),
}
}
fn device(&self) -> Device {
match self {
QStorage::Cpu(_storage) => Device::Cpu,
QStorage::Metal(storage) => Device::Metal(storage.device().clone()),
QStorage::Cuda(storage) => Device::Cuda(storage.device().clone()),
#[cfg(feature = "rocm")]
QStorage::Rocm(_storage, device) => Device::Rocm(device.clone()),
#[cfg(feature = "vulkan")]
QStorage::Vulkan(_storage, device) => Device::Vulkan(device.clone()),
#[cfg(feature = "wgpu")]
QStorage::Wgpu(_storage, device) => Device::Wgpu(device.clone()),
}
}
fn size_in_bytes(&self) -> usize {
match self {
QStorage::Cpu(storage) => storage.storage_size_in_bytes(),
QStorage::Metal(storage) => storage.storage_size_in_bytes(),
QStorage::Cuda(storage) => storage.storage_size_in_bytes(),
#[cfg(feature = "rocm")]
QStorage::Rocm(storage, _) => storage.storage_size_in_bytes(),
#[cfg(feature = "vulkan")]
QStorage::Vulkan(storage, _) => storage.storage_size_in_bytes(),
#[cfg(feature = "wgpu")]
QStorage::Wgpu(storage, _) => storage.storage_size_in_bytes(),
}
}
fn quantize(&mut self, src: &Storage) -> Result<()> {
match (self, src) {
(QStorage::Cpu(storage), Storage::Cpu(src)) => {
storage.from_float(src.as_slice::<f32>()?);
}
(QStorage::Metal(storage), Storage::Metal(src)) => storage.quantize(src)?,
(QStorage::Cuda(storage), Storage::Cuda(src)) => storage.quantize(src)?,
_ => crate::bail!("Invalid quantize storage locations do not match"),
}
Ok(())
}
fn quantize_imatrix(
&mut self,
src: &Storage,
imatrix_weights: &[f32],
n_per_row: usize,
) -> Result<()> {
match (self, src) {
(QStorage::Cpu(storage), Storage::Cpu(src)) => {
storage.from_float_imatrix(src.as_slice::<f32>()?, imatrix_weights, n_per_row);
}
(QStorage::Metal(storage), Storage::Metal(src)) => {
storage.quantize_imatrix(src, imatrix_weights, n_per_row)?
}
(QStorage::Cuda(storage), Storage::Cuda(src)) => {
storage.quantize_imatrix(src, imatrix_weights, n_per_row)?
}
_ => crate::bail!("Invalid quantize storage locations do not match"),
}
Ok(())
}
fn quantize_onto(&mut self, src: &Storage) -> Result<()> {
match (self, src) {
(QStorage::Cpu(storage), Storage::Cpu(src)) => {
storage.from_float(src.as_slice::<f32>()?);
}
(QStorage::Metal(storage), Storage::Cpu(src)) => storage.quantize_onto(src)?,
(QStorage::Cuda(storage), Storage::Cpu(src)) => storage.quantize_onto(src)?,
_ => crate::bail!("Invalid quantize source storage locations: not on cpu"),
}
Ok(())
}
fn quantize_imatrix_onto(
&mut self,
src: &Storage,
imatrix_weights: &[f32],
n_per_row: usize,
) -> Result<()> {
match (self, src) {
(QStorage::Cpu(storage), Storage::Cpu(src)) => {
storage.from_float_imatrix(src.as_slice::<f32>()?, imatrix_weights, n_per_row);
}
(QStorage::Metal(storage), Storage::Cpu(src)) => {
storage.quantize_imatrix_onto(src, imatrix_weights, n_per_row)?
}
(QStorage::Cuda(storage), Storage::Cpu(src)) => {
storage.quantize_imatrix_onto(src, imatrix_weights, n_per_row)?
}
_ => crate::bail!("Invalid quantize storage locations do not match"),
}
Ok(())
}
fn dequantize(&self, elem_count: usize) -> Result<Storage> {
match self {
QStorage::Cpu(storage) => Ok(Storage::Cpu(storage.dequantize(elem_count)?)),
QStorage::Metal(storage) => Ok(Storage::Metal(storage.dequantize(elem_count)?)),
QStorage::Cuda(storage) => Ok(Storage::Cuda(storage.dequantize(elem_count)?)),
#[cfg(feature = "rocm")]
QStorage::Rocm(storage, device) => {
// Dequantize on the CPU, then upload the dense f32 weights to the ROCm device.
use crate::backend::BackendDevice;
let cpu = storage.dequantize(elem_count)?;
Ok(Storage::Rocm(device.storage_from_cpu_storage(&cpu)?))
}
#[cfg(feature = "vulkan")]
QStorage::Vulkan(storage, device) => {
// Dequantize on the CPU, then upload the f32 weights to the GPU.
let cpu = storage.dequantize(elem_count)?;
Ok(Storage::Vulkan(device.upload_f32(cpu.as_slice::<f32>()?)?))
}
#[cfg(feature = "wgpu")]
QStorage::Wgpu(storage, device) => {
// Dequantize on the CPU, then upload the f32 weights to the GPU.
let cpu = storage.dequantize(elem_count)?;
Ok(Storage::Wgpu(device.upload_f32(cpu.as_slice::<f32>()?)?))
}
}
}
fn data(&self) -> Result<Cow<'_, [u8]>> {
match self {
QStorage::Cpu(storage) => {
let data_ptr = storage.as_ptr();
let size_in_bytes = storage.storage_size_in_bytes();
let data = unsafe { std::slice::from_raw_parts(data_ptr, size_in_bytes) };
Ok(Cow::from(data))
}
QStorage::Cuda(storage) => Ok(Cow::from(storage.data()?)),
QStorage::Metal(storage) => Ok(Cow::from(storage.data()?)),
#[cfg(feature = "rocm")]
QStorage::Rocm(storage, _) => {
let data_ptr = storage.as_ptr();
let size_in_bytes = storage.storage_size_in_bytes();
let data = unsafe { std::slice::from_raw_parts(data_ptr, size_in_bytes) };
Ok(Cow::from(data))
}
#[cfg(feature = "vulkan")]
QStorage::Vulkan(storage, _) => {
let data_ptr = storage.as_ptr();
let size_in_bytes = storage.storage_size_in_bytes();
let data = unsafe { std::slice::from_raw_parts(data_ptr, size_in_bytes) };
Ok(Cow::from(data))
}
#[cfg(feature = "wgpu")]
QStorage::Wgpu(storage, _) => {
let data_ptr = storage.as_ptr();
let size_in_bytes = storage.storage_size_in_bytes();
let data = unsafe { std::slice::from_raw_parts(data_ptr, size_in_bytes) };
Ok(Cow::from(data))
}
}
}
pub fn device_ptr(&self) -> Result<*const u8> {
match self {
QStorage::Cuda(storage) => storage.device_ptr(),
#[cfg(feature = "rocm")]
QStorage::Rocm(..) => crate::bail!("not implemented"),
#[cfg(feature = "vulkan")]
QStorage::Vulkan(..) => crate::bail!("not implemented"),
#[cfg(feature = "wgpu")]
QStorage::Wgpu(..) => crate::bail!("not implemented"),
QStorage::Metal(_) | QStorage::Cpu(_) => {
crate::bail!("not implemented");
}
}
}
#[cfg(feature = "cuda")]
pub fn device_ptr_with_guard<'a>(
&'a self,
stream: &'a crate::cuda_backend::cudarc::driver::CudaStream,
) -> Result<(
*const u8,
crate::cuda_backend::cudarc::driver::SyncOnDrop<'a>,
)> {
match self {
QStorage::Cuda(storage) => storage.device_ptr_with_guard(stream),
QStorage::Metal(_) | QStorage::Cpu(_) => {
crate::bail!("not implemented");
}
}
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum GgmlDType {
F32,
F16,
BF16,
Q4_0,
Q4_1,
Q5_0,
Q5_1,
Q8_0,
Q8_1,
Q2K,
Q3K,
Q4K,
Q5K,
Q6K,
Q8K,
#[allow(non_camel_case_types)]
IQ4_NL,
#[allow(non_camel_case_types)]
IQ4_XS,
// 4-bit microscaling float (MXFP4), ggml type 39: 32 elems / block, E8M0 scale + 16 nibble-pairs.
MXFP4,
// IQ / ternary / 1-bit / NVFP4 codec types (decode-only; dequant->matmul on every backend).
#[allow(non_camel_case_types)]
IQ2_XXS,
#[allow(non_camel_case_types)]
IQ2_XS,
#[allow(non_camel_case_types)]
IQ3_XXS,
#[allow(non_camel_case_types)]
IQ1_S,
#[allow(non_camel_case_types)]
IQ3_S,
#[allow(non_camel_case_types)]
IQ2_S,
#[allow(non_camel_case_types)]
IQ1_M,
TQ1_0,
TQ2_0,
NVFP4,
Q1_0,
}
// --- Single-source-of-truth wiring (Cut 2) -----------------------------------------
//
// The five purely 1:1-per-block `GgmlDType` methods (`from_u32`, `to_u32`, `cpu_zeros`,
// `from_data`, `type_size`) are generated from the ONE `for_each_quant!` table in
// `quant_format.rs` instead of six hand-maintained match blocks. Each generator below is
// handed the whole `Variant => Block @ ggml_id` list and emits the block arms; the three
// non-block pseudo-types (F32/F16/BF16) that the table intentionally omits keep their
// bespoke arms inline. Behavior is byte-identical to the previous hand-written matches —
// the table's ids/blocks were verified equal to them. (`block_size` is left hand-written:
// the table carries no block-size data and its grouped form — F32=1, Q1_0/NVFP4 special,
// the big QK_K group — is already minimal.)
use crate::for_each_quant;
macro_rules! gen_from_u32 {
($($v:ident => $b:ident @ $id:literal),+ $(,)?) => {
pub(crate) fn from_u32(u: u32) -> Result<Self> {
let dtype = match u {
0 => Self::F32,
1 => Self::F16,
30 => Self::BF16,
$( $id => Self::$v, )+
_ => crate::bail!("unknown dtype for tensor {u}"),
};
Ok(dtype)
}
};
}
macro_rules! gen_to_u32 {
($($v:ident => $b:ident @ $id:literal),+ $(,)?) => {
/// GGML type id for this dtype. Single source of truth (generated from the
/// `for_each_quant!` table); cross-crate callers (e.g. hanzo-quant UQFF
/// serialization) use this instead of hand-rolled id maps that drift.
pub fn to_u32(self) -> u32 {
match self {
Self::F32 => 0,
Self::F16 => 1,
Self::BF16 => 30,
$( Self::$v => $id, )+
}
}
};
}
macro_rules! gen_cpu_zeros {
($($v:ident => $b:ident @ $id:literal),+ $(,)?) => {
/// The block dtype
pub fn cpu_zeros(&self, elem_count: usize) -> Box<dyn QuantizedType> {
match self {
Self::F32 => Box::new(vec![f32::zeros(); elem_count]),
Self::F16 => Box::new(vec![f16::zeros(); elem_count]),
Self::BF16 => Box::new(vec![bf16::zeros(); elem_count]),
$( Self::$v => Box::new(vec![<$b>::zeros(); elem_count / <$b>::BLCK_SIZE]), )+
}
}
};
}
macro_rules! gen_from_data {
($($v:ident => $b:ident @ $id:literal),+ $(,)?) => {
pub fn from_data(&self, data: Cow<'_, [u8]>) -> Box<dyn QuantizedType> {
match self {
Self::F32 => Box::new(as_t_slice::<f32>(&data).to_vec()),
Self::F16 => Box::new(as_t_slice::<f16>(&data).to_vec()),
Self::BF16 => Box::new(as_t_slice::<bf16>(&data).to_vec()),
$( Self::$v => Box::new(as_t_slice::<$b>(&data).to_vec()), )+
}
}
};
}
macro_rules! gen_type_size {
($($v:ident => $b:ident @ $id:literal),+ $(,)?) => {
/// The type size for blocks in bytes.
pub fn type_size(&self) -> usize {
use k_quants::*;
match self {
Self::F32 => 4,
Self::F16 | Self::BF16 => 2,
$( Self::$v => std::mem::size_of::<$b>(), )+
}
}
};
}
impl GgmlDType {
for_each_quant!(gen_from_u32);
for_each_quant!(gen_to_u32);
for_each_quant!(gen_cpu_zeros);
for_each_quant!(gen_from_data);
for_each_quant!(gen_type_size);
/// The block size, i.e. the number of elements stored in each block.
pub fn block_size(&self) -> usize {
match self {
Self::F32 => 1,
Self::F16 | Self::BF16 => 1,
Self::Q4_0 => k_quants::QK4_0,
Self::Q4_1 => k_quants::QK4_1,
Self::Q5_0 => k_quants::QK5_0,
Self::Q5_1 => k_quants::QK5_1,
Self::Q8_0 => k_quants::QK8_0,
Self::Q8_1 => k_quants::QK8_1,
Self::IQ4_NL => k_quants::QK4_NL,
Self::MXFP4 => k_quants::QK_MXFP4,
Self::Q1_0 => iq_quants::QK1_0,
Self::NVFP4 => iq_quants::QK_NVFP4,
Self::Q2K
| Self::Q3K
| Self::Q4K
| Self::Q5K
| Self::Q6K
| Self::Q8K
| Self::IQ4_XS
| Self::IQ2_XXS
| Self::IQ2_XS
| Self::IQ3_XXS
| Self::IQ1_S
| Self::IQ3_S
| Self::IQ2_S
| Self::IQ1_M
| Self::TQ1_0
| Self::TQ2_0 => k_quants::QK_K,
}
}
}
// A version of GgmlType without `vec_dot` so that it can be dyn boxed.
pub trait QuantizedType: Send + Sync {
fn dtype(&self) -> GgmlDType;
fn matmul_t(&self, mkn: (usize, usize, usize), lhs: &[f32], dst: &mut [f32]) -> Result<()>;
fn matmul_t_f16(&self, mkn: (usize, usize, usize), lhs: &[f16], dst: &mut [f16]) -> Result<()>;
fn dequantize(&self, elem_count: usize) -> Result<CpuStorage>;
fn storage_size_in_bytes(&self) -> usize;
fn as_ptr(&self) -> *const u8;
fn block_size(&self) -> usize;
#[allow(clippy::wrong_self_convention)]
fn from_float(&mut self, xs: &[f32]);
#[allow(clippy::wrong_self_convention)]
fn from_float_imatrix(&mut self, xs: &[f32], imatrix_weights: &[f32], n_per_row: usize);
fn size(&self) -> usize;
}
impl<T: k_quants::GgmlType + Send + Sync> QuantizedType for Vec<T> {
fn matmul_t(&self, mkn: (usize, usize, usize), lhs: &[f32], dst: &mut [f32]) -> Result<()> {
k_quants::matmul(mkn, lhs, self.as_slice(), dst)
}
fn matmul_t_f16(&self, mkn: (usize, usize, usize), lhs: &[f16], dst: &mut [f16]) -> Result<()> {
k_quants::matmul_f16(mkn, lhs, self.as_slice(), dst)
}
fn size(&self) -> usize {
self.len() * core::mem::size_of::<T>()
}
fn from_float(&mut self, xs: &[f32]) {
T::from_float(xs, self)
}
fn from_float_imatrix(&mut self, xs: &[f32], imatrix_weights: &[f32], n_per_row: usize) {
T::from_float_imatrix(xs, self, imatrix_weights, n_per_row)
}
fn dtype(&self) -> GgmlDType {
T::DTYPE
}
fn block_size(&self) -> usize {
T::BLCK_SIZE
}
fn dequantize(&self, elem_count: usize) -> Result<CpuStorage> {
let mut ys = vec![0.0f32; elem_count];
T::to_float(self.as_slice(), &mut ys);
Ok(CpuStorage::F32(ys))
}
fn storage_size_in_bytes(&self) -> usize {
self.len() * std::mem::size_of::<T>()
}
fn as_ptr(&self) -> *const u8 {
self.as_ptr() as *const u8
}
}
impl std::fmt::Debug for QTensor {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "QTensor[{:?}; {:?}]", self.shape, self.dtype())
}
}
fn check_shape(shape: &Shape, block_size: usize) -> Result<()> {
let dims = shape.dims();
if dims.is_empty() {
crate::bail!("scalar tensor cannot be quantized {shape:?}")
}
if !dims[dims.len() - 1].is_multiple_of(block_size) {
crate::bail!(
"quantized tensor must have their last dim divisible by block size {shape:?} {}",
block_size
)
}
Ok(())
}
impl QTensor {
pub fn new<S: Into<Shape>>(storage: QStorage, shape: S) -> Result<Self> {
let shape = shape.into();
check_shape(&shape, storage.block_size())?;
Ok(Self { storage, shape })
}
pub fn quantize(src: &Tensor, dtype: GgmlDType) -> Result<Self> {
let shape = src.shape();
let block_size = dtype.block_size();
check_shape(shape, block_size)?;
let src = src.to_dtype(crate::DType::F32)?.flatten_all()?;
let elem_count = shape.elem_count();
if !elem_count.is_multiple_of(block_size) {
crate::bail!(
"tensor size ({shape:?}) is not divisible by block size {}",
block_size
)
}
let mut storage = src.device().qzeros(elem_count, dtype)?;
storage.quantize(&src.storage())?;
Ok(Self {
storage,
shape: shape.clone(),
})
}
pub fn quantize_imatrix(
src: &Tensor,
imatrix_weights: &[f32],
dtype: GgmlDType,
) -> Result<Self> {
// (n_per_row/QK_K-1)*QK_K+(QK_K/32-1)*32+32=n_per_row
// Size of imatrix == last dim of tensor
let n_per_row = src.dim(D::Minus1)?;
if imatrix_weights.len() != n_per_row {
crate::bail!(
"imatrix weights must have the same length {} as the last dim of src {}",
imatrix_weights.len(),
src.dim(D::Minus1)?
);
}
let shape = src.shape();
let block_size = dtype.block_size();
check_shape(shape, block_size)?;
let src = src.to_dtype(crate::DType::F32)?.flatten_all()?;
let elem_count = shape.elem_count();
if !elem_count.is_multiple_of(block_size) {
crate::bail!(
"tensor size ({shape:?}) is not divisible by block size {}",
block_size
);
}
let mut storage = src.device().qzeros(elem_count, dtype)?;
storage.quantize_imatrix(&src.storage(), imatrix_weights, n_per_row)?;
Ok(Self {
storage,
shape: shape.clone(),
})
}
/// Quantize `src` (currently on the CPU) to a QTensor on `dev`
pub fn quantize_imatrix_onto(
src: &Tensor,
imatrix_weights: &[f32],
dtype: GgmlDType,
dev: &Device,
) -> Result<Self> {
if !src.device().is_cpu() {
crate::bail!(
"`quantize_onto` expects a `src` to be on the cpu, got {:?}.",
src.device()
)
}
// (n_per_row/QK_K-1)*QK_K+(QK_K/32-1)*32+32=n_per_row
// Size of imatrix == last dim of tensor
let n_per_row = src.dim(D::Minus1)?;
if imatrix_weights.len() != n_per_row {
crate::bail!(
"imatrix weights must have the same length {} as the last dim of src {}",
imatrix_weights.len(),
src.dim(D::Minus1)?
);
}
let shape = src.shape();
let block_size = dtype.block_size();
check_shape(shape, block_size)?;
let src = src.to_dtype(crate::DType::F32)?.flatten_all()?;
let elem_count = shape.elem_count();
if !elem_count.is_multiple_of(block_size) {
crate::bail!(
"tensor size ({shape:?}) is not divisible by block size {}",
block_size
)
}
// storage is on the `dev`, src is on `cpu`
let mut storage = dev.qzeros(elem_count, dtype)?;
storage.quantize_imatrix_onto(&src.storage(), imatrix_weights, n_per_row)?;
Ok(Self {
storage,
shape: shape.clone(),
})
}
/// Quantize `src` (currently on the CPU) to a QTensor on `dev`
pub fn quantize_onto(src: &Tensor, dtype: GgmlDType, dev: &Device) -> Result<Self> {
if !src.device().is_cpu() {
crate::bail!(
"`quantize_onto` expects a `src` to be on the cpu, got {:?}.",
src.device()
)
}
let shape = src.shape();
let block_size = dtype.block_size();
check_shape(shape, block_size)?;
let src = src.to_dtype(crate::DType::F32)?.flatten_all()?;
let elem_count = shape.elem_count();
if !elem_count.is_multiple_of(block_size) {
crate::bail!(
"tensor size ({shape:?}) is not divisible by block size {}",
block_size
)
}
// storage is on the `dev`, src is on `cpu`
let mut storage = dev.qzeros(elem_count, dtype)?;
storage.quantize_onto(&src.storage())?;
Ok(Self {
storage,
shape: shape.clone(),
})
}
pub fn dtype(&self) -> GgmlDType {
self.storage.dtype()
}
pub fn device(&self) -> Device {
self.storage.device()
}
pub fn rank(&self) -> usize {
self.shape.rank()
}
pub fn shape(&self) -> &Shape {
&self.shape
}
pub fn dequantize(&self, device: &Device) -> Result<Tensor> {
let storage = self.storage.dequantize(self.shape.elem_count())?;
let none = crate::op::BackpropOp::none();
crate::tensor::from_storage(storage, self.shape.clone(), none, false).to_device(device)
}
pub fn dequantize_f16(&self, device: &Device) -> Result<Tensor> {
// In the CUDA case, we have a specialized kernel as this can be useful for volta
// architectures. https://github.com/hanzoai/ml/issues/2136
match &self.storage {
QStorage::Cuda(s) => {
let s = s.dequantize_f16(self.shape.elem_count())?;
let none = crate::op::BackpropOp::none();
crate::tensor::from_storage(Storage::Cuda(s), self.shape.clone(), none, false)
.to_device(device)
}
_ => {
let s = self.dequantize(device)?.to_dtype(crate::DType::F16)?;
Ok(s)
}
}
}
pub fn storage_size_in_bytes(&self) -> usize {
self.storage.size_in_bytes()
}
pub fn data(&self) -> Result<Cow<'_, [u8]>> {
self.storage.data()
}
// Upload this expert bank's GGML bytes to VRAM ONCE and keep it resident, keyed by the stable
// (ptr,len) of the QTensor's CPU bytes. Re-uploading the multi-GB bank per token/layer would
// dominate decode, so the cache makes MoE bandwidth-bound on the quant matvec, not the H2D copy.
#[cfg(feature = "rocm")]
fn rocm_moe_bank(
&self,
dev: &crate::RocmDevice,
) -> Result<std::sync::Arc<crate::RocmStorage>> {
use crate::backend::BackendDevice;
let bank = self.data()?;
let key = (bank.as_ref().as_ptr() as usize, bank.as_ref().len());
let cache = rocm_moe_bank_cache();
let mut guard = cache.lock().expect("moe bank cache lock");
if let Some(w) = guard.get(&key) {
Ok(w.clone())
} else {
let w = std::sync::Arc::new(dev.storage_from_slice(bank.as_ref())?);
guard.insert(key, w.clone());
Ok(w)
}
}
pub fn indexed_moe_forward(&self, x: &Tensor, ids: &Tensor) -> Result<Tensor> {
// The fused CUDA path reads ids as a flat row-major [batch*topk] buffer (rank-agnostic since
// 0.11.17); force dense strides so a non-contiguous router output can't misindex the kernel.
let ids = &ids.contiguous()?;
match &self.storage {
// Only dtypes with a fused CUDA indexed-MoE kernel take the fast path; others (e.g. MXFP4,
// i-quant/ternary) fall through to the generic per-expert path below, which dequantizes via
// QMatMul. The supported set is derived from the ONE kernel-name table (cuda.rs), so this gate
// can't drift from the kernels that actually exist -- which is exactly what had stranded
// Q4_0/Q4_1/Q5_0/Q5_1 on the CPU even though their fused kernels are now compiled.
QStorage::Cuda(s) if cuda::QCudaStorage::supports_indexed_moe(s.dtype()) =>
{
match (&*x.storage(), &*ids.storage()) {
(Storage::Cuda(x_storage), Storage::Cuda(ids_storage)) => {
let (storage, out_shape) = s.indexed_moe_forward(
self.shape(),
x_storage,
x.layout(),
ids_storage,
ids.layout(),
)?;
Ok(crate::tensor::from_storage(
Storage::Cuda(storage),
out_shape,
crate::op::BackpropOp::none(),
false,
))
}
_ => {
panic!("Non-cuda indexed_moe_forward is not implemented!");
}
}
},
// Native CUDA i-quant MoE: the i-quant codebook types have no Blue-C fused q8_1 MoE kernel,
// but a native dp4a MoE-decode kernel (moe_qmatvec_dp4a_<iq*>). The [E,n,k] bank stays
// RESIDENT in VRAM and the router gather runs on-device -- the dp4a twin of the ROCm path.
// This intercepts i-quant MoE BEFORE the generic fallback below, which would DtoH the whole
// expert bank to host (self.data()) and re-upload every selected expert PER TOKEN.
#[cfg(feature = "cuda")]
QStorage::Cuda(s)
if cuda::QCudaStorage::supports_iquant_moe(s.dtype())
&& !cuda::iq_dequant_fallback() =>
{
let out_dtype = x.dtype();
let (_e_cnt, n, k) = self.shape().dims3()?;
let (t, topk) = ids.dims2()?;
let nrows = t * topk;
// PREFILL (t>1): expert-grouped int8-WMMA MMQ (qmmq) -- stage each expert's weight ONCE
// and amortize it over all its routed tokens via the tensor cores (llama mul_mat_id),
// instead of the per-slot dp4a re-streaming the weight per token. Uses the RAW [t,in1,k]
// input (indexed_moe_grouped broadcasts/gathers internally). IQ1_M (no MMQ kernel) returns
// None -> the per-slot dp4a below. HANZO_MOE_QMMQ_FALLBACK forces dp4a (A/B).
if t > 1 && std::env::var("HANZO_MOE_QMMQ_FALLBACK").is_err() {
let x_f32 = x.to_dtype(crate::DType::F32)?.contiguous()?;
let ids_u32 = ids.to_dtype(crate::DType::U32)?.contiguous()?;
let (xs, _) = x_f32.storage_and_layout();
let xc = match &*xs {
Storage::Cuda(c) => c,
_ => crate::bail!("cuda i-quant MoE: x not on cuda after contiguous()"),
};
let (ids_s, _) = ids_u32.storage_and_layout();
let idc = match &*ids_s {
Storage::Cuda(c) => c,
_ => crate::bail!("cuda i-quant MoE: ids not on cuda"),
};
if let Some((st, sh)) = s.moe_iquant_qmmq(
self.shape(),
xc.as_cuda_slice::<f32>()?,
x.shape(),
&idc.as_cuda_slice::<u32>()?.slice(0..),
ids.shape(),
)? {
return crate::tensor::from_storage(
Storage::Cuda(st),
sh,
crate::op::BackpropOp::none(),
false,
)
.to_dtype(out_dtype);
}
}
// DECODE (t==1) or qmmq-unsupported (IQ1_M): per-slot dp4a. Broadcast the shared gate/up
// input across topk to a per-slot [nrows,k] activation. f32-native -> the matvec returns
// F32 and the to_dtype below is a no-op for f32 models.
let sdim = x.dim(1)?; // 1 (gate/up: shared input) or topk (down: per-slot)
let x_exp = if sdim == topk {
x.clone()
} else {
x.broadcast_as((t, topk, k))?
};
let x_flat = x_exp
.reshape((nrows, k))?
.to_dtype(crate::DType::F32)?
.contiguous()?;
let ids_flat = ids.reshape((nrows,))?.to_dtype(crate::DType::U32)?.contiguous()?;
let (xstore, _) = x_flat.storage_and_layout();
let xc = match &*xstore {
Storage::Cuda(c) => c,
_ => crate::bail!("cuda i-quant MoE: x not on cuda after contiguous()"),
};
let (idstore, _) = ids_flat.storage_and_layout();
let idc = match &*idstore {
Storage::Cuda(c) => c,
_ => crate::bail!("cuda i-quant MoE: ids not on cuda"),
};
let y = s.moe_iquant_dp4a(
&xc.as_cuda_slice::<f32>()?.slice(0..),
&idc.as_cuda_slice::<u32>()?.slice(0..),
nrows,
n,
k,
)?;
let out = crate::tensor::from_storage(
Storage::Cuda(y),
(nrows, n),
crate::op::BackpropOp::none(),
false,
);
out.reshape((t, topk, n))?.to_dtype(out_dtype)
}
// Native Vulkan MoE: one fused grouped quant matvec dispatch reads the per-expert slice
// out of the GGML weight bank [E, n, k] resident in VRAM and gathers by the router ids --
// the whole expert compute runs on the GPU (no CPU expert loop; the CPU fallback below
// would also hit the unimplemented Vulkan index_add). Supported for Q4_0/Q8_0/Q4_K; other
// quant dtypes fall through to the (CPU-bound) generic path.
#[cfg(feature = "vulkan")]
QStorage::Vulkan(_, vk_dev)
if matches!(
self.storage.dtype(),
GgmlDType::Q4_0 | GgmlDType::Q8_0 | GgmlDType::Q4K
) =>
{
let out_dtype = x.dtype();
let (e_cnt, n, k) = self.shape().dims3()?;
let (t, topk) = ids.dims2()?;
let s = x.dim(1)?; // 1 (gate/up: shared input) or topk (down: per-slot)
let x_exp = if s == topk {
x.clone()
} else {
x.broadcast_as((t, topk, k))?
};
// [S, k] contiguous f32 on the Vulkan device; S = t*topk routed slots.
let nrows = t * topk;
let x_flat = x_exp
.reshape((nrows, k))?
.to_dtype(crate::DType::F32)?
.contiguous()?;
let ids_vec = ids
.reshape((nrows,))?
.to_dtype(crate::DType::U32)?
.to_vec1::<u32>()?;
// Defend against a stray id (model bug / corrupt router) reading OOB in the bank.
if let Some(&bad) = ids_vec.iter().find(|&&e| e as usize >= e_cnt) {
crate::bail!("indexed_moe_forward: expert id {bad} >= num_experts {e_cnt}");
}
let kernel = match self.storage.dtype() {
GgmlDType::Q4_0 => "moe_matvec_q4_0",
GgmlDType::Q8_0 => "moe_matvec_q8_0",
GgmlDType::Q4K => "moe_matvec_q4k",
other => crate::bail!("vulkan MoE: no kernel for {other:?}"),
};
let bank = self.data()?; // raw GGML bytes for all E experts, [E, n, k]
// moe_matvec_q8_0's shader reads the repacked 9-u32/block layout (same as the decode
// matvec_q8 path); Q4_0/Q4_K shaders read the raw GGML bytes directly.
let wbank = match self.storage.dtype() {
GgmlDType::Q8_0 => vk_dev.quantize_q8_blocks(&bank, e_cnt * n, k)?,
_ => vk_dev.upload_qweight(&bank)?,
};
let ids_buf = vk_dev.upload_ids(&ids_vec)?;
let y = {
let (store, _) = x_flat.storage_and_layout();
let xv = match &*store {
Storage::Vulkan(v) => v,
_ => crate::bail!("vulkan MoE: x not on vulkan after contiguous()"),
};
vk_dev.moe_matvec_gpu(kernel, &wbank, xv, &ids_buf, nrows, n, k)?
};
let out = crate::tensor::from_storage(
Storage::Vulkan(y),
(nrows, n),
crate::op::BackpropOp::none(),
false,
);
out.reshape((t, topk, n))?.to_dtype(out_dtype)
}
// Native wgpu MoE: mirror of the Vulkan fused grouped quant matvec dispatch. The GGML
// weight bank [E, n, k] is uploaded once and the router gather + per-expert GEMM run in
// one WGSL dispatch. Supported for Q4_0/Q8_0/Q4_K.
#[cfg(feature = "wgpu")]
QStorage::Wgpu(_, wgpu_dev)
if matches!(
self.storage.dtype(),
GgmlDType::Q4_0 | GgmlDType::Q8_0 | GgmlDType::Q4K
) =>
{
let out_dtype = x.dtype();
let (e_cnt, n, k) = self.shape().dims3()?;
let (t, topk) = ids.dims2()?;
let s = x.dim(1)?; // 1 (gate/up: shared input) or topk (down: per-slot)
let x_exp = if s == topk {
x.clone()
} else {
x.broadcast_as((t, topk, k))?
};
let nrows = t * topk;
let x_flat = x_exp
.reshape((nrows, k))?
.to_dtype(crate::DType::F32)?
.contiguous()?;
let ids_vec = ids
.reshape((nrows,))?
.to_dtype(crate::DType::U32)?
.to_vec1::<u32>()?;
if let Some(&bad) = ids_vec.iter().find(|&&e| e as usize >= e_cnt) {
crate::bail!("indexed_moe_forward: expert id {bad} >= num_experts {e_cnt}");
}
let kernel = match self.storage.dtype() {
GgmlDType::Q4_0 => "moe_matvec_q4_0",
GgmlDType::Q8_0 => "moe_matvec_q8_0",
GgmlDType::Q4K => "moe_matvec_q4k",
other => crate::bail!("wgpu MoE: no kernel for {other:?}"),
};
let bank = self.data()?; // raw GGML bytes for all E experts, [E, n, k]
let wbank = wgpu_dev.upload_qweight(&bank)?;
let ids_buf = wgpu_dev.upload_ids(&ids_vec)?;
let y = {
let (store, _) = x_flat.storage_and_layout();
let xv = match &*store {
Storage::Wgpu(v) => v,
_ => crate::bail!("wgpu MoE: x not on wgpu after contiguous()"),
};
wgpu_dev.moe_matvec_gpu(kernel, &wbank, xv, &ids_buf, nrows, n, k)?
};
let out = crate::tensor::from_storage(
Storage::Wgpu(y),
(nrows, n),
crate::op::BackpropOp::none(),
false,
);
out.reshape((t, topk, n))?.to_dtype(out_dtype)
}
// Native ROCm MoE: the GGML expert bank [E,n,k] is uploaded once and each routed slot
// is dispatched through the SAME unified qmatvec_core<WTYPE> as ordinary decode (no
// MoE-per-quant kernel; works for every wired quant). Avoids ROCm's missing index_add:
// each routed slot writes exactly one output row, placed directly by slot index.
#[cfg(feature = "rocm")]
QStorage::Rocm(_, rocm_dev)
if crate::RocmQuantType::from_ggml(self.storage.dtype()).is_some() =>
{
let qt = crate::RocmQuantType::from_ggml(self.storage.dtype()).unwrap();
let out_dtype = x.dtype();
// e_cnt is not read: ids stay on-device and the router guarantees the bound, so the
// old host bounds check (and its DtoH `to_vec1`) is gone.
let (_e_cnt, n, k) = self.shape().dims3()?;
let (t, topk) = ids.dims2()?;
let s = x.dim(1)?; // 1 (gate/up: shared input) or topk (down: per-slot)
let x_exp = if s == topk {
x.clone()
} else {
x.broadcast_as((t, topk, k))?
};
let nrows = t * topk;
// PREFILL (t>1) routes to the fused expert-grouped WMMA GEMM (f16 activations); DECODE
// (t==1) keeps the model's native bf16/f16 on the capture-clean matvec. See the twin in
// QStorage::indexed_moe_forward. HANZO_MOE_QMMQ_FALLBACK forces matvec for the A/B.
// Decode-only types (no qmmq kernel) ride the per-slot matvec core for prefill too
// (correct at any token count). ONE predicate gates every prefill site.
let use_qmmq =
t > 1 && qt.qmmq_capable() && std::env::var("HANZO_MOE_QMMQ_FALLBACK").is_err();
let x_flat = match x_exp.dtype() {
// qmmq quantizes f16/f32 activations natively, so keep the model's dtype and skip
// the f32->f16 cast (a 16.7M-elem read+write per gate/up). Other dtypes (bf16 with
// a symmetric expert type) still cast to f16.
DType::F16 | DType::F32 if use_qmmq => x_exp.reshape((nrows, k))?.contiguous()?,
_ if use_qmmq => x_exp.reshape((nrows, k))?.to_dtype(DType::F16)?.contiguous()?,
DType::BF16 | DType::F16 => x_exp.reshape((nrows, k))?.contiguous()?,
// DECODE f32-native: dp4a experts quantize q8_1 from f32 and store f32, so an F32
// routed activation stays F32 (the matvec returns F32 -> the .to_dtype(out_dtype)
// below is a no-op), removing the cast pair that wrapped each gate/up/down matvec.
DType::F32 if qt.dp4a_active() => x_exp.reshape((nrows, k))?.contiguous()?,
_ => x_exp.reshape((nrows, k))?.to_dtype(DType::F16)?.contiguous()?,
};
let wbank = self.rocm_moe_bank(rocm_dev)?;
// Keep router ids ON the GPU for EVERY wired quant type and run ONE batched launch
// (experts on grid.y, ids read on-device). No `to_vec1` DtoH sync -- that host round-
// trip (3 per layer x 48 layers per token) was both the dominant WSL decode stall AND
// what made HIP stream capture illegal (hipErrorStreamCaptureImplicit -> the graph-path
// SIGSEGV). The router emits a top-k over the e_cnt expert logits, so 0 <= id < e_cnt
// by construction; the prior host bounds check is dropped to stay capture-clean.
let ids_u32 = ids
.reshape((nrows,))?
.to_dtype(crate::DType::U32)?
.contiguous()?;
let (store, _) = x_flat.storage_and_layout();
let xr = match &*store {
crate::Storage::Rocm(r) => r,
_ => crate::bail!("rocm MoE: x not on rocm after contiguous()"),
};
let (idstore, _) = ids_u32.storage_and_layout();
let idr = match &*idstore {
crate::Storage::Rocm(r) => r,
_ => crate::bail!("rocm MoE: ids not on rocm"),
};
let y = if use_qmmq {
rocm_dev.moe_qmmq_quant(qt, wbank.as_ref(), xr, idr, nrows, n, k)?
} else {
rocm_dev.moe_matvec_quant(qt, wbank.as_ref(), xr, idr, nrows, n, k)?
};
let out = crate::tensor::from_storage(
crate::Storage::Rocm(y),
(nrows, n),
crate::op::BackpropOp::none(),
false,
);
out.reshape((t, topk, n))?.to_dtype(out_dtype)
}
_ => {
// CPU / non-CUDA fallback: per-expert quantized matmul. The packed expert bank
// [E, n, k] is sliced into equal, contiguous per-expert quantized blocks; for
// each expert that is actually selected we run hanzo-ml's native quantized matmul
// on just the tokens routed to it. Nothing is dequantized, so quantized MoE runs
// on any backend (CPU, Metal, ...) at a cost proportional to the active experts.
use crate::Module; // brings QMatMul::forward into scope
use std::collections::HashMap;
use std::sync::Arc;
let device = x.device();
let out_dtype = x.dtype();
let (e_cnt, n, k) = self.shape().dims3()?;
let (t, topk) = ids.dims2()?;
let s = x.dim(1)?; // 1 (gate/up: shared input) or topk (down: per-slot)
let x_exp = if s == topk {
x.clone()
} else {
x.broadcast_as((t, topk, k))?
};
let x_flat = x_exp
.reshape((t * topk, k))?
.to_dtype(crate::DType::F32)?
.contiguous()?;
let ids_flat = ids.reshape((t * topk,))?.to_dtype(crate::DType::U32)?;
let ids_vec = ids_flat.to_vec1::<u32>()?;
let mut groups: HashMap<u32, Vec<u32>> = HashMap::new();
for (slot, eid) in ids_vec.iter().enumerate() {
groups.entry(*eid).or_default().push(slot as u32);
}
let dtype = self.storage.dtype();
let all_bytes = self.data()?;
let expert_bytes = all_bytes.len() / e_cnt;
let mut out_flat = Tensor::zeros((t * topk, n), crate::DType::F32, device)?;
for (eid, slots) in groups.into_iter() {
let off = eid as usize * expert_bytes;
let qs = QStorage::from_data(
std::borrow::Cow::Borrowed(&all_bytes[off..off + expert_bytes]),
device,
dtype,
)?;
let shape: crate::Shape = (n, k).into();
let w_e = QTensor { storage: qs, shape };
let qm = QMatMul::from_arc(Arc::new(w_e))?;
let m = slots.len();
let idx = Tensor::from_vec(slots, (m,), device)?;
let x_e = x_flat.index_select(&idx, 0)?; // [m, k]
let y_e = qm.forward(&x_e)?.to_dtype(crate::DType::F32)?; // [m, n]
out_flat = out_flat.index_add(&idx, &y_e, 0)?;
}
out_flat.reshape((t, topk, n))?.to_dtype(out_dtype)
}
}
}
pub fn device_ptr(&self) -> Result<*const u8> {
match &self.storage {
QStorage::Cuda(storage) => storage.device_ptr(),
#[cfg(feature = "rocm")]
QStorage::Rocm(..) => crate::bail!("not implemented"),
#[cfg(feature = "vulkan")]
QStorage::Vulkan(..) => crate::bail!("not implemented"),
#[cfg(feature = "wgpu")]
QStorage::Wgpu(..) => crate::bail!("not implemented"),
QStorage::Metal(_) | QStorage::Cpu(_) => {
crate::bail!("not implemented");
}
}
}
#[cfg(feature = "cuda")]
pub fn device_ptr_with_guard<'a>(
&'a self,
stream: &'a crate::cuda_backend::cudarc::driver::CudaStream,
) -> Result<(
*const u8,
crate::cuda_backend::cudarc::driver::SyncOnDrop<'a>,
)> {
self.storage.device_ptr_with_guard(stream)
}
}
#[derive(Clone, Debug)]
pub enum QMatMul {
QTensor(std::sync::Arc<QTensor>),
Tensor(Tensor),
TensorF16(Tensor),
// Native Vulkan quantized weight: the GGML quantized blocks live in VRAM (Q4_0/Q4_K ~0.5 B/elem,
// Q8_0 ~1.06 B/elem). Decode (1 row) runs the matching on-GPU quant matvec kernel directly out of
// the block format (no CPU dequant, no re-pack) -- the bandwidth lever for memory-bound decode.
// Prefill (>1 row) dequantizes the original `qtensor` to a temporary f32 weight. `dtype` selects
// the kernel; `n`/`k` are the weight dims.
#[cfg(feature = "vulkan")]
VulkanQuant {
qtensor: std::sync::Arc<QTensor>,
wq: std::sync::Arc<crate::VulkanStorage>,
dtype: GgmlDType,
n: usize,
k: usize,
},
// wgpu mirror of VulkanQuant: GGML quantized blocks live in VRAM and decode (1 row) runs the
// matching native-GGML quant matvec WGSL kernel straight out of the block format. Prefill (>1
// row) dequantizes to a temporary f32 weight. `dtype` selects the kernel; `n`/`k` are the dims.
#[cfg(feature = "wgpu")]
WgpuQuant {
qtensor: std::sync::Arc<QTensor>,
wq: std::sync::Arc<crate::WgpuStorage>,
dtype: GgmlDType,
n: usize,
k: usize,
},
// Native ROCm quantized weight: the GGML blocks live in VRAM. Decode (1 row) runs the ONE
// unified on-GPU quant matvec (qmatvec_core<WTYPE>) straight out of the block format; prefill
// (>1 row) runs the ONE unified int8 WMMA GEMM (qmmq_core<WTYPE>) -- both for the full wired
// spread (Q8_0/Q4_0/Q4_K/Q6_K/IQ4_XS/TQ2_0). Unwired types dequantize to a temporary f16
// weight (RDNA matrix-core matmul). `n`/`k` are the weight dims.
#[cfg(feature = "rocm")]
RocmQuant {
qtensor: std::sync::Arc<QTensor>,
wq: std::sync::Arc<crate::RocmStorage>,
dtype: GgmlDType,
n: usize,
k: usize,
},
}
// Resident ROCm MoE expert-bank cache: maps a (CPU bank ptr, len) to its uploaded VRAM copy so
// the multi-GB GGML expert bank is host->device copied ONCE, not per token/layer. The CPU bytes
// are owned by the model's QTensor for its lifetime, so the pointer is a stable key. Keyed by
// usize (raw ptr) to stay Send+Sync; the RocmStorage is reference-counted and reused.
#[cfg(feature = "rocm")]
fn rocm_moe_bank_cache(
) -> &'static std::sync::Mutex<std::collections::HashMap<(usize, usize), std::sync::Arc<crate::RocmStorage>>>
{
static CACHE: std::sync::OnceLock<
std::sync::Mutex<std::collections::HashMap<(usize, usize), std::sync::Arc<crate::RocmStorage>>>,
> = std::sync::OnceLock::new();
CACHE.get_or_init(|| std::sync::Mutex::new(std::collections::HashMap::new()))
}
/// FUSED MoE expert-combine: `out[i,j] = sum_e scores[i,e] * ys[i,e,j]`, reducing the per-expert
/// outputs `ys` [t, topk, n] by the router weights `scores` [t, topk] into [t, n]. On ROCm this is
/// ONE fused kernel (`RocmDevice::moe_combine`) instead of `ys.broadcast_mul(scores).sum(Minus2)`,
/// which cast ys -> f32, wrote a [t,topk,n] f32 product temp, and ran an 8-wide strided reduce.
/// Other backends keep the generic broadcast-mul + sum.
pub fn moe_combine(ys: &Tensor, scores: &Tensor) -> Result<Tensor> {
let (t, topk, n) = ys.dims3()?;
#[cfg(feature = "rocm")]
if let Device::Rocm(dev) = ys.device() {
if std::env::var("HANZO_MOE_COMBINE_FALLBACK").is_ok() {
return ys.broadcast_mul(&scores.unsqueeze(D::Minus1)?)?.sum(D::Minus2);
}
let ys_c = ys.contiguous()?;
let scores_c = scores.to_dtype(DType::F32)?.contiguous()?;
let (ys_store, _) = ys_c.storage_and_layout();
let yr = match &*ys_store {
Storage::Rocm(r) => r,
_ => crate::bail!("moe_combine: ys not on rocm after contiguous()"),
};
let (sc_store, _) = scores_c.storage_and_layout();
let sr = match &*sc_store {
Storage::Rocm(r) => r,
_ => crate::bail!("moe_combine: scores not on rocm after contiguous()"),
};
let out = dev.moe_combine(yr, sr, t, topk, n)?;
return Ok(crate::tensor::from_storage(
Storage::Rocm(out),
(t, n),
crate::op::BackpropOp::none(),
false,
));
}
ys.broadcast_mul(&scores.unsqueeze(D::Minus1)?)?.sum(D::Minus2)
}
/// Fused MoE router. Reduces the F32 router logits [ntok, n_experts] to the topk selected expert
/// ids [ntok, topk] (descending logit) and their softmax weights [ntok, topk]; `norm` renormalizes
/// the topk weights to sum 1 (norm_topk_prob). On ROCm this is ONE `moe_route` kernel replacing the
/// softmax->sort->narrow->sum->div chain (~6 launches/layer); elsewhere it is that chain via ml ops.
pub fn moe_route(logits: &Tensor, topk: usize, norm: bool) -> Result<(Tensor, Tensor)> {
let (ntok, n_experts) = logits.dims2()?;
#[cfg(feature = "rocm")]
if let Device::Rocm(dev) = logits.device() {
if std::env::var("HANZO_MOE_ROUTE_FALLBACK").is_err() {
let logits_c = logits.to_dtype(DType::F32)?.contiguous()?;
let (lg_store, _) = logits_c.storage_and_layout();
let lr = match &*lg_store {
Storage::Rocm(r) => r,
_ => crate::bail!("moe_route: logits not on rocm after contiguous()"),
};
let (ids, w) = dev.moe_route(lr, ntok, n_experts, topk, norm)?;
let ids_t = crate::tensor::from_storage(
Storage::Rocm(ids),
(ntok, topk),
crate::op::BackpropOp::none(),
false,
);
let w_t = crate::tensor::from_storage(
Storage::Rocm(w),
(ntok, topk),
crate::op::BackpropOp::none(),
false,
);
return Ok((ids_t, w_t));
}
}
let lf = logits.to_dtype(DType::F32)?;
let mx = lf.max_keepdim(D::Minus1)?;
let e = lf.broadcast_sub(&mx)?.exp()?;
let z = e.sum_keepdim(D::Minus1)?;
let p = e.broadcast_div(&z)?;
let (sv, si) = p.sort_last_dim(false)?;
let ids = si.narrow(D::Minus1, 0, topk)?.contiguous()?;
let mut w = sv.narrow(D::Minus1, 0, topk)?.contiguous()?;
if norm {
w = w.broadcast_div(&w.sum_keepdim(D::Minus1)?)?;
}
Ok((ids, w))
}
/// Fused MoE gate+up projections. Both expert banks consume the SAME routed token `x` [t,1,k], so the
/// shared input is broadcast + quantized ONCE and matvec'd against both banks (vs once per bank,
/// re-materializing + re-quantizing the identical activation). Returns the raw (gate_out, up_out)
/// [t,topk,n]; the caller applies silu(gate)*up. Each output is bit-identical to the unfused
/// `indexed_moe_forward` because the q8_1 activation is deterministic in `x`. ROCm decode/matvec path
/// only (the prefill qmmq path keeps its own per-bank quantize); every other case runs the two
/// unfused forwards. HANZO_MOE_GATEUP_FALLBACK forces the unfused path (the A/B + equivalence lever).
pub fn moe_gate_up(
x: &Tensor,
ids: &Tensor,
gate: &QMatMul,
up: &QMatMul,
) -> Result<(Tensor, Tensor)> {
#[cfg(feature = "rocm")]
if std::env::var("HANZO_MOE_GATEUP_FALLBACK").is_err() {
if let (QMatMul::QTensor(gq), QMatMul::QTensor(uq)) = (gate, up) {
if let (QStorage::Rocm(_, dev), QStorage::Rocm(..)) = (&gq.storage, &uq.storage) {
let dt = gq.storage.dtype();
if dt == uq.storage.dtype() {
if let Some(qt) = crate::RocmQuantType::from_ggml(dt) {
let (_e, n, k) = gq.shape().dims3()?;
let (t, topk) = ids.dims2()?;
let use_qmmq = t > 1
&& qt.qmmq_capable()
&& std::env::var("HANZO_MOE_QMMQ_FALLBACK").is_err();
if x.dim(1)? == 1 && !use_qmmq {
let nrows = t * topk;
let x_exp = x.broadcast_as((t, topk, k))?;
let x_flat = match x_exp.dtype() {
DType::BF16 | DType::F16 => x_exp.reshape((nrows, k))?.contiguous()?,
DType::F32 if qt.dp4a_active() => {
x_exp.reshape((nrows, k))?.contiguous()?
}
_ => {
x_exp.reshape((nrows, k))?.to_dtype(DType::F16)?.contiguous()?
}
};
let out_dtype = x.dtype();
let ids_u32 =
ids.reshape((nrows,))?.to_dtype(DType::U32)?.contiguous()?;
let gwb = gq.rocm_moe_bank(dev)?;
let uwb = uq.rocm_moe_bank(dev)?;
let (xstore, _) = x_flat.storage_and_layout();
let xr = match &*xstore {
Storage::Rocm(r) => r,
_ => crate::bail!("moe_gate_up: x not on rocm after contiguous()"),
};
let (idstore, _) = ids_u32.storage_and_layout();
let idr = match &*idstore {
Storage::Rocm(r) => r,
_ => crate::bail!("moe_gate_up: ids not on rocm"),
};
let (gy, uy) = dev.moe_matvec_pair(
qt,
gwb.as_ref(),
uwb.as_ref(),
xr,
idr,
nrows,
n,
k,
)?;
let g = crate::tensor::from_storage(
Storage::Rocm(gy),
(nrows, n),
crate::op::BackpropOp::none(),
false,
)
.reshape((t, topk, n))?
.to_dtype(out_dtype)?;
let u = crate::tensor::from_storage(
Storage::Rocm(uy),
(nrows, n),
crate::op::BackpropOp::none(),
false,
)
.reshape((t, topk, n))?
.to_dtype(out_dtype)?;
return Ok((g, u));
}
}
}
}
}
}
Ok((gate.indexed_moe_forward(x, ids)?, up.indexed_moe_forward(x, ids)?))
}
thread_local! {
static DEQUANTIZE_ALL: bool = {
match std::env::var("DEQUANTIZE_ALL") {
Ok(s) => {
!s.is_empty() && s != "0"
},
Err(_) => false,
}
}
}
thread_local! {
static DEQUANTIZE_ALL_F16: bool = {
match std::env::var("DEQUANTIZE_ALL_F16") {
Ok(s) => {
!s.is_empty() && s != "0"
},
Err(_) => false,
}
}
}
impl QMatMul {
pub fn from_arc(qtensor: std::sync::Arc<QTensor>) -> Result<Self> {
// Native Vulkan quantized path: keep the GGML quantized blocks in VRAM and run the matching
// on-GPU quant matvec for decode, instead of dequantizing the whole model to f32 (4x the
// decode bandwidth). The kernel reads the GGML block format straight from the uploaded bytes
// -- no CPU dequant, no re-pack -- so this is exact w.r.t. the CPU reference. Q4_0/Q4_K need
// k a multiple of their block (32 / 256); Q8_0 needs a multiple of 32.
#[cfg(feature = "vulkan")]
{
let dt = qtensor.dtype();
let native_vk = matches!(
dt,
GgmlDType::Q4_0
| GgmlDType::Q8_0
| GgmlDType::Q4K
| GgmlDType::Q5K
| GgmlDType::Q6K
| GgmlDType::Q2K
| GgmlDType::Q3K
| GgmlDType::IQ4_XS
| GgmlDType::IQ4_NL
| GgmlDType::TQ2_0
| GgmlDType::IQ2_XXS
| GgmlDType::IQ2_S
| GgmlDType::IQ3_XXS
| GgmlDType::IQ3_S
| GgmlDType::IQ1_S
| GgmlDType::IQ1_M
| GgmlDType::IQ2_XS
);
if native_vk {
if let Device::Vulkan(d) = qtensor.device() {
if let Ok((n, k)) = qtensor.shape().dims2() {
let blk = dt.block_size();
if k % blk == 0 {
let bytes = qtensor.data()?;
// Q6_K (210 B) and Q3_K (110 B) blocks are not u32-aligned; their shaders
// read a padded u32 stride, so repack on upload. Q8_0 repacks to the
// 9-u32/block layout that BOTH its decode (mul_mat_vec_q8) and prefill GEMM
// (mul_mat_q8) read -- ONE layout, so decode + prefill + MoE all agree
// (mirrors how the MoE bank repacks Q8_0). Every other native type's
// shaders byte-address the raw GGML bytes directly.
let wq = match dt {
GgmlDType::Q6K => d.quantize_q6k(&bytes, n, k)?,
GgmlDType::Q3K => d.quantize_q3k(&bytes, n, k)?,
GgmlDType::Q8_0 => d.quantize_q8_blocks(&bytes, n, k)?,
GgmlDType::IQ2_XXS => d.quantize_iq2xxs(&bytes, n, k)?,
GgmlDType::IQ2_XS => d.quantize_iq2xs(&bytes, n, k)?,
GgmlDType::IQ1_M => d.quantize_iq1m(&bytes, n, k)?,
GgmlDType::IQ1_S => d.quantize_iq1s(&bytes, n, k)?,
GgmlDType::IQ3_S => d.quantize_iq3s(&bytes, n, k)?,
GgmlDType::IQ3_XXS => d.quantize_iq3xxs(&bytes, n, k)?,
GgmlDType::IQ2_S => d.quantize_iq2s(&bytes, n, k)?,
_ => d.upload_qweight(&bytes)?,
};
return Ok(Self::VulkanQuant {
qtensor,
wq: std::sync::Arc::new(wq),
dtype: dt,
n,
k,
});
}
}
}
}
}
// Native wgpu quantized path: same idea as Vulkan. Ships the Q4_0/Q8_0/Q4_K WGSL matvec
// kernels; other dtypes fall through to the dequantize path below.
#[cfg(feature = "wgpu")]
{
let dt = qtensor.dtype();
let native_wgpu = matches!(dt, GgmlDType::Q4_0 | GgmlDType::Q8_0 | GgmlDType::Q4K);
if native_wgpu {
if let Device::Wgpu(d) = qtensor.device() {
if let Ok((n, k)) = qtensor.shape().dims2() {
let blk = dt.block_size();
if k % blk == 0 {
let bytes = qtensor.data()?;
let wq = d.upload_qweight(&bytes)?;
return Ok(Self::WgpuQuant {
qtensor,
wq: std::sync::Arc::new(wq),
dtype: dt,
n,
k,
});
}
}
}
}
}
// Native ROCm quantized path: keep the GGML blocks in VRAM and run the ONE unified on-GPU
// quant decode core (qmatvec_core<WTYPE>; Q8_0+Q4_0 also have the int8 WMMA prefill gemm),
// instead of dequantizing the whole model to dense f16 (2x+ the decode bandwidth). Reads the
// block format straight from the uploaded bytes -- exact w.r.t. the CPU reference. The wired
// set is exactly RocmQuantType::from_ggml; k must be a multiple of that type's block size.
#[cfg(feature = "rocm")]
{
let dt = qtensor.dtype();
// Decode AND prefill native iff the unified core has this type wired (one enum row in
// RocmQuantType): decode rides qmatvec_core<WTYPE>, prefill (rows>1) rides the int8 WMMA
// qmmq_core<WTYPE>. Both cover the SAME wired spread; adding a type is one enum row + the
// in-kernel decode, no per-quant kernel. Unwired types dequantize-to-f16 in forward().
if let Some(qt) = crate::RocmQuantType::from_ggml(dt) {
if let Device::Rocm(d) = qtensor.device() {
if let Ok((n, k)) = qtensor.shape().dims2() {
let blk_ok = k % qt.block_elems() == 0;
if blk_ok {
use crate::backend::BackendDevice;
let bytes = qtensor.data()?;
let wq = d.storage_from_slice(bytes.as_ref())?;
return Ok(Self::RocmQuant {
qtensor,
wq: std::sync::Arc::new(wq),
dtype: dt,
n,
k,
});
}
}
}
}
}
// ROCm MoE bank: a 3D [E,n,k] expert bank of a wired quant type stays QUANTIZED (kept as
// QTensor), so `indexed_moe_forward` runs each routed expert through the ONE unified
// qmatvec_core (no per-expert kernel) instead of dequantizing the whole bank to dense f16
// (which for a 30B-A3B model is many GB of resident f16 AND has no indexed_moe path). The 2D
// RocmQuant decode/prefill path above already handles ordinary weights; this is the MoE case.
#[cfg(feature = "rocm")]
{
if qtensor.device().is_rocm()
&& qtensor.shape().dims().len() == 3
&& crate::RocmQuantType::from_ggml(qtensor.dtype()).is_some()
&& !DEQUANTIZE_ALL.with(|b| *b)
{
return Ok(Self::QTensor(qtensor));
}
}
let dequantize = match qtensor.dtype() {
GgmlDType::F32 | GgmlDType::F16 | GgmlDType::BF16 => true,
// The Vulkan/wgpu/ROCm backends have no generic native quantized matmul, so dequantize
// to f32 here (once, at construction) and run the regular f32 GPU matmul.
_ => {
DEQUANTIZE_ALL.with(|b| *b)
|| qtensor.device().is_vulkan()
|| qtensor.device().is_wgpu()
|| qtensor.device().is_rocm()
}
};
let t = if dequantize {
// ROCm: dequantize to f16 so the matmul hits RDNA3.5 matrix cores (WMMA). Dense f32
// (sgemm) has no matrix-core path on RDNA and runs ~an order of magnitude slower, and
// f16 also halves the resident weight memory.
if qtensor.device().is_rocm() {
Self::TensorF16(qtensor.dequantize_f16(&qtensor.device())?)
} else {
Self::Tensor(qtensor.dequantize(&qtensor.device())?)
}
} else if DEQUANTIZE_ALL_F16.with(|b| *b) {
let tensor = qtensor.dequantize_f16(&qtensor.device())?;
Self::TensorF16(tensor)
} else {
Self::QTensor(qtensor)
};
Ok(t)
}
pub fn from_qtensor(qtensor: QTensor) -> Result<Self> {
Self::from_arc(std::sync::Arc::new(qtensor))
}
pub fn dequantize_f16(&self) -> Result<Tensor> {
match self {
Self::QTensor(t) => t.dequantize_f16(&t.device()),
Self::Tensor(t) => t.to_dtype(DType::F16),
Self::TensorF16(t) => Ok(t.clone()),
#[cfg(feature = "rocm")]
Self::RocmQuant { qtensor, .. } => qtensor.dequantize_f16(&qtensor.device()),
#[cfg(feature = "vulkan")]
Self::VulkanQuant { qtensor, .. } => qtensor.dequantize_f16(&qtensor.device()),
#[cfg(feature = "wgpu")]
Self::WgpuQuant { qtensor, .. } => qtensor.dequantize_f16(&qtensor.device()),
}
}
pub fn forward_via_f16(&self, xs: &Tensor) -> Result<Tensor> {
let w = self.dequantize_f16()?;
let in_dtype = xs.dtype();
let w = match *xs.dims() {
[b1, b2, _, _] => w.broadcast_left((b1, b2))?.t()?,
[bsize, _, _] => w.broadcast_left(bsize)?.t()?,
_ => w.t()?,
};
xs.to_dtype(DType::F16)?.matmul(&w)?.to_dtype(in_dtype)
}
pub fn indexed_moe_forward(&self, x: &Tensor, ids: &Tensor) -> Result<Tensor> {
match self {
Self::QTensor(t) => t.indexed_moe_forward(x, ids),
// Resident-bank MoE: `wq` already holds the [E,n,k] GGML blocks in VRAM (uploaded at
// load), so route straight to the batched on-GPU quant matvec. Delegating to `qtensor`
// (CPU-side) instead drops to the generic fallback that re-uploads every routed expert
// every token -- the 20-50x decode cliff. `qtensor` is read only for its shape.
#[cfg(feature = "rocm")]
Self::RocmQuant {
qtensor, wq, dtype, ..
} if crate::RocmQuantType::from_ggml(*dtype).is_some() => {
let qt = crate::RocmQuantType::from_ggml(*dtype).unwrap();
let wbank = wq.as_ref();
// e_cnt unused: ids stay on-device, router guarantees the bound (no host check).
let (_e_cnt, n, k) = qtensor.shape().dims3()?;
let (t, topk) = ids.dims2()?;
let s = x.dim(1)?; // 1 (gate/up: shared input) or topk (down: per-slot)
let x_exp = if s == topk {
x.clone()
} else {
x.broadcast_as((t, topk, k))?
};
let nrows = t * topk;
// PREFILL (t>1, never graph-captured) routes to the FUSED expert-grouped WMMA GEMM
// (`moe_qmmq_quant`), which needs f16 activations; DECODE (t==1) stays on the
// capture-clean dp4a/scalar matvec, which takes bf16/f16 natively. HANZO_MOE_QMMQ_FALLBACK
// forces the matvec on prefill too (the before/after A/B + oracle-equivalence lever).
// Decode-only types (no qmmq kernel) ride the per-slot matvec core for prefill too
// (correct at any token count). ONE predicate gates every prefill site.
let use_qmmq =
t > 1 && qt.qmmq_capable() && std::env::var("HANZO_MOE_QMMQ_FALLBACK").is_err();
let x_flat = match x_exp.dtype() {
// qmmq quantizes f16/f32 activations natively, so keep the model's dtype and skip
// the f32->f16 cast (a 16.7M-elem read+write per gate/up). Other dtypes (bf16 with
// a symmetric expert type) still cast to f16.
DType::F16 | DType::F32 if use_qmmq => x_exp.reshape((nrows, k))?.contiguous()?,
_ if use_qmmq => x_exp.reshape((nrows, k))?.to_dtype(DType::F16)?.contiguous()?,
DType::BF16 | DType::F16 => x_exp.reshape((nrows, k))?.contiguous()?,
// DECODE f32-native dp4a: keep F32 routed activation F32 end-to-end (matvec stores
// F32), eliding the cast pair around each expert matvec. See QStorage twin above.
DType::F32 if qt.dp4a_active() => x_exp.reshape((nrows, k))?.contiguous()?,
_ => x_exp.reshape((nrows, k))?.to_dtype(DType::F16)?.contiguous()?,
};
let out_dtype = x.dtype();
// Keep router ids ON the GPU for EVERY wired quant type: the batched kernels index
// experts on-device, so there is no per-call `to_vec1` host round-trip. That DtoH
// sync (3 per layer x 48 layers per token) was both the dominant decode stall on WSL
// AND the HIP-graph capture breaker. Router top-k guarantees 0 <= id < e_cnt.
let ids_u32 = ids
.reshape((nrows,))?
.to_dtype(crate::DType::U32)?
.contiguous()?;
let (xstore, _) = x_flat.storage_and_layout();
let xr = match &*xstore {
crate::Storage::Rocm(r) => r,
_ => crate::bail!("rocm MoE: x not on rocm after contiguous()"),
};
let (idstore, _) = ids_u32.storage_and_layout();
let idr = match &*idstore {
crate::Storage::Rocm(r) => r,
_ => crate::bail!("rocm MoE: ids not on rocm"),
};
let y = if use_qmmq {
wbank.device.moe_qmmq_quant(qt, wbank, xr, idr, nrows, n, k)?
} else {
wbank.device.moe_matvec_quant(qt, wbank, xr, idr, nrows, n, k)?
};
let out = crate::tensor::from_storage(
crate::Storage::Rocm(y),
(nrows, n),
crate::op::BackpropOp::none(),
false,
);
out.reshape((t, topk, n))?.to_dtype(out_dtype)
}
// Unwired ROCm quant dtypes (no on-GPU quant matvec): CPU per-expert fallback.
#[cfg(feature = "rocm")]
Self::RocmQuant { qtensor, .. } => qtensor.indexed_moe_forward(x, ids),
#[cfg(feature = "vulkan")]
Self::VulkanQuant { qtensor, .. } => qtensor.indexed_moe_forward(x, ids),
#[cfg(feature = "wgpu")]
Self::WgpuQuant { qtensor, .. } => qtensor.indexed_moe_forward(x, ids),
_ => {
panic!("Not implemented!")
}
}
}
}
impl crate::CustomOp1 for QTensor {
fn name(&self) -> &'static str {
"qmatmul"
}
fn cpu_fwd(
&self,
storage: &crate::CpuStorage,
layout: &crate::Layout,
) -> Result<(crate::CpuStorage, Shape)> {
if !layout.is_contiguous() {
crate::bail!("input tensor is not contiguous {layout:?}")
}
let src_shape = layout.shape();
// self is transposed so n is first then k.
let (n, k) = self.shape.dims2()?;
if src_shape.rank() < 2 {
crate::bail!("input tensor has only one dimension {layout:?}")
}
let mut dst_shape = src_shape.dims().to_vec();
let last_k = dst_shape.pop().unwrap();
if last_k != k {
crate::bail!("input tensor {layout:?} incompatible with {:?}", self.shape)
}
dst_shape.push(n);
let dst_shape = Shape::from(dst_shape);
#[allow(clippy::infallible_destructuring_match)]
let self_storage = match &self.storage {
QStorage::Cpu(storage) => storage,
#[cfg(feature = "rocm")]
QStorage::Rocm(..) => crate::bail!("Invalid storage"),
#[cfg(feature = "vulkan")]
QStorage::Vulkan(..) => crate::bail!("Invalid storage"),
#[cfg(feature = "wgpu")]
QStorage::Wgpu(..) => crate::bail!("Invalid storage"),
QStorage::Metal(_) | QStorage::Cuda(_) => crate::bail!("Invalid storage"),
};
match storage.dtype() {
DType::F32 => {
let slice = storage.as_slice::<f32>()?;
let slice =
&slice[layout.start_offset()..layout.start_offset() + src_shape.elem_count()];
let mut dst_storage = vec![0f32; dst_shape.elem_count()];
self_storage.matmul_t(
(dst_shape.elem_count() / n, k, n),
slice,
&mut dst_storage,
)?;
Ok((crate::CpuStorage::F32(dst_storage), dst_shape))
}
DType::F16 => {
let slice = storage.as_slice::<f16>()?;
let slice =
&slice[layout.start_offset()..layout.start_offset() + src_shape.elem_count()];
let mut dst_storage = vec![f16::ZERO; dst_shape.elem_count()];
self_storage.matmul_t_f16(
(dst_shape.elem_count() / n, k, n),
slice,
&mut dst_storage,
)?;
Ok((crate::CpuStorage::F16(dst_storage), dst_shape))
}
_ => crate::bail!("Expected f32/f16"),
}
}
fn metal_fwd(
&self,
storage: &crate::MetalStorage,
layout: &crate::Layout,
) -> Result<(crate::MetalStorage, Shape)> {
let self_storage = match &self.storage {
QStorage::Metal(metal) => metal,
_ => unreachable!("Cannot call metal matmul on non metal QTensor"),
};
self_storage.fwd(&self.shape, storage, layout)
}
fn cuda_fwd(
&self,
storage: &crate::CudaStorage,
layout: &crate::Layout,
) -> Result<(crate::CudaStorage, Shape)> {
let self_storage = match &self.storage {
QStorage::Cuda(cuda) => cuda,
_ => unreachable!("Cannot call cuda matmul on non cuda QTensor"),
};
self_storage.fwd(&self.shape, storage, layout)
}
}
/// Dense (non-quantized) matmul `xs @ w^T` for the `Tensor`/`TensorF16` `QMatMul` variants, where
/// the stored weight `w` is `[n, k]` and `xs` is `[.., k]`. On ROCm at decode (a single-row matvec)
/// this computes the result as `sum_k(xs[k] * w[n, k])` via pooled broadcast-mul + reduce instead of
/// rocBLAS `gemm_ex`. rocBLAS's GEMM dispatch records a vendor-specific PM4 indirect-buffer packet
/// that WSL's HSA thunk rejects on hipGraph replay (`VendorSpecificAqlToPm4` assert), so a captured
/// decode forward containing one (e.g. the MoE F32 router gate) corrupts/aborts on replay. The
/// reduce path uses only ops already exercised under capture (RMSNorm etc.), so it replays cleanly,
/// and at M=1 a GEMV-as-reduce is as cheap as the GEMM (it materializes only the `[n, k]` weight).
/// Prefill (rows > 1, never graph-captured) keeps the rocBLAS GEMM. Non-ROCm devices are unchanged.
fn dense_matmul(xs: &Tensor, w: &Tensor) -> Result<Tensor> {
let k = *w.dims().last().unwrap();
let rows = xs.elem_count() / k;
if rows == 1 && xs.device().is_rocm() {
let n = w.dim(0)?;
#[cfg(feature = "rocm")]
{
// Dense decode GEMV: read the [n,k] weight ONCE (warp/row dot) instead of materializing
// and re-reading the broadcast_mul product. The activation is matched to the weight dtype
// (a [k] cast, negligible); the GEMV stays capture-clean (no rocBLAS).
let d = match xs.device() {
Device::Rocm(d) => d.clone(),
_ => unreachable!(),
};
let xs1 = xs.reshape((k,))?.to_dtype(w.dtype())?.contiguous()?;
let w = w.contiguous()?;
let (wstore, _) = w.storage_and_layout();
let wr = match &*wstore {
crate::Storage::Rocm(r) => r,
_ => crate::bail!("dense_matmul: weight not on rocm"),
};
let (xstore, _) = xs1.storage_and_layout();
let xr = match &*xstore {
crate::Storage::Rocm(r) => r,
_ => crate::bail!("dense_matmul: x not on rocm"),
};
let y = d.dense_gemv(wr, xr, n, k)?;
let mut dims = xs.dims().to_vec();
*dims.last_mut().unwrap() = n;
return crate::tensor::from_storage(
crate::Storage::Rocm(y),
dims,
crate::op::BackpropOp::none(),
false,
)
.to_dtype(xs.dtype());
}
#[cfg(not(feature = "rocm"))]
{
let out = xs.reshape((1, k))?.broadcast_mul(w)?.sum(D::Minus1)?;
let mut dims = xs.dims().to_vec();
*dims.last_mut().unwrap() = n;
return out.reshape(dims);
}
}
let w = match *xs.dims() {
[b1, b2, _, _] => w.broadcast_left((b1, b2))?.t()?,
[bsize, _, _] => w.broadcast_left(bsize)?.t()?,
_ => w.t()?,
};
xs.matmul(&w)
}
// Prefill row-count gate for the native Vulkan quantized GEMM. The column-per-invocation `mul_mat_q*`
// kernel re-reads AND re-decodes the weight ceil(M / MATMUL_Q_MAX_M(8)) times; the dequant path
// decodes the weight to f32 once then runs a dense matmul. So the GEMM wins at small/moderate M and
// loses once the re-decode dominates. The crossover is dtype-dependent: cheap-decode quants
// (Q4_0/Q8_0/Q4_K -- nibble or single-byte unpack) stay ahead through M=128, while the expensive
// high-bit super-blocks (Q5_K/Q6_K -- 5/6-bit reconstruction with a qh high-bit gather, compute-bound
// at large N) cross earlier and are only safe through M=64. Measured on RADV gfx1151 (Radeon 8060S),
// K=4096, N in {4096, 11008}: the chosen rows are the strict-non-regression floor for each family
// (worst case ~2.1x at the threshold, up to 25x at M=16). Larger dense prefill keeps the dequant path
// until a shared-memory-tiled int8 GEMM (reads + decodes the weight once, removing this gate) lands.
#[cfg(feature = "vulkan")]
fn vulkan_prefill_gemm_max_rows(dtype: GgmlDType) -> usize {
match dtype {
GgmlDType::Q5K | GgmlDType::Q6K => 64,
_ => 128,
}
}
impl crate::Module for QMatMul {
fn forward(&self, xs: &Tensor) -> Result<Tensor> {
match self {
#[cfg(feature = "rocm")]
Self::RocmQuant {
qtensor,
wq,
dtype,
n,
k,
} => {
// Device-residency guard: multi-token attention prefill can leave the activation
// off-device (an upstream op leaked to host); recover instead of bailing so prefill
// stays correct. The leak is the bug to fix for speed; this keeps us correct meanwhile.
let xs_recovered = if xs.device().is_rocm() {
None
} else {
if std::env::var("HANZO_DBG_PATH").is_ok() {
eprintln!(
"[ROCm-RECOVER] activation off-device {:?} dims {:?}",
xs.device().location(),
xs.dims()
);
}
Some(xs.to_device(&qtensor.device())?)
};
let xs = xs_recovered.as_ref().unwrap_or(xs);
let rows: usize = xs.elem_count() / *k;
#[cfg(feature = "rocm")]
{
use std::sync::atomic::{AtomicUsize, Ordering};
static DBG_DECODE: AtomicUsize = AtomicUsize::new(0);
static DBG_PREFILL: AtomicUsize = AtomicUsize::new(0);
static DBG_FALLBACK: AtomicUsize = AtomicUsize::new(0);
if std::env::var("HANZO_DBG_PATH").is_ok() {
// Buckets MATCH the real dispatch below: decode = rows==1 wired (the dp4a-vs-
// scalar A/B is internal to matvec_quant, still native); prefill = rows>1 wired
// native qmmq_core<WTYPE>; fallback = unwired OR HANZO_QMMQ_FALLBACK dequantize.
let qt = crate::RocmQuantType::from_ggml(*dtype);
let decode_wired = qt.is_some();
let prefill_wired = qt.is_some_and(|qt| qt.qmmq_capable());
let prefill_fb = std::env::var("HANZO_QMMQ_FALLBACK").is_ok();
if rows == 1 && decode_wired {
DBG_DECODE.fetch_add(1, Ordering::Relaxed);
} else if rows > 1 && prefill_wired && !prefill_fb {
DBG_PREFILL.fetch_add(1, Ordering::Relaxed);
} else {
DBG_FALLBACK.fetch_add(1, Ordering::Relaxed);
}
// Print on EVERY rows>1 (prefill is rare vs decode) + every 200 total, so the
// native-prefill path is always visible the moment it is taken.
let tot = DBG_DECODE.load(Ordering::Relaxed)
+ DBG_PREFILL.load(Ordering::Relaxed)
+ DBG_FALLBACK.load(Ordering::Relaxed);
if rows > 1 || tot % 200 == 0 {
eprintln!(
"[DBG_PATH] decode={} prefill(native)={} fallback={} (dt={:?} rows={} n={} k={})",
DBG_DECODE.load(Ordering::Relaxed),
DBG_PREFILL.load(Ordering::Relaxed),
DBG_FALLBACK.load(Ordering::Relaxed),
dtype, rows, *n, *k
);
}
}
}
// Table-driven unified decode: a type is decode-native iff the single
// `qmatvec_core<WTYPE>` has a `decode_block` wired for it (RocmQuantType::from_ggml).
// Q8_0/Q4_0/Q4_K/Q6_K/IQ4_XS/TQ2_0 today; adding a type is one enum row, no kernel.
// The dp4a-vs-scalar A/B for dp4a-capable types (HANZO_Q4K_FALLBACK / HANZO_Q6K_FALLBACK)
// lives entirely inside `matvec_quant` (dp4a_active) -- ONE fallback, one place; it
// switches the decode core, the type stays on the native path either way.
#[cfg(feature = "rocm")]
let unified_qt = crate::RocmQuantType::from_ggml(*dtype);
#[cfg(not(feature = "rocm"))]
let unified_qt: Option<()> = None;
// Native int8-WMMA prefill exists only for `qmmq_capable` types; the decode-only types
// (Q2_K/Q3_K + every IQ*/TQ* codebook/fractional type) dequantize-to-f16 for rows>1 via
// the `else` branch below -- correct, just not WMMA-accelerated. ONE predicate, read here
// and at the two MoE `use_qmmq` sites.
#[cfg(feature = "rocm")]
let qmmq_ok = unified_qt.map(|qt| qt.qmmq_capable()).unwrap_or(false);
#[cfg(not(feature = "rocm"))]
let qmmq_ok = false;
if rows == 1 && unified_qt.is_some() {
// Decode: weights stay quantized in VRAM; the ONE native on-GPU quant matvec core
// dequantizes per-block on-the-fly (no dense f16 copy). The matvec consumes
// bf16/f16 activations directly and returns the same dtype, so the model's working
// dtype (bf16) is kept end-to-end -- no bf16->f32->f16->bf16 cast detour. Only fall
// back to an f16 cast for exotic input dtypes. Every wired type (symmetric 8-bit
// through asymmetric super-block through sub-4-bit ternary) rides the same core.
// dp4a-capable types accept the F32 residual/norm stream DIRECTLY (q8_1 quantize
// from f32 + f32-store matvec), so an F32 activation stays F32 end-to-end with no
// f16 bounce -- this removes the cast_f32_f16-before / cast_f16_f32-after pair that
// wrapped every decode matvec. Non-dp4a (scalar) types keep the f16 cast.
#[cfg(feature = "rocm")]
let keep_f32 = unified_qt.map(|qt| qt.dp4a_active()).unwrap_or(false);
#[cfg(not(feature = "rocm"))]
let keep_f32 = false;
let xs = match xs.dtype() {
DType::BF16 | DType::F16 => xs.contiguous()?,
DType::F32 if keep_f32 => xs.contiguous()?,
_ => xs.to_dtype(DType::F16)?.contiguous()?,
};
let d = match xs.device() {
Device::Rocm(d) => d,
_ => crate::bail!("RocmQuant input not on rocm"),
};
let y = {
let (store, _) = xs.storage_and_layout();
let xr = match &*store {
crate::Storage::Rocm(r) => r,
_ => crate::bail!("RocmQuant expected rocm storage"),
};
#[cfg(feature = "rocm")]
{
d.matvec_quant(unified_qt.unwrap(), wq, xr, *n, *k)?
}
#[cfg(not(feature = "rocm"))]
{
crate::bail!("rocm feature disabled")
}
};
let mut dims = xs.dims().to_vec();
let last = dims.len() - 1;
dims[last] = *n;
Ok(crate::tensor::from_storage(
crate::Storage::Rocm(y),
dims,
crate::op::BackpropOp::none(),
false,
))
} else if let Some(qt) =
unified_qt.filter(|_| qmmq_ok && std::env::var("HANZO_QMMQ_FALLBACK").is_err())
{
// Prefill (rows>1): native int8 WMMA gemm through the ONE unified core
// (`qmmq_core<WTYPE>` in quant.hip). Weights stay quantized in VRAM (no resident
// dense f16, which would slow the memory-bound decode) and the MAC runs on the
// RDNA3 int8 matrix cores instead of rocBLAS. The SAME core covers the whole wired
// spread: Q8_0/Q4_0 (symmetric, proven), Q4_K (asymmetric -- min bias via the
// q8_1 block-sum), and the symmetric super-block / IQ / ternary types (Q6_K,
// IQ4_XS, TQ2_0). Selecting the type is one `RocmQuantType` row + the in-kernel
// decode; there is NO per-quant prefill kernel. HANZO_QMMQ_FALLBACK=1 forces the
// dequant-f16 matmul below (the prefill before/after A/B benchmark lever).
let xs = xs.to_dtype(DType::F16)?.contiguous()?;
let d = match xs.device() {
Device::Rocm(d) => d,
_ => crate::bail!("RocmQuant input not on rocm"),
};
let m = xs.elem_count() / *k;
let y = {
let (store, _) = xs.storage_and_layout();
let xr = match &*store {
crate::Storage::Rocm(r) => r,
_ => crate::bail!("RocmQuant expected rocm storage"),
};
#[cfg(feature = "rocm")]
{
d.qmmq_quant(qt, xr, wq, m, *n, *k)?
}
#[cfg(not(feature = "rocm"))]
{
let _ = qt;
crate::bail!("rocm feature disabled")
}
};
let mut dims = xs.dims().to_vec();
let last = dims.len() - 1;
dims[last] = *n;
Ok(crate::tensor::from_storage(
crate::Storage::Rocm(y),
dims,
crate::op::BackpropOp::none(),
false,
))
} else {
// Unwired-type / forced-fallback prefill: dequantize to a temporary f16 weight
// (freed after; a persistent f16 copy would slow the memory-bound decode). Only
// reached for quants with no `qmmq_core<WTYPE>` wired (e.g. Q5_K/MXFP4) or when
// HANZO_QMMQ_FALLBACK forces it for the prefill A/B measurement.
let w = qtensor.dequantize_f16(&xs.device())?;
let w = match *xs.dims() {
[b1, b2, _, _] => w.broadcast_left((b1, b2))?.t()?,
[bsize, _, _] => w.broadcast_left(bsize)?.t()?,
_ => w.t()?,
};
xs.to_dtype(DType::F16)?.matmul(&w)
}
}
#[cfg(feature = "vulkan")]
Self::VulkanQuant {
qtensor,
wq,
dtype,
n,
k,
} => {
let rows: usize = xs.elem_count() / *k;
if rows == 1 {
// Decode: weights stay quantized in VRAM; the matching native-GGML quant matvec
// runs straight out of the block format (no dequant, no copy).
let xs = xs.contiguous()?;
let d = match xs.device() {
Device::Vulkan(d) => d,
_ => crate::bail!("VulkanQuant input not on vulkan"),
};
let y = {
let (store, _) = xs.storage_and_layout();
let xv = match &*store {
crate::Storage::Vulkan(v) => v,
_ => crate::bail!("VulkanQuant expected vulkan storage"),
};
match dtype {
GgmlDType::Q4_0 => d.matvec_q4_0_gpu(wq, xv, *n, *k)?,
// Q8_0 rides the 9-u32 repacked layout (mul_mat_vec_q8), the SAME blocks
// the prefill GEMM (mul_mat_q8) reads -- one layout for decode + prefill.
GgmlDType::Q8_0 => d.matvec_q8_gpu(wq, xv, *n, *k)?,
GgmlDType::Q4K => d.matvec_q4k_gpu(wq, xv, *n, *k)?,
GgmlDType::Q5K => d.matvec_q5k_gpu(wq, xv, *n, *k)?,
GgmlDType::Q6K => d.matvec_q6k_gpu(wq, xv, *n, *k)?,
GgmlDType::Q2K => d.matvec_q2k_gpu(wq, xv, *n, *k)?,
GgmlDType::Q3K => d.matvec_q3k_gpu(wq, xv, *n, *k)?,
GgmlDType::IQ4_XS => d.matvec_iq4xs_gpu(wq, xv, *n, *k)?,
GgmlDType::IQ4_NL => d.matvec_iq4nl_gpu(wq, xv, *n, *k)?,
GgmlDType::IQ2_XXS => d.matvec_iq2xxs_gpu(wq, xv, *n, *k)?,
GgmlDType::IQ2_XS => d.matvec_iq2xs_gpu(wq, xv, *n, *k)?,
GgmlDType::IQ1_M => d.matvec_iq1m_gpu(wq, xv, *n, *k)?,
GgmlDType::IQ1_S => d.matvec_iq1s_gpu(wq, xv, *n, *k)?,
GgmlDType::IQ3_S => d.matvec_iq3s_gpu(wq, xv, *n, *k)?,
GgmlDType::IQ3_XXS => d.matvec_iq3xxs_gpu(wq, xv, *n, *k)?,
GgmlDType::IQ2_S => d.matvec_iq2s_gpu(wq, xv, *n, *k)?,
GgmlDType::TQ2_0 => d.matvec_tq2_0_gpu(wq, xv, *n, *k)?,
other => crate::bail!("VulkanQuant: no native matvec for {other:?}"),
}
};
let mut dims = xs.dims().to_vec();
let last = dims.len() - 1;
dims[last] = *n;
Ok(crate::tensor::from_storage(
crate::Storage::Vulkan(y),
dims,
crate::op::BackpropOp::none(),
false,
))
} else if rows <= vulkan_prefill_gemm_max_rows(*dtype) {
// Prefill (small/moderate M): native quantized GEMM. Weights stay quantized in
// VRAM and each weight block is decoded ONCE per output column then reused across
// a tile of up to MATMUL_Q_MAX_M(=8) rows -- so the weight is re-read+re-decoded
// ceil(M/8) times, vs the dequant path's one-time f32 materialization. The GEMM
// therefore wins decisively while M is small (short / chunked prefill, batched
// decode) and would lose at large M, which the dtype-aware `rows` gate routes to
// the dequant path below. Same block layout + decode as the decode matvec above;
// one matmul_q*_gpu per native dtype. Leading batch dims flatten into M.
let m = rows;
let xs = xs.contiguous()?;
let d = match xs.device() {
Device::Vulkan(d) => d,
_ => crate::bail!("VulkanQuant input not on vulkan"),
};
let y = {
let (store, _) = xs.storage_and_layout();
let xv = match &*store {
crate::Storage::Vulkan(v) => v,
_ => crate::bail!("VulkanQuant expected vulkan storage"),
};
match dtype {
GgmlDType::Q4_0 => d.matmul_q4_0_gpu(wq, xv, m, *n, *k)?,
GgmlDType::Q8_0 => d.matmul_q8_gpu(wq, xv, m, *n, *k)?,
GgmlDType::Q4K => d.matmul_q4k_gpu(wq, xv, m, *n, *k)?,
GgmlDType::Q5K => d.matmul_q5k_gpu(wq, xv, m, *n, *k)?,
GgmlDType::Q6K => d.matmul_q6k_gpu(wq, xv, m, *n, *k)?,
other => crate::bail!("VulkanQuant: no native matmul for {other:?}"),
}
};
let mut dims = xs.dims().to_vec();
let last = dims.len() - 1;
dims[last] = *n;
Ok(crate::tensor::from_storage(
crate::Storage::Vulkan(y),
dims,
crate::op::BackpropOp::none(),
false,
))
} else {
// Large dense prefill (M > the crossover): the column-per-invocation GEMM would
// re-read the weight ceil(M/8) times and lose to materializing the f32 weight once
// and running a dense matmul. Keep the dequant path here -- a strict non-regression
// until a shared-memory-tiled int8 GEMM (reads the weight once) removes the gate.
let w = qtensor.dequantize(&xs.device())?;
let w = match *xs.dims() {
[b1, b2, _, _] => w.broadcast_left((b1, b2))?.t()?,
[bsize, _, _] => w.broadcast_left(bsize)?.t()?,
_ => w.t()?,
};
xs.matmul(&w)
}
}
#[cfg(feature = "wgpu")]
Self::WgpuQuant {
qtensor,
wq,
dtype,
n,
k,
} => {
let rows: usize = xs.elem_count() / *k;
if rows == 1 {
// Decode: weights stay quantized in VRAM; the matching native-GGML quant matvec
// WGSL kernel runs straight out of the block format (no dequant, no copy).
let xs = xs.contiguous()?;
let d = match xs.device() {
Device::Wgpu(d) => d,
_ => crate::bail!("WgpuQuant input not on wgpu"),
};
let y = {
let (store, _) = xs.storage_and_layout();
let xv = match &*store {
crate::Storage::Wgpu(v) => v,
_ => crate::bail!("WgpuQuant expected wgpu storage"),
};
match dtype {
GgmlDType::Q4_0 => d.matvec_q4_0_gpu(wq, xv, *n, *k)?,
GgmlDType::Q8_0 => d.matvec_q8_0_gpu(wq, xv, *n, *k)?,
GgmlDType::Q4K => d.matvec_q4k_gpu(wq, xv, *n, *k)?,
other => crate::bail!("WgpuQuant: no native matvec for {other:?}"),
}
};
let mut dims = xs.dims().to_vec();
let last = dims.len() - 1;
dims[last] = *n;
Ok(crate::tensor::from_storage(
crate::Storage::Wgpu(y),
dims,
crate::op::BackpropOp::none(),
false,
))
} else {
// Prefill: dequantize to a temporary f32 weight (reuses the NT matmul path).
let w = qtensor.dequantize(&xs.device())?;
let w = match *xs.dims() {
[b1, b2, _, _] => w.broadcast_left((b1, b2))?.t()?,
[bsize, _, _] => w.broadcast_left(bsize)?.t()?,
_ => w.t()?,
};
xs.matmul(&w)
}
}
Self::QTensor(t) => xs.apply_op1_no_bwd(t.as_ref()),
Self::Tensor(w) => dense_matmul(xs, w),
Self::TensorF16(w) => {
let in_dtype = xs.dtype();
dense_matmul(&xs.to_dtype(DType::F16)?, w)?.to_dtype(in_dtype)
}
}
}
}