1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
|
/*++
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
EbcExecute.c
Abstract:
Contains code that implements the virtual machine.
--*/
#include "EbcInt.h"
#include "EbcExecute.h"
//
// VM major/minor version
//
#define VM_MAJOR_VERSION 1
#define VM_MINOR_VERSION 0
//
// Define some useful data size constants to allow switch statements based on
// size of operands or data.
//
#define DATA_SIZE_INVALID 0
#define DATA_SIZE_8 1
#define DATA_SIZE_16 2
#define DATA_SIZE_32 4
#define DATA_SIZE_64 8
#define DATA_SIZE_N 48 // 4 or 8
//
// Structure we'll use to dispatch opcodes to execute functions.
//
typedef struct {
EFI_STATUS (*ExecuteFunction) (IN VM_CONTEXT * VmPtr);
}
VM_TABLE_ENTRY;
typedef
UINT64
(*DATA_MANIP_EXEC_FUNCTION) (
IN VM_CONTEXT * VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
);
STATIC
INT16
VmReadIndex16 (
IN VM_CONTEXT *VmPtr,
IN UINT32 CodeOffset
);
STATIC
INT32
VmReadIndex32 (
IN VM_CONTEXT *VmPtr,
IN UINT32 CodeOffset
);
STATIC
INT64
VmReadIndex64 (
IN VM_CONTEXT *VmPtr,
IN UINT32 CodeOffset
);
STATIC
UINT8
VmReadMem8 (
IN VM_CONTEXT *VmPtr,
IN UINTN Addr
);
STATIC
UINT16
VmReadMem16 (
IN VM_CONTEXT *VmPtr,
IN UINTN Addr
);
STATIC
UINT32
VmReadMem32 (
IN VM_CONTEXT *VmPtr,
IN UINTN Addr
);
STATIC
UINT64
VmReadMem64 (
IN VM_CONTEXT *VmPtr,
IN UINTN Addr
);
STATIC
UINTN
VmReadMemN (
IN VM_CONTEXT *VmPtr,
IN UINTN Addr
);
STATIC
EFI_STATUS
VmWriteMem8 (
IN VM_CONTEXT *VmPtr,
UINTN Addr,
IN UINT8 Data
);
STATIC
EFI_STATUS
VmWriteMem16 (
IN VM_CONTEXT *VmPtr,
UINTN Addr,
IN UINT16 Data
);
STATIC
EFI_STATUS
VmWriteMem32 (
IN VM_CONTEXT *VmPtr,
UINTN Addr,
IN UINT32 Data
);
EFI_STATUS
VmWriteMemN (
IN VM_CONTEXT *VmPtr,
UINTN Addr,
IN UINTN Data
);
EFI_STATUS
VmWriteMem64 (
IN VM_CONTEXT *VmPtr,
UINTN Addr,
IN UINT64 Data
);
STATIC
UINT16
VmReadCode16 (
IN VM_CONTEXT *VmPtr,
IN UINT32 Offset
);
STATIC
UINT32
VmReadCode32 (
IN VM_CONTEXT *VmPtr,
IN UINT32 Offset
);
STATIC
UINT64
VmReadCode64 (
IN VM_CONTEXT *VmPtr,
IN UINT32 Offset
);
STATIC
INT8
VmReadImmed8 (
IN VM_CONTEXT *VmPtr,
IN UINT32 Offset
);
STATIC
INT16
VmReadImmed16 (
IN VM_CONTEXT *VmPtr,
IN UINT32 Offset
);
STATIC
INT32
VmReadImmed32 (
IN VM_CONTEXT *VmPtr,
IN UINT32 Offset
);
STATIC
INT64
VmReadImmed64 (
IN VM_CONTEXT *VmPtr,
IN UINT32 Offset
);
STATIC
UINTN
ConvertStackAddr (
IN VM_CONTEXT *VmPtr,
IN UINTN Addr
);
STATIC
EFI_STATUS
ExecuteDataManip (
IN VM_CONTEXT *VmPtr,
IN BOOLEAN IsSignedOperation
);
//
// Functions that execute VM opcodes
//
STATIC
EFI_STATUS
ExecuteBREAK (
IN VM_CONTEXT *VmPtr
);
STATIC
EFI_STATUS
ExecuteJMP (
IN VM_CONTEXT *VmPtr
);
STATIC
EFI_STATUS
ExecuteJMP8 (
IN VM_CONTEXT *VmPtr
);
STATIC
EFI_STATUS
ExecuteCALL (
IN VM_CONTEXT *VmPtr
);
STATIC
EFI_STATUS
ExecuteRET (
IN VM_CONTEXT *VmPtr
);
STATIC
EFI_STATUS
ExecuteCMP (
IN VM_CONTEXT *VmPtr
);
STATIC
EFI_STATUS
ExecuteCMPI (
IN VM_CONTEXT *VmPtr
);
STATIC
EFI_STATUS
ExecuteMOVxx (
IN VM_CONTEXT *VmPtr
);
STATIC
EFI_STATUS
ExecuteMOVI (
IN VM_CONTEXT *VmPtr
);
STATIC
EFI_STATUS
ExecuteMOVIn (
IN VM_CONTEXT *VmPtr
);
STATIC
EFI_STATUS
ExecuteMOVREL (
IN VM_CONTEXT *VmPtr
);
STATIC
EFI_STATUS
ExecutePUSHn (
IN VM_CONTEXT *VmPtr
);
STATIC
EFI_STATUS
ExecutePUSH (
IN VM_CONTEXT *VmPtr
);
STATIC
EFI_STATUS
ExecutePOPn (
IN VM_CONTEXT *VmPtr
);
STATIC
EFI_STATUS
ExecutePOP (
IN VM_CONTEXT *VmPtr
);
STATIC
EFI_STATUS
ExecuteSignedDataManip (
IN VM_CONTEXT *VmPtr
);
STATIC
EFI_STATUS
ExecuteUnsignedDataManip (
IN VM_CONTEXT *VmPtr
);
STATIC
EFI_STATUS
ExecuteLOADSP (
IN VM_CONTEXT *VmPtr
);
STATIC
EFI_STATUS
ExecuteSTORESP (
IN VM_CONTEXT *VmPtr
);
STATIC
EFI_STATUS
ExecuteMOVsnd (
IN VM_CONTEXT *VmPtr
);
STATIC
EFI_STATUS
ExecuteMOVsnw (
IN VM_CONTEXT *VmPtr
);
//
// Data manipulation subfunctions
//
STATIC
UINT64
ExecuteNOT (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
);
STATIC
UINT64
ExecuteNEG (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
);
STATIC
UINT64
ExecuteADD (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
);
STATIC
UINT64
ExecuteSUB (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
);
STATIC
UINT64
ExecuteMUL (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
);
STATIC
UINT64
ExecuteMULU (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
);
STATIC
UINT64
ExecuteDIV (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
);
STATIC
UINT64
ExecuteDIVU (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
);
STATIC
UINT64
ExecuteMOD (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
);
STATIC
UINT64
ExecuteMODU (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
);
STATIC
UINT64
ExecuteAND (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
);
STATIC
UINT64
ExecuteOR (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
);
STATIC
UINT64
ExecuteXOR (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
);
STATIC
UINT64
ExecuteSHL (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
);
STATIC
UINT64
ExecuteSHR (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
);
STATIC
UINT64
ExecuteASHR (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
);
STATIC
UINT64
ExecuteEXTNDB (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
);
STATIC
UINT64
ExecuteEXTNDW (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
);
STATIC
UINT64
ExecuteEXTNDD (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
);
//
// Once we retrieve the operands for the data manipulation instructions,
// call these functions to perform the operation.
//
static CONST DATA_MANIP_EXEC_FUNCTION mDataManipDispatchTable[] = {
ExecuteNOT,
ExecuteNEG,
ExecuteADD,
ExecuteSUB,
ExecuteMUL,
ExecuteMULU,
ExecuteDIV,
ExecuteDIVU,
ExecuteMOD,
ExecuteMODU,
ExecuteAND,
ExecuteOR,
ExecuteXOR,
ExecuteSHL,
ExecuteSHR,
ExecuteASHR,
ExecuteEXTNDB,
ExecuteEXTNDW,
ExecuteEXTNDD,
};
static CONST VM_TABLE_ENTRY mVmOpcodeTable[] = {
{ ExecuteBREAK }, // opcode 0x00
{ ExecuteJMP }, // opcode 0x01
{ ExecuteJMP8 }, // opcode 0x02
{ ExecuteCALL }, // opcode 0x03
{ ExecuteRET }, // opcode 0x04
{ ExecuteCMP }, // opcode 0x05 CMPeq
{ ExecuteCMP }, // opcode 0x06 CMPlte
{ ExecuteCMP }, // opcode 0x07 CMPgte
{ ExecuteCMP }, // opcode 0x08 CMPulte
{ ExecuteCMP }, // opcode 0x09 CMPugte
{ ExecuteUnsignedDataManip }, // opcode 0x0A NOT
{ ExecuteSignedDataManip }, // opcode 0x0B NEG
{ ExecuteSignedDataManip }, // opcode 0x0C ADD
{ ExecuteSignedDataManip }, // opcode 0x0D SUB
{ ExecuteSignedDataManip }, // opcode 0x0E MUL
{ ExecuteUnsignedDataManip }, // opcode 0x0F MULU
{ ExecuteSignedDataManip }, // opcode 0x10 DIV
{ ExecuteUnsignedDataManip }, // opcode 0x11 DIVU
{ ExecuteSignedDataManip }, // opcode 0x12 MOD
{ ExecuteUnsignedDataManip }, // opcode 0x13 MODU
{ ExecuteUnsignedDataManip }, // opcode 0x14 AND
{ ExecuteUnsignedDataManip }, // opcode 0x15 OR
{ ExecuteUnsignedDataManip }, // opcode 0x16 XOR
{ ExecuteUnsignedDataManip }, // opcode 0x17 SHL
{ ExecuteUnsignedDataManip }, // opcode 0x18 SHR
{ ExecuteSignedDataManip }, // opcode 0x19 ASHR
{ ExecuteUnsignedDataManip }, // opcode 0x1A EXTNDB
{ ExecuteUnsignedDataManip }, // opcode 0x1B EXTNDW
{ ExecuteUnsignedDataManip }, // opcode 0x1C EXTNDD
{ ExecuteMOVxx }, // opcode 0x1D MOVBW
{ ExecuteMOVxx }, // opcode 0x1E MOVWW
{ ExecuteMOVxx }, // opcode 0x1F MOVDW
{ ExecuteMOVxx }, // opcode 0x20 MOVQW
{ ExecuteMOVxx }, // opcode 0x21 MOVBD
{ ExecuteMOVxx }, // opcode 0x22 MOVWD
{ ExecuteMOVxx }, // opcode 0x23 MOVDD
{ ExecuteMOVxx }, // opcode 0x24 MOVQD
{ ExecuteMOVsnw }, // opcode 0x25 MOVsnw
{ ExecuteMOVsnd }, // opcode 0x26 MOVsnd
{ NULL }, // opcode 0x27
{ ExecuteMOVxx }, // opcode 0x28 MOVqq
{ ExecuteLOADSP }, // opcode 0x29 LOADSP SP1, R2
{ ExecuteSTORESP }, // opcode 0x2A STORESP R1, SP2
{ ExecutePUSH }, // opcode 0x2B PUSH {@}R1 [imm16]
{ ExecutePOP }, // opcode 0x2C POP {@}R1 [imm16]
{ ExecuteCMPI }, // opcode 0x2D CMPIEQ
{ ExecuteCMPI }, // opcode 0x2E CMPILTE
{ ExecuteCMPI }, // opcode 0x2F CMPIGTE
{ ExecuteCMPI }, // opcode 0x30 CMPIULTE
{ ExecuteCMPI }, // opcode 0x31 CMPIUGTE
{ ExecuteMOVxx }, // opcode 0x32 MOVN
{ ExecuteMOVxx }, // opcode 0x33 MOVND
{ NULL }, // opcode 0x34
{ ExecutePUSHn }, // opcode 0x35
{ ExecutePOPn }, // opcode 0x36
{ ExecuteMOVI }, // opcode 0x37 - mov immediate data
{ ExecuteMOVIn }, // opcode 0x38 - mov immediate natural
{ ExecuteMOVREL } // opcode 0x39 - move data relative to PC
};
//
// Length of JMP instructions, depending on upper two bits of opcode.
//
static CONST UINT8 mJMPLen[] = { 2, 2, 6, 10 };
//
// Simple Debugger Protocol GUID
//
EFI_GUID mEbcSimpleDebuggerProtocolGuid = EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL_GUID;
EFI_STATUS
EbcExecuteInstructions (
IN EFI_EBC_VM_TEST_PROTOCOL *This,
IN VM_CONTEXT *VmPtr,
IN OUT UINTN *InstructionCount
)
/*++
Routine Description:
Given a pointer to a new VM context, execute one or more instructions. This
function is only used for test purposes via the EBC VM test protocol.
Arguments:
This - pointer to protocol interface
VmPtr - pointer to a VM context
InstructionCount - how many instructions to execute. 0 if don't count.
Returns:
EFI_UNSUPPORTED
EFI_SUCCESS
--*/
{
UINTN ExecFunc;
EFI_STATUS Status;
UINTN InstructionsLeft;
UINTN SavedInstructionCount;
Status = EFI_SUCCESS;
if (*InstructionCount == 0) {
InstructionsLeft = 1;
} else {
InstructionsLeft = *InstructionCount;
}
SavedInstructionCount = *InstructionCount;
*InstructionCount = 0;
//
// Index into the opcode table using the opcode byte for this instruction.
// This gives you the execute function, which we first test for null, then
// call it if it's not null.
//
while (InstructionsLeft != 0) {
ExecFunc = (UINTN) mVmOpcodeTable[(*VmPtr->Ip & 0x3F)].ExecuteFunction;
if (ExecFunc == (UINTN) NULL) {
EbcDebugSignalException (EXCEPT_EBC_INVALID_OPCODE, EXCEPTION_FLAG_FATAL, VmPtr);
return EFI_UNSUPPORTED;
} else {
mVmOpcodeTable[(*VmPtr->Ip & 0x3F)].ExecuteFunction (VmPtr);
*InstructionCount = *InstructionCount + 1;
}
//
// Decrement counter if applicable
//
if (SavedInstructionCount != 0) {
InstructionsLeft--;
}
}
return Status;
}
EFI_STATUS
EbcExecute (
IN VM_CONTEXT *VmPtr
)
/*++
Routine Description:
Execute an EBC image from an entry point or from a published protocol.
Arguments:
VmPtr - pointer to prepared VM context.
Returns:
Standard EBC status.
--*/
{
UINTN ExecFunc;
UINT8 StackCorrupted;
EFI_STATUS Status;
EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL *EbcSimpleDebugger;
//
// end DEBUG_CODE
//
EbcSimpleDebugger = NULL;
Status = EFI_SUCCESS;
StackCorrupted = 0;
//
// Make sure the magic value has been put on the stack before we got here.
//
if (*VmPtr->StackMagicPtr != (UINTN) VM_STACK_KEY_VALUE) {
StackCorrupted = 1;
}
VmPtr->FramePtr = (VOID *) ((UINT8 *) (UINTN) VmPtr->R[0] + 8);
//
// Try to get the debug support for EBC
//
DEBUG_CODE (
Status = gBS->LocateProtocol (
&mEbcSimpleDebuggerProtocolGuid,
NULL,
(VOID **) &EbcSimpleDebugger
);
if (EFI_ERROR (Status)) {
EbcSimpleDebugger = NULL;
}
);
//
// Save the start IP for debug. For example, if we take an exception we
// can print out the location of the exception relative to the entry point,
// which could then be used in a disassembly listing to find the problem.
//
VmPtr->EntryPoint = (VOID *) VmPtr->Ip;
//
// We'll wait for this flag to know when we're done. The RET
// instruction sets it if it runs out of stack.
//
VmPtr->StopFlags = 0;
while (!(VmPtr->StopFlags & STOPFLAG_APP_DONE)) {
//
// If we've found a simple debugger protocol, call it
//
DEBUG_CODE (
if (EbcSimpleDebugger != NULL) {
EbcSimpleDebugger->Debugger (EbcSimpleDebugger, VmPtr);
}
);
//
// Verify the opcode is in range. Otherwise generate an exception.
//
if ((*VmPtr->Ip & OPCODE_M_OPCODE) >= (sizeof (mVmOpcodeTable) / sizeof (mVmOpcodeTable[0]))) {
EbcDebugSignalException (EXCEPT_EBC_INVALID_OPCODE, EXCEPTION_FLAG_FATAL, VmPtr);
Status = EFI_UNSUPPORTED;
goto Done;
}
//
// Use the opcode bits to index into the opcode dispatch table. If the
// function pointer is null then generate an exception.
//
ExecFunc = (UINTN) mVmOpcodeTable[(*VmPtr->Ip & OPCODE_M_OPCODE)].ExecuteFunction;
if (ExecFunc == (UINTN) NULL) {
EbcDebugSignalException (EXCEPT_EBC_INVALID_OPCODE, EXCEPTION_FLAG_FATAL, VmPtr);
Status = EFI_UNSUPPORTED;
goto Done;
}
//
// The EBC VM is a strongly ordered processor, so perform a fence operation before
// and after each instruction is executed.
//
MemoryFence ();
mVmOpcodeTable[(*VmPtr->Ip & OPCODE_M_OPCODE)].ExecuteFunction (VmPtr);
MemoryFence ();
//
// If the step flag is set, signal an exception and continue. We don't
// clear it here. Assuming the debugger is responsible for clearing it.
//
if (VMFLAG_ISSET (VmPtr, VMFLAGS_STEP)) {
EbcDebugSignalException (EXCEPT_EBC_STEP, EXCEPTION_FLAG_NONE, VmPtr);
}
//
// Make sure stack has not been corrupted. Only report it once though.
//
if (!StackCorrupted && (*VmPtr->StackMagicPtr != (UINTN) VM_STACK_KEY_VALUE)) {
EbcDebugSignalException (EXCEPT_EBC_STACK_FAULT, EXCEPTION_FLAG_FATAL, VmPtr);
StackCorrupted = 1;
}
}
Done:
return Status;
}
STATIC
EFI_STATUS
ExecuteMOVxx (
IN VM_CONTEXT *VmPtr
)
/*++
Routine Description:
Execute the MOVxx instructions.
Arguments:
VmPtr - pointer to a VM context.
Returns:
EFI_UNSUPPORTED
EFI_SUCCESS
Instruction format:
MOV[b|w|d|q|n]{w|d} {@}R1 {Index16|32}, {@}R2 {Index16|32}
MOVqq {@}R1 {Index64}, {@}R2 {Index64}
Copies contents of [R2] -> [R1], zero extending where required.
First character indicates the size of the move.
Second character indicates the size of the index(s).
Invalid to have R1 direct with index.
--*/
{
UINT8 Opcode;
UINT8 OpcMasked;
UINT8 Operands;
UINT8 Size;
UINT8 MoveSize;
INT16 Index16;
INT32 Index32;
INT64 Index64Op1;
INT64 Index64Op2;
UINT64 Data64;
UINT64 DataMask;
UINTN Source;
Opcode = GETOPCODE (VmPtr);
OpcMasked = (UINT8) (Opcode & OPCODE_M_OPCODE);
//
// Get the operands byte so we can get R1 and R2
//
Operands = GETOPERANDS (VmPtr);
//
// Assume no indexes
//
Index64Op1 = 0;
Index64Op2 = 0;
Data64 = 0;
//
// Determine if we have an index/immediate data. Base instruction size
// is 2 (opcode + operands). Add to this size each index specified.
//
Size = 2;
if (Opcode & (OPCODE_M_IMMED_OP1 | OPCODE_M_IMMED_OP2)) {
//
// Determine size of the index from the opcode. Then get it.
//
if ((OpcMasked <= OPCODE_MOVQW) || (OpcMasked == OPCODE_MOVNW)) {
//
// MOVBW, MOVWW, MOVDW, MOVQW, and MOVNW have 16-bit immediate index.
// Get one or both index values.
//
if (Opcode & OPCODE_M_IMMED_OP1) {
Index16 = VmReadIndex16 (VmPtr, 2);
Index64Op1 = (INT64) Index16;
Size += sizeof (UINT16);
}
if (Opcode & OPCODE_M_IMMED_OP2) {
Index16 = VmReadIndex16 (VmPtr, Size);
Index64Op2 = (INT64) Index16;
Size += sizeof (UINT16);
}
} else if ((OpcMasked <= OPCODE_MOVQD) || (OpcMasked == OPCODE_MOVND)) {
//
// MOVBD, MOVWD, MOVDD, MOVQD, and MOVND have 32-bit immediate index
//
if (Opcode & OPCODE_M_IMMED_OP1) {
Index32 = VmReadIndex32 (VmPtr, 2);
Index64Op1 = (INT64) Index32;
Size += sizeof (UINT32);
}
if (Opcode & OPCODE_M_IMMED_OP2) {
Index32 = VmReadIndex32 (VmPtr, Size);
Index64Op2 = (INT64) Index32;
Size += sizeof (UINT32);
}
} else if (OpcMasked == OPCODE_MOVQQ) {
//
// MOVqq -- only form with a 64-bit index
//
if (Opcode & OPCODE_M_IMMED_OP1) {
Index64Op1 = VmReadIndex64 (VmPtr, 2);
Size += sizeof (UINT64);
}
if (Opcode & OPCODE_M_IMMED_OP2) {
Index64Op2 = VmReadIndex64 (VmPtr, Size);
Size += sizeof (UINT64);
}
} else {
//
// Obsolete MOVBQ, MOVWQ, MOVDQ, and MOVNQ have 64-bit immediate index
//
EbcDebugSignalException (
EXCEPT_EBC_INSTRUCTION_ENCODING,
EXCEPTION_FLAG_FATAL,
VmPtr
);
return EFI_UNSUPPORTED;
}
}
//
// Determine the size of the move, and create a mask for it so we can
// clear unused bits.
//
if ((OpcMasked == OPCODE_MOVBW) || (OpcMasked == OPCODE_MOVBD)) {
MoveSize = DATA_SIZE_8;
DataMask = 0xFF;
} else if ((OpcMasked == OPCODE_MOVWW) || (OpcMasked == OPCODE_MOVWD)) {
MoveSize = DATA_SIZE_16;
DataMask = 0xFFFF;
} else if ((OpcMasked == OPCODE_MOVDW) || (OpcMasked == OPCODE_MOVDD)) {
MoveSize = DATA_SIZE_32;
DataMask = 0xFFFFFFFF;
} else if ((OpcMasked == OPCODE_MOVQW) || (OpcMasked == OPCODE_MOVQD) || (OpcMasked == OPCODE_MOVQQ)) {
MoveSize = DATA_SIZE_64;
DataMask = (UINT64)~0;
} else if ((OpcMasked == OPCODE_MOVNW) || (OpcMasked == OPCODE_MOVND)) {
MoveSize = DATA_SIZE_N;
DataMask = (UINT64)~0 >> (64 - 8 * sizeof (UINTN));
} else {
//
// We were dispatched to this function and we don't recognize the opcode
//
EbcDebugSignalException (EXCEPT_EBC_UNDEFINED, EXCEPTION_FLAG_FATAL, VmPtr);
return EFI_UNSUPPORTED;
}
//
// Now get the source address
//
if (OPERAND2_INDIRECT (Operands)) {
//
// Indirect form @R2. Compute address of operand2
//
Source = (UINTN) (VmPtr->R[OPERAND2_REGNUM (Operands)] + Index64Op2);
//
// Now get the data from the source. Always 0-extend and let the compiler
// sign-extend where required.
//
switch (MoveSize) {
case DATA_SIZE_8:
Data64 = (UINT64) (UINT8) VmReadMem8 (VmPtr, Source);
break;
case DATA_SIZE_16:
Data64 = (UINT64) (UINT16) VmReadMem16 (VmPtr, Source);
break;
case DATA_SIZE_32:
Data64 = (UINT64) (UINT32) VmReadMem32 (VmPtr, Source);
break;
case DATA_SIZE_64:
Data64 = (UINT64) VmReadMem64 (VmPtr, Source);
break;
case DATA_SIZE_N:
Data64 = (UINT64) (UINTN) VmReadMemN (VmPtr, Source);
break;
default:
//
// not reached
//
break;
}
} else {
//
// Not indirect source: MOVxx {@}Rx, Ry [Index]
//
Data64 = VmPtr->R[OPERAND2_REGNUM (Operands)] + Index64Op2;
//
// Did Operand2 have an index? If so, treat as two signed values since
// indexes are signed values.
//
if (Opcode & OPCODE_M_IMMED_OP2) {
//
// NOTE: need to find a way to fix this, most likely by changing the VM
// implementation to remove the stack gap. To do that, we'd need to
// allocate stack space for the VM and actually set the system
// stack pointer to the allocated buffer when the VM starts.
//
// Special case -- if someone took the address of a function parameter
// then we need to make sure it's not in the stack gap. We can identify
// this situation if (Operand2 register == 0) && (Operand2 is direct)
// && (Index applies to Operand2) && (Index > 0) && (Operand1 register != 0)
// Situations that to be aware of:
// * stack adjustments at beginning and end of functions R0 = R0 += stacksize
//
if ((OPERAND2_REGNUM (Operands) == 0) &&
(!OPERAND2_INDIRECT (Operands)) &&
(Index64Op2 > 0) &&
(OPERAND1_REGNUM (Operands) == 0) &&
(OPERAND1_INDIRECT (Operands))
) {
Data64 = (UINT64) ConvertStackAddr (VmPtr, (UINTN) (INT64) Data64);
}
}
}
//
// Now write it back
//
if (OPERAND1_INDIRECT (Operands)) {
//
// Reuse the Source variable to now be dest.
//
Source = (UINTN) (VmPtr->R[OPERAND1_REGNUM (Operands)] + Index64Op1);
//
// Do the write based on the size
//
switch (MoveSize) {
case DATA_SIZE_8:
VmWriteMem8 (VmPtr, Source, (UINT8) Data64);
break;
case DATA_SIZE_16:
VmWriteMem16 (VmPtr, Source, (UINT16) Data64);
break;
case DATA_SIZE_32:
VmWriteMem32 (VmPtr, Source, (UINT32) Data64);
break;
case DATA_SIZE_64:
VmWriteMem64 (VmPtr, Source, Data64);
break;
case DATA_SIZE_N:
VmWriteMemN (VmPtr, Source, (UINTN) Data64);
break;
default:
//
// not reached
//
break;
}
} else {
//
// Operand1 direct.
// Make sure we didn't have an index on operand1.
//
if (Opcode & OPCODE_M_IMMED_OP1) {
EbcDebugSignalException (
EXCEPT_EBC_INSTRUCTION_ENCODING,
EXCEPTION_FLAG_FATAL,
VmPtr
);
return EFI_UNSUPPORTED;
}
//
// Direct storage in register. Clear unused bits and store back to
// register.
//
VmPtr->R[OPERAND1_REGNUM (Operands)] = Data64 & DataMask;
}
//
// Advance the instruction pointer
//
VmPtr->Ip += Size;
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
ExecuteBREAK (
IN VM_CONTEXT *VmPtr
)
/*++
Routine Description:
Execute the EBC BREAK instruction
Arguments:
VmPtr - pointer to current VM context
Returns:
EFI_UNSUPPORTED
EFI_SUCCESS
--*/
{
UINT8 Operands;
VOID *EbcEntryPoint;
VOID *Thunk;
EFI_STATUS Status;
UINT64 U64EbcEntryPoint;
INT32 Offset;
Operands = GETOPERANDS (VmPtr);
switch (Operands) {
//
// Runaway program break. Generate an exception and terminate
//
case 0:
EbcDebugSignalException (EXCEPT_EBC_BAD_BREAK, EXCEPTION_FLAG_FATAL, VmPtr);
break;
//
// Get VM version -- return VM revision number in R7
//
case 1:
//
// Bits:
// 63-17 = 0
// 16-8 = Major version
// 7-0 = Minor version
//
VmPtr->R[7] = GetVmVersion ();
break;
//
// Debugger breakpoint
//
case 3:
VmPtr->StopFlags |= STOPFLAG_BREAKPOINT;
//
// See if someone has registered a handler
//
EbcDebugSignalException (
EXCEPT_EBC_BREAKPOINT,
EXCEPTION_FLAG_NONE,
VmPtr
);
//
// Don't advance the IP
//
return EFI_UNSUPPORTED;
break;
//
// System call, which there are none, so NOP it.
//
case 4:
break;
//
// Create a thunk for EBC code. R7 points to a 32-bit (in a 64-bit slot)
// "offset from self" pointer to the EBC entry point.
// After we're done, *(UINT64 *)R7 will be the address of the new thunk.
//
case 5:
Offset = (INT32) VmReadMem32 (VmPtr, (UINTN) VmPtr->R[7]);
U64EbcEntryPoint = (UINT64) (VmPtr->R[7] + Offset + 4);
EbcEntryPoint = (VOID *) (UINTN) U64EbcEntryPoint;
//
// Now create a new thunk
//
Status = EbcCreateThunks (VmPtr->ImageHandle, EbcEntryPoint, &Thunk, 0);
//
// Finally replace the EBC entry point memory with the thunk address
//
VmWriteMem64 (VmPtr, (UINTN) VmPtr->R[7], (UINT64) (UINTN) Thunk);
break;
//
// Compiler setting version per value in R7
//
case 6:
VmPtr->CompilerVersion = (UINT32) VmPtr->R[7];
//
// Check compiler version against VM version?
//
break;
//
// Unhandled break code. Signal exception.
//
default:
EbcDebugSignalException (EXCEPT_EBC_BAD_BREAK, EXCEPTION_FLAG_FATAL, VmPtr);
break;
}
//
// Advance IP
//
VmPtr->Ip += 2;
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
ExecuteJMP (
IN VM_CONTEXT *VmPtr
)
/*++
Routine Description:
Execute the JMP instruction
Arguments:
VmPtr - pointer to VM context
Returns:
Standard EFI_STATUS
Instruction syntax:
JMP64{cs|cc} Immed64
JMP32{cs|cc} {@}R1 {Immed32|Index32}
Encoding:
b0.7 - immediate data present
b0.6 - 1 = 64 bit immediate data
0 = 32 bit immediate data
b1.7 - 1 = conditional
b1.6 1 = CS (condition set)
0 = CC (condition clear)
b1.4 1 = relative address
0 = absolute address
b1.3 1 = operand1 indirect
b1.2-0 operand 1
--*/
{
UINT8 Opcode;
UINT8 CompareSet;
UINT8 ConditionFlag;
UINT8 Size;
UINT8 Operand;
UINT64 Data64;
INT32 Index32;
UINTN Addr;
Operand = GETOPERANDS (VmPtr);
Opcode = GETOPCODE (VmPtr);
//
// Get instruction length from the opcode. The upper two bits are used here
// to index into the length array.
//
Size = mJMPLen[(Opcode >> 6) & 0x03];
//
// Decode instruction conditions
// If we haven't met the condition, then simply advance the IP and return.
//
CompareSet = (UINT8) ((Operand & JMP_M_CS) ? 1 : 0);
ConditionFlag = (UINT8) VMFLAG_ISSET (VmPtr, VMFLAGS_CC);
if (Operand & CONDITION_M_CONDITIONAL) {
if (CompareSet != ConditionFlag) {
VmPtr->Ip += Size;
return EFI_SUCCESS;
}
}
//
// Check for 64-bit form and do it right away since it's the most
// straight-forward form.
//
if (Opcode & OPCODE_M_IMMDATA64) {
//
// Double check for immediate-data, which is required. If not there,
// then signal an exception
//
if (!(Opcode & OPCODE_M_IMMDATA)) {
EbcDebugSignalException (
EXCEPT_EBC_INSTRUCTION_ENCODING,
EXCEPTION_FLAG_ERROR,
VmPtr
);
return EFI_UNSUPPORTED;
}
//
// 64-bit immediate data is full address. Read the immediate data,
// check for alignment, and jump absolute.
//
Data64 = VmReadImmed64 (VmPtr, 2);
if (!IS_ALIGNED ((UINTN) Data64, sizeof (UINT16))) {
EbcDebugSignalException (
EXCEPT_EBC_ALIGNMENT_CHECK,
EXCEPTION_FLAG_FATAL,
VmPtr
);
return EFI_UNSUPPORTED;
}
//
// Take jump -- relative or absolute
//
if (Operand & JMP_M_RELATIVE) {
VmPtr->Ip += (UINTN) Data64 + Size;
} else {
VmPtr->Ip = (VMIP) (UINTN) Data64;
}
return EFI_SUCCESS;
}
//
// 32-bit forms:
// Get the index if there is one. May be either an index, or an immediate
// offset depending on indirect operand.
// JMP32 @R1 Index32 -- immediate data is an index
// JMP32 R1 Immed32 -- immedate data is an offset
//
if (Opcode & OPCODE_M_IMMDATA) {
if (OPERAND1_INDIRECT (Operand)) {
Index32 = VmReadIndex32 (VmPtr, 2);
} else {
Index32 = VmReadImmed32 (VmPtr, 2);
}
} else {
Index32 = 0;
}
//
// Get the register data. If R == 0, then special case where it's ignored.
//
if (OPERAND1_REGNUM (Operand) == 0) {
Data64 = 0;
} else {
Data64 = OPERAND1_REGDATA (VmPtr, Operand);
}
//
// Decode the forms
//
if (OPERAND1_INDIRECT (Operand)) {
//
// Form: JMP32 @Rx {Index32}
//
Addr = VmReadMemN (VmPtr, (UINTN) Data64 + Index32);
if (!IS_ALIGNED ((UINTN) Addr, sizeof (UINT16))) {
EbcDebugSignalException (
EXCEPT_EBC_ALIGNMENT_CHECK,
EXCEPTION_FLAG_FATAL,
VmPtr
);
return EFI_UNSUPPORTED;
}
if (Operand & JMP_M_RELATIVE) {
VmPtr->Ip += (UINTN) Addr + Size;
} else {
VmPtr->Ip = (VMIP) Addr;
}
} else {
//
// Form: JMP32 Rx {Immed32}
//
Addr = (UINTN) (Data64 + Index32);
if (!IS_ALIGNED ((UINTN) Addr, sizeof (UINT16))) {
EbcDebugSignalException (
EXCEPT_EBC_ALIGNMENT_CHECK,
EXCEPTION_FLAG_FATAL,
VmPtr
);
return EFI_UNSUPPORTED;
}
if (Operand & JMP_M_RELATIVE) {
VmPtr->Ip += (UINTN) Addr + Size;
} else {
VmPtr->Ip = (VMIP) Addr;
}
}
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
ExecuteJMP8 (
IN VM_CONTEXT *VmPtr
)
/*++
Routine Description:
Execute the EBC JMP8 instruction
Arguments:
VmPtr - pointer to a VM context
Returns:
Standard EFI_STATUS
Instruction syntax:
JMP8{cs|cc} Offset/2
--*/
{
UINT8 Opcode;
UINT8 ConditionFlag;
UINT8 CompareSet;
INT8 Offset;
//
// Decode instruction.
//
Opcode = GETOPCODE (VmPtr);
CompareSet = (UINT8) ((Opcode & JMP_M_CS) ? 1 : 0);
ConditionFlag = (UINT8) VMFLAG_ISSET (VmPtr, VMFLAGS_CC);
//
// If we haven't met the condition, then simply advance the IP and return
//
if (Opcode & CONDITION_M_CONDITIONAL) {
if (CompareSet != ConditionFlag) {
VmPtr->Ip += 2;
return EFI_SUCCESS;
}
}
//
// Get the offset from the instruction stream. It's relative to the
// following instruction, and divided by 2.
//
Offset = VmReadImmed8 (VmPtr, 1);
//
// Want to check for offset == -2 and then raise an exception?
//
VmPtr->Ip += (Offset * 2) + 2;
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
ExecuteMOVI (
IN VM_CONTEXT *VmPtr
)
/*++
Routine Description:
Execute the EBC MOVI
Arguments:
VmPtr - pointer to a VM context
Returns:
Standard EFI_STATUS
Instruction syntax:
MOVI[b|w|d|q][w|d|q] {@}R1 {Index16}, ImmData16|32|64
First variable character specifies the move size
Second variable character specifies size of the immediate data
Sign-extend the immediate data to the size of the operation, and zero-extend
if storing to a register.
Operand1 direct with index/immed is invalid.
--*/
{
UINT8 Opcode;
UINT8 Operands;
UINT8 Size;
INT16 Index16;
INT64 ImmData64;
UINT64 Op1;
UINT64 Mask64;
//
// Get the opcode and operands byte so we can get R1 and R2
//
Opcode = GETOPCODE (VmPtr);
Operands = GETOPERANDS (VmPtr);
//
// Get the index (16-bit) if present
//
if (Operands & MOVI_M_IMMDATA) {
Index16 = VmReadIndex16 (VmPtr, 2);
Size = 4;
} else {
Index16 = 0;
Size = 2;
}
//
// Extract the immediate data. Sign-extend always.
//
if ((Opcode & MOVI_M_DATAWIDTH) == MOVI_DATAWIDTH16) {
ImmData64 = (INT64) (INT16) VmReadImmed16 (VmPtr, Size);
Size += 2;
} else if ((Opcode & MOVI_M_DATAWIDTH) == MOVI_DATAWIDTH32) {
ImmData64 = (INT64) (INT32) VmReadImmed32 (VmPtr, Size);
Size += 4;
} else if ((Opcode & MOVI_M_DATAWIDTH) == MOVI_DATAWIDTH64) {
ImmData64 = (INT64) VmReadImmed64 (VmPtr, Size);
Size += 8;
} else {
//
// Invalid encoding
//
EbcDebugSignalException (
EXCEPT_EBC_INSTRUCTION_ENCODING,
EXCEPTION_FLAG_FATAL,
VmPtr
);
return EFI_UNSUPPORTED;
}
//
// Now write back the result
//
if (!OPERAND1_INDIRECT (Operands)) {
//
// Operand1 direct. Make sure it didn't have an index.
//
if (Operands & MOVI_M_IMMDATA) {
EbcDebugSignalException (
EXCEPT_EBC_INSTRUCTION_ENCODING,
EXCEPTION_FLAG_FATAL,
VmPtr
);
return EFI_UNSUPPORTED;
}
//
// Writing directly to a register. Clear unused bits.
//
if ((Operands & MOVI_M_MOVEWIDTH) == MOVI_MOVEWIDTH8) {
Mask64 = 0x000000FF;
} else if ((Operands & MOVI_M_MOVEWIDTH) == MOVI_MOVEWIDTH16) {
Mask64 = 0x0000FFFF;
} else if ((Operands & MOVI_M_MOVEWIDTH) == MOVI_MOVEWIDTH32) {
Mask64 = 0x00000000FFFFFFFF;
} else {
Mask64 = (UINT64)~0;
}
VmPtr->R[OPERAND1_REGNUM (Operands)] = ImmData64 & Mask64;
} else {
//
// Get the address then write back based on size of the move
//
Op1 = (UINT64) VmPtr->R[OPERAND1_REGNUM (Operands)] + Index16;
if ((Operands & MOVI_M_MOVEWIDTH) == MOVI_MOVEWIDTH8) {
VmWriteMem8 (VmPtr, (UINTN) Op1, (UINT8) ImmData64);
} else if ((Operands & MOVI_M_MOVEWIDTH) == MOVI_MOVEWIDTH16) {
VmWriteMem16 (VmPtr, (UINTN) Op1, (UINT16) ImmData64);
} else if ((Operands & MOVI_M_MOVEWIDTH) == MOVI_MOVEWIDTH32) {
VmWriteMem32 (VmPtr, (UINTN) Op1, (UINT32) ImmData64);
} else {
VmWriteMem64 (VmPtr, (UINTN) Op1, ImmData64);
}
}
//
// Advance the instruction pointer
//
VmPtr->Ip += Size;
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
ExecuteMOVIn (
IN VM_CONTEXT *VmPtr
)
/*++
Routine Description:
Execute the EBC MOV immediate natural. This instruction moves an immediate
index value into a register or memory location.
Arguments:
VmPtr - pointer to a VM context
Returns:
Standard EFI_STATUS
Instruction syntax:
MOVIn[w|d|q] {@}R1 {Index16}, Index16|32|64
--*/
{
UINT8 Opcode;
UINT8 Operands;
UINT8 Size;
INT16 Index16;
INT16 ImmedIndex16;
INT32 ImmedIndex32;
INT64 ImmedIndex64;
UINT64 Op1;
//
// Get the opcode and operands byte so we can get R1 and R2
//
Opcode = GETOPCODE (VmPtr);
Operands = GETOPERANDS (VmPtr);
//
// Get the operand1 index (16-bit) if present
//
if (Operands & MOVI_M_IMMDATA) {
Index16 = VmReadIndex16 (VmPtr, 2);
Size = 4;
} else {
Index16 = 0;
Size = 2;
}
//
// Extract the immediate data and convert to a 64-bit index.
//
if ((Opcode & MOVI_M_DATAWIDTH) == MOVI_DATAWIDTH16) {
ImmedIndex16 = VmReadIndex16 (VmPtr, Size);
ImmedIndex64 = (INT64) ImmedIndex16;
Size += 2;
} else if ((Opcode & MOVI_M_DATAWIDTH) == MOVI_DATAWIDTH32) {
ImmedIndex32 = VmReadIndex32 (VmPtr, Size);
ImmedIndex64 = (INT64) ImmedIndex32;
Size += 4;
} else if ((Opcode & MOVI_M_DATAWIDTH) == MOVI_DATAWIDTH64) {
ImmedIndex64 = VmReadIndex64 (VmPtr, Size);
Size += 8;
} else {
//
// Invalid encoding
//
EbcDebugSignalException (
EXCEPT_EBC_INSTRUCTION_ENCODING,
EXCEPTION_FLAG_FATAL,
VmPtr
);
return EFI_UNSUPPORTED;
}
//
// Now write back the result
//
if (!OPERAND1_INDIRECT (Operands)) {
//
// Check for MOVIn R1 Index16, Immed (not indirect, with index), which
// is illegal
//
if (Operands & MOVI_M_IMMDATA) {
EbcDebugSignalException (
EXCEPT_EBC_INSTRUCTION_ENCODING,
EXCEPTION_FLAG_FATAL,
VmPtr
);
return EFI_UNSUPPORTED;
}
VmPtr->R[OPERAND1_REGNUM (Operands)] = ImmedIndex64;
} else {
//
// Get the address
//
Op1 = (UINT64) VmPtr->R[OPERAND1_REGNUM (Operands)] + Index16;
VmWriteMemN (VmPtr, (UINTN) Op1, (INTN) ImmedIndex64);
}
//
// Advance the instruction pointer
//
VmPtr->Ip += Size;
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
ExecuteMOVREL (
IN VM_CONTEXT *VmPtr
)
/*++
Routine Description:
Execute the EBC MOVREL instruction.
Dest <- Ip + ImmData
Arguments:
VmPtr - pointer to a VM context
Returns:
Standard EFI_STATUS
Instruction syntax:
MOVREL[w|d|q] {@}R1 {Index16}, ImmData16|32|64
--*/
{
UINT8 Opcode;
UINT8 Operands;
UINT8 Size;
INT16 Index16;
INT64 ImmData64;
UINT64 Op1;
UINT64 Op2;
//
// Get the opcode and operands byte so we can get R1 and R2
//
Opcode = GETOPCODE (VmPtr);
Operands = GETOPERANDS (VmPtr);
//
// Get the Operand 1 index (16-bit) if present
//
if (Operands & MOVI_M_IMMDATA) {
Index16 = VmReadIndex16 (VmPtr, 2);
Size = 4;
} else {
Index16 = 0;
Size = 2;
}
//
// Get the immediate data.
//
if ((Opcode & MOVI_M_DATAWIDTH) == MOVI_DATAWIDTH16) {
ImmData64 = (INT64) VmReadImmed16 (VmPtr, Size);
Size += 2;
} else if ((Opcode & MOVI_M_DATAWIDTH) == MOVI_DATAWIDTH32) {
ImmData64 = (INT64) VmReadImmed32 (VmPtr, Size);
Size += 4;
} else if ((Opcode & MOVI_M_DATAWIDTH) == MOVI_DATAWIDTH64) {
ImmData64 = VmReadImmed64 (VmPtr, Size);
Size += 8;
} else {
//
// Invalid encoding
//
EbcDebugSignalException (
EXCEPT_EBC_INSTRUCTION_ENCODING,
EXCEPTION_FLAG_FATAL,
VmPtr
);
return EFI_UNSUPPORTED;
}
//
// Compute the value and write back the result
//
Op2 = (UINT64) ((INT64) ((UINT64) (UINTN) VmPtr->Ip) + (INT64) ImmData64 + Size);
if (!OPERAND1_INDIRECT (Operands)) {
//
// Check for illegal combination of operand1 direct with immediate data
//
if (Operands & MOVI_M_IMMDATA) {
EbcDebugSignalException (
EXCEPT_EBC_INSTRUCTION_ENCODING,
EXCEPTION_FLAG_FATAL,
VmPtr
);
return EFI_UNSUPPORTED;
}
VmPtr->R[OPERAND1_REGNUM (Operands)] = (VM_REGISTER) Op2;
} else {
//
// Get the address = [Rx] + Index16
// Write back the result. Always a natural size write, since
// we're talking addresses here.
//
Op1 = (UINT64) VmPtr->R[OPERAND1_REGNUM (Operands)] + Index16;
VmWriteMemN (VmPtr, (UINTN) Op1, (UINTN) Op2);
}
//
// Advance the instruction pointer
//
VmPtr->Ip += Size;
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
ExecuteMOVsnw (
IN VM_CONTEXT *VmPtr
)
/*++
Routine Description:
Execute the EBC MOVsnw instruction. This instruction loads a signed
natural value from memory or register to another memory or register. On
32-bit machines, the value gets sign-extended to 64 bits if the destination
is a register.
Arguments:
VmPtr - pointer to a VM context
Returns:
Standard EFI_STATUS
Instruction syntax:
MOVsnw {@}R1 {Index16}, {@}R2 {Index16|Immed16}
0:7 1=>operand1 index present
0:6 1=>operand2 index present
--*/
{
UINT8 Opcode;
UINT8 Operands;
UINT8 Size;
INT16 Op1Index;
INT16 Op2Index;
UINT64 Op2;
//
// Get the opcode and operand bytes
//
Opcode = GETOPCODE (VmPtr);
Operands = GETOPERANDS (VmPtr);
Op1Index = Op2Index = 0;
//
// Get the indexes if present.
//
Size = 2;
if (Opcode & OPCODE_M_IMMED_OP1) {
if (OPERAND1_INDIRECT (Operands)) {
Op1Index = VmReadIndex16 (VmPtr, 2);
} else {
//
// Illegal form operand1 direct with index: MOVsnw R1 Index16, {@}R2
//
EbcDebugSignalException (
EXCEPT_EBC_INSTRUCTION_ENCODING,
EXCEPTION_FLAG_FATAL,
VmPtr
);
return EFI_UNSUPPORTED;
}
Size += sizeof (UINT16);
}
if (Opcode & OPCODE_M_IMMED_OP2) {
if (OPERAND2_INDIRECT (Operands)) {
Op2Index = VmReadIndex16 (VmPtr, Size);
} else {
Op2Index = VmReadImmed16 (VmPtr, Size);
}
Size += sizeof (UINT16);
}
//
// Get the data from the source.
//
Op2 = (INT64) ((INTN) (VmPtr->R[OPERAND2_REGNUM (Operands)] + Op2Index));
if (OPERAND2_INDIRECT (Operands)) {
Op2 = (INT64) (INTN) VmReadMemN (VmPtr, (UINTN) Op2);
}
//
// Now write back the result.
//
if (!OPERAND1_INDIRECT (Operands)) {
VmPtr->R[OPERAND1_REGNUM (Operands)] = Op2;
} else {
VmWriteMemN (VmPtr, (UINTN) (VmPtr->R[OPERAND1_REGNUM (Operands)] + Op1Index), (UINTN) Op2);
}
//
// Advance the instruction pointer
//
VmPtr->Ip += Size;
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
ExecuteMOVsnd (
IN VM_CONTEXT *VmPtr
)
/*++
Routine Description:
Execute the EBC MOVsnw instruction. This instruction loads a signed
natural value from memory or register to another memory or register. On
32-bit machines, the value gets sign-extended to 64 bits if the destination
is a register.
Arguments:
VmPtr - pointer to a VM context
Returns:
Standard EFI_STATUS
Instruction syntax:
MOVsnd {@}R1 {Indx32}, {@}R2 {Index32|Immed32}
0:7 1=>operand1 index present
0:6 1=>operand2 index present
--*/
{
UINT8 Opcode;
UINT8 Operands;
UINT8 Size;
INT32 Op1Index;
INT32 Op2Index;
UINT64 Op2;
//
// Get the opcode and operand bytes
//
Opcode = GETOPCODE (VmPtr);
Operands = GETOPERANDS (VmPtr);
Op1Index = Op2Index = 0;
//
// Get the indexes if present.
//
Size = 2;
if (Opcode & OPCODE_M_IMMED_OP1) {
if (OPERAND1_INDIRECT (Operands)) {
Op1Index = VmReadIndex32 (VmPtr, 2);
} else {
//
// Illegal form operand1 direct with index: MOVsnd R1 Index16,..
//
EbcDebugSignalException (
EXCEPT_EBC_INSTRUCTION_ENCODING,
EXCEPTION_FLAG_FATAL,
VmPtr
);
return EFI_UNSUPPORTED;
}
Size += sizeof (UINT32);
}
if (Opcode & OPCODE_M_IMMED_OP2) {
if (OPERAND2_INDIRECT (Operands)) {
Op2Index = VmReadIndex32 (VmPtr, Size);
} else {
Op2Index = VmReadImmed32 (VmPtr, Size);
}
Size += sizeof (UINT32);
}
//
// Get the data from the source.
//
Op2 = (INT64) ((INTN) (VmPtr->R[OPERAND2_REGNUM (Operands)] + Op2Index));
if (OPERAND2_INDIRECT (Operands)) {
Op2 = (INT64) (INTN) VmReadMemN (VmPtr, (UINTN) Op2);
}
//
// Now write back the result.
//
if (!OPERAND1_INDIRECT (Operands)) {
VmPtr->R[OPERAND1_REGNUM (Operands)] = Op2;
} else {
VmWriteMemN (VmPtr, (UINTN) (VmPtr->R[OPERAND1_REGNUM (Operands)] + Op1Index), (UINTN) Op2);
}
//
// Advance the instruction pointer
//
VmPtr->Ip += Size;
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
ExecutePUSHn (
IN VM_CONTEXT *VmPtr
)
/*++
Routine Description:
Execute the EBC PUSHn instruction
Arguments:
VmPtr - pointer to a VM context
Returns:
Standard EFI_STATUS
Instruction syntax:
PUSHn {@}R1 {Index16|Immed16}
--*/
{
UINT8 Opcode;
UINT8 Operands;
INT16 Index16;
UINTN DataN;
//
// Get opcode and operands
//
Opcode = GETOPCODE (VmPtr);
Operands = GETOPERANDS (VmPtr);
//
// Get index if present
//
if (Opcode & PUSHPOP_M_IMMDATA) {
if (OPERAND1_INDIRECT (Operands)) {
Index16 = VmReadIndex16 (VmPtr, 2);
} else {
Index16 = VmReadImmed16 (VmPtr, 2);
}
VmPtr->Ip += 4;
} else {
Index16 = 0;
VmPtr->Ip += 2;
}
//
// Get the data to push
//
if (OPERAND1_INDIRECT (Operands)) {
DataN = VmReadMemN (VmPtr, (UINTN) (VmPtr->R[OPERAND1_REGNUM (Operands)] + Index16));
} else {
DataN = (UINTN) (VmPtr->R[OPERAND1_REGNUM (Operands)] + Index16);
}
//
// Adjust the stack down.
//
VmPtr->R[0] -= sizeof (UINTN);
VmWriteMemN (VmPtr, (UINTN) VmPtr->R[0], DataN);
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
ExecutePUSH (
IN VM_CONTEXT *VmPtr
)
/*++
Routine Description:
Execute the EBC PUSH instruction
Arguments:
VmPtr - pointer to a VM context
Returns:
Standard EFI_STATUS
Instruction syntax:
PUSH[32|64] {@}R1 {Index16|Immed16}
--*/
{
UINT8 Opcode;
UINT8 Operands;
UINT32 Data32;
UINT64 Data64;
INT16 Index16;
//
// Get opcode and operands
//
Opcode = GETOPCODE (VmPtr);
Operands = GETOPERANDS (VmPtr);
//
// Get immediate index if present, then advance the IP.
//
if (Opcode & PUSHPOP_M_IMMDATA) {
if (OPERAND1_INDIRECT (Operands)) {
Index16 = VmReadIndex16 (VmPtr, 2);
} else {
Index16 = VmReadImmed16 (VmPtr, 2);
}
VmPtr->Ip += 4;
} else {
Index16 = 0;
VmPtr->Ip += 2;
}
//
// Get the data to push
//
if (Opcode & PUSHPOP_M_64) {
if (OPERAND1_INDIRECT (Operands)) {
Data64 = VmReadMem64 (VmPtr, (UINTN) (VmPtr->R[OPERAND1_REGNUM (Operands)] + Index16));
} else {
Data64 = (UINT64) VmPtr->R[OPERAND1_REGNUM (Operands)] + Index16;
}
//
// Adjust the stack down, then write back the data
//
VmPtr->R[0] -= sizeof (UINT64);
VmWriteMem64 (VmPtr, (UINTN) VmPtr->R[0], Data64);
} else {
//
// 32-bit data
//
if (OPERAND1_INDIRECT (Operands)) {
Data32 = VmReadMem32 (VmPtr, (UINTN) (VmPtr->R[OPERAND1_REGNUM (Operands)] + Index16));
} else {
Data32 = (UINT32) VmPtr->R[OPERAND1_REGNUM (Operands)] + Index16;
}
//
// Adjust the stack down and write the data
//
VmPtr->R[0] -= sizeof (UINT32);
VmWriteMem32 (VmPtr, (UINTN) VmPtr->R[0], Data32);
}
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
ExecutePOPn (
IN VM_CONTEXT *VmPtr
)
/*++
Routine Description:
Execute the EBC POPn instruction
Arguments:
VmPtr - pointer to a VM context
Returns:
Standard EFI_STATUS
Instruction syntax:
POPn {@}R1 {Index16|Immed16}
--*/
{
UINT8 Opcode;
UINT8 Operands;
INT16 Index16;
UINTN DataN;
//
// Get opcode and operands
//
Opcode = GETOPCODE (VmPtr);
Operands = GETOPERANDS (VmPtr);
//
// Get immediate data if present, and advance the IP
//
if (Opcode & PUSHPOP_M_IMMDATA) {
if (OPERAND1_INDIRECT (Operands)) {
Index16 = VmReadIndex16 (VmPtr, 2);
} else {
Index16 = VmReadImmed16 (VmPtr, 2);
}
VmPtr->Ip += 4;
} else {
Index16 = 0;
VmPtr->Ip += 2;
}
//
// Read the data off the stack, then adjust the stack pointer
//
DataN = VmReadMemN (VmPtr, (UINTN) VmPtr->R[0]);
VmPtr->R[0] += sizeof (UINTN);
//
// Do the write-back
//
if (OPERAND1_INDIRECT (Operands)) {
VmWriteMemN (VmPtr, (UINTN) (VmPtr->R[OPERAND1_REGNUM (Operands)] + Index16), DataN);
} else {
VmPtr->R[OPERAND1_REGNUM (Operands)] = (INT64) (UINT64) ((UINTN) DataN + Index16);
}
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
ExecutePOP (
IN VM_CONTEXT *VmPtr
)
/*++
Routine Description:
Execute the EBC POP instruction
Arguments:
VmPtr - pointer to a VM context
Returns:
Standard EFI_STATUS
Instruction syntax:
POP {@}R1 {Index16|Immed16}
--*/
{
UINT8 Opcode;
UINT8 Operands;
INT16 Index16;
INT32 Data32;
UINT64 Data64;
//
// Get opcode and operands
//
Opcode = GETOPCODE (VmPtr);
Operands = GETOPERANDS (VmPtr);
//
// Get immediate data if present, and advance the IP.
//
if (Opcode & PUSHPOP_M_IMMDATA) {
if (OPERAND1_INDIRECT (Operands)) {
Index16 = VmReadIndex16 (VmPtr, 2);
} else {
Index16 = VmReadImmed16 (VmPtr, 2);
}
VmPtr->Ip += 4;
} else {
Index16 = 0;
VmPtr->Ip += 2;
}
//
// Get the data off the stack, then write it to the appropriate location
//
if (Opcode & PUSHPOP_M_64) {
//
// Read the data off the stack, then adjust the stack pointer
//
Data64 = VmReadMem64 (VmPtr, (UINTN) VmPtr->R[0]);
VmPtr->R[0] += sizeof (UINT64);
//
// Do the write-back
//
if (OPERAND1_INDIRECT (Operands)) {
VmWriteMem64 (VmPtr, (UINTN) (VmPtr->R[OPERAND1_REGNUM (Operands)] + Index16), Data64);
} else {
VmPtr->R[OPERAND1_REGNUM (Operands)] = Data64 + Index16;
}
} else {
//
// 32-bit pop. Read it off the stack and adjust the stack pointer
//
Data32 = (INT32) VmReadMem32 (VmPtr, (UINTN) VmPtr->R[0]);
VmPtr->R[0] += sizeof (UINT32);
//
// Do the write-back
//
if (OPERAND1_INDIRECT (Operands)) {
VmWriteMem32 (VmPtr, (UINTN) (VmPtr->R[OPERAND1_REGNUM (Operands)] + Index16), Data32);
} else {
VmPtr->R[OPERAND1_REGNUM (Operands)] = (INT64) Data32 + Index16;
}
}
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
ExecuteCALL (
IN VM_CONTEXT *VmPtr
)
/*++
Routine Description:
Implements the EBC CALL instruction.
Instruction format:
CALL64 Immed64
CALL32 {@}R1 {Immed32|Index32}
CALLEX64 Immed64
CALLEX16 {@}R1 {Immed32}
If Rx == R0, then it's a PC relative call to PC = PC + imm32.
Arguments:
VmPtr - pointer to a VM context.
Returns:
Standard EFI_STATUS
--*/
{
UINT8 Opcode;
UINT8 Operands;
INT32 Immed32;
UINT8 Size;
INT64 Immed64;
VOID *FramePtr;
//
// Get opcode and operands
//
Opcode = GETOPCODE (VmPtr);
Operands = GETOPERANDS (VmPtr);
//
// Assign these as well to avoid compiler warnings
//
Immed64 = 0;
Immed32 = 0;
FramePtr = VmPtr->FramePtr;
//
// Determine the instruction size, and get immediate data if present
//
if (Opcode & OPCODE_M_IMMDATA) {
if (Opcode & OPCODE_M_IMMDATA64) {
Immed64 = VmReadImmed64 (VmPtr, 2);
Size = 10;
} else {
//
// If register operand is indirect, then the immediate data is an index
//
if (OPERAND1_INDIRECT (Operands)) {
Immed32 = VmReadIndex32 (VmPtr, 2);
} else {
Immed32 = VmReadImmed32 (VmPtr, 2);
}
Size = 6;
}
} else {
Size = 2;
}
//
// If it's a call to EBC, adjust the stack pointer down 16 bytes and
// put our return address and frame pointer on the VM stack.
//
if ((Operands & OPERAND_M_NATIVE_CALL) == 0) {
VmPtr->R[0] -= 8;
VmWriteMemN (VmPtr, (UINTN) VmPtr->R[0], (UINTN) FramePtr);
VmPtr->FramePtr = (VOID *) (UINTN) VmPtr->R[0];
VmPtr->R[0] -= 8;
VmWriteMem64 (VmPtr, (UINTN) VmPtr->R[0], (UINT64) (UINTN) (VmPtr->Ip + Size));
}
//
// If 64-bit data, then absolute jump only
//
if (Opcode & OPCODE_M_IMMDATA64) {
//
// Native or EBC call?
//
if ((Operands & OPERAND_M_NATIVE_CALL) == 0) {
VmPtr->Ip = (VMIP) (UINTN) Immed64;
} else {
//
// Call external function, get the return value, and advance the IP
//
EbcLLCALLEX (VmPtr, (UINTN) Immed64, (UINTN) VmPtr->R[0], FramePtr, Size);
}
} else {
//
// Get the register data. If operand1 == 0, then ignore register and
// take immediate data as relative or absolute address.
// Compiler should take care of upper bits if 32-bit machine.
//
if (OPERAND1_REGNUM (Operands) != 0) {
Immed64 = (UINT64) (UINTN) VmPtr->R[OPERAND1_REGNUM (Operands)];
}
//
// Get final address
//
if (OPERAND1_INDIRECT (Operands)) {
Immed64 = (INT64) (UINT64) (UINTN) VmReadMemN (VmPtr, (UINTN) (Immed64 + Immed32));
} else {
Immed64 += Immed32;
}
//
// Now determine if external call, and then if relative or absolute
//
if ((Operands & OPERAND_M_NATIVE_CALL) == 0) {
//
// EBC call. Relative or absolute? If relative, then it's relative to the
// start of the next instruction.
//
if (Operands & OPERAND_M_RELATIVE_ADDR) {
VmPtr->Ip += Immed64 + Size;
} else {
VmPtr->Ip = (VMIP) (UINTN) Immed64;
}
} else {
//
// Native call. Relative or absolute?
//
if (Operands & OPERAND_M_RELATIVE_ADDR) {
EbcLLCALLEX (VmPtr, (UINTN) (Immed64 + VmPtr->Ip + Size), (UINTN) VmPtr->R[0], FramePtr, Size);
} else {
if (VmPtr->StopFlags & STOPFLAG_BREAK_ON_CALLEX) {
CpuBreakpoint ();
}
EbcLLCALLEX (VmPtr, (UINTN) Immed64, (UINTN) VmPtr->R[0], FramePtr, Size);
}
}
}
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
ExecuteRET (
IN VM_CONTEXT *VmPtr
)
/*++
Routine Description:
Execute the EBC RET instruction
Arguments:
VmPtr - pointer to a VM context
Returns:
Standard EFI_STATUS
Instruction syntax:
RET
--*/
{
//
// If we're at the top of the stack, then simply set the done
// flag and return
//
if (VmPtr->StackRetAddr == (UINT64) VmPtr->R[0]) {
VmPtr->StopFlags |= STOPFLAG_APP_DONE;
} else {
//
// Pull the return address off the VM app's stack and set the IP
// to it
//
if (!IS_ALIGNED ((UINTN) VmPtr->R[0], sizeof (UINT16))) {
EbcDebugSignalException (
EXCEPT_EBC_ALIGNMENT_CHECK,
EXCEPTION_FLAG_FATAL,
VmPtr
);
}
//
// Restore the IP and frame pointer from the stack
//
VmPtr->Ip = (VMIP) (UINTN) VmReadMem64 (VmPtr, (UINTN) VmPtr->R[0]);
VmPtr->R[0] += 8;
VmPtr->FramePtr = (VOID *) VmReadMemN (VmPtr, (UINTN) VmPtr->R[0]);
VmPtr->R[0] += 8;
}
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
ExecuteCMP (
IN VM_CONTEXT *VmPtr
)
/*++
Routine Description:
Execute the EBC CMP instruction
Arguments:
VmPtr - pointer to a VM context
Returns:
Standard EFI_STATUS
Instruction syntax:
CMP[32|64][eq|lte|gte|ulte|ugte] R1, {@}R2 {Index16|Immed16}
--*/
{
UINT8 Opcode;
UINT8 Operands;
UINT8 Size;
INT16 Index16;
UINT32 Flag;
INT64 Op2;
INT64 Op1;
//
// Get opcode and operands
//
Opcode = GETOPCODE (VmPtr);
Operands = GETOPERANDS (VmPtr);
//
// Get the register data we're going to compare to
//
Op1 = VmPtr->R[OPERAND1_REGNUM (Operands)];
//
// Get immediate data
//
if (Opcode & OPCODE_M_IMMDATA) {
if (OPERAND2_INDIRECT (Operands)) {
Index16 = VmReadIndex16 (VmPtr, 2);
} else {
Index16 = VmReadImmed16 (VmPtr, 2);
}
Size = 4;
} else {
Index16 = 0;
Size = 2;
}
//
// Now get Op2
//
if (OPERAND2_INDIRECT (Operands)) {
if (Opcode & OPCODE_M_64BIT) {
Op2 = (INT64) VmReadMem64 (VmPtr, (UINTN) (VmPtr->R[OPERAND2_REGNUM (Operands)] + Index16));
} else {
//
// 32-bit operations. 0-extend the values for all cases.
//
Op2 = (INT64) (UINT64) ((UINT32) VmReadMem32 (VmPtr, (UINTN) (VmPtr->R[OPERAND2_REGNUM (Operands)] + Index16)));
}
} else {
Op2 = VmPtr->R[OPERAND2_REGNUM (Operands)] + Index16;
}
//
// Now do the compare
//
Flag = 0;
if (Opcode & OPCODE_M_64BIT) {
//
// 64-bit compares
//
switch (Opcode & OPCODE_M_OPCODE) {
case OPCODE_CMPEQ:
if (Op1 == Op2) {
Flag = 1;
}
break;
case OPCODE_CMPLTE:
if (Op1 <= Op2) {
Flag = 1;
}
break;
case OPCODE_CMPGTE:
if (Op1 >= Op2) {
Flag = 1;
}
break;
case OPCODE_CMPULTE:
if ((UINT64) Op1 <= (UINT64) Op2) {
Flag = 1;
}
break;
case OPCODE_CMPUGTE:
if ((UINT64) Op1 >= (UINT64) Op2) {
Flag = 1;
}
break;
default:
ASSERT (0);
}
} else {
//
// 32-bit compares
//
switch (Opcode & OPCODE_M_OPCODE) {
case OPCODE_CMPEQ:
if ((INT32) Op1 == (INT32) Op2) {
Flag = 1;
}
break;
case OPCODE_CMPLTE:
if ((INT32) Op1 <= (INT32) Op2) {
Flag = 1;
}
break;
case OPCODE_CMPGTE:
if ((INT32) Op1 >= (INT32) Op2) {
Flag = 1;
}
break;
case OPCODE_CMPULTE:
if ((UINT32) Op1 <= (UINT32) Op2) {
Flag = 1;
}
break;
case OPCODE_CMPUGTE:
if ((UINT32) Op1 >= (UINT32) Op2) {
Flag = 1;
}
break;
default:
ASSERT (0);
}
}
//
// Now set the flag accordingly for the comparison
//
if (Flag) {
VMFLAG_SET (VmPtr, VMFLAGS_CC);
} else {
VMFLAG_CLEAR (VmPtr, VMFLAGS_CC);
}
//
// Advance the IP
//
VmPtr->Ip += Size;
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
ExecuteCMPI (
IN VM_CONTEXT *VmPtr
)
/*++
Routine Description:
Execute the EBC CMPI instruction
Arguments:
VmPtr - pointer to a VM context
Returns:
Standard EFI_STATUS
Instruction syntax:
CMPI[32|64]{w|d}[eq|lte|gte|ulte|ugte] {@}Rx {Index16}, Immed16|Immed32
--*/
{
UINT8 Opcode;
UINT8 Operands;
UINT8 Size;
INT64 Op1;
INT64 Op2;
INT16 Index16;
UINT32 Flag;
//
// Get opcode and operands
//
Opcode = GETOPCODE (VmPtr);
Operands = GETOPERANDS (VmPtr);
//
// Get operand1 index if present
//
Size = 2;
if (Operands & OPERAND_M_CMPI_INDEX) {
Index16 = VmReadIndex16 (VmPtr, 2);
Size += 2;
} else {
Index16 = 0;
}
//
// Get operand1 data we're going to compare to
//
Op1 = (INT64) VmPtr->R[OPERAND1_REGNUM (Operands)];
if (OPERAND1_INDIRECT (Operands)) {
//
// Indirect operand1. Fetch 32 or 64-bit value based on compare size.
//
if (Opcode & OPCODE_M_CMPI64) {
Op1 = (INT64) VmReadMem64 (VmPtr, (UINTN) Op1 + Index16);
} else {
Op1 = (INT64) VmReadMem32 (VmPtr, (UINTN) Op1 + Index16);
}
} else {
//
// Better not have been an index with direct. That is, CMPI R1 Index,...
// is illegal.
//
if (Operands & OPERAND_M_CMPI_INDEX) {
EbcDebugSignalException (
EXCEPT_EBC_INSTRUCTION_ENCODING,
EXCEPTION_FLAG_ERROR,
VmPtr
);
VmPtr->Ip += Size;
return EFI_UNSUPPORTED;
}
}
//
// Get immediate data -- 16- or 32-bit sign extended
//
if (Opcode & OPCODE_M_CMPI32_DATA) {
Op2 = (INT64) VmReadImmed32 (VmPtr, Size);
Size += 4;
} else {
//
// 16-bit immediate data. Sign extend always.
//
Op2 = (INT64) ((INT16) VmReadImmed16 (VmPtr, Size));
Size += 2;
}
//
// Now do the compare
//
Flag = 0;
if (Opcode & OPCODE_M_CMPI64) {
//
// 64 bit comparison
//
switch (Opcode & OPCODE_M_OPCODE) {
case OPCODE_CMPIEQ:
if (Op1 == (INT64) Op2) {
Flag = 1;
}
break;
case OPCODE_CMPILTE:
if (Op1 <= (INT64) Op2) {
Flag = 1;
}
break;
case OPCODE_CMPIGTE:
if (Op1 >= (INT64) Op2) {
Flag = 1;
}
break;
case OPCODE_CMPIULTE:
if ((UINT64) Op1 <= (UINT64) ((UINT32) Op2)) {
Flag = 1;
}
break;
case OPCODE_CMPIUGTE:
if ((UINT64) Op1 >= (UINT64) ((UINT32) Op2)) {
Flag = 1;
}
break;
default:
ASSERT (0);
}
} else {
//
// 32-bit comparisons
//
switch (Opcode & OPCODE_M_OPCODE) {
case OPCODE_CMPIEQ:
if ((INT32) Op1 == Op2) {
Flag = 1;
}
break;
case OPCODE_CMPILTE:
if ((INT32) Op1 <= Op2) {
Flag = 1;
}
break;
case OPCODE_CMPIGTE:
if ((INT32) Op1 >= Op2) {
Flag = 1;
}
break;
case OPCODE_CMPIULTE:
if ((UINT32) Op1 <= (UINT32) Op2) {
Flag = 1;
}
break;
case OPCODE_CMPIUGTE:
if ((UINT32) Op1 >= (UINT32) Op2) {
Flag = 1;
}
break;
default:
ASSERT (0);
}
}
//
// Now set the flag accordingly for the comparison
//
if (Flag) {
VMFLAG_SET (VmPtr, VMFLAGS_CC);
} else {
VMFLAG_CLEAR (VmPtr, VMFLAGS_CC);
}
//
// Advance the IP
//
VmPtr->Ip += Size;
return EFI_SUCCESS;
}
STATIC
UINT64
ExecuteNOT (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
)
/*++
Routine Description:
Execute the EBC NOT instruction
Arguments:
VmPtr - pointer to a VM context
Op1 - Operand 1 from the instruction
Op2 - Operand 2 from the instruction
Returns:
~Op2
Instruction syntax:
NOT[32|64] {@}R1, {@}R2 {Index16|Immed16}
--*/
{
return ~Op2;
}
STATIC
UINT64
ExecuteNEG (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
)
/*++
Routine Description:
Execute the EBC NEG instruction
Arguments:
VmPtr - pointer to a VM context
Op1 - Operand 1 from the instruction
Op2 - Operand 2 from the instruction
Returns:
Op2 * -1
Instruction syntax:
NEG[32|64] {@}R1, {@}R2 {Index16|Immed16}
--*/
{
return ~Op2 + 1;
}
STATIC
UINT64
ExecuteADD (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
)
/*++
Routine Description:
Execute the EBC ADD instruction
Arguments:
VmPtr - pointer to a VM context
Op1 - Operand 1 from the instruction
Op2 - Operand 2 from the instruction
Returns:
Op1 + Op2
Instruction syntax:
ADD[32|64] {@}R1, {@}R2 {Index16}
--*/
{
return Op1 + Op2;
}
STATIC
UINT64
ExecuteSUB (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
)
/*++
Routine Description:
Execute the EBC SUB instruction
Arguments:
VmPtr - pointer to a VM context
Op1 - Operand 1 from the instruction
Op2 - Operand 2 from the instruction
Returns:
Op1 - Op2
Standard EFI_STATUS
Instruction syntax:
SUB[32|64] {@}R1, {@}R2 {Index16|Immed16}
--*/
{
if (*VmPtr->Ip & DATAMANIP_M_64) {
return (UINT64) ((INT64) ((INT64) Op1 - (INT64) Op2));
} else {
return (UINT64) ((INT64) ((INT32) Op1 - (INT32) Op2));
}
}
STATIC
UINT64
ExecuteMUL (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
)
/*++
Routine Description:
Execute the EBC MUL instruction
Arguments:
VmPtr - pointer to a VM context
Op1 - Operand 1 from the instruction
Op2 - Operand 2 from the instruction
Returns:
Op1 * Op2
Instruction syntax:
MUL[32|64] {@}R1, {@}R2 {Index16|Immed16}
--*/
{
INT64 ResultHigh;
if (*VmPtr->Ip & DATAMANIP_M_64) {
return MulS64x64 (Op1, Op2, &ResultHigh);
} else {
return (UINT64) ((INT64) ((INT32) Op1 * (INT32) Op2));
}
}
STATIC
UINT64
ExecuteMULU (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
)
/*++
Routine Description:
Execute the EBC MULU instruction
Arguments:
VmPtr - pointer to a VM context
Op1 - Operand 1 from the instruction
Op2 - Operand 2 from the instruction
Returns:
(unsigned)Op1 * (unsigned)Op2
Instruction syntax:
MULU[32|64] {@}R1, {@}R2 {Index16|Immed16}
--*/
{
INT64 ResultHigh;
if (*VmPtr->Ip & DATAMANIP_M_64) {
return MulU64x64 (Op1, Op2, (UINT64 *)&ResultHigh);
} else {
return (UINT64) ((UINT32) Op1 * (UINT32) Op2);
}
}
STATIC
UINT64
ExecuteDIV (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
)
/*++
Routine Description:
Execute the EBC DIV instruction
Arguments:
VmPtr - pointer to a VM context
Op1 - Operand 1 from the instruction
Op2 - Operand 2 from the instruction
Returns:
Op1/Op2
Instruction syntax:
DIV[32|64] {@}R1, {@}R2 {Index16|Immed16}
--*/
{
INT64 Remainder;
UINT32 Error;
//
// Check for divide-by-0
//
if (Op2 == 0) {
EbcDebugSignalException (
EXCEPT_EBC_DIVIDE_ERROR,
EXCEPTION_FLAG_FATAL,
VmPtr
);
return 0;
} else {
if (*VmPtr->Ip & DATAMANIP_M_64) {
return (UINT64) (DivS64x64 (Op1, Op2, &Remainder, &Error));
} else {
return (UINT64) ((INT64) ((INT32) Op1 / (INT32) Op2));
}
}
}
STATIC
UINT64
ExecuteDIVU (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
)
/*++
Routine Description:
Execute the EBC DIVU instruction
Arguments:
VmPtr - pointer to a VM context
Op1 - Operand 1 from the instruction
Op2 - Operand 2 from the instruction
Returns:
(unsigned)Op1 / (unsigned)Op2
Instruction syntax:
DIVU[32|64] {@}R1, {@}R2 {Index16|Immed16}
--*/
{
UINT64 Remainder;
UINT32 Error;
//
// Check for divide-by-0
//
if (Op2 == 0) {
EbcDebugSignalException (
EXCEPT_EBC_DIVIDE_ERROR,
EXCEPTION_FLAG_FATAL,
VmPtr
);
return 0;
} else {
//
// Get the destination register
//
if (*VmPtr->Ip & DATAMANIP_M_64) {
return (UINT64) (DivU64x64 (Op1, Op2, &Remainder, &Error));
} else {
return (UINT64) ((UINT32) Op1 / (UINT32) Op2);
}
}
}
STATIC
UINT64
ExecuteMOD (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
)
/*++
Routine Description:
Execute the EBC MOD instruction
Arguments:
VmPtr - pointer to a VM context
Op1 - Operand 1 from the instruction
Op2 - Operand 2 from the instruction
Returns:
Op1 MODULUS Op2
Instruction syntax:
MOD[32|64] {@}R1, {@}R2 {Index16|Immed16}
--*/
{
INT64 Remainder;
UINT32 Error;
//
// Check for divide-by-0
//
if (Op2 == 0) {
EbcDebugSignalException (
EXCEPT_EBC_DIVIDE_ERROR,
EXCEPTION_FLAG_FATAL,
VmPtr
);
return 0;
} else {
DivS64x64 ((INT64) Op1, (INT64) Op2, &Remainder, &Error);
return Remainder;
}
}
STATIC
UINT64
ExecuteMODU (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
)
/*++
Routine Description:
Execute the EBC MODU instruction
Arguments:
VmPtr - pointer to a VM context
Op1 - Operand 1 from the instruction
Op2 - Operand 2 from the instruction
Returns:
Op1 UNSIGNED_MODULUS Op2
Instruction syntax:
MODU[32|64] {@}R1, {@}R2 {Index16|Immed16}
--*/
{
UINT64 Remainder;
UINT32 Error;
//
// Check for divide-by-0
//
if (Op2 == 0) {
EbcDebugSignalException (
EXCEPT_EBC_DIVIDE_ERROR,
EXCEPTION_FLAG_FATAL,
VmPtr
);
return 0;
} else {
DivU64x64 (Op1, Op2, &Remainder, &Error);
return Remainder;
}
}
STATIC
UINT64
ExecuteAND (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
)
/*++
Routine Description:
Execute the EBC AND instruction
Arguments:
VmPtr - pointer to a VM context
Op1 - Operand 1 from the instruction
Op2 - Operand 2 from the instruction
Returns:
Op1 AND Op2
Instruction syntax:
AND[32|64] {@}R1, {@}R2 {Index16|Immed16}
--*/
{
return Op1 & Op2;
}
STATIC
UINT64
ExecuteOR (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
)
/*++
Routine Description:
Execute the EBC OR instruction
Arguments:
VmPtr - pointer to a VM context
Op1 - Operand 1 from the instruction
Op2 - Operand 2 from the instruction
Returns:
Op1 OR Op2
Instruction syntax:
OR[32|64] {@}R1, {@}R2 {Index16|Immed16}
--*/
{
return Op1 | Op2;
}
STATIC
UINT64
ExecuteXOR (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
)
/*++
Routine Description:
Execute the EBC XOR instruction
Arguments:
VmPtr - pointer to a VM context
Op1 - Operand 1 from the instruction
Op2 - Operand 2 from the instruction
Returns:
Op1 XOR Op2
Instruction syntax:
XOR[32|64] {@}R1, {@}R2 {Index16|Immed16}
--*/
{
return Op1 ^ Op2;
}
STATIC
UINT64
ExecuteSHL (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
)
/*++
Routine Description:
Execute the EBC SHL shift left instruction
Arguments:
VmPtr - pointer to a VM context
Op1 - Operand 1 from the instruction
Op2 - Operand 2 from the instruction
Returns:
Op1 << Op2
Instruction syntax:
SHL[32|64] {@}R1, {@}R2 {Index16|Immed16}
--*/
{
if (*VmPtr->Ip & DATAMANIP_M_64) {
return LeftShiftU64 (Op1, Op2);
} else {
return (UINT64) ((UINT32) ((UINT32) Op1 << (UINT32) Op2));
}
}
STATIC
UINT64
ExecuteSHR (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
)
/*++
Routine Description:
Execute the EBC SHR instruction
Arguments:
VmPtr - pointer to a VM context
Op1 - Operand 1 from the instruction
Op2 - Operand 2 from the instruction
Returns:
Op1 >> Op2 (unsigned operands)
Instruction syntax:
SHR[32|64] {@}R1, {@}R2 {Index16|Immed16}
--*/
{
if (*VmPtr->Ip & DATAMANIP_M_64) {
return RightShiftU64 (Op1, Op2);
} else {
return (UINT64) ((UINT32) Op1 >> (UINT32) Op2);
}
}
STATIC
UINT64
ExecuteASHR (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
)
/*++
Routine Description:
Execute the EBC ASHR instruction
Arguments:
VmPtr - pointer to a VM context
Op1 - Operand 1 from the instruction
Op2 - Operand 2 from the instruction
Returns:
Op1 >> Op2 (signed)
Instruction syntax:
ASHR[32|64] {@}R1, {@}R2 {Index16|Immed16}
--*/
{
if (*VmPtr->Ip & DATAMANIP_M_64) {
return ARightShift64 (Op1, Op2);
} else {
return (UINT64) ((INT64) ((INT32) Op1 >> (UINT32) Op2));
}
}
STATIC
UINT64
ExecuteEXTNDB (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
)
/*++
Routine Description:
Execute the EBC EXTNDB instruction to sign-extend a byte value.
Arguments:
VmPtr - pointer to a VM context
Op1 - Operand 1 from the instruction
Op2 - Operand 2 from the instruction
Returns:
(INT64)(INT8)Op2
Instruction syntax:
EXTNDB[32|64] {@}R1, {@}R2 {Index16|Immed16}
--*/
{
INT8 Data8;
INT64 Data64;
//
// Convert to byte, then return as 64-bit signed value to let compiler
// sign-extend the value
//
Data8 = (INT8) Op2;
Data64 = (INT64) Data8;
return (UINT64) Data64;
}
STATIC
UINT64
ExecuteEXTNDW (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
)
/*++
Routine Description:
Execute the EBC EXTNDW instruction to sign-extend a 16-bit value.
Arguments:
VmPtr - pointer to a VM context
Op1 - Operand 1 from the instruction
Op2 - Operand 2 from the instruction
Returns:
(INT64)(INT16)Op2
Instruction syntax:
EXTNDW[32|64] {@}R1, {@}R2 {Index16|Immed16}
--*/
{
INT16 Data16;
INT64 Data64;
//
// Convert to word, then return as 64-bit signed value to let compiler
// sign-extend the value
//
Data16 = (INT16) Op2;
Data64 = (INT64) Data16;
return (UINT64) Data64;
}
//
// Execute the EBC EXTNDD instruction.
//
// Format: EXTNDD {@}Rx, {@}Ry [Index16|Immed16]
// EXTNDD Dest, Source
//
// Operation: Dest <- SignExtended((DWORD)Source))
//
STATIC
UINT64
ExecuteEXTNDD (
IN VM_CONTEXT *VmPtr,
IN UINT64 Op1,
IN UINT64 Op2
)
/*++
Routine Description:
Execute the EBC EXTNDD instruction to sign-extend a 32-bit value.
Arguments:
VmPtr - pointer to a VM context
Op1 - Operand 1 from the instruction
Op2 - Operand 2 from the instruction
Returns:
(INT64)(INT32)Op2
Instruction syntax:
EXTNDD[32|64] {@}R1, {@}R2 {Index16|Immed16}
--*/
{
INT32 Data32;
INT64 Data64;
//
// Convert to 32-bit value, then return as 64-bit signed value to let compiler
// sign-extend the value
//
Data32 = (INT32) Op2;
Data64 = (INT64) Data32;
return (UINT64) Data64;
}
STATIC
EFI_STATUS
ExecuteSignedDataManip (
IN VM_CONTEXT *VmPtr
)
{
//
// Just call the data manipulation function with a flag indicating this
// is a signed operation.
//
return ExecuteDataManip (VmPtr, TRUE);
}
STATIC
EFI_STATUS
ExecuteUnsignedDataManip (
IN VM_CONTEXT *VmPtr
)
{
//
// Just call the data manipulation function with a flag indicating this
// is not a signed operation.
//
return ExecuteDataManip (VmPtr, FALSE);
}
STATIC
EFI_STATUS
ExecuteDataManip (
IN VM_CONTEXT *VmPtr,
IN BOOLEAN IsSignedOp
)
/*++
Routine Description:
Execute all the EBC data manipulation instructions.
Since the EBC data manipulation instructions all have the same basic form,
they can share the code that does the fetch of operands and the write-back
of the result. This function performs the fetch of the operands (even if
both are not needed to be fetched, like NOT instruction), dispatches to the
appropriate subfunction, then writes back the returned result.
Arguments:
VmPtr - pointer to VM context
Returns:
Standard EBC status
Format:
INSTRUCITON[32|64] {@}R1, {@}R2 {Immed16|Index16}
--*/
{
UINT8 Opcode;
INT16 Index16;
UINT8 Operands;
UINT8 Size;
UINT64 Op1;
UINT64 Op2;
//
// Get opcode and operands
//
Opcode = GETOPCODE (VmPtr);
Operands = GETOPERANDS (VmPtr);
//
// Determine if we have immediate data by the opcode
//
if (Opcode & DATAMANIP_M_IMMDATA) {
//
// Index16 if Ry is indirect, or Immed16 if Ry direct.
//
if (OPERAND2_INDIRECT (Operands)) {
Index16 = VmReadIndex16 (VmPtr, 2);
} else {
Index16 = VmReadImmed16 (VmPtr, 2);
}
Size = 4;
} else {
Index16 = 0;
Size = 2;
}
//
// Now get operand2 (source). It's of format {@}R2 {Index16|Immed16}
//
Op2 = (UINT64) VmPtr->R[OPERAND2_REGNUM (Operands)] + Index16;
if (OPERAND2_INDIRECT (Operands)) {
//
// Indirect form: @R2 Index16. Fetch as 32- or 64-bit data
//
if (Opcode & DATAMANIP_M_64) {
Op2 = VmReadMem64 (VmPtr, (UINTN) Op2);
} else {
//
// Read as signed value where appropriate.
//
if (IsSignedOp) {
Op2 = (UINT64) (INT64) ((INT32) VmReadMem32 (VmPtr, (UINTN) Op2));
} else {
Op2 = (UINT64) VmReadMem32 (VmPtr, (UINTN) Op2);
}
}
} else {
if ((Opcode & DATAMANIP_M_64) == 0) {
if (IsSignedOp) {
Op2 = (UINT64) (INT64) ((INT32) Op2);
} else {
Op2 = (UINT64) ((UINT32) Op2);
}
}
}
//
// Get operand1 (destination and sometimes also an actual operand)
// of form {@}R1
//
Op1 = VmPtr->R[OPERAND1_REGNUM (Operands)];
if (OPERAND1_INDIRECT (Operands)) {
if (Opcode & DATAMANIP_M_64) {
Op1 = VmReadMem64 (VmPtr, (UINTN) Op1);
} else {
if (IsSignedOp) {
Op1 = (UINT64) (INT64) ((INT32) VmReadMem32 (VmPtr, (UINTN) Op1));
} else {
Op1 = (UINT64) VmReadMem32 (VmPtr, (UINTN) Op1);
}
}
} else {
if ((Opcode & DATAMANIP_M_64) == 0) {
if (IsSignedOp) {
Op1 = (UINT64) (INT64) ((INT32) Op1);
} else {
Op1 = (UINT64) ((UINT32) Op1);
}
}
}
//
// Dispatch to the computation function
//
if (((Opcode & OPCODE_M_OPCODE) - OPCODE_NOT) >=
(sizeof (mDataManipDispatchTable) / sizeof (mDataManipDispatchTable[0]))
) {
EbcDebugSignalException (
EXCEPT_EBC_INVALID_OPCODE,
EXCEPTION_FLAG_ERROR,
VmPtr
);
//
// Advance and return
//
VmPtr->Ip += Size;
return EFI_UNSUPPORTED;
} else {
Op2 = mDataManipDispatchTable[(Opcode & OPCODE_M_OPCODE) - OPCODE_NOT](VmPtr, Op1, Op2);
}
//
// Write back the result.
//
if (OPERAND1_INDIRECT (Operands)) {
Op1 = VmPtr->R[OPERAND1_REGNUM (Operands)];
if (Opcode & DATAMANIP_M_64) {
VmWriteMem64 (VmPtr, (UINTN) Op1, Op2);
} else {
VmWriteMem32 (VmPtr, (UINTN) Op1, (UINT32) Op2);
}
} else {
//
// Storage back to a register. Write back, clearing upper bits (as per
// the specification) if 32-bit operation.
//
VmPtr->R[OPERAND1_REGNUM (Operands)] = Op2;
if ((Opcode & DATAMANIP_M_64) == 0) {
VmPtr->R[OPERAND1_REGNUM (Operands)] &= 0xFFFFFFFF;
}
}
//
// Advance the instruction pointer
//
VmPtr->Ip += Size;
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
ExecuteLOADSP (
IN VM_CONTEXT *VmPtr
)
/*++
Routine Description:
Execute the EBC LOADSP instruction
Arguments:
VmPtr - pointer to a VM context
Returns:
Standard EFI_STATUS
Instruction syntax:
LOADSP SP1, R2
--*/
{
UINT8 Operands;
//
// Get the operands
//
Operands = GETOPERANDS (VmPtr);
//
// Do the operation
//
switch (OPERAND1_REGNUM (Operands)) {
//
// Set flags
//
case 0:
//
// Spec states that this instruction will not modify reserved bits in
// the flags register.
//
VmPtr->Flags = (VmPtr->Flags &~VMFLAGS_ALL_VALID) | (VmPtr->R[OPERAND2_REGNUM (Operands)] & VMFLAGS_ALL_VALID);
break;
default:
EbcDebugSignalException (
EXCEPT_EBC_INSTRUCTION_ENCODING,
EXCEPTION_FLAG_WARNING,
VmPtr
);
VmPtr->Ip += 2;
return EFI_UNSUPPORTED;
}
VmPtr->Ip += 2;
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
ExecuteSTORESP (
IN VM_CONTEXT *VmPtr
)
/*++
Routine Description:
Execute the EBC STORESP instruction
Arguments:
VmPtr - pointer to a VM context
Returns:
Standard EFI_STATUS
Instruction syntax:
STORESP Rx, FLAGS|IP
--*/
{
UINT8 Operands;
//
// Get the operands
//
Operands = GETOPERANDS (VmPtr);
//
// Do the operation
//
switch (OPERAND2_REGNUM (Operands)) {
//
// Get flags
//
case 0:
//
// Retrieve the value in the flags register, then clear reserved bits
//
VmPtr->R[OPERAND1_REGNUM (Operands)] = (UINT64) (VmPtr->Flags & VMFLAGS_ALL_VALID);
break;
//
// Get IP -- address of following instruction
//
case 1:
VmPtr->R[OPERAND1_REGNUM (Operands)] = (UINT64) (UINTN) VmPtr->Ip + 2;
break;
default:
EbcDebugSignalException (
EXCEPT_EBC_INSTRUCTION_ENCODING,
EXCEPTION_FLAG_WARNING,
VmPtr
);
VmPtr->Ip += 2;
return EFI_UNSUPPORTED;
break;
}
VmPtr->Ip += 2;
return EFI_SUCCESS;
}
STATIC
INT16
VmReadIndex16 (
IN VM_CONTEXT *VmPtr,
IN UINT32 CodeOffset
)
/*++
Routine Description:
Decode a 16-bit index to determine the offset. Given an index value:
b15 - sign bit
b14:12 - number of bits in this index assigned to natural units (=a)
ba:11 - constant units = C
b0:a - natural units = N
Given this info, the offset can be computed by:
offset = sign_bit * (C + N * sizeof(UINTN))
Max offset is achieved with index = 0x7FFF giving an offset of
0x27B (32-bit machine) or 0x477 (64-bit machine).
Min offset is achieved with index =
Arguments:
VmPtr - pointer to VM context
CodeOffset - offset from IP of the location of the 16-bit index to decode
Returns:
The decoded offset.
--*/
{
UINT16 Index;
INT16 Offset;
INT16 C;
INT16 N;
INT16 NBits;
INT16 Mask;
//
// First read the index from the code stream
//
Index = VmReadCode16 (VmPtr, CodeOffset);
//
// Get the mask for N. First get the number of bits from the index.
//
NBits = (INT16) ((Index & 0x7000) >> 12);
//
// Scale it for 16-bit indexes
//
NBits *= 2;
//
// Now using the number of bits, create a mask.
//
Mask = (INT16) ((INT16)~0 << NBits);
//
// Now using the mask, extract N from the lower bits of the index.
//
N = (INT16) (Index &~Mask);
//
// Now compute C
//
C = (INT16) (((Index &~0xF000) & Mask) >> NBits);
Offset = (INT16) (N * sizeof (UINTN) + C);
//
// Now set the sign
//
if (Index & 0x8000) {
//
// Do it the hard way to work around a bogus compiler warning
//
// Offset = -1 * Offset;
//
Offset = (INT16) ((INT32) Offset * -1);
}
return Offset;
}
STATIC
INT32
VmReadIndex32 (
IN VM_CONTEXT *VmPtr,
IN UINT32 CodeOffset
)
/*++
Routine Description:
Decode a 32-bit index to determine the offset.
Arguments:
VmPtr - pointer to VM context
CodeOffset - offset from IP of the location of the 32-bit index to decode
Returns:
Converted index per EBC VM specification
--*/
{
UINT32 Index;
INT32 Offset;
INT32 C;
INT32 N;
INT32 NBits;
INT32 Mask;
Index = VmReadImmed32 (VmPtr, CodeOffset);
//
// Get the mask for N. First get the number of bits from the index.
//
NBits = (Index & 0x70000000) >> 28;
//
// Scale it for 32-bit indexes
//
NBits *= 4;
//
// Now using the number of bits, create a mask.
//
Mask = (INT32)~0 << NBits;
//
// Now using the mask, extract N from the lower bits of the index.
//
N = Index &~Mask;
//
// Now compute C
//
C = ((Index &~0xF0000000) & Mask) >> NBits;
Offset = N * sizeof (UINTN) + C;
//
// Now set the sign
//
if (Index & 0x80000000) {
Offset = Offset * -1;
}
return Offset;
}
STATIC
INT64
VmReadIndex64 (
IN VM_CONTEXT *VmPtr,
IN UINT32 CodeOffset
)
/*++
Routine Description:
Decode a 64-bit index to determine the offset.
Arguments:
VmPtr - pointer to VM context
CodeOffset - offset from IP of the location of the 64-bit index to decode
Returns:
Converted index per EBC VM specification
--*/
{
UINT64 Index;
UINT64 Remainder;
INT64 Offset;
INT64 C;
INT64 N;
INT64 NBits;
INT64 Mask;
Index = VmReadCode64 (VmPtr, CodeOffset);
//
// Get the mask for N. First get the number of bits from the index.
//
NBits = RightShiftU64 ((Index & 0x7000000000000000ULL), 60);
//
// Scale it for 64-bit indexes (multiply by 8 by shifting left 3)
//
NBits = LeftShiftU64 (NBits, 3);
//
// Now using the number of bits, create a mask.
//
Mask = (LeftShiftU64 ((UINT64)~0, (UINT64) NBits));
//
// Now using the mask, extract N from the lower bits of the index.
//
N = Index &~Mask;
//
// Now compute C
//
C = ARightShift64 (((Index &~0xF000000000000000ULL) & Mask), (UINTN) NBits);
Offset = MulU64x64 (N, sizeof (UINTN), &Remainder) + C;
//
// Now set the sign
//
if (Index & 0x8000000000000000ULL) {
Offset = MulS64x64 (Offset, -1, (INT64 *)&Index);
}
return Offset;
}
STATIC
EFI_STATUS
VmWriteMem8 (
IN VM_CONTEXT *VmPtr,
IN UINTN Addr,
IN UINT8 Data
)
/*++
Routine Description:
The following VmWriteMem? routines are called by the EBC data
movement instructions that write to memory. Since these writes
may be to the stack, which looks like (high address on top) this,
[EBC entry point arguments]
[VM stack]
[EBC stack]
we need to detect all attempts to write to the EBC entry point argument
stack area and adjust the address (which will initially point into the
VM stack) to point into the EBC entry point arguments.
Arguments:
VmPtr - pointer to a VM context
Addr - adddress to write to
Data - value to write to Addr
Returns:
Standard EFI_STATUS
--*/
{
//
// Convert the address if it's in the stack gap
//
Addr = ConvertStackAddr (VmPtr, Addr);
*(UINT8 *) Addr = Data;
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
VmWriteMem16 (
IN VM_CONTEXT *VmPtr,
IN UINTN Addr,
IN UINT16 Data
)
{
EFI_STATUS Status;
//
// Convert the address if it's in the stack gap
//
Addr = ConvertStackAddr (VmPtr, Addr);
//
// Do a simple write if aligned
//
if (IS_ALIGNED (Addr, sizeof (UINT16))) {
*(UINT16 *) Addr = Data;
} else {
//
// Write as two bytes
//
MemoryFence ();
if ((Status = VmWriteMem8 (VmPtr, Addr, (UINT8) Data)) != EFI_SUCCESS) {
return Status;
}
MemoryFence ();
if ((Status = VmWriteMem8 (VmPtr, Addr + 1, (UINT8) (Data >> 8))) != EFI_SUCCESS) {
return Status;
}
MemoryFence ();
}
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
VmWriteMem32 (
IN VM_CONTEXT *VmPtr,
IN UINTN Addr,
IN UINT32 Data
)
{
EFI_STATUS Status;
//
// Convert the address if it's in the stack gap
//
Addr = ConvertStackAddr (VmPtr, Addr);
//
// Do a simple write if aligned
//
if (IS_ALIGNED (Addr, sizeof (UINT32))) {
*(UINT32 *) Addr = Data;
} else {
//
// Write as two words
//
MemoryFence ();
if ((Status = VmWriteMem16 (VmPtr, Addr, (UINT16) Data)) != EFI_SUCCESS) {
return Status;
}
MemoryFence ();
if ((Status = VmWriteMem16 (VmPtr, Addr + sizeof (UINT16), (UINT16) (Data >> 16))) != EFI_SUCCESS) {
return Status;
}
MemoryFence ();
}
return EFI_SUCCESS;
}
EFI_STATUS
VmWriteMem64 (
IN VM_CONTEXT *VmPtr,
IN UINTN Addr,
IN UINT64 Data
)
{
EFI_STATUS Status;
UINT32 Data32;
//
// Convert the address if it's in the stack gap
//
Addr = ConvertStackAddr (VmPtr, Addr);
//
// Do a simple write if aligned
//
if (IS_ALIGNED (Addr, sizeof (UINT64))) {
*(UINT64 *) Addr = Data;
} else {
//
// Write as two 32-bit words
//
MemoryFence ();
if ((Status = VmWriteMem32 (VmPtr, Addr, (UINT32) Data)) != EFI_SUCCESS) {
return Status;
}
MemoryFence ();
Data32 = (UINT32) (((UINT32 *) &Data)[1]);
if ((Status = VmWriteMem32 (VmPtr, Addr + sizeof (UINT32), Data32)) != EFI_SUCCESS) {
return Status;
}
MemoryFence ();
}
return EFI_SUCCESS;
}
EFI_STATUS
VmWriteMemN (
IN VM_CONTEXT *VmPtr,
IN UINTN Addr,
IN UINTN Data
)
{
EFI_STATUS Status;
UINTN Index;
Status = EFI_SUCCESS;
//
// Convert the address if it's in the stack gap
//
Addr = ConvertStackAddr (VmPtr, Addr);
//
// Do a simple write if aligned
//
if (IS_ALIGNED (Addr, sizeof (UINTN))) {
*(UINTN *) Addr = Data;
} else {
for (Index = 0; Index < sizeof (UINTN) / sizeof (UINT32); Index++) {
MemoryFence ();
Status = VmWriteMem32 (VmPtr, Addr + Index * sizeof (UINT32), (UINT32) Data);
MemoryFence ();
Data = (UINTN)RShiftU64 ((UINT64)Data, 32);
}
}
return Status;
}
STATIC
INT8
VmReadImmed8 (
IN VM_CONTEXT *VmPtr,
IN UINT32 Offset
)
/*++
Routine Description:
The following VmReadImmed routines are called by the EBC execute
functions to read EBC immediate values from the code stream.
Since we can't assume alignment, each tries to read in the biggest
chunks size available, but will revert to smaller reads if necessary.
Arguments:
VmPtr - pointer to a VM context
Offset - offset from IP of the code bytes to read.
Returns:
Signed data of the requested size from the specified address.
--*/
{
//
// Simply return the data in flat memory space
//
return * (INT8 *) (VmPtr->Ip + Offset);
}
STATIC
INT16
VmReadImmed16 (
IN VM_CONTEXT *VmPtr,
IN UINT32 Offset
)
{
//
// Read direct if aligned
//
if (IS_ALIGNED ((UINTN) VmPtr->Ip + Offset, sizeof (INT16))) {
return * (INT16 *) (VmPtr->Ip + Offset);
} else {
//
// All code word reads should be aligned
//
EbcDebugSignalException (
EXCEPT_EBC_ALIGNMENT_CHECK,
EXCEPTION_FLAG_WARNING,
VmPtr
);
}
//
// Return unaligned data
//
return (INT16) (*(UINT8 *) (VmPtr->Ip + Offset) + (*(UINT8 *) (VmPtr->Ip + Offset + 1) << 8));
}
STATIC
INT32
VmReadImmed32 (
IN VM_CONTEXT *VmPtr,
IN UINT32 Offset
)
{
UINT32 Data;
//
// Read direct if aligned
//
if (IS_ALIGNED ((UINTN) VmPtr->Ip + Offset, sizeof (UINT32))) {
return * (INT32 *) (VmPtr->Ip + Offset);
}
//
// Return unaligned data
//
Data = (UINT32) VmReadCode16 (VmPtr, Offset);
Data |= (UINT32) (VmReadCode16 (VmPtr, Offset + 2) << 16);
return Data;
}
STATIC
INT64
VmReadImmed64 (
IN VM_CONTEXT *VmPtr,
IN UINT32 Offset
)
{
UINT64 Data64;
UINT32 Data32;
UINT8 *Ptr;
//
// Read direct if aligned
//
if (IS_ALIGNED ((UINTN) VmPtr->Ip + Offset, sizeof (UINT64))) {
return * (UINT64 *) (VmPtr->Ip + Offset);
}
//
// Return unaligned data.
//
Ptr = (UINT8 *) &Data64;
Data32 = VmReadCode32 (VmPtr, Offset);
*(UINT32 *) Ptr = Data32;
Ptr += sizeof (Data32);
Data32 = VmReadCode32 (VmPtr, Offset + sizeof (UINT32));
*(UINT32 *) Ptr = Data32;
return Data64;
}
STATIC
UINT16
VmReadCode16 (
IN VM_CONTEXT *VmPtr,
IN UINT32 Offset
)
/*++
Routine Description:
The following VmReadCode() routines provide the ability to read raw
unsigned data from the code stream.
Arguments:
VmPtr - pointer to VM context
Offset - offset from current IP to the raw data to read.
Returns:
The raw unsigned 16-bit value from the code stream.
--*/
{
//
// Read direct if aligned
//
if (IS_ALIGNED ((UINTN) VmPtr->Ip + Offset, sizeof (UINT16))) {
return * (UINT16 *) (VmPtr->Ip + Offset);
} else {
//
// All code word reads should be aligned
//
EbcDebugSignalException (
EXCEPT_EBC_ALIGNMENT_CHECK,
EXCEPTION_FLAG_WARNING,
VmPtr
);
}
//
// Return unaligned data
//
return (UINT16) (*(UINT8 *) (VmPtr->Ip + Offset) + (*(UINT8 *) (VmPtr->Ip + Offset + 1) << 8));
}
STATIC
UINT32
VmReadCode32 (
IN VM_CONTEXT *VmPtr,
IN UINT32 Offset
)
{
UINT32 Data;
//
// Read direct if aligned
//
if (IS_ALIGNED ((UINTN) VmPtr->Ip + Offset, sizeof (UINT32))) {
return * (UINT32 *) (VmPtr->Ip + Offset);
}
//
// Return unaligned data
//
Data = (UINT32) VmReadCode16 (VmPtr, Offset);
Data |= (VmReadCode16 (VmPtr, Offset + 2) << 16);
return Data;
}
STATIC
UINT64
VmReadCode64 (
IN VM_CONTEXT *VmPtr,
IN UINT32 Offset
)
{
UINT64 Data64;
UINT32 Data32;
UINT8 *Ptr;
//
// Read direct if aligned
//
if (IS_ALIGNED ((UINTN) VmPtr->Ip + Offset, sizeof (UINT64))) {
return * (UINT64 *) (VmPtr->Ip + Offset);
}
//
// Return unaligned data.
//
Ptr = (UINT8 *) &Data64;
Data32 = VmReadCode32 (VmPtr, Offset);
*(UINT32 *) Ptr = Data32;
Ptr += sizeof (Data32);
Data32 = VmReadCode32 (VmPtr, Offset + sizeof (UINT32));
*(UINT32 *) Ptr = Data32;
return Data64;
}
STATIC
UINT8
VmReadMem8 (
IN VM_CONTEXT *VmPtr,
IN UINTN Addr
)
{
//
// Convert the address if it's in the stack gap
//
Addr = ConvertStackAddr (VmPtr, Addr);
//
// Simply return the data in flat memory space
//
return * (UINT8 *) Addr;
}
STATIC
UINT16
VmReadMem16 (
IN VM_CONTEXT *VmPtr,
IN UINTN Addr
)
{
//
// Convert the address if it's in the stack gap
//
Addr = ConvertStackAddr (VmPtr, Addr);
//
// Read direct if aligned
//
if (IS_ALIGNED (Addr, sizeof (UINT16))) {
return * (UINT16 *) Addr;
}
//
// Return unaligned data
//
return (UINT16) (*(UINT8 *) Addr + (*(UINT8 *) (Addr + 1) << 8));
}
STATIC
UINT32
VmReadMem32 (
IN VM_CONTEXT *VmPtr,
IN UINTN Addr
)
{
UINT32 Data;
//
// Convert the address if it's in the stack gap
//
Addr = ConvertStackAddr (VmPtr, Addr);
//
// Read direct if aligned
//
if (IS_ALIGNED (Addr, sizeof (UINT32))) {
return * (UINT32 *) Addr;
}
//
// Return unaligned data
//
Data = (UINT32) VmReadMem16 (VmPtr, Addr);
Data |= (VmReadMem16 (VmPtr, Addr + 2) << 16);
return Data;
}
STATIC
UINT64
VmReadMem64 (
IN VM_CONTEXT *VmPtr,
IN UINTN Addr
)
{
UINT64 Data;
UINT32 Data32;
//
// Convert the address if it's in the stack gap
//
Addr = ConvertStackAddr (VmPtr, Addr);
//
// Read direct if aligned
//
if (IS_ALIGNED (Addr, sizeof (UINT64))) {
return * (UINT64 *) Addr;
}
//
// Return unaligned data. Assume little endian.
//
Data = (UINT64) VmReadMem32 (VmPtr, Addr);
Data32 = VmReadMem32 (VmPtr, Addr + sizeof (UINT32));
*(UINT32 *) ((UINT32 *) &Data + 1) = Data32;
return Data;
}
STATIC
UINTN
ConvertStackAddr (
IN VM_CONTEXT *VmPtr,
IN UINTN Addr
)
/*++
Routine Description:
Given an address that EBC is going to read from or write to, return
an appropriate address that accounts for a gap in the stack.
The stack for this application looks like this (high addr on top)
[EBC entry point arguments]
[VM stack]
[EBC stack]
The EBC assumes that its arguments are at the top of its stack, which
is where the VM stack is really. Therefore if the EBC does memory
accesses into the VM stack area, then we need to convert the address
to point to the EBC entry point arguments area. Do this here.
Arguments:
VmPtr - pointer to VM context
Addr - address of interest
Returns:
The unchanged address if it's not in the VM stack region. Otherwise,
adjust for the stack gap and return the modified address.
--*/
{
if ((Addr >= VmPtr->LowStackTop) && (Addr < VmPtr->HighStackBottom)) {
//
// In the stack gap -- now make sure it's not in the VM itself, which
// would be the case if it's accessing VM register contents.
//
if ((Addr < (UINTN) VmPtr) || (Addr > (UINTN) VmPtr + sizeof (VM_CONTEXT))) {
VmPtr->LastAddrConverted = Addr;
VmPtr->LastAddrConvertedValue = Addr - VmPtr->LowStackTop + VmPtr->HighStackBottom;
return Addr - VmPtr->LowStackTop + VmPtr->HighStackBottom;
}
}
return Addr;
}
STATIC
UINTN
VmReadMemN (
IN VM_CONTEXT *VmPtr,
IN UINTN Addr
)
/*++
Routine Description:
Read a natural value from memory. May or may not be aligned.
Arguments:
VmPtr - current VM context
Addr - the address to read from
Returns:
The natural value at address Addr.
--*/
{
UINTN Data;
UINT32 Size;
UINT8 *FromPtr;
UINT8 *ToPtr;
//
// Convert the address if it's in the stack gap
//
Addr = ConvertStackAddr (VmPtr, Addr);
//
// Read direct if aligned
//
if (IS_ALIGNED (Addr, sizeof (UINTN))) {
return * (UINTN *) Addr;
}
//
// Return unaligned data
//
Data = 0;
FromPtr = (UINT8 *) Addr;
ToPtr = (UINT8 *) &Data;
for (Size = 0; Size < sizeof (Data); Size++) {
*ToPtr = *FromPtr;
ToPtr++;
FromPtr++;
}
return Data;
}
UINT64
GetVmVersion (
VOID
)
{
return (UINT64) (((VM_MAJOR_VERSION & 0xFFFF) << 16) | ((VM_MINOR_VERSION & 0xFFFF)));
}
|