1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622
//! # The MemProcFS API Documentation
//!
//! The MemProcFS crate contains a wrapper API around the [MemProcFS physical
//! memory analysis framework](https://github.com/ufrisk/MemProcFS). The native
//! libray in the form of `vmm.dll` or `vmm.so` must be downloaded or compiled
//! in order to make use of the memprocfs crate.
//!
//! Physical memory analysis may take place on memory dump files for forensic
//! purposes. Analysis may also take place on live memory - either captured by
//! using [PCILeech PCIe DMA devices](https://github.com/ufrisk/pcileech-fpga)
//! or by using a driver - such as WinPMEM, LiveCloudKd, VMware or similar.
//!
//! The base of the MemProcFS API is the [`Vmm`] struct. Once the native vmm
//! has been initialized it's possible to retrieve processes in the form of
//! the [`VmmProcess`] struct. Using the `Vmm` and `VmmProcess` it's possible
//! to undertake a wide range of actions - such as reading/writing memory or
//! retrieve various information.
//!
//! The use of the low-level [`LeechCore`] library is also possible. [LeechCore](https://github.com/ufrisk/LeechCore/wiki)
//! is used for low-level tasks such as setting a [memory map](https://github.com/ufrisk/LeechCore/wiki/Device_FPGA_AMD_Thunderbolt),
//! implementing raw PCIe Transaction Layer Packet (TLP), PCIe Base Address
//! Register (BAR) support and more.
//!
//!
//! <b>Read and write memory</b> by using the methods
//! [`mem_read()`](VmmProcess::mem_read()),
//! [`mem_read_ex()`](VmmProcess::mem_read_ex()) and
//! [`mem_write()`](VmmProcess::mem_write()).
//! Virtual memory is read from [`VmmProcess`] struct.
//! Physical memory is read from the [`Vmm`] struct.
//!
//! <b>Efficiently read and write memory</b> using the [`VmmScatterMemory`]
//! struct. The scatter struct is retrieved by calling
//! [`mem_scatter()`](VmmProcess::mem_scatter()) on either the base [`Vmm`]
//! struct or the individual [`VmmProcess`] structs.
//!
//! <b>Access information</b> about loaded modules, memory regions, registry,
//! process handles, kernel pool allocations and much more!
//!
//! <b>Access the Virtual File System</b> (VFS) using the Rust API to get access
//! to the full range of built-in and external plugins. The VFS is accessed by
//! using the methods
//! [`vfs_list()`](Vmm::vfs_list()), [`vfs_read()`](Vmm::vfs_read()) and
//! [`vfs_write()`](Vmm::vfs_write()) on the [`Vmm`] struct.
//!
//! The MemProcFS crate and API also supports creation of native MemProcFS
//! plugins in the form of a library `.dll` or `.so`.
//!
//!
//! ## Example projects
//! Check out the
//! [Example Project](https://github.com/ufrisk/MemProcFS/blob/master/vmmrust/memprocfs_example/src/main.rs)
//! and the
//! [Example Plugin](https://github.com/ufrisk/MemProcFS/blob/master/vmmrust/m_example_plugin/src/lib.rs).
//!
//!
//! ## Project documentation
//! Check out the project documentation for MemProcFS, LeechCore and pcileech-fpga:
//! * [MemProcFS](https://github.com/ufrisk/MemProcFS) - [Documentation](https://github.com/ufrisk/MemProcFS/wiki).
//! * [LeechCore](https://github.com/ufrisk/LeechCore/) - [Documentation](https://github.com/ufrisk/LeechCore/wiki).
//! * [PCILeech](https://github.com/ufrisk/pcileech) - [Documentation](https://github.com/ufrisk/pcileech/wiki).
//! * [PCILeech-FPGA](https://github.com/ufrisk/pcileech-fpga).
//!
//!
//! ## Support PCILeech/MemProcFS development:
//! PCILeech and MemProcFS is free and open source!
//!
//! I put a lot of time and energy into PCILeech and MemProcFS and related
//! research to make this happen. Some aspects of the projects relate to
//! hardware and I put quite some money into my projects and related research.
//! If you think PCILeech and/or MemProcFS are awesome tools and/or if you
//! had a use for them it's now possible to contribute by becoming a sponsor!
//!
//! If you like what I've created with PCIleech and MemProcFS with regards to
//! DMA, Memory Analysis and Memory Forensics and would like to give something
//! back to support future development please consider becoming a sponsor at:
//! <https://github.com/sponsors/ufrisk>
//!
//! To all my sponsors, Thank You 💖
//!
//!
//! ## Questions and Comments
//! Please feel free to contact me!
//! * Github: <https://github.com/ufrisk/MemProcFS>
//! * Discord Server: <https://discord.gg/pcileech>.
//! * Twitter: <https://twitter.com/UlfFrisk>
//! * Email: pcileech@frizk.net
//!
//!
//! ## Get Started!
//! Check out the [`Vmm`] documentation and the
//! [Example Project](https://github.com/ufrisk/MemProcFS/tree/master/vmmrust/memprocfs_example)!
//!
//! <b>Best wishes with your memory analysis project!</b>
//
// (c) Ulf Frisk, 2023-2024
// Author: Ulf Frisk, pcileech@frizk.net
// https://github.com/ufrisk/LeechCore
//
use std::collections::HashMap;
use std::ffi::{CStr, CString, c_char, c_int};
use std::fmt;
use anyhow::{anyhow, Context};
use serde::{Serialize, Deserialize};
/// Result type for MemProcFS API.
///
/// The MemProcFS result type is a wrapper around the anyhow::Result type.
/// It contains a function-defined return type and a String error type.
pub type ResultEx<T> = anyhow::Result<T>;
// MemProcFS memory read/write flags:
/// Do not use internal data cache.
pub const FLAG_NOCACHE : u64 = 0x0001;
/// Zero pad failed memory reads and report success.
pub const FLAG_ZEROPAD_ON_FAIL : u64 = 0x0002;
/// Force use of data cache - fail non-cached pages.
///
/// Flag is only valid for reads, invalid with VMM_FLAG_NOCACHE/VMM_FLAG_ZEROPAD_ON_FAIL.
pub const FLAG_FORCECACHE_READ : u64 = 0x0008;
/// Do not retrieve memory from paged out memory.
///
/// Paged out memory may be from pagefile/compressed (even if possible).
/// If slow I/O accesses are the concern the flag `FLAG_NOPAGING_IO` may be a better choice.
pub const FLAG_NOPAGING : u64 = 0x0010;
/// Do not retrieve memory from paged out memory***.
///
/// ***) If the read would incur additional I/O (even if possible).
pub const FLAG_NOPAGING_IO : u64 = 0x0020;
/// Do not populate the data cache on a successful read.
pub const FLAG_NOCACHEPUT : u64 = 0x0100;
/// Only fetch from the most recent active cache region when reading.
pub const FLAG_CACHE_RECENT_ONLY : u64 = 0x0200;
/// Do not perform additional predictive page reads.
///
/// This is default on smaller requests.
pub const FLAG_NO_PREDICTIVE_READ : u64 = 0x0400;
/// Disable/override any use of VMM_FLAG_FORCECACHE_READ.
///
/// This flag is only recommended for local files. improves forensic artifact order.
pub const FLAG_FORCECACHE_READ_DISABLE : u64 = 0x0800;
/// Disable clearing of memory supplied to VmmScatterMemory.prepare_ex
pub const VMMDLL_FLAG_SCATTER_PREPAREEX_NOMEMZERO : u64 = 0x1000;
/// Get/Set library console printouts.
pub const CONFIG_OPT_CORE_PRINTF_ENABLE : u64 = 0x4000000100000000;
/// Get/Set standard verbosity.
pub const CONFIG_OPT_CORE_VERBOSE : u64 = 0x4000000200000000;
/// Get/Set extra verbosity.
pub const CONFIG_OPT_CORE_VERBOSE_EXTRA : u64 = 0x4000000300000000;
/// Get/Set super extra verbosity and PCIe TLP debug.
pub const CONFIG_OPT_CORE_VERBOSE_EXTRA_TLP : u64 = 0x4000000400000000;
/// Get max native physical memory address.
pub const CONFIG_OPT_CORE_MAX_NATIVE_ADDRESS : u64 = 0x4000000800000000;
/// Get the LeechCore native handle. (void*) (do not close/free).
pub const CONFIG_OPT_CORE_LEECHCORE_HANDLE : u64 = 0x4000001000000000;
/// Get the vmmid that may be used with startup option '-create-from-vmmid' to create a thread-safe duplicate VMM instance.
pub const CONFIG_OPT_CORE_VMM_ID : u64 = 0x4000002000000000;
/// Get the numeric system type according to VMM C-API.
pub const CONFIG_OPT_CORE_SYSTEM : u64 = 0x2000000100000000;
/// Get the numeric memory model type according to the VMM C-API.
pub const CONFIG_OPT_CORE_MEMORYMODEL : u64 = 0x2000000200000000;
/// Get whether the refresh is enabled or not (1/0).
pub const CONFIG_OPT_CONFIG_IS_REFRESH_ENABLED : u64 = 0x2000000300000000;
/// Get/Set base tick period in ms.
pub const CONFIG_OPT_CONFIG_TICK_PERIOD : u64 = 0x2000000400000000;
/// Get/Set memory cache validity period (in ticks).
pub const CONFIG_OPT_CONFIG_READCACHE_TICKS : u64 = 0x2000000500000000;
/// Get/Set page table (tlb) cache validity period (in ticks).
pub const CONFIG_OPT_CONFIG_TLBCACHE_TICKS : u64 = 0x2000000600000000;
/// Get/Set process refresh (partial) period (in ticks).
pub const CONFIG_OPT_CONFIG_PROCCACHE_TICKS_PARTIAL : u64 = 0x2000000700000000;
/// Get/Set process refresh (full) period (in ticks).
pub const CONFIG_OPT_CONFIG_PROCCACHE_TICKS_TOTAL : u64 = 0x2000000800000000;
/// Get MemProcFS major version.
pub const CONFIG_OPT_CONFIG_VMM_VERSION_MAJOR : u64 = 0x2000000900000000;
/// Get MemProcFS minor version.
pub const CONFIG_OPT_CONFIG_VMM_VERSION_MINOR : u64 = 0x2000000A00000000;
/// Get MemProcFS revision version.
pub const CONFIG_OPT_CONFIG_VMM_VERSION_REVISION : u64 = 0x2000000B00000000;
/// Get/Set enable function call statistics (.status/statistics_fncall file).
pub const CONFIG_OPT_CONFIG_STATISTICS_FUNCTIONCALL : u64 = 0x2000000C00000000;
/// Get/Set enable paging support 1/0.
pub const CONFIG_OPT_CONFIG_IS_PAGING_ENABLED : u64 = 0x2000000D00000000;
/// Set native library internal custom debug.
pub const CONFIG_OPT_CONFIG_DEBUG : u64 = 0x2000000E00000000;
/// Get OS version major.
pub const CONFIG_OPT_WIN_VERSION_MAJOR : u64 = 0x2000010100000000;
/// Get OS version minor.
pub const CONFIG_OPT_WIN_VERSION_MINOR : u64 = 0x2000010200000000;
/// Get OS version build.
pub const CONFIG_OPT_WIN_VERSION_BUILD : u64 = 0x2000010300000000;
/// Get MemProcFS unique system id.
pub const CONFIG_OPT_WIN_SYSTEM_UNIQUE_ID : u64 = 0x2000010400000000;
/// Get/Set enable/retrieve forensic mode type [0-4].
pub const CONFIG_OPT_FORENSIC_MODE : u64 = 0x2000020100000000;
// REFRESH OPTIONS:
/// Set - trigger refresh all caches.
pub const CONFIG_OPT_REFRESH_ALL : u64 = 0x2001ffff00000000;
/// Set - refresh memory cache (excl. TLB) (fully).
pub const CONFIG_OPT_REFRESH_FREQ_MEM : u64 = 0x2001100000000000;
/// Set - refresh memory cache (excl. TLB) [partial 33%/call].
pub const CONFIG_OPT_REFRESH_FREQ_MEM_PARTIAL : u64 = 0x2001000200000000;
/// Set - refresh page table (TLB) cache (fully)
pub const CONFIG_OPT_REFRESH_FREQ_TLB : u64 = 0x2001080000000000;
/// Set - refresh page table (TLB) cache [partial 33%/call].
pub const CONFIG_OPT_REFRESH_FREQ_TLB_PARTIAL : u64 = 0x2001000400000000;
/// Set - refresh fast frequency - incl. partial process refresh.
pub const CONFIG_OPT_REFRESH_FREQ_FAST : u64 = 0x2001040000000000;
/// Set - refresh medium frequency - incl. full process refresh.
pub const CONFIG_OPT_REFRESH_FREQ_MEDIUM : u64 = 0x2001000100000000;
/// Set - refresh slow frequency.
pub const CONFIG_OPT_REFRESH_FREQ_SLOW : u64 = 0x2001001000000000;
/// Set custom process directory table base. [LO-DWORD: Process PID].
pub const CONFIG_OPT_PROCESS_DTB : u64 = 0x2002000100000000;
// PLUGIN NOTIFICATIONS:
/// Verbosity change. Query new verbosity with: `vmm.get_config()`.
pub const PLUGIN_NOTIFY_VERBOSITYCHANGE : u32 = 0x01;
/// Fast refresh. Partial process refresh.
pub const PLUGIN_NOTIFY_REFRESH_FAST : u32 = 0x05;
/// Medium refresh. Full process refresh and other refresh tasks.
pub const PLUGIN_NOTIFY_REFRESH_MEDIUM : u32 = 0x02;
/// Slow refresh. Total refresh of as much as possible.
pub const PLUGIN_NOTIFY_REFRESH_SLOW : u32 = 0x04;
/// Forensic mode initialization start.
pub const PLUGIN_NOTIFY_FORENSIC_INIT : u32 = 0x01000100;
/// Forensic mode processing is completed.
pub const PLUGIN_NOTIFY_FORENSIC_INIT_COMPLETE : u32 = 0x01000200;
/// A child VM was attached or detached. Query new state with API.
pub const PLUGIN_NOTIFY_VM_ATTACH_DETACH : u32 = 0x01000400;
/// <b>MemProcFS API Base Struct.</b>
///
/// The [`Vmm`] struct is the base of the MemProcFS API. All API accesses
/// takes place from the [`Vmm`] struct and its sub-structs.
///
/// The [`Vmm`] struct acts as a wrapper around the native MemProcFS VMM API.
///
/// <b>Check out the example project for more detailed API usage and
/// additional examples!</b>
///
///
/// # Created By
/// - [`Vmm::new()`]
/// - [`Vmm::new_from_virtual_machine()`]
/// - `plugin sub-system`
///
/// The [`Vmm`] is normally created by [`Vmm::new()`] (see example below).
///
/// The [`Vmm`] object represents memory analysis of a target system. If the
/// target system contains virtual machines additional child `Vmm` objects
/// representing the individual VMs may be retrieved by calling the
/// function [`Vmm::new_from_virtual_machine()`].
///
/// The [`Vmm`] object is also supplied by the plugin API to any plugins created.
///
///
/// # Examples
///
/// ```
/// // Initialize MemProcFS VMM on a Windows system parsing a
/// // memory dump and virtual machines inside it.
/// let args = ["-printf", "-v", "-waitinitialize", "-device", "C:\\Dumps\\mem.dmp"].to_vec();
/// if let Ok(vmm) = Vmm::new("C:\\MemProcFS\\vmm.dll", &args) {
/// ...
/// // The underlying native vmm is automatically closed
/// // when the vmm object goes out of scope.
/// };
/// ```
///
/// ```
/// // Initialize MemProcFS VMM on a Linux system parsing live memory
/// // retrieved from a PCILeech FPGA hardware device.
/// let args = ["-device", "fpga"].to_vec();
/// if let Ok(vmm) = Vmm::new("/home/user/memprocfs/vmm.so", &args) {
/// ...
/// // The underlying native vmm is automatically closed
/// // when the vmm object goes out of scope.
/// };
/// ```
#[allow(dead_code)]
#[derive(Debug)]
pub struct Vmm<'a> {
path_lc : String,
path_vmm : String,
native : VmmNative,
parent_vmm : Option<&'a Vmm<'a>>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum VmmLogLevel {
_1Critical,
_2Warning,
_3Info,
_4Verbose,
_5Debug,
_6Trace,
_7None,
}
/// Info: Network connections.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmMapNetEntry {
pub pid : u32,
pub state : u32,
pub address_family : u16,
pub src_is_valid : bool,
pub src_port : u16,
pub src_addr_raw : [u8; 16],
pub src_str : String,
pub dst_is_valid : bool,
pub dst_port : u16,
pub dst_addr_raw : [u8; 16],
pub dst_str : String,
pub va_object : u64,
pub filetime : u64,
pub pool_tag : u32,
pub desc : String,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum VmmMapPfnType {
Zero,
Free,
Standby,
Modified,
ModifiedNoWrite,
Bad,
Active,
Transition,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum VmmMapPfnTypeExtended {
Unknown,
Unused,
ProcessPrivate,
PageTable,
LargePage,
DriverLocked,
Shareable,
File,
}
/// Info: Memory PFN (Page Frame Number).
///
/// # Created By
/// - [`vmm.map_pfn()`](Vmm::map_pfn())
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmMapPfnEntry {
pub pfn : u32,
pub location : VmmMapPfnType,
pub is_prototype : bool,
pub color : u32,
// extended attributes below - only valid if is_extended == true
pub is_extended : bool,
pub tp_ex : VmmMapPfnTypeExtended,
pub pid : u32,
pub ptes : [u32; 5], // 1 = pfn:PTE, .. 4 = pfn:PML4E
pub va : u64,
pub va_pte : u64,
pub pte_original : u64,
}
/// Info: Kernel pool entries.
///
/// # Created By
/// - [`vmm.map_pool()`](Vmm::map_pool())
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmMapPoolEntry {
pub va : u64,
pub cb : u32,
pub tag : u32,
pub is_alloc : bool,
pub tp_pool : u8, // VMMDLL_MAP_POOL_TYPE
pub tp_subsegment : u8, // VMMDLL_MAP_POOL_TYPE_SUBSEGMENT
}
/// Info: Physical memory map entries.
///
/// # Created By
/// - [`vmm.map_memory()`](Vmm::map_memory())
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmMapMemoryEntry {
pub pa : u64,
pub cb : u64
}
/// Info: Services.
///
/// # Created By
/// - [`vmm.map_service()`](Vmm::map_service())
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmMapServiceEntry {
pub ordinal : u32,
pub va_object : u64,
pub pid : u32,
pub start_type : u32,
pub service_type : u32,
pub current_state : u32,
pub controls_accepted : u32,
pub win32_exit_code : u32,
pub service_specific_exit_code : u32,
pub check_point : u32,
pub wait_hint : u32,
pub name : String,
pub name_display : String,
pub path : String,
pub user_type : String,
pub user_account : String,
pub image_path : String,
}
/// Info: Users.
///
/// # Created By
/// - [`vmm.map_user()`](Vmm::map_user())
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmMapUserEntry {
pub user : String,
pub sid : String,
pub va_reg_hive : u64,
}
/// Info: Virtual Machines (VMs).
///
/// # Created By
/// - [`vmm.map_virtual_machine()`](Vmm::map_virtual_machine())
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmMapVirtualMachineEntry {
h_vmm : usize,
h_vm : usize,
pub name : String,
pub gpa_max : u64,
pub tp_vm : u32,
pub is_active : bool,
pub is_readonly : bool,
pub is_physicalonly : bool,
pub partition_id : u32,
pub guest_os_version_build : u32,
pub guest_tp_system : u32,
pub parent_mount_id : u32,
pub vmmem_pid : u32,
}
/// VFS (Virtual File System) entry information - file or directory.
///
/// # Created By
/// - [`vmm.vfs_list()`](Vmm::vfs_list())
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmVfsEntry {
/// Name of the file or directory.
pub name : String,
/// True if entry is a directory, False if entry is a file.
pub is_directory : bool,
/// File size if file.
pub size : u64,
}
impl Vmm<'_> {
/// <b>MemProcFS Initialization Function.</b>
///
/// The [`Vmm`] struct is the base of the MemProcFS API. All API accesses
/// takes place from the [`Vmm`] struct and its sub-structs.
///
/// The [`Vmm`] struct acts as a wrapper around the native MemProcFS VMM API.
///
///
/// # Arguments
/// * `vmm_lib_path` - Full path to the native vmm library - i.e. `vmm.dll` or `vmm.so`.
/// * `args` - MemProcFS command line arguments as a Vec<&str>.
///
/// MemProcFS command line argument documentation is found on the [MemProcFS wiki](https://github.com/ufrisk/MemProcFS/wiki/_CommandLine).
///
///
/// # Examples
///
/// ```
/// // Initialize MemProcFS VMM on a Windows system parsing a
/// // memory dump and virtual machines inside it.
/// let args = ["-printf", "-v", "-waitinitialize", "-device", "C:\\Dumps\\mem.dmp"].to_vec();
/// if let Ok(vmm) = Vmm::new("C:\\MemProcFS\\vmm.dll", &args) {
/// ...
/// // The underlying native vmm is automatically closed
/// // when the vmm object goes out of scope.
/// };
/// ```
///
/// ```
/// // Initialize MemProcFS VMM on a Linux system parsing live memory
/// // retrieved from a PCILeech FPGA hardware device.
/// let args = ["-device", "fpga"].to_vec();
/// if let Ok(vmm) = Vmm::new("/home/user/memprocfs/vmm.so", &args) {
/// ...
/// // The underlying native vmm is automatically closed
/// // when the vmm object goes out of scope.
/// };
/// ```
pub fn new<'a>(vmm_lib_path : &str, args: &Vec<&str>) -> ResultEx<Vmm<'a>> {
return crate::impl_new(vmm_lib_path, 0, args);
}
/// Initialize MemProcFS from a host VMM and a child VM.
///
/// Initialize a MemProcFS VMM object representing a child virtual machine (VM).
///
/// # Arguments
/// * `vmm_parent` - The host (parent) [`Vmm`].
/// * `vm_entry` - The [`VmmMapVirtualMachineEntry`] to initialize as a [`Vmm`].
///
/// # Examples
/// ```
/// if let Ok(virtualmachine_all) = vmm.map_virtual_machine() {
/// for virtualmachine in &*virtualmachine_all {
/// println!("{virtualmachine}");
/// if virtualmachine.is_active {
/// // for active vms it's possible to create a new vmm object for
/// // the vm. it's possible to treat this as any other vmm object
/// // to read memory, query processes etc.
/// let vmm_vm = match Vmm::new_from_virtual_machine(&vmm, &virtualmachine) {
/// Err(_) => continue,
/// Ok(r) => r,
/// };
/// let max_addr = vmm_vm.get_config(CONFIG_OPT_CORE_MAX_NATIVE_ADDRESS).unwrap_or(0);
/// println!("vm max native address: {:#x}", max_addr);
/// }
/// }
/// }
/// ```
pub fn new_from_virtual_machine<'a>(vmm_parent : &'a Vmm, vm_entry : &VmmMapVirtualMachineEntry) -> ResultEx<Vmm<'a>> {
return impl_new_from_virtual_machine(vmm_parent, vm_entry);
}
/// Retrieve the underlying LeechCore native handle.
///
/// # Examples
/// ```
/// let lc = vmm.get_leechcore()?;
/// ```
pub fn get_leechcore(&self) -> ResultEx<LeechCore> {
return self.impl_get_leechcore();
}
/// Retrieve a single process by PID.
///
/// # Arguments
/// * `pid` - Process id (PID) of the process to retrieve.
///
/// # Examples
/// ```
/// if let Ok(process) = vmm.process_from_pid(4) {
/// println!("{}", process);
/// }
/// ```
pub fn process_from_pid(&self, pid : u32) -> ResultEx<VmmProcess> {
return self.impl_process_from_pid(pid);
}
/// Retrieve a single process by name.
///
/// If multiple processes have the same name the first process located by
/// MemProcFS will be returned. If it is important to fetch the correct
/// process retrieve the process list from `vmm.list()` and iterate.
///
/// # Arguments
/// * `process_name` - Name of the process to retrieve.
///
/// # Examples
/// ```
/// if let Ok(process) = vmm.process_from_name("System") {
/// println!("{}", process);
/// }
/// ```
pub fn process_from_name(&self, process_name : &str) -> ResultEx<VmmProcess> {
return self.impl_process_from_name(process_name);
}
/// Retrieve all processes.
///
/// # Examples
/// ```
/// // Retrieve all processes (as a Vec).
/// process_all = vmm.process_list()?
/// for process in &*process_all {
/// println!("{process} ");
/// }
/// ```
pub fn process_list(&self) -> ResultEx<Vec<VmmProcess>> {
return self.impl_process_list();
}
/// Retrieve all processes as a map.
///
/// K: PID,
/// V: VmmProcess
///
/// # Examples
/// ```
/// // Retrieve all processes as (a HashMap).
/// process_all = vmm.process_map()?;
/// for process in process_all {
/// println!("<{},{}> ", process.0, process.1);
/// }
/// ```
pub fn process_map(&self) -> ResultEx<HashMap<u32, VmmProcess>> {
return Ok(self.impl_process_list()?.into_iter().map(|s| (s.pid, s)).collect());
}
/// Get a numeric configuration value.
///
/// # Arguments
/// * `config_id` - As specified by a `CONFIG_OPT_*` constant marked as `Get`. (Optionally or'ed | with process pid for select options).
///
/// # Examples
/// ```
/// println!("max addr: {:#x}", vmm.get_config(CONFIG_OPT_CORE_MAX_NATIVE_ADDRESS).unwrap_or(0));
/// ```
pub fn get_config(&self, config_id : u64) -> ResultEx<u64> {
return self.impl_get_config(config_id);
}
/// Set a numeric configuration value.
///
/// # Arguments
/// * `config_id` - As specified by a `CONFIG_OPT_*` constant marked as `Set`. (Optionally or'ed | with process pid for select options).
/// * `config_value` - The config value to set.
///
/// # Examples
/// ```
/// // The below force MemProcFS to undertake a full refresh - refresing
/// // processes, memory and other general data structures completely.
/// let _r = vmm.set_config(CONFIG_OPT_REFRESH_ALL, 1);
/// ```
pub fn set_config(&self, config_id : u64, config_value : u64) -> ResultEx<()> {
return self.impl_set_config(config_id, config_value);
}
/// Retrieve the kernel convenience struct.
///
/// The kernel struct provides easy access to kernel build number,
/// the system process (pid 4) and kernel (nt) debug symbols.
///
/// # Examples
/// ```
/// // Retrieve and print the kernel build number.
/// println!("{}", vmm.kernel().build());
/// ```
pub fn kernel(&self) -> VmmKernel {
return VmmKernel { vmm : &self };
}
/// Log a message to the MemProcFS logging system.
///
/// # Arguments
/// * `log_level`
/// * `log_message`
///
/// # Examples
/// ```
/// vmm.log(&VmmLogLevel::_1Critical, "Test Message Critical!");
/// ```
pub fn log(&self, log_level : &VmmLogLevel, log_message : &str) {
self.impl_log(VMMDLL_MID_RUST, log_level, log_message);
}
/// Retrieve the physical memory range info map.
///
/// # Examples
/// ```
/// if let Ok(memory_range_all) = vmm.map_memory() {
/// for memory_range in &*memory_range_all {
/// println!("{memory_range} \t pa={:x} cb={:x}", memory_range.pa, memory_range.cb);
/// }
/// }
/// ```
pub fn map_memory(&self) -> ResultEx<Vec<VmmMapMemoryEntry>> {
return self.impl_map_memory();
}
/// Retrieve the network connection info map.
///
/// # Examples
/// ```
/// let net_all vmm.map_net()?;
/// for net in &*net_all {
/// println!("{net}");
/// }
/// ```
pub fn map_net(&self) -> ResultEx<Vec<VmmMapNetEntry>> {
return self.impl_map_net();
}
/// Retrieve the page frame number (PFN) info map.
///
/// # Arguments
/// * `pfns` - The PFNs to retrieve.
/// * `is_extended` - Retrieve extended information (more resource intense).
///
/// # Examples
/// ```
/// let pfns: Vec<u32> = (1..=10).collect();
/// if let Ok(pfn_all) = vmm.map_pfn(&pfns, true) {
/// for pfn in &*pfn_all {
/// println!("{pfn} \t location={} tp_ex={} pid={:x} va={:x} color={}",
/// pfn.location, pfn.tp_ex, pfn.pid, pfn.va, pfn.color);
/// }
/// }
/// ```
pub fn map_pfn(&self, pfns : &Vec<u32>, is_extended : bool) -> ResultEx<Vec<VmmMapPfnEntry>> {
return self.impl_map_pfn(pfns, is_extended);
}
/// Retrieve the kernel pool allocation info map.
///
/// # Arguments
/// * `is_bigpool_only` - Retrieve only entries from the big pool (faster).
///
/// # Examples
/// ```
/// if let Ok(pool_all) = vmm.map_pool(false) {
/// println!("Number of pool allocations: {}.", pool_all.len());
/// let pool_proc_all : Vec<&VmmMapPoolEntry> =
/// pool_all.iter().filter(|e| e.tag == 0x636f7250 /* 'Proc' backwards */).collect();
/// println!("Number of pool 'Proc' allocations: {}.", pool_all.len());
/// for pool_proc in &*pool_proc_all {
/// print!("{pool_proc} ");
/// }
/// println!("");
/// }
/// ```
pub fn map_pool(&self, is_bigpool_only : bool) -> ResultEx<Vec<VmmMapPoolEntry>> {
return self.impl_map_pool(is_bigpool_only);
}
/// Retrieve the servives info map.
///
/// # Examples
/// ```
/// let service_all = vmm.map_service()?;
/// for service in &*service_all {
/// println!("{service} ");
/// }
/// ```
pub fn map_service(&self) -> ResultEx<Vec<VmmMapServiceEntry>> {
return self.impl_map_service();
}
/// Retrieve the user map.
///
/// # Examples
/// ```
/// let user_all = vmm.map_user()?;
/// for user in &*user_all {
/// println!("{:x}:: {} :: {} :: {user}", user.va_reg_hive, user.sid, user.user);
/// }
/// ```
pub fn map_user(&self) -> ResultEx<Vec<VmmMapUserEntry>> {
return self.impl_map_user();
}
/// Retrieve the virtual machines info map.
///
/// # Examples
/// ```
/// let virtualmachine_all = vmm.map_virtual_machine()?
/// for virtualmachine in &*virtualmachine_all {
/// println!("{virtualmachine}");
/// if virtualmachine.is_active {
/// // for active vms it's possible to create a new vmm object for
/// // the vm. it's possible to treat this as any other vmm object
/// // to read memory, query processes etc.
/// let vmm_vm = match Vmm::new_from_virtual_machine(&vmm, &virtualmachine) {
/// Err(_) => continue,
/// Ok(r) => r,
/// };
/// println!("vm max native address: {:#x} -> {:#x}",
/// CONFIG_OPT_CORE_MAX_NATIVE_ADDRESS,
/// vmm_vm.get_config(CONFIG_OPT_CORE_MAX_NATIVE_ADDRESS).unwrap_or(0));
/// }
/// }
/// ```
pub fn map_virtual_machine(&self) -> ResultEx<Vec<VmmMapVirtualMachineEntry>> {
return self.impl_map_virtual_machine();
}
/// Read a contigious physical memory chunk.
///
/// The physical memory is read without any special flags. The whole chunk
/// must be read successfully for the method to succeed.
///
/// If deseriable to provide flags modifying the behavior (such as skipping
/// the built-in data cache or slower paging access) use the method
/// `mem_read_ex()` instead.
///
/// Reading many memory chunks individually may be slow, especially if
/// reading takes place using hardware FPGA devices. In that case it's
/// better to use the `mem_scatter()` functionality for better performance.
///
///
/// # Arguments
/// * `pa` - Physical address to start reading from.
/// * `size` - Number of bytes to read.
///
/// # Examples
/// ```
/// // Read 0x100 bytes of data starting at address 0x1000.
/// // Example assumes: use pretty_hex::*;
/// if let Ok(data_read) = vmm.mem_read(0x1000, 0x100) {
/// println!("{:?}", data_read.hex_dump());
/// }
/// ```
pub fn mem_read(&self, pa : u64, size : usize) -> ResultEx<Vec<u8>> {
return self.impl_mem_read(u32::MAX, pa, size, 0);
}
/// Read a contigious physical memory chunk with flags.
///
/// Flags are constants named `FLAG_*`
///
/// Reading many memory chunks individually may be slow, especially if
/// reading takes place using hardware FPGA devices. In that case it's
/// better to use the `mem_scatter()` functionality for better performance.
///
///
/// # Arguments
/// * `pa` - Physical address to start reading from.
/// * `size` - Number of bytes to read.
/// * `flags` - Any combination of `FLAG_*`.
///
/// # Examples
/// ```
/// // Read 0x100 bytes of data starting at address 0x1000.
/// // Force reading the underlying memory device (skip data cache) and
/// // Zero-Pad if parts of the memory read fail instead of failing.
/// // Example assumes: use pretty_hex::*;
/// if let Ok(data_read) = vmm.mem_read_ex(0x1000, 0x100, FLAG_NOCACHE | FLAG_ZEROPAD_ON_FAIL) {
/// println!("{:?}", data_read.hex_dump());
/// }
/// ```
pub fn mem_read_ex(&self, pa : u64, size : usize, flags : u64) -> ResultEx<Vec<u8>> {
return self.impl_mem_read(u32::MAX, pa, size, flags);
}
/// Read a contigious physical memory chunk with flags as a type/struct.
///
/// Flags are constants named `FLAG_*`
///
/// Reading many memory chunks individually may be slow, especially if
/// reading takes place using hardware FPGA devices. In that case it's
/// better to use the `mem_scatter()` functionality for better performance.
///
///
/// # Arguments
/// * `pa` - Physical address to start reading from.
/// * `flags` - Any combination of `FLAG_*`.
///
/// # Examples
/// ```
/// // Read the C-struct IMAGE_DOS_HEADER from memory.
/// // Force reading the underlying memory device (skip data cache).
/// #[repr(C)]
/// struct IMAGE_DOS_HEADER {
/// e_magic : u16,
/// ...
/// e_lfanew : u32,
/// }
/// if let Ok(doshdr) = vmm.mem_read_as::<IMAGE_DOS_HEADER>(pa_kernel32, FLAG_NOCACHE) {
/// println!("e_magic: {:x}", doshdr.e_magic);
/// println!("e_lfanew: {:x}", doshdr.e_lfanew);
/// }
/// ```
pub fn mem_read_as<T>(&self, pa : u64, flags : u64) -> ResultEx<T> {
return self.impl_mem_read_as(u32::MAX, pa, flags);
}
/// Create a scatter memory object for efficient physical memory reads.
///
/// Check out the [`VmmScatterMemory`] struct for more detailed information.
///
/// # Arguments
/// * `flags` - Any combination of `FLAG_*`.
///
/// # Examples
/// ```
/// let mem_scatter_physical = vmm.mem_scatter(FLAG_NOCACHE | FLAG_ZEROPAD_ON_FAIL)?;
/// ```
pub fn mem_scatter(&self, flags : u64) -> ResultEx<VmmScatterMemory> {
return self.impl_mem_scatter(u32::MAX, flags);
}
/// Write physical memory.
///
/// The write is a best effort. Even of the write should fail it's not
/// certain that an error will be returned. To be absolutely certain that
/// a write has taken place follow up with a read.
///
/// # Arguments
/// * `pa` - Physical address to start writing from.
/// * `data` - Byte data to write.
///
/// # Examples
/// ```
/// let data_to_write = [0x56u8, 0x4d, 0x4d, 0x52, 0x55, 0x53, 0x54].to_vec();
/// let _r = vmm.mem_write(0x1000, &data_to_write);
/// ```
pub fn mem_write(&self, pa : u64, data : &Vec<u8>) -> ResultEx<()> {
return self.impl_mem_write(u32::MAX, pa, data);
}
/// Write a type/struct to physical memory.
///
/// The write is a best effort. Even of the write should fail it's not
/// certain that an error will be returned. To be absolutely certain that
/// a write has taken place follow up with a read.
///
/// # Arguments
/// * `pa` - Pnhysical address to start writing from.
/// * `data` - Data to write. In case of a struct repr(C) is recommended.
///
/// # Examples
/// ```
/// let data_to_write = [0x56, 0x4d, 0x4d, 0x52, 0x55, 0x53, 0x54];
/// let _r = vmm.mem_write_as(0x1000, &data_to_write);
/// ```
pub fn mem_write_as<T>(&self, pa : u64, data : &T) -> ResultEx<()> {
return self.impl_mem_write_as(u32::MAX, pa, data);
}
/// List a VFS (Virtual File System) directory.
///
/// Returns a result containing the individual directory entries -
/// which may be files or directories.
///
/// # Arguments
/// * `path` - VFS path to list directory contents in. Ex: /sys/
///
/// # Examples
/// ```
/// let vfs_list_path = "/sys/";
/// if let Ok(vfs_all) = vmm.vfs_list(vfs_list_path) {
/// println!("VFS directory listing for directory: {vfs_list_path}");
/// println!("Number of file/directory entries: {}.", vfs_all.len());
/// for vfs in &*vfs_all {
/// println!("{vfs}");
/// }
/// }
/// ```
pub fn vfs_list(&self, path : &str) -> ResultEx<Vec<VmmVfsEntry>> {
return self.impl_vfs_list(path);
}
/// Read a VFS (Virtual File System) file.
///
/// The read contents are returned as a Vec containing the byte results.
/// If the end of the file is reached the number of read bytes may be
/// shorter than the requested read size.
///
/// # Arguments
/// * `filename` - Full vfs path of the file to read. Ex: /sys/version.txt
/// * `size` - Number of bytes to read.
/// * `offset` - File offset.
///
/// # Examples
/// ```
/// if let Ok(vfs_file_data) = vmm.vfs_read("/sys/memory/physmemmap.txt", 0x2000, 0) {
/// println!("Bytes read from file '/sys/memory/physmemmap.txt': {}.", vfs_file_data.len());
/// println!("{:?}", vfs_file_data.hex_dump());
/// }
/// ```
pub fn vfs_read(&self, filename : &str, size : u32, offset : u64) -> ResultEx<Vec<u8>> {
return self.impl_vfs_read(filename, size, offset);
}
/// Write a VFS (Virtual File System) file.
///
/// Writes are undertaken on a best-effort basis. Writing to read-only
/// files will have no meaning. Writing to memory may or may not be
/// possible depending on various factors. If important, it's recommended
/// to verify the `vfs_write()` with a `vfs_read()`.
///
/// # Arguments
/// * `filename` - Full VFS path of the file to write. Ex: /conf/config_printf_enable.txt
/// * `data` - Byte data to write.
/// * `offset` - File offset.
///
/// # Examples
/// ```
/// let vfs_write_data = vec![1u8; 1];
/// vmm.vfs_write("/conf/config_process_show_terminated.txt", vfs_write_data, 0);
/// ```
pub fn vfs_write(&self, filename : &str, data : Vec<u8>, offset : u64) {
return self.impl_vfs_write(filename, data, offset);
}
/// Retrieve all registry hives.
///
/// # Examples
/// ```
/// let hive_all = vmm.reg_hive_list()?;
/// for hive in hive_all {
/// println!("{hive} size={} path={}", hive.size, hive.path);
/// }
/// ```
pub fn reg_hive_list(&self) -> ResultEx<Vec<VmmRegHive>> {
return self.impl_reg_hive_list();
}
/// Retrieve a registry key by its path.
///
/// Registry keys may be addressed either by its full path or by hive address
/// and hive path. Both addressing modes are shown in the examples below.
/// Registry keys are case sensitive.
///
/// Check out the [`VmmRegKey`] struct for more detailed information.
///
/// # Examples
/// ```
/// // Retrieve a regkey by full path.
/// let regkey = vmm.reg_key("HKLM\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Run")?
/// println!("{regkey");
/// ```
///
/// ```
/// // Retrieve a regkey by hive path.
/// // (SOFTWARE hive example address: 0xffffba061a908000).
/// let regkey = vmm.reg_key("0xffffba061a908000\\ROOT\\Microsoft\\Windows\\CurrentVersion\\Run")?
/// println!("{regkey");
/// ```
pub fn reg_key(&self, path : &str) -> ResultEx<VmmRegKey> {
return self.impl_reg_key(path);
}
/// Retrieve a registry value by its path.
///
/// Registry values may be addressed either by its full path or by hive
/// address and hive path. Both addressing modes are shown in the examples
/// below. Registry keys are case sensitive.
///
/// Check out the [`VmmRegValue`] struct for more detailed information.
///
/// # Examples
/// ```
/// // Retrieve a regvalue by full path.
/// let regpath = "HKLM\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\ProgramFilesDir";
/// let regvalue = vmm.reg_key(regpath)?
/// println!("{regkey");
/// ```
///
/// ```
/// // Retrieve a regvalue by hive path.
/// // (SOFTWARE hive example address: 0xffffba061a908000).
/// regpath = "0xffffba061a908000\\ROOT\\Microsoft\\Windows\\CurrentVersion\\ProgramFilesDir";
/// let regvalue = vmm.reg_key(regpath)?
/// println!("{regkey");
/// ```
pub fn reg_value(&self, path : &str) -> ResultEx<VmmRegValue> {
return self.impl_reg_value(path);
}
/// Retrieve a search struct for physical memory.
///
/// NB! This does not start the actual search yet.
///
/// Check out the [`VmmSearch`] struct for more detailed information.
///
///
/// # Arguments
/// * `addr_min` - Start search at this physical address.
/// * `addr_max` - End the search at this physical address. 0 is interpreted as u64::MAX.
/// * `num_results_max` - Max number of search hits to search for. Max allowed value is 0x10000.
/// * `flags` - Any combination of `FLAG_*`.
///
///
/// # Examples
/// ```
/// // Retrieve a VmmSearch for the entire physical memory.
/// let mut search = vmm.search(0, 0, 0x10000, 0)?
/// ```
///
/// ```
/// // Retrieve a VmmSearch for physical memory between 4GB and 8GB.
/// // Also stop at first search hit.
/// let mut search = vmm.search(0x100000000, 0x200000000, 1, 0)?
/// ```
pub fn search(&self, addr_min : u64, addr_max : u64, num_results_max : u32, flags : u64) -> ResultEx<VmmSearch> {
return VmmSearch::impl_new(&self, u32::MAX, addr_min, addr_max, num_results_max, flags);
}
/// Retrieve a yara search struct for physical memory.
///
/// NB! This does not start the actual search yet.
///
/// Check out the [`VmmYara`] struct for more detailed information.
///
///
/// # Arguments
/// * `rules` - Yara rules to search for.
/// * `addr_min` - Start yara search at this physical address.
/// * `addr_max` - End the yara search at this physical address. 0 is interpreted as u64::MAX.
/// * `num_results_max` - Max number of search hits to search for. Max allowed value is 0x10000.
/// * `flags` - Any combination of `FLAG_*`.
///
///
/// # Examples
/// ```
/// // Retrieve a VmmYara for the entire physical memory.
/// let yara_rule = " rule mz_header { strings: $mz = \"MZ\" condition: $mz at 0 } ";
/// let yara_rules = vec![yara_rule];
/// let mut yara = vmm.search_yara(yara_rules, 0, 0, 0x10000, 0)?
/// ```
///
/// ```
/// // Retrieve a VmmYara for physical memory between 4GB and 8GB.
/// // Also stop at first yara search hit.
/// let yara_rules = vec!["/tmp/my_yara_rule.yar", "/tmp/my_yara_rule2.yar"];
/// let mut yara = vmm.search_yara(yara_rules, 0x100000000, 0x200000000, 1, 0)?
/// ```
pub fn search_yara(&self, rules : Vec<&str>, addr_min : u64, addr_max : u64, num_results_max : u32, flags : u64) -> ResultEx<VmmYara> {
return VmmYara::impl_new(&self, rules, u32::MAX, addr_min, addr_max, num_results_max, flags);
}
}
impl VmmMapPoolEntry {
/// Retrieve the pool entry tag String.
pub fn tag_to_string(&self) -> String {
let tag_chars = [((self.tag >> 0) & 0xff) as u8, ((self.tag >> 8) & 0xff) as u8, ((self.tag >> 16) & 0xff) as u8, ((self.tag >> 24) & 0xff) as u8];
return String::from_utf8_lossy(&tag_chars).to_string();
}
}
/// Kernel information.
///
/// The kernel struct gives easy access to:
/// * The system process (pid 4).
/// * Kernel build number.
/// * Kernel debug symbols (nt).
///
///
/// # Created By
/// - [`vmm.kernel()`](Vmm::kernel())
///
/// # Examples
/// ```
/// println!("{}", vmm.kernel().process());
/// println!("{}", vmm.kernel().build());
/// let kernel = vmm.kernel();
/// let pdb = kernel.pdb();
/// println!("{pdb}");
/// ```
#[derive(Debug)]
pub struct VmmKernel<'a> {
vmm : &'a Vmm<'a>,
}
impl VmmKernel<'_> {
/// Get the kernel build numer.
///
/// # Examples
/// ```
/// // Retrieve and print the kernel build number.
/// println!("{}", vmm.kernel().build());
/// ```
pub fn build(&self) -> u32 {
return self.vmm.get_config(CONFIG_OPT_WIN_VERSION_BUILD).unwrap_or_default().try_into().unwrap_or_default();
}
/// Get the System process (pid 4).
///
/// # Examples
/// ```
/// // Retrieve and print the kernel build number.
/// let systemprocess = vmm.kernel().process();
/// ```
pub fn process(&self) -> VmmProcess {
return VmmProcess { vmm : self.vmm, pid : 4 };
}
/// Get kernel debug information (nt).
///
/// For additional information about debug symbols check out the [`VmmPdb`] struct.
///
/// # Examples
/// ```
/// // Retrieve and print the kernel build number.
/// let pdb_nt = vmm.kernel().pdb();
/// ```
pub fn pdb(&self) -> VmmPdb {
return VmmPdb { vmm : self.vmm, module : String::from("nt") };
}
}
/// Debug Symbol API.
///
/// The PDB sub-system requires that MemProcFS supporting DLLs/.SO's for
/// debugging and symbol server are put alongside `vmm.dll`. Also it's
/// recommended that the file `info.db` is put alongside `vmm.dll`.
///
///
/// # Created By
/// - [`vmmprocess.pdb_from_module_address()`](VmmProcess::pdb_from_module_address())
/// - [`vmm.kernel().pdb()`](VmmKernel::pdb())
///
/// # Examples
/// ```
/// // Retrieve the PDB struct associated with the kernel (nt).
/// let kernel = vmm.kernel();
/// let pdb = kernel.pdb();
/// ```
///
/// ```
/// // Retrieve the PDB struct associated with a process module.
/// let pdb = vmmprocess.pdb("ntdll.dll")?;
/// ```
#[derive(Debug)]
pub struct VmmPdb<'a> {
vmm : &'a Vmm<'a>,
pub module : String,
}
impl VmmPdb<'_> {
/// Retrieve a symbol name and a displacement given a module offset or virtual address.
///
/// # Arguments
/// * `va_or_offset` - Virtual address or offset from module base.
///
/// # Examples
/// ```
/// if let Ok(r) = pdb.symbol_name_from_address(va_symbol) {
/// println!("va_o: {:x} name: '{}' displacement: {:x}", va_symbol, r.0, r.1);
/// }
/// ```
pub fn symbol_name_from_address(&self, va_or_offset : u64) -> ResultEx<(String, u32)> {
return self.impl_symbol_name_from_address(va_or_offset);
}
/// Lookup a symbol address given its name.
///
/// # Arguments
/// * `symbol_name`
///
/// # Examples
/// ```
/// let va = pdb_nt.symbol_address_from_name("MiMapContiguousMemory")?;
/// ```
pub fn symbol_address_from_name(&self, symbol_name : &str) -> ResultEx<u64> {
return self.impl_symbol_address_from_name(symbol_name);
}
/// Retrieve the size of a struct/type.
///
/// # Arguments
/// * `type_name`
///
/// # Examples
/// ```
/// let size_eprocess = pdb_nt.type_size("_EPROCESS")?;
/// ```
pub fn type_size(&self, type_name : &str) -> ResultEx<u32> {
return self.impl_type_size(type_name);
}
/// Retrieve offset of a struct child member.
///
/// # Arguments
/// * `type_name`
/// * `type_child_name`
///
/// # Examples
/// ```
/// let offet_vadroot = pdb_nt.type_child_offset("_EPROCESS", "VadRoot")?
/// ```
pub fn type_child_offset(&self, type_name : &str, type_child_name : &str) -> ResultEx<u32> {
return self.impl_type_child_offset(type_name, type_child_name);
}
}
/// Efficient Memory Reading API.
///
/// The Scatter Memory API allows reading several scattered memory regions at
/// the same time in one pass - greatly improving efficiency over multiple
/// normal memory reads.
///
/// The Rust Scatter API may be used in two different ways, both are displayed
/// below in the examples section.
///
///
/// # Created By
/// - [`vmm.mem_scatter()`](Vmm::mem_scatter())
/// - [`vmmprocess.mem_scatter()`](VmmProcess::mem_scatter())
///
/// # Example #1
/// ```
/// // Example: vmmprocess.mem_scatter() #1:
/// // This example will show how it's possible to use VmmScatterMemory to
/// // more efficiently read memory from the underlying device.
/// {
/// // Example: vmmprocess.mem_scatter():
/// // Retrieve a scatter memory read object that may be used to batch
/// // several reads/writes into one efficient call to the memory device.
/// println!("========================================");
/// println!("vmmprocess.mem_scatter() #1:");
/// let mem_scatter = vmmprocess.mem_scatter(FLAG_NOCACHE | FLAG_ZEROPAD_ON_FAIL)?;
/// println!("mem_scatter = {mem_scatter}");
/// // Prepare three memory ranges to read.
/// let _r = mem_scatter.prepare(kernel32.va_base + 0x0000, 0x100);
/// let _r = mem_scatter.prepare(kernel32.va_base + 0x1000, 0x100);
/// let _r = mem_scatter.prepare(kernel32.va_base + 0x2000, 0x100);
/// // Perform the actual read (and writes) by calling the execute() function.
/// let _r = mem_scatter.execute();
/// // Fetch data read. It's possible (but wasteful) to read less data than was prepared.
/// if let Ok(data_read) = mem_scatter.read(kernel32.va_base + 0x0000, 0x80) {
/// println!("memory range: va={:x} cb={:x} cb_read={:x}", kernel32.va_base + 0x0000, 0x80, data_read.len());
/// println!("{:?}", data_read.hex_dump());
/// println!("-----------------------");
/// }
/// if let Ok(data_read) = mem_scatter.read(kernel32.va_base + 0x1000, 0x100) {
/// println!("memory range: va={:x} cb={:x} cb_read={:x}", kernel32.va_base + 0x1000, 0x100, data_read.len());
/// println!("{:?}", data_read.hex_dump());
/// println!("-----------------------");
/// }
/// // It's possible to do a re-read of the ranges by calling execute again!
/// let _r = mem_scatter.execute();
/// if let Ok(data_read) = mem_scatter.read(kernel32.va_base + 0x0000, 0x80) {
/// println!("memory range: va={:x} cb={:x} cb_read={:x}", kernel32.va_base + 0x0000, 0x80, data_read.len());
/// println!("{:?}", data_read.hex_dump());
/// println!("-----------------------");
/// }
/// // It's also possible to clear the VmmScatterMemory to start anew.
/// // Clearing is slightly more efficient than creating a new object.
/// // let _r = mem_scatter.clear();
///
/// // NB! the VmmScatterMemory struct will be automatically free'd
/// // on the native backend when it goes out of scope.
/// }
/// ```
///
/// # Example #2
/// ```
/// // Example: vmmprocess.mem_scatter() #2:
/// // This example demo how it's possible to use the prepare_ex function
/// // which will populate the prepared data regions automatically when the
/// // VmmScatterMemory is dropped.
/// // It's not recommended to mix the #1 and #2 syntaxes.
/// {
/// // memory ranges to read are tuples:
/// // .0 = the virtual address to read.
/// // .1 = vector of u8 which memory should be read into.
/// // .2 = u32 receiving the bytes successfully read data.
/// let mut memory_range_1 = (kernel32.va_base + 0x0000, vec![0u8; 0x100], 0u32);
/// let mut memory_range_2 = (kernel32.va_base + 0x1000, vec![0u8; 0x100], 0u32);
/// let mut memory_range_3 = (kernel32.va_base + 0x2000, vec![0u8; 0x100], 0u32);
/// // Feed the ranges into a mutable VmmScatterMemory inside a
/// // separate scope. The actual memory read will take place when
/// // the VmmScatterMemory goes out of scope and are dropped.
/// println!("========================================");
/// println!("vmmprocess.mem_scatter() #2:");
/// if let Ok(mut mem_scatter) = vmmprocess.mem_scatter(FLAG_NOCACHE | FLAG_ZEROPAD_ON_FAIL) {
/// let _r = mem_scatter.prepare_ex(&mut memory_range_1);
/// let _r = mem_scatter.prepare_ex(&mut memory_range_2);
/// let _r = mem_scatter.prepare_ex(&mut memory_range_3);
/// }
/// // Results should now be available in the memory ranges if the read
/// // was successful. Note that there is no guarantee that memory is
/// // read - make sure to check the .2 item - number of bytes read.
/// for memory_range in [memory_range_1, memory_range_2, memory_range_3] {
/// println!("memory range: va={:x} cb={:x} cb_read={:x}", memory_range.0, memory_range.1.len(), memory_range.2);
/// println!("{:?}", memory_range.1.hex_dump());
/// println!("-----------------------");
/// }
/// }
/// ```
#[derive(Debug)]
pub struct VmmScatterMemory<'a> {
vmm : &'a Vmm<'a>,
hs : usize,
pid : u32,
flags : u32,
is_scatter_ex : bool,
}
impl <'a> VmmScatterMemory<'a> {
/// Prepare a memory range for reading according to method #2.
///
/// Once the `mem_scatter.execute()` call has been made the memory
/// read should (if successful) be found in the prepared tuple.
///
/// See the [`VmmScatterMemory`] struct for an example.
///
/// # Arguments
/// * `data_to_read` - Tuple with data to prepare as below:
/// * `data_to_read.0` - Address to start read from.
/// * `data_to_read.1` - Byte Vec with space to fill with read data on success.
/// * `data_to_read.2` - Bytes actually read on `mem_scatter.execute()` call. Should be zero at call to `mem_scatter.prepare_ex()`.
pub fn prepare_ex(&mut self, data_to_read : &'a mut (u64, Vec<u8>, u32)) -> ResultEx<()> {
return self.impl_prepare_ex(data_to_read);
}
/// Prepare a memory range for reading according to method #2.
///
/// Once the `mem_scatter.execute()` call has been made the memory
/// read should (if successful) be found in the prepared tuple.
///
/// See the [`VmmScatterMemory`] struct for an example.
///
/// # Arguments
/// * `data_to_read` - Tuple with data to prepare as below:
/// * `data_to_read.0` - Address to start read from.
/// * `data_to_read.1` - Generic Type/Struct to fill with read data on success.
/// * `data_to_read.2` - Bytes actually read on `mem_scatter.execute()` call. Should be zero at call to `mem_scatter.prepare_ex()`.
pub fn prepare_ex_as<T>(&mut self, data_to_read : &'a mut (u64, T, u32)) -> ResultEx<()> {
return self.impl_prepare_ex_as(data_to_read);
}
}
impl VmmScatterMemory<'_> {
/// Prepare a memory range for reading according to method #1.
///
/// Once the `mem_scatter.execute()` call has been made it's possible
/// to read the memory by calling `mem_scatter.read()`.
///
/// See the [`VmmScatterMemory`] struct for an example.
///
/// # Arguments
/// * `va` - Address to prepare to read from.
/// * `size` - Number of bytes to read.
pub fn prepare(&self, va : u64, size : usize) -> ResultEx<()> {
return self.impl_prepare(va, size);
}
/// Prepare a memory range for reading according to method #1.
///
/// Once the `mem_scatter.execute()` call has been made it's possible
/// to read the memory by calling `mem_scatter.read()`.
///
/// See the [`VmmScatterMemory`] struct for an example.
///
/// # Arguments
/// * `va` - Address to prepare to read from.
pub fn prepare_as<T>(&self, va : u64) -> ResultEx<()> {
return self.impl_prepare(va, std::mem::size_of::<T>());
}
/// Prepare a memory range for writing.
///
/// Writing takes place on the call to `mem_scatter.execute()`.
///
/// # Arguments
/// * `va` - Address to prepare to write to.
/// * `data` - Data to write.
pub fn prepare_write(&self, va : u64, data : &Vec<u8>) -> ResultEx<()> {
return self.impl_prepare_write(va, data);
}
/// Prepare a memory range for writing.
///
/// Writing takes place on the call to `mem_scatter.execute()`.
///
/// # Arguments
/// * `va` - Address to prepare to write to.
/// * `data` - Data to write. In case of a struct repr(C) is recommended.
pub fn prepare_write_as<T>(&self, va : u64, data : &T) -> ResultEx<()> {
return self.impl_prepare_write_as(va, data);
}
/// Execute the scatter call to the underlying memory device.
///
/// This function takes care of all reading and writing. After
/// this function is called it's possible to read memory, or if
/// approach #2 is used the memory should already be read into
/// buffers prepared with the call to `mem_scatter.prepare_ex()`.
pub fn execute(&self) -> ResultEx<()> {
return self.impl_execute();
}
/// Read memory prepared after the `execute()` call.
pub fn read(&self, va : u64, size : usize) -> ResultEx<Vec<u8>> {
return self.impl_read(va, size);
}
/// Read memory prepared after the `execute()` call.
pub fn read_as<T>(&self, va : u64) -> ResultEx<T> {
return self.impl_read_as(va);
}
/// Clear the scatter memory for additional read/writes.
pub fn clear(&self) -> ResultEx<()> {
return self.impl_clear();
}
}
/// <b>Process API Base Struct.</b>
///
/// The [`VmmProcess`] struct is the base of the per-process related
/// functionality of the MemProcFS API. The [`VmmProcess`] struct should
/// be considered a child to the main [`Vmm`] struct.
///
/// <b>Check out the example project for more detailed API usage and
/// additional examples!</b>
///
///
/// # Created By
/// - [`vmm.process_from_pid()`](Vmm::process_from_pid())
/// - [`vmm.process_from_name()`](Vmm::process_from_name())
/// - [`vmm.process_list()`](Vmm::process_list())
/// - [`vmm.kernel().process()`](VmmKernel::process())
/// - `plugin sub-system`
///
///
/// # Examples
///
/// ```
/// // Retrieve all processes:
/// if let Ok(process_all) = vmm.process_list() {
/// for process in &*process_all {
/// print!("{process} ");
/// }
/// }
/// ```
///
/// ```
/// // Retrieve a process by its name. If more than one process share the
/// // same name the first found will be returned.
/// let systemprocess = vmm.process_from_name("System")?;
/// println!("{systemprocess}");
/// ```
///
/// ```
/// // Retrieve a process by its PID.
/// let systemprocess = vmm.process_from_pid(4)?;
/// println!("{systemprocess}");
/// ```
///
/// ```
/// // Process kernel memory and session space:
/// // Mask the process PID with 0x80000000 to retrieve kernel memory.
/// // This may be useful for retrieving kernel session data related to win32k.
/// let mut winlogon = vmm.process_from_name("winlogon.exe")?;
/// winlogon.pid = winlogon.pid | 0x80000000;
/// let va = winlogon.get_proc_address("win32kbase.sys", "gSessionId")?;
/// let sessionid : u32 = winlogon.mem_read_as(va, 0)?;
/// println!("win32kbase.sys!gSessionId -> {:x} : {}", va, sessionid);
/// ```
#[derive(Debug)]
pub struct VmmProcess<'a> {
vmm : &'a Vmm<'a>,
pub pid : u32,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum VmmIntegrityLevelType {
Unknown,
Untrusted,
Low,
Medium,
MediumPlus,
High,
System,
Protected,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum VmmMemoryModelType {
NA,
X86,
X86PAE,
X64,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum VmmSystemType {
UnknownPhysical,
UnknownX64,
WindowsX64,
UnknownX86,
WindowsX86,
}
/// Process Information.
///
/// # Created By
/// - [`vmmprocess.info()`](VmmProcess::info())
///
/// # Examples
/// ```
/// // Retrieve the VmmProcess info struct from a process.
/// // It's better to retrieve this struct once and query its fields rather
/// // than calling `vmmprocess.info()` repetedly since there is a small
/// // native overhead doing so.
/// if let Ok(procinfo) = vmmprocess.info() {
/// println!("struct -> {procinfo}");
/// println!("pid -> {}", procinfo.pid);
/// println!("ppid -> {}", procinfo.pid);
/// println!("peb -> {:x}", procinfo.va_peb);
/// println!("eprocess -> {:x}", procinfo.va_eprocess);
/// println!("name -> {}", procinfo.name);
/// println!("longname -> {}", procinfo.name_long);
/// println!("SID -> {}", procinfo.sid);
/// }
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmProcessInfo {
pub pid : u32,
pub ppid : u32,
pub name : String,
pub name_long : String,
pub tp_system : VmmSystemType,
pub tp_memorymodel : VmmMemoryModelType,
pub is_user_mode : bool,
pub state : u32,
pub pa_dtb : u64,
pub pa_dtb_user : u64,
pub va_eprocess : u64,
pub va_peb : u64,
pub is_wow64 : bool,
pub va_peb32 : u32,
pub session_id : u32,
pub luid : u64,
pub sid : String,
pub integrity_level : VmmIntegrityLevelType,
}
/// Info: Process Module: PE data directories.
///
/// # Created By
/// - [`vmmprocess.map_module_data_directory()`](VmmProcess::map_module_data_directory())
///
/// # Examples
/// ```
/// if let Ok(data_directory_all) = vmmprocess.map_module_data_directory("kernel32.dll") {
/// println!("Number of module data directories: {}.", data_directory_all.len());
/// for data_directory in &*data_directory_all {
/// println!("{data_directory}");
/// }
/// }
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmProcessMapDirectoryEntry {
pub pid : u32,
pub name : &'static str,
pub virtual_address : u32,
pub size : u32,
}
/// Info: Process Module: PE exported entries.
///
/// # Created By
/// - [`vmmprocess.map_module_eat()`](VmmProcess::map_module_eat()
///
/// # Examples
/// ```
/// if let Ok(eat_all) = vmmprocess.map_module_eat("kernel32.dll") {
/// println!("Number of module exported functions: {}.", eat_all.len());
/// for eat in &*eat_all {
/// println!("{eat} :: {}", eat.forwarded_function);
/// }
/// }
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmProcessMapEatEntry {
pub pid : u32,
pub va_function : u64,
pub ordinal : u32,
pub function : String,
pub forwarded_function : String,
}
/// Info: Process: Handles.
///
/// # Created By
/// - [`vmmprocess.map_handle()`](VmmProcess::map_handle())
///
/// # Examples
/// ```
/// if let Ok(handle_all) = vmmprocess.map_handle() {
/// println!("Number of handle entries: {}.", handle_all.len());
/// for handle in &*handle_all {
/// println!("{handle}");
/// }
/// }
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmProcessMapHandleEntry {
pub pid : u32,
pub va_object : u64,
pub handle_id : u32,
pub granted_access : u32,
pub type_index : u32,
pub handle_count : u64,
pub pointer_count : u64,
pub va_object_create_info : u64,
pub va_security_descriptor : u64,
pub handle_pid : u32,
pub pool_tag : u32,
pub info : String,
pub tp : String,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum VmmProcessMapHeapType {
NA,
NtHeap,
SegmentHeap,
}
/// Info: Process: Heaps.
///
/// # Created By
/// - [`vmmprocess.map_heap()`](VmmProcess::map_heap())
///
/// # Examples
/// ```
/// if let Ok(heap_all) = vmmprocess.map_heap() {
/// println!("Number of heap entries: {}.", heap_all.len());
/// for heap in &*heap_all {
/// println!("{heap}");
/// }
/// }
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmProcessMapHeapEntry {
pub pid : u32,
pub tp : VmmProcessMapHeapType,
pub is_32 : bool,
pub index : u32,
pub number : u32,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum VmmProcessMapHeapAllocType {
NA,
NtHeap,
NtLFH,
NtLarge,
NtNA,
SegVS,
SegLFH,
SegLarge,
SegNA,
}
/// Info: Process: Heap allocations.
///
/// # Created By
/// - [`vmmprocess.map_heapalloc()`](VmmProcess::map_heapalloc())
///
/// # Examples
/// ```
/// if let Ok(heapalloc_all) = vmmprocess.map_heapalloc(0) {
/// println!("Number of allocated heap entries: {}.", heapalloc_all.len());
/// for heapalloc in &*heapalloc_all {
/// print!("{heapalloc} ");
/// }
/// println!("");
/// }
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmProcessMapHeapAllocEntry {
pub pid : u32,
pub va : u64,
pub size : u32,
pub tp : VmmProcessMapHeapAllocType,
}
/// Info: Process Module: PE imported entries.
///
/// # Created By
/// - [`vmmprocess.map_module_iat()`](VmmProcess::map_module_iat())
///
/// # Examples
/// ```
/// if let Ok(iat_all) = vmmprocess.map_module_iat("kernel32.dll") {
/// println!("Number of module imported functions: {}.", iat_all.len());
/// for iat in &*iat_all {
/// println!("{iat}");
/// }
/// }
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmProcessMapIatEntry {
pub pid : u32,
pub va_function : u64,
pub function : String,
pub module : String,
}
/// Info: Process: Modules (loaded DLLs) debug information.
///
/// # Created By
/// - [`vmmprocess.map_module()`](VmmProcess::map_module())
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmProcessMapModuleDebugEntry {
pub pid : u32,
pub age : u32,
pub raw_guid : [u8; 16],
pub guid : String,
pub pdb_filename : String,
}
/// Info: Process: Modules (loaded DLLs) version information.
///
/// # Created By
/// - [`vmmprocess.map_module()`](VmmProcess::map_module())
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmProcessMapModuleVersionEntry {
pub pid : u32,
pub company_name : String,
pub file_description : String,
pub file_version : String,
pub internal_name : String,
pub legal_copyright : String,
pub original_file_name : String,
pub product_name : String,
pub product_version : String,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum VmmProcessMapModuleType {
Normal,
Data,
NotLinked,
Injected,
}
/// Info: Process: Modules (loaded DLLs).
///
/// # Created By
/// - [`vmmprocess.map_module()`](VmmProcess::map_module())
///
/// # Examples
/// ```
/// if let Ok(module_all) = vmmprocess.map_module(true, true) {
/// println!("Number of process modules: {}.", module_all.len());
/// for module in &*module_all {
/// println!("{module}");
/// }
/// }
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmProcessMapModuleEntry {
pub pid : u32,
pub va_base : u64,
pub va_entry : u64,
pub image_size : u32,
pub is_wow64 : bool,
pub tp : VmmProcessMapModuleType,
pub name : String,
pub full_name : String,
pub file_size_raw : u32,
pub section_count : u32,
pub eat_count : u32,
pub iat_count : u32,
pub debug_info : Option<VmmProcessMapModuleDebugEntry>,
pub version_info : Option<VmmProcessMapModuleVersionEntry>,
}
/// Info: Process: PTE memory map entries.
///
/// # Created By
/// - [`vmmprocess.map_pte()`](VmmProcess::map_pte())
///
/// # Examples
/// ```
/// if let Ok(pte_all) = vmmprocess.map_pte(true) {
/// println!("Number of pte entries: {}.", pte_all.len());
/// for pte in &*pte_all {
/// let s = if pte.is_s { 's' } else { '-' };
/// let r = if pte.is_r { 'r' } else { '-' };
/// let w = if pte.is_w { 'w' } else { '-' };
/// let x = if pte.is_x { 'x' } else { '-' };
/// println!("{pte} :: {s}{r}{w}{x} :: {}", pte.info);
/// }
/// }
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmProcessMapPteEntry {
pub pid : u32,
pub va_base : u64,
pub page_count : u64,
pub page_software_count : u32,
pub is_wow64 : bool,
pub info : String,
pub is_r : bool,
pub is_w : bool,
pub is_x : bool,
pub is_s : bool,
}
/// Info: Process Module: PE sections.
///
/// # Created By
/// - [`vmmprocess.map_module_section()`](VmmProcess::map_module_section())
///
/// # Examples
/// ```
/// if let Ok(section_all) = vmmprocess.map_module_section("kernel32.dll") {
/// println!("Number of module sections: {}.", section_all.len());
/// for section in &*section_all {
/// println!("{section}");
/// }
/// }
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmProcessSectionEntry {
pub pid : u32,
pub index : u32,
pub name : String,
pub name_raw : [u8; 8],
pub misc_virtual_size : u32,
pub virtual_address : u32,
pub size_of_raw_data : u32,
pub pointer_to_raw_data : u32,
pub pointer_to_relocations : u32,
pub pointer_to_linenumbers : u32,
pub number_of_relocations : u16,
pub number_of_linenumbers : u16,
pub characteristics : u32,
}
/// Info: Process: Threads.
///
/// # Created By
/// - [`vmmprocess.map_thread()`](VmmProcess::map_thread())
///
/// # Examples
/// ```
/// if let Ok(thread_all) = vmmprocess.map_thread() {
/// println!("Number of process threads: {}.", thread_all.len());
/// for thread in &*thread_all {
/// println!("{thread}");
/// }
/// }
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmProcessMapThreadEntry {
pub pid : u32,
pub thread_id : u32,
pub thread_pid : u32,
pub exit_status : u32,
pub state : u8,
pub running : u8,
pub priority : u8,
pub priority_base : u8,
pub va_ethread : u64,
pub va_teb : u64,
pub ft_create_time : u64,
pub ft_exit_time : u64,
pub va_start_address : u64,
pub va_win32_start_address : u64,
pub va_stack_user_base : u64,
pub va_stack_user_limit : u64,
pub va_stack_kernel_base : u64,
pub va_stack_kernel_limit : u64,
pub va_trap_frame : u64,
pub va_impersonation_token : u64,
pub va_rip : u64,
pub va_rsp : u64,
pub affinity : u64,
pub user_time : u32,
pub kernel_time : u32,
pub suspend_count : u8,
pub wait_reason : u8
}
/// Info: Process: Unloaded modules.
///
/// # Created By
/// - [`vmmprocess.map_unloaded_module()`](VmmProcess::map_unloaded_module())
///
/// # Examples
/// ```
/// if let Ok(unloaded_all) = vmmprocess.map_unloaded_module() {
/// println!("Number of process unloaded modules: {}.", unloaded_all.len());
/// for unloaded in &*unloaded_all {
/// println!("{unloaded}");
/// }
/// }
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmProcessMapUnloadedModuleEntry {
pub pid : u32,
pub va_base : u64,
pub image_size : u32,
pub is_wow64 : bool,
pub name : String,
pub checksum : u32, // user-mode only
pub timedatestamp : u32, // user-mode only
pub ft_unload : u64, // kernel-mode only
}
/// Info: Process: VAD (Virtual Address Descriptor) memory map entries.
///
/// # Created By
/// - [`vmmprocess.map_vad()`](VmmProcess::map_vad())
///
/// # Examples
/// ```
/// if let Ok(vad_all) = vmmprocess.map_vad(true) {
/// println!("Number of vad entries: {}.", vad_all.len());
/// for vad in &*vad_all {
/// println!("{vad} :: {}", vad.info);
/// }
/// }
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmProcessMapVadEntry {
pub pid : u32,
pub va_start : u64,
pub va_end : u64,
pub va_vad : u64,
pub u0 : u32,
pub u1 : u32,
pub u2 : u32,
pub commit_charge : u32,
pub is_mem_commit : bool,
pub cb_prototype_pte : u32,
pub va_prototype_pte : u64,
pub va_subsection : u64,
pub va_file_object : u64,
pub info : String,
pub vadex_page_base : u32,
pub vadex_page_count : u32,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum VmmProcessMapVadExType {
NA,
Hardware,
Transition,
Prototype,
DemandZero,
Compressed,
Pagefile,
File,
}
/// Info: Process: Extended VAD memory map entries.
///
/// # Created By
/// - [`vmmprocess.map_vadex()`](VmmProcess::map_vadex())
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmProcessMapVadExEntry {
pub pid : u32,
pub tp : VmmProcessMapVadExType,
pub i_pml : u8,
pub va : u64,
pub pa : u64,
pub pte : u64,
pub pte_flags : u8,
pub proto_tp : VmmProcessMapVadExType,
pub proto_pa : u64,
pub proto_pte : u64,
pub va_vad_base : u64,
}
impl VmmProcess<'_> {
/// Get the base virtual address for a loaded module.
///
/// # Arguments
/// * `module_name`
///
/// # Examples
/// ```
/// if let Ok(module_base_kernel32) = vmmprocess.get_module_base("kernel32.dll") {
/// println!("kernel32.dll -> {:x}", module_base_kernel32);
/// }
/// ```
pub fn get_module_base(&self, module_name : &str) -> ResultEx<u64> {
return self.impl_get_module_base(module_name);
}
/// Get the address of an exported function or symbol.
///
/// This is similar to the Windows function GetProcAddress.
///
/// # Arguments
/// * `module_name`
/// * `function_name`
///
/// # Examples
/// ```
/// if let Ok(procaddress) = vmmprocess.get_proc_address("kernel32.dll", "GetProcAddress") {
/// println!("kernel32.dll!GetProcAddress -> {:x}", procaddress);
/// }
/// ```
pub fn get_proc_address(&self, module_name : &str, function_name : &str) -> ResultEx<u64> {
return self.impl_get_proc_address(module_name, function_name);
}
/// Get the process path (retrieved fom kernel mode).
///
/// # Examples
/// ```
/// if let Ok(path) = vmmprocess.get_path_kernel() {
/// println!("-> {path}");
/// }
/// ```
pub fn get_path_kernel(&self) -> ResultEx<String> {
return self.impl_get_information_string(VMMDLL_PROCESS_INFORMATION_OPT_STRING_PATH_KERNEL);
}
/// Get the process path (retrieved from user-mode).
///
/// # Examples
/// ```
/// if let Ok(path) = vmmprocess.get_path_user() {
/// println!("-> {path}");
/// }
/// ```
pub fn get_path_user(&self) -> ResultEx<String> {
return self.impl_get_information_string(VMMDLL_PROCESS_INFORMATION_OPT_STRING_PATH_USER_IMAGE);
}
/// Get the process command line.
///
/// # Examples
/// ```
/// if let Ok(s_cmdline) = vmmprocess.get_cmdline() {
/// println!("-> {s_cmdline}");
/// }
/// ```
pub fn get_cmdline(&self) -> ResultEx<String> {
return self.impl_get_information_string(VMMDLL_PROCESS_INFORMATION_OPT_STRING_CMDLINE);
}
/// Get process information - such as name, ppid, state, etc.
///
/// If retrieving multiple values from the [`VmmProcessInfo`] struct it's
/// recommended to retrieve the info object once instead of repetedly
/// calling the info() method.
///
/// # Examples
/// ```
/// if let Ok(procinfo) = vmmprocess.info() {
/// println!("struct -> {procinfo}");
/// println!("pid -> {}", procinfo.pid);
/// println!("ppid -> {}", procinfo.pid);
/// println!("peb -> {:x}", procinfo.va_peb);
/// println!("eprocess -> {:x}", procinfo.va_eprocess);
/// println!("name -> {}", procinfo.name);
/// println!("longname -> {}", procinfo.name_long);
/// println!("SID -> {}", procinfo.sid);
/// }
/// ```
pub fn info(&self) -> ResultEx<VmmProcessInfo> {
return self.impl_info();
}
/// Retrieve the handles info map.
///
/// For additional information see the [`VmmProcessMapHandleEntry`] struct.
///
/// # Examples
/// ```
/// if let Ok(handle_all) = vmmprocess.map_handle() {
/// println!("Number of handle entries: {}.", handle_all.len());
/// for handle in &*handle_all {
/// println!("{handle}");
/// }
/// }
/// ```
pub fn map_handle(&self) -> ResultEx<Vec<VmmProcessMapHandleEntry>> {
return self.impl_map_handle();
}
/// Retrieve the heaps info map.
///
/// For additional information see the [`VmmProcessMapHeapEntry`] struct.
///
/// # Examples
/// ```
/// if let Ok(heap_all) = vmmprocess.map_heap() {
/// println!("Number of heap entries: {}.", heap_all.len());
/// for heap in &*heap_all {
/// println!("{heap}");
/// }
/// }
/// ```
pub fn map_heap(&self) -> ResultEx<Vec<VmmProcessMapHeapEntry>> {
return self.impl_map_heap();
}
/// Retrieve the heap allocations info map.
///
/// For additional information see the [`VmmProcessMapHeapAllocEntry`] struct.
///
/// # Arguments
/// * `heap_number_or_address` - Heap number as given by [`VmmProcessMapHeapEntry`] or the heap base address.
///
/// # Examples
/// ```
/// if let Ok(heapalloc_all) = vmmprocess.map_heapalloc(0) {
/// println!("Number of allocated heap entries: {}.", heapalloc_all.len());
/// for heapalloc in &*heapalloc_all {
/// print!("{heapalloc} ");
/// }
/// println!("");
/// }
/// ```
pub fn map_heapalloc(&self, heap_number_or_address : u64) -> ResultEx<Vec<VmmProcessMapHeapAllocEntry>> {
return self.impl_map_heapalloc(heap_number_or_address);
}
/// Retrieve the loaded modules map.
///
/// For additional information see the [`VmmProcessMapModuleEntry`] struct.
///
/// # Arguments
/// * `is_info_debug` - Also retrieve debug information.
/// * `is_info_version` - Also version information.
///
/// # Examples
/// ```
/// if let Ok(module_all) = vmmprocess.map_module(true, true) {
/// println!("Number of process modules: {}.", module_all.len());
/// for module in &*module_all {
/// println!("{module}");
/// }
/// }
/// ```
pub fn map_module(&self, is_info_debug : bool, is_info_version : bool) -> ResultEx<Vec<VmmProcessMapModuleEntry>> {
return self.impl_map_module(is_info_debug, is_info_version);
}
/// Retrieve PE data directories associated with a module.
///
/// For additional information see the [`VmmProcessMapDirectoryEntry`] struct.
///
/// # Arguments
/// * `module_name`
///
/// # Examples
/// ```
/// if let Ok(data_directory_all) = vmmprocess.map_module_data_directory("kernel32.dll") {
/// println!("Number of module data directories: {}.", data_directory_all.len());
/// for data_directory in &*data_directory_all {
/// println!("{data_directory}");
/// }
/// }
/// ```
pub fn map_module_data_directory(&self, module_name : &str) -> ResultEx<Vec<VmmProcessMapDirectoryEntry>> {
return self.impl_map_module_data_directory(module_name);
}
/// Retrieve exported functions and symbols associated with a module.
///
/// For additional information see the [`VmmProcessMapEatEntry`] struct.
///
/// # Arguments
/// * `module_name`
///
/// # Examples
/// ```
/// if let Ok(eat_all) = vmmprocess.map_module_eat("kernel32.dll") {
/// println!("Number of module exported functions: {}.", eat_all.len());
/// for eat in &*eat_all {
/// println!("{eat} :: {}", eat.forwarded_function);
/// }
/// }
/// ```
pub fn map_module_eat(&self, module_name : &str) -> ResultEx<Vec<VmmProcessMapEatEntry>> {
return self.impl_map_module_eat(module_name);
}
/// Retrieve imported functions associated with a module.
///
/// For additional information see the [`VmmProcessMapIatEntry`] struct.
///
/// # Arguments
/// * `module_name`
///
/// # Examples
/// ```
/// if let Ok(iat_all) = vmmprocess.map_module_iat("kernel32.dll") {
/// println!("Number of module imported functions: {}.", iat_all.len());
/// for iat in &*iat_all {
/// println!("{iat}");
/// }
/// }
/// ```
pub fn map_module_iat(&self, module_name : &str) -> ResultEx<Vec<VmmProcessMapIatEntry>> {
return self.impl_map_module_iat(module_name);
}
/// Retrieve PE sections associated with a module.
///
/// For additional information see the [`VmmProcessSectionEntry`] struct.
///
/// # Arguments
/// * `module_name`
///
/// # Examples
/// ```
/// if let Ok(section_all) = vmmprocess.map_module_section("kernel32.dll") {
/// println!("Number of module sections: {}.", section_all.len());
/// for section in &*section_all {
/// println!("{section}");
/// }
/// }
/// ```
pub fn map_module_section(&self, module_name : &str) -> ResultEx<Vec<VmmProcessSectionEntry>> {
return self.impl_map_module_section(module_name);
}
/// Retrieve the PTE memory info map.
///
/// For additional information see the [`VmmProcessMapPteEntry`] struct.
///
/// # Examples
/// ```
/// if let Ok(pte_all) = vmmprocess.map_pte(true) {
/// println!("Number of pte entries: {}.", pte_all.len());
/// for pte in &*pte_all {
/// let s = if pte.is_s { 's' } else { '-' };
/// let r = if pte.is_r { 'r' } else { '-' };
/// let w = if pte.is_w { 'w' } else { '-' };
/// let x = if pte.is_x { 'x' } else { '-' };
/// println!("{pte} :: {s}{r}{w}{x} :: {}", pte.info);
/// }
/// }
/// ```
pub fn map_pte(&self, is_identify_modules : bool) -> ResultEx<Vec<VmmProcessMapPteEntry>> {
return self.impl_map_pte(is_identify_modules);
}
/// Retrieve the thread info map.
///
/// For additional information see the [`VmmProcessMapThreadEntry`] struct.
///
/// # Examples
/// ```
/// if let Ok(thread_all) = vmmprocess.map_thread() {
/// println!("Number of process threads: {}.", thread_all.len());
/// for thread in &*thread_all {
/// println!("{thread}");
/// }
/// }
/// ```
pub fn map_thread(&self) -> ResultEx<Vec<VmmProcessMapThreadEntry>> {
return self.impl_map_thread();
}
/// Retrieve the unloaded module info map.
///
/// For additional information see the [`VmmProcessMapUnloadedModuleEntry`] struct.
///
/// # Examples
/// ```
/// if let Ok(unloaded_all) = vmmprocess.map_unloaded_module() {
/// println!("Number of process unloaded modules: {}.", unloaded_all.len());
/// for unloaded in &*unloaded_all {
/// println!("{unloaded}");
/// }
/// }
/// ```
pub fn map_unloaded_module(&self) -> ResultEx<Vec<VmmProcessMapUnloadedModuleEntry>> {
return self.impl_map_unloaded_module();
}
/// Retrieve the VAD (virtual address descriptor) memory info map.
///
/// For additional information see the [`VmmProcessMapVadEntry`] struct.
///
/// # Examples
/// ```
/// if let Ok(vad_all) = vmmprocess.map_vad(true) {
/// println!("Number of vad entries: {}.", vad_all.len());
/// for vad in &*vad_all {
/// println!("{vad} :: {}", vad.info);
/// }
/// }
/// ```
pub fn map_vad(&self, is_identify_modules : bool) -> ResultEx<Vec<VmmProcessMapVadEntry>> {
return self.impl_map_vad(is_identify_modules);
}
/// Retrieve the extended VAD info map.
///
/// For additional information see the [`VmmProcessMapVadExEntry`] struct.
pub fn map_vadex(&self, offset_pages : u32, count_pages : u32) -> ResultEx<Vec<VmmProcessMapVadExEntry>> {
return self.impl_map_vadex(offset_pages, count_pages);
}
/// Read a contigious virtual memory chunk.
///
/// The virtual memory is read without any special flags. The whole chunk
/// must be read successfully for the method to succeed.
///
/// If deseriable to provide flags modifying the behavior (such as skipping
/// the built-in data cache or slower paging access) use the method
/// `mem_read_ex()` instead.
///
/// Reading many memory chunks individually may be slow, especially if
/// reading takes place using hardware FPGA devices. In that case it's
/// better to use the `mem_scatter()` functionality for better performance.
///
///
/// # Arguments
/// * `va` - Virtual address to start reading from.
/// * `size` - Number of bytes to read.
///
/// # Examples
/// ```
/// // Read 0x100 bytes of data from the base of kernel32.
/// // Example assumes: use pretty_hex::*;
/// if let Ok(data_read) = vmmprocess.mem_read(va_kernel32, 0x100) {
/// println!("{:?}", data_read.hex_dump());
/// }
/// ```
pub fn mem_read(&self, va : u64, size : usize) -> ResultEx<Vec<u8>> {
return self.vmm.impl_mem_read(self.pid, va, size, 0);
}
/// Read a contigious virtual memory chunk with flags.
///
/// Flags are constants named `FLAG_*`
///
/// Reading many memory chunks individually may be slow, especially if
/// reading takes place using hardware FPGA devices. In that case it's
/// better to use the `mem_scatter()` functionality for better performance.
///
///
/// # Arguments
/// * `va` - Virtual address to start reading from.
/// * `size` - Number of bytes to read.
/// * `flags` - Any combination of `FLAG_*`.
///
/// # Examples
/// ```
/// // Read 0x100 bytes of data from the base of kernel32.
/// // Force reading the underlying memory device (skip data cache) and
/// // Zero-Pad if parts of the memory read fail instead of failing.
/// // Example assumes: use pretty_hex::*;
/// let r = vmmprocess.mem_read_ex(va_kernel32, 0x100, FLAG_NOCACHE | FLAG_ZEROPAD_ON_FAIL);
/// let Ok(data_read) = r {
/// println!("{:?}", data_read.hex_dump());
/// }
/// ```
pub fn mem_read_ex(&self, va : u64, size : usize, flags : u64) -> ResultEx<Vec<u8>> {
return self.vmm.impl_mem_read(self.pid, va, size, flags);
}
/// Read a contigious virtual memory chunk with flags as a type/struct.
///
/// Flags are constants named `FLAG_*`
///
/// Reading many memory chunks individually may be slow, especially if
/// reading takes place using hardware FPGA devices. In that case it's
/// better to use the `mem_scatter()` functionality for better performance.
///
///
/// # Arguments
/// * `va` - Virtual address to start reading from.
/// * `flags` - Any combination of `FLAG_*`.
///
/// # Examples
/// ```
/// // Read the C-struct IMAGE_DOS_HEADER from memory.
/// // Force reading the underlying memory device (skip data cache).
/// #[repr(C)]
/// struct IMAGE_DOS_HEADER {
/// e_magic : u16,
/// ...
/// e_lfanew : u32,
/// }
/// if let Ok(doshdr) = vmmprocess.mem_read_as::<IMAGE_DOS_HEADER>(va_kernel32, FLAG_NOCACHE) {
/// println!("e_magic: {:x}", doshdr.e_magic);
/// println!("e_lfanew: {:x}", doshdr.e_lfanew);
/// }
/// ```
pub fn mem_read_as<T>(&self, va : u64, flags : u64) -> ResultEx<T> {
return self.vmm.impl_mem_read_as(self.pid, va, flags);
}
/// Create a scatter memory object for efficient virtual memory reads.
///
/// Check out the [`VmmScatterMemory`] struct for more detailed information.
///
/// # Arguments
/// * `flags` - Any combination of `FLAG_*`.
///
/// # Examples
/// ```
/// let mem_scatter = vmmprocess.mem_scatter(FLAG_NOCACHE | FLAG_ZEROPAD_ON_FAIL)?;
/// ```
pub fn mem_scatter(&self, flags : u64) -> ResultEx<VmmScatterMemory> {
return self.vmm.impl_mem_scatter(self.pid, flags);
}
/// Translate a virtual address to a physical address.
///
/// It's not always possible to translate a virtual address to a physical
/// address. This is the case when memory is "paged out".
///
/// # Arguments
/// * `va` - Virtual address to translate.
///
/// # Examples
/// ```
/// let pa_kernel32 = vmmprocess.mem_virt2phys(va_kernel32)?;
/// ```
pub fn mem_virt2phys(&self, va : u64) -> ResultEx<u64> {
return self.vmm.impl_mem_virt2phys(self.pid, va);
}
/// Write virtual memory.
///
/// The write is a best effort. Even of the write should fail it's not
/// certain that an error will be returned. To be absolutely certain that
/// a write has taken place follow up with a read.
///
/// # Arguments
/// * `va` - Virtual address to start writing from.
/// * `data` - Byte data to write.
///
/// # Examples
/// ```
/// // Write data starting at the base of kernel32 (in the pe header).
/// let data_to_write = [0x56u8, 0x4d, 0x4d, 0x52, 0x55, 0x53, 0x54].to_vec();
/// let _r = vmmprocess.mem_write(va_kernel32, &data_to_write);
/// ```
pub fn mem_write(&self, va : u64, data : &Vec<u8>) -> ResultEx<()> {
return self.vmm.impl_mem_write(self.pid, va, data);
}
/// Write a type/struct to virtual memory.
///
/// The write is a best effort. Even of the write should fail it's not
/// certain that an error will be returned. To be absolutely certain that
/// a write has taken place follow up with a read.
///
/// # Arguments
/// * `va` - Virtual address to start writing from.
/// * `data` - Data to write. In case of a struct repr(C) is recommended.
///
/// # Examples
/// ```
/// // Write data starting at the base of kernel32 (in the pe header).
/// let data_to_write = [0x56, 0x4d, 0x4d, 0x52, 0x55, 0x53, 0x54];
/// let _r = vmmprocess.mem_write_as(va_kernel32, &data_to_write);
/// ```
pub fn mem_write_as<T>(&self, va : u64, data : &T) -> ResultEx<()> {
return self.vmm.impl_mem_write_as(self.pid, va, data);
}
/// Retrieve PDB debugging for the module.
///
/// PDB debugging most often only work on modules by Microsoft.
/// See [`VmmPdb`] documentation for additional information.
///
/// # Arguments
/// * `va_module_base`
///
/// # Examples
/// ```
/// if let Ok(pdb_kernel32) = vmmprocess.pdb_from_module_address(kernel32.va_base) {
/// println!("-> {pdb_kernel32}");
/// }
/// ```
pub fn pdb_from_module_address(&self, va_module_base : u64) -> ResultEx<VmmPdb> {
return self.impl_pdb_from_module_address(va_module_base);
}
/// Retrieve a search struct for process virtual memory.
///
/// NB! This does not start the actual search yet.
///
/// Check out the [`VmmSearch`] struct for more detailed information.
///
///
/// # Arguments
/// * `addr_min` - Start search at this virtual address.
/// * `addr_max` - End the search at this virtual address. 0 is interpreted as u64::MAX.
/// * `num_results_max` - Max number of search hits to search for. Max allowed value is 0x10000.
/// * `flags` - Any combination of `FLAG_*`.
///
///
/// # Examples
/// ```
/// // Retrieve a VmmSearch for the entire virtual memory.
/// let mut search = vmmprocess.search(0, 0, 0x10000, 0)?
/// ```
///
/// ```
/// // Retrieve a VmmSearch for virtual memory. Stop at first hit.
/// // Also avoid using cached and paged out memory.
/// let mut search = vmmprocess.search(0, 0, 1, FLAG_NOCACHE | FLAG_NOPAGING)?
/// ```
pub fn search(&self, addr_min : u64, addr_max : u64, num_results_max : u32, flags : u64) -> ResultEx<VmmSearch> {
return VmmSearch::impl_new(self.vmm, self.pid, addr_min, addr_max, num_results_max, flags);
}
/// Retrieve a yara search struct for process virtual memory.
///
/// NB! This does not start the actual search yet.
///
/// Check out the [`VmmYara`] struct for more detailed information.
///
///
/// # Arguments
/// * `rules` - Yara rules to search for.
/// * `addr_min` - Start yara search at this virtual address.
/// * `addr_max` - End the yara search at this virtual address. 0 is interpreted as u64::MAX.
/// * `num_results_max` - Max number of yara search hits to search for. Max allowed value is 0x10000.
/// * `flags` - Any combination of `FLAG_*`.
///
///
/// # Examples
/// # Examples
/// ```
/// // Retrieve a VmmYara for the entire physical memory.
/// let yara_rule = " rule mz_header { strings: $mz = \"MZ\" condition: $mz at 0 } ";
/// let yara_rules = vec![yara_rule];
/// let mut yara = vmmprocess.search_yara(yara_rules, 0, 0, 0x10000, 0)?
/// ```
///
/// ```
/// // Retrieve a VmmYara for physical memory between 4GB and 8GB.
/// // Also stop at first yara search hit.
/// let yara_rules = vec!["/tmp/my_yara_rule.yar", "/tmp/my_yara_rule2.yar"];
/// let mut yara = vmmprocess.search_yara(yara_rules, 0x100000000, 0x200000000, 1, 0)?
/// ```
pub fn search_yara(&self, rules : Vec<&str>, addr_min : u64, addr_max : u64, num_results_max : u32, flags : u64) -> ResultEx<VmmYara> {
return VmmYara::impl_new(self.vmm, rules, self.pid, addr_min, addr_max, num_results_max, flags);
}
}
/// Registry Hive API.
///
/// The [`VmmRegHive`] info struct allows for access to the registry hive by
/// exposed fields and various methods.
///
/// # Created By
/// - [`vmm.reg_hive_list()`](Vmm::reg_hive_list())
///
/// # Examples
/// ```
/// let hive_all = vmm.reg_hive_list()?;
/// for hive in hive_all {
/// println!("{hive} size={} path={}", hive.size, hive.path);
/// }
/// ```
#[derive(Debug)]
pub struct VmmRegHive<'a> {
vmm : &'a Vmm<'a>,
pub va : u64,
pub va_baseblock : u64,
pub size : u32,
pub name : String,
pub name_short : String,
pub path : String,
}
impl VmmRegHive<'_> {
/// Read registry hive data.
///
/// # Arguments
/// * `ra` - Registry hive address to start reading from.
/// * `size` - The number of bytes to read.
/// * `flags` - Any combination of `FLAG_*`.
///
/// # Examples
/// ```
/// if let Ok(data) = hive.reg_hive_read(0x1000, 0x100, FLAG_NOCACHE | FLAG_ZEROPAD_ON_FAIL) {
/// println!("{:?}", data.hex_dump());
/// }
/// ```
pub fn reg_hive_read(&self, ra : u32, size : usize, flags : u64) -> ResultEx<Vec<u8>> {
return self.impl_reg_hive_read(ra, size, flags);
}
/// Write registry hive data.
///
/// Writing to registry hives is extemely unsafe and may lead to
/// registry corruption and unusable systems. Use with extreme care!
///
/// # Arguments
/// * `ra` - Registry hive address to start writing from.
/// * `data` - Byte data to write.
///
/// # Examples
/// ```
/// let data_to_write = [0x56u8, 0x4d, 0x4d, 0x52, 0x55, 0x53, 0x54].to_vec();
/// let _r = hive.reg_hive_write(0x1000, &data_to_write);
/// ```
pub fn reg_hive_write(&self, ra : u32, data : &Vec<u8>) -> ResultEx<()> {
return self.impl_reg_hive_write(ra, data);
}
}
/// Registry Key API.
///
/// The [`VmmRegKey`] info struct represents a registry key and also have
/// additional access methods for retrieving registry keys and values.
///
/// Registry keys may be addressed either by its full path or by hive address
/// and hive path. Both addressing modes are shown in the examples below.
/// Registry keys are case sensitive.
///
/// # Created By
/// - [`vmm.reg_key()`](Vmm::reg_key())
/// - [`vmmregkey.parent()`](VmmRegKey::parent())
/// - [`vmmregkey.subkeys()`](VmmRegKey::subkeys())
/// - [`vmmregkey.subkeys_map()`](VmmRegKey::subkeys_map())
/// - [`vmmregvalue.parent()`](VmmRegValue::parent())
///
/// # Examples
/// ```
/// // Retrieve a regkey by full path.
/// let regkey = vmm.reg_key("HKLM\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Run")?
/// println!("{regkey");
/// ```
///
/// ```
/// // Retrieve a regkey by hive path.
/// // (SOFTWARE hive example address: 0xffffba061a908000).
/// let regkey = vmm.reg_key("0xffffba061a908000\\ROOT\\Microsoft\\Windows\\CurrentVersion\\Run")?
/// println!("{regkey");
/// ```
#[derive(Debug)]
pub struct VmmRegKey<'a> {
vmm : &'a Vmm<'a>,
/// Key name.
pub name : String,
/// Path including key name.
pub path : String,
/// Last write timestamp in Windows filetime format.
pub ft_last_write : u64,
}
impl VmmRegKey<'_> {
/// Retrieve the parent registry key of this registry key.
///
/// # Examples
/// ```
/// let regkey_parent = regkey.parent()?
/// println!("{regkey_parent");
/// ```
pub fn parent(&self) -> ResultEx<VmmRegKey> {
return self.impl_parent();
}
/// Retrieve the registry subkeys of this registry key
///
/// # Examples
/// ```
/// // Retrieve all registry subkeys (as Vec).
/// let subkeys = regkey.subkeys()?
/// for key in subkeys {
/// println!("{key}")
/// }
/// ```
pub fn subkeys(&self) -> ResultEx<Vec<VmmRegKey>> {
return self.impl_subkeys();
}
/// Retrieve the registry subkeys of this registry key as a map
///
/// K: String key name,
/// V: VmmRegKey
///
/// # Examples
/// ```
/// // Retrieve all registry subkeys (as HashMap).
/// let subkeys = regkey.subkeys_map()?
/// for e in subkeys {
/// println!("{},{}", e.0, e.1)
/// }
/// ```
pub fn subkeys_map(&self) -> ResultEx<HashMap<String, VmmRegKey>> {
return Ok(self.impl_subkeys()?.into_iter().map(|s| (s.name.clone(), s)).collect());
}
/// Retrieve the registry values of this registry key
///
/// # Examples
/// ```
/// // Retrieve all registry values (as Vec).
/// let values = regkey.values()?
/// for value in values {
/// println!("{value}")
/// }
/// ```
pub fn values(&self) -> ResultEx<Vec<VmmRegValue>> {
return self.impl_values();
}
/// Retrieve the registry values of this registry key as a map
///
/// K: String value name,
/// V: VmmRegValue
///
/// # Examples
/// ```
/// // Retrieve all registry values (as HashMap).
/// let values = regkey.values_map()?
/// for e in values {
/// println!("{},{}", e.0, e.1)
/// }
/// ```
pub fn values_map(&self) -> ResultEx<HashMap<String, VmmRegValue>> {
return Ok(self.impl_values()?.into_iter().map(|s| (s.name.clone(), s)).collect());
}
}
#[allow(non_camel_case_types)]
pub enum VmmRegValueType {
REG_NONE,
REG_SZ(String),
REG_EXPAND_SZ(String),
REG_BINARY(Vec<u8>),
REG_DWORD(u32),
REG_DWORD_BIG_ENDIAN(u32),
REG_LINK(String),
REG_MULTI_SZ(Vec<String>),
REG_RESOURCE_LIST(Vec<u8>),
REG_FULL_RESOURCE_DESCRIPTOR(Vec<u8>),
REG_RESOURCE_REQUIREMENTS_LIST(Vec<u8>),
REG_QWORD(u64),
}
/// Registry Value API.
///
/// The [`VmmRegValue`] info struct represents a registry value and also have
/// additional access methods for parent key and the value itself.
///
/// Registry values may be addressed either by its full path or by hive address
/// and hive path. Both addressing modes are shown in the examples below.
/// Registry values are case sensitive.
///
/// # Created By
/// - [`vmm.reg_value()`](Vmm::reg_value())
/// - [`vmmregkey.values()`](VmmRegKey::values())
/// - [`vmmregkey.values_map()`](VmmRegKey::values_map())
///
/// # Examples
/// ```
/// // Retrieve a REG_SZ (string) reg value by its full path.
/// let regpath = "HKLM\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\ProgramFilesDir";
/// let regvalue = vmm.reg_key(regpath)?
/// println!("{regvalue}");
/// if let Ok(VmmRegValueType::REG_SZ(s)) = regvalue.value() {
/// println!("REG_SZ: {s}");
/// }
/// ```
///
/// ```
/// // Retrieve a REG_DWORD reg value using the hive path.
/// // (SOFTWARE hive example address: 0xffffba061a908000).
/// let regpath = "0xffffba061a908000\\ROOT\\Microsoft\\.NETFramework\\Enable64Bit";
/// let regvalue = vmm.reg_key(regpath)?
/// if let Ok(VmmRegValueType::REG_DWORD(dw)) = regvalue.value() {
/// println!("REG_DWORD: 0x{:08x}", dw);
/// }
/// ```
#[derive(Debug)]
pub struct VmmRegValue<'a> {
vmm : &'a Vmm<'a>,
/// Value name.
pub name : String,
/// Path including key name.
pub path : String,
/// The raw type as specified by Windows REG_* constants.
pub raw_type : u32,
/// The raw data size in bytes.
pub raw_size : u32,
raw_value : Option<Vec<u8>>,
}
impl VmmRegValue<'_> {
/// Retrieve the parent registry key.
///
/// # Examples
/// ```
/// let regkey_parent = regvalue.parent()?
/// println!("{regkey_parent");
/// ```
pub fn parent(&self) -> ResultEx<VmmRegKey> {
return self.impl_parent();
}
/// Retrieve the registry value.
///
/// The registry value is returned as [`VmmRegValueType`] enum containing
/// the relevant embedded value.
///
///
/// # Examples
/// ```
/// // Retrieve a REG_SZ (string) reg value.
/// if let Ok(VmmRegValueType::REG_SZ(s)) = regvalue.value() {
/// println!("REG_SZ: {s}");
/// }
/// ```
///
/// ```
/// // Retrieve a REG_DWORD reg value.
/// if let Ok(VmmRegValueType::REG_DWORD(dw)) = regvalue.value() {
/// println!("REG_DWORD: 0x{:08x}", dw);
/// }
/// ```
pub fn value(&self) -> ResultEx<VmmRegValueType> {
return self.impl_value();
}
/// Retrieve the raw value bytes backing the actual value.
///
/// # Examples
/// ```
/// let raw_value = vmmregvalue.raw_value()?;
/// println!("{:?}", raw_value.hex_dump());
/// ```
pub fn raw_value(&self) -> ResultEx<Vec<u8>> {
return self.impl_raw_value();
}
}
/// Search API.
///
/// Search for binary keywords in physical or virtual memory.
///
/// Each keyword/term may be up to 32 bytes long. Up to 16 search terms may
/// be used in the same search.
///
/// The search may optionally take place with a skipmask - i.e. a bitmask in
/// which '1' would equal a wildcard bit.
///
/// The [`VmmSearch`] must be used as mut. Also see [`VmmSearchResult`].
///
/// The synchronous search workflow:
/// 1) Acquire search object from `vmm.search()` or `vmmprocess.search()`.
/// 2) Add 1-16 different search terms using `vmmsearch.add_search()` and/or
/// `vmmsearch.add_search_ex()`.
/// 3) Start the search and retrieve result (blocking) by calling
/// `vmmsearch.result()`.
///
/// The asynchronous search workflow:
/// 1) Acquire search object from `vmm.search()` or `vmmprocess.search()`.
/// 2) Add 1-16 different search terms using `vmmsearch.add_search()` and/or
/// `vmmsearch.add_search_ex()`.
/// 3) Start the search in the background using `vmmsearch.start()`.
/// 4) Optionally abort the search with `vmmsearch.abort()`.
/// 5) Optionally poll status or result (if completed) using `vmmsearch.poll()`.
/// 6) Optionally retrieve result (blocking) by calling `vmmsearch.result()`.
/// 7) Search goes out of scope and is cleaned up. Any on-going searches may
/// take a short while to terminate gracefully.
///
///
/// # Created By
/// - [`vmm.search()`](Vmm::search())
/// - [`vmmprocess.search()`](VmmProcess::search())
///
/// # Examples
/// ```
/// // Fetch search struct for entire process virtual address space.
/// // Max 256 search hits and avoid using the cache in this example.
/// let mut vmmsearch = vmmprocess.search(0, 0, 256, FLAG_NOCACHE);
/// // Search for 'MZ' - i.e. start at PE file at even 0x1000 alignment.
/// let search_term = ['M' as u8, 'Z' as u8];
/// let _search_term_id = vmmsearch.add_search_ex(&search_term, None, 0x1000);
/// // Start search in async mode.
/// vmmsearch.start();
/// // Search is now running - it's possible to do other actions here.
/// // It's possible to poll() to see current progress (or if finished).
/// // It's possible to abort() to stop search.
/// // It's possible to fetch result() which will block until search is finished.
/// let search_result = vmmsearch.result();
/// ```
#[derive(Debug)]
pub struct VmmSearch<'a> {
vmm : &'a Vmm<'a>,
pid : u32,
is_started : bool,
is_completed : bool,
is_completed_success : bool,
native_search : CVMMDLL_MEM_SEARCH_CONTEXT,
thread : Option<std::thread::JoinHandle<bool>>,
result : Vec<(u64, u32)>,
}
/// Info: Search Progress/Result.
///
/// Also see [`VmmSearch`].
///
/// # Created By
/// - [`vmmsearch.poll()`](VmmSearch::poll())
/// - [`vmmsearch.result()`](VmmSearch::result())
///
/// # Examples
/// ```
/// // Retrieve a search progress/result in a non-blocking call.
/// let searchresult = vmmsearch.poll();
/// ```
///
/// ```
/// // Retrieve a search result in a blocking call (until completed search).
/// let searchresult = vmmsearch.result();
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmSearchResult {
/// Indicates that the search has been started. i.e. start() or result() have been called.
pub is_started : bool,
/// Indicates that the search has been completed.
pub is_completed : bool,
/// If is_completed is true this indicates if the search was completed successfully.
pub is_completed_success : bool,
/// Address to start searching from - default 0.
pub addr_min : u64,
/// Address to stop searching at - default u64::MAX.
pub addr_max : u64,
/// Current address being searched in search thread.
pub addr_current : u64,
/// Number of bytes that have been procssed in search.
pub total_read_bytes : u64,
/// Number of search results.
pub total_results : u32,
/// The actual result. result.0 = address, result.1 = search_term_id.
pub result : Vec<(u64, u32)>,
}
impl VmmSearch<'_> {
/// Add a search term.
///
/// The search will later be performed using the whole search term and
/// without alignment requirements (align = 1 byte).
///
/// On success the `search_term_id` will be returned. This is the 2nd
/// field (`searchresulttuple.1`) in the search result tuple. This may be
/// useful if multiple searches are undertaken in one single search run.
///
/// # Arguments
/// * `search_bytes` - Byte data to search for. Max 32 bytes.
///
/// # Examples
/// ```
/// // add a search term for pointer references to address 0x7ffcec973308.
/// let search_term = [0x08, 0x33, 0x97, 0xec, 0xfc, 0x7f, 0x00, 0x00];
/// let search_term_id = vmmsearch.add_search(&search_term)?;
/// ```
pub fn add_search(&mut self, search_bytes : &[u8]) -> ResultEx<u32> {
return self.impl_add_search(search_bytes, None, 1);
}
/// Add a search term.
///
/// The search will later be performed using the search term with the
/// given alignment (typically 1, 2, 4, 8, 16, .. 0x1000) and an optional
/// skip bitmask in which bit '1' represents a search wildcard value.
///
/// On success the `search_term_id` will be returned. This is the 2nd
/// field (`searchresulttuple.1`) in the search result tuple. This may be
/// useful if multiple searches are undertaken in one single search run.
///
/// # Arguments
/// * `search_bytes` - Byte data to search for. Max 32 bytes.
/// * `search_skipmask` - Optional skipmask (see above). Max search_bytes.len().
/// * `byte_align` - Byte alignment (see above).
///
/// # Examples
/// ```
/// // Add a search term for pointer references to address 0x7ffcec973308.
/// // Pointers are 64-bit/8-byte aligned hence the 8-byte alignment.
/// let search_term = [0x08, 0x33, 0x97, 0xec, 0xfc, 0x7f, 0x00, 0x00];
/// let search_term_id = vmmsearch.add_search_ex(&search_term, None, 8)?;
/// ```
pub fn add_search_ex(&mut self, search_bytes : &[u8], search_skipmask : Option<&[u8]>, byte_align : u32) -> ResultEx<u32> {
return self.impl_add_search(search_bytes, search_skipmask, byte_align);
}
/// Start a search in asynchronous background thread.
///
/// This is useful since the search may take some time and other work may
/// be done while waiting for the result.
///
/// The search will start immediately and the progress (and result, if
/// finished) may be polled by calling [`poll()`](VmmSearch::poll()).
///
/// The result may be retrieved by a call to `poll()` or by a blocking
/// call to [`result()`](VmmSearch::result()) which will return when the
/// search is completed.
///
/// # Examples
/// ```
/// vmmsearch.start();
/// ```
pub fn start(&mut self) {
self.impl_start();
}
/// Abort an on-going search.
///
/// # Examples
/// ```
/// vmmsearch.abort();
/// ```
pub fn abort(&mut self) {
self.impl_abort();
}
/// Poll an on-going search for the status/result.
///
/// Also see [`VmmSearch`] and [`VmmSearchResult`].
///
/// # Examples
/// ```
/// let search_status_and_result = vmmsearch.poll();
/// ```
pub fn poll(&mut self) -> VmmSearchResult {
return self.impl_poll();
}
/// Retrieve the search result.
///
/// If the search haven't yet been started it will be started.
/// The function is blocking and will wait for the search to complete
/// before the search results are returned.
///
/// Also see [`VmmSearch`] and [`VmmSearchResult`].
///
/// # Examples
/// ```
/// let search_status_and_result = vmmsearch.result();
/// ```
pub fn result(&mut self) -> VmmSearchResult {
return self.impl_result();
}
}
/// Yara Search API.
///
/// Search for yara signatures in physical or virtual memory.
///
/// Yara rules may be in either the form of:
/// - one (1) compiled yara rules file.
/// - multiple yara source rules files.
/// - multiple yara source rules strings.
///
/// The [`VmmYara`] must be used as mut. Also see [`VmmYaraResult`].
///
/// The synchronous search workflow:
/// 1) Acquire search object from `vmm.search_yara()` or `vmmprocess.search_yara()`.
/// 2) Start the search and retrieve result (blocking) by calling `vmmyara.result()`.
///
/// The asynchronous search workflow:
/// 1) Acquire search object from `vmm.search_yara()` or `vmmprocess.search_yara()`.
/// 2) Start the search in the background using `vmmyara.start()`.
/// 3) Optionally abort the search with `vmmyara.abort()`.
/// 4) Optionally poll status or result (if completed) using `vmmyara.poll()`.
/// 5) Optionally retrieve result (blocking) by calling `vmmyara.result()`.
/// 6) Yara Search goes out of scope and is cleaned up. Any on-going searches
/// may take a short while to terminate gracefully.
///
///
/// # Created By
/// - [`vmm.search_yara()`](Vmm::search_yara())
/// - [`vmmprocess.search_yara()`](VmmProcess::search_yara())
///
/// # Examples
/// ```
/// // Fetch yara search struct for entire process virtual address space.
/// // Max 256 search hits and avoid using the cache in this example.
/// let yara_rule = " rule mz_header { strings: $mz = \"MZ\" condition: $mz at 0 } ";
/// let yara_rules = vec![yara_rule];
/// let mut vmmyara = vmmprocess.search_yara(yara_rules, 0, 0, 256, FLAG_NOCACHE);
/// // Start search in async mode.
/// vmmyara.start();
/// // Search is now running - it's possible to do other actions here.
/// // It's possible to poll() to see current progress (or if finished).
/// // It's possible to abort() to stop search.
/// // It's possible to fetch result() which will block until search is finished.
/// let yara_result = vmmyara.result();
/// ```
#[derive(Debug)]
pub struct VmmYara<'a> {
vmm : &'a Vmm<'a>,
pid : u32,
is_started : bool,
is_completed : bool,
is_completed_success : bool,
native : CVMMDLL_YARA_CONFIG,
_native_args_rules : Vec<CString>,
_native_argv_rules : Vec<*const c_char>,
thread : Option<std::thread::JoinHandle<bool>>,
result : Vec<VmmYaraMatch>,
}
/// Info: Yara search Progress/Result.
///
/// Also see [`VmmYara`].
///
///
/// # Created By
/// - [`vmmyara.poll()`](VmmYara::poll())
/// - [`vmmyara.result()`](VmmYara::result())
///
/// # Examples
/// ```
/// // Retrieve a search progress/result in a non-blocking call.
/// let yararesult = vmmyara.poll();
/// ```
///
/// ```
/// // Retrieve a search result in a blocking call (until completed search).
/// let yararesult = vmmyara.result();
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmYaraResult {
/// Indicates that the yara search has been completed.
pub is_completed : bool,
/// If is_completed is true this indicates if the search was completed successfully.
pub is_completed_success : bool,
/// Address to start searching from - default 0.
pub addr_min : u64,
/// Address to stop searching at - default u64::MAX.
pub addr_max : u64,
/// Current address being searched in search thread.
pub addr_current : u64,
/// Number of bytes that have been procssed in search.
pub total_read_bytes : u64,
/// Number of search results.
pub total_results : u32,
/// The actual result containing the yara matches.
pub result : Vec<VmmYaraMatch>,
}
/// Info: Yara search match string.
///
/// Also see [`VmmYara`] and [`VmmYaraResult`].
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmYaraMatchString {
/// yara match string identifier.
pub match_string : String,
/// yara match addresses.
pub addresses : Vec<u64>,
}
/// Info: Yara search match.
///
/// Also see [`VmmYara`] and [`VmmYaraResult`].
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmYaraMatch {
/// yara match memory region base address.
pub addr : u64,
/// yara rule identifier.
pub rule : String,
/// yara rule tags.
pub tags : Vec<String>,
/// yara rule meta data - key/value pairs.
pub meta : Vec<(String, String)>,
/// yara match strings.
pub match_strings : Vec<VmmYaraMatchString>,
}
impl VmmYara<'_> {
/// Start a yara search in asynchronous background thread.
///
/// This is useful since the yara search may take some time and other work
/// may be done while waiting for the result.
///
/// The search will start immediately and the progress (and result, if
/// finished) may be polled by calling [`poll()`](VmmYara::poll()).
///
/// The result may be retrieved by a call to `poll()` or by a blocking
/// call to [`result()`](VmmSearch::result()) which will return when the
/// search is completed.
///
/// # Examples
/// ```
/// vmmyara.start();
/// ```
pub fn start(&mut self) {
self.impl_start();
}
/// Abort an on-going yara search.
///
/// # Examples
/// ```
/// vmmyara.abort();
/// ```
pub fn abort(&mut self) {
self.impl_abort();
}
/// Poll an on-going yara search for the status/result.
///
/// Also see [`VmmYara`] and [`VmmYaraResult`].
///
/// # Examples
/// ```
/// let yara_status_and_result = vmmyara.poll();
/// ```
pub fn poll(&mut self) -> VmmYaraResult {
return self.impl_poll();
}
/// Retrieve the yara search result.
///
/// The function is blocking and will wait for the search to complete
/// before the results are returned.
///
/// Also see [`VmmYara`] and [`VmmYaraResult`].
///
/// # Examples
/// ```
/// let yara_status_and_result = vmmyara.result();
/// ```
pub fn result(&mut self) -> VmmYaraResult {
return self.impl_result();
}
}
/// Initialize plugin information and initialization context.
///
/// This should usually be the first call in a `InitializeVmmPlugin()` export.
///
/// See the plugin example for additional documentation.
pub fn new_plugin_initialization<T>(native_h : usize, native_reginfo : usize) -> ResultEx<(VmmPluginInitializationInfo, VmmPluginInitializationContext<T>)> {
return impl_new_plugin_initialization::<T>(native_h, native_reginfo);
}
/// Plugin Context: Supplied by MemProcFS to plugin callback functions.
///
/// Contains the `vmm` field which gives access to the general API.
///
/// Contains the `ctxlock` field which gives access to the user-defined generic
/// struct set at plugin initialization.
///
/// The `ctxlock` field is a `std::sync::RwLock` and the inner user-defined
/// generic struct may be accessed in either multi-threaded read-mode or
/// single-threaded mutable write-mode. Read mode is more efficient.
///
/// See the plugin example for additional use cases and documentation.
///
///
/// # Created By
/// - `plugin sub-system`
///
///
/// # Examples
///
/// ```
/// // Access the `vmm` field to retrieve a process for pid 768.
/// // Some `vmm` calls such as `vmm.process(pid)` may fail. In this case if
/// // the process does not exist. It is recommended to handle these errors
/// // gracefully as per below.
/// if let Ok(systemprocess) = plugin_ctx.vmm.process(768) {
/// // ...
/// }
/// ```
///
/// ```
/// // Access the `vmm` field to retrieve a process for pid 768.
/// // Some `vmm` calls such as `vmm.process(pid)` may fail. It is possible to
/// // use error propagation for simplicity. Errors will be handled by upper
/// // plugin layers. If this is preferred error propagation may be simpler.
/// let systemprocess = plugin_ctx.vmm.process(768)?;
/// ```
///
/// ```
/// // Access the ctxlock in multi-threaded read-mode:
/// // The lock should always contain a generic so unwrap() should be safe.
/// let user_ctx = plugin_ctx.ctxlock.read().unwrap();
/// ```
///
/// ```
/// // Access the ctxlock in single-threaded mutable write-mode:
/// // The lock should always contain a generic so unwrap() should be safe.
/// let mut user_ctx = plugin_ctx.ctxlock.write().unwrap();
/// ```
///
///
/// See the plugin example about usage of the ctxlock field.
pub struct VmmPluginContext<'a, T> {
/// Access the general MemProcFS API through the `vmm` field.
pub vmm : Vmm<'a>,
/// Access generic user-set plugin context in a thread-safe way.
pub ctxlock : std::sync::RwLock<T>,
fn_list : Option<fn(ctxp : &VmmPluginContext<T>, process : Option<VmmProcess>, path : &str, file_list : &VmmPluginFileList) -> ResultEx<()>>,
fn_read : Option<fn(ctxp : &VmmPluginContext<T>, process : Option<VmmProcess>, file_name : &str, cb : u32, cb_offset : u64) -> ResultEx<Vec<u8>>>,
fn_write : Option<fn(ctxp : &VmmPluginContext<T>, process : Option<VmmProcess>, file_name : &str, data : Vec<u8>, cb_offset : u64) -> ResultEx<()>>,
fn_visible : Option<fn(ctxp : &VmmPluginContext<T>, process : Option<VmmProcess>) -> ResultEx<bool>>,
fn_notify : Option<fn(ctxp : &VmmPluginContext<T>, event_id : u32) -> ResultEx<()>>,
}
/// Plugin File List: Supplied by MemProcFS to plugin list callback function.
///
/// The `VmmPluginFileList` struct contains the methods `add_file()` and
/// `add_directory()` which will allow the plugin list callback function
/// to populate files & directories given the specified path and process.
///
/// # Created By
/// - `plugin sub-system`
#[derive(Debug)]
pub struct VmmPluginFileList<'a> {
vmm : &'a Vmm<'a>,
h_file_list : usize,
}
impl VmmPluginFileList<'_> {
/// Add a file to the plugin directory indicated by path and process.
///
/// For additional information check the `plugin_list_cb()` function in the
/// plugin example project.
///
/// # Examples
///
/// ```
/// // Add a directory named readme.txt with size 4kB to the plugin path.
/// file_list.impl_add_file("readme.txt", 4096);
/// ```
pub fn add_file(&self, name : &str, size : u64) {
self.impl_add_file(name, size);
}
/// Add a directory to the plugin directory indicated by path and process.
///
/// For additional information check the `plugin_list_cb()` function in the
/// plugin example project.
///
/// # Examples
///
/// ```
/// // Add a directory named subdir33 to the plugin path.
/// file_list.add_directory("subdir33");
/// ```
pub fn add_directory(&self, name : &str) {
self.impl_add_directory(name);
}
}
/// Plugin Initialization System Information.
///
/// The `VmmPluginInitializationInfo` is used in the plugin module entry point
/// (the exported `InitializeVmmPlugin()` function).
///
/// The `InitializeVmmPlugin()` function must be fast for the user experience
/// and the initialization function may query this info struct to decide if
/// the current system is supported or not before registering the plugin.
///
/// Contains information about the: system type, memory model and OS version
/// (in the form of build, major and minor).
///
/// For additional information check the `InitializeVmmPlugin()` function in
/// the plugin example project.
///
///
/// # Created By
/// - [`new_plugin_initialization()`]
///
///
/// # Examples
///
/// ```
/// // Retrieve the system_info and plugin_init_ctx in InitializeVmmPlugin()
/// let (system_info, mut plugin_init_ctx) = match new_plugin_initialization::<PluginContext>(native_h, native_reginfo) {
/// Ok(r) => r,
/// Err(_) => return,
/// };
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VmmPluginInitializationInfo {
/// The system type - i.e. 32-bit or 64-bit Windows.
pub tp_system : VmmSystemType,
/// The memory model type - i.e. X86, X86PAE, X64.
pub tp_memorymodel : VmmMemoryModelType,
/// The OS major version. Use version_build instead if possible.
pub version_major : u32,
/// The OS minor version. Use version_build instead if possible.
pub version_minor : u32,
/// The build version number.
pub version_build : u32,
}
/// Plugin Initialization Context.
///
/// The `VmmPluginInitializationContext` is used in the plugin module entry
/// point (the exported `InitializeVmmPlugin()` function).
///
/// The context is to be populated by the user with information such as name,
/// callback functions and plugin visibility.
///
/// The flow usually follows the below structure:
///
/// 1: Call: memprocfs::new_plugin_initialization(native_h, native_reginfo) to
/// create the plugin init context inside the InitializeVmmPlugin() function.
///
/// 2: Fill out the required ctx and path_name struct members.
///
/// 3: Fill out the module type in the is* struct members.
///
/// 4: Fill out the optional pfn* callback functions.
///
/// 5: Register the plugin with the VMM by calling the register() method.
///
/// For additional information check the `InitializeVmmPlugin()` function in
/// the plugin example project.
///
///
/// # Created By
/// - [`new_plugin_initialization()`]
///
///
/// # Examples
///
/// ```
/// // Retrieve the system_info and plugin_init_ctx in InitializeVmmPlugin()
/// let (system_info, mut plugin_init_ctx) = match new_plugin_initialization::<PluginContext>(native_h, native_reginfo) {
/// Ok(r) => r,
/// Err(_) => return,
/// };
/// // set plugin name:
/// plugin_init_ctx.path_name = String::from("/rust/example");
/// // Set user-defined generic plugin context:
/// let ctx = PluginContext {
/// ...
/// };
/// plugin_init_ctx.ctx = Some(ctx);
/// // Set visiblity:
/// plugin_init_ctx.is_root_module = true;
/// plugin_init_ctx.is_process_module = true;
/// // Set callback functions:
/// plugin_init_ctx.fn_list = Some(plugin_list_cb);
/// plugin_init_ctx.fn_read = Some(plugin_read_cb);
/// plugin_init_ctx.fn_write = Some(plugin_write_cb);
/// // Register the plugin with the MemProcFS plugin manager:
/// let _r = plugin_init_ctx.register();
/// ```
pub struct VmmPluginInitializationContext<T> {
h_vmm : usize,
h_reginfo : usize,
/// user-defined generic plugin context.
pub ctx : Option<T>,
/// Plugin path and name.
pub path_name : String,
/// Plugin shows up in the file system root.
pub is_root_module : bool,
/// Plugin is hidden in the file system root.
pub is_root_module_hidden : bool,
/// Plugin shows up on a per-process basis.
pub is_process_module : bool,
/// Plugin is hidden on a per-process basis.
pub is_process_module_hidden : bool,
/// Callback function - VFS list directory. This callback used in most cases.
pub fn_list : Option<fn(ctxp : &VmmPluginContext<T>, process : Option<VmmProcess>, path : &str, file_list : &VmmPluginFileList) -> ResultEx<()>>,
/// Callback function - VFS read file. This callback is used in most cases.
pub fn_read : Option<fn(ctxp : &VmmPluginContext<T>, process : Option<VmmProcess>, file_name : &str, cb : u32, cb_offset : u64) -> ResultEx<Vec<u8>>>,
/// Callback function - VFS write file.
pub fn_write : Option<fn(ctxp : &VmmPluginContext<T>, process : Option<VmmProcess>, file_name : &str, data : Vec<u8>, cb_offset : u64) -> ResultEx<()>>,
/// Callback function - plugin dynamic visiblity. This callback is rarely used, and in special circumstances only.
pub fn_visible : Option<fn(ctxp : &VmmPluginContext<T>, process : Option<VmmProcess>) -> ResultEx<bool>>,
/// Callback function - notification on an event defined by: `PLUGIN_NOTIFY_*` constants.
pub fn_notify : Option<fn(ctxp : &VmmPluginContext<T>, event_id : u32) -> ResultEx<()>>,
}
impl<T> VmmPluginInitializationContext<T> {
/// Register the plugin with the MemProcFS plugin sub-system.
///
/// The initialiation context may not be used after the `register()` call.
///
/// It is possible to register additional plugins in the same plugin
/// initialization function if a new `VmmPluginInitializationContext`
/// is retrieved from the `new_plugin_initialization()` function.
///
/// # Examples
///
/// ```
/// // Register the plugin with MemProcFS. This will consume the context
/// // which should not be possible to use after this.
/// let _r = plugin_init_ctx.register();
/// ```
///
pub fn register(self) -> ResultEx<()> {
return self.impl_register();
}
}
//=============================================================================
// LEECHCORE API:
//=============================================================================
/// <b>LeechCore API Base Struct.</b>
///
/// The [`LeechCore`] struct is the base of the low-level physical memory
/// aqusition API used by MemProcFS / [`Vmm`]. Normally it is not required
/// to interact with this low-level library.
///
/// One may however wish to use specialized functionality such as sending and
/// receiving raw PCIe TLPs (if the FPGA backend is in use), or to implement a
/// device PCIe BAR.
///
/// The [`LeechCore`] struct acts as a wrapper around the native LeechCore API.
///
/// <b>Check out the example project for more detailed API usage and
/// additional examples!</b>
///
///
/// # Created By
/// - [`LeechCore::new()`]
/// - [`LeechCore::new_ex()`]
/// - [`Vmm::get_leechcore()`]
///
/// # Examples
///
/// ```
/// // Create a new LeechCore instance:
/// let lc = LeechCore::new('fpga://algo=0', LeechCore::LC_CONFIG_PRINTF_ENABLED)?;
/// ```
///
/// ```
/// // Fetch an existing LeechCore instance from a Vmm instance:
/// let lc = vmm.get_leechcore()?;
/// ```
#[derive(Debug)]
pub struct LeechCore {
native : LcNative,
}
/// PCIe BAR info struct.
///
/// # Created By
/// - [`LeechCore::get_bars()`]
/// - LeechCore PCIe BAR callback.
/// ```
#[derive(Clone, Copy, Debug, Default)]
pub struct LcBar {
/// BAR is valid.
pub is_valid : bool,
/// BAR is I/O.
pub is_io : bool,
/// BAR is 64-bit.
pub is_64bit : bool,
/// BAR is prefetchable.
pub is_prefetchable : bool,
/// BAR index (0-5).
pub bar_index : u32,
/// BAR physical base address.
pub pa : u64,
/// BAR size in bytes.
pub cb : u64,
}
/// PCIe BAR request struct.
///
/// # Created By
/// - LeechCore PCIe BAR callback.
/// ```
#[derive(Debug)]
pub struct LcBarRequest {
native : *mut LC_BAR_REQUEST,
/// The PCIe BAR which this request is for.
pub bar : LcBar,
/// PCIe TLP packet tag.
pub tag : u8,
/// first byte-enable.
pub be_first : u8,
/// last byte-enable.
pub be_last : u8,
/// is a 64-bit request.
pub is_64bit : bool,
/// is a read request.
pub is_read : bool,
/// is a write request.
pub is_write : bool,
/// data size in bytes.
pub data_size : u32,
/// data byte offset within the BAR.
pub data_offset : u64,
/// data to write (if a write request).
pub data_write : Option<Vec<u8>>,
}
/// PCIe BAR Context: Supplied by LeechCore to the BAR callback function.
///
/// Contains the `lc` field which gives access to the general API.
///
/// Contains the `ctxlock` field which gives access to the user-defined generic
/// struct set at plugin initialization.
///
/// The `ctxlock` field is a `std::sync::RwLock` and the inner user-defined
/// generic struct may be accessed in either multi-threaded read-mode or
/// single-threaded mutable write-mode. Read mode is more efficient.
///
/// See the plugin example for additional use cases and documentation.
///
/// Only one BAR callback may be active at a given time for a given native
/// LeechCore instance. Previous instances will become inactive if a new
/// one is started. To inactivate a callback drop the context.
///
///
/// # Created By
/// - `LeechCore::pcie_bar_callback()`
///
pub struct LcBarContext<'a, T> {
/// Access the general LeechCore API through the `lc` field.
pub lc : &'a LeechCore,
/// Access generic user-set plugin context in a thread-safe way.
pub ctxlock : std::sync::RwLock<T>,
fn_callback : fn(ctx : &LcBarContext<T>, req : &LcBarRequest) -> ResultEx<()>,
native_ctx : usize,
}
/// PCIe BAR wrapper context - returned to the caller of the BAR enable function.
pub struct LcBarContextWrap<'a, T> {
/// Access to the underlying context.
pub ctx : &'a LcBarContext::<'a, T>,
native : *mut LcBarContext::<'a, T>,
}
/// PCIe TLP Context: Supplied by LeechCore to the TLP callback function.
///
/// Contains the `lc` field which gives access to the general API.
///
/// Contains the `ctxlock` field which gives access to the user-defined generic
/// struct set at plugin initialization.
///
/// The `ctxlock` field is a `std::sync::RwLock` and the inner user-defined
/// generic struct may be accessed in either multi-threaded read-mode or
/// single-threaded mutable write-mode. Read mode is more efficient.
///
/// See the plugin example for additional use cases and documentation.
///
/// Only one TLP callback may be active at a given time for a given native
/// LeechCore instance. Previous instances will become inactive if a new
/// one is started. To inactivate a callback drop the context.
///
///
/// # Created By
/// - `LeechCore::pcie_tlp_callback()`
///
pub struct LcTlpContext<'a, T> {
/// Access the general LeechCore API through the `lc` field.
pub lc : &'a LeechCore,
/// Access generic user-set plugin context in a thread-safe way.
pub ctxlock : std::sync::RwLock<T>,
fn_callback : fn(ctx : &LcTlpContext<T>, tlp : &[u8], tlp_str : &str) -> ResultEx<()>,
native_ctx : usize,
}
/// PCIe TLP wrapper context - returned to the caller of the TLP enable function.
pub struct LcTlpContextWrap<'a, T> {
/// Access to the underlying context.
pub ctx : &'a LcTlpContext::<'a, T>,
native : *mut LcTlpContext::<'a, T>,
}
impl LeechCore {
/// LeechCore configuration struct version.
pub const LC_CONFIG_VERSION : u32 = 0xc0fd0002;
/// No printf verbosity.
pub const LC_CONFIG_PRINTF_NONE : u32 = 0x00000000;
/// Printf verbosity: standard.
pub const LC_CONFIG_PRINTF_ENABLED : u32 = 0x00000001;
/// Printf verbosity: verbose.
pub const LC_CONFIG_PRINTF_V : u32 = 0x00000002;
/// Printf verbosity: extra verbose.
pub const LC_CONFIG_PRINTF_VV : u32 = 0x00000004;
/// Printf verbosity: extra extra verbose (TLP).
pub const LC_CONFIG_PRINTF_VVV : u32 = 0x00000008;
/// LeechCore initialization function.
///
/// The [`LeechCore`] is the base of the low-level physical memory
/// aqusition API used by MemProcFS / [`Vmm`]. Normally it is not required
/// to interact with this low-level library.
///
/// One may however wish to use specialized functionality such as sending and
/// receiving raw PCIe TLPs (if the FPGA backend is in use), or to implement a
/// device PCIe BAR.
///
/// # Arguments
/// * `lc_lib_path` - Full path to the native leechcore library - i.e. `leechcore.dll` or `leechcore.so`.
/// * `device_config` - Leechcore device connection string, i.e. `fpga://algo=0`.
/// * `lc_config_printf_verbosity` - Leechcore printf verbosity level as a combination of `LeechCore::LC_CONFIG_PRINTF_*` values.
///
/// Information about supported memory acqusition methods may be found on the [LeechCore wiki](https://github.com/ufrisk/LeechCore/wiki).
///
///
/// # Examples
///
/// ```
/// // Initialize a new LeechCore instance using the FPGA memory acqusition method.
/// let lc = LeechCore::new('C:\\Temp\\MemProcFS\\leechcore.dll', 'fpga://algo=0', LeechCore::LC_CONFIG_PRINTF_ENABLED)?;
/// ```
pub fn new(lc_lib_path : &str, device_config : &str, lc_config_printf_verbosity : u32) -> ResultEx<LeechCore> {
return LeechCore::impl_new(lc_lib_path, device_config, "", lc_config_printf_verbosity, 0);
}
/// LeechCore initialization function.
///
/// The [`LeechCore`] is the base of the low-level physical memory
/// aqusition API used by MemProcFS / [`Vmm`]. Normally it is not required
/// to interact with this low-level library.
///
/// One may however wish to use specialized functionality such as sending and
/// receiving raw PCIe TLPs (if the FPGA backend is in use), or to implement a
/// device PCIe BAR.
///
/// # Arguments
/// * `lc_lib_path` - Full path to the native leechcore library - i.e. `leechcore.dll` or `leechcore.so`.
/// * `device_config` - Leechcore device connection string, i.e. `fpga://algo=0`.
/// * `lc_config_printf_verbosity` - Leechcore printf verbosity level as a combination of `LeechCore::LC_CONFIG_PRINTF_*` values.
/// * `remote_config` - Leechcore remote connection string, i.e. blank or ``rpc://...` (Windows only).
/// * `pa_max` - Max physical address to use for memory acquisition.
///
/// Information about supported memory acqusition methods may be found on the [LeechCore wiki](https://github.com/ufrisk/LeechCore/wiki).
///
///
/// # Examples
///
/// ```
/// // Initialize a new LeechCore instance using the FPGA memory acqusition method.
/// let lc = LeechCore::new('C:\\Temp\\MemProcFS\\leechcore.dll', 'fpga://algo=0', LeechCore::LC_CONFIG_PRINTF_ENABLED, '', 0x23fffffff)?;
/// ```
pub fn new_ex(lc_lib_path : &str, device_config : &str, lc_config_printf_verbosity : u32, remote_config : &str, pa_max : u64) -> ResultEx<LeechCore> {
return LeechCore::impl_new(lc_lib_path, device_config, remote_config, lc_config_printf_verbosity, pa_max);
}
/// LeechCore printf enable [RW].
pub const LC_OPT_CORE_PRINTF_ENABLE : u64 = 0x4000000100000000;
/// LeechCore verbose level [RW].
pub const LC_OPT_CORE_VERBOSE : u64 = 0x4000000200000000;
/// LeechCore extra verbose level [RW].
pub const LC_OPT_CORE_VERBOSE_EXTRA : u64 = 0x4000000300000000;
/// LeechCore extra extra verbose level (TLP) [RW].
pub const LC_OPT_CORE_VERBOSE_EXTRA_TLP : u64 = 0x4000000400000000;
/// LeechCore major version [R].
pub const LC_OPT_CORE_VERSION_MAJOR : u64 = 0x4000000500000000;
/// LeechCore minor version [R].
pub const LC_OPT_CORE_VERSION_MINOR : u64 = 0x4000000600000000;
/// LeechCore revision version [R].
pub const LC_OPT_CORE_VERSION_REVISION : u64 = 0x4000000700000000;
/// LeechCore max physical address [R].
pub const LC_OPT_CORE_ADDR_MAX : u64 = 0x1000000800000000;
/// LeechCore statistics call count [lo-dword: LC_STATISTICS_ID_*] [R].
pub const LC_OPT_CORE_STATISTICS_CALL_COUNT : u64 = 0x4000000900000000;
/// LeechCore statistics call time [lo-dword: LC_STATISTICS_ID_*] [R].
pub const LC_OPT_CORE_STATISTICS_CALL_TIME : u64 = 0x4000000a00000000;
/// LeechCore is memory volatile [R].
pub const LC_OPT_CORE_VOLATILE : u64 = 0x1000000b00000000;
/// LeechCore is memory readonly [R].
pub const LC_OPT_CORE_READONLY : u64 = 0x1000000c00000000;
/// LeechCore memory info: is valid [R]
pub const LC_OPT_MEMORYINFO_VALID : u64 = 0x0200000100000000;
/// LeechCore memory info: is 32-bit OS [R].
pub const LC_OPT_MEMORYINFO_FLAG_32BIT : u64 = 0x0200000300000000;
/// LeechCore memory info: is 32-bit PAE OS [R].
pub const LC_OPT_MEMORYINFO_FLAG_PAE : u64 = 0x0200000400000000;
/// LeechCore memory info: architecture [R].
pub const LC_OPT_MEMORYINFO_ARCH : u64 = 0x0200001200000000;
/// LeechCore memory info: OS minor version [R].
pub const LC_OPT_MEMORYINFO_OS_VERSION_MINOR : u64 = 0x0200000500000000;
/// LeechCore memory info: OS major version [R].
pub const LC_OPT_MEMORYINFO_OS_VERSION_MAJOR : u64 = 0x0200000600000000;
/// LeechCore memory info: OS directory table base [R].
pub const LC_OPT_MEMORYINFO_OS_DTB : u64 = 0x0200000700000000;
/// LeechCore memory info: OS PFN database [R].
pub const LC_OPT_MEMORYINFO_OS_PFN : u64 = 0x0200000800000000;
/// LeechCore memory info: OS PsLoadedModuleList [R].
pub const LC_OPT_MEMORYINFO_OS_PSLOADEDMODULELIST : u64 = 0x0200000900000000;
/// LeechCore memory info: OS PsActiveProcessHead [R].
pub const LC_OPT_MEMORYINFO_OS_PSACTIVEPROCESSHEAD : u64 = 0x0200000a00000000;
/// LeechCore memory info: OS machine image type [R].
pub const LC_OPT_MEMORYINFO_OS_MACHINE_IMAGE_TP : u64 = 0x0200000b00000000;
/// LeechCore memory info: OS number of processors [R].
pub const LC_OPT_MEMORYINFO_OS_NUM_PROCESSORS : u64 = 0x0200000c00000000;
/// LeechCore memory info: OS system time [R].
pub const LC_OPT_MEMORYINFO_OS_SYSTEMTIME : u64 = 0x0200000d00000000;
/// LeechCore memory info: OS uptime [R].
pub const LC_OPT_MEMORYINFO_OS_UPTIME : u64 = 0x0200000e00000000;
/// LeechCore memory info: OS kernel base [R].
pub const LC_OPT_MEMORYINFO_OS_KERNELBASE : u64 = 0x0200000f00000000;
/// LeechCore memory info: OS kernel hint [R].
pub const LC_OPT_MEMORYINFO_OS_KERNELHINT : u64 = 0x0200001000000000;
/// LeechCore memory info: OS KdDebuggerDataBlock [R].
pub const LC_OPT_MEMORYINFO_OS_KDDEBUGGERDATABLOCK : u64 = 0x0200001100000000;
/// LeechCore fpga: probe maximum number of pages [RW].
pub const LC_OPT_FPGA_PROBE_MAXPAGES : u64 = 0x0300000100000000;
/// LeechCore fpga: max rx size [RW].
pub const LC_OPT_FPGA_MAX_SIZE_RX : u64 = 0x0300000300000000;
/// LeechCore fpga: max tx size [RW].
pub const LC_OPT_FPGA_MAX_SIZE_TX : u64 = 0x0300000400000000;
/// LeechCore fpga: time delay probe read in uS (algo: 2,3) [RW].
pub const LC_OPT_FPGA_DELAY_PROBE_READ : u64 = 0x0300000500000000;
/// LeechCore fpga: time delay probe write in uS (algo: 2,3) [RW].
pub const LC_OPT_FPGA_DELAY_PROBE_WRITE : u64 = 0x0300000600000000;
/// LeechCore fpga: time delay write in uS (algo: 2,3) [RW].
pub const LC_OPT_FPGA_DELAY_WRITE : u64 = 0x0300000700000000;
/// LeechCore fpga: time delay read in uS (algo: 2,3) [RW].
pub const LC_OPT_FPGA_DELAY_READ : u64 = 0x0300000800000000;
/// LeechCore fpga: retry on error [RW].
pub const LC_OPT_FPGA_RETRY_ON_ERROR : u64 = 0x0300000900000000;
/// LeechCore fpga: PCIe device id - bus:dev:fn (ex: 04:00.0 == : u64 = 0x0400) [RW].
pub const LC_OPT_FPGA_DEVICE_ID : u64 = 0x0300008000000000;
/// LeechCore fpga: FPGA bistream id [R].
pub const LC_OPT_FPGA_FPGA_ID : u64 = 0x0300008100000000;
/// LeechCore fpga: version major [R].
pub const LC_OPT_FPGA_VERSION_MAJOR : u64 = 0x0300008200000000;
/// LeechCore fpga: version minor [R].
pub const LC_OPT_FPGA_VERSION_MINOR : u64 = 0x0300008300000000;
/// LeechCore fpga: 1/0 use tiny 128-byte/tlp read algorithm. [RW].
pub const LC_OPT_FPGA_ALGO_TINY : u64 = 0x0300008400000000;
/// LeechCore fpga: 1/0 use synchronous (old) read algorithm. [RW].
pub const LC_OPT_FPGA_ALGO_SYNCHRONOUS : u64 = 0x0300008500000000;
/// LeechCore fpga: [lo-dword: register address in bytes] [bytes: 0-3: data, 4-7: byte_enable(if wr/set); top bit = cfg_mgmt_wr_rw1c_as_rw] [RW].
pub const LC_OPT_FPGA_CFGSPACE_XILINX : u64 = 0x0300008600000000;
/// LeechCore fpga: 1/0 call TLP read callback with additional string info in szInfo [RW].
pub const LC_OPT_FPGA_TLP_READ_CB_WITHINFO : u64 = 0x0300009000000000;
/// LeechCore fpga: 1/0 call TLP read callback with memory read completions from read calls filtered [RW].
pub const LC_OPT_FPGA_TLP_READ_CB_FILTERCPL : u64 = 0x0300009100000000;
/// Get a numeric configuration value.
///
/// # Arguments
/// * `config_id` - As specified by a `LeechCore::LC_OPT_*` constant marked as Read [R] or Read/Write [RW]. (Optionally or'ed with other data on select options).
///
/// # Examples
/// ```
/// println!("max addr: {:#x}", lc.get_option(LeechCore::LC_OPT_CORE_ADDR_MAX).unwrap_or(0));
/// ```
pub fn get_option(&self, config_id : u64) -> ResultEx<u64> {
return self.impl_get_option(config_id);
}
/// Set a numeric configuration value.
///
/// # Arguments
/// * `config_id` - As specified by a `LeechCore::LC_OPT_*` constant marked as Write [W] or Read/Write [RW]. (Optionally or'ed with other data on select options).
/// * `config_value` - The config value to set.
///
/// # Examples
/// ```
/// // The below enables printf outputs from within the LeechCore library.
/// let _r = lc.set_option(LeechCore::LC_OPT_CORE_PRINTF_ENABLE, 1);
/// ```
pub fn set_option(&self, config_id : u64, config_value : u64) -> ResultEx<()> {
return self.impl_set_option(config_id, config_value);
}
/// LeechCore command: FPGA PCIe Config Space [R].
pub const LC_CMD_FPGA_PCIECFGSPACE : u64 = 0x0000010300000000;
/// LeechCore command: FPGA PCIe register value [lo-dword: register address] [RW].
pub const LC_CMD_FPGA_CFGREGPCIE : u64 = 0x0000010400000000;
/// LeechCore command: FPGA register cfg [RW].
pub const LC_CMD_FPGA_CFGREGCFG : u64 = 0x0000010500000000;
/// LeechCore command: FPGA read/write DRP register space [lo-dword: register address] [RW].
pub const LC_CMD_FPGA_CFGREGDRP : u64 = 0x0000010600000000;
/// LeechCore command: FPGA write with mask [lo-dword: register address] [bytes: 0-1: data, 2-3: mask] [W].
pub const LC_CMD_FPGA_CFGREGCFG_MARKWR : u64 = 0x0000010700000000;
/// LeechCore command: FPGA write with mask [lo-dword: register address] [bytes: 0-1: data, 2-3: mask] [W].
pub const LC_CMD_FPGA_CFGREGPCIE_MARKWR : u64 = 0x0000010800000000;
/// LeechCore command: FPGA probe [RW].
pub const LC_CMD_FPGA_PROBE : u64 = 0x0000010b00000000;
/// LeechCore command: FPGA read shadow config space[R].
pub const LC_CMD_FPGA_CFGSPACE_SHADOW_RD : u64 = 0x0000010c00000000;
/// LeechCore command: FPGA [lo-dword: config space write base address] [W].
pub const LC_CMD_FPGA_CFGSPACE_SHADOW_WR : u64 = 0x0000010d00000000;
/// LeechCore command: FPGA write single tlp BYTE:s [W].
pub const LC_CMD_FPGA_TLP_WRITE_SINGLE : u64 = 0x0000011000000000;
/// LeechCore command: FPGA write multiple LC_TLP:s [W].
pub const LC_CMD_FPGA_TLP_WRITE_MULTIPLE : u64 = 0x0000011100000000;
/// LeechCore command: FPGA convert single TLP to LPSTR; *pcbDataOut includes NULL terminator [RW].
pub const LC_CMD_FPGA_TLP_TOSTRING : u64 = 0x0000011200000000;
/// LeechCore command: FPGA set/unset TLP user-defined context to be passed to callback function. [not remote] [W].
pub const LC_CMD_FPGA_TLP_CONTEXT : u64 = 0x2000011400000000;
/// LeechCore command: FPGA get TLP user-defined context to be passed to callback function. [not remote] [R].
pub const LC_CMD_FPGA_TLP_CONTEXT_RD : u64 = 0x2000011b00000000;
/// LeechCore command: FPGA set/unset TLP callback function [not remote] [W].
pub const LC_CMD_FPGA_TLP_FUNCTION_CALLBACK : u64 = 0x2000011500000000;
/// LeechCore command: FPGA get TLP callback function [not remote] [R].
pub const LC_CMD_FPGA_TLP_FUNCTION_CALLBACK_RD : u64 = 0x2000011c00000000;
/// LeechCore command: FPGA set/unset BAR user-defined context to be passed to callback function. [not remote] [W].
pub const LC_CMD_FPGA_BAR_CONTEXT : u64 = 0x2000012000000000;
/// LeechCore command: FPGA get BAR user-defined context to be passed to callback function [not remote] [R].
pub const LC_CMD_FPGA_BAR_CONTEXT_RD : u64 = 0x2000012100000000;
/// LeechCore command: FPGA set/unset BAR callback function [not remote] [W].
pub const LC_CMD_FPGA_BAR_FUNCTION_CALLBACK : u64 = 0x2000012200000000;
/// LeechCore command: FPGA get BAR callback function [not remote] [R].
pub const LC_CMD_FPGA_BAR_FUNCTION_CALLBACK_RD : u64 = 0x2000012300000000;
/// LeechCore command: FPGA BAR info. (pbDataOut == LC_BAR_INFO[6]) [R].
pub const LC_CMD_FPGA_BAR_INFO : u64 = 0x0000012400000000;
/// LeechCore command: Get the dump file header [R].
pub const LC_CMD_FILE_DUMPHEADER_GET : u64 = 0x0000020100000000;
/// LeechCore command: Get statistics [R].
pub const LC_CMD_STATISTICS_GET : u64 = 0x4000010000000000;
/// LeechCore command: Get memmap as string [R].
pub const LC_CMD_MEMMAP_GET : u64 = 0x4000020000000000;
/// LeechCore command: Set memmap as string [W].
pub const LC_CMD_MEMMAP_SET : u64 = 0x4000030000000000;
/// LeechCore command: Get memmap as C-struct [R].
pub const LC_CMD_MEMMAP_GET_STRUCT : u64 = 0x4000040000000000;
/// LeechCore command: Set memmap as C-struct [W].
pub const LC_CMD_MEMMAP_SET_STRUCT : u64 = 0x4000050000000000;
/// Execute a command using the LcCommand interface.
///
/// # Arguments
/// * `command_id` - The command id to execute.
/// * `data` - Optional data to send with the command.
///
/// # Examples
/// ```
/// // Get the LeechCore memory map:
/// let memmap = lc.command(LeechCore::LC_CMD_MEMMAP_GET, None)?.to_string();
/// ```
pub fn command(&self, command_id : u64, data : Option<&Vec<u8>>) -> ResultEx<Option<Vec<u8>>> {
return self.impl_command(command_id, data);
}
/// Read a contigious physical memory chunk.
///
/// The whole chunk must be read successfully for the method to succeed.
///
///
/// # Arguments
/// * `pa` - Physical address to start reading from.
/// * `size` - Number of bytes to read.
///
/// # Examples
/// ```
/// // Read 0x100 bytes of data starting at address 0x1000.
/// // Example assumes: use pretty_hex::*;
/// let data_read = lc.mem_read(0x1000, 0x100)?;
/// println!("{:?}", data_read.hex_dump());
/// ```
pub fn mem_read(&self, pa : u64, size : usize) -> ResultEx<Vec<u8>> {
return self.impl_mem_read(pa, size);
}
/// Read a contigious physical memory chunk with flags as a type/struct.
///
///
/// # Arguments
/// * `pa` - Physical address to start reading from.
///
/// # Examples
/// ```
/// // Read the C-struct IMAGE_DOS_HEADER from memory.
/// #[repr(C)]
/// struct IMAGE_DOS_HEADER {
/// e_magic : u16,
/// ...
/// e_lfanew : u32,
/// }
/// if let Ok(doshdr) = lc.mem_read_as::<IMAGE_DOS_HEADER>(pa_module) {
/// println!("e_magic: {:x}", doshdr.e_magic);
/// println!("e_lfanew: {:x}", doshdr.e_lfanew);
/// }
/// ```
pub fn mem_read_as<T>(&self, pa : u64) -> ResultEx<T> {
return self.impl_mem_read_as(pa);
}
/// Write physical memory.
///
/// The write is a best effort. Even of the write should fail it's not
/// certain that an error will be returned. To be absolutely certain that
/// a write has taken place follow up with a read.
///
/// # Arguments
/// * `pa` - Physical address to start writing from.
/// * `data` - Byte data to write.
///
/// # Examples
/// ```
/// let data_to_write = [0x56u8, 0x4d, 0x4d, 0x52, 0x55, 0x53, 0x54].to_vec();
/// let _r = lc.mem_write(0x1000, &data_to_write);
/// ```
pub fn mem_write(&self, pa : u64, data : &Vec<u8>) -> ResultEx<()> {
return self.impl_mem_write(pa, data);
}
/// Write a type/struct to physical memory.
///
/// The write is a best effort. Even of the write should fail it's not
/// certain that an error will be returned. To be absolutely certain that
/// a write has taken place follow up with a read.
///
/// # Arguments
/// * `pa` - Physical address to start writing from.
/// * `data` - Data to write. In case of a struct repr(C) is recommended.
///
/// # Examples
/// ```
/// let data_to_write = [0x56, 0x4d, 0x4d, 0x52, 0x55, 0x53, 0x54];
/// let _r = lc.mem_write_as(0x1000, &data_to_write);
/// ```
pub fn mem_write_as<T>(&self, pa : u64, data : &T) -> ResultEx<()> {
return self.impl_mem_write_as(pa, data);
}
/// Retrieve the memory map currently in-use.
///
/// For more information about memory maps see the [LeechCore wiki](https://github.com/ufrisk/LeechCore/wiki/Device_FPGA_AMD_Thunderbolt).
///
/// # Examples
/// ```
/// let memmap = lc.get_memmap()?;
/// println!("{}", memmap);
/// ```
pub fn get_memmap(&self) -> ResultEx<String> {
return self.impl_get_memmap();
}
/// Set/Update the memory map currently in-use.
///
/// For more information about memory maps see the [LeechCore wiki](https://github.com/ufrisk/LeechCore/wiki/Device_FPGA_AMD_Thunderbolt).
///
/// # Arguments
/// * `str_memmap` - The str containing the new memory map to use.
///
/// # Examples
/// ```
/// let _r = lc.set_memmap(memmap.as_str())?;
/// ```
pub fn set_memmap(&self, str_memmap : &str) -> ResultEx<()> {
return self.impl_set_memmap(str_memmap);
}
/// PCIe only function: Get the BARs of the PCIe device.
///
/// # Examples
/// ```
/// let bars = lc.pcie_bar_info()?;
/// ```
pub fn pcie_bar_info(&self) -> ResultEx<[LcBar; 6]> {
return self.impl_pcie_bar_info();
}
/// PCIe only function: Start a PCIe BAR callback.
///
/// # Arguments
/// * `ctx` - User defined context to be passed to the callback function.
/// * `fn_bar_callback` - The callback function to call when a BAR is accessed.
///
/// See [`LcBarContext`] for more information.
///
/// Only one PCIe BAR callback may be active at a time.
pub fn pcie_bar_callback<T>(&self, ctx : T, fn_bar_callback : fn(ctx : &LcBarContext<T>, req : &LcBarRequest) -> ResultEx<()>) -> ResultEx<LcBarContextWrap<T>> {
return self.impl_pcie_bar_callback(ctx, fn_bar_callback);
}
/// PCIe only function: Start a PCIe TLP callback.
///
/// # Arguments
/// * `ctx` - User defined context to be passed to the callback function.
/// * `fn_tlp_callback` - The callback function to call when a TLP is received.
///
/// See [`LcTlpContext`] for more information.
///
/// Only one PCIe TLP callback may be active at a time.
pub fn pcie_tlp_callback<T>(&self, ctx : T, fn_tlp_callback : fn(ctx : &LcTlpContext<T>, tlp : &[u8], tlp_str : &str) -> ResultEx<()>) -> ResultEx<LcTlpContextWrap<T>> {
return self.impl_pcie_tlp_callback(ctx, fn_tlp_callback);
}
/// PCIe only function: Write a PCIe TLP.
///
/// # Arguments
/// * `tlp` - The TLP to write.
pub fn pcie_tlp_write(&self, tlp : &[u8]) -> ResultEx<()> {
return self.impl_pcie_tlp_write(tlp);
}
}
impl LcBarRequest {
/// Send a valid read reply to the BAR request.
///
/// The read reply must be of the exact length of the BAR read request.
///
/// # Arguments
/// * `data_reply` - The data to send as a reply.
pub fn read_reply(&self, data_reply : &[u8]) -> ResultEx<()> {
return self.impl_read_reply(data_reply, false);
}
/// Send an invalid read reply to the BAR request indicating that the read
/// failed. An Unsupported Request TLP will be sent to the host system in
/// reponse to the failed read.
///
/// This function should normally not be called.
pub fn read_reply_fail(&self) -> ResultEx<()> {
let data = [0u8; 0];
return self.impl_read_reply(&data, true);
}
}
//=============================================================================
// INTERNAL: VMM CORE:
//=============================================================================
#[allow(dead_code)]
#[allow(non_snake_case)]
#[derive(Debug)]
struct VmmNative {
h : usize,
is_close_h : bool,
library_lc : Option<libloading::Library>,
library_vmm : Option<libloading::Library>,
VMMDLL_Initialize : extern "C" fn(argc: c_int, argv: *const *const c_char) -> usize,
VMMDLL_InitializePlugins : extern "C" fn(hVMM : usize) -> bool,
VMMDLL_Close : extern "C" fn(hVMM : usize),
VMMDLL_ConfigGet : extern "C" fn(hVMM : usize, fOption : u64, pqwValue : *mut u64) -> bool,
VMMDLL_ConfigSet : extern "C" fn(hVMM : usize, fOption : u64, qwValue : u64) -> bool,
VMMDLL_MemFree : extern "C" fn(pvMem : usize),
VMMDLL_Log : extern "C" fn(hVMM : usize, MID : u32, dwLogLevel : u32, uszFormat : *const c_char, uszParam : *const c_char),
VMMDLL_MemSearch : extern "C" fn(hVMM : usize, pid : u32, ctx : *mut CVMMDLL_MEM_SEARCH_CONTEXT, ppva : *mut u64, pcva : *mut u32) -> bool,
VMMDLL_YaraSearch : extern "C" fn(hVMM : usize, pid : u32, ctx : *mut CVMMDLL_YARA_CONFIG, ppva : *mut u64, pcva : *mut u32) -> bool,
VMMDLL_MemReadEx : extern "C" fn(hVMM : usize, pid : u32, qwA : u64, pb : *mut u8, cb : u32, pcbReadOpt : *mut u32, flags : u64) -> bool,
VMMDLL_MemWrite : extern "C" fn(hVMM : usize, pid : u32, qwA : u64, pb : *const u8, cb : u32) -> bool,
VMMDLL_MemVirt2Phys : extern "C" fn(hVMM : usize, pid : u32, qwA : u64, pqwPA : *mut u64) -> bool,
VMMDLL_Scatter_Initialize : extern "C" fn(hVMM : usize, pid : u32, flags : u32) -> usize,
VMMDLL_Scatter_Prepare : extern "C" fn(hS : usize, va : u64, cb : u32) -> bool,
VMMDLL_Scatter_PrepareEx : extern "C" fn(hS : usize, va : u64, cb : u32, pb : *mut u8, pcbRead : *mut u32) -> bool,
VMMDLL_Scatter_PrepareWrite : extern "C" fn(hS : usize, va : u64, pb : *const u8, cb : u32) -> bool,
VMMDLL_Scatter_Execute : extern "C" fn(hS : usize) -> bool,
VMMDLL_Scatter_Read : extern "C" fn(hS : usize, va : u64, cb : u32, pb : *mut u8, pcbRead : *mut u32) -> bool,
VMMDLL_Scatter_Clear : extern "C" fn(hS : usize, pid : u32, flags : u32) -> bool,
VMMDLL_Scatter_CloseHandle : extern "C" fn(hS : usize),
VMMDLL_PidGetFromName : extern "C" fn(hVMM : usize, szProcName : *const c_char, pdwPID : *mut u32) -> bool,
VMMDLL_PidList : extern "C" fn(hVMM : usize, pPIDs : *mut u32, pcPIDs : *mut usize) -> bool,
VMMDLL_WinReg_HiveList : extern "C" fn(hVMM : usize, pHives : *mut CRegHive, cHives : u32, pcHives : *mut u32) -> bool,
VMMDLL_WinReg_HiveReadEx : extern "C" fn(hVMM : usize, vaCMHive : u64, ra : u32, pb : *mut u8, cb : u32, pcbReadOpt : *mut u32, flags : u64) -> bool,
VMMDLL_WinReg_HiveWrite : extern "C" fn(hVMM : usize, vaCMHive : u64, ra : u32, pb : *const u8, cb : u32) -> bool,
VMMDLL_WinReg_EnumKeyExU : extern "C" fn(hVMM : usize, uszFullPathKey : *const c_char, dwIndex : u32, lpcchName : *mut c_char, lpcchName : *mut u32, lpftLastWriteTime : *mut u64) -> bool,
VMMDLL_WinReg_EnumValueU : extern "C" fn(hVMM : usize, uszFullPathKey : *const c_char, dwIndex : u32, lpValueName : *mut c_char, lpcchValueName : *mut u32, lpType : *mut u32, lpcbData : *mut u32) -> bool,
VMMDLL_WinReg_QueryValueExU : extern "C" fn(hVMM : usize, uszFullPathKeyValue : *const c_char, lpType : *mut u32, lpData : *mut u8, lpcbData : *mut u32) -> bool,
VMMDLL_ProcessGetModuleBaseU : extern "C" fn(hVMM : usize, pid : u32, uszModuleName : *const c_char) -> u64,
VMMDLL_ProcessGetProcAddressU : extern "C" fn(hVMM : usize, pid : u32, uszModuleName : *const c_char, szFunctionName : *const c_char) -> u64,
VMMDLL_ProcessGetInformation : extern "C" fn(hVMM : usize, pid : u32, pProcessInformation : *mut CProcessInformation, pcbProcessInformation : *mut usize) -> bool,
VMMDLL_ProcessGetInformationString : extern "C" fn(hVMM : usize, pid : u32, fOptionString : u32) -> *const c_char,
VMMDLL_Map_GetNetU : extern "C" fn(hVMM : usize, ppNetMap : *mut *mut CNetMap) -> bool,
VMMDLL_Map_GetPfnEx : extern "C" fn(hVMM : usize, pPfns : *const u32, cPfns : u32, ppPfnMap : *mut *mut CPfnMap, flags : u32) -> bool,
VMMDLL_Map_GetPhysMem : extern "C" fn(hVMM : usize, ppPhysMemMap : *mut *mut CMemoryMap) -> bool,
VMMDLL_Map_GetPool : extern "C" fn(hVMM : usize, ppPoolMap : *mut *mut CPoolMap, flags : u32) -> bool,
VMMDLL_Map_GetServicesU : extern "C" fn(hVMM : usize, ppServiceMap : *mut *mut CServiceMap) -> bool,
VMMDLL_Map_GetUsersU : extern "C" fn(hVMM : usize, ppUserMap : *mut *mut CUserMap) -> bool,
VMMDLL_Map_GetVMU : extern "C" fn(hVMM : usize, ppVmMap : *mut *mut CVmMap) -> bool,
VMMDLL_PdbLoad : extern "C" fn(hVMM : usize, dwPID : u32, vaModuleBase : u64, szModuleName : *mut c_char) -> bool,
VMMDLL_PdbSymbolName : extern "C" fn(hVMM : usize, szModule : *const c_char, cbSymbolAddressOrOffset : u64, szSymbolName : *mut c_char, pdwSymbolDisplacement : *mut u32) -> bool,
VMMDLL_PdbSymbolAddress : extern "C" fn(hVMM : usize, szModule : *const c_char, szSymbolName : *const c_char, pvaSymbolAddress : *mut u64) -> bool,
VMMDLL_PdbTypeSize : extern "C" fn(hVMM : usize, szModule : *const c_char, szTypeName : *const c_char, pcbTypeSize : *mut u32) -> bool,
VMMDLL_PdbTypeChildOffset : extern "C" fn(hVMM : usize, szModule : *const c_char, uszTypeName : *const c_char, uszTypeChildName : *const c_char, pcbTypeChildOffset : *mut u32) -> bool,
VMMDLL_Map_GetEATU : extern "C" fn(hVMM : usize, pid : u32, uszModuleName : *const c_char, ppEatMap : *mut *mut CEatMap) -> bool,
VMMDLL_Map_GetHandleU : extern "C" fn(hVMM : usize, pid : u32, ppHandleMap : *mut *mut CHandleMap) -> bool,
VMMDLL_Map_GetHeap : extern "C" fn(hVMM : usize, pid : u32, ppHeapMap : *mut *mut CHeapMap) -> bool,
VMMDLL_Map_GetHeapAlloc : extern "C" fn(hVMM : usize, pid : u32, qwHeapNumOrAddress : u64, ppHeapAllocMap : *mut *mut CHeapAllocMap) -> bool,
VMMDLL_Map_GetIATU : extern "C" fn(hVMM : usize, pid : u32, uszModuleName : *const c_char, ppIatMap : *mut *mut CIatMap) -> bool,
VMMDLL_Map_GetModuleU : extern "C" fn(hVMM : usize, pid : u32, ppModuleMap : *mut *mut CModuleMap, flags : u32) -> bool,
VMMDLL_Map_GetPteU : extern "C" fn(hVMM : usize, pid : u32, fIdentifyModules : bool, ppPteMap : *mut *mut CPteMap) -> bool,
VMMDLL_Map_GetThread : extern "C" fn(hVMM : usize, pid : u32, ppThreadMap : *mut *mut CThreadMap) -> bool,
VMMDLL_Map_GetUnloadedModuleU : extern "C" fn(hVMM : usize, pid : u32, ppUnloadedModuleMap : *mut *mut CUnloadedModuleMap) -> bool,
VMMDLL_Map_GetVadU : extern "C" fn(hVMM : usize, pid : u32, fIdentifyModules : bool, ppVadMap : *mut *mut CVadMap) -> bool,
VMMDLL_Map_GetVadEx : extern "C" fn(hVMM : usize, pid : u32, oPage : u32, cPage : u32, ppVadExMap : *mut *mut CVadExMap) -> bool,
VMMDLL_ProcessGetDirectoriesU : extern "C" fn(hVMM : usize, pid : u32, uszModule : *const c_char, pDataDirectories : *mut CIMAGE_DATA_DIRECTORY) -> bool,
VMMDLL_ProcessGetSectionsU : extern "C" fn(hVMM : usize, pid : u32, uszModule : *const c_char, pSections : *mut CIMAGE_SECTION_HEADER, cSections : u32, pcSections : *mut u32) -> bool,
VMMDLL_VfsListU : extern "C" fn(hVMM : usize, uszPath : *const c_char, pFileList : *mut CVMMDLL_VFS_FILELIST2) -> bool,
VMMDLL_VfsReadU : extern "C" fn(hVMM : usize, uszFileName : *const c_char, pb : *mut u8, cb : u32, pcbRead : *mut u32, cbOffset : u64) -> u32,
VMMDLL_VfsWriteU : extern "C" fn(hVMM : usize, uszFileName : *const c_char, pb : *const u8, cb : u32, pcbWrite : *mut u32, cbOffset : u64) -> u32,
VMMDLL_VmGetVmmHandle : extern "C" fn(hVMM : usize, hVM : usize) -> usize,
// Plugin related info below:
VMMDLL_VfsList_AddFile : extern "C" fn(pFileList : usize, uszName : *const c_char, cb : u64, pExInfo : usize),
VMMDLL_VfsList_AddDirectory : extern "C" fn(pFileList : usize, uszName : *const c_char, pExInfo : usize),
}
#[allow(non_snake_case)]
fn impl_new<'a>(vmm_lib_path : &str, h_vmm_existing_opt : usize, args: &Vec<&str>) -> ResultEx<Vmm<'a>> {
unsafe {
// load MemProcFS native library (vmm.dll / vmm.so):
// vmm is however dependant on leechcore which must be loaded first...
let path_vmm = std::path::Path::new(vmm_lib_path).canonicalize()?;
let mut path_lc = path_vmm.parent().unwrap().canonicalize()?;
if cfg!(windows) {
path_lc = path_lc.join("leechcore.dll");
} else {
path_lc = path_lc.join("leechcore.so");
}
let str_path_lc = path_lc.to_str().unwrap_or("");
let str_path_vmm = path_vmm.to_str().unwrap_or("");
let lib_lc : libloading::Library = libloading::Library::new(str_path_lc)
.with_context(|| format!("Failed to load leechcore library at: {}", str_path_lc))?;
let lib : libloading::Library = libloading::Library::new(str_path_vmm)
.with_context(|| format!("Failed to load vmm library at: {}", str_path_vmm))?;
// fetch function references:
let VMMDLL_Initialize : extern "C" fn(argc: c_int, argv: *const *const c_char) -> usize = *lib.get(b"VMMDLL_Initialize")?;
let VMMDLL_InitializePlugins : extern "C" fn(usize) -> bool = *lib.get(b"VMMDLL_InitializePlugins")?;
let VMMDLL_Close = *lib.get(b"VMMDLL_Close")?;
let VMMDLL_ConfigGet = *lib.get(b"VMMDLL_ConfigGet")?;
let VMMDLL_ConfigSet = *lib.get(b"VMMDLL_ConfigSet")?;
let VMMDLL_MemFree = *lib.get(b"VMMDLL_MemFree")?;
let VMMDLL_Log = *lib.get(b"VMMDLL_Log")?;
let VMMDLL_MemSearch = *lib.get(b"VMMDLL_MemSearch")?;
let VMMDLL_YaraSearch = *lib.get(b"VMMDLL_YaraSearch")?;
let VMMDLL_MemReadEx = *lib.get(b"VMMDLL_MemReadEx")?;
let VMMDLL_MemWrite = *lib.get(b"VMMDLL_MemWrite")?;
let VMMDLL_MemVirt2Phys = *lib.get(b"VMMDLL_MemVirt2Phys")?;
let VMMDLL_Scatter_Initialize = *lib.get(b"VMMDLL_Scatter_Initialize")?;
let VMMDLL_Scatter_Prepare = *lib.get(b"VMMDLL_Scatter_Prepare")?;
let VMMDLL_Scatter_PrepareEx = *lib.get(b"VMMDLL_Scatter_PrepareEx")?;
let VMMDLL_Scatter_PrepareWrite = *lib.get(b"VMMDLL_Scatter_PrepareWrite")?;
let VMMDLL_Scatter_Execute = *lib.get(b"VMMDLL_Scatter_Execute")?;
let VMMDLL_Scatter_Read = *lib.get(b"VMMDLL_Scatter_Read")?;
let VMMDLL_Scatter_Clear = *lib.get(b"VMMDLL_Scatter_Clear")?;
let VMMDLL_Scatter_CloseHandle = *lib.get(b"VMMDLL_Scatter_CloseHandle")?;
let VMMDLL_PidGetFromName = *lib.get(b"VMMDLL_PidGetFromName")?;
let VMMDLL_PidList = *lib.get(b"VMMDLL_PidList")?;
let VMMDLL_WinReg_HiveList = *lib.get(b"VMMDLL_WinReg_HiveList")?;
let VMMDLL_WinReg_HiveReadEx = *lib.get(b"VMMDLL_WinReg_HiveReadEx")?;
let VMMDLL_WinReg_HiveWrite = *lib.get(b"VMMDLL_WinReg_HiveWrite")?;
let VMMDLL_WinReg_EnumKeyExU = *lib.get(b"VMMDLL_WinReg_EnumKeyExU")?;
let VMMDLL_WinReg_EnumValueU = *lib.get(b"VMMDLL_WinReg_EnumValueU")?;
let VMMDLL_WinReg_QueryValueExU = *lib.get(b"VMMDLL_WinReg_QueryValueExU")?;
let VMMDLL_ProcessGetModuleBaseU = *lib.get(b"VMMDLL_ProcessGetModuleBaseU")?;
let VMMDLL_ProcessGetProcAddressU = *lib.get(b"VMMDLL_ProcessGetProcAddressU")?;
let VMMDLL_ProcessGetInformation = *lib.get(b"VMMDLL_ProcessGetInformation")?;
let VMMDLL_ProcessGetInformationString = *lib.get(b"VMMDLL_ProcessGetInformationString")?;
let VMMDLL_Map_GetNetU = *lib.get(b"VMMDLL_Map_GetNetU")?;
let VMMDLL_Map_GetPfnEx = *lib.get(b"VMMDLL_Map_GetPfnEx")?;
let VMMDLL_Map_GetPhysMem = *lib.get(b"VMMDLL_Map_GetPhysMem")?;
let VMMDLL_Map_GetPool = *lib.get(b"VMMDLL_Map_GetPool")?;
let VMMDLL_Map_GetUsersU = *lib.get(b"VMMDLL_Map_GetUsersU")?;
let VMMDLL_Map_GetServicesU = *lib.get(b"VMMDLL_Map_GetServicesU")?;
let VMMDLL_Map_GetVMU = *lib.get(b"VMMDLL_Map_GetVMU")?;
let VMMDLL_PdbLoad = *lib.get(b"VMMDLL_PdbLoad")?;
let VMMDLL_PdbSymbolName = *lib.get(b"VMMDLL_PdbSymbolName")?;
let VMMDLL_PdbSymbolAddress = *lib.get(b"VMMDLL_PdbSymbolAddress")?;
let VMMDLL_PdbTypeSize = *lib.get(b"VMMDLL_PdbTypeSize")?;
let VMMDLL_PdbTypeChildOffset = *lib.get(b"VMMDLL_PdbTypeChildOffset")?;
let VMMDLL_Map_GetEATU = *lib.get(b"VMMDLL_Map_GetEATU")?;
let VMMDLL_Map_GetHandleU = *lib.get(b"VMMDLL_Map_GetHandleU")?;
let VMMDLL_Map_GetHeap = *lib.get(b"VMMDLL_Map_GetHeap")?;
let VMMDLL_Map_GetHeapAlloc = *lib.get(b"VMMDLL_Map_GetHeapAlloc")?;
let VMMDLL_Map_GetIATU = *lib.get(b"VMMDLL_Map_GetIATU")?;
let VMMDLL_Map_GetModuleU = *lib.get(b"VMMDLL_Map_GetModuleU")?;
let VMMDLL_Map_GetPteU = *lib.get(b"VMMDLL_Map_GetPteU")?;
let VMMDLL_Map_GetThread = *lib.get(b"VMMDLL_Map_GetThread")?;
let VMMDLL_Map_GetUnloadedModuleU = *lib.get(b"VMMDLL_Map_GetUnloadedModuleU")?;
let VMMDLL_Map_GetVadU = *lib.get(b"VMMDLL_Map_GetVadU")?;
let VMMDLL_Map_GetVadEx = *lib.get(b"VMMDLL_Map_GetVadEx")?;
let VMMDLL_ProcessGetDirectoriesU = *lib.get(b"VMMDLL_ProcessGetDirectoriesU")?;
let VMMDLL_ProcessGetSectionsU = *lib.get(b"VMMDLL_ProcessGetSectionsU")?;
let VMMDLL_VfsListU = *lib.get(b"VMMDLL_VfsListU")?;
let VMMDLL_VfsReadU = *lib.get(b"VMMDLL_VfsReadU")?;
let VMMDLL_VfsWriteU = *lib.get(b"VMMDLL_VfsWriteU")?;
let VMMDLL_VmGetVmmHandle = *lib.get(b"VMMDLL_VmGetVmmHandle")?;
let VMMDLL_VfsList_AddFile = *lib.get(b"VMMDLL_VfsList_AddFile")?;
let VMMDLL_VfsList_AddDirectory = *lib.get(b"VMMDLL_VfsList_AddDirectory")?;
// initialize MemProcFS
let h;
if h_vmm_existing_opt != 0 {
h = h_vmm_existing_opt;
} else {
let args = args.iter().map(|arg| CString::new(*arg).unwrap()).collect::<Vec<CString>>();
let argv: Vec<*const c_char> = args.iter().map(|s| s.as_ptr()).collect();
let argc: c_int = args.len() as c_int;
h = (VMMDLL_Initialize)(argc, argv.as_ptr());
if h == 0 {
return Err(anyhow!("VMMDLL_Initialize: fail"));
}
let r = (VMMDLL_InitializePlugins)(h);
if !r {
return Err(anyhow!("VMMDLL_InitializePlugins: fail"));
}
}
// return Vmm struct:
let native = VmmNative {
h,
is_close_h : h_vmm_existing_opt == 0,
library_lc : Some(lib_lc),
library_vmm : Some(lib),
VMMDLL_Initialize,
VMMDLL_InitializePlugins,
VMMDLL_Close,
VMMDLL_ConfigGet,
VMMDLL_ConfigSet,
VMMDLL_MemFree,
VMMDLL_Log,
VMMDLL_MemSearch,
VMMDLL_YaraSearch,
VMMDLL_MemReadEx,
VMMDLL_MemWrite,
VMMDLL_MemVirt2Phys,
VMMDLL_Scatter_Initialize,
VMMDLL_Scatter_Prepare,
VMMDLL_Scatter_PrepareEx,
VMMDLL_Scatter_PrepareWrite,
VMMDLL_Scatter_Execute,
VMMDLL_Scatter_Read,
VMMDLL_Scatter_Clear,
VMMDLL_Scatter_CloseHandle,
VMMDLL_PidGetFromName,
VMMDLL_PidList,
VMMDLL_WinReg_HiveList,
VMMDLL_WinReg_HiveReadEx,
VMMDLL_WinReg_HiveWrite,
VMMDLL_WinReg_EnumKeyExU,
VMMDLL_WinReg_EnumValueU,
VMMDLL_WinReg_QueryValueExU,
VMMDLL_ProcessGetModuleBaseU,
VMMDLL_ProcessGetProcAddressU,
VMMDLL_ProcessGetInformation,
VMMDLL_ProcessGetInformationString,
VMMDLL_Map_GetNetU,
VMMDLL_Map_GetPfnEx,
VMMDLL_Map_GetPhysMem,
VMMDLL_Map_GetPool,
VMMDLL_Map_GetUsersU,
VMMDLL_Map_GetServicesU,
VMMDLL_Map_GetVMU,
VMMDLL_PdbLoad,
VMMDLL_PdbSymbolName,
VMMDLL_PdbSymbolAddress,
VMMDLL_PdbTypeSize,
VMMDLL_PdbTypeChildOffset,
VMMDLL_Map_GetEATU,
VMMDLL_Map_GetHandleU,
VMMDLL_Map_GetHeap,
VMMDLL_Map_GetHeapAlloc,
VMMDLL_Map_GetIATU,
VMMDLL_Map_GetModuleU,
VMMDLL_Map_GetPteU,
VMMDLL_Map_GetThread,
VMMDLL_Map_GetUnloadedModuleU,
VMMDLL_Map_GetVadU,
VMMDLL_Map_GetVadEx,
VMMDLL_ProcessGetDirectoriesU,
VMMDLL_ProcessGetSectionsU,
VMMDLL_VfsListU,
VMMDLL_VfsReadU,
VMMDLL_VfsWriteU,
VMMDLL_VmGetVmmHandle,
VMMDLL_VfsList_AddFile,
VMMDLL_VfsList_AddDirectory,
};
let vmm = Vmm {
path_lc : str_path_lc.to_string(),
path_vmm : str_path_vmm.to_string(),
native,
parent_vmm : None,
};
return Ok(vmm);
}
}
#[allow(non_snake_case)]
fn impl_new_from_virtual_machine<'a>(vmm_parent : &'a Vmm, vm_entry : &VmmMapVirtualMachineEntry) -> ResultEx<Vmm<'a>> {
if vmm_parent.native.h != vm_entry.h_vmm {
return Err(anyhow!("Invalid parent/vm relationship."));
}
let h_vmm_vm = (vmm_parent.native.VMMDLL_VmGetVmmHandle)(vmm_parent.native.h, vm_entry.h_vm);
if h_vmm_vm == 0 {
return Err(anyhow!("VMMDLL_VmGetVmmHandle: fail."));
}
let native = VmmNative {
h: vmm_parent.native.h,
library_lc : None,
library_vmm : None,
..vmm_parent.native
};
let vmm = Vmm {
path_lc : vmm_parent.path_lc.clone(),
path_vmm : vmm_parent.path_vmm.clone(),
native : native,
parent_vmm : Some(vmm_parent),
};
return Ok(vmm);
}
//=============================================================================
// INTERNAL: VMM:
//=============================================================================
const MAX_PATH : usize = 260;
const VMMDLL_MEM_SEARCH_VERSION : u32 = 0xfe3e0002;
const VMMDLL_YARA_CONFIG_VERSION : u32 = 0xdec30001;
const VMMYARA_RULE_MATCH_VERSION : u32 = 0xfedc0003;
const VMMDLL_VFS_FILELIST_VERSION : u32 = 2;
const VMMDLL_MAP_EAT_VERSION : u32 = 3;
const VMMDLL_MAP_HANDLE_VERSION : u32 = 3;
const VMMDLL_MAP_HEAP_VERSION : u32 = 4;
const VMMDLL_MAP_HEAPALLOC_VERSION : u32 = 1;
const VMMDLL_MAP_IAT_VERSION : u32 = 2;
const VMMDLL_MAP_POOL_VERSION : u32 = 2;
const VMMDLL_MAP_PTE_VERSION : u32 = 2;
const VMMDLL_MAP_MODULE_VERSION : u32 = 6;
const VMMDLL_MAP_NET_VERSION : u32 = 3;
const VMMDLL_MAP_PFN_VERSION : u32 = 1;
const VMMDLL_MAP_PHYSMEM_VERSION : u32 = 2;
const VMMDLL_MAP_SERVICE_VERSION : u32 = 3;
const VMMDLL_MAP_THREAD_VERSION : u32 = 4;
const VMMDLL_MAP_UNLOADEDMODULE_VERSION : u32 = 2;
const VMMDLL_MAP_USER_VERSION : u32 = 2;
const VMMDLL_MAP_VAD_VERSION : u32 = 6;
const VMMDLL_MAP_VADEX_VERSION : u32 = 4;
const VMMDLL_MAP_VM_VERSION : u32 = 2;
const VMMDLL_MID_RUST : u32 = 0x80000004;
const VMMDLL_PLUGIN_CONTEXT_MAGIC : u64 = 0xc0ffee663df9301c;
const VMMDLL_PLUGIN_CONTEXT_VERSION : u16 = 5;
const VMMDLL_PLUGIN_REGINFO_MAGIC : u64 = 0xc0ffee663df9301d;
const VMMDLL_PLUGIN_REGINFO_VERSION : u16 = 18;
const VMMDLL_STATUS_SUCCESS : u32 = 0x00000000;
const VMMDLL_STATUS_END_OF_FILE : u32 = 0xC0000011;
const VMMDLL_STATUS_FILE_INVALID : u32 = 0xC0000098;
const VMMDLL_PROCESS_INFORMATION_MAGIC : u64 = 0xc0ffee663df9301e;
const VMMDLL_PROCESS_INFORMATION_VERSION : u16 = 7;
const VMMDLL_REGISTRY_HIVE_INFORMATION_MAGIC : u64 = 0xc0ffee653df8d01e;
const VMMDLL_REGISTRY_HIVE_INFORMATION_VERSION : u16 = 4;
const VMMDLL_PROCESS_INFORMATION_OPT_STRING_PATH_KERNEL : u32 = 1;
const VMMDLL_PROCESS_INFORMATION_OPT_STRING_PATH_USER_IMAGE : u32 = 2;
const VMMDLL_PROCESS_INFORMATION_OPT_STRING_CMDLINE : u32 = 3;
const DIRECTORY_NAMES : [&str; 16] = ["EXPORT", "IMPORT", "RESOURCE", "EXCEPTION", "SECURITY", "BASERELOC", "DEBUG", "ARCHITECTURE", "GLOBALPTR", "TLS", "LOAD_CONFIG", "BOUND_IMPORT", "IAT", "DELAY_IMPORT", "COM_DESCRIPTOR", "RESERVED"];
impl Drop for Vmm<'_> {
fn drop(&mut self) {
if self.native.is_close_h {
(self.native.VMMDLL_Close)(self.native.h);
}
}
}
impl fmt::Display for Vmm<'_> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "Vmm")
}
}
impl fmt::Display for VmmLogLevel {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let v = match self {
VmmLogLevel::_1Critical => "Critical(1)",
VmmLogLevel::_2Warning => "Warning(2)",
VmmLogLevel::_3Info => "Info(3)",
VmmLogLevel::_4Verbose => "Verbose(4)",
VmmLogLevel::_5Debug => "Debug(5)",
VmmLogLevel::_6Trace => "Trace(6)",
VmmLogLevel::_7None => "None(7)",
};
write!(f, "{v}")
}
}
impl From<u32> for VmmMemoryModelType {
fn from(v : u32) -> Self {
return match v {
1 => VmmMemoryModelType::X86,
2 => VmmMemoryModelType::X86PAE,
3 => VmmMemoryModelType::X64,
_ => VmmMemoryModelType::NA,
};
}
}
impl fmt::Display for VmmMemoryModelType {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let v = match self {
VmmMemoryModelType::NA => "NA",
VmmMemoryModelType::X86 => "X86",
VmmMemoryModelType::X86PAE => "X86PAE",
VmmMemoryModelType::X64 => "X64",
};
write!(f, "{v}")
}
}
impl From<u32> for VmmSystemType {
fn from(v : u32) -> Self {
return match v {
1 => VmmSystemType::UnknownX64,
2 => VmmSystemType::WindowsX64,
3 => VmmSystemType::UnknownX86,
4 => VmmSystemType::WindowsX86,
_ => VmmSystemType::UnknownPhysical,
};
}
}
impl fmt::Display for VmmSystemType {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let v = match self {
VmmSystemType::UnknownPhysical => "UnknownPhysical",
VmmSystemType::UnknownX64 => "UnknownX64",
VmmSystemType::WindowsX64 => "WindowsX64",
VmmSystemType::UnknownX86 => "UnknownX86",
VmmSystemType::WindowsX86 => "WindowsX86",
};
write!(f, "{v}")
}
}
impl From<u32> for VmmIntegrityLevelType {
fn from(v : u32) -> Self {
return match v {
1 => VmmIntegrityLevelType::Untrusted,
2 => VmmIntegrityLevelType::Low,
3 => VmmIntegrityLevelType::Medium,
4 => VmmIntegrityLevelType::MediumPlus,
5 => VmmIntegrityLevelType::High,
6 => VmmIntegrityLevelType::System,
7 => VmmIntegrityLevelType::Protected,
_ => VmmIntegrityLevelType::Unknown,
};
}
}
impl fmt::Display for VmmIntegrityLevelType {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let v = match self {
VmmIntegrityLevelType::Untrusted => "Untrusted",
VmmIntegrityLevelType::Low => "Low",
VmmIntegrityLevelType::Medium => "Medium",
VmmIntegrityLevelType::MediumPlus => "MediumPlus",
VmmIntegrityLevelType::High => "High",
VmmIntegrityLevelType::System => "System",
VmmIntegrityLevelType::Protected => "Protected",
VmmIntegrityLevelType::Unknown => "Unknown",
};
write!(f, "{v}")
}
}
impl From<u32> for VmmMapPfnType {
fn from(v : u32) -> Self {
return match v {
0 => VmmMapPfnType::Zero,
1 => VmmMapPfnType::Free,
2 => VmmMapPfnType::Standby,
3 => VmmMapPfnType::Modified,
4 => VmmMapPfnType::ModifiedNoWrite,
5 => VmmMapPfnType::Bad,
6 => VmmMapPfnType::Active,
_ => VmmMapPfnType::Transition,
};
}
}
impl fmt::Display for VmmMapPfnType {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let v = match self {
VmmMapPfnType::Zero => "Zero",
VmmMapPfnType::Free => "Free",
VmmMapPfnType::Standby => "Standby",
VmmMapPfnType::Modified => "Modified",
VmmMapPfnType::ModifiedNoWrite => "ModifiedNoWrite",
VmmMapPfnType::Bad => "Bad",
VmmMapPfnType::Active => "Active",
VmmMapPfnType::Transition => "Transition",
};
write!(f, "{v}")
}
}
impl From<u32> for VmmMapPfnTypeExtended {
fn from(v : u32) -> Self {
return match v {
1 => VmmMapPfnTypeExtended::Unused,
2 => VmmMapPfnTypeExtended::ProcessPrivate,
3 => VmmMapPfnTypeExtended::PageTable,
4 => VmmMapPfnTypeExtended::LargePage,
5 => VmmMapPfnTypeExtended::DriverLocked,
6 => VmmMapPfnTypeExtended::Shareable,
7 => VmmMapPfnTypeExtended::File,
_ => VmmMapPfnTypeExtended::Unknown,
};
}
}
impl fmt::Display for VmmMapPfnTypeExtended {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let v = match self {
VmmMapPfnTypeExtended::Unused => "Unused",
VmmMapPfnTypeExtended::ProcessPrivate => "ProcessPrivate",
VmmMapPfnTypeExtended::PageTable => "PageTable",
VmmMapPfnTypeExtended::LargePage => "LargePage",
VmmMapPfnTypeExtended::DriverLocked => "DriverLocked",
VmmMapPfnTypeExtended::Shareable => "Shareable",
VmmMapPfnTypeExtended::File => "File",
VmmMapPfnTypeExtended::Unknown => "Unknown",
};
write!(f, "{v}")
}
}
#[repr(C)]
#[allow(non_snake_case)]
struct CVmEntry {
hVM : usize,
uszName : *const c_char,
gpaMax : u64,
tp : u32,
fActive : bool,
fReadOnly : bool,
fPhysicalOnly : bool,
dwPartitionID : u32,
dwVersionBuild : u32,
tpSystem : u32,
dwParentVmmMountID : u32,
dwVmMemPID : u32,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CVmMap {
dwVersion : u32,
_Reserved1 : [u32; 5],
pbMultiText : *const c_char,
cbMultiText : u32,
cMap : u32,
pMap : CVmEntry,
}
impl fmt::Display for VmmMapPfnEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmMapPfnEntry:{}", self.pfn)
}
}
impl fmt::Display for VmmMapMemoryEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmMapMemoryEntry:{:x}->{:x}", self.pa, self.pa + self.cb - 1)
}
}
impl fmt::Display for VmmMapNetEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmMapNetEntry:'{}'", self.desc)
}
}
impl PartialEq for VmmMapNetEntry {
fn eq(&self, other: &Self) -> bool {
self.va_object == other.va_object
}
}
impl fmt::Display for VmmMapPoolEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmMapPoolEntry:'{}':{:x}", self.tag_to_string(), self.va)
}
}
impl PartialEq for VmmMapPoolEntry {
fn eq(&self, other: &Self) -> bool {
self.va == other.va
}
}
impl fmt::Display for VmmMapServiceEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmMapServiceEntry:{}", self.name)
}
}
impl fmt::Display for VmmMapUserEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmMapUserEntry:[{}]", self.user)
}
}
impl fmt::Display for VmmMapVirtualMachineEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmMapVirtualMachineEntry:[{}]", self.name)
}
}
#[repr(C)]
#[allow(non_snake_case)]
struct CPfnEntry {
dwPfn : u32,
tpExtended : u32,
dwPfnPte : [u32; 5],
va : u64,
vaPte : u64,
OriginalPte : u64,
u3 : u32,
u4 : u64,
_FutureUse : [u32; 6],
}
#[repr(C)]
#[allow(non_snake_case)]
struct CPfnMap {
dwVersion : u32,
_Reserved1 : [u32; 5],
cMap : u32,
pMap : CPfnEntry,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CNetMapEntry {
dwPID : u32,
dwState : u32,
_FutureUse3 : [u16; 3],
AF : u16,
src_fValid : bool,
src__Reserved : u16,
src_port : u16,
src_pbAddr : [u8; 16],
src_uszText : *const c_char,
dst_fValid : bool,
dst__Reserved : u16,
dst_port : u16,
dst_pbAddr : [u8; 16],
dst_uszText : *const c_char,
vaObj : u64,
ftTime : u64,
dwPoolTag : u32,
_FutureUse4 : u32,
uszText : *const c_char,
_FutureUse2 : [u32; 4],
}
#[repr(C)]
#[allow(non_snake_case)]
struct CNetMap {
dwVersion : u32,
_Reserved1 : u32,
pbMultiText : *const c_char,
cbMultiText : u32,
cMap : u32,
pMap : CNetMapEntry,
}
#[repr(C)]
struct CMemoryMapEntry {
pa : u64,
cb : u64,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CMemoryMap {
dwVersion : u32,
_Reserved1 : [u32; 5],
cMap : u32,
_Reserved2 : u32,
pMap : CMemoryMapEntry,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CPoolEntry {
va : u64,
dwTag : u32,
_ReservedZero : u8,
fAlloc : u8,
tpPool : u8,
tpSS : u8,
cb : u32,
_Filler : u32,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CPoolMap {
dwVersion : u32,
_Reserved1 : [u32; 6],
cbTotal : u32,
piTag2Map : usize, // ptr
pTag : usize, // ptr
cTag : u32,
cMap : u32,
pMap : CPoolEntry,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CServiceEntry {
vaObj : u64,
dwOrdinal : u32,
dwStartType : u32,
dwServiceType : u32,
dwCurrentState : u32,
dwControlsAccepted : u32,
dwWin32ExitCode : u32,
dwServiceSpecificExitCode : u32,
dwCheckPoint : u32,
wWaitHint : u32,
uszServiceName : *const c_char,
uszDisplayName : *const c_char,
uszPath : *const c_char,
uszUserTp : *const c_char,
uszUserAcct : *const c_char,
uszImagePath : *const c_char,
dwPID : u32,
_FutureUse1 : u32,
_FutureUse2 : u64,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CServiceMap {
dwVersion : u32,
_Reserved1 : [u32; 5],
pbMultiText : *const c_char,
cbMultiText : u32,
cMap : u32,
pMap : CServiceEntry,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CUserEntry {
_FutureUse1 : [u32; 2],
uszText : *const c_char,
vaRegHive : u64,
uszSID : *const c_char,
_FutureUse2 : [u32; 2],
}
#[repr(C)]
#[allow(non_snake_case)]
struct CUserMap {
dwVersion : u32,
_Reserved1 : [u32; 5],
pbMultiText : *const c_char,
cbMultiText : u32,
cMap : u32,
pMap : CUserEntry,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CRegHive {
magic : u64,
wVersion : u16,
wSize : u16,
_FutureReserved1 : [u8; 0x34],
vaCMHIVE : u64,
vaHBASE_BLOCK : u64,
cbLength : u32,
uszName : [i8; 128],
uszNameShort : [i8; 32 + 1],
uszHiveRootPath : [i8; 260],
_FutureReserved : [u64; 0x10],
}
impl fmt::Display for VmmVfsEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
if self.is_directory {
write!(f, "VmmVfsEntry:D:'{}'", self.name,)
} else {
write!(f, "VmmVfsEntry:F:'{}':0x{:x}", self.name, self.size)
}
}
}
#[repr(C)]
#[allow(non_snake_case, non_camel_case_types)]
struct CVMMDLL_VFS_FILELIST2 {
dwVersion : u32,
pfnAddFile : extern "C" fn(h : &mut Vec<VmmVfsEntry>, uszName : *const c_char, cb : u64, pExInfo : usize),
pfnAddDirectory : extern "C" fn(h : &mut Vec<VmmVfsEntry>, uszName : *const c_char, pExInfo : usize),
h : *mut Vec<VmmVfsEntry>,
}
extern "C" fn vfs_list_addfile_cb(h : &mut Vec<VmmVfsEntry>, name : *const c_char, cb : u64, _p_ex_info : usize) {
unsafe {
if name.is_null() { return; }
if let Ok(name) = CStr::from_ptr(name).to_str() {
let e = VmmVfsEntry {
name : name.to_string(),
is_directory : false,
size : cb,
};
h.push(e);
}
}
}
extern "C" fn vfs_list_adddirectory_cb(h : &mut Vec<VmmVfsEntry>, name : *const c_char, _p_ex_info : usize) {
unsafe {
if name.is_null() { return; }
if let Ok(name) = CStr::from_ptr(name).to_str() {
let e = VmmVfsEntry {
name : name.to_string(),
is_directory : true,
size : 0,
};
h.push(e);
}
}
}
unsafe fn cstr_to_string(sz : *const c_char) -> String {
return if sz.is_null() {
String::from("")
} else {
String::from(CStr::from_ptr(sz).to_str().unwrap_or(""))
};
}
unsafe fn cstr_to_string_lossy(sz : *const c_char) -> String {
return if sz.is_null() {
String::from("")
} else {
String::from_utf8_lossy(CStr::from_ptr(sz).to_bytes()).to_string()
};
}
#[allow(non_snake_case)]
impl Vmm<'_> {
fn impl_get_leechcore(&self) -> ResultEx<LeechCore> {
let lc_handle = self.get_config(CONFIG_OPT_CORE_LEECHCORE_HANDLE)?;
let lc_lib_path = self.path_lc.as_str();
let device_config_string = format!("existing://0x{:x}", lc_handle);
return LeechCore::new(lc_lib_path, device_config_string.as_str(), 0);
}
fn impl_log(&self, log_mid : u32, log_level : &VmmLogLevel, log_message : &str) {
let c_loglevel : u32 = match log_level {
VmmLogLevel::_1Critical => 1,
VmmLogLevel::_2Warning => 2,
VmmLogLevel::_3Info => 3,
VmmLogLevel::_4Verbose => 4,
VmmLogLevel::_5Debug => 5,
VmmLogLevel::_6Trace => 6,
VmmLogLevel::_7None => 7,
};
let sz_log_fmt = CString::new("%s").unwrap();
let sz_log_message = CString::new(log_message).unwrap();
let _r = (self.native.VMMDLL_Log)(self.native.h, log_mid, c_loglevel, sz_log_fmt.as_ptr(), sz_log_message.as_ptr());
}
fn impl_get_config(&self, config_id : u64) -> ResultEx<u64> {
let mut v = 0;
let f = (self.native.VMMDLL_ConfigGet)(self.native.h, config_id, &mut v);
return if f { Ok(v) } else { Err(anyhow!("VMMDLL_ConfigGet: fail")) };
}
fn impl_set_config(&self, config_id : u64, config_value : u64) -> ResultEx<()> {
let f = (self.native.VMMDLL_ConfigSet)(self.native.h, config_id, config_value);
return if f { Ok(()) } else { Err(anyhow!("VMMDLL_ConfigSet: fail")) };
}
fn impl_process_from_pid(&self, pid : u32) -> ResultEx<VmmProcess> {
let process_list = self.process_list()?;
let process = VmmProcess {
vmm : &self,
pid : pid,
};
if process_list.contains(&process) {
return Ok(process);
}
return Err(anyhow!("VMMDLL_PidGetFromName: fail. PID '{pid}' does not exist."));
}
fn impl_process_from_name(&self, process_name : &str) -> ResultEx<VmmProcess> {
let mut pid = 0;
let sz_process_name = CString::new(process_name)?;
let r = (self.native.VMMDLL_PidGetFromName)(self.native.h, sz_process_name.as_ptr(), &mut pid);
if !r {
return Err(anyhow!("VMMDLL_PidGetFromName: fail. Process '{process_name}' does not exist."));
}
return Ok(VmmProcess {
vmm : &self,
pid : pid,
});
}
fn impl_process_list(&self) -> ResultEx<Vec<VmmProcess>> {
let mut cpids : usize = 0;
let r = (self.native.VMMDLL_PidList)(self.native.h, std::ptr::null_mut(), &mut cpids);
if !r || cpids > 0x00100000 {
return Err(anyhow!("VMMDLL_PidList: fail."));
}
let mut pids = vec![0u32; cpids];
let r = (self.native.VMMDLL_PidList)(self.native.h, pids.as_mut_ptr(), &mut cpids);
if !r || cpids > 0x00100000 {
return Err(anyhow!("VMMDLL_PidList: fail."));
}
let mut proclist = Vec::new();
for i in 0..cpids {
let proc = VmmProcess {
vmm : self,
pid : *pids.get(i).unwrap(),
};
proclist.push(proc);
}
return Ok(proclist);
}
fn impl_map_pfn(&self, pfns : &Vec<u32>, is_extended : bool) -> ResultEx<Vec<VmmMapPfnEntry>> {
unsafe {
let mut structs = std::ptr::null_mut();
let flags = if is_extended { 1 } else { 0 };
let r = (self.native.VMMDLL_Map_GetPfnEx)(self.native.h, pfns.as_ptr(), u32::try_from(pfns.len())?, &mut structs, flags);
if !r {
return Err(anyhow!("VMMDLL_Map_GetPfnEx: fail."));
}
if (*structs).dwVersion != VMMDLL_MAP_PFN_VERSION {
(self.native.VMMDLL_MemFree)(structs as usize);
return Err(anyhow!("VMMDLL_Map_GetPfnEx: bad version [{} != {}].", (*structs).dwVersion, VMMDLL_MAP_PFN_VERSION));
}
let mut result = Vec::new();
if (*structs).cMap == 0 {
(self.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
let cMap : usize = (*structs).cMap.try_into()?;
let pMap = std::slice::from_raw_parts(&(*structs).pMap, cMap);
for i in 0..cMap {
let ne = &pMap[i];
let e = VmmMapPfnEntry {
pfn : ne.dwPfn,
location : VmmMapPfnType::from((ne.u3 >> 16) & 7),
is_prototype : if ne.u4 & 0x0200000000000000 > 0 { true } else { false },
color : u32::try_from(ne.u4 >> 58)?,
is_extended : is_extended,
tp_ex : VmmMapPfnTypeExtended::from(ne.tpExtended),
pid : ne.dwPfnPte[0],
ptes : [0, ne.dwPfnPte[1], ne.dwPfnPte[2], ne.dwPfnPte[3], ne.dwPfnPte[4]],
va : ne.va,
va_pte : ne.vaPte,
pte_original : ne.OriginalPte,
};
result.push(e);
}
(self.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
}
fn impl_map_memory(&self) -> ResultEx<Vec<VmmMapMemoryEntry>> {
unsafe {
let mut structs = std::ptr::null_mut();
let r = (self.native.VMMDLL_Map_GetPhysMem)(self.native.h, &mut structs);
if !r {
return Err(anyhow!("VMMDLL_Map_GetPhysMem: fail."));
}
if (*structs).dwVersion != VMMDLL_MAP_PHYSMEM_VERSION {
(self.native.VMMDLL_MemFree)(structs as usize);
return Err(anyhow!("VMMDLL_Map_GetPhysMem: bad version [{} != {}].", (*structs).dwVersion, VMMDLL_MAP_PHYSMEM_VERSION));
}
let mut result = Vec::new();
if (*structs).cMap == 0 {
(self.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
let cMap : usize = (*structs).cMap.try_into()?;
let pMap = std::slice::from_raw_parts(&(*structs).pMap, cMap);
for i in 0..cMap {
let ne = &pMap[i];
let e = VmmMapMemoryEntry {
pa : ne.pa,
cb : ne.cb,
};
result.push(e);
}
(self.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
}
fn impl_map_net(&self) -> ResultEx<Vec<VmmMapNetEntry>> {
unsafe {
let mut structs = std::ptr::null_mut();
let r = (self.native.VMMDLL_Map_GetNetU)(self.native.h, &mut structs);
if !r {
return Err(anyhow!("VMMDLL_Map_GetNetU: fail."));
}
if (*structs).dwVersion != VMMDLL_MAP_NET_VERSION {
(self.native.VMMDLL_MemFree)(structs as usize);
return Err(anyhow!("VMMDLL_Map_GetNetU: bad version [{} != {}].", (*structs).dwVersion, VMMDLL_MAP_NET_VERSION));
}
let mut result = Vec::new();
if (*structs).cMap == 0 {
(self.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
let cMap : usize = (*structs).cMap.try_into()?;
let pMap = std::slice::from_raw_parts(&(*structs).pMap, cMap);
for i in 0..cMap {
let ne = &pMap[i];
let e = VmmMapNetEntry {
pid : ne.dwPID,
state : ne.dwState,
address_family : ne.AF,
src_is_valid : ne.src_fValid,
src_port : ne.src_port,
src_addr_raw : ne.src_pbAddr,
src_str : cstr_to_string(ne.src_uszText),
dst_is_valid : ne.dst_fValid,
dst_port : ne.dst_port,
dst_addr_raw : ne.dst_pbAddr,
dst_str : cstr_to_string(ne.dst_uszText),
va_object : ne.vaObj,
filetime : ne.ftTime,
pool_tag : ne.dwPoolTag,
desc : cstr_to_string(ne.uszText),
};
result.push(e);
}
(self.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
}
fn impl_map_pool(&self, is_bigpool_only : bool) -> ResultEx<Vec<VmmMapPoolEntry>> {
unsafe {
let mut structs = std::ptr::null_mut();
let flags = if is_bigpool_only { 1 } else { 0 };
let r = (self.native.VMMDLL_Map_GetPool)(self.native.h, &mut structs, flags);
if !r {
return Err(anyhow!("VMMDLL_Map_GetPool: fail."));
}
if (*structs).dwVersion != VMMDLL_MAP_POOL_VERSION {
(self.native.VMMDLL_MemFree)(structs as usize);
return Err(anyhow!("VMMDLL_Map_GetPool: bad version [{} != {}].", (*structs).dwVersion, VMMDLL_MAP_POOL_VERSION));
}
let mut result = Vec::new();
if (*structs).cMap == 0 {
(self.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
let cMap : usize = (*structs).cMap.try_into()?;
let pMap = std::slice::from_raw_parts(&(*structs).pMap, cMap);
for i in 0..cMap {
let ne = &pMap[i];
let e = VmmMapPoolEntry {
va : ne.va,
cb : ne.cb,
tag : ne.dwTag,
is_alloc : ne.fAlloc != 0,
tp_pool : ne.tpPool,
tp_subsegment : ne.tpSS,
};
result.push(e);
}
(self.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
}
fn impl_map_service(&self) -> ResultEx<Vec<VmmMapServiceEntry>> {
unsafe {
let mut structs = std::ptr::null_mut();
let r = (self.native.VMMDLL_Map_GetServicesU)(self.native.h, &mut structs);
if !r {
return Err(anyhow!("VMMDLL_Map_GetServicesU: fail."));
}
if (*structs).dwVersion != VMMDLL_MAP_SERVICE_VERSION {
(self.native.VMMDLL_MemFree)(structs as usize);
return Err(anyhow!("VMMDLL_Map_GetServicesU: bad version [{} != {}].", (*structs).dwVersion, VMMDLL_MAP_SERVICE_VERSION));
}
let mut result = Vec::new();
if (*structs).cMap == 0 {
(self.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
let cMap : usize = (*structs).cMap.try_into()?;
let pMap = std::slice::from_raw_parts(&(*structs).pMap, cMap);
for i in 0..cMap {
let ne = &pMap[i];
let e = VmmMapServiceEntry {
ordinal : ne.dwOrdinal,
va_object : ne.vaObj,
pid : ne.dwPID,
start_type : ne.dwStartType,
service_type : ne.dwServiceType,
current_state : ne.dwCurrentState,
controls_accepted : ne.dwControlsAccepted,
win32_exit_code : ne.dwWin32ExitCode,
service_specific_exit_code : ne.dwServiceSpecificExitCode,
check_point : ne.dwCheckPoint,
wait_hint : ne.wWaitHint,
name : cstr_to_string(ne.uszServiceName),
name_display : cstr_to_string(ne.uszDisplayName),
path : cstr_to_string(ne.uszPath),
user_type : cstr_to_string(ne.uszUserTp),
user_account : cstr_to_string(ne.uszUserAcct),
image_path : cstr_to_string(ne.uszImagePath),
};
result.push(e);
}
(self.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
}
fn impl_map_user(&self) -> ResultEx<Vec<VmmMapUserEntry>> {
unsafe {
let mut structs = std::ptr::null_mut();
let r = (self.native.VMMDLL_Map_GetUsersU)(self.native.h, &mut structs);
if !r {
return Err(anyhow!("VMMDLL_Map_GetUsersU: fail."));
}
if (*structs).dwVersion != VMMDLL_MAP_USER_VERSION {
(self.native.VMMDLL_MemFree)(structs as usize);
return Err(anyhow!("VMMDLL_Map_GetUsersU: bad version [{} != {}].", (*structs).dwVersion, VMMDLL_MAP_USER_VERSION));
}
let mut result = Vec::new();
if (*structs).cMap == 0 {
(self.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
let cMap : usize = (*structs).cMap.try_into()?;
let pMap = std::slice::from_raw_parts(&(*structs).pMap, cMap);
for i in 0..cMap {
let ne = &pMap[i];
let e = VmmMapUserEntry {
user : cstr_to_string(ne.uszText),
sid : cstr_to_string(ne.uszSID),
va_reg_hive : ne.vaRegHive,
};
result.push(e);
}
(self.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
}
fn impl_map_virtual_machine(&self) -> ResultEx<Vec<VmmMapVirtualMachineEntry>> {
unsafe {
let mut structs = std::ptr::null_mut();
let r = (self.native.VMMDLL_Map_GetVMU)(self.native.h, &mut structs);
if !r {
return Err(anyhow!("VMMDLL_Map_GetVMU: fail."));
}
if (*structs).dwVersion != VMMDLL_MAP_VM_VERSION {
(self.native.VMMDLL_MemFree)(structs as usize);
return Err(anyhow!("VMMDLL_Map_GetVMU: bad version [{} != {}].", (*structs).dwVersion, VMMDLL_MAP_VM_VERSION));
}
let mut result = Vec::new();
if (*structs).cMap == 0 {
(self.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
let cMap : usize = (*structs).cMap.try_into()?;
let pMap = std::slice::from_raw_parts(&(*structs).pMap, cMap);
for i in 0..cMap {
let ne = &pMap[i];
let e = VmmMapVirtualMachineEntry {
h_vmm : self.native.h,
h_vm : ne.hVM,
name : cstr_to_string(ne.uszName),
gpa_max : ne.gpaMax,
tp_vm : ne.tp,
is_active : ne.fActive,
is_readonly : ne.fReadOnly,
is_physicalonly : ne.fPhysicalOnly,
partition_id : ne.dwPartitionID,
guest_os_version_build : ne.dwVersionBuild,
guest_tp_system : ne.tpSystem,
parent_mount_id : ne.dwParentVmmMountID,
vmmem_pid : ne.dwVmMemPID,
};
result.push(e);
}
(self.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
}
fn impl_mem_read(&self, pid : u32, va : u64, size : usize, flags : u64) -> ResultEx<Vec<u8>> {
let cb = u32::try_from(size)?;
let mut cb_read = 0;
let mut pb_result = vec![0u8; size];
let r = (self.native.VMMDLL_MemReadEx)(self.native.h, pid, va, pb_result.as_mut_ptr(), cb, &mut cb_read, flags);
if !r {
return Err(anyhow!("VMMDLL_MemReadEx: fail."));
}
return Ok(pb_result);
}
fn impl_mem_read_as<T>(&self, pid : u32, va : u64, flags : u64) -> ResultEx<T> {
unsafe {
let cb = u32::try_from(std::mem::size_of::<T>())?;
let mut cb_read = 0;
let mut result : T = std::mem::zeroed();
let r = (self.native.VMMDLL_MemReadEx)(self.native.h, pid, va, &mut result as *mut _ as *mut u8, cb, &mut cb_read, flags);
if !r {
return Err(anyhow!("VMMDLL_MemReadEx: fail."));
}
return Ok(result);
}
}
fn impl_mem_scatter(&self, pid : u32, flags : u64) -> ResultEx<VmmScatterMemory> {
let flags = u32::try_from(flags)?;
let r = (self.native.VMMDLL_Scatter_Initialize)(self.native.h, pid, flags);
if r == 0 {
return Err(anyhow!("VMMDLL_Scatter_Initialize: fail."));
}
return Ok(VmmScatterMemory {
vmm : &self,
hs : r,
pid,
flags,
is_scatter_ex : false,
});
}
fn impl_mem_virt2phys(&self, pid : u32, va : u64) -> ResultEx<u64> {
let mut pa : u64 = 0;
let r = (self.native.VMMDLL_MemVirt2Phys)(self.native.h, pid, va, &mut pa);
if !r {
return Err(anyhow!("VMMDLL_MemVirt2Phys: fail."));
}
return Ok(pa);
}
fn impl_mem_write(&self, pid : u32, va : u64, data : &Vec<u8>) -> ResultEx<()> {
let cb = u32::try_from(data.len())?;
let pb = data.as_ptr();
let r = (self.native.VMMDLL_MemWrite)(self.native.h, pid, va, pb, cb);
if !r {
return Err(anyhow!("VMMDLL_MemWrite: fail."));
}
return Ok(());
}
fn impl_mem_write_as<T>(&self, pid : u32, va : u64, data : &T) -> ResultEx<()> {
let cb = u32::try_from(std::mem::size_of::<T>())?;
let r = (self.native.VMMDLL_MemWrite)(self.native.h, pid, va, data as *const _ as *const u8, cb);
if !r {
return Err(anyhow!("VMMDLL_MemWrite: fail."));
}
return Ok(());
}
fn impl_vfs_list(&self, path : &str) -> ResultEx<Vec<VmmVfsEntry>> {
let c_path = CString::new(str::replace(path, "/", "\\"))?;
let mut vec_result : Vec<VmmVfsEntry> = Vec::new();
let ptr_result : *mut Vec<VmmVfsEntry> = &mut vec_result;
let mut filelist2 = CVMMDLL_VFS_FILELIST2 {
dwVersion : VMMDLL_VFS_FILELIST_VERSION,
pfnAddFile : vfs_list_addfile_cb,
pfnAddDirectory : vfs_list_adddirectory_cb,
h : ptr_result,
};
let r = (self.native.VMMDLL_VfsListU)(self.native.h, c_path.as_ptr(), &mut filelist2);
if !r {
return Err(anyhow!("VMMDLL_VfsListU: fail."));
}
return Ok(vec_result);
}
fn impl_vfs_read(&self, filename : &str, size : u32, offset : u64) -> ResultEx<Vec<u8>> {
let c_filename = CString::new(str::replace(filename, "/", "\\"))?;
let mut cb_read = 0u32;
let mut data = vec![0u8; size as usize];
let ntstatus = (self.native.VMMDLL_VfsReadU)(self.native.h, c_filename.as_ptr(), data.as_mut_ptr(), size, &mut cb_read, offset);
if ntstatus != 0 && ntstatus != 0xC0000011 {
return Err(anyhow!("VMMDLL_VfsReadU: fail."));
}
if cb_read < size {
data.resize(cb_read as usize, 0);
}
return Ok(data);
}
fn impl_vfs_write(&self, filename : &str, data : Vec<u8>, offset : u64) {
if data.len() < u32::MAX as usize {
let c_filename = CString::new(str::replace(filename, "/", "\\")).unwrap();
let mut cb_write = 0u32;
let _ntstatus = (self.native.VMMDLL_VfsWriteU)(self.native.h, c_filename.as_ptr(), data.as_ptr(), data.len() as u32, &mut cb_write, offset);
}
}
fn impl_reg_hive_list(&self) -> ResultEx<Vec<VmmRegHive>> {
unsafe {
let mut cHives = 0;
let r = (self.native.VMMDLL_WinReg_HiveList)(self.native.h, std::ptr::null_mut(), 0, &mut cHives);
if !r {
return Err(anyhow!("VMMDLL_WinReg_HiveList: fail."));
}
if cHives == 0 {
return Ok(Vec::new());
}
let size = std::mem::size_of::<CRegHive>();
let mut bytes = vec![0u8; size * cHives as usize];
let ptr = bytes.as_mut_ptr() as *mut CRegHive;
let r = (self.native.VMMDLL_WinReg_HiveList)(self.native.h, ptr, cHives, &mut cHives);
if !r {
return Err(anyhow!("VMMDLL_WinReg_HiveList: fail."));
}
if cHives == 0 {
return Ok(Vec::new());
}
let mut result = Vec::new();
let pMap = std::slice::from_raw_parts(ptr, cHives as usize);
for i in 0..cHives as usize {
let ne = &pMap[i];
if (ne.magic != VMMDLL_REGISTRY_HIVE_INFORMATION_MAGIC) || (ne.wVersion != VMMDLL_REGISTRY_HIVE_INFORMATION_VERSION) {
return Err(anyhow!("Hive Bad Version."));
}
let e = VmmRegHive {
vmm : &self,
va : ne.vaCMHIVE,
va_baseblock : ne.vaHBASE_BLOCK,
size : ne.cbLength,
name : cstr_to_string_lossy(ne.uszName.as_ptr() as *const c_char),
name_short : cstr_to_string_lossy(ne.uszNameShort.as_ptr() as *const c_char),
path : cstr_to_string_lossy(ne.uszHiveRootPath.as_ptr() as *const c_char),
};
result.push(e);
}
return Ok(result);
}
}
fn impl_reg_pathsplit(path : &str) -> ResultEx<(&str, &str)> {
let path = path.trim_end_matches('\\');
if let Some(split) = path.rsplit_once('\\') {
if (split.0.len() > 0) && (split.1.len() > 0) {
return Ok(split);
}
}
return Err(anyhow!("[err]"));
}
fn impl_reg_key(&self, path : &str) -> ResultEx<VmmRegKey> {
let mut ftLastWrite = 0;
let mut cch = 0;
let c_path = CString::new(path)?;
let r = (self.native.VMMDLL_WinReg_EnumKeyExU)(self.native.h, c_path.as_ptr(), u32::MAX, std::ptr::null_mut(), &mut cch, &mut ftLastWrite);
if !r {
return Err(anyhow!("VMMDLL_WinReg_EnumKeyExU: fail."));
}
let pathname = Vmm::impl_reg_pathsplit(path)?;
let result = VmmRegKey {
vmm : &self,
name : String::from(pathname.1),
path : String::from(path),
ft_last_write : ftLastWrite,
};
return Ok(result);
}
fn impl_reg_value(&self, path : &str) -> ResultEx<VmmRegValue> {
let mut raw_value = None;
let mut raw_type = 0;
let mut v = [0u8; 64];
let mut raw_size = v.len() as u32;
let c_path = CString::new(path)?;
let r = (self.native.VMMDLL_WinReg_QueryValueExU)(self.native.h, c_path.as_ptr(), &mut raw_type, v.as_mut_ptr(), &mut raw_size);
if !r {
return Err(anyhow!("VMMDLL_WinReg_QueryValueExU: fail."));
}
if raw_size < v.len() as u32 {
raw_value = Some(v[0..raw_size as usize].to_vec());
} else {
let r = (self.native.VMMDLL_WinReg_QueryValueExU)(self.native.h, c_path.as_ptr(), std::ptr::null_mut(), std::ptr::null_mut(), &mut raw_size);
if !r {
return Err(anyhow!("VMMDLL_WinReg_QueryValueExU: fail."));
}
}
let pathname = Vmm::impl_reg_pathsplit(path)?;
let result = VmmRegValue {
vmm : &self,
name : String::from(pathname.1),
path : String::from(path),
raw_type,
raw_size,
raw_value,
};
return Ok(result);
}
}
//=============================================================================
// INTERNAL: VMM.KERNEL:
//=============================================================================
impl fmt::Display for VmmKernel<'_> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmKernel")
}
}
//=============================================================================
// INTERNAL: VMM.PDB:
//=============================================================================
impl fmt::Display for VmmPdb<'_> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmPdb:{}", self.module)
}
}
impl VmmPdb<'_> {
fn impl_symbol_name_from_address(&self, va_or_offset : u64) -> ResultEx<(String, u32)> {
let c_module = CString::new(self.module.as_str())?;
let mut c_symbol_name = [0 as c_char; MAX_PATH];
let mut result_symbol_displacement = 0;
let r = (self.vmm.native.VMMDLL_PdbSymbolName)(self.vmm.native.h, c_module.as_ptr(), va_or_offset, c_symbol_name.as_mut_ptr(), &mut result_symbol_displacement);
if !r {
return Err(anyhow!("VMMDLL_PdbSymbolName: fail."));
}
let string_symbol_name = unsafe { cstr_to_string_lossy(c_symbol_name.as_ptr()) };
return Ok((string_symbol_name, result_symbol_displacement));
}
fn impl_symbol_address_from_name(&self, symbol_name : &str) -> ResultEx<u64> {
let c_module = CString::new(self.module.as_str())?;
let c_symbol_name = CString::new(symbol_name)?;
let mut result = 0;
let r = (self.vmm.native.VMMDLL_PdbSymbolAddress)(self.vmm.native.h, c_module.as_ptr(), c_symbol_name.as_ptr(), &mut result);
if !r {
return Err(anyhow!("VMMDLL_PdbSymbolAddress: fail."));
}
return Ok(result);
}
fn impl_type_size(&self, type_name : &str) -> ResultEx<u32> {
let c_module = CString::new(self.module.as_str())?;
let c_type_name = CString::new(type_name)?;
let mut result = 0;
let r = (self.vmm.native.VMMDLL_PdbTypeSize)(self.vmm.native.h, c_module.as_ptr(), c_type_name.as_ptr(), &mut result);
if !r {
return Err(anyhow!("VMMDLL_PdbTypeSize: fail."));
}
return Ok(result);
}
fn impl_type_child_offset(&self, type_name : &str, type_child_name : &str) -> ResultEx<u32> {
let c_module = CString::new(self.module.as_str())?;
let c_type_name = CString::new(type_name)?;
let c_type_child_name = CString::new(type_child_name)?;
let mut result = 0;
let r = (self.vmm.native.VMMDLL_PdbTypeChildOffset)(self.vmm.native.h, c_module.as_ptr(), c_type_name.as_ptr(), c_type_child_name.as_ptr(), &mut result);
if !r {
return Err(anyhow!("VMMDLL_PdbTypeChildOffset: fail."));
}
return Ok(result);
}
}
//=============================================================================
// INTERNAL: VMM.REGISTRY:
//=============================================================================
impl fmt::Display for VmmRegHive<'_> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmRegHive:{:x}", self.va)
}
}
impl PartialEq for VmmRegHive<'_> {
fn eq(&self, other: &Self) -> bool {
self.va == other.va
}
}
impl fmt::Display for VmmRegKey<'_> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmRegKey:{}", self.name)
}
}
impl PartialEq for VmmRegKey<'_> {
fn eq(&self, other: &Self) -> bool {
self.name.eq(&other.name)
}
}
impl fmt::Display for VmmRegValueType {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let v = match self {
VmmRegValueType::REG_NONE => "REG_NONE".to_string(),
VmmRegValueType::REG_SZ(r) => format!("REG_SZ({r})"),
VmmRegValueType::REG_EXPAND_SZ(_) => "REG_EXPAND_SZ".to_string(),
VmmRegValueType::REG_BINARY(_) => "REG_BINARY".to_string(),
VmmRegValueType::REG_DWORD(r) => format!("REG_DWORD(0x{:x})", r),
VmmRegValueType::REG_DWORD_BIG_ENDIAN(r) => format!("REG_DWORD_BIG_ENDIAN(0x{:x})", r),
VmmRegValueType::REG_LINK(r) => format!("REG_LINK({r})"),
VmmRegValueType::REG_MULTI_SZ(_) => "REG_MULTI_SZ".to_string(),
VmmRegValueType::REG_RESOURCE_LIST(_) => "REG_RESOURCE_LIST".to_string(),
VmmRegValueType::REG_FULL_RESOURCE_DESCRIPTOR(_) => "REG_FULL_RESOURCE_DESCRIPTOR".to_string(),
VmmRegValueType::REG_RESOURCE_REQUIREMENTS_LIST(_) => "REG_RESOURCE_REQUIREMENTS_LIST".to_string(),
VmmRegValueType::REG_QWORD(r) => format!("REG_QWORD(0x{:x})", r),
};
write!(f, "{v}")
}
}
impl fmt::Display for VmmRegValue<'_> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmRegValue:{}", self.name)
}
}
impl PartialEq for VmmRegValue<'_> {
fn eq(&self, other: &Self) -> bool {
self.name.eq(&other.name)
}
}
impl VmmRegHive<'_> {
fn impl_reg_hive_read(&self, ra : u32, size : usize, flags : u64) -> ResultEx<Vec<u8>> {
let cb = u32::try_from(size)?;
let mut cb_read = 0;
let mut pb_result = vec![0u8; size];
let r = (self.vmm.native.VMMDLL_WinReg_HiveReadEx)(self.vmm.native.h, self.va, ra, pb_result.as_mut_ptr(), cb, &mut cb_read, flags);
if !r {
return Err(anyhow!("VMMDLL_WinReg_HiveReadEx: fail."));
}
return Ok(pb_result);
}
fn impl_reg_hive_write(&self, ra : u32, data : &Vec<u8>) -> ResultEx<()> {
let cb = u32::try_from(data.len())?;
let pb = data.as_ptr();
let r = (self.vmm.native.VMMDLL_WinReg_HiveWrite)(self.vmm.native.h, self.va, ra, pb, cb);
if !r {
return Err(anyhow!("VMMDLL_WinReg_HiveWrite: fail."));
}
return Ok(());
}
}
impl VmmRegKey<'_> {
fn impl_parent(&self) -> ResultEx<VmmRegKey> {
let pathfile = Vmm::impl_reg_pathsplit(self.path.as_str())?;
let result = self.vmm.impl_reg_key(pathfile.0)?;
return Ok(result);
}
#[allow(unused_assignments)]
fn impl_subkeys(&self) -> ResultEx<Vec<VmmRegKey>> {
unsafe {
let mut ft_last_write = 0;
let mut cch = 0;
let mut i = 0;
let mut data = [0; MAX_PATH+1];
let c_path = CString::new(self.path.as_str())?;
let mut result = Vec::new();
loop {
cch = data.len() as u32 - 1;
let r = (self.vmm.native.VMMDLL_WinReg_EnumKeyExU)(self.vmm.native.h, c_path.as_ptr(), i, data.as_mut_ptr(), &mut cch, &mut ft_last_write);
if !r {
break;
}
let name = cstr_to_string_lossy(data.as_ptr());
let path = format!("{}\\{}", self.path, name);
let e = VmmRegKey {
vmm : self.vmm,
name,
path,
ft_last_write,
};
result.push(e);
i += 1;
}
return Ok(result);
}
}
fn impl_values(&self) -> ResultEx<Vec<VmmRegValue>> {
return Err(anyhow!("Not implemented"));
}
}
impl VmmRegValue<'_> {
fn impl_parent(&self) -> ResultEx<VmmRegKey> {
let pathfile = Vmm::impl_reg_pathsplit(self.path.as_str())?;
let result = self.vmm.impl_reg_key(pathfile.0)?;
return Ok(result);
}
fn impl_raw_value(&self) -> ResultEx<Vec<u8>> {
if self.raw_value.is_some() {
return Ok(self.raw_value.as_ref().unwrap().clone());
}
// size larger than 64 bytes -> not cached in VmmRegValue.
if self.raw_size > 0x01000000 {
return Err(anyhow!("VmmRegKey size too large (>16MB)."));
}
let mut raw_value = vec![0; self.raw_size as usize];
let c_path = CString::new(self.path.clone())?;
let mut raw_size = self.raw_size;
let r = (self.vmm.native.VMMDLL_WinReg_QueryValueExU)(self.vmm.native.h, c_path.as_ptr(), std::ptr::null_mut(), raw_value.as_mut_ptr(), &mut raw_size);
if !r {
return Err(anyhow!("VMMDLL_WinReg_QueryValueExU: fail."));
}
return Ok(raw_value);
}
fn impl_value(&self) -> ResultEx<VmmRegValueType> {
const REG_NONE : u32 = 0;
const REG_SZ : u32 = 1;
const REG_EXPAND_SZ : u32 = 2;
const REG_BINARY : u32 = 3;
const REG_DWORD : u32 = 4;
const REG_DWORD_BIG_ENDIAN : u32 = 5;
const REG_LINK : u32 = 6;
const REG_MULTI_SZ : u32 = 7;
const REG_RESOURCE_LIST : u32 = 8;
const REG_FULL_RESOURCE_DESCRIPTOR : u32 = 9;
const REG_RESOURCE_REQUIREMENTS_LIST: u32 = 10;
const REG_QWORD : u32 = 11;
// Sanity checks and REG_NONE type:
if self.raw_type == REG_NONE {
return Ok(VmmRegValueType::REG_NONE);
}
if self.raw_type > REG_QWORD {
return Err(anyhow!("Unknown registry value type."));
}
// Get data using method call since data may be larger than cached data.
let raw_value = self.raw_value()?;
match self.raw_type {
REG_BINARY => return Ok(VmmRegValueType::REG_BINARY(raw_value)),
REG_RESOURCE_LIST => return Ok(VmmRegValueType::REG_RESOURCE_LIST(raw_value)),
REG_FULL_RESOURCE_DESCRIPTOR => return Ok(VmmRegValueType::REG_FULL_RESOURCE_DESCRIPTOR(raw_value)),
REG_RESOURCE_REQUIREMENTS_LIST => return Ok(VmmRegValueType::REG_RESOURCE_REQUIREMENTS_LIST(raw_value)),
_ => (),
};
if self.raw_type == REG_DWORD {
let v : [u8; 4] = raw_value.as_slice().try_into()?;
return Ok(VmmRegValueType::REG_DWORD(u32::from_le_bytes(v)));
}
if self.raw_type == REG_DWORD_BIG_ENDIAN {
let v : [u8; 4] = raw_value.as_slice().try_into()?;
return Ok(VmmRegValueType::REG_DWORD_BIG_ENDIAN(u32::from_be_bytes(v)));
}
if self.raw_type == REG_QWORD {
let v : [u8; 8] = raw_value.as_slice().try_into()?;
return Ok(VmmRegValueType::REG_QWORD(u64::from_le_bytes(v)));
}
// UTF16 below
if raw_value.len() % 2 == 1 {
return Err(anyhow!("Invalid size"));
}
let mut raw_chars = vec![0u16; raw_value.len() / 2];
unsafe {
// this will only work on little-endian archs (which should be most)
std::ptr::copy_nonoverlapping(raw_value.as_ptr(), raw_chars.as_mut_ptr() as *mut u8, raw_value.len());
}
if self.raw_type == REG_MULTI_SZ {
let mut result_vec = Vec::new();
for raw_string in raw_chars.split(|v| *v == 0) {
if raw_string.len() > 0 {
result_vec.push(String::from_utf16_lossy(raw_string));
}
}
return Ok(VmmRegValueType::REG_MULTI_SZ(result_vec));
}
// SZ EXPAND_SZ, LINK
let mut result_string = "".to_string();
if let Some(raw_string) = raw_chars.split(|v| *v == 0).next() {
result_string = String::from_utf16_lossy(raw_string);
}
match self.raw_type {
REG_SZ => return Ok(VmmRegValueType::REG_SZ(result_string)),
REG_EXPAND_SZ => return Ok(VmmRegValueType::REG_EXPAND_SZ(result_string)),
REG_LINK => return Ok(VmmRegValueType::REG_LINK(result_string)),
_ => return Err(anyhow!("[err]")),
};
}
}
//=============================================================================
// INTERNAL: VMM.PROCESS:
//=============================================================================
impl fmt::Display for VmmProcess<'_> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmProcess:{}", self.pid & 0x7fffffff)
}
}
impl PartialEq for VmmProcess<'_> {
fn eq(&self, other: &Self) -> bool {
self.pid == other.pid
}
}
impl fmt::Display for VmmProcessInfo {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmProcessInfo:{}:{}", self.pid & 0x7fffffff, self.name)
}
}
impl fmt::Display for VmmProcessMapEatEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmProcessMapEatEntry:{:x}:{}", self.va_function, self.function)
}
}
impl fmt::Display for VmmProcessMapHandleEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmProcessMapHandleEntry:{}:{:x}:{}:[{}]", self.pid & 0x7fffffff, self.handle_id, self.tp, self.info)
}
}
impl From<u32> for VmmProcessMapHeapType {
fn from(v : u32) -> Self {
return match v {
1 => VmmProcessMapHeapType::NtHeap,
2 => VmmProcessMapHeapType::SegmentHeap,
_ => VmmProcessMapHeapType::NA,
};
}
}
impl fmt::Display for VmmProcessMapHeapType {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let v = match self {
VmmProcessMapHeapType::NA => "NA",
VmmProcessMapHeapType::NtHeap => "NtHeap",
VmmProcessMapHeapType::SegmentHeap => "SegmentHeap",
};
write!(f, "{v}")
}
}
impl fmt::Display for VmmProcessMapHeapEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmProcessMapHeapAllocEntry:{}:{}:{}", self.pid & 0x7fffffff, self.number, self.tp)
}
}
impl From<u32> for VmmProcessMapHeapAllocType {
fn from(v : u32) -> Self {
return match v {
1 => VmmProcessMapHeapAllocType::NtHeap,
2 => VmmProcessMapHeapAllocType::NtLFH,
3 => VmmProcessMapHeapAllocType::NtLarge,
4 => VmmProcessMapHeapAllocType::NtNA,
5 => VmmProcessMapHeapAllocType::SegVS,
6 => VmmProcessMapHeapAllocType::SegLFH,
7 => VmmProcessMapHeapAllocType::SegLarge,
8 => VmmProcessMapHeapAllocType::SegNA,
_ => VmmProcessMapHeapAllocType::NA,
};
}
}
impl fmt::Display for VmmProcessMapHeapAllocType {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let v = match self {
VmmProcessMapHeapAllocType::NA => "NA",
VmmProcessMapHeapAllocType::NtHeap => "NtHeap",
VmmProcessMapHeapAllocType::NtLFH => "NtLFH",
VmmProcessMapHeapAllocType::NtLarge => "NtLarge",
VmmProcessMapHeapAllocType::NtNA => "NtNA",
VmmProcessMapHeapAllocType::SegVS => "SegVS",
VmmProcessMapHeapAllocType::SegLFH => "SegLFH",
VmmProcessMapHeapAllocType::SegLarge => "SegLarge",
VmmProcessMapHeapAllocType::SegNA => "SegNA",
};
write!(f, "{v}")
}
}
impl fmt::Display for VmmProcessMapHeapAllocEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmProcessMapHeapAllocEntry:{}:{}:{:x}", self.pid & 0x7fffffff, self.tp, self.va)
}
}
impl fmt::Display for VmmProcessMapIatEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmProcessMapIatEntry:{:x}:{}", self.va_function, self.function)
}
}
impl fmt::Display for VmmProcessMapPteEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmProcessMapPteEntry:{}:{:x}->{:x}", self.pid & 0x7fffffff, self.va_base, self.va_base + self.page_count * 0x1000 - 1)
}
}
impl fmt::Display for VmmProcessMapModuleEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmProcessMapModuleEntry:{}:{:x}:[{}]", self.pid & 0x7fffffff, self.va_base, self.name)
}
}
impl fmt::Display for VmmProcessMapModuleDebugEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmProcessMapModuleDebugEntry:[{}]", self.pdb_filename)
}
}
impl fmt::Display for VmmProcessMapModuleVersionEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmProcessMapModuleVersionEntry")
}
}
impl fmt::Display for VmmProcessMapThreadEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmProcessMapThreadEntry:{}:{:x}", self.pid & 0x7fffffff, self.thread_id)
}
}
impl fmt::Display for VmmProcessMapUnloadedModuleEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmProcessMapUnloadedModuleEntry:{}:{:x}:[{}]", self.pid & 0x7fffffff, self.va_base, self.name)
}
}
impl fmt::Display for VmmProcessMapVadEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmProcessMapVadEntry:{}:{:x}->{}", self.pid & 0x7fffffff, self.va_start, self.va_end)
}
}
impl From<u32> for VmmProcessMapVadExType {
fn from(v : u32) -> Self {
return match v {
1 => VmmProcessMapVadExType::Hardware,
2 => VmmProcessMapVadExType::Transition,
3 => VmmProcessMapVadExType::Prototype,
4 => VmmProcessMapVadExType::DemandZero,
5 => VmmProcessMapVadExType::Compressed,
6 => VmmProcessMapVadExType::Pagefile,
7 => VmmProcessMapVadExType::File,
_ => VmmProcessMapVadExType::NA,
};
}
}
impl fmt::Display for VmmProcessMapVadExType {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let v = match self {
VmmProcessMapVadExType::NA => "NA",
VmmProcessMapVadExType::Hardware => "Hardware",
VmmProcessMapVadExType::Transition => "Transition",
VmmProcessMapVadExType::Prototype => "Prototype",
VmmProcessMapVadExType::DemandZero => "DemandZero",
VmmProcessMapVadExType::Compressed => "Compressed",
VmmProcessMapVadExType::Pagefile => "Pagefile",
VmmProcessMapVadExType::File => "File",
};
write!(f, "{v}")
}
}
impl fmt::Display for VmmProcessMapVadExEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmProcessMapVadExEntry:{}:{:x}:{}", self.pid & 0x7fffffff, self.va, self.tp)
}
}
impl fmt::Display for VmmProcessMapDirectoryEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmProcessMapDirectoryEntry:{}:{}:{:x}:{:x}", self.pid & 0x7fffffff, self.name, self.virtual_address, self.size)
}
}
impl fmt::Display for VmmProcessSectionEntry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmProcessSectionEntry:{}:[{}]:{:x}:{:x}", self.pid & 0x7fffffff, self.name, self.virtual_address, self.misc_virtual_size)
}
}
impl From<u32> for VmmProcessMapModuleType {
fn from(v : u32) -> Self {
return match v {
1 => VmmProcessMapModuleType::Data,
2 => VmmProcessMapModuleType::NotLinked,
3 => VmmProcessMapModuleType::Injected,
_ => VmmProcessMapModuleType::Normal,
};
}
}
impl fmt::Display for VmmProcessMapModuleType {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let v = match self {
VmmProcessMapModuleType::Data => "Data",
VmmProcessMapModuleType::NotLinked => "NotLinked",
VmmProcessMapModuleType::Injected => "Injected",
VmmProcessMapModuleType::Normal => "Normal",
};
write!(f, "{v}")
}
}
#[repr(C)]
#[allow(non_snake_case)]
struct CProcessInformation {
magic : u64,
wVersion : u16,
wSize : u16,
tpMemoryModel : u32,
tpSystem : u32,
fUserOnly : bool,
dwPID : u32,
dwPPID : u32,
dwState : u32,
szName : [c_char; 16],
szNameLong : [c_char; 64],
paDTB : u64,
paDTB_UserOpt : u64,
vaEPROCESS : u64,
vaPEB : u64,
_Reserved1 : u64,
fWow64 : bool,
vaPEB32 : u32,
dwSessionId : u32,
qwLUID : u64,
szSID : [c_char; 260],
IntegrityLevel : u32,
}
#[repr(C)]
#[allow(non_snake_case, non_camel_case_types)]
#[derive(Clone, Default)]
struct CIMAGE_SECTION_HEADER {
Name : [u8; 8],
Misc_VirtualAddress : u32,
VirtualAddress : u32,
SizeOfRawData : u32,
PointerToRawData : u32,
PointerToRelocations : u32,
PointerToLinenumbers : u32,
NumberOfRelocations : u16,
NumberOfLinenumbers : u16,
Characteristics : u32,
}
#[repr(C)]
#[allow(non_snake_case, non_camel_case_types)]
#[derive(Clone, Default)]
struct CIMAGE_DATA_DIRECTORY {
VirtualAddress : u32,
Size : u32,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CEatEntry {
vaFunction : u64,
dwOrdinal : u32,
oFunctionsArray : u32,
oNamesArray : u32,
_FutureUse1 : u32,
uszFunction : *const c_char,
uszForwardedFunction : *const c_char,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CEatMap {
dwVersion : u32,
dwOrdinalBase : u32,
cNumberOfNames : u32,
cNumberOfFunctions : u32,
cNumberOfForwardedFunctions : u32,
_Reserved1 : [u32; 3],
vaModuleBase : u64,
vaAddressOfFunctions : u64,
vaAddressOfNames : u64,
pbMultiText : *const c_char,
cbMultiText : u32,
cMap : u32,
pMap : CEatEntry,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CHandleEntry {
vaObject : u64,
dwHandle : u32,
dwGrantedAccess_Tp : u32,
qwHandleCount : u64,
qwPointerCount : u64,
vaObjectCreateInfo : u64,
vaSecurityDescriptor : u64,
uszText : *const c_char,
_FutureUse2 : u32,
dwPID : u32,
dwPoolTag : u32,
_FutureUse : [u32; 7],
uszType : *const c_char,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CHandleMap {
dwVersion : u32,
_Reserved1 : [u32; 5],
pbMultiText : *const c_char,
cbMultiText : u32,
cMap : u32,
pMap : CHandleEntry,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CHeapEntry {
va : u64,
tp : u32,
f32 : bool,
iHeap : u32,
dwHeapNum : u32,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CHeapMap {
dwVersion : u32,
_Reserved1 : [u32; 7],
pSegments : usize,
cSegments : u32,
cMap : u32,
pMap : CHeapEntry,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CHeapAllocEntry {
va : u64,
cb : u32,
tp : u32,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CHeapAllocMap {
dwVersion : u32,
_Reserved1 : [u32; 7],
_Reserved2 : [usize; 2],
cMap : u32,
pMap : CHeapAllocEntry,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CIatEntry {
vaFunction : u64,
uszFunction : *const c_char,
_FutureUse1 : u32,
_FutureUse2 : u32,
uszModule : *const c_char,
thunk_f32 : bool,
thunk_wHint : u16,
thunk__Reserved1 : u16,
thunk_rvaFirstThunk : u32,
thunk_rvaOriginalFirstThunk : u32,
thunk_rvaNameModule : u32,
thunk_rvaNameFunction : u32,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CIatMap {
dwVersion : u32,
_Reserved1 : [u32; 5],
vaModuleBase : u64,
pbMultiText : *const c_char,
cbMultiText : u32,
cMap : u32,
pMap : CIatEntry,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CDebugInfo {
dwAge : u32,
_Reserved : u32,
Guid : [u8; 16],
uszGuid : *const c_char,
uszPdbFilename : *const c_char,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CVersionInfo {
uszCompanyName : *const c_char,
uszFileDescription : *const c_char,
uszFileVersion : *const c_char,
uszInternalName : *const c_char,
uszLegalCopyright : *const c_char,
uszOriginalFilename : *const c_char,
uszProductName : *const c_char,
uszProductVersion : *const c_char,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CModuleEntry {
vaBase : u64,
vaEntry : u64,
cbImageSize : u32,
fWoW64 : bool,
uszText : *const c_char,
_Reserved3 : u32,
_Reserved4 : u32,
uszFullName : *const c_char,
tp : u32,
cbFileSizeRaw : u32,
cSection : u32,
cEAT : u32,
cIAT : u32,
_Reserved2 : u32,
_Reserved1 : [u64; 3],
pExDebugInfo : *const CDebugInfo,
pExVersionInfo : *const CVersionInfo,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CModuleMap {
dwVersion : u32,
_Reserved1 : [u32; 5],
pbMultiText : *const c_char,
cbMultiText : u32,
cMap : u32,
pMap : CModuleEntry,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CPteEntry {
vaBase : u64,
cPages : u64,
fPage : u64,
fWoW64 : bool,
_FutureUse1 : u32,
uszText : *const c_char,
_Reserved1 : u32,
cSoftware : u32,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CPteMap {
dwVersion : u32,
_Reserved1 : [u32; 5],
pbMultiText : *const c_char,
cbMultiText : u32,
cMap : u32,
pMap : CPteEntry,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CThreadEntry {
dwTID : u32,
dwPID : u32,
dwExitStatus : u32,
bState : u8,
bRunning : u8,
bPriority : u8,
bBasePriority : u8,
vaETHREAD : u64,
vaTeb : u64,
ftCreateTime : u64,
ftExitTime : u64,
vaStartAddress : u64,
vaStackBaseUser : u64,
vaStackLimitUser : u64,
vaStackBaseKernel : u64,
vaStackLimitKernel : u64,
vaTrapFrame : u64,
vaRIP : u64,
vaRSP : u64,
qwAffinity : u64,
dwUserTime : u32,
dwKernelTime : u32,
bSuspendCount : u8,
bWaitReason : u8,
_FutureUse1 : [u8; 2],
_FutureUse2 : [u32; 11],
vaImpersonationToken : u64,
vaWin32StartAddress : u64,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CThreadMap {
dwVersion : u32,
_Reserved1 : [u32; 8],
cMap : u32,
pMap : CThreadEntry,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CUnloadedModuleEntry {
vaBase : u64,
cbImageSize : u32,
fWoW64 : bool,
uszText : *const c_char,
_FutureUse1 : u32,
dwCheckSum : u32,
dwTimeDateStamp : u32,
_Reserved1 : u32,
ftUnload : u64,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CUnloadedModuleMap {
dwVersion : u32,
_Reserved1 : [u32; 5],
pbMultiText : *const c_char,
cbMultiText : u32,
cMap : u32,
pMap : CUnloadedModuleEntry,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CVadEntry {
vaStart : u64,
vaEnd : u64,
vaVad : u64,
u0 : u32,
u1 : u32,
u2 : u32,
cbPrototypePte : u32,
vaPrototypePte : u64,
vaSubsection : u64,
uszText : *const c_char,
_FutureUse1 : u32,
_Reserved1 : u32,
vaFileObject : u64,
cVadExPages : u32,
cVadExPagesBase : u32,
_Reserved2 : u64,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CVadMap {
dwVersion : u32,
_Reserved1 : [u32; 4],
cPage : u32,
pbMultiText : *const c_char,
cbMultiText : u32,
cMap : u32,
pMap : CVadEntry,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CVadExEntry {
tp : u32,
iPML : u8,
pteFlags : u8,
_Reserved2 : u16,
va : u64,
pa : u64,
pte : u64,
proto__Reserved1 : u32,
proto_tp : u32,
proto_pa : u64,
proto_va : u64,
vaVadBase : u64,
}
#[repr(C)]
#[allow(non_snake_case)]
struct CVadExMap {
dwVersion : u32,
_Reserved1 : [u32; 4],
cMap : u32,
pMap : CVadExEntry,
}
#[allow(non_snake_case)]
impl VmmProcess<'_> {
fn impl_info(&self) -> ResultEx<VmmProcessInfo> {
let mut cb_pi = std::mem::size_of::<CProcessInformation>();
let mut pi = CProcessInformation {
magic : VMMDLL_PROCESS_INFORMATION_MAGIC,
wVersion : VMMDLL_PROCESS_INFORMATION_VERSION,
wSize : u16::try_from(cb_pi)?,
tpMemoryModel : 0,
tpSystem : 0,
fUserOnly : false,
dwPID : 0,
dwPPID : 0,
dwState : 0,
szName : [0; 16],
szNameLong : [0; 64],
paDTB : 0,
paDTB_UserOpt : 0,
vaEPROCESS : 0,
vaPEB : 0,
_Reserved1 : 0,
fWow64 : false,
vaPEB32 : 0,
dwSessionId : 0,
qwLUID : 0,
szSID : [0; 260],
IntegrityLevel : 0,
};
let raw_pi = &mut pi as *mut CProcessInformation;
let r = (self.vmm.native.VMMDLL_ProcessGetInformation)(self.vmm.native.h, self.pid, raw_pi, &mut cb_pi);
if !r {
return Err(anyhow!("VMMDLL_ProcessGetInformation: fail."));
}
let result = VmmProcessInfo {
tp_system : VmmSystemType::from(pi.tpSystem),
tp_memorymodel : VmmMemoryModelType::from(pi.tpMemoryModel),
is_user_mode : pi.fUserOnly,
pid : pi.dwPID,
ppid : pi.dwPPID,
state : pi.dwState,
name : unsafe { cstr_to_string_lossy(&pi.szName as *const c_char) },
name_long : unsafe { cstr_to_string_lossy(&pi.szNameLong as *const c_char) },
pa_dtb : pi.paDTB,
pa_dtb_user : pi.paDTB_UserOpt,
va_eprocess : pi.vaEPROCESS,
va_peb : pi.vaPEB,
is_wow64 : pi.fWow64,
va_peb32 : pi.vaPEB32,
session_id : pi.dwSessionId,
luid : pi.qwLUID,
sid : unsafe { cstr_to_string_lossy(&pi.szSID as *const c_char) },
integrity_level : VmmIntegrityLevelType::from(pi.IntegrityLevel),
};
return Ok(result);
}
fn impl_get_information_string(&self, option : u32) -> ResultEx<String> {
let r = (self.vmm.native.VMMDLL_ProcessGetInformationString)(self.vmm.native.h, self.pid, option);
if r.is_null() {
return Err(anyhow!("VMMDLL_ProcessGetInformationString: fail."));
}
let result = unsafe { cstr_to_string_lossy(r) };
(self.vmm.native.VMMDLL_MemFree)(r as usize);
return Ok(result);
}
fn impl_get_module_base(&self, module_name : &str) -> ResultEx<u64> {
let sz_module_name = CString::new(module_name)?;
let r = (self.vmm.native.VMMDLL_ProcessGetModuleBaseU)(self.vmm.native.h, self.pid, sz_module_name.as_ptr());
if r == 0 {
return Err(anyhow!("VMMDLL_ProcessGetModuleBaseU: fail."));
}
return Ok(r);
}
fn impl_get_proc_address(&self, module_name : &str, function_name : &str) -> ResultEx<u64> {
let sz_module_name = CString::new(module_name)?;
let sz_function_name = CString::new(function_name)?;
let r = (self.vmm.native.VMMDLL_ProcessGetProcAddressU)(self.vmm.native.h, self.pid, sz_module_name.as_ptr(), sz_function_name.as_ptr());
if r == 0 {
return Err(anyhow!("VMMDLL_ProcessGetProcAddressU: fail."));
}
return Ok(r);
}
fn impl_pdb_from_module_address(&self, va_module_base : u64) -> ResultEx<VmmPdb> {
let mut szModuleName = [0i8; MAX_PATH + 1];
let r = (self.vmm.native.VMMDLL_PdbLoad)(self.vmm.native.h, self.pid, va_module_base, szModuleName.as_mut_ptr() as *mut c_char);
if !r {
return Err(anyhow!("VMMDLL_PdbLoad: fail."));
}
let module = unsafe { cstr_to_string_lossy(szModuleName.as_ptr() as *const c_char) };
let pdb = VmmPdb {
vmm : self.vmm,
module,
};
return Ok(pdb);
}
fn impl_map_handle(&self) -> ResultEx<Vec<VmmProcessMapHandleEntry>> {
unsafe {
let mut structs = std::ptr::null_mut();
let r = (self.vmm.native.VMMDLL_Map_GetHandleU)(self.vmm.native.h, self.pid, &mut structs);
if !r {
return Err(anyhow!("VMMDLL_Map_GetHandleU: fail."));
}
if (*structs).dwVersion != VMMDLL_MAP_HANDLE_VERSION {
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Err(anyhow!("VMMDLL_Map_GetHandleU: bad version [{} != {}].", (*structs).dwVersion, VMMDLL_MAP_HANDLE_VERSION));
}
let mut result = Vec::new();
if (*structs).cMap == 0 {
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
let cMap : usize = (*structs).cMap.try_into()?;
let pMap = std::slice::from_raw_parts(&(*structs).pMap, cMap);
for i in 0..cMap {
let ne = &pMap[i];
let e = VmmProcessMapHandleEntry {
pid : self.pid,
va_object : ne.vaObject,
handle_id : ne.dwHandle,
granted_access : ne.dwGrantedAccess_Tp & 0x00ffffff,
type_index : (ne.dwGrantedAccess_Tp >> 24) & 0xff,
handle_count : ne.qwHandleCount,
pointer_count : ne.qwPointerCount,
va_object_create_info : ne.vaObjectCreateInfo,
va_security_descriptor : ne.vaSecurityDescriptor,
handle_pid : ne.dwPID,
pool_tag : ne.dwPoolTag,
info : cstr_to_string(ne.uszText),
tp : cstr_to_string(ne.uszType),
};
result.push(e);
}
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
}
fn impl_map_heap(&self) -> ResultEx<Vec<VmmProcessMapHeapEntry>> {
unsafe {
let mut structs = std::ptr::null_mut();
let r = (self.vmm.native.VMMDLL_Map_GetHeap)(self.vmm.native.h, self.pid, &mut structs);
if !r {
return Err(anyhow!("VMMDLL_Map_GetHeap: fail."));
}
if (*structs).dwVersion != VMMDLL_MAP_HEAP_VERSION {
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Err(anyhow!("VMMDLL_Map_GetHeap: bad version [{} != {}].", (*structs).dwVersion, VMMDLL_MAP_HEAP_VERSION));
}
let mut result = Vec::new();
if (*structs).cMap == 0 {
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
let cMap : usize = (*structs).cMap.try_into()?;
let pMap = std::slice::from_raw_parts(&(*structs).pMap, cMap);
for i in 0..cMap {
let ne = &pMap[i];
let e = VmmProcessMapHeapEntry {
pid : self.pid,
tp : VmmProcessMapHeapType::from(ne.tp),
is_32 : ne.f32,
index : ne.iHeap,
number : ne.dwHeapNum,
};
result.push(e);
}
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
}
fn impl_map_heapalloc(&self, heap_number_or_address : u64) -> ResultEx<Vec<VmmProcessMapHeapAllocEntry>> {
unsafe {
let mut structs = std::ptr::null_mut();
let r = (self.vmm.native.VMMDLL_Map_GetHeapAlloc)(self.vmm.native.h, self.pid, heap_number_or_address, &mut structs);
if !r {
return Err(anyhow!("VMMDLL_Map_GetHeapAlloc: fail."));
}
if (*structs).dwVersion != VMMDLL_MAP_HEAPALLOC_VERSION {
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Err(anyhow!("VMMDLL_Map_GetHeapAlloc: bad version [{} != {}].", (*structs).dwVersion, VMMDLL_MAP_HEAPALLOC_VERSION));
}
let mut result = Vec::new();
if (*structs).cMap == 0 {
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
let cMap : usize = (*structs).cMap.try_into()?;
let pMap = std::slice::from_raw_parts(&(*structs).pMap, cMap);
for i in 0..cMap {
let ne = &pMap[i];
let e = VmmProcessMapHeapAllocEntry {
pid : self.pid,
va : ne.va,
size : ne.cb,
tp : VmmProcessMapHeapAllocType::from(ne.tp),
};
result.push(e);
}
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
}
fn impl_map_module(&self, is_info_debug : bool, is_info_version : bool) -> ResultEx<Vec<VmmProcessMapModuleEntry>> {
unsafe {
let mut structs = std::ptr::null_mut();
let flags = 0 + if is_info_debug { 1 } else { 0 } + if is_info_version { 2 } else { 0 };
let r = (self.vmm.native.VMMDLL_Map_GetModuleU)(self.vmm.native.h, self.pid, &mut structs, flags);
if !r {
return Err(anyhow!("VMMDLL_Map_GetModuleU: fail."));
}
if (*structs).dwVersion != VMMDLL_MAP_MODULE_VERSION {
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Err(anyhow!("VMMDLL_Map_GetModuleU: bad version [{} != {}].", (*structs).dwVersion, VMMDLL_MAP_MODULE_VERSION));
}
let mut result = Vec::new();
if (*structs).cMap == 0 {
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
let cMap : usize = (*structs).cMap.try_into()?;
let pMap = std::slice::from_raw_parts(&(*structs).pMap, cMap);
for i in 0..cMap {
let ne = &pMap[i];
let mut debug_info = None;
if !ne.pExDebugInfo.is_null() {
let nei = &*ne.pExDebugInfo;
debug_info = Some(VmmProcessMapModuleDebugEntry {
pid : self.pid,
age : nei.dwAge,
raw_guid : nei.Guid,
guid : cstr_to_string(nei.uszGuid),
pdb_filename : cstr_to_string(nei.uszPdbFilename),
});
}
let mut version_info = None;
if !ne.pExVersionInfo.is_null() {
let nei = &*ne.pExVersionInfo;
version_info = Some(VmmProcessMapModuleVersionEntry {
pid : self.pid,
company_name : cstr_to_string(nei.uszCompanyName),
file_description : cstr_to_string(nei.uszFileDescription),
file_version : cstr_to_string(nei.uszFileVersion),
internal_name : cstr_to_string(nei.uszInternalName),
legal_copyright : cstr_to_string(nei.uszLegalCopyright),
original_file_name : cstr_to_string(nei.uszOriginalFilename),
product_name : cstr_to_string(nei.uszProductName),
product_version : cstr_to_string(nei.uszProductVersion),
});
}
let e = VmmProcessMapModuleEntry {
pid : self.pid,
va_base : ne.vaBase,
va_entry : ne.vaEntry,
image_size : ne.cbImageSize,
is_wow64 : ne.fWoW64,
tp : VmmProcessMapModuleType::from(ne.tp),
name : cstr_to_string(ne.uszText),
full_name : cstr_to_string(ne.uszFullName),
file_size_raw : ne.cbFileSizeRaw,
section_count : ne.cSection,
eat_count : ne.cEAT,
iat_count : ne.cIAT,
debug_info : debug_info,
version_info : version_info,
};
result.push(e);
}
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
}
fn impl_map_module_eat(&self, module_name : &str) -> ResultEx<Vec<VmmProcessMapEatEntry>> {
unsafe {
let mut structs = std::ptr::null_mut();
let sz_module_name = CString::new(module_name)?;
let r = (self.vmm.native.VMMDLL_Map_GetEATU)(self.vmm.native.h, self.pid, sz_module_name.as_ptr(), &mut structs);
if !r {
return Err(anyhow!("VMMDLL_Map_GetEATU: fail."));
}
if (*structs).dwVersion != VMMDLL_MAP_EAT_VERSION {
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Err(anyhow!("VMMDLL_Map_GetEATU: bad version [{} != {}].", (*structs).dwVersion, VMMDLL_MAP_EAT_VERSION));
}
let mut result = Vec::new();
if (*structs).cMap == 0 {
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
let cMap : usize = (*structs).cMap.try_into()?;
let pMap = std::slice::from_raw_parts(&(*structs).pMap, cMap);
for i in 0..cMap {
let ne = &pMap[i];
let e = VmmProcessMapEatEntry {
pid : self.pid,
va_function : ne.vaFunction,
ordinal : ne.dwOrdinal,
function : cstr_to_string(ne.uszFunction),
forwarded_function : cstr_to_string(ne.uszForwardedFunction),
};
result.push(e);
}
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
}
fn impl_map_module_iat(&self, module_name : &str) -> ResultEx<Vec<VmmProcessMapIatEntry>> {
unsafe {
let mut structs = std::ptr::null_mut();
let sz_module_name = CString::new(module_name)?;
let r = (self.vmm.native.VMMDLL_Map_GetIATU)(self.vmm.native.h, self.pid, sz_module_name.as_ptr(), &mut structs);
if !r {
return Err(anyhow!("VMMDLL_Map_GetIATU: fail."));
}
if (*structs).dwVersion != VMMDLL_MAP_IAT_VERSION {
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Err(anyhow!("VMMDLL_Map_GetIATU: bad version [{} != {}].", (*structs).dwVersion, VMMDLL_MAP_IAT_VERSION));
}
let mut result = Vec::new();
if (*structs).cMap == 0 {
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
let cMap : usize = (*structs).cMap.try_into()?;
let pMap = std::slice::from_raw_parts(&(*structs).pMap, cMap);
for i in 0..cMap {
let ne = &pMap[i];
let e = VmmProcessMapIatEntry {
pid : self.pid,
va_function : ne.vaFunction,
function : cstr_to_string(ne.uszFunction),
module : cstr_to_string(ne.uszModule),
};
result.push(e);
}
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
}
fn impl_map_pte(&self, is_identify_modules : bool) -> ResultEx<Vec<VmmProcessMapPteEntry>> {
unsafe {
let mut structs = std::ptr::null_mut();
let r = (self.vmm.native.VMMDLL_Map_GetPteU)(self.vmm.native.h, self.pid, is_identify_modules, &mut structs);
if !r {
return Err(anyhow!("VMMDLL_Map_GetPteU: fail."));
}
if (*structs).dwVersion != VMMDLL_MAP_PTE_VERSION {
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Err(anyhow!("VMMDLL_Map_GetPteU: bad version [{} != {}].", (*structs).dwVersion, VMMDLL_MAP_PTE_VERSION));
}
let mut result = Vec::new();
if (*structs).cMap == 0 {
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
let cMap : usize = (*structs).cMap.try_into()?;
let pMap = std::slice::from_raw_parts(&(*structs).pMap, cMap);
for i in 0..cMap {
let ne = &pMap[i];
let e = VmmProcessMapPteEntry {
pid : self.pid,
va_base : ne.vaBase,
page_count : ne.cPages,
page_software_count : ne.cSoftware,
is_r : true,
is_w : (ne.fPage & 0x0000000000000002) != 0,
is_x : (ne.fPage & 0x8000000000000000) == 0,
is_s : (ne.fPage & 0x0000000000000004) == 0,
is_wow64 : ne.fWoW64,
info : cstr_to_string(ne.uszText),
};
result.push(e);
}
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
}
fn impl_map_thread(&self) -> ResultEx<Vec<VmmProcessMapThreadEntry>> {
unsafe {
let mut structs = std::ptr::null_mut();
let r = (self.vmm.native.VMMDLL_Map_GetThread)(self.vmm.native.h, self.pid, &mut structs);
if !r {
return Err(anyhow!("VMMDLL_Map_GetThread: fail."));
}
if (*structs).dwVersion != VMMDLL_MAP_THREAD_VERSION {
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Err(anyhow!("VMMDLL_Map_GetThread: bad version [{} != {}].", (*structs).dwVersion, VMMDLL_MAP_THREAD_VERSION));
}
let mut result = Vec::new();
if (*structs).cMap == 0 {
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
let cMap : usize = (*structs).cMap.try_into()?;
let pMap = std::slice::from_raw_parts(&(*structs).pMap, cMap);
for i in 0..cMap {
let ne = &pMap[i];
let e = VmmProcessMapThreadEntry {
pid : self.pid,
thread_id : ne.dwTID,
thread_pid : ne.dwPID,
exit_status : ne.dwExitStatus,
state : ne.bState,
running : ne.bRunning,
priority : ne.bPriority,
priority_base : ne.bBasePriority,
va_ethread : ne.vaETHREAD,
va_teb : ne.vaTeb,
ft_create_time : ne.ftCreateTime,
ft_exit_time : ne.ftExitTime,
va_start_address : ne.vaStartAddress,
va_win32_start_address : ne.vaWin32StartAddress,
va_stack_user_base : ne.vaStackBaseUser,
va_stack_user_limit : ne.vaStackLimitUser,
va_stack_kernel_base : ne.vaStackBaseKernel,
va_stack_kernel_limit : ne.vaStackLimitKernel,
va_trap_frame : ne.vaTrapFrame,
va_impersonation_token : ne.vaImpersonationToken,
va_rip : ne.vaRIP,
va_rsp : ne.vaRSP,
affinity : ne.qwAffinity,
user_time : ne.dwUserTime,
kernel_time : ne.dwKernelTime,
suspend_count : ne.bSuspendCount,
wait_reason : ne.bWaitReason
};
result.push(e);
}
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
}
fn impl_map_unloaded_module(&self) -> ResultEx<Vec<VmmProcessMapUnloadedModuleEntry>> {
unsafe {
let mut structs = std::ptr::null_mut();
let r = (self.vmm.native.VMMDLL_Map_GetUnloadedModuleU)(self.vmm.native.h, self.pid, &mut structs);
if !r {
return Err(anyhow!("VMMDLL_Map_GetUnloadedModuleU: fail."));
}
if (*structs).dwVersion != VMMDLL_MAP_UNLOADEDMODULE_VERSION {
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Err(anyhow!("VMMDLL_Map_GetUnloadedModuleU: bad version [{} != {}].", (*structs).dwVersion, VMMDLL_MAP_UNLOADEDMODULE_VERSION));
}
let mut result = Vec::new();
if (*structs).cMap == 0 {
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
let cMap : usize = (*structs).cMap.try_into()?;
let pMap = std::slice::from_raw_parts(&(*structs).pMap, cMap);
for i in 0..cMap {
let ne = &pMap[i];
let e = VmmProcessMapUnloadedModuleEntry {
pid : self.pid,
va_base : ne.vaBase,
image_size : ne.cbImageSize,
is_wow64 : ne.fWoW64,
name : cstr_to_string(ne.uszText),
checksum : ne.dwCheckSum,
timedatestamp : ne.dwTimeDateStamp,
ft_unload : ne.ftUnload,
};
result.push(e);
}
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
}
fn impl_map_vad(&self, is_identify_modules : bool) -> ResultEx<Vec<VmmProcessMapVadEntry>> {
unsafe {
let mut structs = std::ptr::null_mut();
let r = (self.vmm.native.VMMDLL_Map_GetVadU)(self.vmm.native.h, self.pid, is_identify_modules, &mut structs);
if !r {
return Err(anyhow!("VMMDLL_Map_GetVadU: fail."));
}
if (*structs).dwVersion != VMMDLL_MAP_VAD_VERSION {
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Err(anyhow!("VMMDLL_Map_GetVadU: bad version [{} != {}].", (*structs).dwVersion, VMMDLL_MAP_VAD_VERSION));
}
let mut result = Vec::new();
if (*structs).cMap == 0 {
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
let cMap : usize = (*structs).cMap.try_into()?;
let pMap = std::slice::from_raw_parts(&(*structs).pMap, cMap);
for i in 0..cMap {
let ne = &pMap[i];
let e = VmmProcessMapVadEntry {
pid : self.pid,
va_start : ne.vaStart,
va_end : ne.vaEnd,
va_vad : ne.vaVad,
u0 : ne.u0,
u1 : ne.u1,
u2 : ne.u2,
commit_charge : ne.u1 & 0x7fffffff,
is_mem_commit : (ne.u1 & 0x80000000) != 0,
cb_prototype_pte : ne.cbPrototypePte,
va_prototype_pte : ne.vaPrototypePte,
va_subsection : ne.vaSubsection,
va_file_object : ne.vaFileObject,
info : cstr_to_string(ne.uszText),
vadex_page_base : ne.cVadExPagesBase,
vadex_page_count : ne.cVadExPages,
};
result.push(e);
}
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
}
fn impl_map_vadex(&self, offset_pages : u32, count_pages : u32) -> ResultEx<Vec<VmmProcessMapVadExEntry>> {
unsafe {
let mut structs = std::ptr::null_mut();
let r = (self.vmm.native.VMMDLL_Map_GetVadEx)(self.vmm.native.h, self.pid, offset_pages, count_pages, &mut structs);
if !r {
return Err(anyhow!("VMMDLL_Map_GetVadEx: fail."));
}
if (*structs).dwVersion != VMMDLL_MAP_VADEX_VERSION {
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Err(anyhow!("VMMDLL_Map_GetVadEx: bad version [{} != {}].", (*structs).dwVersion, VMMDLL_MAP_VADEX_VERSION));
}
let mut result = Vec::new();
if (*structs).cMap == 0 {
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
let cMap : usize = (*structs).cMap.try_into()?;
let pMap = std::slice::from_raw_parts(&(*structs).pMap, cMap);
for i in 0..cMap {
let ne = &pMap[i];
let e = VmmProcessMapVadExEntry {
pid : self.pid,
tp : VmmProcessMapVadExType::from(ne.tp),
i_pml : ne.iPML,
va : ne.va,
pa : ne.pa,
pte : ne.pte,
pte_flags : ne.pteFlags,
proto_tp : VmmProcessMapVadExType::from(ne.proto_tp),
proto_pa : ne.proto_pa,
proto_pte : ne.proto_va,
va_vad_base : ne.vaVadBase,
};
result.push(e);
}
(self.vmm.native.VMMDLL_MemFree)(structs as usize);
return Ok(result);
}
}
fn impl_map_module_data_directory(&self, module_name : &str) -> ResultEx<Vec<VmmProcessMapDirectoryEntry>> {
let sz_module_name = CString::new(module_name)?;
let mut data_directories = vec![CIMAGE_DATA_DIRECTORY::default(); 16];
let r = (self.vmm.native.VMMDLL_ProcessGetDirectoriesU)(self.vmm.native.h, self.pid, sz_module_name.as_ptr(), data_directories.as_mut_ptr());
if !r {
return Err(anyhow!("VMMDLL_ProcessGetDirectoriesU: fail."));
}
let mut result = Vec::new();
for i in 0..16 {
let src : &CIMAGE_DATA_DIRECTORY = data_directories.get(i).unwrap();
let dst = VmmProcessMapDirectoryEntry {
pid : self.pid,
name : DIRECTORY_NAMES[i],
virtual_address : src.VirtualAddress,
size : src.Size,
};
result.push(dst);
}
return Ok(result);
}
fn impl_map_module_section(&self, module_name : &str) -> ResultEx<Vec<VmmProcessSectionEntry>> {
let sz_module_name = CString::new(module_name)?;
let mut section_count = 0u32;
let r = (self.vmm.native.VMMDLL_ProcessGetSectionsU)(self.vmm.native.h, self.pid, sz_module_name.as_ptr(), std::ptr::null_mut(), 0, &mut section_count);
if !r {
return Err(anyhow!("VMMDLL_ProcessGetSectionsU: fail."));
}
let mut sections = vec![CIMAGE_SECTION_HEADER::default(); section_count.try_into()?];
let mut result = Vec::new();
if section_count == 0 {
return Ok(result);
}
let r = (self.vmm.native.VMMDLL_ProcessGetSectionsU)(self.vmm.native.h, self.pid, sz_module_name.as_ptr(), sections.as_mut_ptr(), section_count, &mut section_count);
if !r {
return Err(anyhow!("VMMDLL_ProcessGetSectionsU: fail."));
}
for i in 0..(section_count as usize) {
let src : &CIMAGE_SECTION_HEADER = sections.get(i).unwrap();
let dst = VmmProcessSectionEntry {
pid : self.pid,
index : i as u32,
name : std::str::from_utf8(&src.Name).unwrap_or_default().to_string(),
name_raw : src.Name,
misc_virtual_size : src.Misc_VirtualAddress,
virtual_address : src.VirtualAddress,
size_of_raw_data : src.SizeOfRawData,
pointer_to_raw_data : src.PointerToRawData,
pointer_to_relocations : src.PointerToRelocations,
pointer_to_linenumbers : src.PointerToLinenumbers,
number_of_relocations : src.NumberOfRelocations,
number_of_linenumbers : src.NumberOfLinenumbers,
characteristics : src.Characteristics,
};
result.push(dst);
}
return Ok(result);
}
}
//=============================================================================
// INTERNAL: VMM.SCATTERMEMORY:
//=============================================================================
impl fmt::Display for VmmScatterMemory<'_> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
if self.pid == u32::MAX { write!(f, "VmmScatterMemory:physical") } else { write!(f, "VmmScatterMemory:virtual:{}", self.pid & 0x7fffffff) }
}
}
impl Drop for VmmScatterMemory<'_> {
fn drop(&mut self) {
if self.is_scatter_ex {
let _r = self.impl_execute();
}
(self.vmm.native.VMMDLL_Scatter_CloseHandle)(self.hs);
}
}
impl <'a> VmmScatterMemory<'a> {
fn impl_prepare_ex(&mut self, data_to_read : &'a mut (u64, Vec<u8>, u32)) -> ResultEx<()> {
if data_to_read.2 != 0 {
return Err(anyhow!("data_to_read.2 not set to zero"));
}
let cb = u32::try_from(data_to_read.1.len())?;
let r = (self.vmm.native.VMMDLL_Scatter_PrepareEx)(self.hs, data_to_read.0, cb, data_to_read.1.as_mut_ptr(), &mut data_to_read.2);
if !r {
return Err(anyhow!("VMMDLL_Scatter_PrepareEx: fail."));
}
self.is_scatter_ex = true;
return Ok(());
}
fn impl_prepare_ex_as<T>(&mut self, data_to_read : &'a mut (u64, T, u32)) -> ResultEx<()> {
if data_to_read.2 != 0 {
return Err(anyhow!("data_to_read.2 not set to zero"));
}
let cb = u32::try_from(std::mem::size_of::<T>())?;
let r = (self.vmm.native.VMMDLL_Scatter_PrepareEx)(self.hs, data_to_read.0, cb, &mut data_to_read.1 as *mut _ as *mut u8, &mut data_to_read.2);
if !r {
return Err(anyhow!("VMMDLL_Scatter_PrepareEx: fail."));
}
self.is_scatter_ex = true;
return Ok(());
}
}
impl VmmScatterMemory<'_> {
fn impl_prepare(&self, va : u64, size : usize) -> ResultEx<()> {
let cb = u32::try_from(size)?;
let r = (self.vmm.native.VMMDLL_Scatter_Prepare)(self.hs, va, cb);
if !r {
return Err(anyhow!("VMMDLL_Scatter_Prepare: fail."));
}
return Ok(());
}
fn impl_prepare_write(&self, va : u64, data : &Vec<u8>) -> ResultEx<()> {
let cb = u32::try_from(data.len())?;
let pb = data.as_ptr();
let r = (self.vmm.native.VMMDLL_Scatter_PrepareWrite)(self.hs, va, pb, cb);
if !r {
return Err(anyhow!("VMMDLL_Scatter_PrepareWrite: fail."));
}
return Ok(());
}
fn impl_prepare_write_as<T>(&self, va : u64, data : &T) -> ResultEx<()> {
let cb = u32::try_from(std::mem::size_of::<T>())?;
let r = (self.vmm.native.VMMDLL_Scatter_PrepareWrite)(self.hs, va, data as *const _ as *const u8, cb);
if !r {
return Err(anyhow!("VMMDLL_Scatter_PrepareWrite: fail."));
}
return Ok(());
}
fn impl_execute(&self) -> ResultEx<()> {
let r = (self.vmm.native.VMMDLL_Scatter_Execute)(self.hs);
if !r {
return Err(anyhow!("VMMDLL_Scatter_Execute: fail."));
}
return Ok(());
}
fn impl_read(&self, va : u64, size : usize) -> ResultEx<Vec<u8>> {
let cb = u32::try_from(size)?;
let mut cb_read = 0;
let mut pb_result = vec![0u8; size];
let r = (self.vmm.native.VMMDLL_Scatter_Read)(self.hs, va, cb, pb_result.as_mut_ptr(), &mut cb_read);
if !r {
return Err(anyhow!("VMMDLL_Scatter_Read: fail."));
}
return Ok(pb_result);
}
fn impl_read_as<T>(&self, va : u64) -> ResultEx<T> {
unsafe {
let cb = u32::try_from(std::mem::size_of::<T>())?;
let mut cb_read = 0;
let mut result : T = std::mem::zeroed();
let r = (self.vmm.native.VMMDLL_Scatter_Read)(self.hs, va, cb, &mut result as *mut _ as *mut u8, &mut cb_read);
if !r {
return Err(anyhow!("VMMDLL_Scatter_Read: fail."));
}
return Ok(result);
}
}
fn impl_clear(&self) -> ResultEx<()> {
let r = (self.vmm.native.VMMDLL_Scatter_Clear)(self.hs, self.pid, self.flags);
if !r {
return Err(anyhow!("VMMDLL_Scatter_Clear: fail."));
}
return Ok(());
}
}
//=============================================================================
// INTERNAL: VMM.SEARCH:
//=============================================================================
impl fmt::Display for VmmSearch<'_> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmSearch")
}
}
impl fmt::Display for VmmSearchResult {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmSearchResult")
}
}
#[repr(C)]
#[allow(non_snake_case, non_camel_case_types)]
#[derive(Debug, Default)]
struct CVMMDLL_MEM_SEARCH_CONTEXT_SEARCHENTRY {
cbAlign : u32,
cb : u32,
pb : [u8; 32],
pbSkipMask : [u8; 32],
}
#[repr(C)]
#[allow(non_snake_case, non_camel_case_types)]
#[derive(Debug, Default)]
pub(crate) struct CVMMDLL_MEM_SEARCH_CONTEXT {
dwVersion : u32,
_Filler : [u32; 2],
fAbortRequested : u32,
cMaxResult : u32,
cSearch : u32,
search : [CVMMDLL_MEM_SEARCH_CONTEXT_SEARCHENTRY; 16],
vaMin : u64,
vaMax : u64,
vaCurrent : u64,
_Filler2 : u32,
cResult : u32,
cbReadTotal : u64,
pvUserPtrOpt : usize,
pfnResultOptCB : usize,
ReadFlags : u64,
fForcePTE : u32,
fForceVAD : u32,
pfnFilterOptCB : usize,
}
impl Drop for VmmSearch<'_> {
fn drop(&mut self) {
if self.is_started && !self.is_completed {
self.impl_abort();
let _r = self.impl_result();
}
}
}
// The below implementation is quite ugly, but it works since all methods are
// serialized since they all require &mut self. Under no conditions should the
// VmmSearch struct be accessed directly or non-mutable.
impl VmmSearch<'_> {
fn impl_result(&mut self) -> VmmSearchResult {
if self.is_started == false {
self.impl_start();
}
if self.is_completed == false {
self.is_completed = true;
if let Some(thread) = self.thread.take() {
if let Ok(thread_result) = thread.join() {
self.is_completed_success = thread_result;
}
}
}
return self.impl_poll();
}
fn impl_abort(&mut self) {
if self.is_started && !self.is_completed {
self.native_search.fAbortRequested = 1;
}
}
fn impl_start(&mut self) {
if self.is_started == false {
self.is_started = true;
// ugly code below - but it works ...
self.native_search.pvUserPtrOpt = std::ptr::addr_of!(self.result) as usize;
let pid = self.pid;
let native_h = self.vmm.native.h;
let pfn = self.vmm.native.VMMDLL_MemSearch;
let ptr = &mut self.native_search as *mut CVMMDLL_MEM_SEARCH_CONTEXT;
let ptr_wrap = ptr as usize;
let thread_handle = std::thread::spawn(move || {
let ptr = ptr_wrap as *mut CVMMDLL_MEM_SEARCH_CONTEXT;
(pfn)(native_h, pid, ptr, std::ptr::null_mut(), std::ptr::null_mut())
});
self.thread = Some(thread_handle);
}
}
fn impl_poll(&mut self) -> VmmSearchResult {
if self.is_started && !self.is_completed && self.thread.as_ref().unwrap().is_finished() {
return self.impl_result();
}
let result_vec = if self.is_completed_success { self.result.clone() } else { Vec::new() };
return VmmSearchResult {
is_started : self.is_started,
is_completed : self.is_completed,
is_completed_success : self.is_completed_success,
addr_min : self.native_search.vaMin,
addr_max : self.native_search.vaMax,
addr_current : self.native_search.vaCurrent,
total_read_bytes : self.native_search.cbReadTotal,
total_results : self.native_search.cResult,
result : result_vec,
}
}
fn impl_new<'a>(vmm : &'a Vmm<'a>, pid : u32, addr_min : u64, addr_max : u64, num_results_max : u32, flags : u64) -> ResultEx<VmmSearch<'a>> {
let num_results_max = std::cmp::min(0x10000, num_results_max);
let addr_min = addr_min & 0xfffffffffffff000;
let addr_max = addr_max & 0xfffffffffffff000;
if addr_max != 0 && addr_max <= addr_min {
return Err(anyhow!("search max address must be larger than min address"));
}
let result_vec = Vec::new();
let mut native = CVMMDLL_MEM_SEARCH_CONTEXT::default();
native.dwVersion = VMMDLL_MEM_SEARCH_VERSION;
native.vaMin = addr_min;
native.vaMax = addr_max;
native.ReadFlags = flags;
native.cMaxResult = num_results_max;
native.pfnResultOptCB = VmmSearch::impl_search_cb as usize;
native.pvUserPtrOpt = std::ptr::addr_of!(result_vec) as usize;
//let ptr = result_vec::as_mut_ptr;
return Ok(VmmSearch {
vmm,
pid,
is_started : false,
is_completed : false,
is_completed_success : false,
native_search : native,
thread : None,
result : result_vec,
});
}
fn impl_add_search(&mut self, search_bytes : &[u8], search_skipmask : Option<&[u8]>, byte_align : u32) -> ResultEx<u32> {
if self.native_search.cSearch as usize >= self.native_search.search.len() {
return Err(anyhow!("Search max terms reached."));
}
if (search_bytes.len() == 0) || (search_bytes.len() > 32) {
return Err(anyhow!("Search invalid length: search_bytes."));
}
if byte_align > 0 {
if ((byte_align & (byte_align - 1)) != 0) || (byte_align > 0x1000) {
return Err(anyhow!("Search bad byte_align."));
}
}
if let Some(search_skipmask) = search_skipmask {
if search_skipmask.len() > search_bytes.len() {
return Err(anyhow!("Search invalid length: search_skipmask."));
}
}
let term = &mut self.native_search.search[self.native_search.cSearch as usize];
term.cbAlign = byte_align;
term.cb = search_bytes.len() as u32;
term.pb[0..search_bytes.len()].copy_from_slice(search_bytes);
if let Some(search_skipmask) = search_skipmask {
term.pbSkipMask[0..search_skipmask.len()].copy_from_slice(search_skipmask);
}
let result_index = self.native_search.cSearch;
self.native_search.cSearch += 1;
return Ok(result_index);
}
extern "C" fn impl_search_cb(ctx : usize, va : u64, i_search : u32) -> bool {
unsafe {
let ctx = ctx as *const CVMMDLL_MEM_SEARCH_CONTEXT;
let ptr_result_vec = (*ctx).pvUserPtrOpt as *mut Vec<(u64, u32)>;
(*ptr_result_vec).push((va, i_search));
return true;
}
}
}
//=============================================================================
// INTERNAL: VMM.YARA:
//=============================================================================
impl fmt::Display for VmmYara<'_> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmYara")
}
}
impl fmt::Display for VmmYaraResult {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmYaraResult")
}
}
impl fmt::Display for VmmYaraMatch {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmYaraMatch:[{}]:{}", self.rule, self.match_strings.len())
}
}
impl fmt::Display for VmmYaraMatchString {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmYaraMatchString:[{}]:{}", self.match_string, self.addresses.len())
}
}
#[repr(C)]
#[allow(non_snake_case, non_camel_case_types)]
#[derive(Debug)]
struct CVMMDLL_VMMYARA_RULE_MATCH_META {
szIdentifier : *const c_char,
szString : *const c_char,
}
#[repr(C)]
#[allow(non_snake_case, non_camel_case_types)]
#[derive(Debug)]
struct CVMMDLL_VMMYARA_RULE_MATCH_STRINGS {
szString : *const c_char,
cMatch : u32,
cbMatchOffset : [usize; 16],
}
#[repr(C)]
#[allow(non_snake_case, non_camel_case_types)]
#[derive(Debug)]
struct CVMMDLL_VMMYARA_RULE_MATCH {
dwVersion : u32,
flags : u32,
szRuleIdentifier : *const c_char,
cTags : u32,
szTags : [*const c_char; 8],
cMeta : u32,
meta : [CVMMDLL_VMMYARA_RULE_MATCH_META; 16],
cStrings : u32,
strings : [CVMMDLL_VMMYARA_RULE_MATCH_STRINGS; 8],
}
#[repr(C)]
#[allow(non_snake_case, non_camel_case_types)]
#[derive(Debug)]
pub(crate) struct CVMMDLL_YARA_CONFIG {
dwVersion : u32,
_Filler : [u32; 2],
fAbortRequested : u32,
cMaxResult : u32,
cRules : u32,
pszRules : *const *const c_char,
vaMin : u64,
vaMax : u64,
vaCurrent : u64,
_Filler2 : u32,
cResult : u32,
cbReadTotal : u64,
pvUserPtrOpt : usize,
pfnScanMemoryCB : usize,
ReadFlags : u64,
fForcePTE : u32,
fForceVAD : u32,
pfnFilterOptCB : usize,
pvUserPtrOpt2 : usize,
_Reserved : u64,
}
impl Drop for VmmYara<'_> {
fn drop(&mut self) {
if self.is_started && !self.is_completed {
self.impl_abort();
let _r = self.impl_result();
}
}
}
// The below implementation is quite ugly, but it works since all methods are
// serialized since they all require &mut self. Under no conditions should the
// VmmYara struct be accessed directly or non-mutable.
impl VmmYara<'_> {
fn impl_result(&mut self) -> VmmYaraResult {
if self.is_started == false {
self.impl_start();
}
if self.is_completed == false {
self.is_completed = true;
if let Some(thread) = self.thread.take() {
if let Ok(thread_result) = thread.join() {
self.is_completed_success = thread_result;
}
}
}
return self.impl_poll();
}
fn impl_abort(&mut self) {
if self.is_started && !self.is_completed {
self.native.fAbortRequested = 1;
}
}
fn impl_start(&mut self) {
if self.is_started == false {
self.is_started = true;
// ugly code below - but it works ...
self.native.pvUserPtrOpt2 = std::ptr::addr_of!(self.result) as usize;
self.native.pvUserPtrOpt = std::ptr::addr_of!(self.native) as usize;
let pid = self.pid;
let native_h = self.vmm.native.h;
let pfn = self.vmm.native.VMMDLL_YaraSearch;
let ptr = &mut self.native as *mut CVMMDLL_YARA_CONFIG;
let ptr_wrap = ptr as usize;
let thread_handle = std::thread::spawn(move || {
let ptr = ptr_wrap as *mut CVMMDLL_YARA_CONFIG;
(pfn)(native_h, pid, ptr, std::ptr::null_mut(), std::ptr::null_mut())
});
self.thread = Some(thread_handle);
}
}
fn impl_poll(&mut self) -> VmmYaraResult {
if self.is_started && !self.is_completed && self.thread.as_ref().unwrap().is_finished() {
return self.impl_result();
}
let result_vec = if self.is_completed_success { self.result.clone() } else { Vec::new() };
return VmmYaraResult {
is_completed : self.is_completed,
is_completed_success : self.is_completed_success,
addr_min : self.native.vaMin,
addr_max : self.native.vaMax,
addr_current : self.native.vaCurrent,
total_read_bytes : self.native.cbReadTotal,
total_results : self.result.len() as u32,
result : result_vec,
}
}
fn impl_new<'a>(vmm : &'a Vmm<'a>, rules : Vec<&str>, pid : u32, addr_min : u64, addr_max : u64, num_results_max : u32, flags : u64) -> ResultEx<VmmYara<'a>> {
// 1: verify address validity:
let num_results_max = std::cmp::min(0x10000, num_results_max);
let addr_min = addr_min & 0xfffffffffffff000;
let addr_max = addr_max & 0xfffffffffffff000;
if addr_max != 0 && addr_max <= addr_min {
return Err(anyhow!("search max address must be larger than min address"));
}
// 2: create native object:
let native_args_rules = rules.iter().map(|arg| CString::new(*arg).unwrap()).collect::<Vec<CString>>();
let native_argv_rules: Vec<*const c_char> = native_args_rules.iter().map(|s| s.as_ptr()).collect();
let native = CVMMDLL_YARA_CONFIG {
dwVersion : VMMDLL_YARA_CONFIG_VERSION,
_Filler : [0; 2],
fAbortRequested : 0,
cMaxResult : num_results_max,
cRules : native_args_rules.len() as u32,
pszRules : native_argv_rules.as_ptr(),
vaMin : addr_min,
vaMax : addr_max,
vaCurrent : 0,
_Filler2 : 0,
cResult : 0,
cbReadTotal : 0,
pvUserPtrOpt : 0,
pfnScanMemoryCB : VmmYara::impl_yara_cb as usize,
ReadFlags : flags,
fForcePTE : 0,
fForceVAD : 0,
pfnFilterOptCB : 0,
pvUserPtrOpt2 : 0,
_Reserved : 0,
};
// 3: create object and return:
let yara = VmmYara {
vmm,
pid,
is_started : false,
is_completed : false,
is_completed_success : false,
native,
_native_args_rules : native_args_rules,
_native_argv_rules : native_argv_rules,
thread : None,
result : Vec::new(),
};
return Ok(yara);
}
extern "C" fn impl_yara_cb(ctx : *const CVMMDLL_YARA_CONFIG, yrm : *const CVMMDLL_VMMYARA_RULE_MATCH, _pb_buffer : *const u8, _cb_buffer : usize) -> bool {
unsafe {
if (*ctx).dwVersion != VMMDLL_YARA_CONFIG_VERSION {
return false;
}
if (*yrm).dwVersion != VMMYARA_RULE_MATCH_VERSION {
return false;
}
let addr = (*ctx).vaCurrent;
// rule:
let rule = cstr_to_string((*yrm).szRuleIdentifier);
// tags:
let mut tags = Vec::new();
let ctags = std::cmp::min((*yrm).cTags as usize, 8);
for i in 0..ctags {
let tag = cstr_to_string((*yrm).szTags[i]);
tags.push(tag);
}
// meta:
let mut meta = Vec::new();
let cmeta = std::cmp::min((*yrm).cMeta as usize, 8);
for i in 0..cmeta {
let key = cstr_to_string((*yrm).meta[i].szIdentifier);
let value = cstr_to_string((*yrm).meta[i].szString);
meta.push((key, value));
}
// match_strings:
let mut match_strings = Vec::new();
let cmatch_strings = std::cmp::min((*yrm).cStrings as usize, 8);
for i in 0..cmatch_strings {
let match_string = cstr_to_string((*yrm).strings[i].szString);
let cmatch = std::cmp::min((*yrm).strings[i].cMatch as usize, 16);
let mut addresses = Vec::new();
for j in 0..cmatch {
let offset = (*yrm).strings[i].cbMatchOffset[j] as u64;
addresses.push(addr + offset);
}
let match_string = VmmYaraMatchString {
match_string,
addresses,
};
match_strings.push(match_string);
}
// create result:
let yara_match = VmmYaraMatch {
addr,
rule,
tags,
meta,
match_strings,
};
let ptr_result_vec = (*ctx).pvUserPtrOpt2 as *mut Vec<VmmYaraMatch>;
(*ptr_result_vec).push(yara_match);
return true;
}
}
}
//=============================================================================
// INTERNAL: VMM.PLUGINS:
//=============================================================================
impl<T> fmt::Display for VmmPluginContext<'_, T> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmPluginContext")
}
}
impl fmt::Display for VmmPluginFileList<'_> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmPluginFileList")
}
}
impl<T> fmt::Display for VmmPluginInitializationContext<T> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmPluginInitializationContext")
}
}
impl fmt::Display for VmmPluginInitializationInfo {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "VmmPluginInitializationInfo")
}
}
#[repr(C)]
#[allow(non_snake_case, non_camel_case_types)]
struct CVMMDLL_PLUGIN_CONTEXT<'a, T> {
magic : u64,
wVersion : u16,
wSize : u16,
pid : u32,
pProcess : usize,
uszModule : *const c_char,
uszPath : *const c_char,
pvReserved1 : usize,
ctxM : *const VmmPluginContext<'a, T>,
MID : u32,
}
#[repr(C)]
#[allow(non_snake_case, non_camel_case_types)]
struct CVMMDLL_PLUGIN_REGINFO<T> {
magic : u64,
wVersion : u16,
wSize : u16,
tpMemoryModel : u32,
tpSystem : u32,
hDLL : usize,
pfnPluginManager_Register : extern "C" fn(H : usize, pPluginRegInfo : *mut CVMMDLL_PLUGIN_REGINFO<T>) -> bool,
uszPathVmmDLL : *const c_char,
_Reserved : [u32; 30],
Py_fPythonStandalone : bool,
Py__Reserved : u32,
Py_hReservedDllPython3 : usize,
Py_hReservedDllPython3X : usize,
// reg_info:
reg_info_ctxM : usize,
reg_info_uszPathName : [u8; 128],
reg_info_fRootModule : u32, // bool
reg_info_fProcessModule : u32, // bool
reg_info_fRootModuleHidden : u32, // bool
reg_info_fProcessModuleHidden : u32, // bool
reg_info_sTimelineNameShort : [u8; 6],
reg_info__Reserved : [u8; 2],
reg_info_uszTimelineFile : [u8; 32],
reg_info__Reserved2 : [u8; 32],
// reg_fn:
reg_fn_pfnList : extern "C" fn(H : usize, ctxP : *const CVMMDLL_PLUGIN_CONTEXT<T>, pFileList : usize) -> bool,
reg_fn_pfnRead : extern "C" fn(H : usize, ctxP : *const CVMMDLL_PLUGIN_CONTEXT<T>, pb : *mut u8, cb : u32, pcbRead : *mut u32, cbOffset : u64) -> u32,
reg_fn_pfnWrite : extern "C" fn(H : usize, ctxP : *const CVMMDLL_PLUGIN_CONTEXT<T>, pb : *const u8, cb : u32, pcbWrite : *mut u32, cbOffset : u64) -> u32,
reg_fn_pfnNotify : extern "C" fn(H : usize, ctxP : *const CVMMDLL_PLUGIN_CONTEXT<T>, fEvent : u32, pvEvent : usize, cbEvent : usize),
reg_fn_pfnClose : extern "C" fn(H : usize, ctxP : *const CVMMDLL_PLUGIN_CONTEXT<T>),
reg_fn_pfnVisibleModule : extern "C" fn(H : usize, ctxP : *const CVMMDLL_PLUGIN_CONTEXT<T>) -> bool,
reg_fn_pvReserved : [usize; 10],
// reg_fnfc: // TODO:
reg_fnfc_pfnInitialize : usize,
reg_fnfc_pfnFinalize : usize,
reg_fnfc_pfnTimeline : usize,
reg_fnfc_pfnIngestPhysmem : usize,
reg_fnfc_pfnIngestVirtmem : usize,
reg_fnfc_pfnIngestFinalize : usize,
reg_fnfc_pfnFindEvil : usize,
reg_fnfc_pvReserved : [usize; 7],
reg_fnfc_pfnLogCSV : usize,
reg_fnfc_pfnLogJSON : usize,
// sysinfo:
sysinfo_f32 : u32,
sysinfo_dwVersionMajor : u32,
sysinfo_dwVersionMinor : u32,
sysinfo_dwVersionBuild : u32,
sysinfo__Reserved : [u32; 32],
}
fn impl_new_plugin_initialization<T>(native_h : usize, native_reginfo : usize) -> ResultEx<(VmmPluginInitializationInfo, VmmPluginInitializationContext<T>)> {
unsafe {
let reginfo = native_reginfo as *mut CVMMDLL_PLUGIN_REGINFO<T>;
if (*reginfo).magic != VMMDLL_PLUGIN_REGINFO_MAGIC || (*reginfo).wVersion != VMMDLL_PLUGIN_REGINFO_VERSION {
return Err(anyhow!("Bad reginfo magic/version."));
}
let info = VmmPluginInitializationInfo {
tp_system : VmmSystemType::from((*reginfo).tpSystem),
tp_memorymodel : VmmMemoryModelType::from((*reginfo).tpMemoryModel),
version_major : (*reginfo).sysinfo_dwVersionMajor,
version_minor : (*reginfo).sysinfo_dwVersionMinor,
version_build : (*reginfo).sysinfo_dwVersionBuild,
};
let ctx = VmmPluginInitializationContext {
h_vmm : native_h,
h_reginfo : native_reginfo,
ctx : None,
path_name : String::from(""),
is_root_module : false,
is_root_module_hidden : false,
is_process_module : false,
is_process_module_hidden : false,
fn_list : None,
fn_read : None,
fn_write : None,
fn_notify : None,
fn_visible : None,
};
return Ok((info, ctx));
}
}
impl<T> VmmPluginInitializationContext<T> {
fn impl_register(self) -> ResultEx<()> {
unsafe {
let reginfo = self.h_reginfo as *mut CVMMDLL_PLUGIN_REGINFO<T>;
if (*reginfo).magic != VMMDLL_PLUGIN_REGINFO_MAGIC || (*reginfo).wVersion != VMMDLL_PLUGIN_REGINFO_VERSION {
return Err(anyhow!("Bad reginfo magic/version."));
}
if self.ctx.is_none() {
return Err(anyhow!("User context ctx is missing. User context cannot be None."));
}
let pathname_str = str::replace(&self.path_name, "/", "\\");
let pathname_cstring = CString::new(pathname_str)?;
let pathname_bytes = pathname_cstring.to_bytes_with_nul();
if pathname_bytes.len() > (*reginfo).reg_info_uszPathName.len() {
return Err(anyhow!("Plugin path/name too long."));
}
let pathname_len = std::cmp::min(pathname_bytes.len(), (*reginfo).reg_info_uszPathName.len());
// "initialize" rust vmm context from handle and create rust plugin native context:
let c_path_vmm = CStr::from_ptr((*reginfo).uszPathVmmDLL);
let vmm = impl_new(c_path_vmm.to_str()?, self.h_vmm, &Vec::new())?;
let ctx_user = self.ctx.unwrap();
let ctx_rust = VmmPluginContext {
vmm : vmm,
ctxlock : std::sync::RwLock::new(ctx_user),
fn_list : self.fn_list,
fn_read : self.fn_read,
fn_write : self.fn_write,
fn_notify : self.fn_notify,
fn_visible : self.fn_visible,
};
let ctx_rust_box = Box::new(ctx_rust);
let ctx_native = Box::into_raw(ctx_rust_box);
// prepare native registration context and register:
for i in 0..pathname_len {
(*reginfo).reg_info_uszPathName[i] = pathname_bytes[i];
}
(*reginfo).reg_info_ctxM = ctx_native as usize;
(*reginfo).reg_info_fProcessModule = if self.is_process_module { 1 } else { 0 };
(*reginfo).reg_info_fProcessModuleHidden = if self.is_process_module_hidden { 1 } else { 0 };
(*reginfo).reg_info_fRootModule = if self.is_root_module { 1 } else { 0 };
(*reginfo).reg_info_fRootModuleHidden = if self.is_root_module_hidden { 1 } else { 0 };
// native callback registration:
(*reginfo).reg_fn_pfnClose = impl_plugin_close_cb;
if self.fn_list.is_some() {
(*reginfo).reg_fn_pfnList = impl_plugin_list_cb;
}
if self.fn_read.is_some() {
(*reginfo).reg_fn_pfnRead = impl_plugin_read_cb;
}
if self.fn_write.is_some() {
(*reginfo).reg_fn_pfnWrite = impl_plugin_write_cb;
}
if self.fn_visible.is_some() {
(*reginfo).reg_fn_pfnVisibleModule = impl_plugin_visible_cb;
}
if self.fn_notify.is_some() {
(*reginfo).reg_fn_pfnNotify = impl_plugin_notify_cb;
}
let r = ((*reginfo).pfnPluginManager_Register)(self.h_vmm, reginfo);
if !r {
return Err(anyhow!("Failed registering plugin."));
}
return Ok(());
}
}
}
impl VmmPluginFileList<'_> {
fn impl_add_file(&self, name : &str, size : u64) {
let sz_name = CString::new(name).unwrap();
(self.vmm.native.VMMDLL_VfsList_AddFile)(self.h_file_list, sz_name.as_ptr(), size, 0);
}
fn impl_add_directory(&self, name : &str) {
let sz_name = CString::new(name).unwrap();
(self.vmm.native.VMMDLL_VfsList_AddDirectory)(self.h_file_list, sz_name.as_ptr(), 0);
}
}
extern "C" fn impl_plugin_close_cb<T>(_h : usize, ctxp : *const CVMMDLL_PLUGIN_CONTEXT<T>) {
unsafe {
drop(Box::from_raw((*ctxp).ctxM as *mut VmmPluginContext<T>));
}
}
extern "C" fn impl_plugin_list_cb<T>(_h : usize, ctxp : *const CVMMDLL_PLUGIN_CONTEXT<T>, h_pfilelist : usize) -> bool {
unsafe {
let ctx = &*(*ctxp).ctxM;
if ((*ctxp).magic != VMMDLL_PLUGIN_CONTEXT_MAGIC) || ((*ctxp).wVersion != VMMDLL_PLUGIN_CONTEXT_VERSION) {
return true;
}
let callback = ctx.fn_list.unwrap();
let process = if (*ctxp).pid > 0 { Some(VmmProcess{ vmm : &ctx.vmm, pid : (*ctxp).pid }) } else { None };
let path_string = str::replace(CStr::from_ptr((*ctxp).uszPath).to_str().unwrap_or("[err]"), "\\", "/");
let path = path_string.as_str();
if path == "[err]" {
return true;
}
let filelist = VmmPluginFileList {
vmm : &ctx.vmm,
h_file_list : h_pfilelist,
};
let _r = (callback)(ctx, process, path, &filelist);
return true;
}
}
extern "C" fn impl_plugin_read_cb<T>(_h : usize, ctxp : *const CVMMDLL_PLUGIN_CONTEXT<T>, pb : *mut u8, cb : u32, pcb_read : *mut u32, cb_offset : u64) -> u32 {
unsafe {
*pcb_read = 0;
let ctx = &*(*ctxp).ctxM;
if ((*ctxp).magic != VMMDLL_PLUGIN_CONTEXT_MAGIC) || ((*ctxp).wVersion != VMMDLL_PLUGIN_CONTEXT_VERSION) {
return VMMDLL_STATUS_FILE_INVALID;
}
let callback = ctx.fn_read.unwrap();
let process = if (*ctxp).pid > 0 { Some(VmmProcess{ vmm : &ctx.vmm, pid : (*ctxp).pid }) } else { None };
let path_string = str::replace(CStr::from_ptr((*ctxp).uszPath).to_str().unwrap_or("[err]"), "\\", "/");
let path = path_string.as_str();
if path == "[err]" {
return VMMDLL_STATUS_FILE_INVALID;
}
let r = match (callback)(ctx, process, path, cb, cb_offset) {
Err(_) => return VMMDLL_STATUS_FILE_INVALID,
Ok(r) => r,
};
if r.len() == 0 {
return VMMDLL_STATUS_END_OF_FILE;
}
if r.len() > u32::MAX as usize {
return VMMDLL_STATUS_FILE_INVALID;
}
*pcb_read = r.len() as u32;
std::ptr::copy_nonoverlapping(r.as_ptr(), pb, r.len());
return VMMDLL_STATUS_SUCCESS;
}
}
extern "C" fn impl_plugin_write_cb<T>(_h : usize, ctxp : *const CVMMDLL_PLUGIN_CONTEXT<T>, pb : *const u8, cb : u32, pcb_write : *mut u32, cb_offset : u64) -> u32 {
unsafe {
*pcb_write = 0;
let ctx = &*(*ctxp).ctxM;
if ((*ctxp).magic != VMMDLL_PLUGIN_CONTEXT_MAGIC) || ((*ctxp).wVersion != VMMDLL_PLUGIN_CONTEXT_VERSION) {
return VMMDLL_STATUS_FILE_INVALID;
}
let callback = ctx.fn_write.unwrap();
let process = if (*ctxp).pid > 0 { Some(VmmProcess{ vmm : &ctx.vmm, pid : (*ctxp).pid }) } else { None };
let path_string = str::replace(CStr::from_ptr((*ctxp).uszPath).to_str().unwrap_or("[err]"), "\\", "/");
let path = path_string.as_str();
if path == "[err]" {
return VMMDLL_STATUS_FILE_INVALID;
}
let size = cb as usize;
let mut data = vec![0u8; size];
std::ptr::copy_nonoverlapping(pb, data.as_mut_ptr(), size);
if (callback)(ctx, process, path, data, cb_offset).is_err() {
return VMMDLL_STATUS_FILE_INVALID;
};
*pcb_write = cb;
return VMMDLL_STATUS_SUCCESS;
}
}
extern "C" fn impl_plugin_visible_cb<T>(_h : usize, ctxp : *const CVMMDLL_PLUGIN_CONTEXT<T>) -> bool {
unsafe {
let ctx = &*(*ctxp).ctxM;
if ((*ctxp).magic != VMMDLL_PLUGIN_CONTEXT_MAGIC) || ((*ctxp).wVersion != VMMDLL_PLUGIN_CONTEXT_VERSION) {
return false;
}
let callback = ctx.fn_visible.unwrap();
let process = if (*ctxp).pid > 0 { Some(VmmProcess{ vmm : &ctx.vmm, pid : (*ctxp).pid }) } else { None };
let path_string = str::replace(CStr::from_ptr((*ctxp).uszPath).to_str().unwrap_or("[err]"), "\\", "/");
let path = path_string.as_str();
if path == "[err]" {
return false;
}
return (callback)(ctx, process).unwrap_or(false);
}
}
extern "C" fn impl_plugin_notify_cb<T>(_h : usize, ctxp : *const CVMMDLL_PLUGIN_CONTEXT<T>, f_event : u32, _pv_event : usize, _cb_event : usize) {
unsafe {
let ctx = &*(*ctxp).ctxM;
if ((*ctxp).magic != VMMDLL_PLUGIN_CONTEXT_MAGIC) || ((*ctxp).wVersion != VMMDLL_PLUGIN_CONTEXT_VERSION) {
return;
}
let callback = ctx.fn_notify.unwrap();
let _r = (callback)(ctx, f_event);
}
}
//=============================================================================
// INTERNAL: LEECHCORE:
//=============================================================================
#[allow(dead_code)]
#[allow(non_snake_case)]
#[derive(Debug)]
struct LcNative {
h : usize,
library_lc : libloading::Library,
config : CLC_CONFIG,
LcCreate : extern "C" fn(pLcCreateConfig : *mut CLC_CONFIG) -> usize,
LcClose : extern "C" fn(hLC : usize),
LcMemFree : extern "C" fn(pvMem : usize),
LcRead : extern "C" fn(hLC : usize, pa : u64, cb : u32, pb : *mut u8) -> bool,
LcWrite : extern "C" fn(hLC : usize, pa : u64, cb : u32, pb : *const u8) -> bool,
LcGetOption : extern "C" fn(hLC : usize, fOption : u64, pqwValue : *mut u64) -> bool,
LcSetOption : extern "C" fn(hLC : usize, fOption : u64, qwValue : u64) -> bool,
LcCommand : extern "C" fn(hLC : usize, fCommand : u64, cbDataIn : u32, pbDataIn : *const u8, ppbDataOut : *mut *mut u8, pcbDataOut : *mut u32) -> bool,
LcCommandPtr : extern "C" fn(hLC : usize, fCommand : u64, cbDataIn : u32, pbDataIn : usize, ppbDataOut : *mut usize, pcbDataOut : *mut u32) -> bool,
}
impl fmt::Display for LeechCore {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "LeechCore")
}
}
impl fmt::Display for LcBar {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
if self.is_valid {
write!(f, "LcBar:{}:[{:x}->{:x}]", self.bar_index, self.pa, self.pa + self.cb - 1)
} else {
write!(f, "LcBar:{}:inactive", self.bar_index)
}
}
}
impl fmt::Display for LcBarRequest {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let tp = if self.is_write { "write" } else { "read" };
write!(f, "LcBarRequest:{}:{tp}:[{:x}:{:x}]", self.bar.bar_index, self.data_offset, self.data_size)
}
}
impl<T> fmt::Display for LcBarContext<'_, T> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "LcBarContext")
}
}
impl<T> fmt::Display for LcBarContextWrap<'_, T> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "LcBarContextWrap")
}
}
impl<T> fmt::Display for LcTlpContext<'_, T> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "LcTlpContext")
}
}
impl<T> fmt::Display for LcTlpContextWrap<'_, T> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "LcTlpContextWrap")
}
}
impl Drop for LeechCore {
fn drop(&mut self) {
(self.native.LcClose)(self.native.h);
}
}
impl<T> Drop for LcBarContext<'_, T> {
fn drop(&mut self) {
let mut native_ctx : usize = 0;
let r = (self.lc.native.LcCommandPtr)(self.lc.native.h, LeechCore::LC_CMD_FPGA_BAR_CONTEXT_RD, 0, 0, &mut native_ctx, std::ptr::null_mut());
if r && self.native_ctx == native_ctx {
let _r = (self.lc.native.LcCommandPtr)(self.lc.native.h, LeechCore::LC_CMD_FPGA_BAR_FUNCTION_CALLBACK, 0, 0, std::ptr::null_mut(), std::ptr::null_mut());
let _r = (self.lc.native.LcCommandPtr)(self.lc.native.h, LeechCore::LC_CMD_FPGA_BAR_CONTEXT, 0, 0, std::ptr::null_mut(), std::ptr::null_mut());
}
}
}
impl<T> Drop for LcBarContextWrap<'_, T> {
fn drop(&mut self) {
unsafe {
drop(Box::from_raw(self.native));
}
}
}
impl<T> Drop for LcTlpContext<'_, T> {
fn drop(&mut self) {
let mut native_ctx : usize = 0;
let r = (self.lc.native.LcCommandPtr)(self.lc.native.h, LeechCore::LC_CMD_FPGA_TLP_CONTEXT_RD, 0, 0, &mut native_ctx, std::ptr::null_mut());
if r && self.native_ctx == native_ctx {
let _r = (self.lc.native.LcCommandPtr)(self.lc.native.h, LeechCore::LC_CMD_FPGA_TLP_FUNCTION_CALLBACK, 0, 0, std::ptr::null_mut(), std::ptr::null_mut());
let _r = (self.lc.native.LcCommandPtr)(self.lc.native.h, LeechCore::LC_CMD_FPGA_TLP_CONTEXT, 0, 0, std::ptr::null_mut(), std::ptr::null_mut());
}
}
}
impl<T> Drop for LcTlpContextWrap<'_, T> {
fn drop(&mut self) {
unsafe {
drop(Box::from_raw(self.native));
}
}
}
#[allow(non_snake_case)]
impl LeechCore {
#[allow(non_snake_case)]
fn impl_new(lc_lib_path : &str, device_config : &str, remote_config : &str, lc_config_printf_verbosity : u32, pa_max : u64) -> ResultEx<LeechCore> {
unsafe {
// load LeechCore native library (leechcore.dll / leechcore.so):
let path = std::path::Path::new(lc_lib_path).canonicalize()?;
let str_path = path.to_str().unwrap_or("");
let library_lc : libloading::Library = libloading::Library::new(str_path)
.with_context(|| format!("Failed to load leechcore library at: {}", str_path))?;
// fetch function references:
let LcCreate : extern "C" fn(pLcCreateConfig : *mut CLC_CONFIG) -> usize = *library_lc.get(b"LcCreate")?;
let LcClose = *library_lc.get(b"LcClose")?;
let LcMemFree = *library_lc.get(b"LcMemFree")?;
let LcRead = *library_lc.get(b"LcRead")?;
let LcWrite = *library_lc.get(b"LcWrite")?;
let LcGetOption = *library_lc.get(b"LcGetOption")?;
let LcSetOption = *library_lc.get(b"LcSetOption")?;
let LcCommand = *library_lc.get(b"LcCommand")?;
let LcCommandPtr = *library_lc.get(b"LcCommand")?;
// build config:
let device_config_bytes = &*(device_config.as_bytes() as *const [u8] as *const [c_char]);
let mut device_sz: [c_char; 260] = [0; 260];
device_sz[..device_config_bytes.len().min(260-1)].copy_from_slice(device_config_bytes);
let remote_config_bytes = &*(remote_config.as_bytes() as *const [u8] as *const [c_char]);
let mut remote_sz: [c_char; 260] = [0; 260];
remote_sz[..remote_config_bytes.len().min(260-1)].copy_from_slice(remote_config_bytes);
let mut config = CLC_CONFIG {
dwVersion : LeechCore::LC_CONFIG_VERSION,
dwPrintfVerbosity : lc_config_printf_verbosity,
szDevice : device_sz,
szRemote : remote_sz,
pfn_printf_opt : 0,
paMax : pa_max,
fVolatile : 0,
fWritable : 0,
fRemote : 0,
fRemoteDisableCompress : 0,
szDeviceName : [0; 260],
};
// initialize library
let h: usize;
h = (LcCreate)(&mut config);
if h == 0 {
return Err(anyhow!("LcCreate: fail"));
}
// return LeechCore struct:
let native = LcNative {
h,
library_lc,
config,
LcCreate,
LcClose,
LcMemFree,
LcRead,
LcWrite,
LcGetOption,
LcSetOption,
LcCommand,
LcCommandPtr,
};
let lc = LeechCore {
native,
};
return Ok(lc);
}
}
fn impl_get_option(&self, config_id : u64) -> ResultEx<u64> {
let mut v = 0;
let f = (self.native.LcGetOption)(self.native.h, config_id, &mut v);
return if f { Ok(v) } else { Err(anyhow!("LcGetOption: fail")) };
}
fn impl_set_option(&self, config_id : u64, config_value : u64) -> ResultEx<()> {
let f = (self.native.LcSetOption)(self.native.h, config_id, config_value);
return if f { Ok(()) } else { Err(anyhow!("LcSetOption: fail")) };
}
fn impl_mem_read(&self, pa : u64, size : usize) -> ResultEx<Vec<u8>> {
let cb = u32::try_from(size)?;
let mut pb_result: Vec<u8> = vec![0u8; size];
let r = (self.native.LcRead)(self.native.h, pa, cb, pb_result.as_mut_ptr());
if !r {
return Err(anyhow!("LcRead: fail."));
}
return Ok(pb_result);
}
fn impl_mem_read_as<T>(&self, pa : u64) -> ResultEx<T> {
unsafe {
let cb = u32::try_from(std::mem::size_of::<T>())?;
let mut result : T = std::mem::zeroed();
let r = (self.native.LcRead)(self.native.h, pa, cb, &mut result as *mut _ as *mut u8);
if !r {
return Err(anyhow!("LcRead: fail."));
}
return Ok(result);
}
}
fn impl_mem_write(&self, va : u64, data : &Vec<u8>) -> ResultEx<()> {
let cb = u32::try_from(data.len())?;
let pb = data.as_ptr();
let r = (self.native.LcWrite)(self.native.h, va, cb, pb);
if !r {
return Err(anyhow!("LcWrite: fail."));
}
return Ok(());
}
fn impl_mem_write_as<T>(&self, va : u64, data : &T) -> ResultEx<()> {
let cb = u32::try_from(std::mem::size_of::<T>())?;
let r = (self.native.LcWrite)(self.native.h, va, cb, data as *const _ as *const u8);
if !r {
return Err(anyhow!("LcWrite: fail."));
}
return Ok(());
}
fn impl_command(&self, command_id : u64, data : Option<&Vec<u8>>) -> ResultEx<Option<Vec<u8>>> {
unsafe {
let mut pb_out : *mut u8 = std::ptr::null_mut();
let mut cb_out : u32 = 0;
let cb_in;
let pb_in;
match data {
Some(data) => {
cb_in = u32::try_from(data.len())?;
pb_in = data.as_ptr();
},
None => {
cb_in = 0;
pb_in = std::ptr::null();
},
}
let r = (self.native.LcCommand)(self.native.h, command_id, cb_in, pb_in, &mut pb_out, &mut cb_out);
if !r {
return Err(anyhow!("LcCommand: fail."));
}
if pb_out.is_null() {
return Ok(None);
}
let mut pb_result: Vec<u8> = vec![0u8; cb_out as usize];
std::ptr::copy_nonoverlapping(pb_out, pb_result.as_mut_ptr(), cb_out as usize);
(self.native.LcMemFree)(pb_out as usize);
return Ok(Some(pb_result));
}
}
fn impl_get_memmap(&self) -> ResultEx<String> {
let memmap_vec = self.command(LeechCore::LC_CMD_MEMMAP_GET, None)?;
match memmap_vec {
Some(memmap_vec) => {
let memmap_str = String::from_utf8(memmap_vec)?;
return Ok(memmap_str);
},
None => {
return Err(anyhow!("Failed to get memmap."));
},
}
}
fn impl_set_memmap(&self, str_memmap : &str) -> ResultEx<()> {
let memmap_vec = str_memmap.as_bytes().to_vec();
self.command(LeechCore::LC_CMD_MEMMAP_SET, Some(&memmap_vec))?;
return Ok(());
}
fn impl_pcie_bar_info(&self) -> ResultEx<[LcBar; 6]> {
unsafe {
let mut cb_out = 0;
let mut pb_out = 0;
let r = (self.native.LcCommandPtr)(self.native.h, LeechCore::LC_CMD_FPGA_BAR_INFO, 0, 0, &mut pb_out, &mut cb_out);
if !r {
return Err(anyhow!("LcCommand: fail."));
}
if pb_out == 0 || cb_out as usize != 6 * std::mem::size_of::<CLC_BAR>() {
return Err(anyhow!("Failed to get PCIe BARs."));
}
let structs = pb_out as *const CLC_BAR;
let mut result : [LcBar; 6] = [LcBar::default(); 6];
let pMap = std::slice::from_raw_parts(structs, 6);
for i in 0..6 {
let ne = &pMap[i];
result[i] = LcBar {
bar_index : ne.iBar,
is_valid : ne.fValid != 0,
is_io : ne.fIO != 0,
is_64bit : ne.f64Bit != 0,
is_prefetchable : ne.fPrefetchable != 0,
pa : ne.pa,
cb : ne.cb,
};
}
return Ok(result);
}
}
fn impl_pcie_tlp_write(&self, tlp : &[u8]) -> ResultEx<()> {
if tlp.len() % 4 > 0 {
return Err(anyhow!("TLP length must be a multiple of 4."));
}
let r = (self.native.LcCommand)(self.native.h, LeechCore::LC_CMD_FPGA_TLP_WRITE_SINGLE, tlp.len() as u32, tlp.as_ptr(), std::ptr::null_mut(), std::ptr::null_mut());
if !r {
return Err(anyhow!("LcCommand: fail."));
}
return Ok(());
}
fn impl_pcie_bar_callback<T>(&self, ctx_user : T, fn_bar_callback : fn(ctx : &LcBarContext<T>, req : &LcBarRequest) -> ResultEx<()>) -> ResultEx<LcBarContextWrap<T>> {
unsafe {
let ctx = LcBarContext {
lc : self,
ctxlock : std::sync::RwLock::new(ctx_user),
fn_callback : fn_bar_callback,
native_ctx : 0,
};
let ctx_rust_box = Box::new(ctx);
let ctx_native = Box::into_raw(ctx_rust_box); // destroys ownership: returned LcBarContextWrap Drop is responsible for free.
(*ctx_native).native_ctx = ctx_native as usize;
let native_pfn = LeechCore::impl_pcie_bar_callback_external::<T> as usize;
let r = (self.native.LcCommandPtr)(self.native.h, LeechCore::LC_CMD_FPGA_BAR_CONTEXT, 0, ctx_native as usize, std::ptr::null_mut(), std::ptr::null_mut());
if !r {
return Err(anyhow!("LcCommand: fail."));
}
let r = (self.native.LcCommandPtr)(self.native.h, LeechCore::LC_CMD_FPGA_BAR_FUNCTION_CALLBACK, 0, native_pfn, std::ptr::null_mut(), std::ptr::null_mut());
if !r {
return Err(anyhow!("LcCommand: fail."));
}
let ctx_wrap = LcBarContextWrap {
ctx : &*ctx_native,
native : ctx_native,
};
return Ok(ctx_wrap);
}
}
fn impl_pcie_tlp_callback<T>(&self, ctx_user : T, fn_tlp_callback : fn(ctx : &LcTlpContext<T>, tlp : &[u8], tlp_str : &str) -> ResultEx<()>) -> ResultEx<LcTlpContextWrap<T>> {
unsafe {
let ctx = LcTlpContext {
lc : self,
ctxlock : std::sync::RwLock::new(ctx_user),
fn_callback : fn_tlp_callback,
native_ctx : 0,
};
let ctx_rust_box = Box::new(ctx);
let ctx_native = Box::into_raw(ctx_rust_box); // destroys ownership: returned LcTlpContextWrap Drop is responsible for free.
(*ctx_native).native_ctx = ctx_native as usize;
let native_pfn = LeechCore::impl_pcie_tlp_callback_external::<T> as usize;
let r = (self.native.LcSetOption)(self.native.h, LeechCore::LC_OPT_FPGA_TLP_READ_CB_WITHINFO, 1);
if !r {
return Err(anyhow!("LcSetOption: fail."));
}
let r = (self.native.LcCommandPtr)(self.native.h, LeechCore::LC_CMD_FPGA_TLP_CONTEXT, 0, ctx_native as usize, std::ptr::null_mut(), std::ptr::null_mut());
if !r {
return Err(anyhow!("LcCommand: fail."));
}
let r = (self.native.LcCommandPtr)(self.native.h, LeechCore::LC_CMD_FPGA_TLP_FUNCTION_CALLBACK, 0, native_pfn, std::ptr::null_mut(), std::ptr::null_mut());
if !r {
return Err(anyhow!("LcCommand: fail."));
}
let ctx_wrap = LcTlpContextWrap {
ctx : &*ctx_native,
native : ctx_native,
};
return Ok(ctx_wrap);
}
}
extern "C" fn impl_pcie_tlp_callback_external<T>(native_ctx : *const LcTlpContext<T>, cbTlp : u32, pbTlp : *const u8, cbInfo : u32, szInfo : *const u8) {
unsafe {
let ctx : &LcTlpContext<T> = &*native_ctx;
let tlp = std::slice::from_raw_parts(pbTlp, cbTlp as usize);
let info = std::str::from_utf8_unchecked(std::slice::from_raw_parts(szInfo, cbInfo as usize));
let _r = (ctx.fn_callback)(ctx, tlp, info);
}
}
extern "C" fn impl_pcie_bar_callback_external<T>(native_bar_request : *mut LC_BAR_REQUEST) {
unsafe {
let req = &*native_bar_request;
let ctx = &*(req.ctx as *const LcBarContext<T>);
// assign bar
let ne = &*req.pBar;
let bar = LcBar {
bar_index : ne.iBar,
is_valid : ne.fValid != 0,
is_io : ne.fIO != 0,
is_64bit : ne.f64Bit != 0,
is_prefetchable : ne.fPrefetchable != 0,
pa : ne.pa,
cb : ne.cb,
};
// assign bar request
let data_write : Option<Vec<u8>>;
if req.fWrite != 0 {
data_write = Some(std::slice::from_raw_parts(req.pbData.as_ptr(), req.cbData as usize).to_vec());
} else {
data_write = None;
}
let bar_request = LcBarRequest {
native : native_bar_request,
bar,
tag : req.bTag,
be_first : req.bFirstBE,
be_last : req.bLastBE,
is_64bit : req.f64 != 0,
is_read : req.fRead != 0,
is_write : req.fWrite != 0,
data_size : req.cbData,
data_offset : req.oData,
data_write,
};
let _r = (ctx.fn_callback)(ctx, &bar_request);
}
}
}
#[allow(non_snake_case)]
impl LcBarRequest {
fn impl_read_reply(&self, data_reply : &[u8], is_fail : bool) -> ResultEx<()> {
unsafe {
if !self.is_read {
return Err(anyhow!("LcBarRequest: only allowed to reply to read requests."));
}
if !is_fail && self.data_size != data_reply.len() as u32 {
return Err(anyhow!("LcBarRequest: reply data size mismatch."));
}
(*self.native).fReadReply = 1;
(*self.native).cbData = data_reply.len() as u32;
(*self.native).pbData[..data_reply.len()].copy_from_slice(data_reply);
return Ok(());
}
}
}
#[repr(C)]
#[derive(Clone, Debug)]
#[allow(non_snake_case, non_camel_case_types)]
struct CLC_CONFIG {
dwVersion : u32,
dwPrintfVerbosity : u32,
szDevice : [c_char; 260],
szRemote : [c_char; 260],
pfn_printf_opt : usize,
paMax : u64,
fVolatile : u32,
fWritable : u32,
fRemote : u32,
fRemoteDisableCompress : u32,
szDeviceName : [c_char; 260],
}
#[repr(C)]
#[derive(Clone, Debug)]
#[allow(non_snake_case, non_camel_case_types)]
struct CLC_BAR {
fValid : u32,
fIO : u32,
f64Bit : u32,
fPrefetchable : u32,
_Filler : [u32; 3],
iBar : u32,
pa : u64,
cb : u64,
}
#[repr(C)]
#[derive(Clone, Debug)]
#[allow(non_snake_case, non_camel_case_types)]
struct LC_BAR_REQUEST {
ctx : usize,
pBar : *const CLC_BAR,
bTag : u8,
bFirstBE : u8,
bLastBE : u8,
_Filler : u8,
f64 : u32,
fRead : u32,
fReadReply : u32,
fWrite : u32,
cbData : u32,
oData : u64,
pbData : [u8; 1024],
}