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
// Copyright 2022 The ChromiumOS Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
cfg_if::cfg_if! {
if #[cfg(any(target_os = "android", target_os = "linux"))] {
use base::RawDescriptor;
use devices::virtio::vhost::user::device::parse_wayland_sock;
use crate::crosvm::sys::config::parse_pmem_ext2_option;
use crate::crosvm::sys::config::VfioOption;
use crate::crosvm::sys::config::SharedDir;
use crate::crosvm::sys::config::PmemExt2Option;
}
}
use std::collections::BTreeMap;
#[cfg(feature = "config-file")]
use std::path::Path;
use std::path::PathBuf;
use std::str::FromStr;
use std::sync::atomic::AtomicUsize;
use std::sync::atomic::Ordering;
use arch::CpuSet;
use arch::FdtPosition;
use arch::Pstore;
#[cfg(target_arch = "x86_64")]
use arch::SmbiosOptions;
use arch::VcpuAffinity;
use argh::FromArgs;
use base::getpid;
use cros_async::ExecutorKind;
use devices::virtio::block::DiskOption;
#[cfg(any(feature = "video-decoder", feature = "video-encoder"))]
use devices::virtio::device_constants::video::VideoDeviceConfig;
use devices::virtio::scsi::ScsiOption;
#[cfg(feature = "audio")]
use devices::virtio::snd::parameters::Parameters as SndParameters;
use devices::virtio::vhost::user::device;
use devices::virtio::vsock::VsockConfig;
use devices::virtio::DeviceType;
#[cfg(feature = "gpu")]
use devices::virtio::GpuDisplayParameters;
#[cfg(feature = "gpu")]
use devices::virtio::GpuMouseMode;
#[cfg(feature = "gpu")]
use devices::virtio::GpuParameters;
#[cfg(all(unix, feature = "net"))]
use devices::virtio::NetParameters;
#[cfg(all(unix, feature = "net"))]
use devices::virtio::NetParametersMode;
use devices::FwCfgParameters;
use devices::PflashParameters;
use devices::SerialHardware;
use devices::SerialParameters;
use devices::StubPciParameters;
#[cfg(target_arch = "x86_64")]
use hypervisor::CpuHybridType;
use hypervisor::ProtectionType;
use merge::vec::append;
use resources::AddressRange;
#[cfg(feature = "config-file")]
use serde::de::Error as SerdeError;
use serde::Deserialize;
#[cfg(feature = "config-file")]
use serde::Deserializer;
use serde::Serialize;
#[cfg(feature = "gpu")]
use serde_keyvalue::FromKeyValues;
use super::config::PmemOption;
#[cfg(feature = "gpu")]
use super::gpu_config::fixup_gpu_display_options;
#[cfg(feature = "gpu")]
use super::gpu_config::fixup_gpu_options;
#[cfg(all(feature = "gpu", feature = "virgl_renderer"))]
use super::sys::GpuRenderServerParameters;
use crate::crosvm::config::from_key_values;
use crate::crosvm::config::parse_bus_id_addr;
use crate::crosvm::config::parse_cpu_affinity;
use crate::crosvm::config::parse_cpu_capacity;
#[cfg(all(
any(target_arch = "arm", target_arch = "aarch64"),
any(target_os = "android", target_os = "linux")
))]
use crate::crosvm::config::parse_cpu_frequencies;
use crate::crosvm::config::parse_dynamic_power_coefficient;
#[cfg(target_arch = "x86_64")]
use crate::crosvm::config::parse_memory_region;
use crate::crosvm::config::parse_mmio_address_range;
use crate::crosvm::config::parse_pflash_parameters;
use crate::crosvm::config::parse_serial_options;
use crate::crosvm::config::parse_touch_device_option;
use crate::crosvm::config::parse_vhost_user_fs_option;
use crate::crosvm::config::BatteryConfig;
use crate::crosvm::config::CpuOptions;
use crate::crosvm::config::DtboOption;
use crate::crosvm::config::Executable;
use crate::crosvm::config::FileBackedMappingParameters;
use crate::crosvm::config::HypervisorKind;
use crate::crosvm::config::InputDeviceOption;
use crate::crosvm::config::IrqChipKind;
use crate::crosvm::config::MemOptions;
use crate::crosvm::config::TouchDeviceOption;
use crate::crosvm::config::VhostUserFrontendOption;
use crate::crosvm::config::VhostUserFsOption;
use crate::crosvm::config::VhostUserOption;
#[cfg(feature = "plugin")]
use crate::crosvm::plugin::parse_plugin_mount_option;
#[cfg(feature = "plugin")]
use crate::crosvm::plugin::BindMount;
#[cfg(feature = "plugin")]
use crate::crosvm::plugin::GidMap;
#[derive(FromArgs)]
/// crosvm
pub struct CrosvmCmdlineArgs {
#[argh(switch)]
/// use extended exit status
pub extended_status: bool,
#[argh(option, default = r#"String::from("info")"#)]
/// specify log level, eg "off", "error", "debug,disk=off", etc
pub log_level: String,
#[argh(option, arg_name = "TAG")]
/// when logging to syslog, use the provided tag
pub syslog_tag: Option<String>,
#[argh(switch)]
/// disable output to syslog
pub no_syslog: bool,
#[argh(subcommand)]
pub command: Command,
}
#[allow(clippy::large_enum_variant)]
#[derive(FromArgs)]
#[argh(subcommand)]
pub enum CrossPlatformCommands {
#[cfg(feature = "balloon")]
Balloon(BalloonCommand),
#[cfg(feature = "balloon")]
BalloonStats(BalloonStatsCommand),
#[cfg(feature = "balloon")]
BalloonWs(BalloonWsCommand),
Battery(BatteryCommand),
#[cfg(feature = "composite-disk")]
CreateComposite(CreateCompositeCommand),
#[cfg(feature = "qcow")]
CreateQcow2(CreateQcow2Command),
Device(DeviceCommand),
Disk(DiskCommand),
#[cfg(feature = "gpu")]
Gpu(GpuCommand),
MakeRT(MakeRTCommand),
Resume(ResumeCommand),
Run(RunCommand),
Stop(StopCommand),
Suspend(SuspendCommand),
Swap(SwapCommand),
Powerbtn(PowerbtnCommand),
Sleepbtn(SleepCommand),
Gpe(GpeCommand),
Usb(UsbCommand),
Version(VersionCommand),
Vfio(VfioCrosvmCommand),
#[cfg(feature = "pci-hotplug")]
VirtioNet(VirtioNetCommand),
Snapshot(SnapshotCommand),
}
#[allow(clippy::large_enum_variant)]
#[derive(argh_helpers::FlattenSubcommand)]
pub enum Command {
CrossPlatform(CrossPlatformCommands),
Sys(super::sys::cmdline::Commands),
}
#[derive(FromArgs)]
#[argh(subcommand, name = "balloon")]
/// Set balloon size of the crosvm instance to `SIZE` bytes
pub struct BalloonCommand {
#[argh(positional, arg_name = "SIZE")]
/// amount of bytes
pub num_bytes: u64,
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
/// wait for response
#[argh(switch)]
pub wait: bool,
}
#[derive(argh::FromArgs)]
#[argh(subcommand, name = "balloon_stats")]
/// Prints virtio balloon statistics for a `VM_SOCKET`
pub struct BalloonStatsCommand {
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
#[derive(argh::FromArgs)]
#[argh(subcommand, name = "balloon_ws")]
/// Prints virtio balloon working set for a `VM_SOCKET`
pub struct BalloonWsCommand {
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM control socket path.
pub socket_path: String,
}
#[derive(FromArgs)]
#[argh(subcommand, name = "battery")]
/// Modify battery
pub struct BatteryCommand {
#[argh(positional, arg_name = "BATTERY_TYPE")]
/// battery type
pub battery_type: String,
#[argh(positional)]
/// battery property
/// status | present | health | capacity | aconline
pub property: String,
#[argh(positional)]
/// battery property target
/// STATUS | PRESENT | HEALTH | CAPACITY | ACONLINE
pub target: String,
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
#[cfg(feature = "composite-disk")]
#[derive(FromArgs)]
#[argh(subcommand, name = "create_composite")]
/// Create a new composite disk image file
pub struct CreateCompositeCommand {
#[argh(positional, arg_name = "PATH")]
/// image path
pub path: String,
#[argh(positional, arg_name = "LABEL:PARTITION[:writable][:<GUID>]")]
/// partitions
pub partitions: Vec<String>,
}
#[cfg(feature = "qcow")]
#[derive(FromArgs)]
#[argh(subcommand, name = "create_qcow2")]
/// Create Qcow2 image given path and size
pub struct CreateQcow2Command {
#[argh(positional, arg_name = "PATH")]
/// path to the new qcow2 file to create
pub file_path: String,
#[argh(positional, arg_name = "SIZE")]
/// desired size of the image in bytes; required if not using --backing-file
pub size: Option<u64>,
#[argh(option)]
/// path to backing file; if specified, the image will be the same size as the backing file,
/// and SIZE may not be specified
pub backing_file: Option<String>,
}
#[derive(FromArgs)]
#[argh(subcommand)]
pub enum DiskSubcommand {
Resize(ResizeDiskSubcommand),
}
#[derive(FromArgs)]
/// resize disk
#[argh(subcommand, name = "resize")]
pub struct ResizeDiskSubcommand {
#[argh(positional, arg_name = "DISK_INDEX")]
/// disk index
pub disk_index: usize,
#[argh(positional, arg_name = "NEW_SIZE")]
/// new disk size
pub disk_size: u64,
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
#[derive(FromArgs)]
#[argh(subcommand, name = "disk")]
/// Manage attached virtual disk devices
pub struct DiskCommand {
#[argh(subcommand)]
pub command: DiskSubcommand,
}
#[derive(FromArgs)]
#[argh(subcommand, name = "make_rt")]
/// Enables real-time vcpu priority for crosvm instances started with `--delay-rt`
pub struct MakeRTCommand {
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
#[derive(FromArgs)]
#[argh(subcommand, name = "resume")]
/// Resumes the crosvm instance. No-op if already running. When starting crosvm with `--restore`,
/// this command can be used to wait until the restore is complete
// Implementation note: All the restore work happens before crosvm becomes able to process incoming
// commands, so really all commands can be used to wait for restore to complete, but few are side
// effect free.
pub struct ResumeCommand {
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
/// suspend VM VCPUs and Devices
#[argh(switch)]
pub full: bool,
}
#[derive(FromArgs)]
#[argh(subcommand, name = "stop")]
/// Stops crosvm instances via their control sockets
pub struct StopCommand {
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
#[derive(FromArgs)]
#[argh(subcommand, name = "suspend")]
/// Suspends the crosvm instance
pub struct SuspendCommand {
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
/// suspend VM VCPUs and Devices
#[argh(switch)]
pub full: bool,
}
#[derive(FromArgs)]
#[argh(subcommand, name = "enable")]
/// Enable vmm-swap of a VM. The guest memory is moved to staging memory
pub struct SwapEnableCommand {
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
#[derive(FromArgs)]
#[argh(subcommand, name = "trim")]
/// Trim pages in the staging memory
pub struct SwapTrimCommand {
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
#[derive(FromArgs)]
#[argh(subcommand, name = "out")]
/// Swap out staging memory to swap file
pub struct SwapOutCommand {
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
#[derive(FromArgs)]
#[argh(subcommand, name = "disable")]
/// Disable vmm-swap of a VM
pub struct SwapDisableCommand {
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
#[argh(switch)]
/// clean up the swap file in the background.
pub slow_file_cleanup: bool,
}
#[derive(FromArgs)]
#[argh(subcommand, name = "status")]
/// Get vmm-swap status of a VM
pub struct SwapStatusCommand {
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
/// Vmm-swap commands
#[derive(FromArgs)]
#[argh(subcommand, name = "swap")]
pub struct SwapCommand {
#[argh(subcommand)]
pub nested: SwapSubcommands,
}
#[derive(FromArgs)]
#[argh(subcommand)]
pub enum SwapSubcommands {
Enable(SwapEnableCommand),
Trim(SwapTrimCommand),
SwapOut(SwapOutCommand),
Disable(SwapDisableCommand),
Status(SwapStatusCommand),
}
#[derive(FromArgs)]
#[argh(subcommand, name = "powerbtn")]
/// Triggers a power button event in the crosvm instance
pub struct PowerbtnCommand {
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
#[derive(FromArgs)]
#[argh(subcommand, name = "sleepbtn")]
/// Triggers a sleep button event in the crosvm instance
pub struct SleepCommand {
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
#[derive(FromArgs)]
#[argh(subcommand, name = "gpe")]
/// Injects a general-purpose event into the crosvm instance
pub struct GpeCommand {
#[argh(positional)]
/// GPE #
pub gpe: u32,
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
#[derive(FromArgs)]
#[argh(subcommand, name = "usb")]
/// Manage attached virtual USB devices.
pub struct UsbCommand {
#[argh(subcommand)]
pub command: UsbSubCommand,
}
#[cfg(feature = "gpu")]
#[derive(FromArgs)]
#[argh(subcommand, name = "gpu")]
/// Manage attached virtual GPU device.
pub struct GpuCommand {
#[argh(subcommand)]
pub command: GpuSubCommand,
}
#[derive(FromArgs)]
#[argh(subcommand, name = "version")]
/// Show package version.
pub struct VersionCommand {}
#[derive(FromArgs)]
#[argh(subcommand, name = "add")]
/// ADD
pub struct VfioAddSubCommand {
#[argh(positional)]
/// path to host's vfio sysfs
pub vfio_path: PathBuf,
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
#[derive(FromArgs)]
#[argh(subcommand, name = "remove")]
/// REMOVE
pub struct VfioRemoveSubCommand {
#[argh(positional)]
/// path to host's vfio sysfs
pub vfio_path: PathBuf,
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
#[derive(FromArgs)]
#[argh(subcommand)]
pub enum VfioSubCommand {
Add(VfioAddSubCommand),
Remove(VfioRemoveSubCommand),
}
#[derive(FromArgs)]
#[argh(subcommand, name = "vfio")]
/// add/remove host vfio pci device into guest
pub struct VfioCrosvmCommand {
#[argh(subcommand)]
pub command: VfioSubCommand,
}
#[cfg(feature = "pci-hotplug")]
#[derive(FromArgs)]
#[argh(subcommand)]
pub enum VirtioNetSubCommand {
AddTap(VirtioNetAddSubCommand),
RemoveTap(VirtioNetRemoveSubCommand),
}
#[cfg(feature = "pci-hotplug")]
#[derive(FromArgs)]
#[argh(subcommand, name = "add")]
/// Add by Tap name.
pub struct VirtioNetAddSubCommand {
#[argh(positional)]
/// tap name
pub tap_name: String,
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
#[cfg(feature = "pci-hotplug")]
#[derive(FromArgs)]
#[argh(subcommand, name = "remove")]
/// Remove tap by bus number.
pub struct VirtioNetRemoveSubCommand {
#[argh(positional)]
/// bus number for device to remove
pub bus: u8,
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM socket path
pub socket_path: String,
}
#[cfg(feature = "pci-hotplug")]
#[derive(FromArgs)]
#[argh(subcommand, name = "virtio-net")]
/// add network device as virtio into guest.
pub struct VirtioNetCommand {
#[argh(subcommand)]
pub command: VirtioNetSubCommand,
}
#[derive(FromArgs)]
#[argh(subcommand, name = "device")]
/// Start a device process
pub struct DeviceCommand {
/// configure async executor backend; "uring" or "epoll" on Linux, "handle" or "overlapped" on
/// Windows. If this option is omitted on Linux, "epoll" is used by default.
#[argh(option, arg_name = "EXECUTOR")]
pub async_executor: Option<ExecutorKind>,
#[argh(subcommand)]
pub command: DeviceSubcommand,
}
#[derive(FromArgs)]
#[argh(subcommand)]
/// Cross-platform Devices
pub enum CrossPlatformDevicesCommands {
Block(device::BlockOptions),
#[cfg(feature = "gpu")]
Gpu(device::GpuOptions),
#[cfg(feature = "net")]
Net(device::NetOptions),
#[cfg(feature = "audio")]
Snd(device::SndOptions),
}
#[derive(argh_helpers::FlattenSubcommand)]
pub enum DeviceSubcommand {
CrossPlatform(CrossPlatformDevicesCommands),
Sys(super::sys::cmdline::DeviceSubcommand),
}
#[cfg(feature = "gpu")]
#[derive(FromArgs)]
#[argh(subcommand)]
pub enum GpuSubCommand {
AddDisplays(GpuAddDisplaysCommand),
ListDisplays(GpuListDisplaysCommand),
RemoveDisplays(GpuRemoveDisplaysCommand),
SetDisplayMouseMode(GpuSetDisplayMouseModeCommand),
}
#[cfg(feature = "gpu")]
#[derive(FromArgs)]
/// Attach a new display to the GPU device.
#[argh(subcommand, name = "add-displays")]
pub struct GpuAddDisplaysCommand {
#[argh(option)]
/// displays
pub gpu_display: Vec<GpuDisplayParameters>,
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
#[cfg(feature = "gpu")]
#[derive(FromArgs)]
/// List the displays currently attached to the GPU device.
#[argh(subcommand, name = "list-displays")]
pub struct GpuListDisplaysCommand {
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
#[cfg(feature = "gpu")]
#[derive(FromArgs)]
/// Detach an existing display from the GPU device.
#[argh(subcommand, name = "remove-displays")]
pub struct GpuRemoveDisplaysCommand {
#[argh(option)]
/// display id
pub display_id: Vec<u32>,
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
#[cfg(feature = "gpu")]
#[derive(FromArgs)]
/// Sets the mouse mode of a display attached to the GPU device.
#[argh(subcommand, name = "set-mouse-mode")]
pub struct GpuSetDisplayMouseModeCommand {
#[argh(option)]
/// display id
pub display_id: u32,
#[argh(option)]
/// display mouse mode
pub mouse_mode: GpuMouseMode,
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
#[derive(FromArgs)]
#[argh(subcommand)]
pub enum UsbSubCommand {
Attach(UsbAttachCommand),
SecurityKeyAttach(UsbAttachKeyCommand),
Detach(UsbDetachCommand),
List(UsbListCommand),
}
#[derive(FromArgs)]
/// Attach usb device
#[argh(subcommand, name = "attach")]
pub struct UsbAttachCommand {
#[argh(
positional,
arg_name = "BUS_ID:ADDR:BUS_NUM:DEV_NUM",
from_str_fn(parse_bus_id_addr)
)]
pub addr: (u8, u8, u16, u16),
#[argh(positional)]
/// usb device path
pub dev_path: String,
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
#[derive(FromArgs)]
/// Attach security key device
#[argh(subcommand, name = "attach_key")]
pub struct UsbAttachKeyCommand {
#[argh(positional)]
/// security key hidraw device path
pub dev_path: String,
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
#[derive(FromArgs)]
/// Detach usb device
#[argh(subcommand, name = "detach")]
pub struct UsbDetachCommand {
#[argh(positional, arg_name = "PORT")]
/// usb port
pub port: u8,
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
#[derive(FromArgs)]
/// List currently attached USB devices
#[argh(subcommand, name = "list")]
pub struct UsbListCommand {
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
}
/// Structure containing the parameters for a single disk as well as a unique counter increasing
/// each time a new disk parameter is parsed.
///
/// This allows the letters assigned to each disk to reflect the order of their declaration, as
/// we have several options for specifying disks (rwroot, root, etc) and order can thus be lost
/// when they are aggregated.
#[derive(Deserialize, Serialize, Clone, Debug)]
#[serde(deny_unknown_fields, from = "DiskOption", into = "DiskOption")]
struct DiskOptionWithId {
disk_option: DiskOption,
index: usize,
}
/// FromStr implementation for argh.
impl FromStr for DiskOptionWithId {
type Err = String;
fn from_str(s: &str) -> Result<Self, Self::Err> {
let disk_option: DiskOption = from_key_values(s)?;
Ok(Self::from(disk_option))
}
}
/// Assign the next id to `disk_option`.
impl From<DiskOption> for DiskOptionWithId {
fn from(disk_option: DiskOption) -> Self {
static DISK_COUNTER: AtomicUsize = AtomicUsize::new(0);
Self {
disk_option,
index: DISK_COUNTER.fetch_add(1, Ordering::Relaxed),
}
}
}
impl From<DiskOptionWithId> for DiskOption {
fn from(disk_option_with_id: DiskOptionWithId) -> Self {
disk_option_with_id.disk_option
}
}
#[derive(FromArgs)]
#[argh(subcommand, name = "snapshot", description = "Snapshot commands")]
/// Snapshot commands
pub struct SnapshotCommand {
#[argh(subcommand)]
pub snapshot_command: SnapshotSubCommands,
}
#[derive(FromArgs)]
#[argh(subcommand, name = "take")]
/// Take a snapshot of the VM
pub struct SnapshotTakeCommand {
#[argh(positional, arg_name = "snapshot_path")]
/// VM Image path
pub snapshot_path: PathBuf,
#[argh(positional, arg_name = "VM_SOCKET")]
/// VM Socket path
pub socket_path: String,
#[argh(switch)]
/// compress the ram snapshot.
pub compress_memory: bool,
#[argh(switch, arg_name = "encrypt")]
/// whether the snapshot should be encrypted
pub encrypt: bool,
}
#[derive(FromArgs)]
#[argh(subcommand)]
/// Snapshot commands
pub enum SnapshotSubCommands {
Take(SnapshotTakeCommand),
}
/// Container for GpuParameters that have been fixed after parsing using serde.
///
/// This deserializes as a regular `GpuParameters` and applies validation.
#[cfg(feature = "gpu")]
#[derive(Debug, Deserialize, FromKeyValues)]
#[serde(try_from = "GpuParameters")]
pub struct FixedGpuParameters(pub GpuParameters);
#[cfg(feature = "gpu")]
impl TryFrom<GpuParameters> for FixedGpuParameters {
type Error = String;
fn try_from(gpu_params: GpuParameters) -> Result<Self, Self::Error> {
fixup_gpu_options(gpu_params)
}
}
/// Container for `GpuDisplayParameters` that have been fixed after parsing using serde.
///
/// This deserializes as a regular `GpuDisplayParameters` and applies validation.
/// TODO(b/260101753): Remove this once the old syntax for specifying DPI is deprecated.
#[cfg(feature = "gpu")]
#[derive(Debug, Deserialize, FromKeyValues)]
#[serde(try_from = "GpuDisplayParameters")]
pub struct FixedGpuDisplayParameters(pub GpuDisplayParameters);
#[cfg(feature = "gpu")]
impl TryFrom<GpuDisplayParameters> for FixedGpuDisplayParameters {
type Error = String;
fn try_from(gpu_display_params: GpuDisplayParameters) -> Result<Self, Self::Error> {
fixup_gpu_display_options(gpu_display_params)
}
}
/// Deserialize `config_file` into a `RunCommand`.
#[cfg(feature = "config-file")]
fn load_config_file<P: AsRef<Path>>(config_file: P) -> Result<RunCommand, String> {
let config = std::fs::read_to_string(config_file).map_err(|e| e.to_string())?;
serde_json::from_str(&config).map_err(|e| e.to_string())
}
/// Return a vector configuration loaded from the files pointed by strings in a sequence.
///
/// Used for including configuration files from another one.
#[cfg(feature = "config-file")]
fn include_config_file<'de, D>(deserializer: D) -> Result<Vec<RunCommand>, D::Error>
where
D: Deserializer<'de>,
{
use serde::de::SeqAccess;
struct ConfigVisitor;
impl<'de> serde::de::Visitor<'de> for ConfigVisitor {
type Value = Vec<RunCommand>;
fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
formatter.write_str("an array of paths to configuration file to include")
}
fn visit_seq<S>(self, mut seq: S) -> Result<Self::Value, S::Error>
where
S: SeqAccess<'de>,
{
let mut ret = Vec::new();
while let Some(path) = seq.next_element::<&'de str>()? {
let config =
load_config_file(path).map_err(<S as SeqAccess<'de>>::Error::custom)?;
ret.push(config);
}
Ok(ret)
}
}
deserializer.deserialize_seq(ConfigVisitor)
}
#[cfg(feature = "config-file")]
fn write_config_file(config_file: &Path, cmd: &RunCommand) -> Result<(), String> {
use std::io::Write;
let mut w =
std::io::BufWriter::new(std::fs::File::create(config_file).map_err(|e| e.to_string())?);
serde_json::to_writer_pretty(&mut w, cmd).map_err(|e| e.to_string())?;
w.flush().map_err(|e| e.to_string())?;
Ok(())
}
/// Overwrite an `Option<T>` if the right member is set.
///
/// The default merge strategy for `Option<T>` is to merge `right` into `left` iff `left.is_none()`.
/// This doesn't play well with our need to overwrite options that have already been set.
///
/// `overwrite_option` merges `right` into `left` iff `right.is_some()`, which allows us to override
/// previously-set options.
fn overwrite_option<T>(left: &mut Option<T>, right: Option<T>) {
if right.is_some() {
*left = right;
}
}
#[allow(dead_code)]
fn overwrite<T>(left: &mut T, right: T) {
let _ = std::mem::replace(left, right);
}
fn bool_default_true() -> bool {
true
}
/// User-specified configuration for the `crosvm run` command.
///
/// All fields of this structure MUST be either an `Option` or a `Vec` of their type. Arguments of
/// type `Option` can only be specified once, whereas `Vec` arguments can be specified several
/// times.
///
/// Each field of this structure has a dual use:
///
/// 1) As a command-line parameter, controlled by the `#[argh]` helper attribute.
/// 2) As a configuration file parameter, controlled by the `#[serde]` helper attribute.
///
/// For consistency, field names should be the same and use kebab-case for both uses, so please
/// refrain from using renaming directives and give the field the desired parameter name (it will
/// automatically be converted to kebab-case).
///
/// For consistency and convenience, all parameters should be deserializable by `serde_keyvalue`, as
/// this will automatically provide the same schema for both the command-line and configuration
/// file. This is particularly important for fields that are enums or structs, for which extra
/// parameters can be specified. Make sure to annotate your struct/enum with
/// `#[serde(deny_unknown_fields, rename_all = "kebab-case")]` so invalid fields are properly
/// rejected and all members are converted to kebab-case.
///
/// Each field should also have a `#[merge]` helper attribute, which defines the strategy to use
/// when merging two configurations into one. This happens when e.g. the user has specified extra
/// command-line arguments along with a configuration file. In this case, the `RunCommand` created
/// from the command-line arguments will be merged into the `RunCommand` deserialized from the
/// configuration file.
///
/// The rule of thumb for `#[merge]` attributes is that parameters that can only be specified once
/// (of `Option` type) should be overridden (`#[merge(strategy = overwrite_option)]`), while
/// parameters that can be specified several times (typically of `Vec` type) should be appended
/// (`#[merge(strategy = append)]`), but there might also be exceptions.
///
/// The command-line is the root configuration source, but one or more configuration files can be
/// specified for inclusion using the `--cfg` argument. Configuration files are applied in the
/// order they are mentioned, overriding (for `Option` fields) or augmenting (for `Vec` fields)
/// their fields, and the command-line options are finally applied last.
///
/// A configuration files can also include other configuration files by using `cfg` itself.
/// Included configuration files are applied first, with the parent configuration file applied
/// last.
///
/// The doccomment of the member will be displayed as its help message with `--help`.
///
/// Note that many parameters are marked with `#[serde(skip)]` and annotated with b/255223604. This
/// is because we only want to enable parameters in the config file after they undergo a proper
/// review to make sure they won't be obsoleted.
#[remain::sorted]
#[argh_helpers::pad_description_for_argh]
#[derive(FromArgs, Default, Deserialize, Serialize, merge::Merge)]
#[argh(subcommand, name = "run", description = "Start a new crosvm instance")]
#[serde(deny_unknown_fields, rename_all = "kebab-case")]
pub struct RunCommand {
#[cfg(all(target_arch = "x86_64", unix))]
#[argh(switch)]
#[serde(default)]
#[merge(strategy = overwrite_option)]
/// enable AC adapter device
/// It purpose is to emulate ACPI ACPI0003 device, replicate and propagate the
/// ac adapter status from the host to the guest.
pub ac_adapter: Option<bool>,
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = append)]
/// path to user provided ACPI table
pub acpi_table: Vec<PathBuf>,
#[cfg(feature = "android_display")]
#[argh(option, arg_name = "NAME")]
#[merge(strategy = overwrite_option)]
/// name that the Android display backend will be registered to the service manager.
pub android_display_service: Option<String>,
#[argh(option)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// path to Android fstab
pub android_fstab: Option<PathBuf>,
/// configure async executor backend; "uring" or "epoll" on Linux, "handle" or "overlapped" on
/// Windows. If this option is omitted on Linux, "epoll" is used by default.
#[argh(option, arg_name = "EXECUTOR")]
#[serde(skip)] // TODO(b/255223604)
pub async_executor: Option<ExecutorKind>,
#[cfg(feature = "balloon")]
#[argh(option, arg_name = "N")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// amount to bias balance of memory between host and guest as the balloon inflates, in mib.
pub balloon_bias_mib: Option<i64>,
#[cfg(feature = "balloon")]
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// path for balloon controller socket.
pub balloon_control: Option<PathBuf>,
#[cfg(feature = "balloon")]
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// enable page reporting in balloon.
pub balloon_page_reporting: Option<bool>,
#[cfg(feature = "balloon")]
#[argh(option)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// set number of WS bins to use (default = 4).
pub balloon_ws_num_bins: Option<u8>,
#[cfg(feature = "balloon")]
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// enable working set reporting in balloon.
pub balloon_ws_reporting: Option<bool>,
#[argh(option)]
/// comma separated key=value pairs for setting up battery
/// device
/// Possible key values:
/// type=goldfish - type of battery emulation, defaults to
/// goldfish
#[merge(strategy = overwrite_option)]
pub battery: Option<BatteryConfig>,
#[argh(option)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// path to BIOS/firmware ROM
pub bios: Option<PathBuf>,
#[argh(option, short = 'b', arg_name = "PATH[,key=value[,key=value[,...]]]")]
#[serde(default)]
#[merge(strategy = append)]
/// parameters for setting up a block device.
/// Valid keys:
/// path=PATH - Path to the disk image. Can be specified
/// without the key as the first argument.
/// ro=BOOL - Whether the block should be read-only.
/// (default: false)
/// root=BOOL - Whether the block device should be mounted
/// as the root filesystem. This will add the required
/// parameters to the kernel command-line. Can only be
/// specified once. (default: false)
/// sparse=BOOL - Indicates whether the disk should support
/// the discard operation. (default: true)
/// block-size=BYTES - Set the reported block size of the
/// disk. (default: 512)
/// id=STRING - Set the block device identifier to an ASCII
/// string, up to 20 characters. (default: no ID)
/// direct=BOOL - Use O_DIRECT mode to bypass page cache.
/// (default: false)
/// async-executor=epoll|uring - set the async executor kind
/// to simulate the block device with. This takes
/// precedence over the global --async-executor option.
/// multiple-workers=BOOL - (Experimental) run multiple
/// worker threads in parallel. this option is not
/// effective for vhost-user blk device.
/// (default: false)
/// packed-queue=BOOL - Use packed virtqueue
/// in block device. If false, use split virtqueue.
/// (default: false)
/// bootindex=NUM - An index dictating the order that the
/// firmware will consider devices to boot from.
/// For example, if bootindex=2, then the BIOS
/// will attempt to boot from the current device
/// after failing to boot from the device with
/// bootindex=1.
/// pci-address=ADDR - Preferred PCI address, e.g. "00:01.0".
block: Vec<DiskOptionWithId>,
#[cfg(any(target_os = "android", target_os = "linux"))]
#[argh(switch)]
#[serde(skip)]
#[merge(strategy = overwrite_option)]
/// set a minimum utilization for vCPU threads which will hint to the host scheduler
/// to ramp up higher frequencies or place vCPU threads on larger cores.
pub boost_uclamp: Option<bool>,
#[cfg(target_arch = "x86_64")]
#[argh(switch)]
#[merge(strategy = overwrite_option)]
/// break linux PCI configuration space io probing, to force the use of
/// mmio access to PCIe ECAM.
pub break_linux_pci_config_io: Option<bool>,
/// ratelimit enforced on detected bus locks in guest.
/// The default value of the bus_lock_ratelimit is 0 per second,
/// which means no limitation on the guest's bus locks.
#[cfg(target_arch = "x86_64")]
#[argh(option)]
pub bus_lock_ratelimit: Option<u64>,
#[cfg(feature = "config-file")]
#[argh(option, arg_name = "CONFIG_FILE", from_str_fn(load_config_file))]
#[serde(default, deserialize_with = "include_config_file")]
#[merge(skip)]
/// path to a JSON configuration file to load.
///
/// The options specified in the file can be overridden or augmented by subsequent uses of
/// this argument, or other command-line parameters.
cfg: Vec<Self>,
#[argh(option, arg_name = "CID")]
#[serde(skip)] // Deprecated - use `vsock` instead.
#[merge(strategy = overwrite_option)]
/// context ID for virtual sockets.
pub cid: Option<u64>,
#[cfg(any(target_os = "android", target_os = "linux"))]
#[argh(
option,
arg_name = "unpin_policy=POLICY,unpin_interval=NUM,unpin_limit=NUM,unpin_gen_threshold=NUM"
)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// comma separated key=value pairs for setting up coiommu
/// devices.
/// Possible key values:
/// unpin_policy=lru - LRU unpin policy.
/// unpin_interval=NUM - Unpin interval time in seconds.
/// unpin_limit=NUM - Unpin limit for each unpin cycle, in
/// unit of page count. 0 is invalid.
/// unpin_gen_threshold=NUM - Number of unpin intervals a
/// pinned page must be busy for to be aged into the
/// older which is less frequently checked generation.
pub coiommu: Option<devices::CoIommuParameters>,
#[argh(option, default = "true")]
#[merge(strategy = overwrite)]
#[serde(default = "bool_default_true")]
/// protect VM threads from hyperthreading-based attacks by scheduling them on different cores.
/// Enabled by default, and required for per_vm_core_scheduling.
pub core_scheduling: bool,
#[argh(option, arg_name = "CPUSET", from_str_fn(parse_cpu_affinity))]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// comma-separated list of CPUs or CPU ranges to run VCPUs on (e.g. 0,1-3,5)
/// or colon-separated list of assignments of guest to host CPU assignments (e.g. 0=0:1=1:2=2)
/// (default: no mask)
pub cpu_affinity: Option<VcpuAffinity>,
#[argh(
option,
arg_name = "CPU=CAP[,CPU=CAP[,...]]",
from_str_fn(parse_cpu_capacity)
)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// set the relative capacity of the given CPU (default: no capacity)
pub cpu_capacity: Option<BTreeMap<usize, u32>>, // CPU index -> capacity
#[argh(option, arg_name = "CPUSET")]
#[serde(skip)] // Deprecated - use `cpu clusters=[...]` instead.
#[merge(strategy = append)]
/// group the given CPUs into a cluster (default: no clusters)
pub cpu_cluster: Vec<CpuSet>,
#[cfg(all(
any(target_arch = "arm", target_arch = "aarch64"),
any(target_os = "android", target_os = "linux")
))]
#[argh(
option,
arg_name = "CPU=FREQS[,CPU=FREQS[,...]]",
from_str_fn(parse_cpu_frequencies)
)]
#[serde(skip)]
#[merge(strategy = overwrite_option)]
/// set the list of frequencies in KHz for the given CPU (default: no frequencies)
pub cpu_frequencies_khz: Option<BTreeMap<usize, Vec<u32>>>, // CPU index -> frequencies
#[argh(option, short = 'c')]
#[merge(strategy = overwrite_option)]
/// cpu parameters.
/// Possible key values:
/// num-cores=NUM - number of VCPUs. (default: 1)
/// clusters=[[CLUSTER],...] - CPU clusters (default: None)
/// Each CLUSTER is a set containing a list of CPUs
/// that should belong to the same cluster. Individual
/// CPU ids or ranges can be specified, comma-separated.
/// Examples:
/// clusters=[[0],[1],[2],[3]] - creates 4 clusters, one
/// for each specified core.
/// clusters=[[0-3]] - creates a cluster for cores 0 to 3
/// included.
/// clusters=[[0,2],[1,3],[4-7,12]] - creates one cluster
/// for cores 0 and 2, another one for cores 1 and 3,
/// and one last for cores 4, 5, 6, 7 and 12.
/// core-types=[atom=[CPUSET],core=[CPUSET]] - Hybrid core
/// types. (default: None)
/// Set the type of virtual hybrid CPUs. Currently
/// supports Intel Atom and Intel Core cpu types.
/// Examples:
/// core-types=[atom=[0,1],core=[2,3]] - set vCPU 0 and
/// vCPU 1 as intel Atom type, also set vCPU 2 and vCPU 3
/// as intel Core type.
/// boot-cpu=NUM - Select vCPU to boot from. (default: 0) (aarch64 only)
/// freq_domains=[[FREQ_DOMAIN],...] - CPU freq_domains (default: None) (aarch64 only)
/// Usage is identical to clusters, each FREQ_DOMAIN is a set containing a
/// list of CPUs that should belong to the same freq_domain. Individual
/// CPU ids or ranges can be specified, comma-separated.
/// Examples:
/// freq_domains=[[0],[1],[2],[3]] - creates 4 freq_domains, one
/// for each specified core.
/// freq_domains=[[0-3]] - creates a freq_domain for cores 0 to 3
/// included.
/// freq_domains=[[0,2],[1,3],[4-7,12]] - creates one freq_domain
/// for cores 0 and 2, another one for cores 1 and 3,
/// and one last for cores 4, 5, 6, 7 and 12.
/// sve=[enabled=bool] - SVE Config. (aarch64 only)
/// Examples:
/// sve=[enabled=true] - Enables SVE on device. Will fail is SVE unsupported.
/// default value = false.
pub cpus: Option<CpuOptions>,
#[cfg(feature = "crash-report")]
#[argh(option, arg_name = "\\\\.\\pipe\\PIPE_NAME")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// the crash handler ipc pipe name.
pub crash_pipe_name: Option<String>,
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// don't set VCPUs real-time until make-rt command is run
pub delay_rt: Option<bool>,
#[argh(option, arg_name = "PATH[,filter]")]
#[serde(default)]
#[merge(strategy = append)]
/// path to device tree overlay binary which will be applied to the base guest device tree
/// Parameters:
/// filter - only apply device tree nodes which belong to a VFIO device
pub device_tree_overlay: Vec<DtboOption>,
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// run all devices in one, non-sandboxed process
pub disable_sandbox: Option<bool>,
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// disable INTx in virtio devices
pub disable_virtio_intx: Option<bool>,
#[argh(option, short = 'd', arg_name = "PATH[,key=value[,key=value[,...]]]")]
#[serde(skip)] // Deprecated - use `block` instead.
#[merge(strategy = append)]
// (DEPRECATED): Use `block` instead.
/// path to a disk image followed by optional comma-separated
/// options.
/// Valid keys:
/// sparse=BOOL - Indicates whether the disk should support
/// the discard operation (default: true)
/// block_size=BYTES - Set the reported block size of the
/// disk (default: 512)
/// id=STRING - Set the block device identifier to an ASCII
/// string, up to 20 characters (default: no ID)
/// o_direct=BOOL - Use O_DIRECT mode to bypass page cache"
disk: Vec<DiskOptionWithId>,
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// capture keyboard input from the display window
pub display_window_keyboard: Option<bool>,
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// capture keyboard input from the display window
pub display_window_mouse: Option<bool>,
#[cfg(feature = "config-file")]
#[argh(option, arg_name = "CONFIG_FILE")]
#[serde(skip)]
#[merge(skip)]
/// path to a JSON configuration file to write the current configuration.
dump_cfg: Option<PathBuf>,
#[argh(option, long = "dump-device-tree-blob", arg_name = "FILE")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// dump generated device tree as a DTB file
pub dump_device_tree_blob: Option<PathBuf>,
#[argh(
option,
arg_name = "CPU=DYN_PWR[,CPU=DYN_PWR[,...]]",
from_str_fn(parse_dynamic_power_coefficient)
)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// pass power modeling param from to guest OS; scalar coefficient used in conjuction with
/// voltage and frequency for calculating power; in units of uW/MHz/^2
pub dynamic_power_coefficient: Option<BTreeMap<usize, u32>>,
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// enable the fw_cfg device. If enabled, fw_cfg will automatically produce firmware
/// configuration files containing such information as bootorder and the memory location of
/// rsdp. If --fw-cfg is specified (see below), there is no need for this argument.
pub enable_fw_cfg: Option<bool>,
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// expose HWP feature to the guest
pub enable_hwp: Option<bool>,
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = append)]
/// path to an event device node. The device will be grabbed (unusable from the host) and made
/// available to the guest with the same configuration it shows on the host
pub evdev: Vec<PathBuf>,
#[cfg(windows)]
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// gather and display statistics on Vm Exits and Bus Reads/Writes.
pub exit_stats: Option<bool>,
#[argh(option)]
#[serde(skip)]
#[merge(strategy = overwrite)]
/// where the FDT is placed in memory.
///
/// On x86_64, no effect.
///
/// On aarch64, defaults to `end` for kernel payloads and to `start` for BIOS payloads.
///
/// On riscv64, defaults to `after-payload`.
pub fdt_position: Option<FdtPosition>,
#[argh(
option,
arg_name = "addr=NUM,size=SIZE,path=PATH[,offset=NUM][,rw][,sync]"
)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = append)]
/// map the given file into guest memory at the specified
/// address.
/// Parameters (addr, size, path are required):
/// addr=NUM - guest physical address to map at
/// size=NUM - amount of memory to map
/// path=PATH - path to backing file/device to map
/// offset=NUM - offset in backing file (default 0)
/// rw - make the mapping writable (default readonly)
/// sync - open backing file with O_SYNC
/// align - whether to adjust addr and size to page
/// boundaries implicitly
pub file_backed_mapping: Vec<FileBackedMappingParameters>,
#[cfg(target_arch = "x86_64")]
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// force use of a calibrated TSC cpuid leaf (0x15) even if the hypervisor
/// doesn't require one.
pub force_calibrated_tsc_leaf: Option<bool>,
#[argh(option, arg_name = "name=NAME,(path=PATH|string=STRING)")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = append)]
/// comma separated key=value pairs to specify data to pass to
/// fw_cfg.
/// Possible key values:
/// name - Name of the file in fw_cfg that will
/// be associated with provided data
/// path - Path to data that will be included in
/// fw_cfg under name
/// string - Alternative to path, data to be
/// included in fw_cfg under name
pub fw_cfg: Vec<FwCfgParameters>,
#[cfg(feature = "gdb")]
#[argh(option, arg_name = "PORT")]
#[merge(strategy = overwrite_option)]
/// (EXPERIMENTAL) gdb on the given port
pub gdb: Option<u32>,
#[cfg(feature = "gpu")]
#[argh(option)]
// Although `gpu` is a vector, we are currently limited to a single GPU device due to the
// resource bridge and interaction with other video devices. We do use a vector so the GPU
// device can be specified like other device classes in the configuration file, and because we
// hope to lift this limitation eventually.
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = append)]
/// (EXPERIMENTAL) Comma separated key=value pairs for setting
/// up a virtio-gpu device
/// Possible key values:
/// backend=(2d|virglrenderer|gfxstream) - Which backend to
/// use for virtio-gpu (determining rendering protocol)
/// max_num_displays=INT - The maximum number of concurrent
/// virtual displays in this VM. This must not exceed
/// VIRTIO_GPU_MAX_SCANOUTS (i.e. 16).
/// displays=[[GpuDisplayParameters]] - The list of virtual
/// displays to create when booting this VM. Displays may
/// be hotplugged after booting. See the possible key
/// values for GpuDisplayParameters in the section below.
/// context-types=LIST - The list of supported context
/// types, separated by ':' (default: no contexts enabled)
/// width=INT - The width of the virtual display connected
/// to the virtio-gpu.
/// Deprecated - use `displays` instead.
/// height=INT - The height of the virtual display
/// connected to the virtio-gpu.
/// Deprecated - use `displays` instead.
/// egl[=true|=false] - If the backend should use a EGL
/// context for rendering.
/// glx[=true|=false] - If the backend should use a GLX
/// context for rendering.
/// surfaceless[=true|=false] - If the backend should use a
/// surfaceless context for rendering.
/// angle[=true|=false] - If the gfxstream backend should
/// use ANGLE (OpenGL on Vulkan) as its native OpenGL
/// driver.
/// vulkan[=true|=false] - If the backend should support
/// vulkan
/// wsi=vk - If the gfxstream backend should use the Vulkan
/// swapchain to draw on a window
/// cache-path=PATH - The path to the virtio-gpu device
/// shader cache.
/// cache-size=SIZE - The maximum size of the shader cache.
/// pci-address=ADDR - The PCI bus, device, and function
/// numbers, e.g. "00:01.0"
/// pci-bar-size=SIZE - The size for the PCI BAR in bytes
/// (default 8gb).
/// implicit-render-server[=true|=false] - If the render
/// server process should be allowed to autostart
/// (ignored when sandboxing is enabled)
/// fixed-blob-mapping[=true|=false] - if gpu memory blobs
/// should use fixed address mapping.
///
/// Possible key values for GpuDisplayParameters:
/// mode=(borderless_full_screen|windowed[width,height]) -
/// Whether to show the window on the host in full
/// screen or windowed mode. If not specified, windowed
/// mode is used by default. "windowed" can also be
/// specified explicitly to use a window size different
/// from the default one.
/// hidden[=true|=false] - If the display window is
/// initially hidden (default: false).
/// refresh-rate=INT - Force a specific vsync generation
/// rate in hertz on the guest (default: 60)
/// dpi=[INT,INT] - The horizontal and vertical DPI of the
/// display (default: [320,320])
/// horizontal-dpi=INT - The horizontal DPI of the display
/// (default: 320)
/// Deprecated - use `dpi` instead.
/// vertical-dpi=INT - The vertical DPI of the display
/// (default: 320)
/// Deprecated - use `dpi` instead.
pub gpu: Vec<FixedGpuParameters>,
#[cfg(all(unix, feature = "gpu"))]
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// move all vGPU threads to this Cgroup (default: nothing moves)
pub gpu_cgroup_path: Option<PathBuf>,
#[cfg(feature = "gpu")]
#[argh(option)]
#[serde(skip)] // TODO(b/255223604). Deprecated - use `gpu` instead.
#[merge(strategy = append)]
/// (EXPERIMENTAL) Comma separated key=value pairs for setting
/// up a display on the virtio-gpu device. See comments for `gpu`
/// for possible key values of GpuDisplayParameters.
pub gpu_display: Vec<FixedGpuDisplayParameters>,
#[cfg(all(unix, feature = "gpu", feature = "virgl_renderer"))]
#[argh(option)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// (EXPERIMENTAL) Comma separated key=value pairs for setting
/// up a render server for the virtio-gpu device
/// Possible key values:
/// path=PATH - The path to the render server executable.
/// cache-path=PATH - The path to the render server shader
/// cache.
/// cache-size=SIZE - The maximum size of the shader cache
/// foz-db-list-path=PATH - The path to GPU foz db list
/// file for dynamically loading RO caches.
pub gpu_render_server: Option<GpuRenderServerParameters>,
#[cfg(all(unix, feature = "gpu"))]
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// move all vGPU server threads to this Cgroup (default: nothing moves)
pub gpu_server_cgroup_path: Option<PathBuf>,
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// use mirror cpu topology of Host for Guest VM, also copy some cpu feature to Guest VM
pub host_cpu_topology: Option<bool>,
#[cfg(windows)]
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// string representation of the host guid in registry format, for namespacing vsock
/// connections.
pub host_guid: Option<String>,
#[cfg(all(unix, feature = "net"))]
#[argh(option, arg_name = "IP")]
#[serde(skip)] // Deprecated - use `net` instead.
#[merge(strategy = overwrite_option)]
/// IP address to assign to host tap interface
pub host_ip: Option<std::net::Ipv4Addr>,
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// advise the kernel to use Huge Pages for guest memory mappings
pub hugepages: Option<bool>,
/// hypervisor backend
#[argh(option)]
#[merge(strategy = overwrite_option)]
pub hypervisor: Option<HypervisorKind>,
#[cfg(feature = "balloon")]
#[argh(option, arg_name = "N")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// amount of guest memory outside the balloon at boot in MiB. (default: --mem)
pub init_mem: Option<u64>,
#[argh(option, short = 'i', arg_name = "PATH")]
#[merge(strategy = overwrite_option)]
/// initial ramdisk to load
pub initrd: Option<PathBuf>,
#[argh(option, arg_name = "TYPE[OPTIONS]")]
#[serde(default)]
#[merge(strategy = append)]
/// virtio-input device
/// TYPE is an input device type, and OPTIONS are key=value
/// pairs specific to the device type:
/// evdev[path=PATH]
/// keyboard[path=PATH]
/// mouse[path=PATH]
/// multi-touch[path=PATH,width=W,height=H,name=N]
/// rotary[path=PATH]
/// single-touch[path=PATH,width=W,height=H,name=N]
/// switches[path=PATH]
/// trackpad[path=PATH,width=W,height=H,name=N]
/// multi-touch-trackpad[path=PATH,width=W,height=H,name=N]
/// See <https://crosvm.dev/book/devices/input.html> for more
/// information.
pub input: Vec<InputDeviceOption>,
#[argh(option, arg_name = "kernel|split|userspace")]
#[merge(strategy = overwrite_option)]
/// type of interrupt controller emulation. "split" is only available for x86 KVM.
pub irqchip: Option<IrqChipKind>,
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// allow to enable ITMT scheduling feature in VM. The success of enabling depends on HWP and
/// ACPI CPPC support on hardware
pub itmt: Option<bool>,
#[argh(positional, arg_name = "KERNEL")]
#[merge(strategy = overwrite_option)]
/// bzImage of kernel to run
pub kernel: Option<PathBuf>,
#[cfg(windows)]
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// forward hypervisor kernel driver logs for this VM to a file.
pub kernel_log_file: Option<String>,
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = append)]
/// path to a socket from where to read keyboard input events and write status updates to
pub keyboard: Vec<PathBuf>,
#[cfg(any(target_os = "android", target_os = "linux"))]
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // Deprecated - use `hypervisor` instead.
#[merge(strategy = overwrite_option)]
/// path to the KVM device. (default /dev/kvm)
pub kvm_device: Option<PathBuf>,
#[cfg(any(target_os = "android", target_os = "linux"))]
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// disable host swap on guest VM pages.
pub lock_guest_memory: Option<bool>,
#[cfg(windows)]
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// redirect logs to the supplied log file at PATH rather than stderr. For multi-process mode,
/// use --logs-directory instead
pub log_file: Option<String>,
#[cfg(windows)]
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// path to the logs directory used for crosvm processes. Logs will be sent to stderr if unset,
/// and stderr/stdout will be uncaptured
pub logs_directory: Option<String>,
#[cfg(all(unix, feature = "net"))]
#[argh(option, arg_name = "MAC", long = "mac")]
#[serde(skip)] // Deprecated - use `net` instead.
#[merge(strategy = overwrite_option)]
/// MAC address for VM
pub mac_address: Option<net_util::MacAddress>,
#[argh(option, short = 'm', arg_name = "N")]
#[merge(strategy = overwrite_option)]
/// memory parameters.
/// Possible key values:
/// size=NUM - amount of guest memory in MiB. (default: 256)
pub mem: Option<MemOptions>,
#[argh(option, from_str_fn(parse_mmio_address_range))]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// MMIO address ranges
pub mmio_address_range: Option<Vec<AddressRange>>,
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = append)]
/// path to a socket from where to read mouse input events and write status updates to
pub mouse: Vec<PathBuf>,
#[cfg(target_arch = "aarch64")]
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// enable the Memory Tagging Extension in the guest
pub mte: Option<bool>,
#[argh(
option,
arg_name = "[path=]PATH[,width=WIDTH][,height=HEIGHT][,name=NAME]",
from_str_fn(parse_touch_device_option)
)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = append)]
/// path to a socket from where to read multi touch input events (such as those from a
/// touchscreen) and write status updates to, optionally followed by width and height (defaults
/// to 800x1280) and a name for the input device
pub multi_touch: Vec<TouchDeviceOption>,
#[argh(option)]
#[merge(strategy = overwrite_option)]
/// optional name for the VM. This is used as the name of the crosvm
/// process which is helpful to distinguish multiple crosvm processes.
/// A name longer than 15 bytes is truncated on Linux-like OSes. This
/// is no-op on Windows and MacOS at the moment.
pub name: Option<String>,
#[cfg(all(unix, feature = "net"))]
#[argh(
option,
arg_name = "(tap-name=TAP_NAME,mac=MAC_ADDRESS|tap-fd=TAP_FD,mac=MAC_ADDRESS|host-ip=IP,netmask=NETMASK,mac=MAC_ADDRESS),vhost-net=VHOST_NET,vq-pairs=N,pci-address=ADDR"
)]
#[serde(default)]
#[merge(strategy = append)]
/// comma separated key=value pairs for setting up a network
/// device.
/// Possible key values:
/// (
/// tap-name=STRING - name of a configured persistent TAP
/// interface to use for networking.
/// mac=STRING - MAC address for VM. [Optional]
/// OR
/// tap-fd=INT - File descriptor for configured tap
/// device.
/// mac=STRING - MAC address for VM. [Optional]
/// OR
/// (
/// host-ip=STRING - IP address to assign to host tap
/// interface.
/// AND
/// netmask=STRING - Netmask for VM subnet.
/// AND
/// mac=STRING - MAC address for VM.
/// )
/// )
/// AND
/// vhost-net
/// OR
/// vhost-net=[device=/vhost_net/device] - use vhost_net.
/// If the device path is not the default
/// /dev/vhost-net, it can also be
/// specified.
/// Default: false. [Optional]
/// vq-pairs=N - number of rx/tx queue pairs.
/// Default: 1. [Optional]
/// packed-queue - use packed queue.
/// If not set or set to false, it will
/// use split virtqueue.
/// Default: false. [Optional]
/// pci-address - preferred PCI address, e.g. "00:01.0"
/// Default: automatic PCI address assignment. [Optional]
///
/// Either one tap_name, one tap_fd or a triplet of host_ip,
/// netmask and mac must be specified.
pub net: Vec<NetParameters>,
#[cfg(all(unix, feature = "net"))]
#[argh(option, arg_name = "N")]
#[serde(skip)] // Deprecated - use `net` instead.
#[merge(strategy = overwrite_option)]
/// virtio net virtual queue pairs. (default: 1)
pub net_vq_pairs: Option<u16>,
#[cfg(all(unix, feature = "net"))]
#[argh(option, arg_name = "NETMASK")]
#[serde(skip)] // Deprecated - use `net` instead.
#[merge(strategy = overwrite_option)]
/// netmask for VM subnet
pub netmask: Option<std::net::Ipv4Addr>,
#[cfg(feature = "balloon")]
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// don't use virtio-balloon device in the guest
pub no_balloon: Option<bool>,
#[cfg(target_arch = "x86_64")]
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// don't use legacy KBD devices emulation
pub no_i8042: Option<bool>,
#[cfg(target_arch = "aarch64")]
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// disable Performance Monitor Unit (PMU)
pub no_pmu: Option<bool>,
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// don't create RNG device in the guest
pub no_rng: Option<bool>,
#[cfg(target_arch = "x86_64")]
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// don't use legacy RTC devices emulation
pub no_rtc: Option<bool>,
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// don't use SMT in the guest
pub no_smt: Option<bool>,
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// don't use usb devices in the guest
pub no_usb: Option<bool>,
#[cfg(target_arch = "x86_64")]
#[argh(option, arg_name = "OEM_STRING")]
#[serde(skip)] // Deprecated - use `smbios` instead.
#[merge(strategy = append)]
/// SMBIOS OEM string values to add to the DMI tables
pub oem_strings: Vec<String>,
#[argh(option, short = 'p', arg_name = "PARAMS")]
#[serde(default)]
#[merge(strategy = append)]
/// extra kernel or plugin command line arguments. Can be given more than once
pub params: Vec<String>,
#[cfg(any(target_os = "android", target_os = "linux"))]
#[argh(option, arg_name = "pci_hotplug_slots")]
#[serde(default)]
#[merge(strategy = overwrite_option)]
/// number of hotplug slot count (default: None)
pub pci_hotplug_slots: Option<u8>,
#[cfg(target_arch = "x86_64")]
#[argh(option, arg_name = "pci_low_mmio_start")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// the pci mmio start address below 4G
pub pci_start: Option<u64>,
#[cfg(target_arch = "x86_64")]
#[argh(
option,
arg_name = "mmio_base,mmio_length",
from_str_fn(parse_memory_region)
)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// region for PCIe Enhanced Configuration Access Mechanism
pub pcie_ecam: Option<AddressRange>,
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// enable per-VM core scheduling intead of the default one (per-vCPU core scheduing) by
/// making all vCPU threads share same cookie for core scheduling.
/// This option is no-op on devices that have neither MDS nor L1TF vulnerability
pub per_vm_core_scheduling: Option<bool>,
#[argh(
option,
arg_name = "path=PATH,[block_size=SIZE]",
from_str_fn(parse_pflash_parameters)
)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// comma-seperated key-value pair for setting up the pflash device, which provides space to
/// store UEFI variables. block_size defaults to 4K.
/// [--pflash <path=PATH,[block_size=SIZE]>]
pub pflash: Option<PflashParameters>,
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// path to empty directory to use for sandbox pivot root
pub pivot_root: Option<PathBuf>,
#[cfg(feature = "plugin")]
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// absolute path to plugin process to run under crosvm
pub plugin: Option<PathBuf>,
#[cfg(feature = "plugin")]
#[argh(option, arg_name = "GID:GID:INT")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = append)]
/// supplemental GIDs that should be mapped in plugin jail. Can be given more than once
pub plugin_gid_map: Vec<GidMap>,
#[cfg(feature = "plugin")]
#[argh(option)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// path to the file listing supplemental GIDs that should be mapped in plugin jail. Can be
/// given more than once
pub plugin_gid_map_file: Option<PathBuf>,
#[cfg(feature = "plugin")]
#[argh(option, arg_name = "PATH:PATH:BOOL")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = append)]
/// path to be mounted into the plugin's root filesystem. Can be given more than once
pub plugin_mount: Vec<BindMount>,
#[cfg(feature = "plugin")]
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// path to the file listing paths be mounted into the plugin's root filesystem. Can be given
/// more than once
pub plugin_mount_file: Option<PathBuf>,
#[cfg(feature = "plugin")]
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// absolute path to a directory that will become root filesystem for the plugin process.
pub plugin_root: Option<PathBuf>,
#[argh(option)]
#[serde(default)]
#[merge(strategy = append)]
/// parameters for setting up a virtio-pmem device.
/// Valid keys:
/// path=PATH - Path to the disk image. Can be specified
/// without the key as the first argument.
/// ro=BOOL - Whether the pmem device should be read-only.
/// (default: false)
/// vma-size=BYTES - (Experimental) Size in bytes
/// of an anonymous virtual memory area that is
/// created to back this device. When this
/// option is specified, the disk image path
/// is used to name the memory area
/// swap-interval-ms=NUM - (Experimental) Interval
/// in milliseconds for periodic swap out of
/// memory mapping created by this device. 0
/// means the memory mapping won't be swapped
/// out by crosvm
pub pmem: Vec<PmemOption>,
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = append)]
/// (DEPRECATED): Use --pmem instead.
/// path to a disk image
pmem_device: Vec<DiskOption>,
#[cfg(any(target_os = "android", target_os = "linux"))]
#[argh(
option,
arg_name = "PATH[,key=value[,key=value[,...]]]",
from_str_fn(parse_pmem_ext2_option)
)]
#[serde(default)]
#[merge(strategy = append)]
/// (EXPERIMENTAL): construct an ext2 file system on a pmem
/// device from the given directory. The argument is the form of
/// "PATH[,key=value[,key=value[,...]]]".
/// Valid keys:
/// blocks_per_group=NUM - Number of blocks in a block
/// group. (default: 4096)
/// inodes_per_group=NUM - Number of inodes in a block
/// group. (default: 1024)
/// size=BYTES - Size of the memory region allocated by this
/// device. A file system will be built on the region. If
/// the filesystem doesn't fit within this size, crosvm
/// will fail to start with an error.
/// The number of block groups in the file system is
/// calculated from this value and other given parameters.
/// The value of `size` must be larger than (4096 *
/// blocks_per_group.) (default: 16777216)
/// uid=UID - uid of the mkfs process in the user
/// namespace created by minijail. (default: 0)
/// gid=GID - gid of the mkfs process in the user
/// namespace created by minijail. (default: 0)
/// uidmap=UIDMAP - a uid map in the format
/// "inner outer count[,inner outer count]". This format
/// is same as one for minijail.
/// (default: "0 <current euid> 1")
/// gidmap=GIDMAP - a gid map in the same format as uidmap
/// (default: "0 <current egid> 1")
pub pmem_ext2: Vec<PmemExt2Option>,
#[cfg(feature = "process-invariants")]
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// shared read-only memory address for a serialized EmulatorProcessInvariants proto
pub process_invariants_handle: Option<u64>,
#[cfg(feature = "process-invariants")]
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// size of the serialized EmulatorProcessInvariants proto pointed at by
/// process-invariants-handle
pub process_invariants_size: Option<usize>,
#[cfg(windows)]
#[argh(option)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// product channel
pub product_channel: Option<String>,
#[cfg(windows)]
#[argh(option)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// the product name for file paths.
pub product_name: Option<String>,
#[cfg(windows)]
#[argh(option)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// product version
pub product_version: Option<String>,
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// prevent host access to guest memory
pub protected_vm: Option<bool>,
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// (EXPERIMENTAL/FOR DEBUGGING) Use custom VM firmware to run in protected mode
pub protected_vm_with_firmware: Option<PathBuf>,
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// (EXPERIMENTAL) prevent host access to guest memory, but don't use protected VM firmware
protected_vm_without_firmware: Option<bool>,
#[argh(option, arg_name = "path=PATH,size=SIZE")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// path to pstore buffer backend file followed by size
/// [--pstore <path=PATH,size=SIZE>]
pub pstore: Option<Pstore>,
#[cfg(feature = "pvclock")]
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// enable virtio-pvclock.
/// Only available when crosvm is built with feature 'pvclock'.
pub pvclock: Option<bool>,
#[argh(option, long = "restore", arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// path of the snapshot that is used to restore the VM on startup.
pub restore: Option<PathBuf>,
#[argh(option, arg_name = "PATH[,key=value[,key=value[,...]]]", short = 'r')]
#[serde(skip)] // Deprecated - use `block` instead.
#[merge(strategy = overwrite_option)]
// (DEPRECATED): Use `block` instead.
/// path to a disk image followed by optional comma-separated
/// options.
/// Valid keys:
/// sparse=BOOL - Indicates whether the disk should support
/// the discard operation (default: true)
/// block_size=BYTES - Set the reported block size of the
/// disk (default: 512)
/// id=STRING - Set the block device identifier to an ASCII
/// string, up to 20 characters (default: no ID)
/// o_direct=BOOL - Use O_DIRECT mode to bypass page cache
root: Option<DiskOptionWithId>,
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = append)]
/// path to a socket from where to read rotary input events and write status updates to
pub rotary: Vec<PathBuf>,
#[argh(option, arg_name = "CPUSET")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// comma-separated list of CPUs or CPU ranges to run VCPUs on. (e.g. 0,1-3,5) (default: none)
pub rt_cpus: Option<CpuSet>,
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = append)]
/// (DEPRECATED): Use --pmem instead.
/// path to a writable disk image
rw_pmem_device: Vec<DiskOption>,
#[argh(option, arg_name = "PATH[,key=value[,key=value[,...]]]")]
#[serde(skip)] // Deprecated - use `block` instead.
#[merge(strategy = append)]
// (DEPRECATED): Use `block` instead.
/// path to a read-write disk image followed by optional
/// comma-separated options.
/// Valid keys:
/// sparse=BOOL - Indicates whether the disk should support
/// the discard operation (default: true)
/// block_size=BYTES - Set the reported block size of the
/// disk (default: 512)
/// id=STRING - Set the block device identifier to an ASCII
/// string, up to 20 characters (default: no ID)
/// o_direct=BOOL - Use O_DIRECT mode to bypass page cache
rwdisk: Vec<DiskOptionWithId>,
#[argh(option, arg_name = "PATH[,key=value[,key=value[,...]]]")]
#[serde(skip)] // Deprecated - use `block` instead.
#[merge(strategy = overwrite_option)]
// (DEPRECATED) Use `block` instead.
/// path to a read-write root disk image followed by optional
/// comma-separated options.
/// Valid keys:
/// sparse=BOOL - Indicates whether the disk should support
/// the discard operation (default: true)
/// block_size=BYTES - Set the reported block size of the
/// disk (default: 512)
/// id=STRING - Set the block device identifier to an ASCII
/// string, up to 20 characters (default: no ID)
/// o_direct=BOOL - Use O_DIRECT mode to bypass page cache
rwroot: Option<DiskOptionWithId>,
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// set Low Power S0 Idle Capable Flag for guest Fixed ACPI
/// Description Table, additionally use enhanced crosvm suspend and resume
/// routines to perform full guest suspension/resumption
pub s2idle: Option<bool>,
#[argh(option, arg_name = "PATH[,key=value[,key=value[,...]]]")]
#[serde(default)]
#[merge(strategy = append)]
/// (EXPERIMENTAL) parameters for setting up a SCSI disk.
/// Valid keys:
/// path=PATH - Path to the disk image. Can be specified
/// without the key as the first argument.
/// block_size=BYTES - Set the reported block size of the
/// disk (default: 512)
/// ro=BOOL - Whether the block should be read-only.
/// (default: false)
/// root=BOOL - Whether the scsi device should be mounted
/// as the root filesystem. This will add the required
/// parameters to the kernel command-line. Can only be
/// specified once. (default: false)
// TODO(b/300580119): Add O_DIRECT and sparse file support.
scsi_block: Vec<ScsiOption>,
#[cfg(any(target_os = "android", target_os = "linux"))]
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// instead of seccomp filter failures being fatal, they will be logged instead
pub seccomp_log_failures: Option<bool>,
#[cfg(any(target_os = "android", target_os = "linux"))]
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// path to seccomp .policy files
pub seccomp_policy_dir: Option<PathBuf>,
#[argh(
option,
arg_name = "type=TYPE,[hardware=HW,name=NAME,num=NUM,path=PATH,input=PATH,console,earlycon,stdin,pci-address=ADDR]",
from_str_fn(parse_serial_options)
)]
#[serde(default)]
#[merge(strategy = append)]
/// comma separated key=value pairs for setting up serial
/// devices. Can be given more than once.
/// Possible key values:
/// type=(stdout,syslog,sink,file) - Where to route the
/// serial device
/// hardware=(serial,virtio-console,debugcon,
/// legacy-virtio-console) - Which type of
/// serial hardware to emulate. Defaults to 8250 UART
/// (serial).
/// name=NAME - Console Port Name, used for virtio-console
/// as a tag for identification within the guest.
/// num=(1,2,3,4) - Serial Device Number. If not provided,
/// num will default to 1.
/// debugcon_port=PORT - Port for the debugcon device to
/// listen to. Defaults to 0x402, which is what OVMF
/// expects.
/// path=PATH - The path to the file to write to when
/// type=file
/// input=PATH - The path to the file to read from when not
/// stdin
/// console - Use this serial device as the guest console.
/// Will default to first serial port if not provided.
/// earlycon - Use this serial device as the early console.
/// Can only be given once.
/// stdin - Direct standard input to this serial device.
/// Can only be given once. Will default to first serial
/// port if not provided.
/// pci-address - Preferred PCI address, e.g. "00:01.0".
pub serial: Vec<SerialParameters>,
#[cfg(windows)]
#[argh(option, arg_name = "PIPE_NAME")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// the service ipc pipe name. (Prefix \\\\.\\pipe\\ not needed.
pub service_pipe_name: Option<String>,
#[cfg(any(target_os = "android", target_os = "linux"))]
#[argh(
option,
arg_name = "PATH:TAG[:type=TYPE:writeback=BOOL:timeout=SECONDS:uidmap=UIDMAP:gidmap=GIDMAP:cache=CACHE:dax=BOOL,posix_acl=BOOL]"
)]
// TODO(b/218223240) add Deserialize implementation for SharedDir so it can be supported by the
// config file.
#[serde(skip)]
#[merge(strategy = append)]
/// colon-separated options for configuring a directory to be
/// shared with the VM. The first field is the directory to be
/// shared and the second field is the tag that the VM can use
/// to identify the device. The remaining fields are key=value
/// pairs that may appear in any order.
/// Valid keys are:
/// type=(p9, fs) - Indicates whether the directory should
/// be shared via virtio-9p or virtio-fs (default: p9).
/// uidmap=UIDMAP - The uid map to use for the device's
/// jail in the format "inner outer
/// count[,inner outer count]"
/// (default: 0 <current euid> 1).
/// gidmap=GIDMAP - The gid map to use for the device's
/// jail in the format "inner outer
/// count[,inner outer count]"
/// (default: 0 <current egid> 1).
/// cache=(never, auto, always) - Indicates whether the VM
/// can cache the contents of the shared directory
/// (default: auto). When set to "auto" and the type
/// is "fs", the VM will use close-to-open consistency
/// for file contents.
/// timeout=SECONDS - How long the VM should consider file
/// attributes and directory entries to be valid
/// (default: 5). If the VM has exclusive access to the
/// directory, then this should be a large value. If
/// the directory can be modified by other processes,
/// then this should be 0.
/// writeback=BOOL - Enables writeback caching
/// (default: false). This is only safe to do when the
/// VM has exclusive access to the files in a directory.
/// Additionally, the server should have read
/// permission for all files as the VM may issue read
/// requests even for files that are opened write-only.
/// dax=BOOL - Enables DAX support. Enabling DAX can
/// improve performance for frequently accessed files
/// by mapping regions of the file directly into the
/// VM's memory. There is a cost of slightly increased
/// latency the first time the file is accessed. Since
/// the mapping is shared directly from the host kernel's
/// file cache, enabling DAX can improve performance even
/// when the guest cache policy is "Never". The default
/// value for this option is "false".
/// posix_acl=BOOL - Indicates whether the shared directory
/// supports POSIX ACLs. This should only be enabled
/// when the underlying file system supports POSIX ACLs.
/// The default value for this option is "true".
/// uid=UID - uid of the device process in the user
/// namespace created by minijail. (default: 0)
/// gid=GID - gid of the device process in the user
/// namespace created by minijail. (default: 0)
/// max_dynamic_perm=uint - Indicates maximum number of
/// dynamic permissions that the shared directory allows.
/// (default: 0). The fuse server will return EPERM
/// Error when FS_IOC_SETPERMISSION ioctl is called
/// in the device if current dyamic permission path is
/// lager or equal to this value.
/// max_dynamic_xattr=uint - Indicates maximum number of
/// dynamic xattrs that the shared directory allows.
/// (default: 0). The fuse server will return EPERM
/// Error when FS_IOC_SETPATHXATTR ioctl is called
/// in the device if current dyamic permission path is
/// lager or equal to this value.
/// security_ctx=BOOL - Enables FUSE_SECURITY_CONTEXT
/// feature(default: true). This should be set to false
/// in case the when the host not allowing write to
/// /proc/<pid>/attr/fscreate, or guest directory does
/// not care about the security context.
/// Options uid and gid are useful when the crosvm process
/// has no CAP_SETGID/CAP_SETUID but an identity mapping of
/// the current user/group between the VM and the host is
/// required. Say the current user and the crosvm process
/// has uid 5000, a user can use "uid=5000" and
/// "uidmap=5000 5000 1" such that files owned by user
/// 5000 still appear to be owned by user 5000 in the VM.
/// These 2 options are useful only when there is 1 user
/// in the VM accessing shared files. If multiple users
/// want to access the shared file, gid/uid options are
/// useless. It'd be better to create a new user namespace
/// and give CAP_SETUID/CAP_SETGID to the crosvm.
pub shared_dir: Vec<SharedDir>,
#[argh(
option,
arg_name = "[path=]PATH[,width=WIDTH][,height=HEIGHT][,name=NAME]",
from_str_fn(parse_touch_device_option)
)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = append)]
/// path to a socket from where to read single touch input events (such as those from a
/// touchscreen) and write status updates to, optionally followed by width and height (defaults
/// to 800x1280) and a name for the input device
pub single_touch: Vec<TouchDeviceOption>,
#[cfg(any(feature = "slirp-ring-capture", feature = "slirp-debug"))]
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// redirects slirp network packets to the supplied log file rather than the current directory
/// as `slirp_capture_packets.pcap`
pub slirp_capture_file: Option<String>,
#[cfg(target_arch = "x86_64")]
#[argh(option, arg_name = "key=val,...")]
#[serde(default)]
#[merge(strategy = overwrite_option)]
/// SMBIOS table configuration (DMI)
/// The fields are key=value pairs.
/// Valid keys are:
/// bios-vendor=STRING - BIOS vendor name.
/// bios-version=STRING - BIOS version number (free-form string).
/// manufacturer=STRING - System manufacturer name.
/// product-name=STRING - System product name.
/// serial-number=STRING - System serial number.
/// uuid=UUID - System UUID.
/// oem-strings=[...] - Free-form OEM strings (SMBIOS type 11).
pub smbios: Option<SmbiosOptions>,
#[argh(option, short = 's', arg_name = "PATH")]
#[merge(strategy = overwrite_option)]
/// path to put the control socket. If PATH is a directory, a name will be generated
pub socket: Option<PathBuf>,
#[cfg(feature = "audio")]
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// path to the VioS server socket for setting up virtio-snd devices
pub sound: Option<PathBuf>,
#[cfg(target_arch = "x86_64")]
#[argh(switch)]
#[serde(skip)] // Deprecated - use `irq_chip` instead.
#[merge(strategy = overwrite_option)]
/// (EXPERIMENTAL) enable split-irqchip support
pub split_irqchip: Option<bool>,
#[argh(
option,
arg_name = "DOMAIN:BUS:DEVICE.FUNCTION[,vendor=NUM][,device=NUM][,class=NUM][,subsystem_vendor=NUM][,subsystem_device=NUM][,revision=NUM]"
)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = append)]
/// comma-separated key=value pairs for setting up a stub PCI
/// device that just enumerates. The first option in the list
/// must specify a PCI address to claim.
/// Optional further parameters
/// vendor=NUM - PCI vendor ID
/// device=NUM - PCI device ID
/// class=NUM - PCI class (including class code, subclass,
/// and programming interface)
/// subsystem_vendor=NUM - PCI subsystem vendor ID
/// subsystem_device=NUM - PCI subsystem device ID
/// revision=NUM - revision
pub stub_pci_device: Vec<StubPciParameters>,
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// start a VM with vCPUs and devices suspended
pub suspended: Option<bool>,
#[argh(option, long = "swap", arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// enable vmm-swap via an unnamed temporary file on the filesystem which contains the
/// specified directory.
pub swap_dir: Option<PathBuf>,
#[argh(option, arg_name = "N")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// (EXPERIMENTAL) Size of virtio swiotlb buffer in MiB (default: 64 if `--protected-vm` or
/// `--protected-vm-without-firmware` is present)
pub swiotlb: Option<u64>,
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = append)]
/// path to a socket from where to read switch input events and write status updates to
pub switches: Vec<PathBuf>,
#[argh(option, arg_name = "TAG")]
#[serde(skip)] // Deprecated - use `CrosvmCmdlineArgs::syslog_tag` instead.
#[merge(strategy = overwrite_option)]
/// when logging to syslog, use the provided tag
pub syslog_tag: Option<String>,
#[cfg(any(target_os = "android", target_os = "linux"))]
#[argh(option)]
#[serde(skip)] // Deprecated - use `net` instead.
#[merge(strategy = append)]
/// file descriptor for configured tap device. A different virtual network card will be added
/// each time this argument is given
pub tap_fd: Vec<RawDescriptor>,
#[cfg(any(target_os = "android", target_os = "linux"))]
#[argh(option)]
#[serde(skip)] // Deprecated - use `net` instead.
#[merge(strategy = append)]
/// name of a configured persistent TAP interface to use for networking. A different virtual
/// network card will be added each time this argument is given
pub tap_name: Vec<String>,
#[cfg(target_os = "android")]
#[argh(option, arg_name = "NAME[,...]")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = append)]
/// comma-separated names of the task profiles to apply to all threads in crosvm including the
/// vCPU threads
pub task_profiles: Vec<String>,
#[argh(
option,
arg_name = "[path=]PATH[,width=WIDTH][,height=HEIGHT][,name=NAME]",
from_str_fn(parse_touch_device_option)
)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = append)]
/// path to a socket from where to read trackpad input events and write status updates to,
/// optionally followed by screen width and height (defaults to 800x1280) and a name for the
/// input device
pub trackpad: Vec<TouchDeviceOption>,
#[cfg(any(target_os = "android", target_os = "linux"))]
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// set MADV_DONTFORK on guest memory
///
/// Intended for use in combination with --protected-vm, where the guest memory can be
/// dangerous to access. Some systems, e.g. Android, have tools that fork processes and examine
/// their memory. This flag effectively hides the guest memory from those tools.
///
/// Not compatible with sandboxing.
pub unmap_guest_memory_on_fork: Option<bool>,
// Must be `Some` iff `protection_type == ProtectionType::UnprotectedWithFirmware`.
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// (EXPERIMENTAL/FOR DEBUGGING) Use VM firmware, but allow host access to guest memory
pub unprotected_vm_with_firmware: Option<PathBuf>,
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// move all vCPU threads to this CGroup (default: nothing moves)
pub vcpu_cgroup_path: Option<PathBuf>,
#[cfg(any(target_os = "android", target_os = "linux"))]
#[argh(
option,
arg_name = "PATH[,guest-address=<BUS:DEVICE.FUNCTION>][,iommu=viommu|coiommu|pkvm-iommu|off][,dt-symbol=<SYMBOL>]"
)]
#[serde(default)]
#[merge(strategy = append)]
/// path to sysfs of VFIO device.
/// guest-address=<BUS:DEVICE.FUNCTION> - PCI address
/// that the device will be assigned in the guest.
/// If not specified, the device will be assigned an
/// address that mirrors its address in the host.
/// Only valid for PCI devices.
/// iommu=viommu|coiommu|pkvm-iommu|off - indicates which type of IOMMU
/// to use for this device.
/// dt-symbol=<SYMBOL> - the symbol that labels the device tree
/// node in the device tree overlay file.
pub vfio: Vec<VfioOption>,
#[cfg(any(target_os = "android", target_os = "linux"))]
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// isolate all hotplugged passthrough vfio device behind virtio-iommu
pub vfio_isolate_hotplug: Option<bool>,
#[cfg(any(target_os = "android", target_os = "linux"))]
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // Deprecated - use `vfio` instead.
#[merge(strategy = append)]
/// path to sysfs of platform pass through
pub vfio_platform: Vec<VfioOption>,
#[cfg(any(target_os = "android", target_os = "linux"))]
#[argh(switch)]
#[serde(skip)] // Deprecated - use `net` instead.
#[merge(strategy = overwrite_option)]
/// use vhost for networking
pub vhost_net: Option<bool>,
#[cfg(any(target_os = "android", target_os = "linux"))]
#[argh(option, arg_name = "PATH")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// path to the vhost-net device. (default /dev/vhost-net)
pub vhost_net_device: Option<PathBuf>,
#[cfg(any(target_os = "android", target_os = "linux"))]
#[cfg(any(target_arch = "arm", target_arch = "aarch64"))]
#[argh(switch)]
#[merge(strategy = overwrite_option)]
/// use vhost for scmi
pub vhost_scmi: Option<bool>,
#[argh(
option,
arg_name = "[type=]TYPE,socket=SOCKET_PATH[,max-queue-size=NUM][,pci-address=ADDR]"
)]
#[serde(default)]
#[merge(strategy = append)]
/// comma separated key=value pairs for connecting to a
/// vhost-user backend.
/// Possible key values:
/// type=TYPE - Virtio device type (net, block, etc.)
/// socket=SOCKET_PATH - Path to vhost-user socket.
/// max-queue-size=NUM - Limit maximum queue size (must be a power of two).
/// pci-address=ADDR - Preferred PCI address, e.g. "00:01.0".
pub vhost_user: Vec<VhostUserFrontendOption>,
#[argh(option, arg_name = "SOCKET_PATH")]
#[serde(skip)] // Deprecated - use `vhost-user` instead.
#[merge(strategy = append)]
/// path to a socket for vhost-user block
pub vhost_user_blk: Vec<VhostUserOption>,
#[argh(option)]
#[serde(skip)]
#[merge(strategy = overwrite_option)]
/// number of milliseconds to retry if the socket path is missing or has no listener. Defaults
/// to no retries.
pub vhost_user_connect_timeout_ms: Option<u64>,
#[argh(option, arg_name = "SOCKET_PATH")]
#[serde(skip)] // Deprecated - use `vhost-user` instead.
#[merge(strategy = append)]
/// path to a socket for vhost-user console
pub vhost_user_console: Vec<VhostUserOption>,
#[argh(
option,
arg_name = "[socket=]SOCKET_PATH,tag=TAG[,max-queue-size=NUM]",
from_str_fn(parse_vhost_user_fs_option)
)]
#[serde(skip)] // Deprecated - use `vhost-user` instead.
#[merge(strategy = append)]
/// path to a socket path for vhost-user fs, and tag for the shared dir
pub vhost_user_fs: Vec<VhostUserFsOption>,
#[argh(option, arg_name = "SOCKET_PATH")]
#[serde(skip)] // Deprecated - use `vhost-user` instead.
#[merge(strategy = append)]
/// paths to a vhost-user socket for gpu
pub vhost_user_gpu: Vec<VhostUserOption>,
#[argh(option, arg_name = "SOCKET_PATH")]
#[serde(skip)] // Deprecated - use `vhost-user` instead.
#[merge(strategy = overwrite_option)]
/// path to a socket for vhost-user mac80211_hwsim
pub vhost_user_mac80211_hwsim: Option<VhostUserOption>,
#[argh(option, arg_name = "SOCKET_PATH")]
#[serde(skip)] // Deprecated - use `vhost-user` instead.
#[merge(strategy = append)]
/// path to a socket for vhost-user net
pub vhost_user_net: Vec<VhostUserOption>,
#[argh(option, arg_name = "SOCKET_PATH")]
#[serde(skip)] // Deprecated - use `vhost-user` instead.
#[merge(strategy = append)]
/// path to a socket for vhost-user snd
pub vhost_user_snd: Vec<VhostUserOption>,
#[argh(option, arg_name = "SOCKET_PATH")]
#[serde(skip)] // Deprecated - use `vhost-user` instead.
#[merge(strategy = append)]
/// path to a socket for vhost-user video decoder
pub vhost_user_video_decoder: Vec<VhostUserOption>,
#[argh(option, arg_name = "SOCKET_PATH")]
#[serde(skip)] // Deprecated - use `vhost-user` instead.
#[merge(strategy = append)]
/// path to a socket for vhost-user vsock
pub vhost_user_vsock: Vec<VhostUserOption>,
#[argh(option, arg_name = "SOCKET_PATH")]
#[serde(skip)] // Deprecated - use `vhost-user` instead.
#[merge(strategy = overwrite_option)]
/// path to a vhost-user socket for wayland
pub vhost_user_wl: Option<VhostUserOption>,
#[cfg(any(target_os = "android", target_os = "linux"))]
#[argh(option, arg_name = "SOCKET_PATH")]
#[serde(skip)] // Deprecated - use `vsock` instead.
#[merge(strategy = overwrite_option)]
/// path to the vhost-vsock device. (default /dev/vhost-vsock)
pub vhost_vsock_device: Option<PathBuf>,
#[cfg(any(target_os = "android", target_os = "linux"))]
#[argh(option, arg_name = "FD")]
#[serde(skip)] // Deprecated - use `vsock` instead.
#[merge(strategy = overwrite_option)]
/// open FD to the vhost-vsock device, mutually exclusive with vhost-vsock-device
pub vhost_vsock_fd: Option<RawDescriptor>,
#[cfg(feature = "video-decoder")]
#[argh(option, arg_name = "[backend]")]
#[serde(default)]
#[merge(strategy = append)]
/// (EXPERIMENTAL) enable virtio-video decoder device
/// Possible backend values: libvda, ffmpeg, vaapi
pub video_decoder: Vec<VideoDeviceConfig>,
#[cfg(feature = "video-encoder")]
#[argh(option, arg_name = "[backend]")]
#[serde(default)]
#[merge(strategy = append)]
/// (EXPERIMENTAL) enable virtio-video encoder device
/// Possible backend values: libvda
pub video_encoder: Vec<VideoDeviceConfig>,
#[cfg(all(
any(target_arch = "arm", target_arch = "aarch64"),
any(target_os = "android", target_os = "linux")
))]
#[argh(switch)]
#[serde(skip)]
#[merge(strategy = overwrite_option)]
/// enable a virtual cpu freq device
pub virt_cpufreq: Option<bool>,
#[cfg(all(
any(target_arch = "arm", target_arch = "aarch64"),
any(target_os = "android", target_os = "linux")
))]
#[argh(switch)]
#[serde(skip)]
#[merge(strategy = overwrite_option)]
/// enable version of the virtual cpu freq device compatible
/// with the driver in upstream linux
pub virt_cpufreq_upstream: Option<bool>,
#[cfg(feature = "audio")]
#[argh(
option,
arg_name = "[capture=true,backend=BACKEND,num_output_devices=1,\
num_input_devices=1,num_output_streams=1,num_input_streams=1]"
)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = append)]
/// comma separated key=value pairs for setting up virtio snd
/// devices.
/// Possible key values:
/// capture=(false,true) - Disable/enable audio capture.
/// Default is false.
/// backend=(null,file,[cras]) - Which backend to use for
/// virtio-snd.
/// client_type=(crosvm,arcvm,borealis) - Set specific
/// client type for cras backend. Default is crosvm.
/// socket_type=(legacy,unified) Set specific socket type
/// for cras backend. Default is unified.
/// playback_path=STR - Set directory of output streams
/// for file backend.
/// playback_size=INT - Set size of the output streams
/// from file backend.
/// num_output_devices=INT - Set number of output PCM
/// devices.
/// num_input_devices=INT - Set number of input PCM devices.
/// num_output_streams=INT - Set number of output PCM
/// streams per device.
/// num_input_streams=INT - Set number of input PCM streams
/// per device.
pub virtio_snd: Vec<SndParameters>,
#[argh(option, arg_name = "cid=CID[,device=VHOST_DEVICE]")]
#[serde(default)]
#[merge(strategy = overwrite_option)]
/// add a vsock device. Since a guest can only have one CID,
/// this option can only be specified once.
/// cid=CID - CID to use for the device.
/// device=VHOST_DEVICE - path to the vhost-vsock device to
/// use (Linux only). Defaults to /dev/vhost-vsock.
pub vsock: Option<VsockConfig>,
#[cfg(feature = "vtpm")]
#[argh(switch)]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// enable the virtio-tpm connection to vtpm daemon
pub vtpm_proxy: Option<bool>,
#[cfg(any(target_os = "android", target_os = "linux"))]
#[argh(option, arg_name = "PATH[,name=NAME]", from_str_fn(parse_wayland_sock))]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = append)]
/// path to the Wayland socket to use. The unnamed one is used for displaying virtual screens.
/// Named ones are only for IPC
pub wayland_sock: Vec<(String, PathBuf)>,
#[cfg(any(target_os = "android", target_os = "linux"))]
#[argh(option, arg_name = "DISPLAY")]
#[serde(skip)] // TODO(b/255223604)
#[merge(strategy = overwrite_option)]
/// X11 display name to use
pub x_display: Option<String>,
}
#[cfg(feature = "config-file")]
impl RunCommand {
/// Merge the content of `self` into `self.cfg` if it exists, and return the merged
/// configuration in which `self.cfg` is empty.
pub fn squash(mut self) -> Self {
use merge::Merge;
std::mem::take(&mut self.cfg)
.into_iter()
.map(|c| c.squash())
.chain(std::iter::once(self))
.reduce(|mut acc: Self, cfg| {
acc.merge(cfg);
acc
})
.unwrap()
}
}
impl TryFrom<RunCommand> for super::config::Config {
type Error = String;
fn try_from(cmd: RunCommand) -> Result<Self, Self::Error> {
// Squash the configuration file (if any) and command-line arguments together.
#[cfg(feature = "config-file")]
let cmd = {
if !cmd.cfg.is_empty() {
log::warn!(
"`--cfg` is still experimental and the configuration file format may change"
);
}
cmd.squash()
};
#[cfg(feature = "config-file")]
if let Some(cfg_path) = &cmd.dump_cfg {
write_config_file(cfg_path, &cmd)?;
}
let mut cfg = Self::default();
// TODO: we need to factor out some(?) of the checks into config::validate_config
// Process arguments
if let Some(p) = cmd.kernel {
cfg.executable_path = Some(Executable::Kernel(p));
}
#[cfg(any(target_os = "android", target_os = "linux"))]
if let Some(p) = cmd.kvm_device {
log::warn!(
"`--kvm-device <PATH>` is deprecated; use `--hypervisor kvm[device=<PATH>]` instead"
);
if cmd.hypervisor.is_some() {
return Err("cannot specify both --hypervisor and --kvm-device".to_string());
}
cfg.hypervisor = Some(crate::crosvm::config::HypervisorKind::Kvm { device: Some(p) });
}
cfg.android_fstab = cmd.android_fstab;
cfg.async_executor = cmd.async_executor;
#[cfg(target_arch = "x86_64")]
if let Some(p) = cmd.bus_lock_ratelimit {
cfg.bus_lock_ratelimit = p;
}
cfg.params.extend(cmd.params);
cfg.core_scheduling = cmd.core_scheduling;
cfg.per_vm_core_scheduling = cmd.per_vm_core_scheduling.unwrap_or_default();
// `--cpu` parameters.
{
let cpus = cmd.cpus.unwrap_or_default();
cfg.vcpu_count = cpus.num_cores;
cfg.boot_cpu = cpus.boot_cpu.unwrap_or_default();
cfg.cpu_freq_domains = cpus.freq_domains;
// Only allow deprecated `--cpu-cluster` option only if `--cpu clusters=[...]` is not
// used.
cfg.cpu_clusters = match (&cpus.clusters.is_empty(), &cmd.cpu_cluster.is_empty()) {
(_, true) => cpus.clusters,
(true, false) => cmd.cpu_cluster,
(false, false) => {
return Err(
"cannot specify both --cpu clusters=[...] and --cpu_cluster".to_string()
)
}
};
#[cfg(target_arch = "x86_64")]
if let Some(cpu_types) = cpus.core_types {
for cpu in cpu_types.atom {
if cfg
.vcpu_hybrid_type
.insert(cpu, CpuHybridType::Atom)
.is_some()
{
return Err(format!("vCPU index must be unique {}", cpu));
}
}
for cpu in cpu_types.core {
if cfg
.vcpu_hybrid_type
.insert(cpu, CpuHybridType::Core)
.is_some()
{
return Err(format!("vCPU index must be unique {}", cpu));
}
}
}
#[cfg(any(target_arch = "arm", target_arch = "aarch64"))]
{
cfg.sve = cpus.sve;
}
}
cfg.vcpu_affinity = cmd.cpu_affinity;
if let Some(dynamic_power_coefficient) = cmd.dynamic_power_coefficient {
cfg.dynamic_power_coefficient = dynamic_power_coefficient;
}
if let Some(capacity) = cmd.cpu_capacity {
cfg.cpu_capacity = capacity;
}
#[cfg(all(
any(target_arch = "arm", target_arch = "aarch64"),
any(target_os = "android", target_os = "linux")
))]
{
cfg.virt_cpufreq = cmd.virt_cpufreq.unwrap_or_default();
cfg.virt_cpufreq_v2 = cmd.virt_cpufreq_upstream.unwrap_or_default();
if cfg.virt_cpufreq && cfg.virt_cpufreq_v2 {
return Err("Only one version of virt-cpufreq can be used!".to_string());
}
if let Some(frequencies) = cmd.cpu_frequencies_khz {
cfg.cpu_frequencies_khz = frequencies;
}
}
cfg.vcpu_cgroup_path = cmd.vcpu_cgroup_path;
cfg.no_smt = cmd.no_smt.unwrap_or_default();
if let Some(rt_cpus) = cmd.rt_cpus {
cfg.rt_cpus = rt_cpus;
}
cfg.delay_rt = cmd.delay_rt.unwrap_or_default();
let mem = cmd.mem.unwrap_or_default();
cfg.memory = mem.size;
#[cfg(target_arch = "aarch64")]
{
if cmd.mte.unwrap_or_default()
&& !(cmd.pmem.is_empty()
&& cmd.pmem_device.is_empty()
&& cmd.pstore.is_none()
&& cmd.rw_pmem_device.is_empty())
{
return Err(
"--mte cannot be specified together with --pstore or pmem flags".to_string(),
);
}
cfg.mte = cmd.mte.unwrap_or_default();
cfg.no_pmu = cmd.no_pmu.unwrap_or_default();
cfg.swiotlb = cmd.swiotlb;
}
cfg.hugepages = cmd.hugepages.unwrap_or_default();
// `cfg.hypervisor` may have been set by the deprecated `--kvm-device` option above.
// TODO(b/274817652): remove this workaround when `--kvm-device` is removed.
if cfg.hypervisor.is_none() {
cfg.hypervisor = cmd.hypervisor;
}
#[cfg(any(target_os = "android", target_os = "linux"))]
{
cfg.lock_guest_memory = cmd.lock_guest_memory.unwrap_or_default();
cfg.boost_uclamp = cmd.boost_uclamp.unwrap_or_default();
}
#[cfg(feature = "audio")]
{
cfg.sound = cmd.sound;
}
for serial_params in cmd.serial {
super::sys::config::check_serial_params(&serial_params)?;
let num = serial_params.num;
let key = (serial_params.hardware, num);
if cfg.serial_parameters.contains_key(&key) {
return Err(format!(
"serial hardware {} num {}",
serial_params.hardware, num,
));
}
if serial_params.earlycon {
// Only SerialHardware::Serial supports earlycon= currently.
match serial_params.hardware {
SerialHardware::Serial => {}
_ => {
return Err(super::config::invalid_value_err(
serial_params.hardware.to_string(),
String::from("earlycon not supported for hardware"),
));
}
}
for params in cfg.serial_parameters.values() {
if params.earlycon {
return Err(format!(
"{} device {} already set as earlycon",
params.hardware, params.num,
));
}
}
}
if serial_params.stdin {
if let Some(previous_stdin) = cfg.serial_parameters.values().find(|sp| sp.stdin) {
return Err(format!(
"{} device {} already connected to standard input",
previous_stdin.hardware, previous_stdin.num,
));
}
}
cfg.serial_parameters.insert(key, serial_params);
}
if !(cmd.root.is_none()
&& cmd.rwroot.is_none()
&& cmd.disk.is_empty()
&& cmd.rwdisk.is_empty())
{
log::warn!("Deprecated disk flags such as --[rw]disk or --[rw]root are passed. Use --block instead.");
}
// Aggregate all the disks with the expected read-only and root values according to the
// option they have been passed with.
let mut disks = cmd
.root
.into_iter()
.map(|mut d| {
d.disk_option.read_only = true;
d.disk_option.root = true;
d
})
.chain(cmd.rwroot.into_iter().map(|mut d| {
d.disk_option.read_only = false;
d.disk_option.root = true;
d
}))
.chain(cmd.disk.into_iter().map(|mut d| {
d.disk_option.read_only = true;
d.disk_option.root = false;
d
}))
.chain(cmd.rwdisk.into_iter().map(|mut d| {
d.disk_option.read_only = false;
d.disk_option.root = false;
d
}))
.chain(cmd.block)
.collect::<Vec<_>>();
// Sort all our disks by index.
disks.sort_by_key(|d| d.index);
cfg.disks = disks.into_iter().map(|d| d.disk_option).collect();
cfg.scsis = cmd.scsi_block;
cfg.pmems = cmd.pmem;
if !cmd.pmem_device.is_empty() || !cmd.rw_pmem_device.is_empty() {
log::warn!(
"--pmem-device and --rw-pmem-device are deprecated. Please use --pmem instead."
);
}
// Convert the deprecated `pmem_device` and `rw_pmem_device` into `pmem_devices`.
for disk_option in cmd.pmem_device.into_iter() {
cfg.pmems.push(PmemOption {
path: disk_option.path,
ro: true, // read-only
..PmemOption::default()
});
}
for disk_option in cmd.rw_pmem_device.into_iter() {
cfg.pmems.push(PmemOption {
path: disk_option.path,
ro: false, // writable
..PmemOption::default()
});
}
// Find the device to use as the kernel `root=` parameter. There can only be one.
let virtio_blk_root_devs = cfg
.disks
.iter()
.enumerate()
.filter(|(_, d)| d.root)
.map(|(i, d)| (format_disk_letter("/dev/vd", i), d.read_only));
let virtio_scsi_root_devs = cfg
.scsis
.iter()
.enumerate()
.filter(|(_, s)| s.root)
.map(|(i, s)| (format_disk_letter("/dev/sd", i), s.read_only));
let virtio_pmem_root_devs = cfg
.pmems
.iter()
.enumerate()
.filter(|(_, p)| p.root)
.map(|(i, p)| (format!("/dev/pmem{}", i), p.ro));
let mut root_devs = virtio_blk_root_devs
.chain(virtio_scsi_root_devs)
.chain(virtio_pmem_root_devs);
if let Some((root_dev, read_only)) = root_devs.next() {
cfg.params.push(format!(
"root={} {}",
root_dev,
if read_only { "ro" } else { "rw" }
));
// If the iterator is not exhausted, the user specified `root=true` on more than one
// device, which is an error.
if root_devs.next().is_some() {
return Err("only one root disk can be specified".to_string());
}
}
#[cfg(any(target_os = "android", target_os = "linux"))]
{
cfg.pmem_ext2 = cmd.pmem_ext2;
}
#[cfg(feature = "pvclock")]
{
cfg.pvclock = cmd.pvclock.unwrap_or_default();
}
#[cfg(windows)]
{
#[cfg(feature = "crash-report")]
{
cfg.crash_pipe_name = cmd.crash_pipe_name;
}
cfg.product_name = cmd.product_name;
cfg.exit_stats = cmd.exit_stats.unwrap_or_default();
cfg.host_guid = cmd.host_guid;
cfg.kernel_log_file = cmd.kernel_log_file;
cfg.log_file = cmd.log_file;
cfg.logs_directory = cmd.logs_directory;
#[cfg(feature = "process-invariants")]
{
cfg.process_invariants_data_handle = cmd.process_invariants_handle;
cfg.process_invariants_data_size = cmd.process_invariants_size;
}
#[cfg(windows)]
{
cfg.service_pipe_name = cmd.service_pipe_name;
}
#[cfg(any(feature = "slirp-ring-capture", feature = "slirp-debug"))]
{
cfg.slirp_capture_file = cmd.slirp_capture_file;
}
cfg.product_channel = cmd.product_channel;
cfg.product_version = cmd.product_version;
}
cfg.pstore = cmd.pstore;
cfg.enable_fw_cfg = cmd.enable_fw_cfg.unwrap_or_default();
cfg.fw_cfg_parameters = cmd.fw_cfg;
#[cfg(any(target_os = "android", target_os = "linux"))]
for (name, params) in cmd.wayland_sock {
if cfg.wayland_socket_paths.contains_key(&name) {
return Err(format!("wayland socket name already used: '{}'", name));
}
cfg.wayland_socket_paths.insert(name, params);
}
#[cfg(any(target_os = "android", target_os = "linux"))]
{
cfg.x_display = cmd.x_display;
}
cfg.display_window_keyboard = cmd.display_window_keyboard.unwrap_or_default();
cfg.display_window_mouse = cmd.display_window_mouse.unwrap_or_default();
cfg.swap_dir = cmd.swap_dir;
cfg.restore_path = cmd.restore;
cfg.suspended = cmd.suspended.unwrap_or_default();
if let Some(mut socket_path) = cmd.socket {
if socket_path.is_dir() {
socket_path.push(format!("crosvm-{}.sock", getpid()));
}
cfg.socket_path = Some(socket_path);
}
cfg.vsock = cmd.vsock;
// Legacy vsock options.
if let Some(cid) = cmd.cid {
if cfg.vsock.is_some() {
return Err(
"`cid` and `vsock` cannot be specified together. Use `vsock` only.".to_string(),
);
}
let legacy_vsock_config = VsockConfig::new(
cid,
#[cfg(any(target_os = "android", target_os = "linux"))]
match (cmd.vhost_vsock_device, cmd.vhost_vsock_fd) {
(Some(_), Some(_)) => {
return Err(
"Only one of vhost-vsock-device vhost-vsock-fd has to be specified"
.to_string(),
)
}
(Some(path), None) => Some(path),
(None, Some(fd)) => Some(PathBuf::from(format!("/proc/self/fd/{}", fd))),
(None, None) => None,
},
);
cfg.vsock = Some(legacy_vsock_config);
}
#[cfg(feature = "plugin")]
{
use std::fs::File;
use std::io::BufRead;
use std::io::BufReader;
if let Some(p) = cmd.plugin {
if cfg.executable_path.is_some() {
return Err(format!(
"A VM executable was already specified: {:?}",
cfg.executable_path
));
}
cfg.executable_path = Some(Executable::Plugin(p));
}
cfg.plugin_root = cmd.plugin_root;
cfg.plugin_mounts = cmd.plugin_mount;
if let Some(path) = cmd.plugin_mount_file {
let file = File::open(path)
.map_err(|_| String::from("unable to open `plugin-mount-file` file"))?;
let reader = BufReader::new(file);
for l in reader.lines() {
let line = l.unwrap();
let trimmed_line = line.split_once('#').map_or(&*line, |x| x.0).trim();
if !trimmed_line.is_empty() {
let mount = parse_plugin_mount_option(trimmed_line)?;
cfg.plugin_mounts.push(mount);
}
}
}
cfg.plugin_gid_maps = cmd.plugin_gid_map;
if let Some(path) = cmd.plugin_gid_map_file {
let file = File::open(path)
.map_err(|_| String::from("unable to open `plugin-gid-map-file` file"))?;
let reader = BufReader::new(file);
for l in reader.lines() {
let line = l.unwrap();
let trimmed_line = line.split_once('#').map_or(&*line, |x| x.0).trim();
if !trimmed_line.is_empty() {
let map = trimmed_line.parse()?;
cfg.plugin_gid_maps.push(map);
}
}
}
}
#[cfg(any(target_os = "android", target_os = "linux"))]
#[cfg(any(target_arch = "arm", target_arch = "aarch64"))]
{
cfg.vhost_scmi = cmd.vhost_scmi.unwrap_or_default();
}
#[cfg(feature = "vtpm")]
{
cfg.vtpm_proxy = cmd.vtpm_proxy.unwrap_or_default();
}
cfg.virtio_input = cmd.input;
if !cmd.single_touch.is_empty() {
log::warn!("`--single-touch` is deprecated; please use `--input single-touch[...]`");
cfg.virtio_input
.extend(
cmd.single_touch
.into_iter()
.map(|touch| InputDeviceOption::SingleTouch {
path: touch.path,
width: touch.width,
height: touch.height,
name: touch.name,
}),
);
}
if !cmd.multi_touch.is_empty() {
log::warn!("`--multi-touch` is deprecated; please use `--input multi-touch[...]`");
cfg.virtio_input
.extend(
cmd.multi_touch
.into_iter()
.map(|touch| InputDeviceOption::MultiTouch {
path: touch.path,
width: touch.width,
height: touch.height,
name: touch.name,
}),
);
}
if !cmd.trackpad.is_empty() {
log::warn!("`--trackpad` is deprecated; please use `--input trackpad[...]`");
cfg.virtio_input
.extend(
cmd.trackpad
.into_iter()
.map(|trackpad| InputDeviceOption::Trackpad {
path: trackpad.path,
width: trackpad.width,
height: trackpad.height,
name: trackpad.name,
}),
);
}
if !cmd.mouse.is_empty() {
log::warn!("`--mouse` is deprecated; please use `--input mouse[...]`");
cfg.virtio_input.extend(
cmd.mouse
.into_iter()
.map(|path| InputDeviceOption::Mouse { path }),
);
}
if !cmd.keyboard.is_empty() {
log::warn!("`--keyboard` is deprecated; please use `--input keyboard[...]`");
cfg.virtio_input.extend(
cmd.keyboard
.into_iter()
.map(|path| InputDeviceOption::Keyboard { path }),
)
}
if !cmd.switches.is_empty() {
log::warn!("`--switches` is deprecated; please use `--input switches[...]`");
cfg.virtio_input.extend(
cmd.switches
.into_iter()
.map(|path| InputDeviceOption::Switches { path }),
);
}
if !cmd.rotary.is_empty() {
log::warn!("`--rotary` is deprecated; please use `--input rotary[...]`");
cfg.virtio_input.extend(
cmd.rotary
.into_iter()
.map(|path| InputDeviceOption::Rotary { path }),
);
}
if !cmd.evdev.is_empty() {
log::warn!("`--evdev` is deprecated; please use `--input evdev[...]`");
cfg.virtio_input.extend(
cmd.evdev
.into_iter()
.map(|path| InputDeviceOption::Evdev { path }),
);
}
cfg.irq_chip = cmd.irqchip;
#[cfg(target_arch = "x86_64")]
if cmd.split_irqchip.unwrap_or_default() {
if cmd.irqchip.is_some() {
return Err("cannot use `--irqchip` and `--split-irqchip` together".to_string());
}
log::warn!("`--split-irqchip` is deprecated; please use `--irqchip=split`");
cfg.irq_chip = Some(IrqChipKind::Split);
}
cfg.initrd_path = cmd.initrd;
if let Some(p) = cmd.bios {
if cfg.executable_path.is_some() {
return Err(format!(
"A VM executable was already specified: {:?}",
cfg.executable_path
));
}
cfg.executable_path = Some(Executable::Bios(p));
}
cfg.pflash_parameters = cmd.pflash;
#[cfg(feature = "video-decoder")]
{
cfg.video_dec = cmd.video_decoder;
}
#[cfg(feature = "video-encoder")]
{
cfg.video_enc = cmd.video_encoder;
}
cfg.acpi_tables = cmd.acpi_table;
cfg.usb = !cmd.no_usb.unwrap_or_default();
cfg.rng = !cmd.no_rng.unwrap_or_default();
#[cfg(feature = "balloon")]
{
cfg.balloon = !cmd.no_balloon.unwrap_or_default();
// cfg.balloon_bias is in bytes.
if let Some(b) = cmd.balloon_bias_mib {
cfg.balloon_bias = b * 1024 * 1024;
}
cfg.balloon_control = cmd.balloon_control;
cfg.balloon_page_reporting = cmd.balloon_page_reporting.unwrap_or_default();
cfg.balloon_ws_num_bins = cmd.balloon_ws_num_bins.unwrap_or(4);
cfg.balloon_ws_reporting = cmd.balloon_ws_reporting.unwrap_or_default();
cfg.init_memory = cmd.init_mem;
}
#[cfg(feature = "audio")]
{
cfg.virtio_snds = cmd.virtio_snd;
}
#[cfg(feature = "gpu")]
{
// Due to the resource bridge, we can only create a single GPU device at the moment.
if cmd.gpu.len() > 1 {
return Err("at most one GPU device can currently be created".to_string());
}
cfg.gpu_parameters = cmd.gpu.into_iter().map(|p| p.0).take(1).next();
if !cmd.gpu_display.is_empty() {
log::warn!("'--gpu-display' is deprecated; please use `--gpu displays=[...]`");
cfg.gpu_parameters
.get_or_insert_with(Default::default)
.display_params
.extend(cmd.gpu_display.into_iter().map(|p| p.0));
}
#[cfg(feature = "android_display")]
{
if let Some(gpu_parameters) = &cfg.gpu_parameters {
if !gpu_parameters.display_params.is_empty() {
cfg.android_display_service = cmd.android_display_service;
}
}
}
#[cfg(windows)]
if let Some(gpu_parameters) = &cfg.gpu_parameters {
let num_displays = gpu_parameters.display_params.len();
if num_displays > 1 {
return Err(format!(
"Only one display is supported (supplied {})",
num_displays
));
}
}
#[cfg(any(target_os = "android", target_os = "linux"))]
{
cfg.gpu_cgroup_path = cmd.gpu_cgroup_path;
cfg.gpu_server_cgroup_path = cmd.gpu_server_cgroup_path;
}
}
#[cfg(all(unix, feature = "net"))]
{
use devices::virtio::VhostNetParameters;
use devices::virtio::VHOST_NET_DEFAULT_PATH;
cfg.net = cmd.net;
if let Some(vhost_net_device) = &cmd.vhost_net_device {
let vhost_net_path = vhost_net_device.to_string_lossy();
log::warn!(
"`--vhost-net-device` is deprecated; please use \
`--net ...,vhost-net=[device={vhost_net_path}]`"
);
}
let vhost_net_config = if cmd.vhost_net.unwrap_or_default() {
Some(VhostNetParameters {
device: cmd
.vhost_net_device
.unwrap_or_else(|| PathBuf::from(VHOST_NET_DEFAULT_PATH)),
})
} else {
None
};
let vhost_net_msg = match cmd.vhost_net.unwrap_or_default() {
true => ",vhost-net=true",
false => "",
};
let vq_pairs_msg = match cmd.net_vq_pairs {
Some(n) => format!(",vq-pairs={}", n),
None => "".to_string(),
};
for tap_name in cmd.tap_name {
log::warn!(
"`--tap-name` is deprecated; please use \
`--net tap-name={tap_name}{vhost_net_msg}{vq_pairs_msg}`"
);
cfg.net.push(NetParameters {
mode: NetParametersMode::TapName {
tap_name,
mac: None,
},
vhost_net: vhost_net_config.clone(),
vq_pairs: cmd.net_vq_pairs,
packed_queue: false,
pci_address: None,
});
}
for tap_fd in cmd.tap_fd {
log::warn!(
"`--tap-fd` is deprecated; please use \
`--net tap-fd={tap_fd}{vhost_net_msg}{vq_pairs_msg}`"
);
cfg.net.push(NetParameters {
mode: NetParametersMode::TapFd { tap_fd, mac: None },
vhost_net: vhost_net_config.clone(),
vq_pairs: cmd.net_vq_pairs,
packed_queue: false,
pci_address: None,
});
}
if cmd.host_ip.is_some() || cmd.netmask.is_some() || cmd.mac_address.is_some() {
let host_ip = match cmd.host_ip {
Some(host_ip) => host_ip,
None => return Err("`host-ip` missing from network config".to_string()),
};
let netmask = match cmd.netmask {
Some(netmask) => netmask,
None => return Err("`netmask` missing from network config".to_string()),
};
let mac = match cmd.mac_address {
Some(mac) => mac,
None => return Err("`mac` missing from network config".to_string()),
};
if !cmd.vhost_user_net.is_empty() {
return Err(
"vhost-user-net cannot be used with any of --host-ip, --netmask or --mac"
.to_string(),
);
}
log::warn!(
"`--host-ip`, `--netmask`, and `--mac` are deprecated; please use \
`--net host-ip={host_ip},netmask={netmask},mac={mac}{vhost_net_msg}{vq_pairs_msg}`"
);
cfg.net.push(NetParameters {
mode: NetParametersMode::RawConfig {
host_ip,
netmask,
mac,
},
vhost_net: vhost_net_config,
vq_pairs: cmd.net_vq_pairs,
packed_queue: false,
pci_address: None,
});
}
// The number of vq pairs on a network device shall never exceed the number of vcpu
// cores. Fix that up if needed.
for net in &mut cfg.net {
if let Some(vq_pairs) = net.vq_pairs {
if vq_pairs as usize > cfg.vcpu_count.unwrap_or(1) {
log::warn!("the number of net vq pairs must not exceed the vcpu count, falling back to single queue mode");
net.vq_pairs = None;
}
}
}
}
#[cfg(any(target_os = "android", target_os = "linux"))]
{
cfg.shared_dirs = cmd.shared_dir;
cfg.coiommu_param = cmd.coiommu;
#[cfg(all(feature = "gpu", feature = "virgl_renderer"))]
{
cfg.gpu_render_server_parameters = cmd.gpu_render_server;
}
if let Some(d) = cmd.seccomp_policy_dir {
cfg.jail_config
.get_or_insert_with(Default::default)
.seccomp_policy_dir = Some(d);
}
if cmd.seccomp_log_failures.unwrap_or_default() {
cfg.jail_config
.get_or_insert_with(Default::default)
.seccomp_log_failures = true;
}
if let Some(p) = cmd.pivot_root {
cfg.jail_config
.get_or_insert_with(Default::default)
.pivot_root = p;
}
}
let protection_flags = [
cmd.protected_vm.unwrap_or_default(),
cmd.protected_vm_with_firmware.is_some(),
cmd.protected_vm_without_firmware.unwrap_or_default(),
cmd.unprotected_vm_with_firmware.is_some(),
];
if protection_flags.into_iter().filter(|b| *b).count() > 1 {
return Err("Only one protection mode has to be specified".to_string());
}
cfg.protection_type = if cmd.protected_vm.unwrap_or_default() {
ProtectionType::Protected
} else if cmd.protected_vm_without_firmware.unwrap_or_default() {
ProtectionType::ProtectedWithoutFirmware
} else if let Some(p) = cmd.protected_vm_with_firmware {
if !p.exists() || !p.is_file() {
return Err(
"protected-vm-with-firmware path should be an existing file".to_string()
);
}
cfg.pvm_fw = Some(p);
ProtectionType::ProtectedWithCustomFirmware
} else if let Some(p) = cmd.unprotected_vm_with_firmware {
if !p.exists() || !p.is_file() {
return Err(
"unprotected-vm-with-firmware path should be an existing file".to_string(),
);
}
cfg.pvm_fw = Some(p);
ProtectionType::UnprotectedWithFirmware
} else {
ProtectionType::Unprotected
};
if !matches!(cfg.protection_type, ProtectionType::Unprotected) {
// USB devices only work for unprotected VMs.
cfg.usb = false;
// Protected VMs can't trust the RNG device, so don't provide it.
cfg.rng = false;
}
cfg.battery_config = cmd.battery;
#[cfg(all(target_arch = "x86_64", unix))]
{
cfg.ac_adapter = cmd.ac_adapter.unwrap_or_default();
}
#[cfg(feature = "gdb")]
{
cfg.gdb = cmd.gdb;
}
cfg.host_cpu_topology = cmd.host_cpu_topology.unwrap_or_default();
#[cfg(target_arch = "x86_64")]
{
cfg.break_linux_pci_config_io = cmd.break_linux_pci_config_io.unwrap_or_default();
cfg.enable_hwp = cmd.enable_hwp.unwrap_or_default();
cfg.force_s2idle = cmd.s2idle.unwrap_or_default();
cfg.pcie_ecam = cmd.pcie_ecam;
cfg.pci_low_start = cmd.pci_start;
cfg.no_i8042 = cmd.no_i8042.unwrap_or_default();
cfg.no_rtc = cmd.no_rtc.unwrap_or_default();
cfg.smbios = cmd.smbios.unwrap_or_default();
if !cmd.oem_strings.is_empty() {
log::warn!(
"`--oem-strings` is deprecated; use `--smbios oem-strings=[...]` instead."
);
cfg.smbios.oem_strings.extend_from_slice(&cmd.oem_strings);
}
}
#[cfg(feature = "pci-hotplug")]
{
cfg.pci_hotplug_slots = cmd.pci_hotplug_slots;
}
cfg.vhost_user = cmd.vhost_user;
cfg.vhost_user_connect_timeout_ms = cmd.vhost_user_connect_timeout_ms;
// Convert an option from `VhostUserOption` to `VhostUserFrontendOption` with the given
// device type.
fn vu(
opt: impl IntoIterator<Item = VhostUserOption>,
type_: DeviceType,
) -> impl Iterator<Item = VhostUserFrontendOption> {
opt.into_iter().map(move |o| {
log::warn!(
"`--vhost-user-*` is deprecated; use `--vhost-user {},socket={}` instead",
type_,
o.socket.display(),
);
VhostUserFrontendOption {
type_,
socket: o.socket,
max_queue_size: o.max_queue_size,
pci_address: None,
}
})
}
cfg.vhost_user.extend(
vu(cmd.vhost_user_blk, DeviceType::Block)
.chain(vu(cmd.vhost_user_console, DeviceType::Console))
.chain(vu(cmd.vhost_user_gpu, DeviceType::Gpu))
.chain(vu(cmd.vhost_user_mac80211_hwsim, DeviceType::Mac80211HwSim))
.chain(vu(cmd.vhost_user_net, DeviceType::Net))
.chain(vu(cmd.vhost_user_snd, DeviceType::Sound))
.chain(vu(cmd.vhost_user_video_decoder, DeviceType::VideoDecoder))
.chain(vu(cmd.vhost_user_vsock, DeviceType::Vsock))
.chain(vu(cmd.vhost_user_wl, DeviceType::Wl)),
);
cfg.vhost_user_fs = cmd.vhost_user_fs;
cfg.disable_virtio_intx = cmd.disable_virtio_intx.unwrap_or_default();
cfg.dump_device_tree_blob = cmd.dump_device_tree_blob;
cfg.itmt = cmd.itmt.unwrap_or_default();
#[cfg(target_arch = "x86_64")]
{
cfg.force_calibrated_tsc_leaf = cmd.force_calibrated_tsc_leaf.unwrap_or_default();
}
cfg.stub_pci_devices = cmd.stub_pci_device;
cfg.fdt_position = cmd.fdt_position;
cfg.file_backed_mappings = cmd.file_backed_mapping;
#[cfg(target_os = "android")]
{
cfg.task_profiles = cmd.task_profiles;
}
#[cfg(any(target_os = "android", target_os = "linux"))]
{
if cmd.unmap_guest_memory_on_fork.unwrap_or_default()
&& !cmd.disable_sandbox.unwrap_or_default()
{
return Err("--unmap-guest-memory-on-fork requires --disable-sandbox".to_string());
}
cfg.unmap_guest_memory_on_fork = cmd.unmap_guest_memory_on_fork.unwrap_or_default();
}
#[cfg(any(target_os = "android", target_os = "linux"))]
{
cfg.vfio.extend(cmd.vfio);
cfg.vfio.extend(cmd.vfio_platform);
cfg.vfio_isolate_hotplug = cmd.vfio_isolate_hotplug.unwrap_or_default();
}
cfg.device_tree_overlay = cmd.device_tree_overlay;
#[cfg(any(target_os = "android", target_os = "linux"))]
{
if cfg.device_tree_overlay.iter().any(|o| o.filter_devs)
&& cfg.vfio.iter().all(|o| o.dt_symbol.is_none())
{
return Err("expected at least one VFIO device with a defined dt_symbol".into());
}
}
// `--disable-sandbox` has the effect of disabling sandboxing altogether, so make sure
// to handle it after other sandboxing options since they implicitly enable it.
if cmd.disable_sandbox.unwrap_or_default() {
cfg.jail_config = None;
}
cfg.name = cmd.name;
// Now do validation of constructed config
super::config::validate_config(&mut cfg)?;
Ok(cfg)
}
}
// Produce a block device path as used by Linux block devices.
//
// Examples for "/dev/vdX":
// /dev/vda, /dev/vdb, ..., /dev/vdz, /dev/vdaa, /dev/vdab, ...
fn format_disk_letter(dev_prefix: &str, mut i: usize) -> String {
const ALPHABET_LEN: usize = 26; // a to z
let mut s = dev_prefix.to_string();
let insert_idx = dev_prefix.len();
loop {
s.insert(insert_idx, char::from(b'a' + (i % ALPHABET_LEN) as u8));
i /= ALPHABET_LEN;
if i == 0 {
break;
}
i -= 1;
}
s
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
#[cfg(feature = "config-file")]
fn merge_runcommands() {
let cmd2 = RunCommand {
mem: Some(MemOptions { size: Some(4096) }),
kernel: Some("/path/to/kernel".into()),
params: vec!["firstparam".into()],
..Default::default()
};
let cmd3 = RunCommand {
mem: Some(MemOptions { size: Some(8192) }),
params: vec!["secondparam".into()],
..Default::default()
};
let cmd1 = RunCommand {
mem: Some(MemOptions { size: Some(2048) }),
params: vec!["thirdparam".into(), "fourthparam".into()],
cfg: vec![cmd2, cmd3],
..Default::default()
};
let merged_cmd = cmd1.squash();
assert_eq!(merged_cmd.mem, Some(MemOptions { size: Some(2048) }));
assert_eq!(merged_cmd.kernel, Some("/path/to/kernel".into()));
assert_eq!(
merged_cmd.params,
vec![
String::from("firstparam"),
String::from("secondparam"),
String::from("thirdparam"),
String::from("fourthparam"),
]
);
}
#[test]
fn disk_letter() {
assert_eq!(format_disk_letter("/dev/sd", 0), "/dev/sda");
assert_eq!(format_disk_letter("/dev/sd", 1), "/dev/sdb");
assert_eq!(format_disk_letter("/dev/sd", 25), "/dev/sdz");
assert_eq!(format_disk_letter("/dev/sd", 26), "/dev/sdaa");
assert_eq!(format_disk_letter("/dev/sd", 27), "/dev/sdab");
assert_eq!(format_disk_letter("/dev/sd", 51), "/dev/sdaz");
assert_eq!(format_disk_letter("/dev/sd", 52), "/dev/sdba");
assert_eq!(format_disk_letter("/dev/sd", 53), "/dev/sdbb");
assert_eq!(format_disk_letter("/dev/sd", 78), "/dev/sdca");
assert_eq!(format_disk_letter("/dev/sd", 701), "/dev/sdzz");
assert_eq!(format_disk_letter("/dev/sd", 702), "/dev/sdaaa");
assert_eq!(format_disk_letter("/dev/sd", 703), "/dev/sdaab");
}
}