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
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
//! Generic decoder-only transformer forward pass, assembled from a
//! ModelConfig. Each layer is: RMSNorm -> GQA attention (+RoPE) ->
//! residual -> RMSNorm -> MoE FFN (router + routed experts + shared
//! experts) -> residual. This is the standard decoder block shape
//! shared by the LLaMA/DeepSeek/GLM/Kimi family of open-weight models.
//!
//! Weight loading from a real GGUF checkpoint lives in `loader`
//! (`Decoder::from_gguf`); `Decoder::new_random` builds
//! correctly-shaped, randomly initialized weights so the full pipeline
//! -- embedding lookup, N decoder layers, output head -- can be
//! exercised end to end with real assertions about shapes, finiteness,
//! and determinism, without requiring a multi-hundred-gigabyte
//! checkpoint to be present.
use std::sync::atomic::{AtomicU64, Ordering};
use ferrox_core::attention::{
apply_rope, apply_rope_interleaved, apply_rope_interleaved_with_freq_factors,
apply_rope_with_freq_factors, causal_gqa_attention_paged,
causal_gqa_attention_prefill_shared_kv_windowed, causal_gqa_attention_softcap,
causal_gqa_attention_windowed_softcap,
};
use ferrox_core::cache::{KvCache, PagedKvCache, PagedKvStore, PagedStoreExhausted};
use ferrox_core::matmul::{geglu, rms_norm, rms_norm_per_head, softcap_inplace};
use rayon::prelude::*;
/// Whether the CUDA `gqa_decode` kernel should serve the per-token GQA
/// reduction (`FERROX_CUDA_GQA=1`). Off by default and only compiled with
/// `--features cuda`; the host path is byte-identical when unset.
#[cfg(feature = "cuda")]
fn cuda_gqa_enabled() -> bool {
use std::sync::OnceLock;
static ENABLED: OnceLock<bool> = OnceLock::new();
*ENABLED.get_or_init(|| {
matches!(
std::env::var("FERROX_CUDA_GQA").ok().as_deref(),
Some("1") | Some("true") | Some("on")
)
})
}
use ferrox_core::tensor::Tensor;
use ferrox_core::weight_matrix::WeightMatrix;
use ferrox_moe::{
combine_expert_outputs, route_top_k, run_expert, run_expert_placed, ExpertPlacement,
ExpertWeights, PlacementPlan,
};
use crate::config::ModelConfig;
pub struct AttnWeights {
pub q_proj: WeightMatrix, // [n_heads*head_dim, hidden_dim]
pub k_proj: WeightMatrix, // [n_kv_heads*head_dim, hidden_dim]
pub v_proj: WeightMatrix, // [n_kv_heads*head_dim, hidden_dim]
pub o_proj: WeightMatrix, // [hidden_dim, n_heads*head_dim]
pub norm_weight: Vec<f32>,
/// OLMoE-style QK-RMSNorm (`attn_q_norm`/`attn_k_norm` GGUF tensors),
/// applied to the *whole* q_proj/k_proj output (width `n_heads*head_dim`
/// / `n_kv_heads*head_dim`) before RoPE -- confirmed against
/// `OlmoeAttention.forward` in `transformers/models/olmoe/modeling_olmoe.py`
/// (`q_norm(q_proj(x))`, `k_norm(k_proj(x))`, both plain whole-vector
/// RMSNorm, not per-head). `None` for every model that doesn't ship
/// these tensors -- absent, not zero/identity-weighted, so existing
/// presets/fixtures are byte-for-byte unaffected.
///
/// Qwen3 / Gemma3 ship the same tensor names with length `head_dim`
/// (per-head). Which style is used is selected by
/// [`ModelConfig::qk_norm_style`] (refined at load from weight length).
pub q_norm: Option<Vec<f32>>,
pub k_norm: Option<Vec<f32>>,
/// Qwen2/Qwen2-MoE-family QKV attention bias (`attn_{q,k,v}.bias`
/// GGUF tensors, real `config.qkv_bias`), added elementwise to the
/// corresponding projection's output before QK-norm/RoPE -- confirmed
/// against the real `transformers` source
/// (`Qwen2MoeAttention.__init__`: `q_proj = nn.Linear(..., bias=
/// config.qkv_bias)`, same for `k_proj`/`v_proj`; `o_proj` has no
/// bias). Found as a real, previously-unhandled architecture gap:
/// ferrox's generic GGUF loader silently ignored these real tensors
/// entirely, producing fluent-but-wrong output on a real downloaded
/// Qwen1.5-MoE checkpoint (same failure class as OLMoE's missing
/// QK-norm). `None` for every model that doesn't ship these tensors.
pub q_bias: Option<Vec<f32>>,
pub k_bias: Option<Vec<f32>>,
pub v_bias: Option<Vec<f32>>,
/// Gemma 2+/3 post-attention RMSNorm (`blk.N.post_attention_norm.weight`
/// / llama.cpp `attn_post_norm`). Applied to attention output before
/// the residual add. `None` for Llama/Qwen/OLMoE.
pub post_attn_norm: Option<Vec<f32>>,
/// Gemma 2+/3 post-FFN RMSNorm (`blk.N.post_ffw_norm.weight`).
pub post_ffn_norm: Option<Vec<f32>>,
}
/// How a layer's routed experts are held. `Resident` is the original
/// always-in-memory form (owned f32 or zero-copy mmap views).
/// `Stored` holds only byte-range layouts; each use acquires the
/// expert's bytes from a bounded, lease-protected
/// `ferrox_core::expert_store::ExpertStore` shared by every layer
/// (one global byte budget), builds temporary `WeightMatrix` views
/// over the leased buffer (`WeightBytes::Shared`, which pins the
/// cache entry for the views' lifetime), and drops them after the
/// expert runs. Dequantized math over identical bytes is identical,
/// so the two backings are bit-equivalent by construction -- pinned
/// by an integration test against the MoE fixture.
pub enum ExpertBacking {
Resident(Vec<ExpertWeights>),
Stored {
store:
std::sync::Arc<ferrox_core::expert_store::ExpertStore<crate::loader::GgufExpertSource>>,
layouts: Vec<crate::loader::StoredExpertLayout>,
layer: u32,
},
}
impl ExpertBacking {
pub fn n_experts(&self) -> usize {
match self {
ExpertBacking::Resident(v) => v.len(),
ExpertBacking::Stored { layouts, .. } => layouts.len(),
}
}
}
pub struct MoeWeights {
pub router: WeightMatrix, // [n_experts, hidden_dim]
pub experts: ExpertBacking,
pub shared_experts: Vec<ExpertWeights>,
/// Qwen2-MoE-specific: when present, the shared experts' combined
/// output is scaled by `sigmoid(shared_expert_gate . x)` before
/// being added to the routed output, instead of added unconditionally
/// -- confirmed against the real `transformers` source
/// (`Qwen2MoeSparseMoeBlock.forward`: `shared_expert_output =
/// F.sigmoid(self.shared_expert_gate(hidden_states)) *
/// shared_expert_output`) and llama.cpp's real `qwen2moe.cpp`
/// (`ffn_gate_inp_shexp` dotted against the hidden state, sigmoid,
/// multiplied into the shared-expert branch before the final add).
/// Real on-disk shape is `[hidden_dim]` (a `Linear(hidden_dim, 1,
/// bias=false)`'s weight, flattened -- ggml's real `create_tensor`
/// call declares it as `{n_embd}`, not a 2D matrix), so this is a
/// plain owned vector dotted with the normed hidden state directly,
/// not a `WeightMatrix`. `None` for every other architecture
/// (DeepSeek-V3's shared experts, for one real confirmed contrast,
/// add unconditionally with no gate at all).
pub shared_expert_gate: Option<Vec<f32>>,
pub norm_weight: Vec<f32>,
/// How many times each routed expert (index into `experts`) has been
/// selected by `route_top_k` across every `forward_token`/
/// `forward_batch` call so far. Real observed hotness, not a
/// placeholder -- feeds `placement_plan` below, which is what
/// `PlacementPlan::from_budget` needs to prioritize actually-hot
/// experts for GPU residency instead of guessing by index.
pub activation_counts: Vec<AtomicU64>,
/// Verified-at-load contiguous expert planes for Metal MoE
/// (`mul_mm_sg` gather/id). Built in `loader` when every routed expert
/// is mmap-backed with a simdgroup-GEMM quant (Q4_0 / Q4_K / Q8_0 / …)
/// and back-to-back gate/up/down slices. Gate/up/down kinds may differ
/// (Qwen1.5-MoE: Q4_K gate/up + Q8_0 down). `None` for store-backed,
/// F32, or non-contiguous layouts.
#[cfg(feature = "metal")]
pub packed_q4: Option<MoePackedQ4Planes>,
}
/// Load-time validated contiguous expert tensor planes (any `mul_mm_sg` quant).
#[cfg(feature = "metal")]
pub struct MoePackedQ4Planes {
gate: ferrox_core::weight_matrix::WeightBytes,
up: ferrox_core::weight_matrix::WeightBytes,
down: ferrox_core::weight_matrix::WeightBytes,
gate_stride: usize,
up_stride: usize,
down_stride: usize,
n_experts: usize,
ffn_rows: usize,
hidden_rows: usize,
gate_row_bytes: usize,
down_row_bytes: usize,
gate_kind: &'static str,
up_kind: &'static str,
down_kind: &'static str,
}
#[cfg(feature = "metal")]
impl MoePackedQ4Planes {
#[allow(clippy::too_many_arguments)]
pub(crate) fn new(
gate: ferrox_core::weight_matrix::WeightBytes,
up: ferrox_core::weight_matrix::WeightBytes,
down: ferrox_core::weight_matrix::WeightBytes,
gate_stride: usize,
up_stride: usize,
down_stride: usize,
n_experts: usize,
ffn_rows: usize,
hidden_rows: usize,
gate_kind: &'static str,
up_kind: &'static str,
down_kind: &'static str,
) -> Self {
Self {
gate,
up,
down,
gate_stride,
up_stride,
down_stride,
n_experts,
ffn_rows,
hidden_rows,
gate_row_bytes: gate_stride / ffn_rows,
down_row_bytes: down_stride / hidden_rows,
gate_kind,
up_kind,
down_kind,
}
}
pub fn view(&self) -> ferrox_metal::gpu::MoePackedQ4<'_> {
ferrox_metal::gpu::MoePackedQ4 {
gate: self.gate.as_slice(),
up: self.up.as_slice(),
down: self.down.as_slice(),
gate_stride: self.gate_stride,
up_stride: self.up_stride,
down_stride: self.down_stride,
n_experts: self.n_experts,
ffn_rows: self.ffn_rows,
hidden_rows: self.hidden_rows,
gate_row_bytes: self.gate_row_bytes,
down_row_bytes: self.down_row_bytes,
gate_kind: self.gate_kind,
up_kind: self.up_kind,
down_kind: self.down_kind,
}
}
}
impl MoeWeights {
pub fn n_experts(&self) -> usize {
self.experts.n_experts()
}
/// This routed expert's weight byte footprint, from resident
/// matrices or the stored layout -- identical numbers either way,
/// so residency planning is backing-independent.
pub fn expert_bytes(&self, e: usize) -> usize {
match &self.experts {
ExpertBacking::Resident(v) => {
let ex = &v[e];
ex.gate.resident_bytes() + ex.up.resident_bytes() + ex.down.resident_bytes()
}
ExpertBacking::Stored { layouts, .. } => layouts[e].total_bytes(),
}
}
/// Runs `f` against expert `e`'s weights, materializing them from
/// the store first when this layer is store-backed. The lease (and
/// therefore the cache entry's pin) lives exactly as long as `f`'s
/// borrow.
pub fn with_expert<R>(&self, e: usize, f: impl FnOnce(&ExpertWeights) -> R) -> R {
match &self.experts {
ExpertBacking::Resident(v) => f(&v[e]),
ExpertBacking::Stored {
store,
layouts,
layer,
} => {
let lease = store
.acquire(ferrox_core::expert_store::ExpertKey {
layer: *layer,
expert: e as u32,
})
.unwrap_or_else(|err| {
panic!(
"expert store read failed for layer {layer} expert {e}: {err} \
(checkpoint file unreadable mid-decode)"
)
});
let tmp = layouts[e].materialize(&lease);
f(&tmp)
}
}
}
fn record_activations(&self, expert_ids: &[usize]) {
for &eid in expert_ids {
if let Some(counter) = self.activation_counts.get(eid) {
counter.fetch_add(1, Ordering::Relaxed);
}
}
}
/// A real VRAM-budget-and-hotness-driven placement plan for this
/// layer's routed experts, built from each expert's actual resident
/// byte size (`WeightMatrix::resident_bytes()` summed across its
/// gate/up/down matrices, so it reflects the real quantization
/// format in use, not an estimate) and the activation counts
/// observed so far. See `ferrox_moe::PlacementPlan::from_budget`.
pub fn placement_plan(&self, vram_budget_bytes: u64) -> PlacementPlan {
let sizes: Vec<usize> = (0..self.n_experts())
.map(|e| self.expert_bytes(e))
.collect();
let counts: Vec<u64> = self
.activation_counts
.iter()
.map(|c| c.load(Ordering::Relaxed))
.collect();
let has_observations = counts.iter().any(|&c| c > 0);
PlacementPlan::from_budget(
&sizes,
has_observations.then_some(counts.as_slice()),
vram_budget_bytes,
)
}
}
pub struct LayerWeights {
pub attn: AttnWeights,
pub moe: MoeWeights,
}
/// The per-layer weights the gpt-oss graph carries and the generic GQA
/// layer structs do not.
///
/// Held as a side table on [`Decoder`] rather than as new `Option`
/// fields on [`AttnWeights`]/[`MoeWeights`] for two reasons. The first
/// is mechanical: those two structs have thirty construction sites
/// across seven loaders and every dedicated engine, and none of them
/// will ever set these. The second is the point of the exercise — a
/// checkpoint either has the whole gpt-oss graph or none of it, so
/// `Decoder::gpt_oss.is_some()` is a single, checkable predicate for
/// "this model needs the gpt-oss path", which is what the CPU-only and
/// paged-attention refusals below key off. Scattering five independent
/// `Option`s would make "half the graph is wired" representable, and
/// that state is precisely the silent-wrong-answer bug this work exists
/// to remove.
pub struct GptOssLayer {
/// `blk.N.attn_sinks.weight`, one learned logit per query head.
pub attn_sinks: Vec<f32>,
/// `blk.N.attn_output.bias`, added after the output projection.
pub o_bias: Vec<f32>,
/// `blk.N.ffn_gate_inp.bias`, added to the router logits.
pub router_bias: Vec<f32>,
/// `blk.N.ffn_{gate,up,down}_exps.bias`, one entry per expert.
pub expert_bias: Vec<ferrox_moe::ExpertBias>,
}
/// gpt-oss side table: one entry per layer, in layer order.
pub struct GptOssWeights {
pub layers: Vec<GptOssLayer>,
}
pub struct Decoder {
pub config: ModelConfig,
/// `[vocab_size, hidden_dim]`. A `WeightMatrix` rather than an
/// eagerly-widened f32 `Tensor`, so a quantized `token_embd.weight`
/// stays quantized on disk/mmap and token lookup dequantizes one
/// row at a time (`WeightMatrix::dequant_row`) -- a large-vocab
/// model's embedding table is multi-GB in f32 and only ever read
/// row-wise.
pub embedding: WeightMatrix,
pub layers: Vec<LayerWeights>,
pub final_norm: Vec<f32>,
pub output_head: WeightMatrix, // [vocab_size, hidden_dim]
/// Real VRAM budget for GPU-resident routed experts.
/// `None` (both constructors below
/// set it) means every expert always runs on CPU -- the exact
/// behavior this field's absence had before it existed. `Some(bytes)`
/// makes each forward call build ONE global `ResidencyPlan`
/// (`Decoder::residency_plan`) across every layer's actual
/// resident expert sizes and observed activation counts against
/// this single budget -- the budget is never re-spent per layer --
/// dispatching device-placed routed experts through
/// `ferrox_moe::run_expert_placed` (a real CUDA kernel when the
/// `cuda` feature is compiled in and the expert's quant kind has
/// one; a correct CPU fallback otherwise, so setting this on a
/// non-`cuda` build is harmless, just never GPU-accelerated).
/// Shared experts and a dense layer's sole expert always run on
/// CPU regardless -- every token activates them, so there's no
/// routing decision to offload the way routed-expert placement is.
/// Rebuilding the plan on every forward call is real but not yet
/// performance-tuned; a real, disclosed limit, not a correctness
/// gap.
pub gpu_vram_budget_bytes: Option<u64>,
/// `Some` only for the gpt-oss family. See [`GptOssWeights`]. When
/// set, every layer runs the gpt-oss CPU graph (attention sinks,
/// alternating SWA, biased router + experts, `swiglu_oai`), GPU
/// offload is refused at load time, and the paged-KV decode path is
/// refused at call time — neither implements sinks, and answering
/// with a different distribution is the failure this replaces.
pub gpt_oss: Option<GptOssWeights>,
/// Per-layer Metal-resident KV for fused decode/prefill attention
/// (`FERROX_METAL_ATTN`). Lazily allocated. After
/// [`ferrox_metal::attn::launch_decode_dense_stack`], Metal KV is
/// authoritative for the next decode step; host [`KvCache`] may lag
/// until [`Self::sync_metal_attn_kv_to_host`] or a CPU fallback.
/// Prefill / prefix restore still upload host → Metal when lengths
/// diverge for other reasons.
#[cfg(feature = "metal")]
pub(crate) metal_attn_kv: std::sync::Mutex<Option<Vec<ferrox_metal::attn::MetalKvBuffers>>>,
/// Load-time execution plan (family, fused-op caps, SWA/RoPE
/// policy). Built once; hot path must not re-resolve architecture
/// strings. See [`crate::execution_plan`].
pub execution_plan: crate::execution_plan::ExecutionPlan,
/// Cache key hit → fused caps last used for that geometry (enables
/// decode/prefill plan reuse without rebuilding residency).
pub plan_cache: std::sync::Mutex<
std::collections::HashMap<
crate::execution_plan::PlanGeometry,
crate::execution_plan::FusedOpCaps,
>,
>,
}
/// Simple deterministic pseudo-random generator so tests are
/// reproducible without pulling in an external `rand` dependency.
struct Lcg(u64);
impl Lcg {
fn new(seed: u64) -> Self {
Lcg(seed)
}
fn next_f32(&mut self) -> f32 {
// xorshift64*
self.0 ^= self.0 << 13;
self.0 ^= self.0 >> 7;
self.0 ^= self.0 << 17;
((self.0 >> 40) as f32 / (1u64 << 24) as f32) - 0.5
}
fn vec(&mut self, n: usize) -> Vec<f32> {
(0..n).map(|_| self.next_f32() * 0.1).collect()
}
}
impl Decoder {
/// Eagerly resolve every kernel lookup this model's dispatch paths
/// will make, and record it in
/// [`ferrox_core::kernel_registry`] before anything runs.
///
/// Call once, at the end of loading, immediately before
/// [`ferrox_core::kernel_registry::seal`]. Nothing here dispatches
/// or decides anything: it asks the same predicates the hot path
/// asks and writes the answers down, so a kernel that is missing
/// becomes a startup line instead of an unexplained benchmark row.
///
/// Routed experts held in an [`ExpertBacking::Stored`] layer are not
/// probed -- they exist only as byte ranges until a token routes to
/// them, and materialising every expert here would defeat the
/// bounded expert store. Their kinds are the same as the resident
/// case, and a dispatch-site miss still trips the sealed registry.
pub fn probe_kernels(&self) {
use ferrox_core::kernel_registry as reg;
if !reg::enabled() {
return;
}
self.embedding.probe_kernels("token_embd");
self.output_head.probe_kernels("output_head");
for layer in &self.layers {
layer.attn.q_proj.probe_kernels("attn_q");
layer.attn.k_proj.probe_kernels("attn_k");
layer.attn.v_proj.probe_kernels("attn_v");
layer.attn.o_proj.probe_kernels("attn_o");
layer.moe.router.probe_kernels("moe_router");
for e in &layer.moe.shared_experts {
e.gate.probe_kernels("shexp_gate");
e.up.probe_kernels("shexp_up");
e.down.probe_kernels("shexp_down");
}
if let ExpertBacking::Resident(experts) = &layer.moe.experts {
for e in experts {
e.gate.probe_kernels("ffn_gate");
e.up.probe_kernels("ffn_up");
e.down.probe_kernels("ffn_down");
}
}
}
// The generic decoder has a real batched prefill
// (`forward_hidden_batch`), so a `pp512` here is one GEMM per
// projection, not 512 matvecs. Recorded as a hit so that an
// engine which lacks it stands out as a miss rather than as an
// absence.
reg::record_build(
reg::Lookup::new(
ferrox_core::weight_matrix::active_backend(),
reg::op::ENGINE_PREFILL_BATCH,
None,
)
.with_role("generic_decoder"),
reg::Outcome::Hit,
);
}
/// Builds a decoder with correctly-shaped, randomly initialized
/// weights for `config`, but overrides `n_layers` and `vocab_size`
/// with small test-scale numbers so it can actually be allocated and
/// run inside a CI sandbox. Use this to validate the forward-pass
/// plumbing only, never to draw conclusions about real model
/// quality.
pub fn new_random_small(config: ModelConfig, n_layers: usize, vocab_size: usize) -> Self {
let mut rng = Lcg::new(42);
let mut config = config;
config.n_layers = n_layers;
config.vocab_size = vocab_size;
let hidden = config.hidden_dim;
let head_dim = config.head_dim;
let n_heads = config.n_heads;
let n_kv_heads = config.n_kv_heads;
let embedding = WeightMatrix::F32(Tensor::new(
rng.vec(vocab_size * hidden),
vec![vocab_size, hidden],
));
let wm = |data: Vec<f32>, shape: Vec<usize>| WeightMatrix::F32(Tensor::new(data, shape));
let mut layers = Vec::with_capacity(n_layers);
for layer_idx in 0..n_layers {
let attn = AttnWeights {
q_proj: wm(
rng.vec(n_heads * head_dim * hidden),
vec![n_heads * head_dim, hidden],
),
k_proj: wm(
rng.vec(n_kv_heads * head_dim * hidden),
vec![n_kv_heads * head_dim, hidden],
),
v_proj: wm(
rng.vec(n_kv_heads * head_dim * hidden),
vec![n_kv_heads * head_dim, hidden],
),
o_proj: wm(
rng.vec(hidden * n_heads * head_dim),
vec![hidden, n_heads * head_dim],
),
norm_weight: vec![1.0; hidden],
q_norm: None,
k_norm: None,
q_bias: None,
k_bias: None,
v_bias: None,
post_attn_norm: None,
post_ffn_norm: None,
};
// Leading dense layers (see ModelConfig::layer_is_dense's
// doc comment) get a single-expert, no-shared-expert
// dense-equivalent FFN regardless of this model's global
// MoE topology, matching the DeepSeek-2/3-family
// convention found in ik_llama.cpp's source.
let is_dense_layer = config.layer_is_dense(layer_idx);
let n_experts = if is_dense_layer {
1
} else {
config.moe.n_experts
};
let n_shared = if is_dense_layer {
0
} else {
config.moe.n_shared_experts
};
let ffn_dim = config.moe.expert_ffn_dim;
let make_expert = |rng: &mut Lcg| ExpertWeights {
gate: WeightMatrix::F32(Tensor::new(
rng.vec(ffn_dim * hidden),
vec![ffn_dim, hidden],
)),
up: WeightMatrix::F32(Tensor::new(
rng.vec(ffn_dim * hidden),
vec![ffn_dim, hidden],
)),
down: WeightMatrix::F32(Tensor::new(
rng.vec(hidden * ffn_dim),
vec![hidden, ffn_dim],
)),
};
let experts: Vec<ExpertWeights> =
(0..n_experts).map(|_| make_expert(&mut rng)).collect();
let shared_experts = (0..n_shared).map(|_| make_expert(&mut rng)).collect();
let activation_counts = (0..experts.len()).map(|_| AtomicU64::new(0)).collect();
let moe = MoeWeights {
router: wm(rng.vec(n_experts * hidden), vec![n_experts, hidden]),
experts: ExpertBacking::Resident(experts),
shared_experts,
shared_expert_gate: None,
norm_weight: vec![1.0; hidden],
activation_counts,
#[cfg(feature = "metal")]
packed_q4: None,
};
layers.push(LayerWeights { attn, moe });
}
let final_norm = vec![1.0; hidden];
let output_head = wm(rng.vec(vocab_size * hidden), vec![vocab_size, hidden]);
let execution_plan = crate::execution_plan::ExecutionPlan::from_config(
&config,
crate::capability::DecoderFamily::StandardGqa,
crate::capability::MemoryKind::KvGqa,
crate::execution_plan::ExecutionPlan::probe_metal_caps(),
);
Decoder {
config,
embedding,
layers,
final_norm,
output_head,
gpu_vram_budget_bytes: None,
// Synthetic-weights constructor: no checkpoint, no gpt-oss.
gpt_oss: None,
#[cfg(feature = "metal")]
metal_attn_kv: std::sync::Mutex::new(None),
execution_plan,
plan_cache: std::sync::Mutex::new(std::collections::HashMap::new()),
}
}
/// Applies RoPE to one head's Q or K slice. Dispatches on both
/// `rope_layout` (Norm = adjacent-pair / NeoX = split-half -- see
/// `RopeLayout`) and whether this checkpoint carries a real
/// `rope_freqs.weight` tensor (Llama 3/3.1/3.2's per-band frequency
/// correction). Getting the layout wrong for `llama` was the real
/// root cause of the Llama-3.1-8B early-stop bug: ferrox applied
/// NeoX pairing to an architecture that needs Norm.
fn apply_rope_head_theta(&self, slice: &mut [f32], pos: usize, theta: f32) {
use crate::config::RopeLayout;
// Partial rotary (llama.cpp `hparams.n_rot` < `n_embd_head_k`,
// GGUF `<arch>.rope.dimension_count`): Phi-3/Phi-4 rotate only the
// first 96 of each 128-wide head and pass the remaining 32
// through untouched. Rotating the whole head instead is not a
// subtle error — it moves dimensions the model never trained to
// be position-dependent.
let slice = match self.config.rope_dim {
Some(rot) if rot < slice.len() => &mut slice[..rot],
_ => slice,
};
match (self.config.rope_layout, &self.config.rope_freqs) {
(RopeLayout::Norm, Some(freq_factors)) => {
apply_rope_interleaved_with_freq_factors(slice, pos, theta, freq_factors)
}
(RopeLayout::Norm, None) => apply_rope_interleaved(slice, pos, theta),
(RopeLayout::Neox, Some(freq_factors)) => {
apply_rope_with_freq_factors(slice, pos, theta, freq_factors)
}
(RopeLayout::Neox, None) => apply_rope(slice, pos, theta),
}
}
fn apply_rope_head_layer(&self, slice: &mut [f32], pos: usize, layer_idx: usize) {
self.apply_rope_head_theta(slice, pos, self.config.layer_rope_theta(layer_idx))
}
/// llama.cpp's RoPE `mscale` (ggml `rope_yarn`), applied where the
/// QKV biases and QK-norms are: multiplying `cos`/`sin` by a constant
/// is the same as scaling the vector RoPE rotates, and rotation is
/// linear, so pre-scaling q and k here is exactly what the kernel
/// would do post-hoc — without a new uniform on five backends' RoPE
/// kernels.
///
/// Both q and k are scaled, so attention logits carry `m²`, which is
/// the whole observable effect (V is untouched, and k enters the
/// cache scaled exactly as llama.cpp's does).
#[inline]
fn apply_rope_attn_factor(&self, q: &mut [f32], k: &mut [f32]) {
let m = self.config.rope_attn_factor;
if m == 1.0 {
return;
}
// ggml folds `attn_factor` into cos_theta/sin_theta inside
// `rope_yarn` (ops.cpp), so it reaches ONLY the rotated channels;
// `[n_rot, head_dim)` is then copied through untouched by the
// "fill the remain channels with data from src tensor" loop.
// Scaling the pass-through tail as well is a different graph, and
// `ferrox parity` caught it as the one DRIFT verdict in a
// 17-model sweep: Phi-4-mini rotates 96 of 128 dims with
// attn_factor 1.1902, so 32 dims per head were scaled that
// llama.cpp leaves alone.
let head_dim = self.config.head_dim;
let rot = self.config.rope_dim.unwrap_or(head_dim).min(head_dim);
for buf in [q, k] {
for head in buf.chunks_mut(head_dim) {
let n = rot.min(head.len());
for v in head[..n].iter_mut() {
*v *= m;
}
}
}
}
/// Applies Q/K RMSNorm according to [`ModelConfig::qk_norm_style`].
fn apply_qk_norm(&self, x: &[f32], weight: &[f32]) -> Vec<f32> {
use crate::capability::QkNormStyle;
match self.config.qk_norm_style {
QkNormStyle::WholeVector => rms_norm(x, weight, self.config.rms_norm_eps),
QkNormStyle::PerHead => {
rms_norm_per_head(x, weight, self.config.head_dim, self.config.rms_norm_eps)
}
}
}
/// Builds a Metal [`MatvecLaunch`] for a quantized matrix, or `None`
/// if the storage/kind cannot run on Metal.
#[cfg(feature = "metal")]
fn metal_matvec_launch<'a>(m: &'a WeightMatrix) -> Option<ferrox_metal::gpu::MatvecLaunch<'a>> {
match m {
WeightMatrix::F32(t) => {
let rows = t.shape[0];
let cols = t.shape[1];
let (src, fn_name, block_bytes, block_elems, rows_per_tg) =
ferrox_metal::gpu::matvec_launch_meta("F32")?;
// SAFETY: f32 ↔ little-endian byte view for Metal upload/alias.
let bytes = unsafe {
std::slice::from_raw_parts(t.data.as_ptr() as *const u8, t.data.len() * 4)
};
Some(ferrox_metal::gpu::MatvecLaunch {
kernel_src: src,
fn_name,
block_bytes,
block_elems,
weights: bytes,
rows,
row_bytes: cols * 4,
rows_per_tg,
})
}
WeightMatrix::Quantized {
data,
rows,
cols: _,
kind,
} => {
let kind_name = match kind {
ferrox_core::QuantKind::Q8_0 => "Q8_0",
ferrox_core::QuantKind::Q4_0 => "Q4_0",
ferrox_core::QuantKind::Q4K => "Q4_K",
ferrox_core::QuantKind::Q5K => "Q5_K",
ferrox_core::QuantKind::Q6K => "Q6_K",
ferrox_core::QuantKind::IQ4XS => "IQ4_XS",
_ => return None,
};
let (src, fn_name, block_bytes, block_elems, rows_per_tg) =
ferrox_metal::gpu::matvec_launch_meta(kind_name)?;
// A zero-row matrix has no rows to stride over, so
// there is no meaningful row size; `checked_div`
// says that once instead of splitting it across a
// guard and a bare division.
let row_bytes = data.as_slice().len().checked_div(*rows).unwrap_or(0);
Some(ferrox_metal::gpu::MatvecLaunch {
kernel_src: src,
fn_name,
block_bytes,
block_elems,
weights: data.as_slice(),
rows: *rows,
row_bytes,
rows_per_tg,
})
}
_ => None,
}
}
/// True when this layer can use the fused Metal attention block
/// (Norm or NeoX RoPE, quantized projections; QKV bias + QK-norm
/// via [`ferrox_metal::attn::AttnExtras`]).
#[cfg(feature = "metal")]
fn layer_supports_metal_attn(&self, layer: &LayerWeights) -> bool {
use crate::config::RopeLayout;
// gpt-oss: no Metal kernel implements attention sinks, so the
// fused stacks would compute a *different* attention than the
// CPU path for the same weights. Keep this family on CPU rather
// than letting the two backends disagree. See `Decoder::gpt_oss`.
if self.gpt_oss.is_some() {
return false;
}
if !matches!(self.config.rope_layout, RopeLayout::Norm | RopeLayout::Neox) {
return false;
}
// QKV bias (Qwen2) and QK-norm — per-head (Qwen3/Gemma-3) or
// whole-vector (OLMoE) — run on Metal via AttnExtras.
let q_len = self.config.n_heads * self.config.head_dim;
let k_len = self.config.n_kv_heads * self.config.head_dim;
let qk_norm_ok = |w: Option<&Vec<f32>>, vec_len: usize| -> bool {
match w {
None => true,
Some(w) if w.len() == self.config.head_dim => true,
Some(w) if w.len() == vec_len => true,
_ => false,
}
};
if !qk_norm_ok(layer.attn.q_norm.as_ref(), q_len)
|| !qk_norm_ok(layer.attn.k_norm.as_ref(), k_len)
{
return false;
}
// Softcaps: final logit softcap is applied on the host after
// lm_head (Metal-safe). Attention softcap runs on Metal FA-vec /
// legacy GQA (decode + prefill). attention_scale is compensated
// by scaling Q on the host/Metal extras path.
if self.config.head_dim > 256 {
return false;
}
// Partial rotary and LongRoPE's `mscale` are CPU-only today: the
// Metal RoPE kernels rotate the whole head and take no magnitude
// uniform, so admitting such a model here would make Metal and
// CPU compute different attention for the same weights. Refusing
// costs Phi-4-mini its Metal path until the kernels carry both;
// the alternative is two backends that disagree.
if self.config.rope_dim.is_some() || self.config.rope_attn_factor != 1.0 {
return false;
}
Self::metal_matvec_launch(&layer.attn.q_proj).is_some()
&& Self::metal_matvec_launch(&layer.attn.k_proj).is_some()
&& Self::metal_matvec_launch(&layer.attn.v_proj).is_some()
&& Self::metal_matvec_launch(&layer.attn.o_proj).is_some()
}
/// Layer features only the fused dense stack implements — the
/// per-layer Metal launches would silently skip them (wrong output).
#[cfg(feature = "metal")]
fn layer_needs_metal_stack(&self, layer: &LayerWeights, layer_idx: usize) -> bool {
layer.attn.post_attn_norm.is_some()
|| layer.attn.post_ffn_norm.is_some()
|| self.config.layer_sliding_window(layer_idx).is_some()
|| matches!(
self.config.ffn_activation,
crate::config::FfnActivation::Gelu
)
|| self.config.layer_rope_theta(layer_idx) != self.config.rope_theta
}
/// Optional QKV bias / QK-norm ops for the Metal attn paths.
#[cfg(feature = "metal")]
fn metal_attn_extras<'a>(&self, layer: &'a LayerWeights) -> ferrox_metal::attn::AttnExtras<'a> {
ferrox_metal::attn::AttnExtras {
q_bias: layer.attn.q_bias.as_deref(),
k_bias: layer.attn.k_bias.as_deref(),
v_bias: layer.attn.v_bias.as_deref(),
q_norm: layer.attn.q_norm.as_deref(),
k_norm: layer.attn.k_norm.as_deref(),
attn_logit_softcap: self.config.attn_logit_softcap,
}
}
/// GPU expert residency only when Metal attention stays on-device
/// (when the Metal dense+attn path is active). Avoids CPU-attention
/// ↔ GPU-expert activation ping-pong on Metal MoE.
#[cfg(feature = "metal")]
fn expert_residency_plan(&self, use_metal_attn: bool) -> Option<ferrox_moe::ResidencyPlan> {
if ferrox_core::metal_dense_enabled()
&& ferrox_metal::attn::metal_attn_enabled()
&& !use_metal_attn
{
return None;
}
self.gpu_vram_budget_bytes.map(|b| self.residency_plan(b))
}
#[cfg(not(feature = "metal"))]
fn expert_residency_plan(&self, _use_metal_attn: bool) -> Option<ferrox_moe::ResidencyPlan> {
self.gpu_vram_budget_bytes.map(|b| self.residency_plan(b))
}
/// Map config RoPE layout onto the Metal kernel selector.
#[cfg(feature = "metal")]
fn metal_rope_layout(&self) -> ferrox_metal::attn::MetalRopeLayout {
use crate::config::RopeLayout;
match self.config.rope_layout {
RopeLayout::Norm => ferrox_metal::attn::MetalRopeLayout::Norm,
RopeLayout::Neox => ferrox_metal::attn::MetalRopeLayout::Neox,
}
}
/// Dense FFN (single expert) with Metal-capable gate/up/down.
#[cfg(feature = "metal")]
fn layer_supports_metal_dense_ffn(layer: &LayerWeights) -> bool {
Self::is_dense_layer(layer)
&& layer.moe.with_expert(0, |ex| {
Self::metal_matvec_launch(&ex.gate).is_some()
&& Self::metal_matvec_launch(&ex.up).is_some()
&& Self::metal_matvec_launch(&ex.down).is_some()
})
}
/// Dense layer eligible for the one-CB `mul_mm_sg` prefill stack.
/// QKV bias / QK-norm are applied on-GPU via [`AttnExtras`] (same as
/// decode); SWA fit is checked separately.
#[cfg(feature = "metal")]
fn metal_prefill_dense_layer_eligible(layer: &LayerWeights) -> bool {
Self::is_dense_layer(layer)
}
#[cfg(feature = "metal")]
fn metal_prefill_dense_swa_fits(
&self,
layer_idx: usize,
start_pos: usize,
batch_size: usize,
) -> bool {
match self.config.layer_sliding_window(layer_idx) {
Some(window) => start_pos + batch_size <= window,
None => true,
}
}
/// Routed-expert FFN for the fused prefill stack, or `None` when this
/// layer must keep the host-routed path (`launch_moe_prefill_q4_0`).
///
/// Note: routing happens on the GPU here, so prefill no longer feeds
/// `record_activations`. Expert hotness for `inspect-plan` comes from
/// decode, which still routes on the host.
#[cfg(feature = "metal")]
fn metal_prefill_moe<'a>(
layer: &'a LayerWeights,
config: &ModelConfig,
) -> Option<ferrox_metal::gpu::PrefillMoeMetal<'a>> {
if !ferrox_metal::attn::metal_moe_stack_enabled()
|| !ferrox_metal::attn::metal_moe_resident_enabled()
|| Self::is_dense_layer(layer)
|| !layer.moe.shared_experts.is_empty()
|| !matches!(
config.ffn_activation,
crate::config::FfnActivation::Swiglu | crate::config::FfnActivation::SwigluFused
)
|| !matches!(config.moe.gating, ferrox_moe::GatingFunction::Softmax)
|| config.moe.expert_group_count.is_some()
{
return None;
}
let ferrox_core::weight_matrix::WeightMatrix::F32(router) = &layer.moe.router else {
return None;
};
let packed = Self::moe_packed_q4(&layer.moe)?;
let moe = ferrox_metal::gpu::PrefillMoeMetal {
router_w: &router.data,
top_k: config.moe.n_experts_active,
renormalize: config.moe.norm_topk_prob,
packed,
};
moe.is_supported().then_some(moe)
}
/// FFN half of a fused-prefill-stack layer: dense `mul_mm_sg` launches
/// or (MoE) the routed-expert description.
#[cfg(feature = "metal")]
fn metal_prefill_ffn<'a>(
layer: &'a LayerWeights,
config: &ModelConfig,
) -> Option<ferrox_metal::attn::PrefillFfnMetal<'a>> {
if let Some(moe) = Self::metal_prefill_moe(layer, config) {
return Some(ferrox_metal::attn::PrefillFfnMetal::Moe(moe));
}
if !Self::is_dense_layer(layer) {
return None;
}
let ExpertBacking::Resident(experts) = &layer.moe.experts else {
return None;
};
let ex = experts.first()?;
Some(ferrox_metal::attn::PrefillFfnMetal::Dense {
gate: ex.gate.mul_mm_sg_launch()?,
up: ex.up.mul_mm_sg_launch()?,
down: ex.down.mul_mm_sg_launch()?,
})
}
/// Length of a consecutive run of Metal prefill-stack layers from
/// `start`, or `None` when fewer than two layers qualify.
#[cfg(feature = "metal")]
fn metal_prefill_dense_stack_run_len(
&self,
start: usize,
start_pos: usize,
batch_size: usize,
kv_caches: &[KvCache],
metal_kvs: Option<&[ferrox_metal::attn::MetalKvBuffers]>,
) -> Option<usize> {
// See `layer_supports_metal_attn`: gpt-oss stays on CPU.
if self.gpt_oss.is_some() {
return None;
}
let metal_kvs = metal_kvs?;
let mut run = 0usize;
for li in start..self.layers.len() {
let layer = &self.layers[li];
let cache = &kv_caches[li];
if !self.metal_prefill_dense_swa_fits(li, start_pos, batch_size) {
break;
}
if metal_kvs[li].seq_len != cache.seq_len || start_pos != cache.seq_len {
break;
}
let ok = layer.attn.q_proj.mul_mm_sg_launch().is_some()
&& layer.attn.k_proj.mul_mm_sg_launch().is_some()
&& layer.attn.v_proj.mul_mm_sg_launch().is_some()
&& layer.attn.o_proj.mul_mm_sg_launch().is_some()
&& Self::metal_prefill_ffn(layer, &self.config).is_some();
if !ok {
break;
}
run += 1;
}
(run >= 2).then_some(run)
}
/// Try [`ferrox_metal::attn::launch_prefill_dense_stack`] for
/// `run_len` layers starting at `start`. Advances host + Metal KV
/// on success.
#[cfg(feature = "metal")]
#[allow(clippy::too_many_arguments)]
fn try_metal_prefill_dense_stack(
&self,
start: usize,
run_len: usize,
hidden_batch: &[f32],
start_pos: usize,
batch_size: usize,
n_heads: usize,
metal_kvs: &mut [ferrox_metal::attn::MetalKvBuffers],
kv_caches: &mut [KvCache],
) -> Option<Vec<f32>> {
let gelu = matches!(
self.config.ffn_activation,
crate::config::FfnActivation::Gelu
);
let mut prefill_layers = Vec::with_capacity(run_len);
let mut rope_thetas = Vec::with_capacity(run_len);
for li in start..start + run_len {
let layer = &self.layers[li];
let ffn = Self::metal_prefill_ffn(layer, &self.config)?;
if matches!(ffn, ferrox_metal::attn::PrefillFfnMetal::Dense { .. }) {
layer.moe.record_activations(&[0]);
}
let (q, k, v, o) = (
layer.attn.q_proj.mul_mm_sg_launch()?,
layer.attn.k_proj.mul_mm_sg_launch()?,
layer.attn.v_proj.mul_mm_sg_launch()?,
layer.attn.o_proj.mul_mm_sg_launch()?,
);
prefill_layers.push(ferrox_metal::attn::PrefillDenseLayerMetal {
attn_norm_w: &layer.attn.norm_weight,
ffn_norm_w: &layer.moe.norm_weight,
q,
k,
v,
o,
ffn,
post_attn_norm: layer.attn.post_attn_norm.as_deref(),
post_ffn_norm: layer.attn.post_ffn_norm.as_deref(),
extras: self.metal_attn_extras(layer),
layer_idx: li as u32,
});
rope_thetas.push(self.config.layer_rope_theta(li));
}
let kvs = &mut metal_kvs[start..start + run_len];
let h_out = ferrox_metal::attn::launch_prefill_dense_stack(
hidden_batch,
&prefill_layers,
kvs,
n_heads,
batch_size,
self.metal_rope_layout(),
&rope_thetas,
self.config.rope_freqs.as_deref(),
start_pos,
self.config.rms_norm_eps,
gelu,
self.config.attn_logit_softcap,
)
.ok()?;
for cache in &mut kv_caches[start..start + run_len] {
cache
.advance_len(batch_size)
.expect("unbounded/planned KvCache growth is infallible");
}
Some(h_out)
}
/// MoE layer eligible for resident Metal decode (attn+router+experts
/// without host residual ping-pong). Requires SwiGLU, no shared
/// experts, Resident expert backing, and Metal router/QKV/O.
#[cfg(feature = "metal")]
fn layer_supports_metal_moe_resident(layer: &LayerWeights, config: &ModelConfig) -> bool {
!Self::is_dense_layer(layer)
&& layer.moe.shared_experts.is_empty()
&& matches!(
config.ffn_activation,
crate::config::FfnActivation::Swiglu | crate::config::FfnActivation::SwigluFused
)
&& matches!(layer.moe.experts, ExpertBacking::Resident(_))
&& Self::metal_matvec_launch(&layer.moe.router).is_some()
&& Self::metal_matvec_launch(&layer.attn.q_proj).is_some()
&& Self::metal_matvec_launch(&layer.attn.k_proj).is_some()
&& Self::metal_matvec_launch(&layer.attn.v_proj).is_some()
&& Self::metal_matvec_launch(&layer.attn.o_proj).is_some()
}
/// One Metal CB for all top-k routed experts (weighted sum). Returns
/// `None` if any expert lacks a Metal launch (caller falls back).
#[cfg(feature = "metal")]
fn try_metal_moe_topk(
layer: &LayerWeights,
normed2: &[f32],
decision: &ferrox_moe::RoutingDecision,
) -> Option<Vec<f32>> {
if decision.expert_ids.is_empty() {
return Some(vec![0f32; normed2.len()]);
}
// Build launches while holding each expert briefly; collect owned
// weight refs via with_expert into temporary MatvecLaunch list.
let mut launches: Vec<ferrox_metal::gpu::MoeExpertLaunch<'_>> =
Vec::with_capacity(decision.expert_ids.len());
// Lifetime: MatvecLaunch borrows WeightMatrix bytes that live in
// layer.moe for the duration of this call. Collect via a scoped
// approach — we need all launches alive together.
// Use indices + rebuild inside a single with_experts loop.
struct Pending {
eid: usize,
weight: f32,
}
let pending: Vec<Pending> = decision
.expert_ids
.iter()
.zip(decision.weights.iter())
.map(|(&eid, &w)| Pending { eid, weight: w })
.collect();
// Validate all experts have Metal launches first.
for p in &pending {
let ok = layer.moe.with_expert(p.eid, |ex| {
Self::metal_matvec_launch(&ex.gate).is_some()
&& Self::metal_matvec_launch(&ex.up).is_some()
&& Self::metal_matvec_launch(&ex.down).is_some()
});
if !ok {
return None;
}
}
// Hold expert refs: Resident experts are in a Vec; with_expert
// only borrows one at a time. For Resident backing we can get
// all launches by indexing once.
match &layer.moe.experts {
ExpertBacking::Resident(experts) => {
for p in &pending {
let ex = &experts[p.eid];
launches.push(ferrox_metal::gpu::MoeExpertLaunch {
gate: Self::metal_matvec_launch(&ex.gate)?,
up: Self::metal_matvec_launch(&ex.up)?,
down: Self::metal_matvec_launch(&ex.down)?,
weight: p.weight,
});
}
}
ExpertBacking::Stored { .. } => {
// Streaming experts: fall back (can't hold all refs easily).
return None;
}
}
match ferrox_metal::gpu::launch_moe_topk_swiglu(normed2, &launches) {
Ok(out) => Some(out),
Err(e) => {
eprintln!("ferrox: Metal MoE top-k fuse failed, falling back: {e}");
None
}
}
}
/// Contiguous Q4_0 expert planes for llama-style `mul_mv_id` MoE.
#[cfg(feature = "metal")]
fn moe_packed_q4(moe: &MoeWeights) -> Option<ferrox_metal::gpu::MoePackedQ4<'_>> {
moe.packed_q4.as_ref().map(MoePackedQ4Planes::view)
}
/// Prefill MoE FFN on Metal: host route over T, then one packed-id CB
/// (`launch_moe_prefill_q4_0`). Shared experts (if any) run as dense
/// batch FFN on the host/GPU path afterwards — not through `mul_mm_id`.
/// Returns FFN outs `[T, H]` or `None`.
#[cfg(feature = "metal")]
fn try_metal_moe_prefill_batch(
layer: &LayerWeights,
normed2_batch: &[f32],
router_logits_batch: &[f32],
batch_size: usize,
hidden_dim: usize,
config: &ModelConfig,
) -> Option<Vec<f32>> {
if batch_size == 0
|| !ferrox_core::metal_dense_enabled()
|| !ferrox_metal::attn::metal_moe_resident_enabled()
|| !matches!(
config.ffn_activation,
crate::config::FfnActivation::Swiglu | crate::config::FfnActivation::SwigluFused
)
|| !matches!(config.moe.gating, ferrox_moe::GatingFunction::Softmax)
|| config.moe.expert_group_count.is_some()
{
return None;
}
let ExpertBacking::Resident(_) = &layer.moe.experts else {
return None;
};
let packed = Self::moe_packed_q4(&layer.moe)?;
let top_k = config.moe.n_experts_active;
if top_k == 0 || top_k > 8 || packed.hidden_rows != hidden_dim {
return None;
}
let n_experts = layer.moe.n_experts().max(1);
let mut ids = Vec::with_capacity(batch_size * top_k);
let mut route = Vec::with_capacity(batch_size * top_k);
for b in 0..batch_size {
let logits = &router_logits_batch[b * n_experts..(b + 1) * n_experts];
let decision = route_top_k(logits, top_k, config.moe.gating, config.moe.norm_topk_prob);
layer.moe.record_activations(&decision.expert_ids);
if decision.expert_ids.len() != top_k {
return None;
}
for (&eid, &w) in decision.expert_ids.iter().zip(decision.weights.iter()) {
ids.push(eid as i32);
route.push(w);
}
}
let mut out = match ferrox_metal::gpu::launch_moe_prefill_q4_0(
normed2_batch,
batch_size,
&packed,
&ids,
&route,
top_k,
) {
Ok(out) => out,
Err(e) => {
eprintln!("ferrox: Metal MoE prefill failed, CPU fallback: {e}");
return None;
}
};
Self::accumulate_shared_experts_batch(
layer,
normed2_batch,
batch_size,
hidden_dim,
&mut out,
);
Some(out)
}
/// Shared expert as dense batch FFN (llama qwen2moe: not through
/// `mul_mat_id`). Optional sigmoid gate scales per token.
fn accumulate_shared_experts_batch(
layer: &LayerWeights,
normed2_batch: &[f32],
batch_size: usize,
hidden_dim: usize,
acc: &mut [f32],
) {
for shex in &layer.moe.shared_experts {
// Prefer one Metal FFN CB (gate∥up→SiLU→down) over three
// `apply_batch` round-trips — Qwen shexp is 4× routed width.
#[cfg(feature = "metal")]
let down = if ferrox_core::metal_dense_enabled() && batch_size >= 4 {
match (
shex.gate.mul_mm_sg_launch(),
shex.up.mul_mm_sg_launch(),
shex.down.mul_mm_sg_launch(),
) {
(Some(g), Some(u), Some(d)) => {
ferrox_metal::gpu::launch_dense_ffn_swiglu_batch(
&g,
&u,
&d,
normed2_batch,
batch_size,
false,
)
.ok()
}
_ => None,
}
} else {
None
};
#[cfg(not(feature = "metal"))]
let down: Option<Vec<f32>> = None;
// Without `metal` the binding above is a literal `None`; the
// fallback is the only arm and clippy flags the unwrap.
#[cfg_attr(not(feature = "metal"), allow(clippy::unnecessary_literal_unwrap))]
let down = down.unwrap_or_else(|| {
let ffn_acts = shex.gate.quantize_batch_acts(normed2_batch, batch_size);
let gate =
shex.gate
.apply_batch_with_acts(normed2_batch, batch_size, ffn_acts.as_ref());
let up =
shex.up
.apply_batch_with_acts(normed2_batch, batch_size, ffn_acts.as_ref());
let activated = ferrox_core::matmul::swiglu(&gate, &up);
shex.down.apply_batch(&activated, batch_size)
});
if let Some(gate_w) = &layer.moe.shared_expert_gate {
for b in 0..batch_size {
let x = &normed2_batch[b * hidden_dim..(b + 1) * hidden_dim];
let logit: f32 = gate_w.iter().zip(x.iter()).map(|(g, v)| g * v).sum();
let scale = 1.0 / (1.0 + (-logit).exp());
let out = &down[b * hidden_dim..(b + 1) * hidden_dim];
let row = &mut acc[b * hidden_dim..(b + 1) * hidden_dim];
for (a, &o) in row.iter_mut().zip(out.iter()) {
*a += scale * o;
}
}
} else {
for (a, &o) in acc.iter_mut().zip(down.iter()) {
*a += o;
}
}
}
}
/// Phase-2 of resident MoE decode: experts on GPU `x2`, add into GPU `h`.
#[cfg(feature = "metal")]
fn try_metal_moe_experts_resident(
layer: &LayerWeights,
decision: &ferrox_moe::RoutingDecision,
) -> Option<()> {
if decision.expert_ids.is_empty() {
return Some(());
}
let pending: Vec<(usize, f32)> = decision
.expert_ids
.iter()
.zip(decision.weights.iter())
.map(|(&eid, &w)| (eid, w))
.collect();
for &(eid, _) in &pending {
let ok = layer.moe.with_expert(eid, |ex| {
Self::metal_matvec_launch(&ex.gate).is_some()
&& Self::metal_matvec_launch(&ex.up).is_some()
&& Self::metal_matvec_launch(&ex.down).is_some()
});
if !ok {
return None;
}
}
let ExpertBacking::Resident(experts) = &layer.moe.experts else {
return None;
};
let mut launches = Vec::with_capacity(pending.len());
for &(eid, weight) in &pending {
let ex = &experts[eid];
launches.push(ferrox_metal::gpu::MoeExpertLaunch {
gate: Self::metal_matvec_launch(&ex.gate)?,
up: Self::metal_matvec_launch(&ex.up)?,
down: Self::metal_matvec_launch(&ex.down)?,
weight,
});
}
match ferrox_metal::attn::launch_moe_decode_experts(&launches) {
Ok(()) => Some(()),
Err(e) => {
eprintln!("ferrox: Metal MoE experts failed, falling back: {e}");
None
}
}
}
/// Append host [`KvCache`] positions that Metal already holds but host
/// skipped (dense-stack fast path). No-op when `cache.seq_len` is caught up.
#[cfg(feature = "metal")]
fn catch_up_host_kv_from_metal(mkv: &ferrox_metal::attn::MetalKvBuffers, cache: &mut KvCache) {
if cache.seq_len >= mkv.seq_len {
return;
}
let start = cache.seq_len;
let n = mkv.seq_len - start;
let (k, v) = mkv.tokens_host(start, n);
let per = cache.n_kv_heads * cache.head_dim;
for i in 0..n {
let off = i * per;
cache
.push(&k[off..off + per], &v[off..off + per])
.expect("unbounded/planned KvCache growth is infallible");
}
}
/// Pull every layer's Metal-ahead suffix into `kv_caches` (prefix-cache
/// store, continuous-batch / CPU readers). Safe no-op without Metal KV.
#[cfg(feature = "metal")]
pub fn sync_metal_attn_kv_to_host(&self, kv_caches: &mut [KvCache]) {
assert_eq!(kv_caches.len(), self.layers.len());
let Ok(guard) = self.metal_attn_kv.lock() else {
return;
};
let Some(metal_kvs) = guard.as_ref() else {
return;
};
if metal_kvs.len() != kv_caches.len() {
return;
}
for (mkv, cache) in metal_kvs.iter().zip(kv_caches.iter_mut()) {
Self::catch_up_host_kv_from_metal(mkv, cache);
}
}
/// GQA decode reduction for one token. Uses the CUDA `gqa_decode`
/// kernel when built with `--features cuda` and `FERROX_CUDA_GQA=1`
/// (falling back to the host path on any launch error), else the
/// portable [`causal_gqa_attention`]. With residency enabled the
/// K/V append stays in [`ferrox_cuda::attn::CudaKvBuffers`] so only
/// Q crosses the bus per call (plus a prefix refresh on append).
#[allow(clippy::too_many_arguments)]
fn gqa_attention(
&self,
layer: usize,
q: &[f32],
k: &[f32],
v: &[f32],
n_heads: usize,
n_kv_heads: usize,
head_dim: usize,
seq_len: usize,
) -> Vec<f32> {
#[cfg(feature = "cuda")]
{
if cuda_gqa_enabled() {
match ferrox_cuda::attn::launch_gqa_decode_resident(
layer, q, k, v, n_heads, n_kv_heads, head_dim, seq_len,
) {
Ok(out) => return out,
Err(e) => {
eprintln!(
"ferrox: CUDA GQA resident decode failed, trying full upload: {e}"
);
}
}
match ferrox_cuda::attn::launch_gqa_decode(
q, k, v, n_heads, n_kv_heads, head_dim, seq_len,
) {
Ok(out) => return out,
Err(e) => {
eprintln!("ferrox: CUDA GQA decode failed, host fallback: {e}");
}
}
}
}
let _ = layer;
causal_gqa_attention_softcap(
q,
k,
v,
n_heads,
n_kv_heads,
head_dim,
seq_len,
self.config.attn_logit_softcap,
)
}
/// Runs one decode step for `token_id` at position `pos`, updating
/// `kv_caches` (one per layer) in place, and returns the logits over
/// the (test-scale) vocabulary.
pub fn forward_token(
&self,
token_id: usize,
pos: usize,
kv_caches: &mut [KvCache],
) -> Vec<f32> {
// Clear stale dense-stack activation TLS. MoE scratch buffers are
// reused across tokens (re-seeded); cleared after lm_head below.
#[cfg(feature = "metal")]
ferrox_metal::gpu::clear_resident_activation();
assert_eq!(kv_caches.len(), self.layers.len());
let hidden_dim = self.config.hidden_dim;
let head_dim = self.config.head_dim;
let n_heads = self.config.n_heads;
let n_kv_heads = self.config.n_kv_heads;
#[cfg(feature = "metal")]
let metal_embd_kind = {
let metal_path = ferrox_core::metal_dense_enabled()
&& ferrox_metal::attn::metal_attn_enabled()
&& self
.layers
.iter()
.all(|l| self.layer_supports_metal_attn(l))
&& self.layers.iter().all(Self::layer_supports_metal_dense_ffn);
// Gemma scales the embedding row (`embedding_scale`) — the GPU
// gather has no scale op, so dequant + scale on the host.
if metal_path && self.config.embedding_scale.is_none() {
Self::metal_matvec_launch(&self.embedding)
.and_then(|l| ferrox_metal::embd::EmbdKind::from_fn_name(l.fn_name))
} else {
None
}
};
#[cfg(feature = "metal")]
let mut hidden = if metal_embd_kind.is_some() {
Vec::new()
} else {
self.embedding.dequant_row(token_id)
};
#[cfg(not(feature = "metal"))]
let mut hidden = self.embedding.dequant_row(token_id);
if let Some(scale) = self.config.embedding_scale {
for v in hidden.iter_mut() {
*v *= scale;
}
}
#[cfg(feature = "cuda")]
if cuda_gqa_enabled() {
// Fixed capacity so ensure_layer_kv does not recreate (and
// wipe) mid-sequence as pos grows.
const CUDA_KV_CAP: usize = 4096;
if let Err(e) = ferrox_cuda::attn::ensure_layer_kv(
self.layers.len(),
self.config.n_kv_heads,
self.config.head_dim,
CUDA_KV_CAP,
) {
eprintln!("ferrox: CUDA KV residency init failed: {e}");
}
if pos == 0 {
ferrox_cuda::attn::clear_layer_kv();
}
}
#[cfg(feature = "metal")]
let use_metal_attn = ferrox_core::metal_dense_enabled()
&& ferrox_metal::attn::metal_attn_enabled()
&& self
.layers
.iter()
.all(|l| self.layer_supports_metal_attn(l));
#[cfg(not(feature = "metal"))]
let use_metal_attn = false;
let residency = self.expert_residency_plan(use_metal_attn);
#[cfg(feature = "metal")]
let mut metal_kv_guard: Option<
std::sync::MutexGuard<'_, Option<Vec<ferrox_metal::attn::MetalKvBuffers>>>,
> = if use_metal_attn {
Some(self.metal_attn_kv.lock().unwrap())
} else {
None
};
#[cfg(feature = "metal")]
if let Some(guard) = metal_kv_guard.as_mut() {
let need = self.layers.len();
let cap = kv_caches
.iter()
.map(|c| c.seq_len.max(pos + 1).saturating_add(256))
.max()
.unwrap_or(512)
.max(512)
.max(pos + 1);
let reset = match guard.as_ref() {
None => true,
Some(v) => {
if v.len() != need || v.iter().any(|m| m.capacity() < pos + 1) {
// Growing / reshaping: preserve Metal-ahead tokens on host first.
if v.len() == need {
for (m, c) in v.iter().zip(kv_caches.iter_mut()) {
Self::catch_up_host_kv_from_metal(m, c);
}
}
true
} else if v.iter().all(|m| m.seq_len == pos) {
// Metal already holds tokens [0, pos). Host may lag
// after dense-stack decode — do not re-upload from host.
false
} else {
// Stale Metal (new request / prefix restore): rebuild from host.
true
}
}
};
if reset {
let mut bufs = Vec::with_capacity(need);
for _ in 0..need {
match ferrox_metal::attn::MetalKvBuffers::with_capacity(
n_kv_heads, head_dim, cap,
) {
Ok(b) => bufs.push(b),
Err(_) => {
**guard = None;
break;
}
}
}
if bufs.len() == need {
// Sync from host after CPU prefill / prefix restore / capacity grow.
let mut ok = true;
for (m, c) in bufs.iter_mut().zip(kv_caches.iter()) {
if c.seq_len > 0 && m.upload_from_host(&c.k, &c.v, c.seq_len).is_err() {
ok = false;
break;
}
}
if ok {
**guard = Some(bufs);
} else {
**guard = None;
}
} else {
**guard = None;
}
}
}
#[cfg(feature = "metal")]
let mut metal_stack_done = false;
#[cfg(feature = "metal")]
let mut final_norm_done_in_stack = false;
// OLMoE: all MoE layers in one CB (llama graph style).
#[cfg(feature = "metal")]
if use_metal_attn
&& ferrox_metal::attn::metal_moe_resident_enabled()
&& matches!(self.config.moe.gating, ferrox_moe::GatingFunction::Softmax)
&& self
.layers
.iter()
.all(|l| Self::layer_supports_metal_moe_resident(l, &self.config))
&& !self.layers.iter().all(Self::layer_supports_metal_dense_ffn)
{
if let Some(guard) = metal_kv_guard.as_mut() {
if let Some(metal_kvs) = guard.as_mut() {
if metal_kvs.iter().all(|m| m.seq_len == pos) {
let mut moe_layers = Vec::with_capacity(self.layers.len());
let mut ok = true;
for layer in &self.layers {
let ExpertBacking::Resident(_) = &layer.moe.experts else {
ok = false;
break;
};
let Some(packed) = Self::moe_packed_q4(&layer.moe) else {
ok = false;
break;
};
let (Some(q), Some(k), Some(v), Some(o), Some(r)) = (
Self::metal_matvec_launch(&layer.attn.q_proj),
Self::metal_matvec_launch(&layer.attn.k_proj),
Self::metal_matvec_launch(&layer.attn.v_proj),
Self::metal_matvec_launch(&layer.attn.o_proj),
Self::metal_matvec_launch(&layer.moe.router),
) else {
ok = false;
break;
};
moe_layers.push(ferrox_metal::attn::MoeLayerMetal {
attn_norm_w: &layer.attn.norm_weight,
ffn_norm_w: &layer.moe.norm_weight,
q,
k,
v,
o,
router: r,
packed,
extras: self.metal_attn_extras(layer),
});
}
if ok {
// Greedy / FERROX_METAL_LOGITS: fold lm_head(+argmax)
// like dense stack — download 1×u32 or vocab, skip host.
let greedy_gpu = ferrox_metal::attn::metal_greedy_argmax_active();
let lm_head_gpu_launch = Self::metal_matvec_launch(&self.output_head);
let out_launch =
if greedy_gpu || ferrox_metal::attn::metal_logits_enabled() {
lm_head_gpu_launch
} else {
None
};
let embd_launch = Self::metal_matvec_launch(&self.embedding);
// Gemma scales embd on host; GPU gather has no scale.
let embd_gather = if self.config.embedding_scale.is_some() {
None
} else {
match (metal_embd_kind, embd_launch.as_ref()) {
(Some(kind), Some(launch)) => {
Some(ferrox_metal::attn::EmbdGatherMetal {
kind,
weights: launch.weights,
rows: launch.rows,
row_bytes: launch.row_bytes,
n_cols: hidden_dim,
token_id,
})
}
_ => None,
}
};
if embd_gather.is_none() && hidden.is_empty() {
hidden = self.embedding.dequant_row(token_id);
if let Some(scale) = self.config.embedding_scale {
for v in hidden.iter_mut() {
*v *= scale;
}
}
}
let seed = if embd_gather.is_some() {
ferrox_metal::attn::moe_decode_ensure(hidden_dim)
} else {
ferrox_metal::attn::moe_decode_seed(&hidden)
};
let hidden_ref: &[f32] =
if embd_gather.is_some() { &[] } else { &hidden };
match seed.and_then(|_| {
ferrox_metal::attn::launch_moe_decode_stack(
hidden_ref,
&moe_layers,
metal_kvs,
self.config.moe.n_experts_active,
self.config.moe.norm_topk_prob,
n_heads,
self.metal_rope_layout(),
self.config.rope_theta,
self.config.rope_freqs.as_deref(),
pos,
self.config.rms_norm_eps,
Some(&self.final_norm),
out_launch.as_ref(),
greedy_gpu && out_launch.is_some(),
true,
embd_gather.as_ref(),
)
}) {
Ok((out, per_layer_ids)) => {
for (layer, ids) in self.layers.iter().zip(per_layer_ids.iter())
{
if !ids.is_empty() {
layer.moe.record_activations(ids);
}
}
if out_launch.is_some() {
#[cfg(feature = "metal")]
ferrox_metal::gpu::clear_resident_activation();
return out;
}
hidden = out;
final_norm_done_in_stack = true;
metal_stack_done = true;
}
Err(e) => {
eprintln!(
"ferrox: Metal MoE stack failed, per-layer fallback: {e}"
);
if hidden.is_empty() {
hidden = self.embedding.dequant_row(token_id);
if let Some(scale) = self.config.embedding_scale {
for v in hidden.iter_mut() {
*v *= scale;
}
}
}
}
}
}
}
}
}
}
#[cfg(feature = "metal")]
if !metal_stack_done
&& use_metal_attn
&& self.layers.iter().all(Self::layer_supports_metal_dense_ffn)
{
if let Some(guard) = metal_kv_guard.as_mut() {
let mut clear_metal_after_stack = false;
if let Some(metal_kvs) = guard.as_mut() {
let seq_ok = metal_kvs.iter().all(|m| m.seq_len == pos);
if seq_ok {
// Build launches only for resident dense experts (Llama path).
let mut dense_layers = Vec::with_capacity(self.layers.len());
let mut ok = true;
for (li, layer) in self.layers.iter().enumerate() {
let ExpertBacking::Resident(experts) = &layer.moe.experts else {
ok = false;
break;
};
let ex = &experts[0];
let (Some(q), Some(k), Some(v), Some(o), Some(g), Some(u), Some(d)) = (
Self::metal_matvec_launch(&layer.attn.q_proj),
Self::metal_matvec_launch(&layer.attn.k_proj),
Self::metal_matvec_launch(&layer.attn.v_proj),
Self::metal_matvec_launch(&layer.attn.o_proj),
Self::metal_matvec_launch(&ex.gate),
Self::metal_matvec_launch(&ex.up),
Self::metal_matvec_launch(&ex.down),
) else {
ok = false;
break;
};
dense_layers.push(ferrox_metal::attn::DenseLayerMetal {
attn_norm_w: &layer.attn.norm_weight,
ffn_norm_w: &layer.moe.norm_weight,
q,
k,
v,
o,
gate: g,
up: u,
down: d,
extras: self.metal_attn_extras(layer),
rope_theta: {
let t = self.config.layer_rope_theta(li);
(t != self.config.rope_theta).then_some(t)
},
window: self.config.layer_sliding_window(li),
post_attn_norm: layer.attn.post_attn_norm.as_deref(),
post_ffn_norm: layer.attn.post_ffn_norm.as_deref(),
});
}
if ok {
// Prefer greedy GPU argmax-in-stack (1×u32 download)
// when generate marked this thread for temperature<=0.
// Else opt-in FERROX_METAL_LOGITS downloads full vocab
// (often slower). Default: host lm_head after hidden.
let greedy_gpu = ferrox_metal::attn::metal_greedy_argmax_active();
let lm_head_gpu_launch = Self::metal_matvec_launch(&self.output_head);
// Prefer greedy GPU argmax-in-stack (1×u32 download)
// when generate marked this thread for temperature<=0.
// Else opt-in FERROX_METAL_LOGITS downloads full vocab
// (often slower). Default: host lm_head after hidden.
let out_launch =
if greedy_gpu || ferrox_metal::attn::metal_logits_enabled() {
lm_head_gpu_launch
} else {
None
};
// Pass final_norm_w when: (1) lm_head runs in stack (out_launch),
// OR (2) lm_head will route to GPU after stack (lm_head_gpu_launch
// but no out_launch) so we can skip download→reupload via TLS.
let final_norm_w =
if out_launch.is_some() || lm_head_gpu_launch.is_some() {
Some(self.final_norm.as_slice())
} else {
None
};
let embd_launch = Self::metal_matvec_launch(&self.embedding);
// Gemma scales the embedding row on the host
// (`hidden` already carries sqrt(hidden_dim));
// the GPU gather has no scale op — skip it.
let embd_gather = if self.config.embedding_scale.is_some() {
None
} else {
match (metal_embd_kind, embd_launch.as_ref()) {
(Some(kind), Some(launch)) => {
Some(ferrox_metal::attn::EmbdGatherMetal {
kind,
weights: launch.weights,
rows: launch.rows,
row_bytes: launch.row_bytes,
n_cols: hidden_dim,
token_id,
})
}
_ => None,
}
};
let hidden_ref: &[f32] =
if embd_gather.is_some() { &[] } else { &hidden };
match ferrox_metal::attn::launch_decode_dense_stack(
hidden_ref,
&dense_layers,
metal_kvs,
n_heads,
self.metal_rope_layout(),
self.config.rope_theta,
self.config.rope_freqs.as_deref(),
pos,
self.config.rms_norm_eps,
final_norm_w,
out_launch.as_ref(),
greedy_gpu && out_launch.is_some(),
embd_gather.as_ref(),
matches!(
self.config.ffn_activation,
crate::config::FfnActivation::Gelu
),
) {
Ok(out) => {
// Metal KV advanced in-place. Skip host
// last_token_host+push — host may lag until
// sync_metal_attn_kv_to_host / CPU fallback.
// Dense stack has no MoE routing; skip
// per-layer hotness atomics on the hot path.
if out_launch.is_some() {
// Stack returned logits or [argmax id] —
// skip host final_norm/lm_head. Clear TLS.
#[cfg(feature = "metal")]
ferrox_metal::gpu::clear_resident_activation();
return out;
}
// Stack downloaded hidden (possibly normalized if
// final_norm_w was Some). Track whether host should
// skip final_norm.
final_norm_done_in_stack = final_norm_w.is_some();
hidden = out;
metal_stack_done = true;
}
Err(e) => {
eprintln!(
"ferrox: Metal dense stack failed, per-layer fallback: {e}"
);
if hidden.is_empty() {
hidden = self.embedding.dequant_row(token_id);
if let Some(scale) = self.config.embedding_scale {
for v in hidden.iter_mut() {
*v *= scale;
}
}
}
// Preserve any prior Metal-ahead tokens on host
// before dropping the device buffers.
for (m, c) in metal_kvs.iter().zip(kv_caches.iter_mut()) {
Self::catch_up_host_kv_from_metal(m, c);
}
clear_metal_after_stack = true;
}
}
}
}
}
if clear_metal_after_stack {
**guard = None;
}
}
}
#[cfg(feature = "metal")]
let run_cpu_layers = !metal_stack_done;
#[cfg(not(feature = "metal"))]
let run_cpu_layers = true;
// When true, residual lives in Metal MoE scratch — host `hidden` is stale.
#[cfg(feature = "metal")]
let mut metal_moe_resident = false;
if run_cpu_layers {
for (l, (layer, cache)) in self.layers.iter().zip(kv_caches.iter_mut()).enumerate() {
// --- attention block ---
#[cfg(feature = "metal")]
if metal_moe_resident
&& (!Self::layer_supports_metal_moe_resident(layer, &self.config)
|| self.layer_needs_metal_stack(layer, l))
{
if let Some(h) = ferrox_metal::attn::moe_decode_take_hidden() {
hidden = h;
}
metal_moe_resident = false;
}
#[cfg(feature = "metal")]
let normed = if metal_moe_resident {
// Residual is on-device; host rms_norm would use stale hidden.
Vec::new()
} else {
rms_norm(&hidden, &layer.attn.norm_weight, self.config.rms_norm_eps)
};
#[cfg(not(feature = "metal"))]
let normed = rms_norm(&hidden, &layer.attn.norm_weight, self.config.rms_norm_eps);
#[cfg(feature = "metal")]
{
let mut did_metal_attn = false;
let mut did_metal_dense = false;
let mut did_metal_moe = false;
let mut clear_metal_kv = false;
if let Some(guard) = metal_kv_guard.as_mut() {
if let Some(metal_kvs) = guard.as_mut() {
// Metal-authoritative: host may lag after dense-stack skip.
// Stack-only features (SWA / sandwich norms / GeGLU /
// per-layer theta) are NOT encoded by the per-layer
// launches — those layers must go to CPU here.
if metal_kvs[l].seq_len == pos
&& !self.layer_needs_metal_stack(layer, l)
{
if let (Some(q_l), Some(k_l), Some(v_l), Some(o_l)) = (
Self::metal_matvec_launch(&layer.attn.q_proj),
Self::metal_matvec_launch(&layer.attn.k_proj),
Self::metal_matvec_launch(&layer.attn.v_proj),
Self::metal_matvec_launch(&layer.attn.o_proj),
) {
// Full dense layer on one CB when FFN is Metal-capable.
if Self::layer_supports_metal_dense_ffn(layer) {
let dense_ok = layer.moe.with_expert(0, |ex| {
let (Some(g_l), Some(u_l), Some(d_l)) = (
Self::metal_matvec_launch(&ex.gate),
Self::metal_matvec_launch(&ex.up),
Self::metal_matvec_launch(&ex.down),
) else {
return false;
};
match ferrox_metal::attn::launch_decode_dense_layer(
&hidden,
&layer.attn.norm_weight,
&q_l,
&k_l,
&v_l,
&o_l,
&mut metal_kvs[l],
&layer.moe.norm_weight,
&g_l,
&u_l,
&d_l,
n_heads,
self.metal_rope_layout(),
self.config.rope_theta,
self.config.rope_freqs.as_deref(),
pos,
self.config.rms_norm_eps,
&self.metal_attn_extras(layer),
) {
Ok(new_h) => {
// Catch up any dense-stack lag + this token.
Self::catch_up_host_kv_from_metal(
&metal_kvs[l],
cache,
);
layer.moe.record_activations(&[0]);
hidden = new_h;
true
}
Err(e) => {
eprintln!(
"ferrox: Metal dense layer failed, CPU fallback: {e}"
);
false
}
}
});
if dense_ok {
did_metal_dense = true;
did_metal_attn = true;
} else if metal_kvs[l].seq_len != cache.seq_len {
// Dense path may have advanced Metal KV before failing.
Self::catch_up_host_kv_from_metal(&metal_kvs[l], cache);
clear_metal_kv = true;
}
}
// Resident MoE: attn+router on GPU, host top-k only,
// then batched experts — no hidden download/upload.
if !did_metal_dense
&& !clear_metal_kv
&& ferrox_metal::attn::metal_moe_resident_enabled()
&& Self::layer_supports_metal_moe_resident(
layer,
&self.config,
)
{
if let Some(router_l) =
Self::metal_matvec_launch(&layer.moe.router)
{
let seed_ok = if metal_moe_resident {
true
} else {
match ferrox_metal::attn::moe_decode_seed(&hidden) {
Ok(()) => {
metal_moe_resident = true;
true
}
Err(e) => {
eprintln!(
"ferrox: Metal MoE seed failed: {e}"
);
false
}
}
};
if seed_ok {
// Prefer one-CB fused path (GPU top-k + packed experts).
let fused_ok = matches!(
self.config.moe.gating,
ferrox_moe::GatingFunction::Softmax
) && match &layer.moe.experts {
ExpertBacking::Resident(_) => {
if let Some(packed) =
Self::moe_packed_q4(&layer.moe)
{
match ferrox_metal::attn::launch_moe_decode_layer_fused(
&layer.attn.norm_weight,
&q_l,
&k_l,
&v_l,
&o_l,
&mut metal_kvs[l],
&layer.moe.norm_weight,
&router_l,
&packed,
self.config.moe.n_experts_active,
self.config.moe.norm_topk_prob,
n_heads,
self.metal_rope_layout(),
self.config.rope_theta,
self.config.rope_freqs.as_deref(),
pos,
self.config.rms_norm_eps,
&self.metal_attn_extras(layer),
) {
Ok(ids) => {
layer.moe.record_activations(&ids);
did_metal_moe = true;
did_metal_attn = true;
true
}
Err(e) => {
eprintln!(
"ferrox: Metal MoE fused layer failed: {e}"
);
false
}
}
} else {
false
}
}
_ => false,
};
if !fused_ok {
match ferrox_metal::attn::launch_moe_decode_pre(
&layer.attn.norm_weight,
&q_l,
&k_l,
&v_l,
&o_l,
&mut metal_kvs[l],
&layer.moe.norm_weight,
&router_l,
n_heads,
self.metal_rope_layout(),
self.config.rope_theta,
self.config.rope_freqs.as_deref(),
pos,
self.config.rms_norm_eps,
&self.metal_attn_extras(layer),
) {
Ok(logits) => {
let decision = route_top_k(
&logits,
self.config.moe.n_experts_active,
self.config.moe.gating,
self.config.moe.norm_topk_prob,
);
layer.moe.record_activations(
&decision.expert_ids,
);
if let Some(()) = Self::try_metal_moe_experts_resident(
layer,
&decision,
) {
did_metal_moe = true;
did_metal_attn = true;
} else if let Some(h) =
ferrox_metal::attn::moe_decode_take_hidden()
{
hidden = h;
metal_moe_resident = false;
// KV already advanced; finish FFN on host.
let normed2 = rms_norm(
&hidden,
&layer.moe.norm_weight,
self.config.rms_norm_eps,
);
let ffn_out = Self::combine_ffn_outputs_for_position(
layer,
&normed2,
&logits,
&self.config,
hidden_dim,
residency.as_ref().map(|p| p.layer_plan(l)),
);
for (h, f) in
hidden.iter_mut().zip(ffn_out.iter())
{
*h += f;
}
did_metal_attn = true;
did_metal_moe = true; // skip second FFN
}
}
Err(e) => {
eprintln!(
"ferrox: Metal MoE pre failed, fallback: {e}"
);
if let Some(h) =
ferrox_metal::attn::moe_decode_take_hidden()
{
hidden = h;
}
metal_moe_resident = false;
if metal_kvs[l].seq_len != cache.seq_len
{
Self::catch_up_host_kv_from_metal(
&metal_kvs[l],
cache,
);
clear_metal_kv = true;
}
}
}
}
}
}
}
if !did_metal_dense && !did_metal_moe && !clear_metal_kv {
match ferrox_metal::attn::launch_decode_attn_block(
&normed,
&q_l,
&k_l,
&v_l,
&o_l,
&mut metal_kvs[l],
n_heads,
self.metal_rope_layout(),
self.config.rope_theta,
self.config.rope_freqs.as_deref(),
pos,
&self.metal_attn_extras(layer),
self.config.rms_norm_eps,
) {
Ok(projected) => {
// Keep Metal KV authoritative — skip per-layer
// host catch-up (dense-stack style). Host is
// flushed on CPU fallback / prefix sync.
for (h, p) in
hidden.iter_mut().zip(projected.iter())
{
*h += p;
}
did_metal_attn = true;
}
Err(e) => {
eprintln!(
"ferrox: Metal attn block failed, CPU fallback: {e}"
);
Self::catch_up_host_kv_from_metal(
&metal_kvs[l],
cache,
);
clear_metal_kv = true;
}
}
}
}
} else if metal_kvs[l].seq_len > cache.seq_len {
// Leaving Metal path: host must see full KV for CPU attn.
Self::catch_up_host_kv_from_metal(&metal_kvs[l], cache);
}
}
if clear_metal_kv {
**guard = None;
}
}
if did_metal_attn {
if !did_metal_dense && !did_metal_moe {
let normed2 =
rms_norm(&hidden, &layer.moe.norm_weight, self.config.rms_norm_eps);
let ffn_out = Self::run_ffn_block(
layer,
&normed2,
&self.config,
hidden_dim,
residency.as_ref().map(|p| p.layer_plan(l)),
);
for (h, f) in hidden.iter_mut().zip(ffn_out.iter()) {
*h += f;
}
}
continue;
}
}
let (mut q, mut k, mut v) = {
#[cfg(any(feature = "cuda", feature = "metal"))]
{
if let Some(mut outs) = ferrox_core::WeightMatrix::apply_gpu_multi(
&[&layer.attn.q_proj, &layer.attn.k_proj, &layer.attn.v_proj],
&normed,
) {
let v = outs.pop().unwrap();
let k = outs.pop().unwrap();
let q = outs.pop().unwrap();
(q, k, v)
} else {
ferrox_core::weight_matrix::WeightMatrix::apply_three(
&layer.attn.q_proj,
&layer.attn.k_proj,
&layer.attn.v_proj,
&normed,
)
}
}
#[cfg(not(any(feature = "cuda", feature = "metal")))]
{
ferrox_core::weight_matrix::WeightMatrix::apply_three(
&layer.attn.q_proj,
&layer.attn.k_proj,
&layer.attn.v_proj,
&normed,
)
}
};
if let Some(bias) = &layer.attn.q_bias {
for (x, b) in q.iter_mut().zip(bias.iter()) {
*x += b;
}
}
if let Some(bias) = &layer.attn.k_bias {
for (x, b) in k.iter_mut().zip(bias.iter()) {
*x += b;
}
}
if let Some(bias) = &layer.attn.v_bias {
for (x, b) in v.iter_mut().zip(bias.iter()) {
*x += b;
}
}
if let Some(q_norm) = &layer.attn.q_norm {
q = self.apply_qk_norm(&q, q_norm);
}
if let Some(k_norm) = &layer.attn.k_norm {
k = self.apply_qk_norm(&k, k_norm);
}
self.apply_rope_attn_factor(&mut q, &mut k);
for h in 0..n_heads {
self.apply_rope_head_layer(&mut q[h * head_dim..(h + 1) * head_dim], pos, l);
}
for h in 0..n_kv_heads {
self.apply_rope_head_layer(&mut k[h * head_dim..(h + 1) * head_dim], pos, l);
}
// When an architecture overrides the score scale (llama.cpp
// Gemma scales Q then calls build_attn with 1.0), compensate
// for the kernel's built-in 1/sqrt(head_dim) so the net
// score scale equals `attention_scale`.
if let Some(scale) = self.config.attention_scale {
let compensate = scale * (head_dim as f32).sqrt();
for v in q.iter_mut() {
*v *= compensate;
}
}
cache
.push(&k, &v)
.expect("unbounded/planned KvCache growth is infallible");
let oai = self.gpt_oss.as_ref().map(|g| &g.layers[l]);
let attn_out = match (oai, self.config.layer_sliding_window(l)) {
(Some(oai), window) => ferrox_core::causal_gqa_attention_sinks(
&q,
&cache.k,
&cache.v,
n_heads,
n_kv_heads,
head_dim,
cache.seq_len,
window,
&oai.attn_sinks,
),
(None, Some(window)) => causal_gqa_attention_windowed_softcap(
&q,
&cache.k,
&cache.v,
n_heads,
n_kv_heads,
head_dim,
cache.seq_len,
window,
self.config.attn_logit_softcap,
),
(None, None) => self.gqa_attention(
l,
&q,
&cache.k,
&cache.v,
n_heads,
n_kv_heads,
head_dim,
cache.seq_len,
),
};
let mut projected = layer.attn.o_proj.apply(&attn_out);
if let Some(oai) = oai {
for (x, b) in projected.iter_mut().zip(oai.o_bias.iter()) {
*x += b;
}
}
if let Some(post) = &layer.attn.post_attn_norm {
projected = rms_norm(&projected, post, self.config.rms_norm_eps);
}
for (h, p) in hidden.iter_mut().zip(projected.iter()) {
*h += p;
}
// --- MoE FFN block ---
let normed2 = rms_norm(&hidden, &layer.moe.norm_weight, self.config.rms_norm_eps);
let mut ffn_out = match oai {
Some(oai) => Self::gpt_oss_ffn(layer, oai, &normed2, &self.config, hidden_dim),
None => Self::run_ffn_block(
layer,
&normed2,
&self.config,
hidden_dim,
residency.as_ref().map(|p| p.layer_plan(l)),
),
};
if let Some(post) = &layer.attn.post_ffn_norm {
ffn_out = rms_norm(&ffn_out, post, self.config.rms_norm_eps);
}
for (h, f) in hidden.iter_mut().zip(ffn_out.iter()) {
*h += f;
}
}
} // run_cpu_layers
#[cfg(feature = "metal")]
if metal_moe_resident {
if let Some(h) = ferrox_metal::attn::moe_decode_take_hidden() {
hidden = h;
}
}
// If Metal stack already ran final_norm, hidden is normalized; else
// normalize here.
#[cfg(feature = "metal")]
let final_normed = if final_norm_done_in_stack {
hidden.clone()
} else {
rms_norm(&hidden, &self.final_norm, self.config.rms_norm_eps)
};
#[cfg(not(feature = "metal"))]
let final_normed = rms_norm(&hidden, &self.final_norm, self.config.rms_norm_eps);
let mut logits = self.output_head.apply(&final_normed);
if let Some(sc) = self.config.final_logit_softcap {
softcap_inplace(&mut logits, sc);
}
// Clear dense-stack activation TLS after lm_head (may have consumed it).
// Keep MoE scratch buffers alive across tokens — `moe_decode_seed`
// overwrites `h` each token; clearing here forced full realloc.
#[cfg(feature = "metal")]
ferrox_metal::gpu::clear_resident_activation();
logits
}
/// Same computation as `forward_token`, but each layer's K/V cache
/// is a `PagedKvCache` (block-table-indexed into a per-layer
/// `PagedKvStore`) instead of a `KvCache`'s contiguous buffer --
/// exercises `causal_gqa_attention_paged` in a real decode loop
/// instead of only in isolation. `kv_caches`/`stores` are parallel
/// per-layer arrays, mirroring `forward_token`'s `kv_caches: &mut
/// [KvCache]`. Must produce bit-identical output to `forward_token`
/// given stores sized so no layer ever exhausts its blocks --
/// pinned by
/// `forward_token_paged_matches_forward_token_bit_identical`.
pub fn forward_token_paged(
&self,
token_id: usize,
pos: usize,
kv_caches: &mut [PagedKvCache],
stores: &mut [PagedKvStore],
) -> Result<Vec<f32>, PagedStoreExhausted> {
assert_eq!(kv_caches.len(), self.layers.len());
assert_eq!(stores.len(), self.layers.len());
// The paged kernel has no attention-sink term and no
// sliding-window arm, so running gpt-oss here would produce a
// different distribution than the contiguous path for the same
// input -- silently, and only for callers who happened to
// configure a KV pool. Refuse instead. See `Decoder::gpt_oss`.
assert!(
self.gpt_oss.is_none(),
"gpt-oss requires attention sinks; the paged-KV decode path does not implement them. \
Run this model without a KV pool (FERROX_KV_POOL_BLOCKS unset)."
);
let hidden_dim = self.config.hidden_dim;
let head_dim = self.config.head_dim;
let n_heads = self.config.n_heads;
let n_kv_heads = self.config.n_kv_heads;
let mut hidden = self.embedding.dequant_row(token_id);
let residency = self.gpu_vram_budget_bytes.map(|b| self.residency_plan(b));
for (l, ((layer, cache), store)) in self
.layers
.iter()
.zip(kv_caches.iter_mut())
.zip(stores.iter_mut())
.enumerate()
{
// --- attention block ---
let normed = rms_norm(&hidden, &layer.attn.norm_weight, self.config.rms_norm_eps);
let (mut q, mut k, mut v) = {
#[cfg(any(feature = "cuda", feature = "metal"))]
{
if let Some(mut outs) = ferrox_core::WeightMatrix::apply_gpu_multi(
&[&layer.attn.q_proj, &layer.attn.k_proj, &layer.attn.v_proj],
&normed,
) {
let v = outs.pop().unwrap();
let k = outs.pop().unwrap();
let q = outs.pop().unwrap();
(q, k, v)
} else {
ferrox_core::weight_matrix::WeightMatrix::apply_three(
&layer.attn.q_proj,
&layer.attn.k_proj,
&layer.attn.v_proj,
&normed,
)
}
}
#[cfg(not(any(feature = "cuda", feature = "metal")))]
{
(
layer.attn.q_proj.apply(&normed),
layer.attn.k_proj.apply(&normed),
layer.attn.v_proj.apply(&normed),
)
}
};
if let Some(bias) = &layer.attn.q_bias {
for (x, b) in q.iter_mut().zip(bias.iter()) {
*x += b;
}
}
if let Some(bias) = &layer.attn.k_bias {
for (x, b) in k.iter_mut().zip(bias.iter()) {
*x += b;
}
}
if let Some(bias) = &layer.attn.v_bias {
for (x, b) in v.iter_mut().zip(bias.iter()) {
*x += b;
}
}
if let Some(q_norm) = &layer.attn.q_norm {
q = self.apply_qk_norm(&q, q_norm);
}
if let Some(k_norm) = &layer.attn.k_norm {
k = self.apply_qk_norm(&k, k_norm);
}
self.apply_rope_attn_factor(&mut q, &mut k);
for h in 0..n_heads {
self.apply_rope_head_layer(&mut q[h * head_dim..(h + 1) * head_dim], pos, l);
}
for h in 0..n_kv_heads {
self.apply_rope_head_layer(&mut k[h * head_dim..(h + 1) * head_dim], pos, l);
}
cache.push(store, &k, &v)?;
let attn_out = causal_gqa_attention_paged(
&q,
store,
cache.block_table(),
n_heads,
n_kv_heads,
head_dim,
cache.seq_len(),
);
let projected = layer.attn.o_proj.apply(&attn_out);
for (h, p) in hidden.iter_mut().zip(projected.iter()) {
*h += p;
}
// --- MoE FFN block ---
let normed2 = rms_norm(&hidden, &layer.moe.norm_weight, self.config.rms_norm_eps);
let ffn_out = Self::run_ffn_block(
layer,
&normed2,
&self.config,
hidden_dim,
residency.as_ref().map(|p| p.layer_plan(l)),
);
for (h, f) in hidden.iter_mut().zip(ffn_out.iter()) {
*h += f;
}
}
let final_normed = rms_norm(&hidden, &self.final_norm, self.config.rms_norm_eps);
Ok(self.output_head.apply(&final_normed))
}
/// The shared expert store's live counters, when this model runs
/// with store-backed (streamed) routed experts -- `None` for fully
/// resident models. Every store-backed layer shares one store, so
/// the first one found speaks for the whole model.
pub fn expert_store_stats(&self) -> Option<ferrox_core::expert_store::ExpertStoreStats> {
self.layers.iter().find_map(|l| match &l.moe.experts {
ExpertBacking::Stored { store, .. } => Some(store.stats()),
ExpertBacking::Resident(_) => None,
})
}
/// Builds one global device-residency plan across ALL layers'
/// routed experts against the single configured VRAM budget --
/// every `(layer, expert)` candidate competes in one hotness-
/// ordered pass and the running byte total is shared, so the
/// budget cannot be re-spent per layer (the accounting bug the
/// earlier per-layer `placement_plan` calls had: N layers would
/// plan N x the configured bytes). Dense layers contribute no
/// candidates (their sole expert always runs on CPU). Rebuilt per
/// forward call so it tracks observed hotness; not yet
/// performance-tuned, a disclosed limit.
fn residency_plan(&self, vram_budget_bytes: u64) -> ferrox_moe::ResidencyPlan {
let mut sizes_per_layer: Vec<Vec<usize>> = Vec::with_capacity(self.layers.len());
let mut counts_per_layer: Vec<Vec<u64>> = Vec::with_capacity(self.layers.len());
let mut any_observed = false;
for layer in &self.layers {
if Self::is_dense_layer(layer) {
sizes_per_layer.push(Vec::new());
counts_per_layer.push(Vec::new());
continue;
}
sizes_per_layer.push(
(0..layer.moe.n_experts())
.map(|e| layer.moe.expert_bytes(e))
.collect(),
);
let counts: Vec<u64> = layer
.moe
.activation_counts
.iter()
.map(|c| c.load(Ordering::Relaxed))
.collect();
any_observed |= counts.iter().any(|&c| c > 0);
counts_per_layer.push(counts);
}
PlacementPlan::plan_layers_against_global_budget(
&sizes_per_layer,
any_observed.then_some(counts_per_layer.as_slice()),
vram_budget_bytes,
)
}
/// True if this layer has nothing to route: exactly one expert and
/// no shared experts, the shape every non-MoE model (and every
/// DeepSeek-style "leading dense layer") loads as. Top-1 selection
/// out of one expert always picks it, and its weight is always
/// exactly 1.0 regardless of gating function (softmax over one
/// logit is trivially 1.0; sigmoid-then-renormalize divides the
/// selected score by itself) -- so skipping the router matmul,
/// `route_top_k`'s sort/exp/renormalize work, and
/// `combine_expert_outputs`'s Vec-wrapping for this case is not an
/// approximation, it produces the exact same result.
fn is_dense_layer(layer: &LayerWeights) -> bool {
layer.moe.n_experts() == 1 && layer.moe.shared_experts.is_empty()
}
/// llama.cpp `mul_mat_id` style: shared Q8 act + flat rayon over
/// `(slot, row_pair)` for gate∥up (2-row SDOT), then SwiGLU, then
/// per-slot down. One outer fork-join — no nested `apply_cpu_q8`.
fn cpu_moe_topk_parallel_slots(
experts: &[ExpertWeights],
normed2: &[f32],
decision: &ferrox_moe::RoutingDecision,
hidden_dim: usize,
) -> Option<Vec<(Vec<f32>, f32)>> {
use rayon::prelude::*;
if !ferrox_core::weight_matrix::cpu_int_dot_enabled() || !normed2.len().is_multiple_of(32) {
return None;
}
let n_slots = decision.expert_ids.len();
if n_slots == 0 {
return Some(Vec::new());
}
for &eid in &decision.expert_ids {
let ex = experts.get(eid)?;
if ex.gate.rows() == 0
|| ex.up.rows() != ex.gate.rows()
|| ex.down.rows() != hidden_dim
|| ex.gate.cols() != normed2.len()
|| ex.up.cols() != normed2.len()
|| ex.down.cols() != ex.gate.rows()
{
return None;
}
if !matches!(
&ex.gate,
WeightMatrix::Quantized {
kind: ferrox_core::QuantKind::Q4_0 | ferrox_core::QuantKind::Q8_0,
..
}
) || !matches!(
&ex.up,
WeightMatrix::Quantized {
kind: ferrox_core::QuantKind::Q4_0 | ferrox_core::QuantKind::Q8_0,
..
}
) {
return None;
}
}
let ffn_rows = experts[decision.expert_ids[0]].gate.rows();
// Even ffn_rows: par_chunks_mut(2) never crosses a slot boundary.
if !ffn_rows.is_multiple_of(2) {
return None;
}
let act = ferrox_quant::quantize_activations_q8(normed2);
let eids = &decision.expert_ids;
let mut gate = vec![0f32; n_slots * ffn_rows];
let mut up = vec![0f32; n_slots * ffn_rows];
gate.par_chunks_mut(2)
.zip(up.par_chunks_mut(2))
.enumerate()
.for_each(|(p, (gc, uc))| {
let row0 = p * 2;
let slot = row0 / ffn_rows;
let r = row0 % ffn_rows;
let ex = &experts[eids[slot]];
if let (Some((g0, g1)), Some((u0, u1))) = (
ex.gate.dot_pair_cpu_q8(r, &act),
ex.up.dot_pair_cpu_q8(r, &act),
) {
gc[0] = g0;
gc[1] = g1;
uc[0] = u0;
uc[1] = u1;
} else {
gc[0] = ex.gate.dot_row_cpu_q8(r, &act).unwrap_or(0.0);
gc[1] = ex.gate.dot_row_cpu_q8(r + 1, &act).unwrap_or(0.0);
uc[0] = ex.up.dot_row_cpu_q8(r, &act).unwrap_or(0.0);
uc[1] = ex.up.dot_row_cpu_q8(r + 1, &act).unwrap_or(0.0);
}
});
let mut activated = vec![0f32; n_slots * ffn_rows];
activated.par_iter_mut().enumerate().for_each(|(idx, a)| {
let g = gate[idx];
*a = (g / (1.0 + (-g).exp())) * up[idx];
});
let mut outs: Vec<(Vec<f32>, f32)> = decision
.weights
.iter()
.map(|&w| (vec![0f32; hidden_dim], w))
.collect();
outs.par_iter_mut()
.enumerate()
.for_each(|(slot, (out, _))| {
let ex = &experts[eids[slot]];
let act_slot = &activated[slot * ffn_rows..(slot + 1) * ffn_rows];
if act_slot.len().is_multiple_of(32) {
let q8 = ferrox_quant::quantize_activations_q8(act_slot);
if let Some(d) = ex.down.apply_cpu_q8(&q8) {
*out = d;
return;
}
}
*out = ex.down.apply(act_slot);
});
Some(outs)
}
/// Fallback: serial top-k with shared Q8 act (pre-mul_mat_id path).
fn cpu_moe_serial_experts(
layer: &LayerWeights,
normed2: &[f32],
decision: &ferrox_moe::RoutingDecision,
plan: Option<&PlacementPlan>,
) -> Vec<(Vec<f32>, f32)> {
let shared_act = if ferrox_core::weight_matrix::cpu_int_dot_enabled()
&& normed2.len().is_multiple_of(32)
&& plan
.map(|p| {
decision
.expert_ids
.iter()
.all(|&eid| matches!(p.placement_for(eid), ExpertPlacement::Cpu))
})
.unwrap_or(true)
{
Some(ferrox_quant::quantize_activations_q8(normed2))
} else {
None
};
decision
.expert_ids
.iter()
.zip(decision.weights.iter())
.map(|(&eid, &w)| {
let placement = plan
.map(|p| p.placement_for(eid))
.unwrap_or(ExpertPlacement::Cpu);
let out = layer.moe.with_expert(eid, |ex| {
if let Some(ref act) = shared_act {
if let (Some(gate), Some(up)) =
(ex.gate.apply_cpu_q8(act), ex.up.apply_cpu_q8(act))
{
let activated = ferrox_core::matmul::swiglu(&gate, &up);
return ex.down.apply(&activated);
}
}
run_expert_placed(normed2, ex, placement)
});
(out, w)
})
.collect()
}
/// Runs one position's normalized hidden state through this
/// layer's MoE FFN block, given already-computed router logits for
/// that position, returning the combined output to add back into
/// the residual stream. Shared by `forward_token` (router computed
/// via a single `apply` call, since there's only one position) and
/// `forward_batch`'s per-position loop (router computed via one
/// batched `apply_batch` call up front, sliced per position here --
/// see `forward_batch`'s doc comment for why that batching matters
/// and must not be lost by calling this per position instead).
/// `gpu_vram_budget_bytes`: see `Decoder::gpu_vram_budget_bytes`'s
/// doc comment -- `None` dispatches every routed expert through
/// `run_expert_placed` with `ExpertPlacement::Cpu`, which is
/// exactly `run_expert`'s own behavior, so this is a real
/// zero-behavior-change default, not just "probably fine."
fn combine_ffn_outputs_for_position(
layer: &LayerWeights,
normed2: &[f32],
router_logits: &[f32],
config: &ModelConfig,
hidden_dim: usize,
plan: Option<&PlacementPlan>,
) -> Vec<f32> {
let decision = match (
config.moe.expert_group_count,
config.moe.expert_group_used_count,
) {
(Some(n_groups), Some(k_per_group)) if n_groups > 1 && k_per_group > 0 => {
ferrox_moe::route_top_k_grouped(
router_logits,
n_groups,
k_per_group,
config.moe.n_experts_active,
config.moe.gating,
config.moe.norm_topk_prob,
)
}
_ => route_top_k(
router_logits,
config.moe.n_experts_active,
config.moe.gating,
config.moe.norm_topk_prob,
),
};
layer.moe.record_activations(&decision.expert_ids);
// Best-effort warm of the routed experts for this layer into
// the store cache (SSD streaming overlap). Resident-backed
// layers skip this entirely.
if let ExpertBacking::Stored {
store,
layer: layer_id,
..
} = &layer.moe.experts
{
let keys: Vec<ferrox_core::expert_store::ExpertKey> = decision
.expert_ids
.iter()
.map(|&eid| ferrox_core::expert_store::ExpertKey {
layer: *layer_id,
expert: eid as u32,
})
.collect();
store.prefetch(&keys);
}
// Metal: fuse all top-k experts into one CB (one wait) when every
// routed expert has Metal matvec launches. Shared experts (rare
// for OLMoE) still run on the host after.
#[cfg(feature = "metal")]
if ferrox_core::metal_dense_enabled()
&& matches!(
config.ffn_activation,
crate::config::FfnActivation::Swiglu | crate::config::FfnActivation::SwigluFused
)
&& layer.moe.shared_experts.is_empty()
{
if let Some(fused) = Self::try_metal_moe_topk(layer, normed2, &decision) {
return fused;
}
}
let routed_outputs: Vec<(Vec<f32>, f32)> = {
// llama.cpp mul_mat_id: one shared Q8 act + flat (slot,row)
// parallel over all top-k experts (not serial expert loops each
// with their own rayon fork-join).
let all_cpu = plan
.map(|p| {
decision
.expert_ids
.iter()
.all(|&eid| matches!(p.placement_for(eid), ExpertPlacement::Cpu))
})
.unwrap_or(true);
if let (true, ExpertBacking::Resident(experts)) = (all_cpu, &layer.moe.experts) {
if let Some(outs) =
Self::cpu_moe_topk_parallel_slots(experts, normed2, &decision, hidden_dim)
{
outs
} else {
Self::cpu_moe_serial_experts(layer, normed2, &decision, plan)
}
} else {
Self::cpu_moe_serial_experts(layer, normed2, &decision, plan)
}
};
// Shared experts fire on every token regardless of routing, so
// there's no offload decision to make for them the way there
// is for routed experts -- always CPU, matching `run_expert`.
let mut shared_outputs: Vec<Vec<f32>> = layer
.moe
.shared_experts
.iter()
.map(|e| run_expert(normed2, e))
.collect();
// Qwen2-MoE-specific: see `MoeWeights::shared_expert_gate`'s doc
// comment. Scaling here (before `combine_expert_outputs`, which
// is architecture-agnostic and knows nothing about this gate)
// keeps the gate a decoder-level detail, not a ferrox-moe API
// change.
if let Some(gate) = &layer.moe.shared_expert_gate {
let gate_logit: f32 = gate.iter().zip(normed2.iter()).map(|(g, x)| g * x).sum();
let gate_value = 1.0 / (1.0 + (-gate_logit).exp());
for out in shared_outputs.iter_mut() {
for x in out.iter_mut() {
*x *= gate_value;
}
}
}
combine_expert_outputs(&routed_outputs, &shared_outputs, hidden_dim)
}
/// The dense FFN for a whole batch of positions in three batched
/// matmuls (gate, up, down) instead of three per position.
///
/// This is the counterpart of what `forward_hidden_batch` already
/// did for Q/K/V and the router, and it is where a dense model's
/// prefill time actually goes: `WeightMatrix::apply_batch` reads
/// each weight row once and dots it against every position, rather
/// than re-reading the whole FFN for each one.
///
/// `None` for anything that is not a plain dense layer -- MoE
/// routing is per position by construction, so those keep the
/// sequential path.
///
/// On a GPU backend the per-position alternative is one *fused*
/// gate+up+SiLU+down launch (`apply_gpu_dense_ffn_swiglu`), so this
/// used to be gated off there: three separate batched launches lost
/// to it while `apply_batch` was still a batched *matvec*.
///
/// That stopped being true once the simdgroup GEMM landed, and the
/// old gate turned out to be the dominant cost of Metal prefill --
/// a 512-token prompt ran the FFN one position at a time, 512 x
/// n_layers fused launches, which a profile put at 90% of prefill
/// while the GEMM it bypassed accounted for 21%.
///
/// Decode (`batch_size == 1`) still takes the fused per-position
/// launch, which is the right shape there.
fn dense_ffn_batch(
layer: &LayerWeights,
normed2_batch: &[f32],
batch_size: usize,
config: &ModelConfig,
) -> Option<Vec<f32>> {
// Match the GPU `mul_mm` threshold: below it the per-call launch
// overhead outweighs the weight reuse.
if !Self::is_dense_layer(layer) || batch_size < 4 {
return None;
}
// On a GPU backend this only wins when the weights have a real
// batched GEMM; otherwise `apply_batch` is a batched matvec and
// loses to the fused per-position launch.
#[cfg(any(feature = "metal", feature = "cuda"))]
{
#[cfg(feature = "metal")]
let gpu_dense = ferrox_core::weight_matrix::metal_dense_enabled();
#[cfg(not(feature = "metal"))]
let gpu_dense = false;
#[cfg(feature = "cuda")]
let gpu_dense = gpu_dense || ferrox_core::weight_matrix::cuda_dense_enabled();
if gpu_dense {
let all_gemm = layer.moe.with_expert(0, |ex| {
ex.gate.prefers_gpu_batch()
&& ex.up.prefers_gpu_batch()
&& ex.down.prefers_gpu_batch()
});
if !all_gemm {
return None;
}
}
}
layer.moe.record_activations(&[0]);
// One command buffer for the whole FFN when every matrix has a
// simdgroup GEMM: gate and up feed the activation and the down
// projection without the intermediates ever touching the host.
// Three separate launches cost three round trips per layer plus
// four copies of a `batch x ffn_dim` tensor.
#[cfg(feature = "metal")]
if ferrox_core::weight_matrix::metal_dense_enabled() {
let gelu = matches!(config.ffn_activation, crate::config::FfnActivation::Gelu);
let fused = layer.moe.with_expert(0, |ex| {
let (g, u, d) = (
ex.gate.mul_mm_sg_launch()?,
ex.up.mul_mm_sg_launch()?,
ex.down.mul_mm_sg_launch()?,
);
ferrox_metal::gpu::launch_dense_ffn_swiglu_batch(
&g,
&u,
&d,
normed2_batch,
batch_size,
gelu,
)
.ok()
});
if let Some(out) = fused {
return Some(out);
}
}
Some(layer.moe.with_expert(0, |ex| {
let ffn_acts = ex.gate.quantize_batch_acts(normed2_batch, batch_size);
let gate = ex
.gate
.apply_batch_with_acts(normed2_batch, batch_size, ffn_acts.as_ref());
let up = ex
.up
.apply_batch_with_acts(normed2_batch, batch_size, ffn_acts.as_ref());
let activated: Vec<f32> = match config.ffn_activation {
crate::config::FfnActivation::Swiglu
| crate::config::FfnActivation::SwigluFused => {
ferrox_core::matmul::swiglu(&gate, &up)
}
crate::config::FfnActivation::Gelu => geglu(&gate, &up),
};
ex.down.apply_batch(&activated, batch_size)
}))
}
/// CPU MoE prefill: bucket tokens by expert, then one
/// `apply_batch` per expert with tokens instead of per-token
/// `combine_ffn_outputs_for_position`. Shared experts append via
/// [`Self::accumulate_shared_experts_batch`]. `None` when gates fail
/// (small batch, dense, Metal preferred, non-SwiGLU, non-resident,
/// or any GPU-placed expert).
fn moe_ffn_batch(
layer: &LayerWeights,
normed2_batch: &[f32],
router_logits_batch: &[f32],
batch_size: usize,
hidden_dim: usize,
config: &ModelConfig,
plan: Option<&PlacementPlan>,
) -> Option<Vec<f32>> {
if batch_size < 32 || Self::is_dense_layer(layer) {
return None;
}
// Metal prefill owns MoE when dense Metal is on
// (`try_metal_moe_prefill_batch`); do not steal the path.
#[cfg(feature = "metal")]
if ferrox_core::metal_dense_enabled() {
return None;
}
if !matches!(
config.ffn_activation,
crate::config::FfnActivation::Swiglu | crate::config::FfnActivation::SwigluFused
) {
return None;
}
let ExpertBacking::Resident(experts) = &layer.moe.experts else {
return None;
};
let n_experts = experts.len();
let all_cpu = plan
.map(|p| (0..n_experts).all(|eid| matches!(p.placement_for(eid), ExpertPlacement::Cpu)))
.unwrap_or(true);
if !all_cpu || n_experts == 0 {
return None;
}
let mut buckets: Vec<Vec<(usize, f32)>> = vec![Vec::new(); n_experts];
for b in 0..batch_size {
let logits = &router_logits_batch[b * n_experts..(b + 1) * n_experts];
let decision = match (
config.moe.expert_group_count,
config.moe.expert_group_used_count,
) {
(Some(n_groups), Some(k_per_group)) if n_groups > 1 && k_per_group > 0 => {
ferrox_moe::route_top_k_grouped(
logits,
n_groups,
k_per_group,
config.moe.n_experts_active,
config.moe.gating,
config.moe.norm_topk_prob,
)
}
_ => route_top_k(
logits,
config.moe.n_experts_active,
config.moe.gating,
config.moe.norm_topk_prob,
),
};
layer.moe.record_activations(&decision.expert_ids);
for (&eid, &w) in decision.expert_ids.iter().zip(decision.weights.iter()) {
buckets[eid].push((b, w));
}
}
let mut acc = vec![0f32; batch_size * hidden_dim];
for (eid, toks) in buckets.iter().enumerate() {
if toks.is_empty() {
continue;
}
let n = toks.len();
let mut gathered = vec![0f32; n * hidden_dim];
for (i, &(tok, _)) in toks.iter().enumerate() {
gathered[i * hidden_dim..(i + 1) * hidden_dim]
.copy_from_slice(&normed2_batch[tok * hidden_dim..(tok + 1) * hidden_dim]);
}
let ex = &experts[eid];
let ffn_acts = ex.gate.quantize_batch_acts(&gathered, n);
let gate = ex
.gate
.apply_batch_with_acts(&gathered, n, ffn_acts.as_ref());
let up = ex.up.apply_batch_with_acts(&gathered, n, ffn_acts.as_ref());
let activated = ferrox_core::matmul::swiglu(&gate, &up);
let down = ex.down.apply_batch(&activated, n);
for (i, &(tok, w)) in toks.iter().enumerate() {
let out = &down[i * hidden_dim..(i + 1) * hidden_dim];
let row = &mut acc[tok * hidden_dim..(tok + 1) * hidden_dim];
for (a, &o) in row.iter_mut().zip(out.iter()) {
*a += w * o;
}
}
}
Self::accumulate_shared_experts_batch(
layer,
normed2_batch,
batch_size,
hidden_dim,
&mut acc,
);
Some(acc)
}
/// gpt-oss's MoE FFN for one position.
///
/// A separate function rather than another branch inside
/// `combine_ffn_outputs_for_position` on purpose: that path carries
/// expert-store prefetch, residency placement, a Metal top-k fusion
/// and a batched parallel-slot kernel, and every one of them would
/// need its own gpt-oss variant to stay honest. This is the whole
/// gpt-oss FFN in one readable block, checked end-to-end against
/// llama.cpp, and slow — routed experts run serially. It is the
/// correct-first shape; making it fast is a separate change with its
/// own A/B, not something to smuggle in under a correctness fix.
///
/// Ported from `llama-graph.cpp::build_moe_ffn` with
/// `gating_op = LLAMA_EXPERT_GATING_FUNC_TYPE_SOFTMAX_WEIGHT`,
/// `type_op = LLM_FFN_SWIGLU_OAI_MOE`, `norm_w = false`,
/// `w_scale = 1`, all four bias tensors present.
fn gpt_oss_ffn(
layer: &LayerWeights,
oai: &GptOssLayer,
normed2: &[f32],
config: &ModelConfig,
hidden_dim: usize,
) -> Vec<f32> {
let mut router_logits = layer.moe.router.apply(normed2);
for (x, b) in router_logits.iter_mut().zip(oai.router_bias.iter()) {
*x += b;
}
// Selection on the raw biased logits, softmax over the winners
// only -- see `route_top_k_softmax_weight`.
let decision =
ferrox_moe::route_top_k_softmax_weight(&router_logits, config.moe.n_experts_active);
layer.moe.record_activations(&decision.expert_ids);
let mut out = vec![0f32; hidden_dim];
for (slot, &eid) in decision.expert_ids.iter().enumerate() {
let w = decision.weights[slot];
let expert_out = layer.moe.with_expert(eid, |ex| {
ferrox_moe::run_expert_oai(
normed2,
ex,
&oai.expert_bias[eid],
ferrox_moe::SWIGLU_OAI_ALPHA,
ferrox_moe::SWIGLU_OAI_LIMIT,
)
});
for (o, e) in out.iter_mut().zip(expert_out.iter()) {
*o += w * e;
}
}
out
}
/// `forward_token`'s MoE FFN block for one position: the dense
/// fast path (see `is_dense_layer`) or the full router+combine path
/// with the router computed inline via a single-position `apply`.
fn run_ffn_block(
layer: &LayerWeights,
normed2: &[f32],
config: &ModelConfig,
hidden_dim: usize,
plan: Option<&PlacementPlan>,
) -> Vec<f32> {
if Self::is_dense_layer(layer) {
layer.moe.record_activations(&[0]);
return layer.moe.with_expert(0, |ex| match config.ffn_activation {
crate::config::FfnActivation::Swiglu
| crate::config::FfnActivation::SwigluFused => run_expert(normed2, ex),
crate::config::FfnActivation::Gelu => {
// Share one Q8 act quant across gate+up when INT_DOT
// can serve both (Q8_0 / Q4_0); else two `.apply`s.
if ferrox_core::weight_matrix::cpu_int_dot_enabled()
&& normed2.len().is_multiple_of(32)
{
let act = ferrox_quant::quantize_activations_q8(normed2);
if let (Some(gate), Some(up)) =
(ex.gate.apply_cpu_q8(&act), ex.up.apply_cpu_q8(&act))
{
let activated = geglu(&gate, &up);
return ex.down.apply(&activated);
}
}
let gate = ex.gate.apply(normed2);
let up = ex.up.apply(normed2);
let activated = geglu(&gate, &up);
ex.down.apply(&activated)
}
});
}
let router_logits = layer.moe.router.apply(normed2);
Self::combine_ffn_outputs_for_position(
layer,
normed2,
&router_logits,
config,
hidden_dim,
plan,
)
}
/// Processes multiple new positions in one call instead of calling
/// `forward_token` once per position. `tokens[i]` is the token at
/// absolute position `start_pos + i`; all positions attend
/// causally (position `i` sees positions `0..=i` of this batch
/// plus everything already in `kv_caches`, nothing later).
///
/// The attention block's Q/K/V/O projections and the MoE router
/// are computed as batched matmuls (`WeightMatrix::apply_batch`),
/// which for quantized weights means each weight row is read from
/// memory once and dotted against every position in the batch,
/// not once per position -- see `apply_batch`'s doc comment for
/// why that's a real memory-bandwidth saving, not just fewer
/// function calls. The expert FFN stage is *not* batched: which
/// expert(s) a position routes to is data-dependent per position,
/// so positions routed to different experts can't share a single
/// matmul the way the shared Q/K/V/router projections can. RoPE
/// and attention itself (causal masking, softmax) are also
/// per-position, since they're cheap relative to the matmuls and
/// batching them would add complexity for little benefit.
///
/// This is what makes prompt-lookup speculative decoding
/// (`speculative` module) actually save work rather than just
/// reshuffle it: verifying `k` draft tokens costs one batched call
/// here, not `k` calls to `forward_token`.
///
/// Thin wrapper over [`Self::forward_hidden_batch`] + `output_head`.
pub fn forward_batch(
&self,
tokens: &[usize],
start_pos: usize,
kv_caches: &mut [KvCache],
) -> Vec<Vec<f32>> {
let hiddens = self.forward_hidden_batch(tokens, start_pos, kv_caches);
if hiddens.is_empty() {
return Vec::new();
}
let batch_size = hiddens.len();
let vocab_size = self.output_head.rows();
let flat: Vec<f32> = hiddens.into_iter().flatten().collect();
let mut logits_batch = self.output_head.apply_batch(&flat, batch_size);
if let Some(sc) = self.config.final_logit_softcap {
softcap_inplace(&mut logits_batch, sc);
}
logits_batch
.chunks(vocab_size)
.map(|c| c.to_vec())
.collect()
}
/// [`Self::forward_batch`] for the common case where only the final
/// position's logits are wanted: prefill a prompt, then sample the
/// next token. Runs `output_head` on **one** row instead of all
/// `batch_size` of them.
///
/// The KV cache and every hidden state are identical either way —
/// only the vocabulary projection is skipped, and only for rows
/// whose logits the caller was going to drop. That projection is not
/// a rounding error: it is `[batch x hidden] x [hidden x vocab]`,
/// which for a large-vocabulary model with a small body is a large
/// share of prefill. `V*H / (V*H + L*P_layer)` comes to 30% on
/// Gemma-3-1B, 21% on Llama-3.2-1B and SmolLM2, 23% on Gemma-2-2B.
/// llama.cpp does not do this work at all during `pp512` —
/// `llama_batch_get_one` leaves `logits` unset, so `inp_out_ids`
/// selects a single row.
///
/// [`Self::forward_batch`] stays for the callers that genuinely need
/// every row: speculative verification checks each draft position,
/// and `/v1/embeddings` pools over all of them.
pub fn forward_batch_last(
&self,
tokens: &[usize],
start_pos: usize,
kv_caches: &mut [KvCache],
) -> Vec<f32> {
let hiddens = self.forward_hidden_batch(tokens, start_pos, kv_caches);
let Some(last) = hiddens.last() else {
return Vec::new();
};
let mut logits = self.output_head.apply(last);
if let Some(sc) = self.config.final_logit_softcap {
softcap_inplace(&mut logits, sc);
}
logits
}
/// Like [`Self::forward_batch`], but returns final RMS-normed hidden
/// states (pre-`output_head`) — one `hidden_dim` vector per input
/// token. Used by `/v1/embeddings` pooling (mean / last).
pub fn forward_hidden_batch(
&self,
tokens: &[usize],
start_pos: usize,
kv_caches: &mut [KvCache],
) -> Vec<Vec<f32>> {
assert_eq!(kv_caches.len(), self.layers.len());
let batch_size = tokens.len();
if batch_size == 0 {
return Vec::new();
}
let hidden_dim = self.config.hidden_dim;
let head_dim = self.config.head_dim;
let n_heads = self.config.n_heads;
let n_kv_heads = self.config.n_kv_heads;
// [batch, hidden], flattened row-major.
let mut hidden_batch: Vec<f32> = tokens
.iter()
.flat_map(|&t| self.embedding.dequant_row(t))
.collect();
if let Some(scale) = self.config.embedding_scale {
for v in hidden_batch.iter_mut() {
*v *= scale;
}
}
#[cfg(feature = "metal")]
let use_metal_attn = ferrox_core::metal_dense_enabled()
&& ferrox_metal::attn::metal_attn_enabled()
&& self
.layers
.iter()
.all(|l| self.layer_supports_metal_attn(l));
#[cfg(not(feature = "metal"))]
let use_metal_attn = false;
let residency = self.expert_residency_plan(use_metal_attn);
#[cfg(feature = "metal")]
let mut metal_kv_guard: Option<
std::sync::MutexGuard<'_, Option<Vec<ferrox_metal::attn::MetalKvBuffers>>>,
> = if use_metal_attn {
Some(self.metal_attn_kv.lock().unwrap())
} else {
None
};
#[cfg(feature = "metal")]
if let Some(guard) = metal_kv_guard.as_mut() {
let need = self.layers.len();
let need_cap = start_pos
.saturating_add(batch_size)
.saturating_add(256)
.max(512);
let reset = match guard.as_ref() {
None => true,
Some(v) => {
v.len() != need
|| v.iter().any(|m| m.capacity() < need_cap)
|| v.iter()
.zip(kv_caches.iter())
.any(|(m, c)| m.seq_len != c.seq_len)
}
};
if reset {
let mut bufs = Vec::with_capacity(need);
for _ in 0..need {
match ferrox_metal::attn::MetalKvBuffers::with_capacity(
n_kv_heads, head_dim, need_cap,
) {
Ok(b) => bufs.push(b),
Err(_) => {
**guard = None;
break;
}
}
}
if bufs.len() == need {
let mut ok = true;
for (m, c) in bufs.iter_mut().zip(kv_caches.iter()) {
if c.seq_len > 0 && m.upload_from_host(&c.k, &c.v, c.seq_len).is_err() {
ok = false;
break;
}
}
if ok {
**guard = Some(bufs);
} else {
**guard = None;
}
} else {
**guard = None;
}
}
}
let n_layers = self.layers.len();
let mut l = 0usize;
while l < n_layers {
let layer = &self.layers[l];
let q_width = n_heads * head_dim;
let kv_width = n_kv_heads * head_dim;
// Multi-layer dense prefill: one CB, activations stay on GPU.
#[cfg(feature = "metal")]
if use_metal_attn && batch_size >= 4 {
if let Some(guard) = metal_kv_guard.as_mut() {
if let Some(metal_kvs) = guard.as_mut() {
if let Some(run_len) = self.metal_prefill_dense_stack_run_len(
l,
start_pos,
batch_size,
kv_caches,
Some(metal_kvs.as_slice()),
) {
if let Some(h_out) = self.try_metal_prefill_dense_stack(
l,
run_len,
&hidden_batch,
start_pos,
batch_size,
n_heads,
metal_kvs,
kv_caches,
) {
hidden_batch = h_out;
l += run_len;
continue;
}
}
}
}
}
let cache = &mut kv_caches[l];
// One-CB dense prefill (RMSNorm→QKV GEMM→attn→O→FFN) when every
// projection has mul_mm_sg and the layer has no QKV bias / QK-norm.
#[cfg(feature = "metal")]
if use_metal_attn && batch_size >= 4 && Self::metal_prefill_dense_layer_eligible(layer)
{
let swa_fits = self.metal_prefill_dense_swa_fits(l, start_pos, batch_size);
if swa_fits {
if let Some(guard) = metal_kv_guard.as_mut() {
if let Some(metal_kvs) = guard.as_mut() {
if metal_kvs[l].seq_len == cache.seq_len && start_pos == cache.seq_len {
layer.moe.record_activations(&[0]);
let fused = layer.moe.with_expert(0, |ex| {
let (q, k, v, o) = (
layer.attn.q_proj.mul_mm_sg_launch()?,
layer.attn.k_proj.mul_mm_sg_launch()?,
layer.attn.v_proj.mul_mm_sg_launch()?,
layer.attn.o_proj.mul_mm_sg_launch()?,
);
let ffn = ferrox_metal::attn::PrefillFfnMetal::Dense {
gate: ex.gate.mul_mm_sg_launch()?,
up: ex.up.mul_mm_sg_launch()?,
down: ex.down.mul_mm_sg_launch()?,
};
let gelu = matches!(
self.config.ffn_activation,
crate::config::FfnActivation::Gelu
);
let prefill_layer =
ferrox_metal::attn::PrefillDenseLayerMetal {
attn_norm_w: &layer.attn.norm_weight,
ffn_norm_w: &layer.moe.norm_weight,
q,
k,
v,
o,
ffn,
post_attn_norm: layer.attn.post_attn_norm.as_deref(),
post_ffn_norm: layer.attn.post_ffn_norm.as_deref(),
extras: self.metal_attn_extras(layer),
layer_idx: l as u32,
};
ferrox_metal::attn::launch_prefill_dense_layer(
&hidden_batch,
&prefill_layer,
&mut metal_kvs[l],
n_heads,
batch_size,
self.metal_rope_layout(),
self.config.layer_rope_theta(l),
self.config.rope_freqs.as_deref(),
start_pos,
self.config.rms_norm_eps,
gelu,
self.config.attn_logit_softcap,
)
.ok()
});
if let Some(h_out) = fused {
cache
.advance_len(batch_size)
.expect("unbounded/planned KvCache growth is infallible");
hidden_batch = h_out;
l += 1;
continue;
}
}
}
}
}
}
// --- attention block ---
let normed_batch: Vec<f32> = hidden_batch
.par_chunks(hidden_dim)
.map(|h| rms_norm(h, &layer.attn.norm_weight, self.config.rms_norm_eps))
.flatten()
.collect();
// One shared activation-quant pass for q/k/v (plan 1e): the
// three projections read the same normed batch, so quantize it
// once instead of once per projection. A kind mismatch inside
// the group just re-quantizes locally.
let qkv_acts = layer
.attn
.q_proj
.quantize_batch_acts(&normed_batch, batch_size);
let mut q_batch = layer.attn.q_proj.apply_batch_with_acts(
&normed_batch,
batch_size,
qkv_acts.as_ref(),
);
let mut k_batch = layer.attn.k_proj.apply_batch_with_acts(
&normed_batch,
batch_size,
qkv_acts.as_ref(),
);
let mut v_batch = layer.attn.v_proj.apply_batch_with_acts(
&normed_batch,
batch_size,
qkv_acts.as_ref(),
);
drop(qkv_acts);
if let Some(bias) = &layer.attn.q_bias {
for row in q_batch.chunks_mut(q_width) {
for (x, b) in row.iter_mut().zip(bias.iter()) {
*x += b;
}
}
}
if let Some(bias) = &layer.attn.k_bias {
for row in k_batch.chunks_mut(kv_width) {
for (x, b) in row.iter_mut().zip(bias.iter()) {
*x += b;
}
}
}
if let Some(bias) = &layer.attn.v_bias {
for row in v_batch.chunks_mut(kv_width) {
for (x, b) in row.iter_mut().zip(bias.iter()) {
*x += b;
}
}
}
if let Some(q_norm) = &layer.attn.q_norm {
for row in q_batch.chunks_mut(q_width) {
let normed = self.apply_qk_norm(row, q_norm);
row.copy_from_slice(&normed);
}
}
if let Some(k_norm) = &layer.attn.k_norm {
for row in k_batch.chunks_mut(kv_width) {
let normed = self.apply_qk_norm(row, k_norm);
row.copy_from_slice(&normed);
}
}
self.apply_rope_attn_factor(&mut q_batch, &mut k_batch);
#[cfg(feature = "metal")]
{
let mut did_metal_prefill = false;
// The Metal prefill kernel is full-causal: only safe on a
// SWA layer while every causal position is still inside
// the window. Longer prompts fall back to CPU attention.
let swa_fits = match self.config.layer_sliding_window(l) {
Some(window) => start_pos + batch_size <= window,
None => true,
};
// Metal prefill applies attn softcap in FA-vec / legacy GQA.
if let Some(guard) = metal_kv_guard.as_mut() {
if let Some(metal_kvs) = guard.as_mut() {
if metal_kvs[l].seq_len == cache.seq_len
&& start_pos == cache.seq_len
&& swa_fits
{
let prefill_res = {
let o_launch = Self::metal_matvec_launch(&layer.attn.o_proj);
// Prefill O fusion: opt-in. Default off until
// fair-chat prompt_per_s proves a win without
// decode noise (Host B contention-sensitive).
let fuse_o = matches!(
std::env::var("FERROX_METAL_PREFILL_FUSE_O").ok().as_deref(),
Some("1") | Some("true") | Some("on")
) && o_launch.as_ref().is_some_and(|o| {
o.fn_name == "q4_0_matvec"
&& o.block_bytes == 18
&& layer.attn.post_attn_norm.is_none()
});
if fuse_o {
let o = o_launch.as_ref().unwrap();
ferrox_metal::attn::launch_prefill_attn_o_residual(
&q_batch,
&k_batch,
&v_batch,
&hidden_batch,
o,
&mut metal_kvs[l],
n_heads,
batch_size,
self.metal_rope_layout(),
self.config.layer_rope_theta(l),
self.config.rope_freqs.as_deref(),
start_pos,
self.config.attn_logit_softcap,
)
.map(|h_out| {
cache.advance_len(batch_size).expect(
"unbounded/planned KvCache growth is infallible",
);
hidden_batch = h_out;
true
})
} else {
ferrox_metal::attn::launch_prefill_attn_block(
&q_batch,
&k_batch,
&v_batch,
&mut metal_kvs[l],
n_heads,
batch_size,
self.metal_rope_layout(),
self.config.layer_rope_theta(l),
self.config.rope_freqs.as_deref(),
start_pos,
self.config.attn_logit_softcap,
false,
)
.map(
|(attn_out_batch, _, _)| {
cache.advance_len(batch_size).expect(
"unbounded/planned KvCache growth is infallible",
);
let projected_batch = layer
.attn
.o_proj
.apply_batch(&attn_out_batch, batch_size);
let projected_batch =
if let Some(post) = &layer.attn.post_attn_norm {
projected_batch
.chunks(hidden_dim)
.flat_map(|row| {
rms_norm(
row,
post,
self.config.rms_norm_eps,
)
})
.collect::<Vec<_>>()
} else {
projected_batch
};
for (h, p) in
hidden_batch.iter_mut().zip(projected_batch.iter())
{
*h += p;
}
true
},
)
}
};
match prefill_res {
Ok(true) => {
did_metal_prefill = true;
}
Ok(false) => {}
Err(e) => {
eprintln!(
"ferrox: Metal prefill attn failed, CPU fallback: {e}"
);
**guard = None;
}
}
}
}
}
if did_metal_prefill {
// --- MoE FFN block (batched Metal when packed Q4) ---
let normed2_batch: Vec<f32> = hidden_batch
.chunks(hidden_dim)
.flat_map(|h| rms_norm(h, &layer.moe.norm_weight, self.config.rms_norm_eps))
.collect();
let dense = Self::is_dense_layer(layer);
let router_logits_batch = if dense {
Vec::new()
} else {
layer.moe.router.apply_batch(&normed2_batch, batch_size)
};
let metal_ffn = if !dense {
Self::try_metal_moe_prefill_batch(
layer,
&normed2_batch,
&router_logits_batch,
batch_size,
hidden_dim,
&self.config,
)
} else {
None
};
if let Some(mut ffn_batch) = metal_ffn {
if let Some(post) = &layer.attn.post_ffn_norm {
ffn_batch = ffn_batch
.chunks(hidden_dim)
.flat_map(|row| rms_norm(row, post, self.config.rms_norm_eps))
.collect();
}
for (h, f) in hidden_batch.iter_mut().zip(ffn_batch.iter()) {
*h += f;
}
} else if let Some(mut ffn_batch) =
Self::dense_ffn_batch(layer, &normed2_batch, batch_size, &self.config)
{
if let Some(post) = &layer.attn.post_ffn_norm {
ffn_batch = ffn_batch
.chunks(hidden_dim)
.flat_map(|row| rms_norm(row, post, self.config.rms_norm_eps))
.collect();
}
for (h, f) in hidden_batch.iter_mut().zip(ffn_batch.iter()) {
*h += f;
}
} else if let Some(mut ffn_batch) = Self::moe_ffn_batch(
layer,
&normed2_batch,
&router_logits_batch,
batch_size,
hidden_dim,
&self.config,
residency.as_ref().map(|p| p.layer_plan(l)),
) {
if let Some(post) = &layer.attn.post_ffn_norm {
ffn_batch = ffn_batch
.chunks(hidden_dim)
.flat_map(|row| rms_norm(row, post, self.config.rms_norm_eps))
.collect();
}
for (h, f) in hidden_batch.iter_mut().zip(ffn_batch.iter()) {
*h += f;
}
} else {
let n_experts = layer.moe.n_experts().max(1);
for b in 0..batch_size {
let normed2 = &normed2_batch[b * hidden_dim..(b + 1) * hidden_dim];
let mut ffn_out = if dense {
Self::run_ffn_block(
layer,
normed2,
&self.config,
hidden_dim,
residency.as_ref().map(|p| p.layer_plan(l)),
)
} else {
let router_logits =
&router_logits_batch[b * n_experts..(b + 1) * n_experts];
Self::combine_ffn_outputs_for_position(
layer,
normed2,
router_logits,
&self.config,
hidden_dim,
residency.as_ref().map(|p| p.layer_plan(l)),
)
};
if let Some(post) = &layer.attn.post_ffn_norm {
ffn_out = rms_norm(&ffn_out, post, self.config.rms_norm_eps);
}
let hidden_row =
&mut hidden_batch[b * hidden_dim..(b + 1) * hidden_dim];
for (h, f) in hidden_row.iter_mut().zip(ffn_out.iter()) {
*h += f;
}
}
}
l += 1;
continue;
}
}
// RoPE per token is independent; parallelize for CPU pp512.
q_batch
.par_chunks_mut(q_width)
.zip(k_batch.par_chunks_mut(kv_width))
.enumerate()
.for_each(|(b, (q_row, k_row))| {
let pos = start_pos + b;
for h in 0..n_heads {
self.apply_rope_head_layer(
&mut q_row[h * head_dim..(h + 1) * head_dim],
pos,
l,
);
}
for h in 0..n_kv_heads {
self.apply_rope_head_layer(
&mut k_row[h * head_dim..(h + 1) * head_dim],
pos,
l,
);
}
});
let base_seq_len = cache.seq_len;
for b in 0..batch_size {
cache
.push(
&k_batch[b * kv_width..(b + 1) * kv_width],
&v_batch[b * kv_width..(b + 1) * kv_width],
)
.expect("unbounded/planned KvCache growth is infallible");
}
// Prefill attention over the just-written KV prefix. Parallel
// over query positions — the serial loop was a dominant CPU
// pp512 bottleneck (each query still attends only its causal
// prefix; K/V slices are immutable after the pushes above).
let cache_k = &cache.k;
let cache_v = &cache.v;
let softcap = self.config.attn_logit_softcap;
let window = self.config.layer_sliding_window(l);
let oai = self.gpt_oss.as_ref().map(|g| &g.layers[l]);
// gpt-oss takes the per-query path on every layer, windowed
// or not: the blocked kernel has no sink term. Everything
// else goes through the blocked kernel, which is Rayon over
// `[query-block x head]` against one shared KV buffer,
// windowed or not. SWA layers used to take a per-query
// `causal_gqa_attention_windowed_softcap` instead, which is
// `online_attn_accumulate`: two scalar `exp` and a
// head_dim-wide rescale per KV position, with the head axis
// serial inside each task. On Gemma-3-1B (22 of 26 layers
// are SWA) that arm was 19.6% of non-idle CPU `pp512`
// samples while doing the *same* KV work as this one - at
// `pp512` the 512-wide window covers the whole prompt.
let attn_out_batch = if let Some(oai) = oai {
let mut out = vec![0f32; batch_size * q_width];
out.par_chunks_mut(q_width)
.enumerate()
.for_each(|(b, dest)| {
let seq_len_b = base_seq_len + b + 1;
let cache_elems = seq_len_b * kv_width;
let attn_out = ferrox_core::causal_gqa_attention_sinks(
&q_batch[b * q_width..(b + 1) * q_width],
&cache_k[..cache_elems],
&cache_v[..cache_elems],
n_heads,
n_kv_heads,
head_dim,
seq_len_b,
window,
&oai.attn_sinks,
);
dest.copy_from_slice(&attn_out);
});
out
} else {
causal_gqa_attention_prefill_shared_kv_windowed(
&q_batch,
cache_k,
cache_v,
n_heads,
n_kv_heads,
head_dim,
batch_size,
base_seq_len,
softcap,
window,
)
};
let mut projected_batch = layer.attn.o_proj.apply_batch(&attn_out_batch, batch_size);
if let Some(oai) = oai {
for row in projected_batch.chunks_mut(hidden_dim) {
for (x, b) in row.iter_mut().zip(oai.o_bias.iter()) {
*x += b;
}
}
}
let projected_batch = if let Some(post) = &layer.attn.post_attn_norm {
projected_batch
.chunks(hidden_dim)
.flat_map(|row| rms_norm(row, post, self.config.rms_norm_eps))
.collect::<Vec<_>>()
} else {
projected_batch
};
for (h, p) in hidden_batch.iter_mut().zip(projected_batch.iter()) {
*h += p;
}
// --- MoE FFN block ---
let normed2_batch: Vec<f32> = hidden_batch
.par_chunks(hidden_dim)
.map(|h| rms_norm(h, &layer.moe.norm_weight, self.config.rms_norm_eps))
.flatten()
.collect();
if let Some(oai) = oai {
// gpt-oss: one position at a time through the single
// validated FFN. None of the batched fast paths below
// knows about router bias, expert bias or swiglu_oai.
for b in 0..batch_size {
let normed2 = &normed2_batch[b * hidden_dim..(b + 1) * hidden_dim];
let ffn_out = Self::gpt_oss_ffn(layer, oai, normed2, &self.config, hidden_dim);
let hidden_row = &mut hidden_batch[b * hidden_dim..(b + 1) * hidden_dim];
for (h, f) in hidden_row.iter_mut().zip(ffn_out.iter()) {
*h += f;
}
}
l += 1;
continue;
}
let dense = Self::is_dense_layer(layer);
// Skip the batched router matmul entirely for a dense
// layer -- there's nothing to route (see
// `is_dense_layer`'s doc comment), so computing it here
// just to ignore it below would waste the one matmul this
// fast path exists to avoid.
let router_logits_batch = if dense {
Vec::new()
} else {
layer.moe.router.apply_batch(&normed2_batch, batch_size)
};
#[cfg(feature = "metal")]
let metal_ffn = if !dense {
Self::try_metal_moe_prefill_batch(
layer,
&normed2_batch,
&router_logits_batch,
batch_size,
hidden_dim,
&self.config,
)
} else {
None
};
#[cfg(not(feature = "metal"))]
let metal_ffn: Option<Vec<f32>> = None;
if let Some(mut ffn_batch) = metal_ffn {
if let Some(post) = &layer.attn.post_ffn_norm {
ffn_batch = ffn_batch
.chunks(hidden_dim)
.flat_map(|row| rms_norm(row, post, self.config.rms_norm_eps))
.collect();
}
for (h, f) in hidden_batch.iter_mut().zip(ffn_batch.iter()) {
*h += f;
}
} else if let Some(mut ffn_batch) =
Self::dense_ffn_batch(layer, &normed2_batch, batch_size, &self.config)
{
// Dense FFN, batched. Without this the FFN -- the
// majority of a dense model's prefill work -- ran one
// position at a time while Q/K/V and the router were
// already batched, which is why `pp512` measured about
// the same as `tg128`.
if let Some(post) = &layer.attn.post_ffn_norm {
ffn_batch = ffn_batch
.chunks(hidden_dim)
.flat_map(|row| rms_norm(row, post, self.config.rms_norm_eps))
.collect();
}
for (h, f) in hidden_batch.iter_mut().zip(ffn_batch.iter()) {
*h += f;
}
} else if let Some(mut ffn_batch) = Self::moe_ffn_batch(
layer,
&normed2_batch,
&router_logits_batch,
batch_size,
hidden_dim,
&self.config,
residency.as_ref().map(|p| p.layer_plan(l)),
) {
if let Some(post) = &layer.attn.post_ffn_norm {
ffn_batch = ffn_batch
.chunks(hidden_dim)
.flat_map(|row| rms_norm(row, post, self.config.rms_norm_eps))
.collect();
}
for (h, f) in hidden_batch.iter_mut().zip(ffn_batch.iter()) {
*h += f;
}
} else {
let n_experts = layer.moe.n_experts().max(1);
for b in 0..batch_size {
let normed2 = &normed2_batch[b * hidden_dim..(b + 1) * hidden_dim];
let mut ffn_out = if dense {
Self::run_ffn_block(
layer,
normed2,
&self.config,
hidden_dim,
residency.as_ref().map(|p| p.layer_plan(l)),
)
} else {
let router_logits =
&router_logits_batch[b * n_experts..(b + 1) * n_experts];
Self::combine_ffn_outputs_for_position(
layer,
normed2,
router_logits,
&self.config,
hidden_dim,
residency.as_ref().map(|p| p.layer_plan(l)),
)
};
if let Some(post) = &layer.attn.post_ffn_norm {
ffn_out = rms_norm(&ffn_out, post, self.config.rms_norm_eps);
}
let hidden_row = &mut hidden_batch[b * hidden_dim..(b + 1) * hidden_dim];
for (h, f) in hidden_row.iter_mut().zip(ffn_out.iter()) {
*h += f;
}
}
}
l += 1;
}
hidden_batch
.chunks(hidden_dim)
.map(|h| rms_norm(h, &self.final_norm, self.config.rms_norm_eps))
.collect()
}
/// Continuous-batching primitive: one decode step across N
/// independent *sequences*, each contributing exactly one new
/// token at its own current position, sharing every layer's
/// projection/router matmuls the same way `forward_batch` shares
/// them across positions of a single sequence -- but each
/// sequence keeps its own `KvCache`, independent `seq_len`, and
/// independent position, so sequences admitted/evicted at
/// different times can still share one batched matmul per step
/// (this is what "continuous" batching means: the batch
/// membership can change every step, unlike `forward_batch`'s
/// fixed-size prompt-processing batch). `kv_caches[s][l]` is
/// sequence `s`'s layer-`l` cache; `tokens[s]`/`positions[s]` is
/// that sequence's next token and its position within its own
/// history. Returns one logits vector per sequence, same order as
/// `tokens`.
///
/// Must produce bit-identical output to calling `forward_token`
/// once per sequence with that sequence's own cache/position --
/// batching independent sequences together is a scheduling detail,
/// not a math change (no sequence's attention ever reads another
/// sequence's cache).
pub fn forward_multi_seq(
&self,
tokens: &[usize],
positions: &[usize],
kv_caches: &mut [Vec<KvCache>],
) -> Vec<Vec<f32>> {
assert_eq!(tokens.len(), positions.len());
assert_eq!(tokens.len(), kv_caches.len());
let batch_size = tokens.len();
if batch_size == 0 {
return Vec::new();
}
for seq in kv_caches.iter() {
assert_eq!(seq.len(), self.layers.len());
}
let hidden_dim = self.config.hidden_dim;
let head_dim = self.config.head_dim;
let n_heads = self.config.n_heads;
let n_kv_heads = self.config.n_kv_heads;
// [batch, hidden], flattened row-major.
let mut hidden_batch: Vec<f32> = tokens
.iter()
.flat_map(|&t| self.embedding.dequant_row(t))
.collect();
if let Some(scale) = self.config.embedding_scale {
for v in hidden_batch.iter_mut() {
*v *= scale;
}
}
let residency = self.gpu_vram_budget_bytes.map(|b| self.residency_plan(b));
for (l, layer) in self.layers.iter().enumerate() {
// --- attention block ---
let normed_batch: Vec<f32> = hidden_batch
.par_chunks(hidden_dim)
.map(|h| rms_norm(h, &layer.attn.norm_weight, self.config.rms_norm_eps))
.flatten()
.collect();
// One shared activation-quant pass for q/k/v (plan 1e): the
// three projections read the same normed batch, so quantize it
// once instead of once per projection. A kind mismatch inside
// the group just re-quantizes locally.
let qkv_acts = layer
.attn
.q_proj
.quantize_batch_acts(&normed_batch, batch_size);
let mut q_batch = layer.attn.q_proj.apply_batch_with_acts(
&normed_batch,
batch_size,
qkv_acts.as_ref(),
);
let mut k_batch = layer.attn.k_proj.apply_batch_with_acts(
&normed_batch,
batch_size,
qkv_acts.as_ref(),
);
let mut v_batch = layer.attn.v_proj.apply_batch_with_acts(
&normed_batch,
batch_size,
qkv_acts.as_ref(),
);
drop(qkv_acts);
let q_width = n_heads * head_dim;
let kv_width = n_kv_heads * head_dim;
if let Some(bias) = &layer.attn.q_bias {
for row in q_batch.chunks_mut(q_width) {
for (x, b) in row.iter_mut().zip(bias.iter()) {
*x += b;
}
}
}
if let Some(bias) = &layer.attn.k_bias {
for row in k_batch.chunks_mut(kv_width) {
for (x, b) in row.iter_mut().zip(bias.iter()) {
*x += b;
}
}
}
if let Some(bias) = &layer.attn.v_bias {
for row in v_batch.chunks_mut(kv_width) {
for (x, b) in row.iter_mut().zip(bias.iter()) {
*x += b;
}
}
}
if let Some(q_norm) = &layer.attn.q_norm {
for row in q_batch.chunks_mut(q_width) {
let normed = self.apply_qk_norm(row, q_norm);
row.copy_from_slice(&normed);
}
}
if let Some(k_norm) = &layer.attn.k_norm {
for row in k_batch.chunks_mut(kv_width) {
let normed = self.apply_qk_norm(row, k_norm);
row.copy_from_slice(&normed);
}
}
self.apply_rope_attn_factor(&mut q_batch, &mut k_batch);
for b in 0..batch_size {
let pos = positions[b];
let q_row = &mut q_batch[b * q_width..(b + 1) * q_width];
for h in 0..n_heads {
self.apply_rope_head_layer(
&mut q_row[h * head_dim..(h + 1) * head_dim],
pos,
l,
);
}
let k_row = &mut k_batch[b * kv_width..(b + 1) * kv_width];
for h in 0..n_kv_heads {
self.apply_rope_head_layer(
&mut k_row[h * head_dim..(h + 1) * head_dim],
pos,
l,
);
}
}
let oai = self.gpt_oss.as_ref().map(|g| &g.layers[l]);
let mut attn_out_batch = vec![0f32; batch_size * q_width];
for b in 0..batch_size {
let cache = &mut kv_caches[b][l];
cache
.push(
&k_batch[b * kv_width..(b + 1) * kv_width],
&v_batch[b * kv_width..(b + 1) * kv_width],
)
.expect("unbounded/planned KvCache growth is infallible");
if let Some(oai) = oai {
let attn_out = ferrox_core::causal_gqa_attention_sinks(
&q_batch[b * q_width..(b + 1) * q_width],
&cache.k,
&cache.v,
n_heads,
n_kv_heads,
head_dim,
cache.seq_len,
self.config.layer_sliding_window(l),
&oai.attn_sinks,
);
attn_out_batch[b * q_width..(b + 1) * q_width].copy_from_slice(&attn_out);
continue;
}
let attn_out = match self.config.layer_sliding_window(l) {
Some(window) => causal_gqa_attention_windowed_softcap(
&q_batch[b * q_width..(b + 1) * q_width],
&cache.k,
&cache.v,
n_heads,
n_kv_heads,
head_dim,
cache.seq_len,
window,
self.config.attn_logit_softcap,
),
None => causal_gqa_attention_softcap(
&q_batch[b * q_width..(b + 1) * q_width],
&cache.k,
&cache.v,
n_heads,
n_kv_heads,
head_dim,
cache.seq_len,
self.config.attn_logit_softcap,
),
};
attn_out_batch[b * q_width..(b + 1) * q_width].copy_from_slice(&attn_out);
}
let mut projected_batch = layer.attn.o_proj.apply_batch(&attn_out_batch, batch_size);
if let Some(oai) = oai {
for row in projected_batch.chunks_mut(hidden_dim) {
for (x, b) in row.iter_mut().zip(oai.o_bias.iter()) {
*x += b;
}
}
}
let projected_batch = if let Some(post) = &layer.attn.post_attn_norm {
projected_batch
.chunks(hidden_dim)
.flat_map(|row| rms_norm(row, post, self.config.rms_norm_eps))
.collect::<Vec<_>>()
} else {
projected_batch
};
for (h, p) in hidden_batch.iter_mut().zip(projected_batch.iter()) {
*h += p;
}
// --- MoE FFN block ---
let normed2_batch: Vec<f32> = hidden_batch
.par_chunks(hidden_dim)
.map(|h| rms_norm(h, &layer.moe.norm_weight, self.config.rms_norm_eps))
.flatten()
.collect();
let dense = Self::is_dense_layer(layer);
let router_logits_batch = if dense || oai.is_some() {
Vec::new()
} else {
layer.moe.router.apply_batch(&normed2_batch, batch_size)
};
let n_experts = layer.moe.n_experts().max(1);
for b in 0..batch_size {
let normed2 = &normed2_batch[b * hidden_dim..(b + 1) * hidden_dim];
let mut ffn_out = if let Some(oai) = oai {
Self::gpt_oss_ffn(layer, oai, normed2, &self.config, hidden_dim)
} else if dense {
Self::run_ffn_block(
layer,
normed2,
&self.config,
hidden_dim,
residency.as_ref().map(|p| p.layer_plan(l)),
)
} else {
let router_logits = &router_logits_batch[b * n_experts..(b + 1) * n_experts];
Self::combine_ffn_outputs_for_position(
layer,
normed2,
router_logits,
&self.config,
hidden_dim,
residency.as_ref().map(|p| p.layer_plan(l)),
)
};
if let Some(post) = &layer.attn.post_ffn_norm {
ffn_out = rms_norm(&ffn_out, post, self.config.rms_norm_eps);
}
let hidden_row = &mut hidden_batch[b * hidden_dim..(b + 1) * hidden_dim];
for (h, f) in hidden_row.iter_mut().zip(ffn_out.iter()) {
*h += f;
}
}
}
let vocab_size = self.output_head.rows();
let final_normed_batch: Vec<f32> = hidden_batch
.par_chunks(hidden_dim)
.map(|h| rms_norm(h, &self.final_norm, self.config.rms_norm_eps))
.flatten()
.collect();
let mut logits_batch = self
.output_head
.apply_batch(&final_normed_batch, batch_size);
if let Some(sc) = self.config.final_logit_softcap {
softcap_inplace(&mut logits_batch, sc);
}
logits_batch
.chunks(vocab_size)
.map(|c| c.to_vec())
.collect()
}
}
#[cfg(test)]
mod partial_rotary_tests {
use super::*;
/// Phi-3/Phi-4 rotate `rope.dimension_count` of each head and pass
/// the rest through. The tail staying bit-identical is the whole
/// property: rotating it would make dimensions position-dependent
/// that the model never trained that way.
#[test]
fn partial_rotary_leaves_the_tail_untouched() {
let mut cfg = crate::config::test_dense_fixture();
cfg.head_dim = 8;
cfg.rope_layout = crate::config::RopeLayout::Neox;
cfg.rope_freqs = None;
cfg.rope_dim = Some(4);
let decoder = Decoder::new_random_small(cfg, 1, 32);
let mut head: Vec<f32> = (0..8).map(|i| 1.0 + i as f32).collect();
let before = head.clone();
decoder.apply_rope_head_theta(&mut head, 3, 10000.0);
assert_eq!(
&head[4..],
&before[4..],
"dims at or past rope_dim must not rotate"
);
assert!(
head[..4] != before[..4],
"dims below rope_dim must rotate at a non-zero position"
);
}
/// `attn_factor` is a magnitude scale folded into cos/sin inside
/// ggml's `rope_yarn`, so it can only ever touch the rotated
/// channels. The pass-through tail must come out bit-identical —
/// scaling it is a different graph, and it was one, until
/// `ferrox parity` reported Phi-4-mini as the single DRIFT in a
/// 17-model sweep against llama.cpp.
#[test]
fn attn_factor_scales_only_the_rotated_channels() {
let mut cfg = crate::config::test_dense_fixture();
cfg.head_dim = 8;
cfg.n_heads = 2;
cfg.n_kv_heads = 2;
cfg.rope_dim = Some(4);
cfg.rope_attn_factor = 2.0;
let decoder = Decoder::new_random_small(cfg, 1, 32);
// Two heads, so a per-head slice bug cannot hide behind a single
// head that happens to span the whole buffer.
let mut q: Vec<f32> = (0..16).map(|i| 1.0 + i as f32).collect();
let mut k: Vec<f32> = (0..16).map(|i| 1.0 + i as f32).collect();
let before = q.clone();
decoder.apply_rope_attn_factor(&mut q, &mut k);
for h in 0..2 {
let base = h * 8;
for i in 0..4 {
assert_eq!(
q[base + i],
before[base + i] * 2.0,
"rotated channel {i} of head {h} must be scaled"
);
}
for i in 4..8 {
assert_eq!(
q[base + i],
before[base + i],
"pass-through channel {i} of head {h} must be untouched"
);
}
}
assert_eq!(q, k, "q and k take the same magnitude scale");
}
/// With no partial rotary the whole head is rotated, so the whole
/// head takes the scale — the narrow case must not become the rule.
#[test]
fn attn_factor_scales_the_whole_head_without_partial_rotary() {
let mut cfg = crate::config::test_dense_fixture();
cfg.head_dim = 8;
cfg.n_heads = 1;
cfg.n_kv_heads = 1;
cfg.rope_dim = None;
cfg.rope_attn_factor = 3.0;
let decoder = Decoder::new_random_small(cfg, 1, 32);
let mut q: Vec<f32> = (0..8).map(|i| 1.0 + i as f32).collect();
let mut k = q.clone();
let before = q.clone();
decoder.apply_rope_attn_factor(&mut q, &mut k);
for i in 0..8 {
assert_eq!(q[i], before[i] * 3.0);
}
}
/// The same call with no `rope_dim` must rotate everything, so the
/// narrow case cannot silently become the default.
#[test]
fn full_rotary_still_rotates_the_whole_head() {
let mut cfg = crate::config::test_dense_fixture();
cfg.head_dim = 8;
cfg.rope_layout = crate::config::RopeLayout::Neox;
cfg.rope_freqs = None;
cfg.rope_dim = None;
let decoder = Decoder::new_random_small(cfg, 1, 32);
let mut head: Vec<f32> = (0..8).map(|i| 1.0 + i as f32).collect();
let before = head.clone();
decoder.apply_rope_head_theta(&mut head, 3, 10000.0);
assert!(head[4..] != before[4..]);
}
/// `mscale` scales q and k and nothing else; `1.0` must be a literal
/// no-op so every other model pays nothing.
#[test]
fn rope_attn_factor_scales_q_and_k_only() {
let mut cfg = crate::config::test_dense_fixture();
cfg.rope_attn_factor = 2.0;
let decoder = Decoder::new_random_small(cfg, 1, 32);
let mut q = vec![1.0f32, -2.0, 3.0];
let mut k = vec![0.5f32, 4.0];
decoder.apply_rope_attn_factor(&mut q, &mut k);
assert_eq!(q, vec![2.0, -4.0, 6.0]);
assert_eq!(k, vec![1.0, 8.0]);
let mut cfg = crate::config::test_dense_fixture();
cfg.rope_attn_factor = 1.0;
let decoder = Decoder::new_random_small(cfg, 1, 32);
let mut q = vec![1.0f32, -2.0];
let mut k = vec![3.0f32];
decoder.apply_rope_attn_factor(&mut q, &mut k);
assert_eq!(q, vec![1.0, -2.0]);
assert_eq!(k, vec![3.0]);
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::config::glm_5_2;
/// Small config used purely to keep the test fast: same
/// architecture *shape* (GQA ratio, MoE topology) as GLM-5.2, but
/// with tiny dims so the whole thing runs in milliseconds.
fn tiny_test_config() -> ModelConfig {
let mut cfg = glm_5_2();
cfg.hidden_dim = 16;
cfg.n_heads = 4;
cfg.n_kv_heads = 2;
cfg.head_dim = 4;
cfg.moe.hidden_dim = 16;
cfg.moe.n_experts = 6;
cfg.moe.n_experts_active = 2;
cfg.moe.n_shared_experts = 1;
cfg.moe.expert_ffn_dim = 8;
cfg
}
#[test]
fn forward_pass_produces_finite_logits_of_correct_shape() {
let vocab = 10;
let decoder = Decoder::new_random_small(tiny_test_config(), 2, vocab);
let mut caches: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder.config.n_kv_heads, decoder.config.head_dim))
.collect();
let logits = decoder.forward_token(3, 0, &mut caches);
assert_eq!(logits.len(), vocab);
assert!(
logits.iter().all(|v| v.is_finite()),
"logits must not contain NaN/Inf"
);
}
/// `gpu_vram_budget_bytes` must be a real zero-behavior-change
/// default at `None`, and a *real placement plan that places
/// nothing* (a zero VRAM budget, so `PlacementPlan::from_budget`
/// fits no expert at all) must produce byte-identical output to
/// `None` too -- proving the new plumbing (building a plan,
/// looking up each routed expert's placement, dispatching through
/// `run_expert_placed`) doesn't change results when nothing is
/// actually GPU-placed, without needing real CUDA hardware to
/// check (that hardware-dependent half is
/// `ferrox-moe`'s/`ferrox-core`'s own `#[ignore]`d tests).
#[test]
fn gpu_vram_budget_bytes_with_nothing_placed_matches_the_default() {
let mut decoder = Decoder::new_random_small(tiny_test_config(), 2, 10);
let mut caches_default: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder.config.n_kv_heads, decoder.config.head_dim))
.collect();
let default_logits = decoder.forward_token(3, 0, &mut caches_default);
decoder.gpu_vram_budget_bytes = Some(0);
let mut caches_zero_budget: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder.config.n_kv_heads, decoder.config.head_dim))
.collect();
let zero_budget_logits = decoder.forward_token(3, 0, &mut caches_zero_budget);
assert_eq!(
default_logits, zero_budget_logits,
"a placement plan that places nothing on GPU must match the None default exactly"
);
}
/// Qwen2-MoE's real shared-expert sigmoid gate
/// (`MoeWeights::shared_expert_gate`): exact math check by mutating
/// `layer.moe.shared_expert_gate` in place on an already-built
/// decoder (no need to reconstruct a `LayerWeights`/`MoeWeights`
/// from scratch) and comparing against a hand-derived expectation:
/// the *only* thing the gate changes is the shared experts' own
/// contribution, scaled by `sigmoid(gate . x)` -- so
/// `gated_shared_output == ungated_shared_output * sigmoid_value`
/// exactly, computed independently here via `run_expert` on the
/// same layer's shared expert.
#[test]
fn shared_expert_gate_scales_shared_output_by_sigmoid_of_the_gate_logit() {
let cfg = tiny_test_config();
let mut decoder = Decoder::new_random_small(cfg, 2, 8);
let hidden_dim = decoder.config.hidden_dim;
assert_eq!(
decoder.layers[1].moe.shared_experts.len(),
1,
"test assumes tiny_test_config's real MoE layer has exactly one shared expert"
);
let normed2: Vec<f32> = (0..hidden_dim).map(|i| (i as f32 * 0.37).sin()).collect();
let gate_vec: Vec<f32> = (0..hidden_dim).map(|i| i as f32 * 0.13 - 0.5).collect();
// Independently compute what the shared expert alone produces,
// and what sigmoid(gate . x) should scale it by -- this is the
// ground truth the gated code path must reproduce exactly.
let shared_out_raw = run_expert(&normed2, &decoder.layers[1].moe.shared_experts[0]);
let gate_logit: f32 = gate_vec
.iter()
.zip(normed2.iter())
.map(|(g, x)| g * x)
.sum();
let gate_value = 1.0 / (1.0 + (-gate_logit).exp());
let expected_gated_shared: Vec<f32> =
shared_out_raw.iter().map(|x| x * gate_value).collect();
// Run the real FFN combine path twice (gate absent, then
// present) and recover each run's shared-only contribution by
// subtracting the routed contribution, which the gate never
// touches and is identical between the two runs (same router,
// same experts, same input).
let router_logits = decoder.layers[1].moe.router.apply(&normed2);
let ungated_total = Decoder::combine_ffn_outputs_for_position(
&decoder.layers[1],
&normed2,
&router_logits,
&decoder.config,
hidden_dim,
None,
);
decoder.layers[1].moe.shared_expert_gate = Some(gate_vec);
let gated_total = Decoder::combine_ffn_outputs_for_position(
&decoder.layers[1],
&normed2,
&router_logits,
&decoder.config,
hidden_dim,
None,
);
for (i, ((u, g), expected_shared)) in ungated_total
.iter()
.zip(gated_total.iter())
.zip(expected_gated_shared.iter())
.enumerate()
{
let routed_contribution = u - shared_out_raw[i];
let gated_shared_recovered = g - routed_contribution;
assert!(
(gated_shared_recovered - expected_shared).abs() < 1e-4,
"index {i}: recovered gated shared output {gated_shared_recovered} != expected {expected_shared} (sigmoid({gate_logit})={gate_value})"
);
}
}
#[test]
fn kv_cache_grows_by_one_position_per_layer_per_step() {
let decoder = Decoder::new_random_small(tiny_test_config(), 3, 5);
let mut caches: Vec<KvCache> = (0..3)
.map(|_| KvCache::new(decoder.config.n_kv_heads, decoder.config.head_dim))
.collect();
decoder.forward_token(0, 0, &mut caches);
decoder.forward_token(1, 1, &mut caches);
decoder.forward_token(2, 2, &mut caches);
for cache in &caches {
assert_eq!(cache.seq_len, 3);
}
}
#[test]
fn same_token_same_position_is_deterministic() {
let decoder = Decoder::new_random_small(tiny_test_config(), 2, 8);
let mut caches_a: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder.config.n_kv_heads, decoder.config.head_dim))
.collect();
let mut caches_b: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder.config.n_kv_heads, decoder.config.head_dim))
.collect();
let out_a = decoder.forward_token(4, 0, &mut caches_a);
let out_b = decoder.forward_token(4, 0, &mut caches_b);
assert_eq!(out_a, out_b, "identical input state must yield identical output (no hidden randomness in the forward pass)");
}
#[test]
fn multi_step_decode_stays_finite_across_positions() {
let decoder = Decoder::new_random_small(tiny_test_config(), 2, 8);
let mut caches: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder.config.n_kv_heads, decoder.config.head_dim))
.collect();
for pos in 0..16 {
let logits = decoder.forward_token(pos % 8, pos, &mut caches);
assert!(
logits.iter().all(|v| v.is_finite()),
"position {pos}: logits must stay finite across an extended decode run"
);
}
}
/// `forward_token_paged` must produce bit-identical output to
/// `forward_token` across a multi-step decode (each layer's paged
/// store sized generously so no layer ever exhausts its blocks) --
/// the block-table indirection is a storage-layout detail, not a
/// math change.
#[test]
fn forward_token_paged_matches_forward_token_bit_identical() {
let n_layers = 2;
let decoder = Decoder::new_random_small(tiny_test_config(), n_layers, 10);
let mut caches: Vec<KvCache> = (0..n_layers)
.map(|_| KvCache::new(decoder.config.n_kv_heads, decoder.config.head_dim))
.collect();
let mut plain_logits = Vec::new();
for (pos, &tok) in [3usize, 5, 7].iter().enumerate() {
plain_logits.push(decoder.forward_token(tok, pos, &mut caches));
}
let block_size = 2;
let mut paged_caches: Vec<PagedKvCache> =
(0..n_layers).map(|_| PagedKvCache::new()).collect();
let mut stores: Vec<PagedKvStore> = (0..n_layers)
.map(|_| {
PagedKvStore::new(
block_size,
/* total_blocks = */ 16,
decoder.config.n_kv_heads,
decoder.config.head_dim,
)
})
.collect();
let mut paged_logits = Vec::new();
for (pos, &tok) in [3usize, 5, 7].iter().enumerate() {
paged_logits.push(
decoder
.forward_token_paged(tok, pos, &mut paged_caches, &mut stores)
.expect("store sized generously, must not exhaust"),
);
}
assert_eq!(plain_logits.len(), paged_logits.len());
for (a, b) in plain_logits.iter().zip(paged_logits.iter()) {
assert_eq!(a.len(), b.len());
for (x, y) in a.iter().zip(b.iter()) {
assert_eq!(
x.to_bits(),
y.to_bits(),
"paged decode must be bit-identical to contiguous decode"
);
}
}
}
/// The single most important correctness property of
/// `forward_batch`: batching positions together for shared matmuls
/// must produce EXACTLY the same result as processing them one at
/// a time with `forward_token`, since causal masking guarantees
/// position `i` only ever sees positions `<= i`. If this test
/// fails, `forward_batch` is not a safe drop-in replacement for
/// sequential decode, which would make speculative decoding built
/// on top of it produce silently wrong output.
#[test]
fn forward_batch_matches_sequential_forward_token_exactly() {
let cfg = tiny_test_config();
let vocab = 8;
let tokens = [1usize, 3, 5, 2, 7];
let decoder_a = Decoder::new_random_small(cfg.clone(), 2, vocab);
let mut caches_a: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder_a.config.n_kv_heads, decoder_a.config.head_dim))
.collect();
let sequential: Vec<Vec<f32>> = tokens
.iter()
.enumerate()
.map(|(pos, &t)| decoder_a.forward_token(t, pos, &mut caches_a))
.collect();
// A second decoder built with the same seed produces identical
// weights (Decoder::new_random_small is deterministic), so
// this is a fair like-for-like comparison against a fresh
// cache rather than reusing decoder_a's now-mutated cache.
let decoder_b = Decoder::new_random_small(cfg, 2, vocab);
let mut caches_b: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder_b.config.n_kv_heads, decoder_b.config.head_dim))
.collect();
let batched = decoder_b.forward_batch(&tokens, 0, &mut caches_b);
assert_eq!(batched.len(), sequential.len());
for (pos, (seq_logits, batch_logits)) in sequential.iter().zip(batched.iter()).enumerate() {
assert_eq!(seq_logits.len(), batch_logits.len());
for (i, (s, b)) in seq_logits.iter().zip(batch_logits.iter()).enumerate() {
assert!(
(s - b).abs() < 1e-3,
"position {pos}, logit {i}: sequential={s} batched={b}"
);
}
}
}
/// `forward_batch_last` exists to skip the vocabulary projection for
/// every position but the last, so the one thing that must hold is
/// that the row it *does* produce is the same row `forward_batch`
/// would have produced. It must also leave the KV cache in the same
/// state -- prefill's whole purpose -- which is checked by decoding
/// one more token from each cache and comparing.
#[test]
fn forward_batch_last_matches_the_final_row_of_forward_batch() {
let cfg = tiny_test_config();
let vocab = 16;
let tokens = vec![1usize, 4, 7, 2, 9];
let decoder_a = Decoder::new_random_small(cfg.clone(), 2, vocab);
let mut caches_a: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder_a.config.n_kv_heads, decoder_a.config.head_dim))
.collect();
let all_rows = decoder_a.forward_batch(&tokens, 0, &mut caches_a);
let decoder_b = Decoder::new_random_small(cfg, 2, vocab);
let mut caches_b: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder_b.config.n_kv_heads, decoder_b.config.head_dim))
.collect();
let last = decoder_b.forward_batch_last(&tokens, 0, &mut caches_b);
let expected = all_rows.last().expect("one row per prompt token");
assert_eq!(last.len(), expected.len());
for (i, (a, b)) in expected.iter().zip(last.iter()).enumerate() {
assert!(
(a - b).abs() < 1e-4,
"logit {i}: forward_batch={a} forward_batch_last={b}"
);
}
// Same KV state: the next token's logits must agree too.
let next_a = decoder_a.forward_token(3, tokens.len(), &mut caches_a);
let next_b = decoder_b.forward_token(3, tokens.len(), &mut caches_b);
for (i, (a, b)) in next_a.iter().zip(next_b.iter()).enumerate() {
assert!(
(a - b).abs() < 1e-4,
"post-prefill decode logit {i}: {a} vs {b}"
);
}
// Empty prompt is the degenerate case both paths must survive.
let mut caches_c: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder_b.config.n_kv_heads, decoder_b.config.head_dim))
.collect();
assert!(decoder_b
.forward_batch_last(&[], 0, &mut caches_c)
.is_empty());
}
/// `forward_multi_seq`'s core correctness property: batching N
/// independent sequences (different token histories, different
/// current positions, different KV caches) together must produce
/// EXACTLY the same per-sequence output as running each sequence
/// through `forward_token` alone, one step at a time. This is what
/// makes continuous batching safe -- no sequence's attention may
/// ever be perturbed by another sequence sharing its batched
/// matmul step.
#[test]
fn forward_multi_seq_matches_independent_forward_token_per_sequence() {
let cfg = tiny_test_config();
let vocab = 8;
// 3 independent sequences, deliberately different lengths/
// histories/current tokens, so no two sequences are at the
// same position when batched together.
let seq_histories: [&[usize]; 3] = [&[1, 3, 5], &[2, 7], &[4, 4, 4, 6]];
let decoder_a = Decoder::new_random_small(cfg.clone(), 2, vocab);
let mut independent_logits: Vec<Vec<f32>> = Vec::new();
for history in seq_histories.iter() {
let mut caches: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder_a.config.n_kv_heads, decoder_a.config.head_dim))
.collect();
let mut logits = Vec::new();
for (pos, &tok) in history.iter().enumerate() {
logits = decoder_a.forward_token(tok, pos, &mut caches);
}
independent_logits.push(logits);
}
// Same seed -> identical weights, fresh caches for a fair
// comparison (mirrors forward_batch_matches_sequential_forward_token_exactly).
let decoder_b = Decoder::new_random_small(cfg, 2, vocab);
let mut per_seq_caches: Vec<Vec<KvCache>> = seq_histories
.iter()
.map(|_| {
(0..2)
.map(|_| KvCache::new(decoder_b.config.n_kv_heads, decoder_b.config.head_dim))
.collect()
})
.collect();
// Feed every sequence's prefix (all but its last token)
// through forward_multi_seq one shared step at a time, then
// do a final batched step for the last token of every
// sequence so all three arrive at their final position in
// the same batched call -- exercising genuinely different
// per-sequence positions/histories within one batch, not just
// parallel identical-length sequences.
let max_len = seq_histories.iter().map(|h| h.len()).max().unwrap();
let mut batched_logits: Vec<Vec<f32>> = vec![Vec::new(); seq_histories.len()];
for step in 0..max_len {
let mut tokens = Vec::new();
let mut positions = Vec::new();
let mut active: Vec<usize> = Vec::new();
for (s, history) in seq_histories.iter().enumerate() {
if step < history.len() {
tokens.push(history[step]);
positions.push(step);
active.push(s);
}
}
if tokens.is_empty() {
continue;
}
let mut active_caches: Vec<Vec<KvCache>> = active
.iter()
.map(|&s| std::mem::take(&mut per_seq_caches[s]))
.collect();
let step_logits = decoder_b.forward_multi_seq(&tokens, &positions, &mut active_caches);
for ((&s, caches), logits) in active.iter().zip(active_caches).zip(step_logits) {
per_seq_caches[s] = caches;
batched_logits[s] = logits;
}
}
assert_eq!(batched_logits.len(), independent_logits.len());
for (s, (seq_logits, batch_logits)) in independent_logits
.iter()
.zip(batched_logits.iter())
.enumerate()
{
assert_eq!(seq_logits.len(), batch_logits.len());
for (i, (a, b)) in seq_logits.iter().zip(batch_logits.iter()).enumerate() {
assert!(
(a - b).abs() < 1e-3,
"sequence {s}, logit {i}: independent={a} batched={b}"
);
}
}
}
/// OLMoE-style QK-norm (`attn_q_norm`/`attn_k_norm`, see `AttnWeights`'
/// doc comment): with both set, `forward_batch` must still match
/// sequential `forward_token` calls exactly -- the same consistency
/// property `forward_batch_matches_sequential_forward_token_exactly`
/// checks for the no-QK-norm path, now exercising the norm-applied
/// per-row slicing (`q_batch.chunks_mut(q_width)`,
/// `k_batch.chunks_mut(kv_width)`) instead of trusting it by
/// inspection.
#[test]
fn forward_batch_matches_forward_token_with_qk_norm_present() {
let cfg = tiny_test_config();
let vocab = 8;
let tokens = [1usize, 3, 5, 2, 7];
let q_width = cfg.n_heads * cfg.head_dim;
let kv_width = cfg.n_kv_heads * cfg.head_dim;
let mut decoder_a = Decoder::new_random_small(cfg.clone(), 2, vocab);
for layer in &mut decoder_a.layers {
layer.attn.q_norm = Some((0..q_width).map(|i| 1.0 + i as f32 * 0.1).collect());
layer.attn.k_norm = Some((0..kv_width).map(|i| 0.5 + i as f32 * 0.05).collect());
}
let mut caches_a: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder_a.config.n_kv_heads, decoder_a.config.head_dim))
.collect();
let sequential: Vec<Vec<f32>> = tokens
.iter()
.enumerate()
.map(|(pos, &t)| decoder_a.forward_token(t, pos, &mut caches_a))
.collect();
let mut decoder_b = Decoder::new_random_small(cfg, 2, vocab);
for layer in &mut decoder_b.layers {
layer.attn.q_norm = Some((0..q_width).map(|i| 1.0 + i as f32 * 0.1).collect());
layer.attn.k_norm = Some((0..kv_width).map(|i| 0.5 + i as f32 * 0.05).collect());
}
let mut caches_b: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder_b.config.n_kv_heads, decoder_b.config.head_dim))
.collect();
let batched = decoder_b.forward_batch(&tokens, 0, &mut caches_b);
assert_eq!(batched.len(), sequential.len());
for (pos, (seq_logits, batch_logits)) in sequential.iter().zip(batched.iter()).enumerate() {
for (i, (s, b)) in seq_logits.iter().zip(batch_logits.iter()).enumerate() {
assert!(
(s - b).abs() < 1e-3,
"position {pos}, logit {i}: sequential={s} batched={b}"
);
}
}
}
/// QK-norm being present must actually change the output -- otherwise
/// the `Some(...)` branches in `forward_token`/`forward_batch` could
/// silently be dead code and this feature would ship unverified. Must
/// decode at least 2 positions: at position 0 with a fresh cache,
/// causal softmax has exactly one candidate (the token attending to
/// itself) and always evaluates to weight 1.0 regardless of the Q*K
/// dot product -- so the attention output there is Q/K-invariant by
/// construction, and a single-position version of this test would
/// pass even with `q_norm`/`k_norm` silently never applied.
#[test]
fn qk_norm_present_changes_output_versus_absent() {
let cfg = tiny_test_config();
let vocab = 8;
let q_width = cfg.n_heads * cfg.head_dim;
let kv_width = cfg.n_kv_heads * cfg.head_dim;
let tokens = [3usize, 5];
let without_norm = Decoder::new_random_small(cfg.clone(), 1, vocab);
let mut with_norm = Decoder::new_random_small(cfg, 1, vocab);
for layer in &mut with_norm.layers {
layer.attn.q_norm = Some(vec![2.0; q_width]);
layer.attn.k_norm = Some(vec![2.0; kv_width]);
}
let mut caches_a: Vec<KvCache> = (0..1)
.map(|_| KvCache::new(without_norm.config.n_kv_heads, without_norm.config.head_dim))
.collect();
let mut caches_b: Vec<KvCache> = (0..1)
.map(|_| KvCache::new(with_norm.config.n_kv_heads, with_norm.config.head_dim))
.collect();
let mut out_a = Vec::new();
let mut out_b = Vec::new();
for (pos, &t) in tokens.iter().enumerate() {
out_a = without_norm.forward_token(t, pos, &mut caches_a);
out_b = with_norm.forward_token(t, pos, &mut caches_b);
}
let differs = out_a
.iter()
.zip(out_b.iter())
.any(|(a, b)| (a - b).abs() > 1e-4);
assert!(
differs,
"QK-norm weights changed nothing -- forward_token likely isn't applying q_norm/k_norm"
);
}
/// Qwen2/Qwen2-MoE-family QKV attention bias (`AttnWeights::q_bias`/
/// `k_bias`/`v_bias`): a real, previously-unhandled gap found by
/// running ferrox's generic GGUF loader against a real downloaded
/// Qwen1.5-MoE-A2.7B-Chat checkpoint, which produced fluent-but-wrong
/// output because these real `attn_{q,k,v}.bias` tensors were
/// silently never added anywhere. Same two real properties checked
/// as the QK-norm tests above: (1) `forward_batch` must match
/// sequential `forward_token` exactly with bias present (batched
/// per-row broadcast must be correct, not just the single-token
/// path), and (2) bias must actually change the output at position
/// 0 or later (not silently dead code) -- checked at position 1
/// specifically, since position 0's causal softmax has exactly one
/// candidate and is Q/K-invariant regardless of any additive bias
/// shifting Q/K, for the same reason the QK-norm test above needs
/// >=2 positions.
#[test]
fn forward_batch_matches_forward_token_with_qkv_bias_present() {
let cfg = tiny_test_config();
let vocab = 8;
let tokens = [1usize, 3, 5, 2, 7];
let q_width = cfg.n_heads * cfg.head_dim;
let kv_width = cfg.n_kv_heads * cfg.head_dim;
let mut decoder_a = Decoder::new_random_small(cfg.clone(), 2, vocab);
for layer in &mut decoder_a.layers {
layer.attn.q_bias = Some((0..q_width).map(|i| 0.3 + i as f32 * 0.02).collect());
layer.attn.k_bias = Some((0..kv_width).map(|i| -0.2 + i as f32 * 0.03).collect());
layer.attn.v_bias = Some((0..kv_width).map(|i| 0.1 - i as f32 * 0.01).collect());
}
let mut caches_a: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder_a.config.n_kv_heads, decoder_a.config.head_dim))
.collect();
let sequential: Vec<Vec<f32>> = tokens
.iter()
.enumerate()
.map(|(pos, &t)| decoder_a.forward_token(t, pos, &mut caches_a))
.collect();
let mut decoder_b = Decoder::new_random_small(cfg, 2, vocab);
for layer in &mut decoder_b.layers {
layer.attn.q_bias = Some((0..q_width).map(|i| 0.3 + i as f32 * 0.02).collect());
layer.attn.k_bias = Some((0..kv_width).map(|i| -0.2 + i as f32 * 0.03).collect());
layer.attn.v_bias = Some((0..kv_width).map(|i| 0.1 - i as f32 * 0.01).collect());
}
let mut caches_b: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder_b.config.n_kv_heads, decoder_b.config.head_dim))
.collect();
let batched = decoder_b.forward_batch(&tokens, 0, &mut caches_b);
assert_eq!(batched.len(), sequential.len());
for (pos, (seq_logits, batch_logits)) in sequential.iter().zip(batched.iter()).enumerate() {
for (i, (s, b)) in seq_logits.iter().zip(batch_logits.iter()).enumerate() {
assert!(
(s - b).abs() < 1e-3,
"position {pos}, logit {i}: sequential={s} batched={b}"
);
}
}
}
#[test]
fn qkv_bias_present_changes_output_versus_absent() {
let cfg = tiny_test_config();
let vocab = 8;
let q_width = cfg.n_heads * cfg.head_dim;
let kv_width = cfg.n_kv_heads * cfg.head_dim;
let tokens = [3usize, 5];
let without_bias = Decoder::new_random_small(cfg.clone(), 1, vocab);
let mut with_bias = Decoder::new_random_small(cfg, 1, vocab);
for layer in &mut with_bias.layers {
layer.attn.q_bias = Some(vec![0.5; q_width]);
layer.attn.k_bias = Some(vec![0.5; kv_width]);
layer.attn.v_bias = Some(vec![0.5; kv_width]);
}
let mut caches_a: Vec<KvCache> = (0..1)
.map(|_| KvCache::new(without_bias.config.n_kv_heads, without_bias.config.head_dim))
.collect();
let mut caches_b: Vec<KvCache> = (0..1)
.map(|_| KvCache::new(with_bias.config.n_kv_heads, with_bias.config.head_dim))
.collect();
let mut out_a = Vec::new();
let mut out_b = Vec::new();
for (pos, &t) in tokens.iter().enumerate() {
out_a = without_bias.forward_token(t, pos, &mut caches_a);
out_b = with_bias.forward_token(t, pos, &mut caches_b);
}
let differs = out_a
.iter()
.zip(out_b.iter())
.any(|(a, b)| (a - b).abs() > 1e-4);
assert!(
differs,
"QKV bias changed nothing -- forward_token likely isn't applying q_bias/k_bias/v_bias"
);
}
#[test]
fn forward_batch_and_forward_token_leave_kv_caches_in_the_same_state() {
let cfg = tiny_test_config();
let tokens = [2usize, 4, 6];
let decoder_a = Decoder::new_random_small(cfg.clone(), 2, 8);
let mut caches_a: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder_a.config.n_kv_heads, decoder_a.config.head_dim))
.collect();
for (pos, &t) in tokens.iter().enumerate() {
decoder_a.forward_token(t, pos, &mut caches_a);
}
let decoder_b = Decoder::new_random_small(cfg, 2, 8);
let mut caches_b: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder_b.config.n_kv_heads, decoder_b.config.head_dim))
.collect();
decoder_b.forward_batch(&tokens, 0, &mut caches_b);
for (ca, cb) in caches_a.iter().zip(caches_b.iter()) {
assert_eq!(ca.seq_len, cb.seq_len);
assert_eq!(ca.k.len(), cb.k.len());
for (a, b) in ca.k.iter().zip(cb.k.iter()) {
assert!((a - b).abs() < 1e-4);
}
}
}
/// Same architecture shape as `tiny_test_config` but genuinely
/// dense (one expert, no shared experts) -- the shape every non-MoE
/// model, and every DeepSeek-style leading dense layer, loads as.
/// Exercises `Decoder::is_dense_layer`'s fast path.
fn tiny_dense_test_config() -> ModelConfig {
let mut cfg = tiny_test_config();
cfg.moe.n_experts = 1;
cfg.moe.n_experts_active = 1;
cfg.moe.n_shared_experts = 0;
cfg
}
#[test]
fn dense_layer_forward_pass_produces_finite_logits_of_correct_shape() {
let vocab = 10;
let decoder = Decoder::new_random_small(tiny_dense_test_config(), 2, vocab);
let mut caches: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder.config.n_kv_heads, decoder.config.head_dim))
.collect();
let logits = decoder.forward_token(3, 0, &mut caches);
assert_eq!(logits.len(), vocab);
assert!(
logits.iter().all(|v| v.is_finite()),
"logits must not contain NaN/Inf"
);
}
#[test]
fn dense_layer_forward_batch_matches_sequential_forward_token_exactly() {
let cfg = tiny_dense_test_config();
let vocab = 8;
let tokens = [1usize, 3, 5, 2, 7];
let decoder_a = Decoder::new_random_small(cfg.clone(), 2, vocab);
let mut caches_a: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder_a.config.n_kv_heads, decoder_a.config.head_dim))
.collect();
let sequential: Vec<Vec<f32>> = tokens
.iter()
.enumerate()
.map(|(pos, &t)| decoder_a.forward_token(t, pos, &mut caches_a))
.collect();
let decoder_b = Decoder::new_random_small(cfg, 2, vocab);
let mut caches_b: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder_b.config.n_kv_heads, decoder_b.config.head_dim))
.collect();
let batched = decoder_b.forward_batch(&tokens, 0, &mut caches_b);
assert_eq!(batched.len(), sequential.len());
for (pos, (seq_logits, batch_logits)) in sequential.iter().zip(batched.iter()).enumerate() {
for (i, (s, b)) in seq_logits.iter().zip(batch_logits.iter()).enumerate() {
assert!(
(s - b).abs() < 1e-3,
"position {pos}, logit {i}: sequential={s} batched={b}"
);
}
}
}
#[test]
fn dense_layer_fast_path_still_records_expert_zero_activations() {
// The dense fast path bypasses `route_top_k` entirely, but
// must still record an activation for expert 0 every step --
// `MoeWeights::placement_plan` and hotness-based GPU placement
// depend on this being real for every model shape, not just
// genuinely-MoE ones.
let decoder = Decoder::new_random_small(tiny_dense_test_config(), 1, 8);
let mut caches: Vec<KvCache> = (0..1)
.map(|_| KvCache::new(decoder.config.n_kv_heads, decoder.config.head_dim))
.collect();
decoder.forward_token(0, 0, &mut caches);
decoder.forward_token(1, 1, &mut caches);
decoder.forward_token(2, 2, &mut caches);
let count =
decoder.layers[0].moe.activation_counts[0].load(std::sync::atomic::Ordering::Relaxed);
assert_eq!(count, 3);
}
#[test]
fn forward_batch_with_empty_tokens_returns_empty() {
let decoder = Decoder::new_random_small(tiny_test_config(), 2, 8);
let mut caches: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder.config.n_kv_heads, decoder.config.head_dim))
.collect();
let out = decoder.forward_batch(&[], 0, &mut caches);
assert!(out.is_empty());
}
#[test]
fn forward_batch_continues_correctly_after_prior_forward_token_calls() {
// Realistic usage pattern: some tokens processed one at a time
// (e.g. the first generated token), then a batch verifying
// several draft tokens at once, continuing from the same
// cache. The batch's positions must be numbered starting from
// wherever the cache left off, not from zero.
let cfg = tiny_test_config();
let decoder_a = Decoder::new_random_small(cfg.clone(), 2, 8);
let mut caches_a: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder_a.config.n_kv_heads, decoder_a.config.head_dim))
.collect();
decoder_a.forward_token(1, 0, &mut caches_a);
decoder_a.forward_token(3, 1, &mut caches_a);
let seq_next = decoder_a.forward_token(5, 2, &mut caches_a);
let decoder_b = Decoder::new_random_small(cfg, 2, 8);
let mut caches_b: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder_b.config.n_kv_heads, decoder_b.config.head_dim))
.collect();
decoder_b.forward_token(1, 0, &mut caches_b);
let batch_next = decoder_b.forward_batch(&[3, 5], 1, &mut caches_b);
for (s, b) in seq_next.iter().zip(batch_next[1].iter()) {
assert!((s - b).abs() < 1e-3, "sequential={s} batched={b}");
}
}
/// `PlacementPlan::from_budget` is
/// real and tested in isolation, but only meaningful once it's fed
/// genuinely observed per-expert activation counts rather than
/// zeros. This proves the full loop: run real forward passes,
/// confirm `MoeWeights::activation_counts` actually reflects what
/// `route_top_k` selected, and confirm `placement_plan` prioritizes
/// the expert that was genuinely hottest -- not just that the
/// budget/size arithmetic works on synthetic inputs.
#[test]
fn placement_plan_reflects_real_observed_expert_activations() {
let cfg = tiny_test_config(); // 6 experts, top-2 active/token
let decoder = Decoder::new_random_small(cfg, 2, 16);
let mut caches: Vec<KvCache> = (0..2)
.map(|_| KvCache::new(decoder.config.n_kv_heads, decoder.config.head_dim))
.collect();
let n_calls = 20;
for pos in 0..n_calls {
decoder.forward_token(pos % 16, pos, &mut caches);
}
let layer0 = &decoder.layers[0].moe;
let counts: Vec<u64> = layer0
.activation_counts
.iter()
.map(|c| c.load(std::sync::atomic::Ordering::Relaxed))
.collect();
let total: u64 = counts.iter().sum();
assert_eq!(
total,
(n_calls as u64) * (decoder.config.moe.n_experts_active as u64),
"total recorded activations must equal calls * experts_active_per_call"
);
// Ties are realistic at this small a sample size; break them the
// same way `PlacementPlan::from_budget` does (lowest index
// wins), so this assertion can't spuriously fail on a tie that
// `from_budget` resolves differently than a naive `max_by_key`
// (which returns the *last* max element) would.
let hottest_count = *counts.iter().max().unwrap();
let hottest_idx = counts.iter().position(|&c| c == hottest_count).unwrap();
assert!(hottest_count > 0);
// A per-expert resident size big enough for exactly one expert.
let per_expert_bytes = layer0.expert_bytes(0);
let plan = layer0.placement_plan(per_expert_bytes as u64);
assert_eq!(
plan.placement_for(hottest_idx),
ferrox_moe::ExpertPlacement::GpuDevice(0),
"the genuinely hottest expert (index {hottest_idx}, {hottest_count} activations) \
must be the one the plan places on GPU when only one expert fits the budget"
);
}
}