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
cc / scheduler / scheduler_state_machine_unittest.cc [blame]
// Copyright 2011 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "cc/scheduler/scheduler_state_machine.h"
#include <stddef.h>
#include <array>
#include "base/time/time.h"
#include "cc/metrics/begin_main_frame_metrics.h"
#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/351564777): Remove this and convert code to safer constructs.
#pragma allow_unsafe_buffers
#endif
#include "base/test/gtest_util.h"
#include "base/test/scoped_feature_list.h"
#include "base/trace_event/trace_event.h"
#include "cc/base/features.h"
#include "cc/scheduler/scheduler.h"
#include "components/viz/common/frame_sinks/begin_frame_args.h"
#include "components/viz/test/begin_frame_args_test.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
// Macro to compare two enum values and get nice output.
// Without:
// Value of: actual() Actual: 7
// Expected: expected() Which is: 0
// With:
// Value of: actual() Actual: "ACTION_DRAW"
// Expected: expected() Which is: "ACTION_NONE"
#define EXPECT_ENUM_EQ(enum_tostring, expected, actual) \
EXPECT_THAT(enum_tostring(actual), testing::Eq(enum_tostring(expected)))
#define EXPECT_IMPL_FRAME_STATE(expected) \
EXPECT_ENUM_EQ(BeginImplFrameStateToString, expected, \
state.begin_impl_frame_state())
#define EXPECT_MAIN_FRAME_STATE(expected) \
EXPECT_ENUM_EQ(BeginMainFrameStateToString, expected, \
state.GetBeginMainFrameState())
#define EXPECT_NEXT_MAIN_FRAME_STATE(expected) \
EXPECT_ENUM_EQ(BeginMainFrameStateToString, expected, \
state.GetNextBeginMainFrameState())
#define EXPECT_ACTION(expected) \
EXPECT_ENUM_EQ(ActionToString, expected, state.NextAction())
#define EXPECT_ACTION_UPDATE_STATE(action) \
EXPECT_ACTION(action); \
if (action == SchedulerStateMachine::Action::DRAW_IF_POSSIBLE || \
action == SchedulerStateMachine::Action::DRAW_FORCED) { \
EXPECT_IMPL_FRAME_STATE( \
SchedulerStateMachine::BeginImplFrameState::INSIDE_DEADLINE); \
} \
PerformAction(&state, action); \
if (action == SchedulerStateMachine::Action::NONE) { \
if (state.begin_impl_frame_state() == \
SchedulerStateMachine::BeginImplFrameState::INSIDE_DEADLINE) \
state.OnBeginImplFrameIdle(); \
}
#define SET_UP_STATE(state) \
state.SetVisible(true); \
EXPECT_ACTION_UPDATE_STATE( \
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION); \
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE); \
state.CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit(); \
state.SetCanDraw(true)
namespace cc {
namespace {
const char* BeginImplFrameStateToString(
SchedulerStateMachine::BeginImplFrameState state) {
using BeginImplFrameState = SchedulerStateMachine::BeginImplFrameState;
switch (state) {
case BeginImplFrameState::IDLE:
return "BeginImplFrameState::IDLE";
case BeginImplFrameState::INSIDE_BEGIN_FRAME:
return "BeginImplFrameState::INSIDE_BEGIN_FRAME";
case BeginImplFrameState::INSIDE_DEADLINE:
return "BeginImplFrameState::INSIDE_DEADLINE";
}
NOTREACHED();
}
const char* BeginMainFrameStateToString(
SchedulerStateMachine::BeginMainFrameState state) {
using BeginMainFrameState = SchedulerStateMachine::BeginMainFrameState;
switch (state) {
case BeginMainFrameState::IDLE:
return "BeginMainFrameState::IDLE";
case BeginMainFrameState::SENT:
return "BeginMainFrameState::SENT";
case BeginMainFrameState::READY_TO_COMMIT:
return "BeginMainFrameState::READY_TO_COMMIT";
}
NOTREACHED();
}
const char* ActionToString(SchedulerStateMachine::Action action) {
using Action = SchedulerStateMachine::Action;
switch (action) {
case Action::NONE:
return "Action::NONE";
case Action::SEND_BEGIN_MAIN_FRAME:
return "Action::SEND_BEGIN_MAIN_FRAME";
case Action::COMMIT:
return "Action::COMMIT";
case Action::POST_COMMIT:
return "Action::POST_COMMIT";
case Action::ACTIVATE_SYNC_TREE:
return "Action::ACTIVATE_SYNC_TREE";
case Action::DRAW_IF_POSSIBLE:
return "Action::DRAW_IF_POSSIBLE";
case Action::DRAW_FORCED:
return "Action::DRAW_FORCED";
case Action::DRAW_ABORT:
return "Action::DRAW_ABORT";
case Action::UPDATE_DISPLAY_TREE:
return "Action::UPDATE_DISPLAY_TREE";
case Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION:
return "Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION";
case Action::PREPARE_TILES:
return "Action::PREPARE_TILES";
case Action::INVALIDATE_LAYER_TREE_FRAME_SINK:
return "Action::INVALIDATE_LAYER_TREE_FRAME_SINK";
case Action::PERFORM_IMPL_SIDE_INVALIDATION:
return "Action::PERFORM_IMPL_SIDE_INVALIDATION";
case Action::NOTIFY_BEGIN_MAIN_FRAME_NOT_EXPECTED_UNTIL:
return "Action::NOTIFY_BEGIN_MAIN_FRAME_NOT_EXPECTED_UNTIL";
case Action::NOTIFY_BEGIN_MAIN_FRAME_NOT_EXPECTED_SOON:
return "Action::NOTIFY_BEGIN_MAIN_FRAME_NOT_EXPECTED_SOON";
}
NOTREACHED();
}
const bool kAnimateOnly = false;
const auto all_begin_impl_frame_states =
std::to_array<SchedulerStateMachine::BeginImplFrameState>({
SchedulerStateMachine::BeginImplFrameState::IDLE,
SchedulerStateMachine::BeginImplFrameState::INSIDE_BEGIN_FRAME,
SchedulerStateMachine::BeginImplFrameState::INSIDE_DEADLINE,
});
const auto begin_main_frame_states =
std::to_array<SchedulerStateMachine::BeginMainFrameState>({
SchedulerStateMachine::BeginMainFrameState::IDLE,
SchedulerStateMachine::BeginMainFrameState::SENT,
SchedulerStateMachine::BeginMainFrameState::READY_TO_COMMIT,
});
// Exposes the protected state fields of the SchedulerStateMachine for testing
class StateMachine : public SchedulerStateMachine {
public:
explicit StateMachine(const SchedulerSettings& scheduler_settings)
: SchedulerStateMachine(scheduler_settings),
draw_result_for_test_(DrawResult::kSuccess) {}
void CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit() {
DidCreateAndInitializeLayerTreeFrameSink();
layer_tree_frame_sink_state_ = LayerTreeFrameSinkState::ACTIVE;
}
void IssueNextBeginImplFrame() {
OnBeginImplFrame(viz::BeginFrameId(0, next_begin_frame_number_++),
kAnimateOnly);
}
void SetBeginMainFrameState(BeginMainFrameState cs) {
begin_main_frame_state_ = cs;
}
BeginMainFrameState GetBeginMainFrameState() const {
return begin_main_frame_state_;
}
BeginMainFrameState GetNextBeginMainFrameState() const {
return next_begin_main_frame_state_;
}
ForcedRedrawOnTimeoutState ForcedRedrawState() const {
return forced_redraw_state_;
}
void SetBeginImplFrameState(BeginImplFrameState bifs) {
begin_impl_frame_state_ = bifs;
}
BeginImplFrameState begin_impl_frame_state() const {
return begin_impl_frame_state_;
}
LayerTreeFrameSinkState layer_tree_frame_sink_state() const {
return layer_tree_frame_sink_state_;
}
void SetNeedsBeginMainFrameForTest(bool needs_begin_main_frame) {
needs_begin_main_frame_ = needs_begin_main_frame;
}
bool NeedsCommit() const { return needs_begin_main_frame_; }
void SetNeedsOneBeginImplFrame(bool needs_frame) {
needs_one_begin_impl_frame_ = needs_frame;
}
void SetNeedsRedraw(bool needs_redraw) { needs_redraw_ = needs_redraw; }
void SetDrawResultForTest(DrawResult draw_result) {
draw_result_for_test_ = draw_result;
}
DrawResult draw_result_for_test() { return draw_result_for_test_; }
void SetNeedsForcedRedrawForTimeout(bool b) {
forced_redraw_state_ = ForcedRedrawOnTimeoutState::WAITING_FOR_COMMIT;
active_tree_needs_first_draw_ = true;
}
bool NeedsForcedRedrawForTimeout() const {
return forced_redraw_state_ != ForcedRedrawOnTimeoutState::IDLE;
}
void SetActiveTreeNeedsFirstDraw(bool needs_first_draw) {
active_tree_needs_first_draw_ = needs_first_draw;
}
bool CanDraw() const { return can_draw_; }
bool Visible() const { return visible_; }
bool ShouldAbortCurrentFrame() const {
return SchedulerStateMachine::ShouldAbortCurrentFrame();
}
bool has_pending_tree() const { return has_pending_tree_; }
void SetHasPendingTree(bool has_pending_tree) {
has_pending_tree_ = has_pending_tree;
}
bool needs_impl_side_invalidation() const {
return needs_impl_side_invalidation_;
}
void AdvanceTimeBy(base::TimeDelta delta) { now_ticks_ += delta; }
using SchedulerStateMachine::ProactiveBeginFrameWanted;
using SchedulerStateMachine::ShouldDraw;
using SchedulerStateMachine::ShouldPrepareTiles;
using SchedulerStateMachine::ShouldSendBeginMainFrame;
using SchedulerStateMachine::ShouldTriggerBeginImplFrameDeadlineImmediately;
using SchedulerStateMachine::ShouldWaitForScrollEvent;
using SchedulerStateMachine::WillCommit;
private:
base::TimeTicks Now() const override { return now_ticks_; }
protected:
DrawResult draw_result_for_test_;
uint64_t next_begin_frame_number_ = viz::BeginFrameArgs::kStartingFrameNumber;
base::TimeTicks now_ticks_;
};
void PerformAction(StateMachine* sm, SchedulerStateMachine::Action action) {
switch (action) {
case SchedulerStateMachine::Action::NONE:
return;
case SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE:
sm->WillActivate();
return;
case SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME:
sm->WillSendBeginMainFrame();
return;
case SchedulerStateMachine::Action::
NOTIFY_BEGIN_MAIN_FRAME_NOT_EXPECTED_UNTIL:
sm->WillNotifyBeginMainFrameNotExpectedUntil();
return;
case SchedulerStateMachine::Action::
NOTIFY_BEGIN_MAIN_FRAME_NOT_EXPECTED_SOON:
sm->WillNotifyBeginMainFrameNotExpectedSoon();
return;
case SchedulerStateMachine::Action::COMMIT: {
bool commit_has_no_updates = false;
sm->WillCommit(commit_has_no_updates);
sm->DidCommit();
return;
}
case SchedulerStateMachine::Action::POST_COMMIT:
sm->DidPostCommit();
return;
case SchedulerStateMachine::Action::DRAW_FORCED:
case SchedulerStateMachine::Action::DRAW_IF_POSSIBLE: {
sm->WillDraw();
sm->DidDraw(sm->draw_result_for_test());
return;
}
case SchedulerStateMachine::Action::DRAW_ABORT: {
sm->AbortDraw();
return;
}
case SchedulerStateMachine::Action::UPDATE_DISPLAY_TREE:
sm->WillUpdateDisplayTree();
return;
case SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION:
sm->WillBeginLayerTreeFrameSinkCreation();
return;
case SchedulerStateMachine::Action::PREPARE_TILES:
sm->WillPrepareTiles();
return;
case SchedulerStateMachine::Action::INVALIDATE_LAYER_TREE_FRAME_SINK:
sm->WillInvalidateLayerTreeFrameSink();
return;
case SchedulerStateMachine::Action::PERFORM_IMPL_SIDE_INVALIDATION:
sm->WillPerformImplSideInvalidation();
return;
}
}
TEST(SchedulerStateMachineTest, BeginFrameNeeded) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
state.SetVisible(true);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit();
state.SetBeginMainFrameState(
SchedulerStateMachine::BeginMainFrameState::IDLE);
// Don't request BeginFrames if we are idle.
state.SetNeedsRedraw(false);
state.SetNeedsOneBeginImplFrame(false);
EXPECT_FALSE(state.BeginFrameNeeded());
// Request BeginFrames if we one is needed.
state.SetNeedsRedraw(false);
state.SetNeedsOneBeginImplFrame(true);
EXPECT_TRUE(state.BeginFrameNeeded());
// Request BeginFrames if we are ready to draw.
state.SetVisible(true);
state.SetNeedsRedraw(true);
state.SetNeedsOneBeginImplFrame(false);
EXPECT_TRUE(state.BeginFrameNeeded());
// Don't background tick for needs_redraw.
state.SetVisible(false);
state.SetNeedsRedraw(true);
state.SetNeedsOneBeginImplFrame(false);
EXPECT_FALSE(state.BeginFrameNeeded());
// Proactively request BeginFrames when commit is pending.
state.SetVisible(true);
state.SetNeedsRedraw(false);
state.SetNeedsOneBeginImplFrame(false);
state.SetNeedsBeginMainFrameForTest(true);
EXPECT_TRUE(state.BeginFrameNeeded());
// Don't request BeginFrames when commit is pending if
// we are currently deferring commits.
state.SetVisible(true);
state.SetNeedsRedraw(false);
state.SetNeedsOneBeginImplFrame(false);
state.SetNeedsBeginMainFrameForTest(true);
state.SetDeferBeginMainFrame(true);
EXPECT_FALSE(state.BeginFrameNeeded());
}
TEST(SchedulerStateMachineTest, BeginMainFrameIsHighestPriorityAction) {
SchedulerSettings default_scheduler_settings;
default_scheduler_settings.main_frame_before_activation_enabled = true;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
state.NotifyReadyToActivate();
EXPECT_ACTION(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
// Still need to active, but sending BMF takes priority.
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
// Still need to draw, but sending BMF takes priority.
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION(SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
}
TEST(SchedulerStateMachineTest,
TestNextActionNotifyBeginMainFrameNotExpectedUntil) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
state.SetMainThreadWantsBeginMainFrameNotExpectedMessages(true);
state.SetVisible(true);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
state.IssueNextBeginImplFrame();
state.CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit();
state.SetNeedsOneBeginImplFrame(true);
EXPECT_TRUE(state.BeginFrameNeeded());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::
NOTIFY_BEGIN_MAIN_FRAME_NOT_EXPECTED_UNTIL);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.SetNeedsRedraw(true);
state.SetNeedsBeginMainFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
TEST(SchedulerStateMachineTest,
TestNextActionNotifyBeginMainFrameNotExpectedSoon) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
state.SetMainThreadWantsBeginMainFrameNotExpectedMessages(true);
state.SetVisible(true);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
state.IssueNextBeginImplFrame();
state.CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit();
state.SetNeedsOneBeginImplFrame(true);
EXPECT_TRUE(state.BeginFrameNeeded());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::
NOTIFY_BEGIN_MAIN_FRAME_NOT_EXPECTED_UNTIL);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.SetNeedsOneBeginImplFrame(false);
EXPECT_FALSE(state.BeginFrameNeeded());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.SetBeginImplFrameState(
SchedulerStateMachine::BeginImplFrameState::IDLE);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::NOTIFY_BEGIN_MAIN_FRAME_NOT_EXPECTED_SOON);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
TEST(SchedulerStateMachineTest, TestNextActionBeginsMainFrameIfNeeded) {
SchedulerSettings default_scheduler_settings;
// If no commit needed, do nothing.
{
StateMachine state(default_scheduler_settings);
state.SetVisible(true);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit();
state.SetBeginMainFrameState(
SchedulerStateMachine::BeginMainFrameState::IDLE);
state.SetNeedsRedraw(false);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_FALSE(state.NeedsCommit());
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_FALSE(state.NeedsCommit());
}
// If commit requested but not visible yet, do nothing.
{
StateMachine state(default_scheduler_settings);
state.SetBeginMainFrameState(
SchedulerStateMachine::BeginMainFrameState::IDLE);
state.SetNeedsRedraw(false);
state.SetNeedsBeginMainFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_TRUE(state.NeedsCommit());
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_TRUE(state.NeedsCommit());
}
// If commit requested, begin a main frame.
{
StateMachine state(default_scheduler_settings);
state.SetBeginMainFrameState(
SchedulerStateMachine::BeginMainFrameState::IDLE);
state.SetVisible(true);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit();
state.SetNeedsRedraw(false);
state.SetNeedsBeginMainFrame();
// Expect nothing to happen until after OnBeginImplFrame.
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::IDLE);
EXPECT_IMPL_FRAME_STATE(SchedulerStateMachine::BeginImplFrameState::IDLE);
EXPECT_TRUE(state.NeedsCommit());
EXPECT_TRUE(state.BeginFrameNeeded());
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::SENT);
EXPECT_FALSE(state.NeedsCommit());
}
// If commit requested and can't draw, still begin a main frame.
{
StateMachine state(default_scheduler_settings);
state.SetBeginMainFrameState(
SchedulerStateMachine::BeginMainFrameState::IDLE);
state.SetVisible(true);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit();
state.SetNeedsRedraw(false);
state.SetNeedsBeginMainFrame();
state.SetCanDraw(false);
// Expect nothing to happen until after OnBeginImplFrame.
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::IDLE);
EXPECT_IMPL_FRAME_STATE(SchedulerStateMachine::BeginImplFrameState::IDLE);
EXPECT_TRUE(state.BeginFrameNeeded());
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::SENT);
EXPECT_FALSE(state.NeedsCommit());
}
}
// Explicitly test main_frame_before_activation_enabled = true
TEST(SchedulerStateMachineTest, MainFrameBeforeActivationEnabled) {
SchedulerSettings scheduler_settings;
scheduler_settings.main_frame_before_activation_enabled = true;
StateMachine state(scheduler_settings);
state.SetBeginMainFrameState(
SchedulerStateMachine::BeginMainFrameState::IDLE);
SET_UP_STATE(state);
state.SetNeedsRedraw(false);
state.SetNeedsBeginMainFrame();
EXPECT_TRUE(state.BeginFrameNeeded());
// Commit to the pending tree.
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::IDLE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Verify that the next commit starts while there is still a pending tree.
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Verify the pending commit doesn't overwrite the pending
// tree until the pending tree has been activated.
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Verify NotifyReadyToActivate unblocks activation, commit, and
// draw in that order.
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_TRUE(state.ShouldTriggerBeginImplFrameDeadlineImmediately());
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
state.DidSubmitCompositorFrame();
state.DidReceiveCompositorFrameAck();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::IDLE);
}
TEST(SchedulerStateMachineTest,
FailedDrawForAnimationCheckerboardSetsNeedsCommitAndRetriesDraw) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
state.SetNeedsRedraw(true);
EXPECT_TRUE(state.RedrawPending());
EXPECT_TRUE(state.BeginFrameNeeded());
// Start a frame.
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_FALSE(state.CommitPending());
// Failing a draw triggers request for a new BeginMainFrame.
state.OnBeginImplFrameDeadline();
state.SetDrawResultForTest(DrawResult::kAbortedCheckerboardAnimations);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameIdle();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// It's okay to attempt more draws just in case additional raster
// finishes and the requested commit wasn't actually necessary.
EXPECT_TRUE(state.CommitPending());
EXPECT_TRUE(state.RedrawPending());
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
state.SetDrawResultForTest(DrawResult::kAbortedCheckerboardAnimations);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameIdle();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
TEST(SchedulerStateMachineTest, FailedDrawForMissingHighResNeedsCommit) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
state.SetNeedsRedraw(true);
EXPECT_TRUE(state.RedrawPending());
EXPECT_TRUE(state.BeginFrameNeeded());
// Start a frame.
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_FALSE(state.CommitPending());
// Failing a draw triggers because of high res tiles missing
// request for a new BeginMainFrame.
state.OnBeginImplFrameDeadline();
state.SetDrawResultForTest(DrawResult::kAbortedMissingHighResContent);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameIdle();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// It doesn't request a draw until we get a new commit though.
EXPECT_TRUE(state.CommitPending());
EXPECT_FALSE(state.RedrawPending());
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameIdle();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Finish the commit and activation.
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_TRUE(state.RedrawPending());
// Verify we draw with the new frame.
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
state.SetDrawResultForTest(DrawResult::kSuccess);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
state.DidSubmitCompositorFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameIdle();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
TEST(SchedulerStateMachineTest,
TestFailedDrawsEventuallyForceDrawAfterNextCommit) {
SchedulerSettings scheduler_settings;
scheduler_settings.maximum_number_of_failed_draws_before_draw_is_forced = 1;
StateMachine state(scheduler_settings);
SET_UP_STATE(state);
// Start a commit.
state.SetNeedsBeginMainFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_TRUE(state.CommitPending());
// Then initiate a draw that fails.
state.SetNeedsRedraw(true);
state.OnBeginImplFrameDeadline();
state.SetDrawResultForTest(DrawResult::kAbortedCheckerboardAnimations);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_TRUE(state.BeginFrameNeeded());
EXPECT_TRUE(state.RedrawPending());
EXPECT_TRUE(state.CommitPending());
// Finish the commit. Note, we should not yet be forcing a draw, but should
// continue the commit as usual.
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_TRUE(state.RedrawPending());
// Activate so we're ready for a new main frame.
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_TRUE(state.RedrawPending());
// The redraw should be forced at the end of the next BeginImplFrame.
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
state.SetDrawResultForTest(DrawResult::kSuccess);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_FORCED);
state.DidSubmitCompositorFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.DidReceiveCompositorFrameAck();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
TEST(SchedulerStateMachineTest, TestFailedDrawsDoNotRestartForcedDraw) {
SchedulerSettings scheduler_settings;
int draw_limit = 2;
scheduler_settings.maximum_number_of_failed_draws_before_draw_is_forced =
draw_limit;
StateMachine state(scheduler_settings);
SET_UP_STATE(state);
// Start a commit.
state.SetNeedsBeginMainFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_TRUE(state.CommitPending());
// Then initiate a draw.
state.SetNeedsRedraw(true);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
// Fail the draw enough times to force a redraw.
for (int i = 0; i < draw_limit; ++i) {
state.SetNeedsRedraw(true);
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
state.SetDrawResultForTest(DrawResult::kAbortedCheckerboardAnimations);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameIdle();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
EXPECT_TRUE(state.BeginFrameNeeded());
EXPECT_TRUE(state.RedrawPending());
// But the commit is ongoing.
EXPECT_TRUE(state.CommitPending());
EXPECT_TRUE(
state.ForcedRedrawState() ==
SchedulerStateMachine::ForcedRedrawOnTimeoutState::WAITING_FOR_COMMIT);
// After failing additional draws, we should still be in a forced
// redraw, but not back in IDLE.
for (int i = 0; i < draw_limit; ++i) {
state.SetNeedsRedraw(true);
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
state.SetDrawResultForTest(DrawResult::kAbortedCheckerboardAnimations);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameIdle();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
EXPECT_TRUE(state.RedrawPending());
EXPECT_TRUE(
state.ForcedRedrawState() ==
SchedulerStateMachine::ForcedRedrawOnTimeoutState::WAITING_FOR_COMMIT);
}
TEST(SchedulerStateMachineTest, TestFailedDrawIsRetriedInNextBeginImplFrame) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
// Start a draw.
state.SetNeedsRedraw(true);
EXPECT_TRUE(state.BeginFrameNeeded());
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_TRUE(state.RedrawPending());
state.SetDrawResultForTest(DrawResult::kAbortedCheckerboardAnimations);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
// Failing the draw for animation checkerboards makes us require a commit.
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_TRUE(state.RedrawPending());
// We should not be trying to draw again now, but we have a commit pending.
EXPECT_TRUE(state.BeginFrameNeeded());
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// We should try to draw again at the end of the next BeginImplFrame on
// the impl thread.
state.OnBeginImplFrameDeadline();
state.SetDrawResultForTest(DrawResult::kSuccess);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
state.DidSubmitCompositorFrame();
state.DidReceiveCompositorFrameAck();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
TEST(SchedulerStateMachineTest, TestDoestDrawTwiceInSameFrame) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
state.SetNeedsRedraw(true);
// Draw the first frame.
EXPECT_TRUE(state.BeginFrameNeeded());
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
state.DidSubmitCompositorFrame();
state.DidReceiveCompositorFrameAck();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Before the next BeginImplFrame, set needs redraw again.
// This should not redraw until the next BeginImplFrame.
state.SetNeedsRedraw(true);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Move to another frame. This should now draw.
EXPECT_TRUE(state.BeginFrameNeeded());
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
state.DidSubmitCompositorFrame();
state.DidReceiveCompositorFrameAck();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// We just submitted, so we should proactively request another BeginImplFrame.
EXPECT_TRUE(state.BeginFrameNeeded());
}
TEST(SchedulerStateMachineTest, TestNextActionDrawsOnBeginImplFrame) {
SchedulerSettings default_scheduler_settings;
// When not in BeginImplFrame deadline, or in BeginImplFrame deadline
// but not visible, don't draw.
for (size_t i = 0; i < begin_main_frame_states.size(); ++i) {
for (size_t j = 0; j < all_begin_impl_frame_states.size(); ++j) {
StateMachine state(default_scheduler_settings);
state.SetVisible(true);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit();
state.SetBeginMainFrameState(begin_main_frame_states[i]);
state.SetBeginImplFrameState(all_begin_impl_frame_states[j]);
bool visible =
(all_begin_impl_frame_states[j] !=
SchedulerStateMachine::BeginImplFrameState::INSIDE_DEADLINE);
state.SetVisible(visible);
// Case 1: needs_begin_main_frame=false
EXPECT_NE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE,
state.NextAction());
// Case 2: needs_begin_main_frame=true
state.SetNeedsBeginMainFrame();
EXPECT_NE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE,
state.NextAction());
}
}
// When in BeginImplFrame deadline we should always draw for SetNeedsRedraw
// except if we're ready to commit, in which case we expect a commit first.
for (size_t i = 0; i < begin_main_frame_states.size(); ++i) {
StateMachine state(default_scheduler_settings);
state.SetVisible(true);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit();
state.SetCanDraw(true);
state.SetBeginMainFrameState(begin_main_frame_states[i]);
state.SetBeginImplFrameState(
SchedulerStateMachine::BeginImplFrameState::INSIDE_DEADLINE);
state.SetNeedsRedraw(true);
SchedulerStateMachine::Action expected_action;
if (begin_main_frame_states[i] ==
SchedulerStateMachine::BeginMainFrameState::READY_TO_COMMIT) {
expected_action = SchedulerStateMachine::Action::COMMIT;
} else {
expected_action = SchedulerStateMachine::Action::DRAW_IF_POSSIBLE;
}
// Case 1: needs_begin_main_frame=false.
EXPECT_ACTION(expected_action);
// Case 2: needs_begin_main_frame=true.
state.SetNeedsBeginMainFrame();
EXPECT_ACTION(expected_action);
}
}
TEST(SchedulerStateMachineTest, TestNoBeginMainFrameStatesRedrawWhenInvisible) {
SchedulerSettings default_scheduler_settings;
for (size_t i = 0; i < begin_main_frame_states.size(); ++i) {
// There shouldn't be any drawing regardless of BeginImplFrame.
for (size_t j = 0; j < 2; ++j) {
StateMachine state(default_scheduler_settings);
state.SetVisible(true);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit();
state.SetBeginMainFrameState(begin_main_frame_states[i]);
state.SetVisible(false);
state.SetNeedsRedraw(true);
if (j == 1) {
state.SetBeginImplFrameState(
SchedulerStateMachine::BeginImplFrameState::INSIDE_DEADLINE);
}
// Case 1: needs_begin_main_frame=false.
EXPECT_NE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE,
state.NextAction());
// Case 2: needs_begin_main_frame=true.
state.SetNeedsBeginMainFrame();
EXPECT_NE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE,
state.NextAction());
}
}
}
TEST(SchedulerStateMachineTest, TestCanRedraw_StopsDraw) {
SchedulerSettings default_scheduler_settings;
for (size_t i = 0; i < begin_main_frame_states.size(); ++i) {
// There shouldn't be any drawing regardless of BeginImplFrame.
for (size_t j = 0; j < 2; ++j) {
StateMachine state(default_scheduler_settings);
state.SetVisible(true);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit();
state.SetBeginMainFrameState(begin_main_frame_states[i]);
state.SetVisible(false);
state.SetNeedsRedraw(true);
if (j == 1)
state.IssueNextBeginImplFrame();
state.SetCanDraw(false);
EXPECT_NE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE,
state.NextAction());
}
}
}
TEST(SchedulerStateMachineTest,
TestCanRedrawWithWaitingForFirstDrawMakesProgress) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
state.SetVisible(true);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit();
state.SetActiveTreeNeedsFirstDraw(true);
state.SetNeedsBeginMainFrame();
state.SetNeedsRedraw(true);
state.SetCanDraw(false);
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_ABORT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_ABORT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
TEST(SchedulerStateMachineTest, TestSetNeedsBeginMainFrameIsNotLost) {
SchedulerSettings scheduler_settings;
StateMachine state(scheduler_settings);
SET_UP_STATE(state);
state.SetNeedsBeginMainFrame();
EXPECT_TRUE(state.BeginFrameNeeded());
// Begin the frame.
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::SENT);
// Now, while the frame is in progress, set another commit.
state.SetNeedsBeginMainFrame();
EXPECT_TRUE(state.NeedsCommit());
// Let the frame finish.
state.NotifyReadyToCommit();
EXPECT_MAIN_FRAME_STATE(
SchedulerStateMachine::BeginMainFrameState::READY_TO_COMMIT);
// Expect to commit regardless of BeginImplFrame state.
EXPECT_IMPL_FRAME_STATE(
SchedulerStateMachine::BeginImplFrameState::INSIDE_BEGIN_FRAME);
EXPECT_ACTION(SchedulerStateMachine::Action::COMMIT);
state.OnBeginImplFrameDeadline();
EXPECT_IMPL_FRAME_STATE(
SchedulerStateMachine::BeginImplFrameState::INSIDE_DEADLINE);
EXPECT_ACTION(SchedulerStateMachine::Action::COMMIT);
state.OnBeginImplFrameIdle();
EXPECT_IMPL_FRAME_STATE(SchedulerStateMachine::BeginImplFrameState::IDLE);
EXPECT_ACTION(SchedulerStateMachine::Action::COMMIT);
state.IssueNextBeginImplFrame();
EXPECT_IMPL_FRAME_STATE(
SchedulerStateMachine::BeginImplFrameState::INSIDE_BEGIN_FRAME);
EXPECT_ACTION(SchedulerStateMachine::Action::COMMIT);
// Finish the commit and activate, then make sure we start the next commit
// immediately and draw on the next BeginImplFrame.
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_TRUE(state.active_tree_needs_first_draw());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
state.DidSubmitCompositorFrame();
state.DidReceiveCompositorFrameAck();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
TEST(SchedulerStateMachineTest, TestFullCycle) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
// Start clean and set commit.
state.SetNeedsBeginMainFrame();
// Begin the frame.
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::SENT);
EXPECT_FALSE(state.NeedsCommit());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Tell the scheduler the frame finished.
state.NotifyReadyToCommit();
EXPECT_MAIN_FRAME_STATE(
SchedulerStateMachine::BeginMainFrameState::READY_TO_COMMIT);
// Commit.
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
// Activate.
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
EXPECT_TRUE(state.active_tree_needs_first_draw());
EXPECT_TRUE(state.needs_redraw());
// Expect to do nothing until BeginImplFrame deadline
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// At BeginImplFrame deadline, draw.
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
state.DidSubmitCompositorFrame();
state.DidReceiveCompositorFrameAck();
// Should be synchronized, no draw needed, no action needed.
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::IDLE);
EXPECT_FALSE(state.needs_redraw());
}
TEST(SchedulerStateMachineTest, TestMainFrameThrottling) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
state.SetThrottleMainFrames(base::Hertz(60));
state.AdvanceTimeBy(base::Seconds(1280)); // Start at an arbitrary point.
int begin_main_frame_count = 0;
for (int i = 0; i < 10; i++) {
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
// If we send a BeginMainFrame(), simulate the fast path, where main is fast
// enough to catch the next deadline.
if (state.ShouldSendBeginMainFrame()) {
begin_main_frame_count += 1;
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::SENT);
EXPECT_FALSE(state.NeedsCommit());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.NotifyReadyToCommit();
EXPECT_MAIN_FRAME_STATE(
SchedulerStateMachine::BeginMainFrameState::READY_TO_COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
EXPECT_TRUE(state.active_tree_needs_first_draw());
EXPECT_TRUE(state.needs_redraw());
} else {
// Still need to require a draw, otherwise nothing will happen below.
state.SetNeedsRedraw(true);
}
// Expect to do nothing until BeginImplFrame deadline
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
state.DidSubmitCompositorFrame();
state.DidReceiveCompositorFrameAck();
// Should be synchronized, no draw needed, no action needed.
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::IDLE);
EXPECT_FALSE(state.needs_redraw());
state.AdvanceTimeBy(base::Hertz(120));
}
EXPECT_EQ(begin_main_frame_count, 5);
}
TEST(SchedulerStateMachineTest, CommitWithoutDrawWithPendingTree) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
// Start clean and set commit.
state.SetNeedsBeginMainFrame();
// Make a main frame, commit and activate it. But don't draw it.
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
// Try to make a new main frame before drawing. Since we will commit it to a
// pending tree and not clobber the active tree, we're able to start a new
// begin frame and commit it.
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
}
TEST(SchedulerStateMachineTest, DontCommitWithoutDrawWithoutPendingTree) {
SchedulerSettings scheduler_settings;
scheduler_settings.commit_to_active_tree = true;
scheduler_settings.main_frame_before_activation_enabled = false;
StateMachine state(scheduler_settings);
SET_UP_STATE(state);
// Start clean and set commit.
state.SetNeedsBeginMainFrame();
viz::BeginFrameId frame_id = viz::BeginFrameId(0, 10);
// Make a main frame, commit and activate it. But don't draw it.
state.OnBeginImplFrame(frame_id, kAnimateOnly);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
// Try to make a new main frame before drawing, but since we would clobber the
// active tree, we will not do so.
state.SetNeedsBeginMainFrame();
frame_id.sequence_number++;
state.OnBeginImplFrame(frame_id, kAnimateOnly);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
TEST(SchedulerStateMachineTest, AbortedMainFrameDoesNotResetPendingTree) {
SchedulerSettings scheduler_settings;
scheduler_settings.main_frame_before_activation_enabled = true;
StateMachine state(scheduler_settings);
SET_UP_STATE(state);
// Perform a commit so that we have an active tree.
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_TRUE(state.has_pending_tree());
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Ask for another commit but abort it. Verify that we didn't reset pending
// tree state.
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_TRUE(state.has_pending_tree());
state.BeginMainFrameAborted(CommitEarlyOutReason::kFinishedNoUpdates);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_TRUE(state.has_pending_tree());
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Ask for another commit that doesn't abort.
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_TRUE(state.has_pending_tree());
// Verify that commit is delayed until the pending tree is activated.
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
EXPECT_FALSE(state.has_pending_tree());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_TRUE(state.has_pending_tree());
}
TEST(SchedulerStateMachineTest, TestFullCycleWithCommitToActive) {
SchedulerSettings scheduler_settings;
scheduler_settings.commit_to_active_tree = true;
StateMachine state(scheduler_settings);
SET_UP_STATE(state);
// Start clean and set commit.
state.SetNeedsBeginMainFrame();
// Begin the frame.
viz::BeginFrameId frame_id = viz::BeginFrameId(0, 10);
state.OnBeginImplFrame(frame_id, kAnimateOnly);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::SENT);
EXPECT_FALSE(state.NeedsCommit());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Tell the scheduler the frame finished.
state.NotifyReadyToCommit();
EXPECT_MAIN_FRAME_STATE(
SchedulerStateMachine::BeginMainFrameState::READY_TO_COMMIT);
// Commit.
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
// Commit always calls NotifyReadyToActivate in this mode.
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// No draw because we haven't received NotifyReadyToDraw yet.
state.OnBeginImplFrameDeadline();
EXPECT_TRUE(state.active_tree_needs_first_draw());
EXPECT_TRUE(state.needs_redraw());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Can't BeginMainFrame yet since last commit hasn't been drawn yet.
state.SetNeedsBeginMainFrame();
frame_id.sequence_number++;
state.OnBeginImplFrame(frame_id, kAnimateOnly);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Now call ready to draw which will allow the draw to happen and
// BeginMainFrame to be sent.
state.NotifyReadyToDraw();
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
// Submit throttled from this point.
state.DidSubmitCompositorFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Can't BeginMainFrame yet since we're submit-frame throttled.
frame_id.sequence_number++;
state.OnBeginImplFrame(frame_id, kAnimateOnly);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// CompositorFrameAck unblocks BeginMainFrame.
state.DidReceiveCompositorFrameAck();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Draw the newly activated tree.
state.NotifyReadyToDraw();
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// When commits are deferred, we don't block the deadline.
state.SetDeferBeginMainFrame(true);
frame_id.sequence_number++;
state.OnBeginImplFrame(frame_id, kAnimateOnly);
EXPECT_NE(SchedulerStateMachine::BeginImplFrameDeadlineMode::BLOCKED,
state.CurrentBeginImplFrameDeadlineMode());
}
TEST(SchedulerStateMachineTest, TestFullCycleWithCommitRequestInbetween) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
// Start clean and set commit.
state.SetNeedsBeginMainFrame();
// Begin the frame.
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::SENT);
EXPECT_FALSE(state.NeedsCommit());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Request another commit while the commit is in flight.
state.SetNeedsBeginMainFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Tell the scheduler the frame finished.
state.NotifyReadyToCommit();
EXPECT_MAIN_FRAME_STATE(
SchedulerStateMachine::BeginMainFrameState::READY_TO_COMMIT);
// First commit and activate.
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
EXPECT_TRUE(state.active_tree_needs_first_draw());
EXPECT_TRUE(state.needs_redraw());
// Expect to do nothing until BeginImplFrame deadline.
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// At BeginImplFrame deadline, draw.
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
state.DidSubmitCompositorFrame();
state.DidReceiveCompositorFrameAck();
// Should be synchronized, no draw needed, no action needed.
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::IDLE);
EXPECT_FALSE(state.needs_redraw());
// Next BeginImplFrame should initiate second commit.
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
}
TEST(SchedulerStateMachineTest, TestNoRequestCommitWhenInvisible) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
state.SetVisible(true);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit();
state.SetVisible(false);
state.SetNeedsBeginMainFrame();
EXPECT_FALSE(state.CouldSendBeginMainFrame());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
TEST(SchedulerStateMachineTest, TestNoRequestCommitWhenBeginFrameSourcePaused) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
state.SetVisible(true);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit();
state.SetBeginFrameSourcePaused(true);
state.SetNeedsBeginMainFrame();
EXPECT_FALSE(state.CouldSendBeginMainFrame());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
TEST(SchedulerStateMachineTest, TestNoRequestLayerTreeFrameSinkWhenInvisible) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
// We should not request a LayerTreeFrameSink when we are still invisible.
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.SetVisible(true);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit();
state.SetVisible(false);
state.DidLoseLayerTreeFrameSink();
state.SetNeedsBeginMainFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.SetVisible(true);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
}
// See ProxyMain::BeginMainFrame "EarlyOut_NotVisible" /
// "EarlyOut_LayerTreeFrameSinkLost" cases.
TEST(SchedulerStateMachineTest, TestAbortBeginMainFrameBecauseInvisible) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
// Start clean and set commit.
state.SetNeedsBeginMainFrame();
// Begin the frame while visible.
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::SENT);
EXPECT_FALSE(state.NeedsCommit());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Become invisible and abort BeginMainFrame.
state.SetVisible(false);
state.BeginMainFrameAborted(CommitEarlyOutReason::kAbortedNotVisible);
// NeedsCommit should now be true again because we never actually did a
// commit.
EXPECT_TRUE(state.NeedsCommit());
// We should now be back in the idle state as if we never started the frame.
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::IDLE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// We shouldn't do anything on the BeginImplFrame deadline.
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Become visible again.
state.SetVisible(true);
// Although we have aborted on this frame and haven't cancelled the commit
// (i.e. need another), don't send another BeginMainFrame yet.
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::IDLE);
EXPECT_ACTION(SchedulerStateMachine::Action::NONE);
EXPECT_TRUE(state.NeedsCommit());
// Start a new frame.
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
// We should be starting the commit now.
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::SENT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
// See ProxyMain::BeginMainFrame "EarlyOut_NoUpdates" case.
TEST(SchedulerStateMachineTest, TestAbortBeginMainFrameBecauseCommitNotNeeded) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
state.SetVisible(true);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.DidCreateAndInitializeLayerTreeFrameSink();
state.SetCanDraw(true);
// Get into a begin frame / commit state.
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::SENT);
EXPECT_FALSE(state.NeedsCommit());
EXPECT_ACTION(SchedulerStateMachine::Action::NONE);
// Abort the commit, true means that the BeginMainFrame was sent but there
// was no work to do on the main thread.
state.BeginMainFrameAborted(CommitEarlyOutReason::kFinishedNoUpdates);
// NeedsCommit should now be false because the commit was actually handled.
EXPECT_FALSE(state.NeedsCommit());
// Since the commit was aborted, we don't need to try and draw.
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Verify another commit doesn't start on another frame either.
EXPECT_FALSE(state.NeedsCommit());
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::IDLE);
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Verify another commit can start if requested, though.
state.SetNeedsBeginMainFrame();
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::IDLE);
state.IssueNextBeginImplFrame();
EXPECT_ACTION(SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
}
TEST(SchedulerStateMachineTest, TestMainFrameBeforeCommit) {
SchedulerSettings default_scheduler_settings;
default_scheduler_settings.main_frame_before_commit_enabled = true;
StateMachine state(default_scheduler_settings);
state.SetVisible(true);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.DidCreateAndInitializeLayerTreeFrameSink();
state.SetCanDraw(true);
// Get into a begin frame / commit state.
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::IDLE);
EXPECT_NEXT_MAIN_FRAME_STATE(
SchedulerStateMachine::BeginMainFrameState::IDLE);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::SENT);
EXPECT_NEXT_MAIN_FRAME_STATE(
SchedulerStateMachine::BeginMainFrameState::IDLE);
EXPECT_ACTION(SchedulerStateMachine::Action::NONE);
// The secondary BeginMainFrame can't be sent until the first one completes
state.IssueNextBeginImplFrame();
state.SetNeedsBeginMainFrame();
EXPECT_ACTION(SchedulerStateMachine::Action::NONE);
// Abort the primary BeginMainFrame; the next BeginMainFrame should also be
// primary.
state.BeginMainFrameAborted(CommitEarlyOutReason::kFinishedNoUpdates);
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::SENT);
EXPECT_NEXT_MAIN_FRAME_STATE(
SchedulerStateMachine::BeginMainFrameState::IDLE);
// Complete the primary BeginMainFrame; the next BeginMainFrame should be
// secondary, and it should be sent *before* commit of the primary.
state.NotifyReadyToCommit();
EXPECT_MAIN_FRAME_STATE(
SchedulerStateMachine::BeginMainFrameState::READY_TO_COMMIT);
EXPECT_NEXT_MAIN_FRAME_STATE(
SchedulerStateMachine::BeginMainFrameState::IDLE);
// Secondary BeginMainFrame can be sent while primary is READY_TO_COMMIT
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_MAIN_FRAME_STATE(
SchedulerStateMachine::BeginMainFrameState::READY_TO_COMMIT);
EXPECT_NEXT_MAIN_FRAME_STATE(
SchedulerStateMachine::BeginMainFrameState::SENT);
// No more than two main frames in flight at a time; we should not send
// this main frame until the next NotifyReadyToCommit().
state.SetNeedsBeginMainFrame();
// Complete the commit; the secondary BeginMainFrame gets promoted to primary.
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::SENT);
EXPECT_NEXT_MAIN_FRAME_STATE(
SchedulerStateMachine::BeginMainFrameState::IDLE);
// Activate to vacate pending tree for another commit
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
// Cannot send the next main frame until the previous one is ready to commit
state.IssueNextBeginImplFrame();
EXPECT_ACTION(SchedulerStateMachine::Action::NONE);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
// Create a secondary BeginMainFrame and abort it; should not affect the
// primary.
state.NotifyReadyToCommit();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
state.BeginMainFrameAborted(CommitEarlyOutReason::kFinishedNoUpdates);
EXPECT_MAIN_FRAME_STATE(
SchedulerStateMachine::BeginMainFrameState::READY_TO_COMMIT);
EXPECT_NEXT_MAIN_FRAME_STATE(
SchedulerStateMachine::BeginMainFrameState::IDLE);
EXPECT_ACTION(SchedulerStateMachine::Action::COMMIT);
}
TEST(SchedulerStateMachineTest, TestFirstContextCreation) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
state.SetVisible(true);
state.SetCanDraw(true);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
state.CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Check that the first init does not SetNeedsBeginMainFrame.
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Check that a needs commit initiates a BeginMainFrame.
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
}
TEST(SchedulerStateMachineTest, TestContextLostWhenCompletelyIdle) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
EXPECT_NE(SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION,
state.NextAction());
state.DidLoseLayerTreeFrameSink();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Once context recreation begins, nothing should happen.
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Recreate the context.
state.CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit();
// When the context is recreated, we should begin a commit.
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
}
TEST(SchedulerStateMachineTest,
TestContextLostWhenIdleAndCommitRequestedWhileRecreating) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
EXPECT_NE(SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION,
state.NextAction());
state.DidLoseLayerTreeFrameSink();
EXPECT_EQ(state.layer_tree_frame_sink_state(),
SchedulerStateMachine::LayerTreeFrameSinkState::NONE);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Once context recreation begins, nothing should happen.
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// While context is recreating, commits shouldn't begin.
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Recreate the context
state.DidCreateAndInitializeLayerTreeFrameSink();
EXPECT_EQ(
state.layer_tree_frame_sink_state(),
SchedulerStateMachine::LayerTreeFrameSinkState::WAITING_FOR_FIRST_COMMIT);
EXPECT_FALSE(state.RedrawPending());
// When the context is recreated, we wait until the next BeginImplFrame
// before starting.
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// When the BeginFrame comes in we should begin a commit
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::SENT);
// Until that commit finishes, we shouldn't be drawing.
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Finish the commit, which should make the surface active.
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
EXPECT_EQ(state.layer_tree_frame_sink_state(),
SchedulerStateMachine::LayerTreeFrameSinkState::
WAITING_FOR_FIRST_ACTIVATION);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_EQ(state.layer_tree_frame_sink_state(),
SchedulerStateMachine::LayerTreeFrameSinkState::ACTIVE);
// Finishing the first commit after initializing a LayerTreeFrameSink should
// automatically cause a redraw.
EXPECT_TRUE(state.RedrawPending());
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_FALSE(state.RedrawPending());
// Next frame as no work to do.
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Once the context is recreated, whether we draw should be based on
// SetCanDraw if waiting on first draw after activate.
state.SetNeedsRedraw(true);
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
state.SetCanDraw(false);
EXPECT_ACTION(SchedulerStateMachine::Action::NONE);
state.SetCanDraw(true);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Once the context is recreated, whether we draw should be based on
// SetCanDraw if waiting on first draw after activate.
state.SetNeedsRedraw(true);
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Activate so we need the first draw
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_TRUE(state.active_tree_needs_first_draw());
EXPECT_TRUE(state.needs_redraw());
state.OnBeginImplFrameDeadline();
EXPECT_ACTION(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
state.SetCanDraw(false);
EXPECT_ACTION(SchedulerStateMachine::Action::DRAW_ABORT);
state.SetCanDraw(true);
EXPECT_ACTION(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
}
TEST(SchedulerStateMachineTest, TestContextLostWhileCommitInProgress) {
SchedulerSettings scheduler_settings;
StateMachine state(scheduler_settings);
SET_UP_STATE(state);
// Get a commit in flight.
state.SetNeedsBeginMainFrame();
// Set damage and expect a draw.
state.SetNeedsRedraw(true);
viz::BeginFrameId frame_id = viz::BeginFrameId(0, 10);
state.OnBeginImplFrame(frame_id, kAnimateOnly);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
state.DidSubmitCompositorFrame();
state.DidReceiveCompositorFrameAck();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Cause a lost context while the BeginMainFrame is in flight.
state.DidLoseLayerTreeFrameSink();
EXPECT_FALSE(state.BeginFrameNeeded());
// Ask for another draw. Expect nothing happens.
state.SetNeedsRedraw(true);
EXPECT_ACTION(SchedulerStateMachine::Action::NONE);
// Finish the frame, commit and activate.
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
// We will abort the draw when the LayerTreeFrameSink is lost if we are
// waiting for the first draw to unblock the main thread.
EXPECT_TRUE(state.active_tree_needs_first_draw());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_ABORT);
// Expect to begin context recreation only in BeginImplFrameState::IDLE
EXPECT_IMPL_FRAME_STATE(SchedulerStateMachine::BeginImplFrameState::IDLE);
EXPECT_ACTION(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
frame_id.sequence_number++;
state.OnBeginImplFrame(frame_id, kAnimateOnly);
EXPECT_IMPL_FRAME_STATE(
SchedulerStateMachine::BeginImplFrameState::INSIDE_BEGIN_FRAME);
EXPECT_ACTION(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_IMPL_FRAME_STATE(
SchedulerStateMachine::BeginImplFrameState::INSIDE_DEADLINE);
EXPECT_ACTION(SchedulerStateMachine::Action::NONE);
}
TEST(SchedulerStateMachineTest,
TestContextLostWhileCommitInProgressAndAnotherCommitRequested) {
SchedulerSettings scheduler_settings;
StateMachine state(scheduler_settings);
SET_UP_STATE(state);
// Get a commit in flight.
state.SetNeedsBeginMainFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Set damage and expect a draw.
state.SetNeedsRedraw(true);
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
state.DidSubmitCompositorFrame();
state.DidReceiveCompositorFrameAck();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Cause a lost context while the BeginMainFrame is in flight.
state.DidLoseLayerTreeFrameSink();
// Ask for another draw and also set needs commit. Expect nothing happens.
state.SetNeedsRedraw(true);
state.SetNeedsBeginMainFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Finish the frame, and commit and activate.
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
EXPECT_TRUE(state.active_tree_needs_first_draw());
// Because the LayerTreeFrameSink is missing, we expect the draw to abort.
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_ABORT);
// Expect to begin context recreation only in BeginImplFrameState::IDLE
EXPECT_IMPL_FRAME_STATE(SchedulerStateMachine::BeginImplFrameState::IDLE);
EXPECT_ACTION(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
state.IssueNextBeginImplFrame();
EXPECT_IMPL_FRAME_STATE(
SchedulerStateMachine::BeginImplFrameState::INSIDE_BEGIN_FRAME);
EXPECT_ACTION(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_IMPL_FRAME_STATE(
SchedulerStateMachine::BeginImplFrameState::INSIDE_DEADLINE);
EXPECT_ACTION(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameIdle();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
// After we get a new LayerTreeFrameSink, the commit flow should start.
state.CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
state.DidSubmitCompositorFrame();
state.DidReceiveCompositorFrameAck();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
TEST(SchedulerStateMachineTest,
DontDrawBeforeCommitAfterLostLayerTreeFrameSink) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
state.SetNeedsRedraw(true);
// Cause a lost LayerTreeFrameSink, and restore it.
state.DidLoseLayerTreeFrameSink();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.DidCreateAndInitializeLayerTreeFrameSink();
EXPECT_FALSE(state.RedrawPending());
state.IssueNextBeginImplFrame();
EXPECT_ACTION(SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
}
TEST(SchedulerStateMachineTest,
TestShouldAbortCurrentFrameAfterLostLayerTreeFrameSink) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
state.SetBeginMainFrameState(
SchedulerStateMachine::BeginMainFrameState::SENT);
// Cause a lost context.
state.DidLoseLayerTreeFrameSink();
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
EXPECT_TRUE(state.ShouldAbortCurrentFrame());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
EXPECT_TRUE(state.PendingDrawsShouldBeAborted());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_ABORT);
}
TEST(SchedulerStateMachineTest, TestNoBeginFrameNeededWhenInvisible) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
state.SetVisible(true);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit();
EXPECT_FALSE(state.BeginFrameNeeded());
state.SetNeedsRedraw(true);
EXPECT_TRUE(state.BeginFrameNeeded());
state.SetVisible(false);
EXPECT_FALSE(state.BeginFrameNeeded());
state.SetVisible(true);
EXPECT_TRUE(state.BeginFrameNeeded());
}
TEST(SchedulerStateMachineTest, TestNoBeginMainFrameWhenInvisible) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
state.SetVisible(true);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit();
state.SetVisible(false);
state.SetNeedsBeginMainFrame();
EXPECT_ACTION(SchedulerStateMachine::Action::NONE);
EXPECT_FALSE(state.BeginFrameNeeded());
// When become visible again, the needs commit should still be pending.
state.SetVisible(true);
EXPECT_TRUE(state.BeginFrameNeeded());
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
}
TEST(SchedulerStateMachineTest, TestFinishCommitWhenCommitInProgress) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
state.SetVisible(true);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit();
state.SetVisible(false);
state.SetBeginMainFrameState(
SchedulerStateMachine::BeginMainFrameState::SENT);
state.SetNeedsBeginMainFrame();
// After the commit completes, activation and draw happen immediately
// because we are not visible.
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
EXPECT_TRUE(state.active_tree_needs_first_draw());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_ABORT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
TEST(SchedulerStateMachineTest,
TestFinishCommitWhenCommitInProgressAndBeginFrameSourcePaused) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
state.SetVisible(true);
state.SetCanDraw(true);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.CreateAndInitializeLayerTreeFrameSinkWithActivatedCommit();
state.SetBeginFrameSourcePaused(true);
state.SetBeginMainFrameState(
SchedulerStateMachine::BeginMainFrameState::SENT);
state.SetNeedsBeginMainFrame();
// After the commit completes, activation and draw happen immediately
// because we are not visible.
state.NotifyReadyToCommit();
EXPECT_TRUE(state.ShouldAbortCurrentFrame());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
EXPECT_TRUE(state.active_tree_needs_first_draw());
EXPECT_TRUE(state.needs_redraw());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_ABORT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_FALSE(state.active_tree_needs_first_draw());
EXPECT_FALSE(state.needs_redraw());
// Unpausing should draw again to ensure a frame is submitted for the commit.
state.SetBeginFrameSourcePaused(false);
EXPECT_TRUE(state.needs_redraw());
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
state.DidSubmitCompositorFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.DidReceiveCompositorFrameAck();
}
TEST(SchedulerStateMachineTest, TestInitialActionsWhenContextLost) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
state.SetNeedsBeginMainFrame();
state.DidLoseLayerTreeFrameSink();
// When we are visible, we normally want to begin LayerTreeFrameSink creation
// as soon as possible.
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
state.DidCreateAndInitializeLayerTreeFrameSink();
EXPECT_EQ(
state.layer_tree_frame_sink_state(),
SchedulerStateMachine::LayerTreeFrameSinkState::WAITING_FOR_FIRST_COMMIT);
// We should not send a BeginMainFrame when we are invisible, even if we've
// lost the LayerTreeFrameSink and are trying to get the first commit, since
// the
// main thread will just abort anyway.
state.SetVisible(false);
EXPECT_ACTION(SchedulerStateMachine::Action::NONE);
}
TEST(SchedulerStateMachineTest, ReportIfNotDrawing) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
EXPECT_FALSE(state.PendingDrawsShouldBeAborted());
state.SetCanDraw(false);
state.SetVisible(true);
EXPECT_TRUE(state.PendingDrawsShouldBeAborted());
state.SetCanDraw(true);
state.SetVisible(false);
EXPECT_TRUE(state.PendingDrawsShouldBeAborted());
state.SetCanDraw(false);
state.SetVisible(false);
EXPECT_TRUE(state.PendingDrawsShouldBeAborted());
state.SetCanDraw(true);
state.SetVisible(true);
state.SetBeginFrameSourcePaused(true);
EXPECT_TRUE(state.PendingDrawsShouldBeAborted());
state.SetBeginFrameSourcePaused(false);
EXPECT_FALSE(state.PendingDrawsShouldBeAborted());
}
TEST(SchedulerStateMachineTest, ForceDrawForResourcelessSoftwareDraw) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
state.SetResourcelessSoftwareDraw(true);
EXPECT_FALSE(state.PendingDrawsShouldBeAborted());
state.SetVisible(false);
EXPECT_FALSE(state.PendingDrawsShouldBeAborted());
state.SetResourcelessSoftwareDraw(false);
EXPECT_TRUE(state.PendingDrawsShouldBeAborted());
state.SetResourcelessSoftwareDraw(true);
EXPECT_FALSE(state.PendingDrawsShouldBeAborted());
state.SetVisible(true);
state.SetBeginFrameSourcePaused(true);
EXPECT_FALSE(state.PendingDrawsShouldBeAborted());
state.SetResourcelessSoftwareDraw(false);
EXPECT_TRUE(state.PendingDrawsShouldBeAborted());
state.SetResourcelessSoftwareDraw(true);
EXPECT_FALSE(state.PendingDrawsShouldBeAborted());
state.SetBeginFrameSourcePaused(false);
state.SetVisible(false);
state.DidLoseLayerTreeFrameSink();
state.SetCanDraw(false);
state.WillBeginLayerTreeFrameSinkCreation();
state.DidCreateAndInitializeLayerTreeFrameSink();
EXPECT_TRUE(state.PendingDrawsShouldBeAborted());
state.SetCanDraw(true);
state.DidLoseLayerTreeFrameSink();
EXPECT_TRUE(state.PendingDrawsShouldBeAborted());
state.SetCanDraw(true);
state.WillBeginLayerTreeFrameSinkCreation();
state.DidCreateAndInitializeLayerTreeFrameSink();
EXPECT_FALSE(state.PendingDrawsShouldBeAborted());
state.SetCanDraw(false);
state.DidLoseLayerTreeFrameSink();
EXPECT_TRUE(state.PendingDrawsShouldBeAborted());
}
TEST(SchedulerStateMachineTest,
TestTriggerDeadlineImmediatelyAfterAbortedCommit) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
// This test mirrors what happens during the first frame of a scroll gesture.
// First we get the input event and a BeginFrame.
state.IssueNextBeginImplFrame();
// As a response the compositor requests a redraw and a commit to tell the
// main thread about the new scroll offset.
state.SetNeedsRedraw(true);
state.SetNeedsBeginMainFrame();
// We should start the commit normally.
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Since only the scroll offset changed, the main thread will abort the
// commit.
state.BeginMainFrameAborted(CommitEarlyOutReason::kFinishedNoUpdates);
// Since the commit was aborted, we should draw right away instead of waiting
// for the deadline.
EXPECT_TRUE(state.ShouldTriggerBeginImplFrameDeadlineImmediately());
}
void FinishPreviousCommitAndDrawWithoutExitingDeadline(
StateMachine* state_ptr) {
// Gross, but allows us to use macros below.
StateMachine& state = *state_ptr;
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_TRUE(state.ShouldTriggerBeginImplFrameDeadlineImmediately());
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
state.DidSubmitCompositorFrame();
}
TEST(SchedulerStateMachineTest, TestImplLatencyTakesPriorityImplInvalidations) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
// Set smoothness priority (used while scrolling).
state.SetTreePrioritiesAndScrollState(
SMOOTHNESS_TAKES_PRIORITY,
ScrollHandlerState::SCROLL_DOES_NOT_AFFECT_SCROLL_HANDLER);
// Impl-side invalidation creates a pending tree which is not yet activated.
bool needs_first_draw_on_activation = true;
state.SetNeedsImplSideInvalidation(needs_first_draw_on_activation);
viz::BeginFrameId frame_id = viz::BeginFrameId(0, 1);
state.OnBeginImplFrame(frame_id, kAnimateOnly);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::PERFORM_IMPL_SIDE_INVALIDATION);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
state.OnBeginImplFrameIdle();
// Now we need a main frame.
state.SetNeedsBeginMainFrame();
frame_id.sequence_number++;
state.OnBeginImplFrame(frame_id, kAnimateOnly);
// We should send a BeginMainFrame even though we haven't drawn the impl
// tree from last frame yet.
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
}
TEST(SchedulerStateMachineTest,
TestTriggerDeadlineImmediatelyOnLostLayerTreeFrameSink) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_FALSE(state.ShouldTriggerBeginImplFrameDeadlineImmediately());
state.DidLoseLayerTreeFrameSink();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// The deadline should be triggered immediately when LayerTreeFrameSink is
// lost.
EXPECT_TRUE(state.ShouldTriggerBeginImplFrameDeadlineImmediately());
}
TEST(SchedulerStateMachineTest, TestTriggerDeadlineImmediatelyWhenInvisible) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_FALSE(state.ShouldTriggerBeginImplFrameDeadlineImmediately());
state.SetVisible(false);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_TRUE(state.ShouldAbortCurrentFrame());
EXPECT_TRUE(state.ShouldTriggerBeginImplFrameDeadlineImmediately());
}
TEST(SchedulerStateMachineTest,
TestTriggerDeadlineImmediatelyWhenBeginFrameSourcePaused) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_FALSE(state.ShouldTriggerBeginImplFrameDeadlineImmediately());
state.SetBeginFrameSourcePaused(true);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_TRUE(state.ShouldAbortCurrentFrame());
EXPECT_TRUE(state.ShouldTriggerBeginImplFrameDeadlineImmediately());
}
TEST(SchedulerStateMachineTest, TestDeferBeginMainFrame) {
SchedulerSettings settings;
StateMachine state(settings);
SET_UP_STATE(state);
state.SetDeferBeginMainFrame(true);
state.SetNeedsBeginMainFrame();
EXPECT_FALSE(state.BeginFrameNeeded());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.SetDeferBeginMainFrame(false);
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
}
TEST(SchedulerStateMachineTest, EarlyOutCommitWantsProactiveBeginFrame) {
SchedulerSettings settings;
StateMachine state(settings);
SET_UP_STATE(state);
EXPECT_FALSE(state.ProactiveBeginFrameWanted());
bool commit_has_no_updates = true;
state.WillCommit(commit_has_no_updates);
EXPECT_TRUE(state.ProactiveBeginFrameWanted());
state.IssueNextBeginImplFrame();
EXPECT_FALSE(state.ProactiveBeginFrameWanted());
}
TEST(SchedulerStateMachineTest,
NoLayerTreeFrameSinkCreationWhileCommitPending) {
SchedulerSettings settings;
StateMachine state(settings);
SET_UP_STATE(state);
// Set up the request for a commit and start a frame.
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
PerformAction(&state, SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
// Lose the LayerTreeFrameSink.
state.DidLoseLayerTreeFrameSink();
// The scheduler shouldn't trigger the LayerTreeFrameSink creation till the
// previous commit has been cleared.
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Trigger the deadline and ensure that the scheduler does not trigger any
// actions until we receive a response for the pending commit.
state.OnBeginImplFrameDeadline();
state.OnBeginImplFrameIdle();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Abort the commit, since that is what we expect the main thread to do if the
// LayerTreeFrameSink was lost due to a synchronous call from the main thread
// to release the LayerTreeFrameSink.
state.BeginMainFrameAborted(CommitEarlyOutReason::kAbortedDeferredCommit);
// The scheduler should begin the LayerTreeFrameSink creation now.
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
}
TEST(SchedulerStateMachineTest, NoImplSideInvalidationsWhileInvisible) {
SchedulerSettings settings;
StateMachine state(settings);
SET_UP_STATE(state);
// No impl-side invalidations should be performed while we are not visible.
state.SetVisible(false);
bool needs_first_draw_on_activation = true;
state.SetNeedsImplSideInvalidation(needs_first_draw_on_activation);
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
TEST(SchedulerStateMachineTest,
NoImplSideInvalidationsWhenBeginFrameSourcePaused) {
SchedulerSettings settings;
StateMachine state(settings);
SET_UP_STATE(state);
// No impl-side invalidations should be performed while we can not make impl
// frames.
state.SetBeginFrameSourcePaused(true);
bool needs_first_draw_on_activation = true;
state.SetNeedsImplSideInvalidation(needs_first_draw_on_activation);
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
TEST(SchedulerStateMachineTest,
ImplSideInvalidationAndMainFrame_NoMainFrameRequest) {
// No main frame request or any update in the last frame, invalidation runs
// immediately.
SchedulerSettings settings;
StateMachine state(settings);
SET_UP_STATE(state);
bool needs_first_draw_on_activation = true;
state.SetNeedsImplSideInvalidation(needs_first_draw_on_activation);
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::PERFORM_IMPL_SIDE_INVALIDATION);
}
TEST(SchedulerStateMachineTest,
ImplSideInvalidationAndMainFrame_MainFrameRequest_FastMainThread) {
// Main frame request, no abort history and the main thread is fast,
// invalidation waits for main frame.
SchedulerSettings settings;
StateMachine state(settings);
SET_UP_STATE(state);
bool needs_first_draw_on_activation = true;
state.set_should_defer_invalidation_for_fast_main_frame(true);
state.SetNeedsBeginMainFrame();
state.SetNeedsImplSideInvalidation(needs_first_draw_on_activation);
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
TEST(SchedulerStateMachineTest,
ImplSideInvalidationAndMainFrame_LastFrameCommit) {
// Main frame committed in the last impl frame and is fast, invalidation waits
// for main frame request.
SchedulerSettings settings;
StateMachine state(settings);
SET_UP_STATE(state);
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
bool needs_first_draw_on_activation = true;
state.set_should_defer_invalidation_for_fast_main_frame(true);
state.SetNeedsImplSideInvalidation(needs_first_draw_on_activation);
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
TEST(SchedulerStateMachineTest,
ImplSideInvalidationAndMainFrame_LastFrameAborted) {
// Last main frame was aborted. An invalidation is performed even if a main
// frame request is pending.
SchedulerSettings settings;
StateMachine state(settings);
SET_UP_STATE(state);
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
state.BeginMainFrameAborted(CommitEarlyOutReason::kFinishedNoUpdates);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
bool needs_first_draw_on_activation = true;
state.set_should_defer_invalidation_for_fast_main_frame(true);
state.SetNeedsImplSideInvalidation(needs_first_draw_on_activation);
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::PERFORM_IMPL_SIDE_INVALIDATION);
}
TEST(SchedulerStateMachineTest,
ImplSideInvalidationAndMainFrame_MainFrameRequest_SlowMainThread) {
// Main frame request but the main thread is slow, invalidation runs
// immediately.
SchedulerSettings settings;
StateMachine state(settings);
SET_UP_STATE(state);
bool needs_first_draw_on_activation = true;
state.set_should_defer_invalidation_for_fast_main_frame(false);
state.SetNeedsBeginMainFrame();
state.SetNeedsImplSideInvalidation(needs_first_draw_on_activation);
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::PERFORM_IMPL_SIDE_INVALIDATION);
}
TEST(SchedulerStateMachineTest, NoImplSideInvalidationUntilFrameSinkActive) {
SchedulerSettings settings;
StateMachine state(settings);
SET_UP_STATE(state);
// Prefer impl side invalidation over begin main frame.
state.set_should_defer_invalidation_for_fast_main_frame(false);
state.DidLoseLayerTreeFrameSink();
// Create new frame sink but don't commit or activate yet.
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
state.DidCreateAndInitializeLayerTreeFrameSink();
state.SetNeedsBeginMainFrame();
bool needs_first_draw_on_activation = true;
state.SetNeedsImplSideInvalidation(needs_first_draw_on_activation);
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
// No impl side invalidation because we're still waiting for first commit.
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
state.OnBeginImplFrameDeadline();
state.OnBeginImplFrameIdle();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.SetNeedsImplSideInvalidation(needs_first_draw_on_activation);
state.IssueNextBeginImplFrame();
// No impl side invalidation because we're still waiting for first activation.
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
state.OnBeginImplFrameIdle();
state.SetNeedsBeginMainFrame();
state.SetNeedsImplSideInvalidation(needs_first_draw_on_activation);
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
// Impl side invalidation only after receiving first commit and activation for
// new frame sink.
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::PERFORM_IMPL_SIDE_INVALIDATION);
}
TEST(SchedulerStateMachineTest, ImplSideInvalidationWhenPendingTreeExists) {
SchedulerSettings settings;
StateMachine state(settings);
SET_UP_STATE(state);
// Set up request for the main frame, commit and create the pending tree.
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
// Request an impl-side invalidation after the commit. The request should wait
// till the current pending tree is activated.
bool needs_first_draw_on_activation = true;
state.SetNeedsImplSideInvalidation(needs_first_draw_on_activation);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Activate the pending tree. Since the commit fills the impl-side
// invalidation funnel as well, the request should wait until the next
// BeginFrame.
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Since there is no main frame request, this should perform impl-side
// invalidations.
state.set_should_defer_invalidation_for_fast_main_frame(false);
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::PERFORM_IMPL_SIDE_INVALIDATION);
}
TEST(SchedulerStateMachineTest, ImplSideInvalidationWhileReadyToCommit) {
SchedulerSettings settings;
StateMachine state(settings);
SET_UP_STATE(state);
// Set up request for the main frame with a slow main thread.
state.set_should_defer_invalidation_for_fast_main_frame(false);
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.NotifyReadyToCommit();
// Request an impl-side invalidation after we are ready to commit. The
// invalidations are merged.
bool needs_first_draw_on_activation = true;
state.SetNeedsImplSideInvalidation(needs_first_draw_on_activation);
EXPECT_TRUE(state.needs_impl_side_invalidation());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
EXPECT_FALSE(state.needs_impl_side_invalidation());
}
TEST(SchedulerStateMachineTest,
ConsecutiveImplSideInvalidationsWaitForBeginFrame) {
SchedulerSettings settings;
StateMachine state(settings);
SET_UP_STATE(state);
// Set up a request for impl-side invalidation.
bool needs_first_draw_on_activation = true;
state.SetNeedsImplSideInvalidation(needs_first_draw_on_activation);
state.IssueNextBeginImplFrame();
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::PERFORM_IMPL_SIDE_INVALIDATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Request another invalidation, which should wait until the pending tree is
// activated *and* we start the next BeginFrame.
state.SetNeedsImplSideInvalidation(needs_first_draw_on_activation);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Now start the next frame, which will first draw the active tree and then
// perform the pending impl-side invalidation request.
state.IssueNextBeginImplFrame();
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::PERFORM_IMPL_SIDE_INVALIDATION);
}
TEST(SchedulerStateMachineTest, ImplSideInvalidationsThrottledOnDraw) {
// In commit_to_active_tree mode, performing the next invalidation should be
// throttled on the active tree being drawn.
SchedulerSettings settings;
settings.commit_to_active_tree = true;
StateMachine state(settings);
SET_UP_STATE(state);
// Commit to the sync tree, activate and draw.
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
state.NotifyReadyToDraw();
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
state.DidSubmitCompositorFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Request impl-side invalidation and start a new frame, which should be
// blocked on the ack for the previous frame.
bool needs_first_draw_on_activation = true;
state.SetNeedsImplSideInvalidation(needs_first_draw_on_activation);
state.IssueNextBeginImplFrame();
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Ack the previous frame and begin impl frame, which should perform the
// invalidation now.
state.DidReceiveCompositorFrameAck();
state.IssueNextBeginImplFrame();
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::PERFORM_IMPL_SIDE_INVALIDATION);
}
TEST(SchedulerStateMachineTest, PrepareTilesWaitForImplSideInvalidation) {
// PrepareTiles
SchedulerSettings settings;
StateMachine state(settings);
SET_UP_STATE(state);
// Request a PrepareTiles and impl-side invalidation. The impl-side
// invalidation should run first, since it will perform PrepareTiles as well.
bool needs_first_draw_on_activation = true;
state.SetNeedsImplSideInvalidation(needs_first_draw_on_activation);
state.SetNeedsPrepareTiles();
state.IssueNextBeginImplFrame();
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::PERFORM_IMPL_SIDE_INVALIDATION);
state.DidPrepareTiles();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
TEST(SchedulerStateMachineTest, TestFullPipelineMode) {
SchedulerSettings scheduler_settings;
scheduler_settings.wait_for_all_pipeline_stages_before_draw = true;
StateMachine state(scheduler_settings);
SET_UP_STATE(state);
// Start clean and set commit.
state.SetNeedsBeginMainFrame();
// While we are waiting for an main frame or pending tree activation, we
// should even block while we can't draw.
state.SetCanDraw(false);
// Begin the frame.
viz::BeginFrameId frame_id = viz::BeginFrameId(0, 10);
state.OnBeginImplFrame(frame_id, kAnimateOnly);
EXPECT_EQ(SchedulerStateMachine::BeginImplFrameDeadlineMode::BLOCKED,
state.CurrentBeginImplFrameDeadlineMode());
// If main thread defers commits, don't wait for it.
state.SetDeferBeginMainFrame(true);
EXPECT_EQ(SchedulerStateMachine::BeginImplFrameDeadlineMode::IMMEDIATE,
state.CurrentBeginImplFrameDeadlineMode());
state.SetDeferBeginMainFrame(false);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::SENT);
EXPECT_FALSE(state.NeedsCommit());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// We are blocking on the main frame.
EXPECT_EQ(SchedulerStateMachine::BeginImplFrameDeadlineMode::BLOCKED,
state.CurrentBeginImplFrameDeadlineMode());
// Tell the scheduler the frame finished.
state.NotifyReadyToCommit();
EXPECT_MAIN_FRAME_STATE(
SchedulerStateMachine::BeginMainFrameState::READY_TO_COMMIT);
// We are blocking on commit.
EXPECT_EQ(SchedulerStateMachine::BeginImplFrameDeadlineMode::BLOCKED,
state.CurrentBeginImplFrameDeadlineMode());
// Commit.
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
// We are blocking on activation.
EXPECT_EQ(SchedulerStateMachine::BeginImplFrameDeadlineMode::BLOCKED,
state.CurrentBeginImplFrameDeadlineMode());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// We should prepare tiles even though we are not in the deadline, otherwise
// we would get stuck here.
EXPECT_FALSE(state.ShouldPrepareTiles());
state.SetNeedsPrepareTiles();
EXPECT_TRUE(state.ShouldPrepareTiles());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::PREPARE_TILES);
// Ready to activate, but not draw.
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
// We should no longer block, because can_draw is still false, and we are no
// longer waiting for activation.
EXPECT_EQ(SchedulerStateMachine::BeginImplFrameDeadlineMode::IMMEDIATE,
state.CurrentBeginImplFrameDeadlineMode());
// However, we should continue to block on ready to draw if we can draw.
state.SetCanDraw(true);
EXPECT_EQ(SchedulerStateMachine::BeginImplFrameDeadlineMode::BLOCKED,
state.CurrentBeginImplFrameDeadlineMode());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Ready to draw triggers immediate deadline.
state.NotifyReadyToDraw();
EXPECT_EQ(SchedulerStateMachine::BeginImplFrameDeadlineMode::IMMEDIATE,
state.CurrentBeginImplFrameDeadlineMode());
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
state.DidSubmitCompositorFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// In full-pipe mode, CompositorFrameAck should always arrive before any
// subsequent BeginFrame.
state.DidReceiveCompositorFrameAck();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Request a redraw without main frame.
state.SetNeedsRedraw(true);
// Redraw should happen immediately since there is no pending tree and active
// tree is ready to draw.
frame_id.sequence_number++;
state.OnBeginImplFrame(frame_id, kAnimateOnly);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_EQ(SchedulerStateMachine::BeginImplFrameDeadlineMode::IMMEDIATE,
state.CurrentBeginImplFrameDeadlineMode());
// Redraw on impl-side only.
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.DidSubmitCompositorFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// In full-pipe mode, CompositorFrameAck should always arrive before any
// subsequent BeginFrame.
state.DidReceiveCompositorFrameAck();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Request a redraw on active frame and a main frame.
state.SetNeedsRedraw(true);
state.SetNeedsBeginMainFrame();
frame_id.sequence_number++;
state.OnBeginImplFrame(frame_id, kAnimateOnly);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Blocked on main frame.
EXPECT_EQ(SchedulerStateMachine::BeginImplFrameDeadlineMode::BLOCKED,
state.CurrentBeginImplFrameDeadlineMode());
// Even with SMOOTHNESS_TAKES_PRIORITY, we don't prioritize impl thread and we
// should wait for main frame.
state.SetTreePrioritiesAndScrollState(
SMOOTHNESS_TAKES_PRIORITY,
ScrollHandlerState::SCROLL_DOES_NOT_AFFECT_SCROLL_HANDLER);
EXPECT_EQ(SchedulerStateMachine::BeginImplFrameDeadlineMode::BLOCKED,
state.CurrentBeginImplFrameDeadlineMode());
// Abort commit and ensure that we don't block anymore.
state.BeginMainFrameAborted(CommitEarlyOutReason::kFinishedNoUpdates);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
EXPECT_MAIN_FRAME_STATE(SchedulerStateMachine::BeginMainFrameState::IDLE);
EXPECT_EQ(SchedulerStateMachine::BeginImplFrameDeadlineMode::IMMEDIATE,
state.CurrentBeginImplFrameDeadlineMode());
}
TEST(SchedulerStateMachineTest, AllowSkippingActiveTreeFirstDraws) {
SchedulerSettings settings;
StateMachine state(settings);
SET_UP_STATE(state);
// Impl-side invalidation creates a pending tree which is activated but not
// drawn in this frame.
bool needs_first_draw_on_activation = false;
state.SetNeedsImplSideInvalidation(needs_first_draw_on_activation);
viz::BeginFrameId frame_id = viz::BeginFrameId(0, 1);
state.OnBeginImplFrame(frame_id, kAnimateOnly);
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::PERFORM_IMPL_SIDE_INVALIDATION);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
state.OnBeginImplFrameIdle();
// Now we have a main frame.
state.SetNeedsBeginMainFrame();
frame_id.sequence_number++;
state.OnBeginImplFrame(frame_id, kAnimateOnly);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
// We should be able to activate this tree without drawing the active tree.
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
}
TEST(SchedulerStateMachineTest, DelayDrawIfAnimationWorkletsPending) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
// This test verifies that having pending mutations from Animation Worklets on
// the active tree will not trigger the deadline early.
state.SetNeedsBeginMainFrame();
viz::BeginFrameId frame_id = viz::BeginFrameId(0, 10);
state.OnBeginImplFrame(frame_id, kAnimateOnly);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
EXPECT_TRUE(state.ShouldTriggerBeginImplFrameDeadlineImmediately());
EXPECT_EQ(SchedulerStateMachine::BeginImplFrameDeadlineMode::IMMEDIATE,
state.CurrentBeginImplFrameDeadlineMode());
// Started async mutation cycle for animation worklets.
state.NotifyAnimationWorkletStateChange(
SchedulerStateMachine::AnimationWorkletState::PROCESSING,
SchedulerStateMachine::TreeType::ACTIVE);
EXPECT_FALSE(state.ShouldTriggerBeginImplFrameDeadlineImmediately());
EXPECT_EQ(SchedulerStateMachine::BeginImplFrameDeadlineMode::REGULAR,
state.CurrentBeginImplFrameDeadlineMode());
// Second queued state change.
state.NotifyAnimationWorkletStateChange(
SchedulerStateMachine::AnimationWorkletState::PROCESSING,
SchedulerStateMachine::TreeType::ACTIVE);
EXPECT_FALSE(state.ShouldTriggerBeginImplFrameDeadlineImmediately());
EXPECT_EQ(SchedulerStateMachine::BeginImplFrameDeadlineMode::REGULAR,
state.CurrentBeginImplFrameDeadlineMode());
// First mutation cycle completes. Still waiting on queued mutation cycle
// before being ready to draw.
state.NotifyAnimationWorkletStateChange(
SchedulerStateMachine::AnimationWorkletState::IDLE,
SchedulerStateMachine::TreeType::ACTIVE);
EXPECT_FALSE(state.ShouldTriggerBeginImplFrameDeadlineImmediately());
EXPECT_EQ(SchedulerStateMachine::BeginImplFrameDeadlineMode::REGULAR,
state.CurrentBeginImplFrameDeadlineMode());
// Queued mutation cycle completes. Now ready to draw.
state.NotifyAnimationWorkletStateChange(
SchedulerStateMachine::AnimationWorkletState::IDLE,
SchedulerStateMachine::TreeType::ACTIVE);
EXPECT_TRUE(state.ShouldTriggerBeginImplFrameDeadlineImmediately());
EXPECT_EQ(SchedulerStateMachine::BeginImplFrameDeadlineMode::IMMEDIATE,
state.CurrentBeginImplFrameDeadlineMode());
// AnimationWorkletState does not effect CanDraw, only whether an early draw
// deadline should be used (crbug/937975).
state.SetNeedsRedraw(true);
state.OnBeginImplFrameDeadline();
EXPECT_IMPL_FRAME_STATE(
SchedulerStateMachine::BeginImplFrameState::INSIDE_DEADLINE);
EXPECT_TRUE(state.ShouldDraw());
state.NotifyAnimationWorkletStateChange(
SchedulerStateMachine::AnimationWorkletState::PROCESSING,
SchedulerStateMachine::TreeType::ACTIVE);
EXPECT_TRUE(state.ShouldDraw());
state.NotifyAnimationWorkletStateChange(
SchedulerStateMachine::AnimationWorkletState::IDLE,
SchedulerStateMachine::TreeType::ACTIVE);
EXPECT_TRUE(state.ShouldDraw());
}
TEST(SchedulerStateMachineTest, BlockActivationIfAnimationWorkletsPending) {
SchedulerSettings settings;
StateMachine state(settings);
SET_UP_STATE(state);
// Verify that pending mutations from Animation Worklets block activation.
state.SetNeedsBeginMainFrame();
viz::BeginFrameId frame_id = viz::BeginFrameId(0, 10);
state.OnBeginImplFrame(frame_id, kAnimateOnly);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
state.NotifyAnimationWorkletStateChange(
SchedulerStateMachine::AnimationWorkletState::PROCESSING,
SchedulerStateMachine::TreeType::PENDING);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.NotifyAnimationWorkletStateChange(
SchedulerStateMachine::AnimationWorkletState::IDLE,
SchedulerStateMachine::TreeType::PENDING);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
}
TEST(SchedulerStateMachineTest, BlockActivationIfPaintWorkletsPending) {
SchedulerSettings settings;
StateMachine state(settings);
SET_UP_STATE(state);
state.SetNeedsBeginMainFrame();
viz::BeginFrameId frame_id = viz::BeginFrameId(0, 10);
state.OnBeginImplFrame(frame_id, kAnimateOnly);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Post-commit, we start working on PaintWorklets. It is not valid to activate
// until they are done.
state.NotifyPaintWorkletStateChange(
SchedulerStateMachine::PaintWorkletState::PROCESSING);
// We (correctly) cannot call state.NotifyReadyToActivate() here as it hits a
// DCHECK because PaintWorklets are ongoing.
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.NotifyPaintWorkletStateChange(
SchedulerStateMachine::PaintWorkletState::IDLE);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
}
TEST(SchedulerStateMachineTest,
BlockActivationIfPaintWorkletsPendingEvenWhenAbortingFrame) {
SchedulerSettings settings;
StateMachine state(settings);
SET_UP_STATE(state);
state.SetNeedsBeginMainFrame();
viz::BeginFrameId frame_id = viz::BeginFrameId(0, 10);
state.OnBeginImplFrame(frame_id, kAnimateOnly);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Even if we are aborting the frame, we must paint the pending tree before we
// activate it (because we cannot have an unpainted active tree).
state.NotifyPaintWorkletStateChange(
SchedulerStateMachine::PaintWorkletState::PROCESSING);
state.SetVisible(false);
ASSERT_TRUE(state.ShouldAbortCurrentFrame());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.NotifyPaintWorkletStateChange(
SchedulerStateMachine::PaintWorkletState::IDLE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
}
TEST(SchedulerStateMachineTest, TestFullPipelineModeDoesntBlockAfterCommit) {
SchedulerSettings settings;
settings.wait_for_all_pipeline_stages_before_draw = true;
StateMachine state(settings);
SET_UP_STATE(state);
const bool needs_first_draw_on_activation = true;
state.SetNeedsImplSideInvalidation(needs_first_draw_on_activation);
state.SetNeedsBeginMainFrame();
state.SetNeedsRedraw(true);
viz::BeginFrameId frame_id = viz::BeginFrameId(0, 10);
state.OnBeginImplFrame(frame_id, kAnimateOnly);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
state.NotifyReadyToDraw();
EXPECT_TRUE(state.active_tree_needs_first_draw());
EXPECT_IMPL_FRAME_STATE(
SchedulerStateMachine::BeginImplFrameState::INSIDE_BEGIN_FRAME);
// Go all the way until ready to draw, but make sure we're not within
// the frame deadline, so actual draw doesn't happen...
EXPECT_FALSE(state.ShouldDraw());
// ... then have another commit ...
state.SetNeedsBeginMainFrame();
frame_id.sequence_number++;
state.OnBeginImplFrame(frame_id, kAnimateOnly);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
// ... and make sure we're in a state where we can proceed,
// rather than draw being blocked by the pending tree.
state.OnBeginImplFrameDeadline();
EXPECT_TRUE(state.ShouldDraw());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
}
TEST(SchedulerStateMachineTest,
PauseRenderingSuppressesCommitsAndInvalidations) {
SchedulerSettings settings;
StateMachine state(settings);
SET_UP_STATE(state);
// Set up a main frame in a state where we're waiting for a commit.
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
// Main thread sends a notification to pause rendering before this frame
// commits.
state.SetPauseRendering(true);
// Finish the impl frame before the main thread responds.
state.OnBeginImplFrameDeadline();
// We're still subscribed to BeginFrames since the pending commit needs to be
// activated and drawn.
EXPECT_TRUE(state.ShouldSubscribeToBeginFrames());
EXPECT_TRUE(state.BeginFrameNeeded());
// Now the main thread responds which triggers commit.
state.NotifyReadyToCommit();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::COMMIT);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::POST_COMMIT);
// The frame finishes before we're ready to activate, should still remain
// subscribed to BeginFrames for activation.
state.OnBeginImplFrameDeadline();
EXPECT_TRUE(state.ShouldSubscribeToBeginFrames());
EXPECT_TRUE(state.BeginFrameNeeded());
// Trigger activation. We should still remain subscribed to BeginFrames for
// draw.
state.NotifyReadyToActivate();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::ACTIVATE_SYNC_TREE);
EXPECT_TRUE(state.ShouldSubscribeToBeginFrames());
EXPECT_TRUE(state.BeginFrameNeeded());
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
// Request main frame. These are suppressed because rendering is paused.
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.OnBeginImplFrameDeadline();
// Request an impl-side invalidation and start a new frame. The invalidations
// are paused to avoid new updates which have to be drained through the
// pipeline.
state.SetNeedsImplSideInvalidation(true);
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Now that the last commit has been drawn, we shouldn't need BeginFrames
// anymore.
EXPECT_TRUE(state.ShouldSubscribeToBeginFrames());
EXPECT_FALSE(state.BeginFrameNeeded());
// Unpause rendering. This should send the suppressed BeginMainFrame and
// trigger impl-side invalidation.
state.SetPauseRendering(false);
EXPECT_TRUE(state.ShouldSubscribeToBeginFrames());
EXPECT_TRUE(state.BeginFrameNeeded());
state.IssueNextBeginImplFrame();
state.set_should_defer_invalidation_for_fast_main_frame(false);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::PERFORM_IMPL_SIDE_INVALIDATION);
}
// Text fixture class for the SchedulerStateMachine tests. Parameterized to
// include a boolean which indicates whether frame rate limits are enabled
// or not i.e. whether the disable_frame_rate_limit flag is set.
class DisableFrameRateLimitSchedulerStateMachineTests
: public testing::Test,
public testing::WithParamInterface<bool> {
public:
SchedulerSettings GetSchedulerSettings() {
SchedulerSettings settings;
settings.disable_frame_rate_limit = GetParam();
return settings;
}
};
TEST_P(DisableFrameRateLimitSchedulerStateMachineTests,
TestImplLatencyTakesPriority) {
SchedulerSettings default_scheduler_settings = GetSchedulerSettings();
StateMachine state(default_scheduler_settings);
SET_UP_STATE(state);
// This test ensures that impl-draws are prioritized over main thread updates
// in prefer impl latency mode.
state.SetNeedsRedraw(true);
state.SetNeedsBeginMainFrame();
state.IssueNextBeginImplFrame();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Verify the deadline is not triggered early until we enter
// prefer impl latency mode.
EXPECT_FALSE(state.ShouldTriggerBeginImplFrameDeadlineImmediately());
state.SetTreePrioritiesAndScrollState(
SMOOTHNESS_TAKES_PRIORITY,
ScrollHandlerState::SCROLL_DOES_NOT_AFFECT_SCROLL_HANDLER);
EXPECT_TRUE(state.ShouldTriggerBeginImplFrameDeadlineImmediately());
// Trigger the deadline.
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::DRAW_IF_POSSIBLE);
state.DidSubmitCompositorFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.DidReceiveCompositorFrameAck();
// Request a new commit and finish the previous one.
state.SetNeedsBeginMainFrame();
FinishPreviousCommitAndDrawWithoutExitingDeadline(&state);
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.DidReceiveCompositorFrameAck();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Finish the previous commit and draw it.
FinishPreviousCommitAndDrawWithoutExitingDeadline(&state);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
// Verify we do not send another BeginMainFrame if was are submit-frame
// throttled and did not just submit one.
state.SetNeedsBeginMainFrame();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.IssueNextBeginImplFrame();
// If disable_frame_rate_limit is enabled, then draws aren't throttled in
// the SchedulerStateMachine. We need to update the expectations accordingly.
if (default_scheduler_settings.disable_frame_rate_limit) {
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::SEND_BEGIN_MAIN_FRAME);
} else {
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
EXPECT_FALSE(state.ShouldTriggerBeginImplFrameDeadlineImmediately());
state.OnBeginImplFrameDeadline();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
INSTANTIATE_TEST_SUITE_P(DisableFrameRateLimitSchedulerStateMachineTests,
DisableFrameRateLimitSchedulerStateMachineTests,
testing::Bool());
// Text fixture class for the ScrollingSchedulerStateMachineTest tests.
// Parameterized to include a boolean which indicates whether frame rate limits
// are enabled or not i.e. whether the disable_frame_rate_limit flag is set.
class ScrollingSchedulerStateMachineTest
: public DisableFrameRateLimitSchedulerStateMachineTests {
public:
ScrollingSchedulerStateMachineTest();
~ScrollingSchedulerStateMachineTest() override = default;
void BeginImplFrameWaitingForScrollEvent();
void SetUp() override;
protected:
SchedulerSettings InitScrollDeadlineMode();
SchedulerSettings scheduler_settings_;
public:
// Having `state` private breaks the testing macros
StateMachine state;
};
ScrollingSchedulerStateMachineTest::ScrollingSchedulerStateMachineTest()
: state(InitScrollDeadlineMode()) {}
void ScrollingSchedulerStateMachineTest::BeginImplFrameWaitingForScrollEvent() {
state.IssueNextBeginImplFrame();
state.set_waiting_for_scroll_event(true);
}
SchedulerSettings ScrollingSchedulerStateMachineTest::InitScrollDeadlineMode() {
scheduler_settings_ =
DisableFrameRateLimitSchedulerStateMachineTests::GetSchedulerSettings();
scheduler_settings_.scroll_deadline_mode_enabled = true;
return scheduler_settings_;
}
void ScrollingSchedulerStateMachineTest::SetUp() {
DisableFrameRateLimitSchedulerStateMachineTests::SetUp();
SET_UP_STATE(state);
state.set_is_scrolling(true);
state.SetTreePrioritiesAndScrollState(
SMOOTHNESS_TAKES_PRIORITY,
ScrollHandlerState::SCROLL_DOES_NOT_AFFECT_SCROLL_HANDLER);
}
// Tests that when we should wait for scroll events, that we do not send
// BeginMainFrame. And that either receiving a scroll, or reaching the deadline,
// that we unblock BeginMainFrames.
TEST_P(ScrollingSchedulerStateMachineTest, ScrollModeBlocksBeginMainFrame) {
state.SetNeedsBeginMainFrame();
// Once the frame starts, we are told to wait for scroll event.
BeginImplFrameWaitingForScrollEvent();
EXPECT_TRUE(state.ShouldWaitForScrollEvent());
EXPECT_FALSE(state.ShouldSendBeginMainFrame());
// Once we are told to stop waiting, then BeginMainFrame should be unblocked.
state.set_waiting_for_scroll_event(false);
EXPECT_FALSE(state.ShouldWaitForScrollEvent());
EXPECT_TRUE(state.ShouldSendBeginMainFrame());
// Start next frame
BeginImplFrameWaitingForScrollEvent();
EXPECT_TRUE(state.ShouldWaitForScrollEvent());
EXPECT_FALSE(state.ShouldSendBeginMainFrame());
// The deadline should also unblock the BeginMainFrame.
state.OnBeginImplFrameDeadline();
EXPECT_FALSE(state.ShouldWaitForScrollEvent());
EXPECT_TRUE(state.ShouldSendBeginMainFrame());
}
// Tests that even if we want to delay for scrolls, if we weren't prepared to
// draw immediately, that we use a longer deadline.
TEST_P(ScrollingSchedulerStateMachineTest, ScrollModeBlockedByNoImmediateMode) {
// We apply back pressure on frame production. After submission we do not
// allow Immediate mode until `DidReceiveCompositorFrameAck`.
state.DidSubmitCompositorFrame();
// We want to draw more.
state.SetNeedsRedraw(true);
// While under back-pressure we should not trigger scroll deadline
BeginImplFrameWaitingForScrollEvent();
// If disable_frame_rate_limit is set, then draws are not throttled. The
// ShouldTriggerBeginImplFrameDeadlineImmediately() function returns true
// in this case. Adjust the expectations accordingly. Please note that
// the expectation changes are just for the tests to pass.
//
// The disable_frame_rate_limit switch is not enabled by default. It is
// likely that some of the assumptions made in the SchedulerStateMachine
// class are not true and we need further testing.
if (scheduler_settings_.disable_frame_rate_limit) {
EXPECT_TRUE(state.ShouldTriggerBeginImplFrameDeadlineImmediately());
} else {
EXPECT_FALSE(state.ShouldTriggerBeginImplFrameDeadlineImmediately());
}
EXPECT_TRUE(state.ShouldWaitForScrollEvent());
// If disable_frame_rate_limit is set, then draws are not throttled. The
// ShouldTriggerBeginImplFrameDeadlineImmediately() function returns true
// in this case. Adjust the expectations accordingly.
if (scheduler_settings_.disable_frame_rate_limit) {
EXPECT_EQ(
SchedulerStateMachine::BeginImplFrameDeadlineMode::WAIT_FOR_SCROLL,
state.CurrentBeginImplFrameDeadlineMode());
} else {
EXPECT_NE(
SchedulerStateMachine::BeginImplFrameDeadlineMode::WAIT_FOR_SCROLL,
state.CurrentBeginImplFrameDeadlineMode());
}
// When we receive the Ack then we should be able select scroll deadline
// again.
state.DidReceiveCompositorFrameAck();
EXPECT_TRUE(state.ShouldTriggerBeginImplFrameDeadlineImmediately());
EXPECT_TRUE(state.ShouldWaitForScrollEvent());
EXPECT_EQ(SchedulerStateMachine::BeginImplFrameDeadlineMode::WAIT_FOR_SCROLL,
state.CurrentBeginImplFrameDeadlineMode());
}
INSTANTIATE_TEST_SUITE_P(ScrollingSchedulerStateMachineTest,
ScrollingSchedulerStateMachineTest,
testing::Bool());
class WarmUpCompositorSchedulerStateMachineTest : public testing::Test {
public:
WarmUpCompositorSchedulerStateMachineTest() {
scoped_feature_list_.InitAndEnableFeature(features::kWarmUpCompositor);
}
private:
base::test::ScopedFeatureList scoped_feature_list_;
};
// Tests that `SetShouldWarmUp()` will start initial `LayerTreeFrameSink`
// creation even if invisible.
TEST_F(WarmUpCompositorSchedulerStateMachineTest,
SetShouldWarmUpWillStartLayerTreeFrameSinkCreation) {
SchedulerSettings default_scheduler_settings;
StateMachine state(default_scheduler_settings);
state.SetVisible(false);
state.SetShouldWarmUp();
EXPECT_ACTION_UPDATE_STATE(
SchedulerStateMachine::Action::BEGIN_LAYER_TREE_FRAME_SINK_CREATION);
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
state.DidCreateAndInitializeLayerTreeFrameSink();
EXPECT_ACTION_UPDATE_STATE(SchedulerStateMachine::Action::NONE);
}
} // namespace
} // namespace cc