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
|
// Copyright (c) Meta Platforms, Inc. and affiliates.
// SPDX-License-Identifier: LGPL-2.1-or-later
#include <ctype.h>
#include <dirent.h>
#include <elf.h>
#include <elfutils/libdwelf.h>
#include <errno.h>
#include <fcntl.h>
#include <gelf.h>
#include <inttypes.h>
#include <libelf.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/mman.h>
#include <sys/stat.h>
#include <unistd.h>
#include "array.h"
#include "binary_buffer.h"
#include "bitops.h"
#include "cleanup.h"
#include "debug_info.h"
#include "drgn_internal.h"
#include "elf_file.h"
#include "elf_notes.h"
#include "error.h"
#include "hash_table.h"
#include "helpers.h"
#include "hexlify.h"
#include "io.h"
#include "linux_kernel.h"
#include "log.h"
#include "platform.h"
#include "program.h"
#include "symbol.h"
#include "type.h"
#include "util.h"
#include "drgn_program_parse_vmcoreinfo.inc"
struct drgn_error *read_memory_via_pgtable(void *buf, uint64_t address,
size_t count, uint64_t offset,
void *arg, bool physical)
{
struct drgn_program *prog = arg;
return linux_helper_read_vm(prog, prog->vmcoreinfo.swapper_pg_dir,
address, buf, count);
}
struct drgn_error *proc_kallsyms_symbol_addr(const char *name,
unsigned long *ret)
{
struct drgn_error *err;
FILE *file;
char *line = NULL;
size_t n = 0;
file = fopen("/proc/kallsyms", "r");
if (!file)
return drgn_error_create_os("fopen", errno, "/proc/kallsyms");
for (;;) {
char *addr_str, *sym_str, *saveptr, *end;
errno = 0;
if (getline(&line, &n, file) == -1) {
if (errno) {
err = drgn_error_create_os("getline", errno,
"/proc/kallsyms");
} else {
err = &drgn_not_found;
}
break;
}
addr_str = strtok_r(line, "\t ", &saveptr);
if (!addr_str || !*addr_str)
goto invalid;
if (!strtok_r(NULL, "\t ", &saveptr))
goto invalid;
sym_str = strtok_r(NULL, "\t\n ", &saveptr);
if (!sym_str)
goto invalid;
if (strcmp(sym_str, name) != 0)
continue;
errno = 0;
*ret = strtoul(line, &end, 16);
if (errno || *end) {
invalid:
err = drgn_error_create(DRGN_ERROR_OTHER,
"could not parse /proc/kallsyms");
break;
}
err = NULL;
break;
}
free(line);
fclose(file);
return err;
}
/*
* Before Linux kernel commit 23c85094fe18 ("proc/kcore: add vmcoreinfo note to
* /proc/kcore") (in v4.19), /proc/kcore didn't have a VMCOREINFO note. Instead,
* we can read from the physical address of the vmcoreinfo note exported in
* sysfs.
*/
struct drgn_error *read_vmcoreinfo_fallback(struct drgn_program *prog)
{
struct drgn_error *err;
FILE *file;
uint64_t address;
size_t size;
Elf64_Nhdr *nhdr;
file = fopen("/sys/kernel/vmcoreinfo", "r");
if (!file) {
return drgn_error_create_os("fopen", errno,
"/sys/kernel/vmcoreinfo");
}
if (fscanf(file, "%" SCNx64 "%zx", &address, &size) != 2) {
fclose(file);
return drgn_error_create(DRGN_ERROR_OTHER,
"could not parse /sys/kernel/vmcoreinfo");
}
fclose(file);
_cleanup_free_ char *buf = malloc(size);
if (!buf)
return &drgn_enomem;
err = drgn_program_read_memory(prog, buf, address, size, true);
if (err)
return err;
/*
* The first 12 bytes are the Elf{32,64}_Nhdr (it's the same in both
* formats). The name is padded up to 4 bytes, so the descriptor starts
* at byte 24.
*/
nhdr = (Elf64_Nhdr *)buf;
if (size < 24 || nhdr->n_namesz != 11 ||
memcmp(buf + sizeof(*nhdr), "VMCOREINFO", 10) != 0 ||
nhdr->n_descsz > size - 24) {
err = drgn_error_create(DRGN_ERROR_OTHER,
"VMCOREINFO is invalid");
return err;
}
return drgn_program_parse_vmcoreinfo(prog, buf + 24, nhdr->n_descsz);
}
#define LINUX_KERNEL_GET_PRIMITIVE(name, primitive_type, signed_unsigned, expr) \
static struct drgn_error *linux_kernel_get_##name(struct drgn_program *prog, \
struct drgn_object *ret) \
{ \
struct drgn_error *err; \
struct drgn_qualified_type qualified_type; \
err = drgn_program_find_primitive_type(prog, (primitive_type), \
&qualified_type.type); \
if (err) \
return err; \
qualified_type.qualifiers = 0; \
return drgn_object_set_##signed_unsigned(ret, qualified_type, (expr), \
0); \
}
#define LINUX_KERNEL_GET_PRIMITIVE_WRAPPER(name, primitive_type) \
static struct drgn_error *linux_kernel_get_##name(struct drgn_program *prog, \
struct drgn_object *ret) \
{ \
struct drgn_error *err; \
typeof(_Generic(&linux_kernel_get_##name##_impl, \
struct drgn_error *(*)(struct drgn_program *, \
uint64_t *): (uint64_t)0, \
struct drgn_error *(*)(struct drgn_program *, \
int64_t *): (int64_t)0)) \
value; \
err = linux_kernel_get_##name##_impl(prog, &value); \
if (err) \
return err; \
struct drgn_qualified_type qualified_type; \
err = drgn_program_find_primitive_type(prog, (primitive_type), \
&qualified_type.type); \
if (err) \
return err; \
qualified_type.qualifiers = 0; \
return _Generic(value, \
uint64_t: drgn_object_set_unsigned, \
int64_t: drgn_object_set_signed) \
(ret, qualified_type, value, 0); \
}
LINUX_KERNEL_GET_PRIMITIVE(page_shift, DRGN_C_TYPE_INT, signed,
prog->vmcoreinfo.page_shift)
LINUX_KERNEL_GET_PRIMITIVE(page_size, DRGN_C_TYPE_UNSIGNED_LONG, unsigned,
prog->vmcoreinfo.page_size)
LINUX_KERNEL_GET_PRIMITIVE(page_mask, DRGN_C_TYPE_UNSIGNED_LONG, unsigned,
~(prog->vmcoreinfo.page_size - 1))
static struct drgn_error *linux_kernel_get_thread_size(struct drgn_program *prog,
struct drgn_object *ret)
{
struct drgn_error *err;
struct drgn_qualified_type qualified_type, thread_union;
qualified_type.qualifiers = 0;
err = drgn_program_find_primitive_type(prog, DRGN_C_TYPE_UNSIGNED_LONG,
&qualified_type.type);
if (err)
return err;
if (prog->thread_size_cached)
return drgn_object_set_unsigned(ret, qualified_type,
prog->thread_size_cached, 0);
/* Prior to 0500871f21b23 ("Construct init thread stack in the linker
* script rather than by union") in v4.16, the file init/init_task.c
* defined a variable of type "union thread_union" which contains a
* member "stack" whose size is THREAD_SIZE. After that commit, it is
* defined via the linker script, and so the variable disappears from
* debuginfo, along with its type. Thankfully, the linker script defines
* symbols that can also be used to infer THREAD_SIZE.
*
* Normally, we optimize for recent kernels by putting their cases first
* in the code. But in this case, the "__{start,end}_init_task" symbols
* do exist on some architectures (e.g. ppc64) prior to v4.16. However,
* prior to v4.16, they aren't guaranteed to have the correct value of
* THREAD_SIZE. So, we need to check for "union thread_union" first, to
* get the most accurate value for those architectures prior to v4.16.
*/
err = drgn_program_find_type(prog, "union thread_union", NULL,
&thread_union);
if (!err) {
struct drgn_type_member *stack_member;
uint64_t bit_offset_unused;
err = drgn_type_find_member(thread_union.type, "stack",
&stack_member, &bit_offset_unused);
if (err)
return err;
struct drgn_qualified_type stack_type;
err = drgn_member_type(stack_member, &stack_type, NULL);
if (err)
return err;
err = drgn_type_sizeof(stack_type.type, &prog->thread_size_cached);
if (err)
return err;
return drgn_object_set_unsigned(ret, qualified_type,
prog->thread_size_cached, 0);
} else if (!drgn_error_catch(&err, DRGN_ERROR_LOOKUP)) {
return err;
}
#define SYMBOL_START_END(symname_start, symname_end) do { \
struct drgn_symbol _cleanup_symbol_ *sym_start = NULL; \
struct drgn_symbol _cleanup_symbol_ *sym_end = NULL; \
err = drgn_program_find_symbol_by_name(prog, symname_start, &sym_start); \
if (drgn_error_catch(&err, DRGN_ERROR_LOOKUP)) \
break; \
else if (err) \
return err; \
err = drgn_program_find_symbol_by_name(prog, symname_end, &sym_end); \
if (err) \
return err; \
prog->thread_size_cached = sym_end->address - sym_start->address; \
return drgn_object_set_unsigned(ret, qualified_type, \
prog->thread_size_cached, 0); \
} while (0)
/* From Linux 4.16 up to 6.10's commit 8f69cba096b5c ("x86: Rename
* __{start,end}_init_task to __{start,end}_init_stack"), the symbols
* were named __{start,end}_init_task. Though the commit message
* indicates that the init_task is only used on x86, the symbols are
* present and accurate on other architectures regardless. */
SYMBOL_START_END("__start_init_task", "__end_init_task");
/* For Linux v6.10 and later, we can observe the stack size by the
* __{start,end}_init_stack symbols. */
SYMBOL_START_END("__start_init_stack", "__end_init_stack");
#undef SYMBOL_START_END
return &drgn_not_found;
}
static struct drgn_error *
linux_kernel_get_uts_release(struct drgn_program *prog, struct drgn_object *ret)
{
struct drgn_error *err;
struct drgn_qualified_type qualified_type;
err = drgn_program_find_primitive_type(prog,
DRGN_C_TYPE_CHAR,
&qualified_type.type);
if (err)
return err;
qualified_type.qualifiers = DRGN_QUALIFIER_CONST;
size_t len = strlen(prog->vmcoreinfo.osrelease);
err = drgn_array_type_create(prog, qualified_type, len + 1,
&drgn_language_c, &qualified_type.type);
if (err)
return err;
qualified_type.qualifiers = 0;
return drgn_object_set_from_buffer(ret, qualified_type,
prog->vmcoreinfo.osrelease, len + 1,
0, 0);
}
// jiffies is defined as an alias of jiffies_64 via the Linux kernel linker
// script, so it is not included in debug info.
static struct drgn_error *linux_kernel_get_jiffies(struct drgn_program *prog,
struct drgn_object *ret)
{
struct drgn_error *err;
DRGN_OBJECT(jiffies_64, prog);
err = drgn_program_find_object(prog, "jiffies_64", NULL,
DRGN_FIND_OBJECT_VARIABLE, &jiffies_64);
if (err) {
if (err->code == DRGN_ERROR_LOOKUP) {
drgn_error_destroy(err);
err = &drgn_not_found;
}
return err;
}
if (jiffies_64.kind != DRGN_OBJECT_REFERENCE)
return &drgn_not_found;
uint64_t address = jiffies_64.address;
struct drgn_qualified_type qualified_type;
err = drgn_program_find_primitive_type(prog, DRGN_C_TYPE_UNSIGNED_LONG,
&qualified_type.type);
if (err)
return err;
qualified_type.qualifiers = DRGN_QUALIFIER_VOLATILE;
if (drgn_type_size(qualified_type.type) == 4 &&
!drgn_type_little_endian(qualified_type.type))
address += 4;
return drgn_object_set_reference(ret, qualified_type, address, 0, 0);
}
static struct drgn_error *
linux_kernel_get_vmcoreinfo(struct drgn_program *prog, struct drgn_object *ret)
{
struct drgn_error *err;
struct drgn_qualified_type qualified_type;
err = drgn_program_find_primitive_type(prog,
DRGN_C_TYPE_CHAR,
&qualified_type.type);
if (err)
return err;
qualified_type.qualifiers = DRGN_QUALIFIER_CONST;
err = drgn_array_type_create(prog, qualified_type, prog->vmcoreinfo.raw_size,
&drgn_language_c, &qualified_type.type);
if (err)
return err;
qualified_type.qualifiers = 0;
return drgn_object_set_from_buffer(ret, qualified_type, prog->vmcoreinfo.raw,
prog->vmcoreinfo.raw_size, 0, 0);
}
// The vmemmap address can vary depending on architecture, kernel version,
// configuration options, and KASLR. However, we can get it generically from the
// section_mem_map of any valid mem_section.
static struct drgn_error *
linux_kernel_get_vmemmap_address(struct drgn_program *prog, uint64_t *ret)
{
static const uint64_t SECTION_HAS_MEM_MAP = 0x2;
static const uint64_t SECTION_MAP_MASK = ~((UINT64_C(1) << 6) - 1);
struct drgn_error *err;
DRGN_OBJECT(mem_section, prog);
DRGN_OBJECT(root, prog);
DRGN_OBJECT(section, prog);
err = drgn_program_find_object(prog, "vmemmap_populate", NULL,
DRGN_FIND_OBJECT_FUNCTION, &mem_section);
if (err) {
if (err->code == DRGN_ERROR_LOOKUP) {
// !CONFIG_SPARSEMEM_VMEMMAP
drgn_error_destroy(err);
err = &drgn_not_found;
}
return err;
}
err = drgn_program_find_object(prog, "mem_section", NULL,
DRGN_FIND_OBJECT_VARIABLE, &mem_section);
if (err)
return err;
const uint64_t nr_section_roots = prog->vmcoreinfo.mem_section_length;
uint64_t sections_per_root;
if (drgn_type_kind(mem_section.type) == DRGN_TYPE_ARRAY) {
// If !CONFIG_SPARSEMEM_EXTREME, mem_section is
// struct mem_section mem_section[NR_SECTION_ROOTS][SECTIONS_PER_ROOT],
// and SECTIONS_PER_ROOT is 1.
sections_per_root = 1;
} else {
// If CONFIG_SPARSEMEM_EXTREME, mem_section is
// struct mem_section **mem_section, and SECTIONS_PER_ROOT is
// PAGE_SIZE / sizeof(struct mem_section).
struct drgn_type *mem_section_type = mem_section.type;
for (int i = 0; i < 2; i++) {
if (drgn_type_kind(mem_section_type) != DRGN_TYPE_POINTER) {
unrecognized_mem_section_type:
return drgn_type_error("mem_section has unrecognized type '%s'",
mem_section.type);
}
mem_section_type = drgn_type_type(mem_section_type).type;
}
if (drgn_type_kind(mem_section_type) != DRGN_TYPE_STRUCT)
goto unrecognized_mem_section_type;
uint64_t sizeof_mem_section = drgn_type_size(mem_section_type);
if (sizeof_mem_section == 0)
goto unrecognized_mem_section_type;
sections_per_root =
prog->vmcoreinfo.page_size / sizeof_mem_section;
}
// Find a valid section.
for (uint64_t i = 0; i < nr_section_roots; i++) {
err = drgn_object_subscript(&root, &mem_section, i);
if (err)
return err;
bool truthy;
err = drgn_object_bool(&root, &truthy);
if (err)
return err;
if (!truthy)
continue;
for (uint64_t j = 0; j < sections_per_root; j++) {
err = drgn_object_subscript(§ion, &root, j);
if (err)
return err;
err = drgn_object_member(§ion, §ion,
"section_mem_map");
if (err)
return err;
uint64_t section_mem_map;
err = drgn_object_read_unsigned(§ion,
§ion_mem_map);
if (err)
return err;
if (section_mem_map & SECTION_HAS_MEM_MAP) {
*ret = section_mem_map & SECTION_MAP_MASK;
return NULL;
}
}
}
return &drgn_not_found;
}
static struct drgn_error *linux_kernel_get_vmemmap(struct drgn_program *prog,
struct drgn_object *ret)
{
struct drgn_error *err;
if (prog->vmemmap.kind == DRGN_OBJECT_ABSENT) {
// Silence -Wmaybe-uninitialized false positive last seen with
// GCC 13 by initializing to zero.
uint64_t address = 0;
err = linux_kernel_get_vmemmap_address(prog, &address);
if (err)
return err;
struct drgn_qualified_type qualified_type;
err = drgn_program_find_type(prog, "struct page *", NULL,
&qualified_type);
if (err)
return err;
err = drgn_object_set_unsigned(&prog->vmemmap, qualified_type,
address, 0);
if (err)
return err;
}
return drgn_object_copy(ret, &prog->vmemmap);
}
static struct drgn_error *
linux_kernel_get_nr_section_roots_impl(struct drgn_program *prog, uint64_t *ret)
{
if (prog->vmcoreinfo.mem_section_length == 0)
return &drgn_not_found;
*ret = prog->vmcoreinfo.mem_section_length;
return NULL;
}
LINUX_KERNEL_GET_PRIMITIVE_WRAPPER(nr_section_roots, DRGN_C_TYPE_UNSIGNED_LONG)
static struct drgn_error *
linux_kernel_get_sections_per_root_impl(struct drgn_program *prog, uint64_t *ret)
{
struct drgn_error *err;
if (prog->cached_sections_per_root) {
*ret = prog->cached_sections_per_root;
return NULL;
}
if (!prog->vmcoreinfo.mem_section_length) // !SPARSEMEM
return &drgn_not_found;
DRGN_OBJECT(mem_section, prog);
err = drgn_program_find_object(prog, "mem_section", NULL,
DRGN_FIND_OBJECT_VARIABLE, &mem_section);
if (err)
return err;
// For SPARSEMEM_STATIC, mem_section is always an array of arrays. For
// SPARSEMEM_EXTREME, since Linux kernel commit 83e3c48729d9
// ("mm/sparsemem: Allocate mem_section at runtime for
// CONFIG_SPARSEMEM_EXTREME=y") (in v4.15), it is a pointer to a pointer
// to struct mem_section. Before that, it is an array of pointers to
// struct mem_section.
struct drgn_type *outer_type = drgn_underlying_type(mem_section.type);
enum drgn_type_kind outer_kind = drgn_type_kind(outer_type);
if (outer_kind != DRGN_TYPE_POINTER && outer_kind != DRGN_TYPE_ARRAY) {
return drgn_type_error("mem_section has unrecognized type: %s",
outer_type);
}
struct drgn_type *inner_type =
drgn_underlying_type(drgn_type_type(outer_type).type);
enum drgn_type_kind inner_kind = drgn_type_kind(inner_type);
if (outer_kind == DRGN_TYPE_ARRAY && inner_kind == DRGN_TYPE_ARRAY) {
// SPARSEMEM_STATIC: SECTIONS_PER_ROOT = 1
*ret = 1;
return NULL;
}
if (inner_kind != DRGN_TYPE_POINTER) {
return drgn_type_error("mem_section[0] has unrecognized type: %s",
inner_type);
}
// SPARSEMEM_EXTREME: SECTIONS_PER_ROOT = PAGE_SIZE / sizeof(struct mem_section)
uint64_t sizeof_mem_section;
err = drgn_type_sizeof(drgn_underlying_type(drgn_type_type(inner_type).type),
&sizeof_mem_section);
if (err)
return err;
if (!is_power_of_two(sizeof_mem_section)) {
return drgn_error_create(DRGN_ERROR_OTHER,
"struct mem_section has invalid size");
}
*ret = prog->cached_sections_per_root =
prog->vmcoreinfo.page_size / sizeof_mem_section;
return err;
}
LINUX_KERNEL_GET_PRIMITIVE_WRAPPER(sections_per_root, DRGN_C_TYPE_UNSIGNED_LONG)
static struct drgn_error *
linux_kernel_get_section_size_bits_impl(struct drgn_program *prog, int64_t *ret)
{
if (prog->vmcoreinfo.section_size_bits) {
*ret = prog->vmcoreinfo.section_size_bits;
return NULL;
}
if (!prog->vmcoreinfo.mem_section_length // !SPARSEMEM
|| !prog->has_platform
|| !prog->platform.arch->linux_kernel_section_size_bits_fallback)
return &drgn_not_found;
// Before Linux kernel commit 4f5aecdff25f ("crash_core, vmcoreinfo:
// append 'SECTION_SIZE_BITS' to vmcoreinfo") (in v5.13), we need
// architecture- and version-specific logic to determine
// SECTION_SIZE_BITS.
*ret = prog->vmcoreinfo.section_size_bits =
prog->platform.arch->linux_kernel_section_size_bits_fallback(prog);
return NULL;
}
LINUX_KERNEL_GET_PRIMITIVE_WRAPPER(section_size_bits, DRGN_C_TYPE_INT)
static struct drgn_error *
linux_kernel_get_max_physmem_bits_impl(struct drgn_program *prog, int64_t *ret)
{
struct drgn_error *err;
if (prog->vmcoreinfo.max_physmem_bits) {
*ret = prog->vmcoreinfo.max_physmem_bits;
return NULL;
}
if (!prog->vmcoreinfo.mem_section_length) // !SPARSEMEM
return &drgn_not_found;
// Before Linux kernel commit 1d50e5d0c505 ("crash_core, vmcoreinfo:
// Append 'MAX_PHYSMEM_BITS' to vmcoreinfo") (in v5.9), we can compute
// MAX_PHYSMEM_BITS from NR_SECTION_ROOTS and SECTION_SIZE_BITS. On
// architectures where's it's straightforward to figure out
// MAX_PHYSMEM_BITS, we can get it that way, too.
if (prog->has_platform
&& prog->platform.arch->linux_kernel_max_physmem_bits_fallback) {
prog->vmcoreinfo.max_physmem_bits =
prog->platform.arch->linux_kernel_max_physmem_bits_fallback(prog);
} else {
// Given:
// NR_SECTION_ROOTS = NR_MEM_SECTIONS / SECTIONS_PER_ROOT
// NR_MEM_SECTIONS = 1 << SECTIONS_SHIFT
// SECTIONS_SHIFT = MAX_PHYSMEM_BITS - SECTION_SIZE_BITS
//
// Solve for MAX_PHYSMEM_BITS:
// => NR_SECTION_ROOTS = (1 << (MAX_PHYSMEM_BITS - SECTION_SIZE_BITS))
// / SECTIONS_PER_ROOT
//
// => NR_SECTION_ROOTS * SECTIONS_PER_ROOT
// = (1 << (MAX_PHYSMEM_BITS - SECTION_SIZE_BITS))
//
// => log2(NR_SECTION_ROOTS * SECTIONS_PER_ROOT)
// = MAX_PHYSMEM_BITS - SECTION_SIZE_BITS
//
// => MAX_PHYSMEM_BITS = log2(NR_SECTION_ROOTS * SECTIONS_PER_ROOT)
// + SECTION_SIZE_BITS
//
// (NR_SECTION_ROOTS and SECTIONS_PER_ROOT are always powers of
// two.)
//
// => MAX_PHYSMEM_BITS = log2(NR_SECTION_ROOTS)
// + log2(SECTIONS_PER_ROOT)
// + SECTION_SIZE_BITS
uint64_t sections_per_root;
err = linux_kernel_get_sections_per_root_impl(prog,
§ions_per_root);
if (err)
return err;
int64_t section_size_bits;
err = linux_kernel_get_section_size_bits_impl(prog,
§ion_size_bits);
if (err)
return err;
prog->vmcoreinfo.max_physmem_bits =
ilog2(prog->vmcoreinfo.mem_section_length)
+ ilog2(sections_per_root)
+ section_size_bits;
}
*ret = prog->vmcoreinfo.max_physmem_bits;
return NULL;
}
LINUX_KERNEL_GET_PRIMITIVE_WRAPPER(max_physmem_bits, DRGN_C_TYPE_INT)
static struct drgn_error *
linux_kernel_get_arch_pfn_offset_impl(struct drgn_program *prog, uint64_t *ret)
{
struct drgn_error *err;
if (prog->arch_pfn_offset_cached) {
*ret = prog->arch_pfn_offset;
return NULL;
}
// Note that contig_page_data.node_mem_map is the struct page * for
// contig_page_data.node_start_pfn. Therefore:
// contig_page_data.node_mem_map = mem_map
// + contig_page_data.node_start_pfn
// - ARCH_PFN_OFFSET
// => ARCH_PFN_OFFSET = mem_map
// + contig_page_data.node_start_pfn
// - contig_page_data.node_mem_map
DRGN_OBJECT(contig_page_data, prog);
DRGN_OBJECT(tmp, prog);
DRGN_OBJECT(tmp2, prog);
err = drgn_program_find_object(prog, "mem_map", NULL,
DRGN_FIND_OBJECT_ANY, &tmp);
if (err)
return err;
err = drgn_program_find_object(prog, "contig_page_data", NULL,
DRGN_FIND_OBJECT_ANY, &contig_page_data);
if (err)
return err;
err = drgn_object_member(&tmp2, &contig_page_data, "node_start_pfn");
if (err)
return err;
err = drgn_object_add(&tmp, &tmp, &tmp2);
if (err)
return err;
err = drgn_object_member(&tmp2, &contig_page_data, "node_mem_map");
if (err)
return err;
err = drgn_object_sub(&tmp, &tmp, &tmp2);
if (err)
return err;
int64_t arch_pfn_offset;
err = drgn_object_read_signed(&tmp, &arch_pfn_offset);
if (err)
return err;
prog->arch_pfn_offset = arch_pfn_offset;
prog->arch_pfn_offset_cached = true;
*ret = prog->arch_pfn_offset;
return NULL;
}
LINUX_KERNEL_GET_PRIMITIVE_WRAPPER(arch_pfn_offset, DRGN_C_TYPE_UNSIGNED_LONG)
#include "linux_kernel_object_find.inc" // IWYU pragma: keep
// Return whether the given kernel is from Fedora. We check whether the release
// matches the regular expression /.fc[0-9]+(.|$)/
static bool is_fedora_kernel(const char *osrelease)
{
const char *p = osrelease;
while ((p = strstr(p, ".fc"))) {
p += sizeof(".fc") - 1;
if (isdigit(*p)) {
do {
p++;
} while (isdigit(*p));
if (*p == '.' || *p == '\0')
return true;
}
}
return false;
}
struct drgn_error *drgn_program_finish_set_kernel(struct drgn_program *prog)
{
struct drgn_error *err;
const struct drgn_object_finder_ops ops = {
.find = linux_kernel_object_find,
};
err = drgn_program_register_object_finder(prog, "linux", &ops, prog, 0);
if (err)
return err;
if (!prog->lang)
prog->lang = &drgn_language_c;
// At the time of writing, only Fedora's debuginfod server provides fast
// Linux kernel downloads. It's painfully slow everywhere else, so
// disable it.
if (!is_fedora_kernel(prog->vmcoreinfo.osrelease)
&& drgn_handler_list_disable(&prog->dbinfo.debug_info_finders,
"debuginfod"))
drgn_log_debug(prog, "disabled debuginfod for Linux kernel");
return NULL;
}
/*
* /lib/modules/$(uname -r)/modules.dep.bin maps all installed kernel modules to
* their filesystem path (and dependencies, which we don't care about). It is
* generated by depmod; the format is a fairly simple serialized radix tree.
*
* modules.dep(5) contains a warning: "These files are not intended for editing
* or use by any additional utilities as their format is subject to change in
* the future." But, the format hasn't changed since 2009, and pulling in
* libkmod is overkill since we only need a very small subset of its
* functionality (plus our minimal parser is more efficient). If the format
* changes in the future, we can reevaluate this.
*/
static void depmod_index_deinit(struct depmod_index *depmod)
{
if (depmod->len > 0)
munmap(depmod->addr, depmod->len);
free(depmod->path);
}
struct depmod_index_buffer {
struct binary_buffer bb;
struct depmod_index *depmod;
};
static struct drgn_error *depmod_index_buffer_error(struct binary_buffer *bb,
const char *pos,
const char *message)
{
struct depmod_index_buffer *buffer =
container_of(bb, struct depmod_index_buffer, bb);
return drgn_error_format(DRGN_ERROR_OTHER, "%s: %#tx: %s",
buffer->depmod->path,
pos - (const char *)buffer->depmod->addr,
message);
}
static void depmod_index_buffer_init(struct depmod_index_buffer *buffer,
struct depmod_index *depmod)
{
binary_buffer_init(&buffer->bb, depmod->addr, depmod->len, false,
depmod_index_buffer_error);
buffer->depmod = depmod;
}
static struct drgn_error *depmod_index_validate(struct depmod_index *depmod)
{
struct drgn_error *err;
struct depmod_index_buffer buffer;
depmod_index_buffer_init(&buffer, depmod);
uint32_t magic;
if ((err = binary_buffer_next_u32(&buffer.bb, &magic)))
return err;
if (magic != 0xb007f457) {
return binary_buffer_error(&buffer.bb,
"invalid magic 0x%" PRIx32, magic);
}
uint32_t version;
if ((err = binary_buffer_next_u32(&buffer.bb, &version)))
return err;
if (version != 0x00020001) {
return binary_buffer_error(&buffer.bb,
"unknown version 0x%" PRIx32,
version);
}
return NULL;
}
static struct drgn_error *depmod_index_init(struct depmod_index *depmod,
char *_path, int fd)
{
struct drgn_error *err;
_cleanup_free_ char *path = _path; // Take ownership of path.
struct stat st;
if (fstat(fd, &st) == -1)
return drgn_error_create_os("fstat", errno, path);
if (st.st_size > SIZE_MAX)
return &drgn_enomem;
void *addr = mmap(NULL, st.st_size, PROT_READ, MAP_PRIVATE, fd, 0);
if (addr == MAP_FAILED)
return drgn_error_create_os("mmap", errno, path);
depmod->path = no_cleanup_ptr(path);
depmod->addr = addr;
depmod->len = st.st_size;
err = depmod_index_validate(depmod);
if (err) {
depmod_index_deinit(depmod);
depmod->path = NULL;
depmod->len = 0;
}
return err;
}
/*
* Look up the path of the kernel module with the given name.
*
* @param[in] name Name of the kernel module.
* @param[out] path_ret Returned path of the kernel module, relative to
* /lib/modules/$(uname -r). This is @em not null-terminated. @c NULL if not
* found.
* @param[out] len_ret Returned length of @p path_ret.
*/
static struct drgn_error *depmod_index_find(struct depmod_index *depmod,
const char *name,
const char **path_ret,
size_t *len_ret)
{
static const uint32_t INDEX_NODE_MASK = UINT32_C(0x0fffffff);
static const uint32_t INDEX_NODE_CHILDS = UINT32_C(0x20000000);
static const uint32_t INDEX_NODE_VALUES = UINT32_C(0x40000000);
static const uint32_t INDEX_NODE_PREFIX = UINT32_C(0x80000000);
struct drgn_error *err;
struct depmod_index_buffer buffer;
depmod_index_buffer_init(&buffer, depmod);
/* depmod_index_validate() already checked that this is within bounds. */
buffer.bb.pos += 8;
uint32_t offset;
for (;;) {
if ((err = binary_buffer_next_u32(&buffer.bb, &offset)))
return err;
if ((offset & INDEX_NODE_MASK) > depmod->len) {
return binary_buffer_error(&buffer.bb,
"offset is out of bounds");
}
buffer.bb.pos = (const char *)depmod->addr + (offset & INDEX_NODE_MASK);
if (offset & INDEX_NODE_PREFIX) {
const char *prefix;
size_t prefix_len;
if ((err = binary_buffer_next_string(&buffer.bb,
&prefix,
&prefix_len)))
return err;
if (strncmp(name, prefix, prefix_len) != 0)
goto not_found;
name += prefix_len;
}
if (offset & INDEX_NODE_CHILDS) {
uint8_t first, last;
if ((err = binary_buffer_next_u8(&buffer.bb, &first)) ||
(err = binary_buffer_next_u8(&buffer.bb, &last)))
return err;
if (*name) {
uint8_t cur = *name;
if (cur < first || cur > last)
goto not_found;
if ((err = binary_buffer_skip(&buffer.bb,
4 * (cur - first))))
return err;
name++;
continue;
} else {
if ((err = binary_buffer_skip(&buffer.bb,
4 * (last - first + 1))))
return err;
break;
}
} else if (*name) {
goto not_found;
} else {
break;
}
}
if (!(offset & INDEX_NODE_VALUES))
goto not_found;
uint32_t value_count;
if ((err = binary_buffer_next_u32(&buffer.bb, &value_count)))
return err;
if (!value_count)
goto not_found; /* Or is this malformed? */
/* Skip over priority. */
if ((err = binary_buffer_skip(&buffer.bb, 4)))
return err;
const char *colon = memchr(buffer.bb.pos, ':',
buffer.bb.end - buffer.bb.pos);
if (!colon) {
return binary_buffer_error(&buffer.bb,
"expected string containing ':'");
}
*path_ret = buffer.bb.pos;
*len_ret = colon - buffer.bb.pos;
return NULL;
not_found:
*path_ret = NULL;
return NULL;
}
DEFINE_VECTOR_FUNCTIONS(char_p_vector);
DEFINE_HASH_MAP_FUNCTIONS(drgn_kmod_walk_module_map, c_string_key_hash_pair,
c_string_key_eq);
struct drgn_kmod_walk_stack_entry {
DIR *dir;
size_t path_len;
};
DEFINE_VECTOR_FUNCTIONS(drgn_kmod_walk_stack);
static inline struct hash_pair
drgn_kmod_walk_inode_hash_pair(const struct drgn_kmod_walk_inode *entry)
{
return hash_pair_from_avalanching_hash(hash_combine(entry->dev, entry->ino));
}
static inline bool
drgn_kmod_walk_inode_eq(const struct drgn_kmod_walk_inode *a,
const struct drgn_kmod_walk_inode *b)
{
return a->dev == b->dev && a->ino == b->ino;
}
DEFINE_HASH_SET_FUNCTIONS(drgn_kmod_walk_inode_set,
drgn_kmod_walk_inode_hash_pair,
drgn_kmod_walk_inode_eq);
static void
drgn_kmod_walk_module_map_entry_deinit(struct drgn_kmod_walk_module_map_entry *entry)
{
vector_for_each(char_p_vector, path, &entry->value)
free(*path);
char_p_vector_deinit(&entry->value);
}
static void
drgn_kmod_walk_state_deinit(struct drgn_kmod_walk_state *state)
{
drgn_kmod_walk_inode_set_deinit(&state->visited_dirs);
string_builder_deinit(&state->path);
vector_for_each(drgn_kmod_walk_stack, entry, &state->stack)
closedir(entry->dir);
drgn_kmod_walk_stack_deinit(&state->stack);
hash_table_for_each(drgn_kmod_walk_module_map, it, &state->modules)
drgn_kmod_walk_module_map_entry_deinit(it.entry);
drgn_kmod_walk_module_map_deinit(&state->modules);
}
void
drgn_standard_debug_info_find_state_deinit(struct drgn_standard_debug_info_find_state *state)
{
drgn_kmod_walk_state_deinit(&state->kmod_walk);
depmod_index_deinit(&state->modules_dep);
}
static struct drgn_error *
drgn_module_try_vmlinux_in_debug_directories(struct drgn_module *module,
const struct drgn_debug_info_options *options,
struct string_builder *sb)
{
struct drgn_error *err;
// Paths relative to the debug directory where vmlinux might be
// installed.
static const char * const debug_dir_paths[] = {
// Debian, Ubuntu:
"/boot/vmlinux-%s",
// Fedora, CentOS:
"/lib/modules/%s/vmlinux",
// SUSE:
"/lib/modules/%s/vmlinux.debug",
};
for (size_t i = 0; options->directories[i]; i++) {
const char *debug_dir = options->directories[i];
sb->len = 0;
if (!string_builder_append(sb, debug_dir))
return &drgn_enomem;
size_t debug_dir_len = sb->len;
array_for_each(format, debug_dir_paths) {
sb->len = debug_dir_len;
if (!string_builder_appendf(sb, *format,
module->prog->vmcoreinfo.osrelease)
|| !string_builder_null_terminate(sb))
return &drgn_enomem;
err = drgn_module_try_standard_file(module, options,
sb->str, -1, true,
NULL);
if (err || !drgn_module_wants_file(module))
return err;
}
}
return NULL;
}
struct drgn_error *
drgn_module_try_vmlinux_files(struct drgn_module *module,
const struct drgn_debug_info_options *options)
{
struct drgn_error *err;
struct drgn_program *prog = module->prog;
const char *osrelease = prog->vmcoreinfo.osrelease;
STRING_BUILDER(sb);
for (size_t i = 0; options->kernel_directories[i]; i++) {
const char *kernel_dir = options->kernel_directories[i];
if (kernel_dir[0]) {
sb.len = 0;
if (!string_builder_append(&sb, kernel_dir))
return &drgn_enomem;
} else {
// Empty path. Try under the debug directories first.
err = drgn_module_try_vmlinux_in_debug_directories(module,
options,
&sb);
if (err || !drgn_module_wants_file(module))
return err;
// Try /boot/vmlinux-$osrelease.
sb.len = 0;
if (!string_builder_append(&sb, "/boot/vmlinux-")
|| !string_builder_append(&sb, osrelease)
|| !string_builder_null_terminate(&sb))
return &drgn_enomem;
err = drgn_module_try_standard_file(module, options,
sb.str, -1, true,
NULL);
if (err || !drgn_module_wants_file(module))
return err;
// Try /lib/modules/$osrelease as the kernel directory.
sb.len = 0;
if (!string_builder_append(&sb, "/lib/modules/")
|| !string_builder_append(&sb, osrelease))
return &drgn_enomem;
}
// Paths relative to the kernel directory where vmlinux might be
// installed.
static const char * const kernel_dir_paths[] = {
"/build/vmlinux",
"/vmlinux",
};
size_t kernel_dir_len = sb.len;
array_for_each(path, kernel_dir_paths) {
if (!string_builder_append(&sb, *path)
|| !string_builder_null_terminate(&sb))
return &drgn_enomem;
err = drgn_module_try_standard_file(module, options,
sb.str, -1, true,
NULL);
if (err || !drgn_module_wants_file(module))
return err;
sb.len = kernel_dir_len;
}
}
return NULL;
}
static struct drgn_error *
drgn_open_modules_dep(struct drgn_program *prog,
const struct drgn_debug_info_options *options,
struct depmod_index *modules_dep)
{
struct drgn_error *err;
if (modules_dep->addr)
return NULL;
STRING_BUILDER(sb);
_cleanup_close_ int fd = -1;
for (size_t i = 0; options->kernel_directories[i]; i++) {
const char *kernel_dir = options->kernel_directories[i];
sb.len = 0;
if (kernel_dir[0]) {
if (!string_builder_append(&sb, kernel_dir))
return &drgn_enomem;
} else {
// Empty path. Try /lib/modules/$osrelease.
if (!string_builder_append(&sb, "/lib/modules/")
|| !string_builder_append(&sb,
prog->vmcoreinfo.osrelease))
return &drgn_enomem;
}
if (!string_builder_append(&sb, "/modules.dep.bin")
|| !string_builder_null_terminate(&sb))
return &drgn_enomem;
fd = open(sb.str, O_RDONLY);
if (fd >= 0)
break;
drgn_log_debug(prog, "%s: %m", sb.str);
}
if (fd < 0) {
drgn_log_debug(prog, "couldn't find depmod index");
fail:
// Set addr so that we don't try again.
modules_dep->addr = MAP_FAILED;
return NULL;
}
err = depmod_index_init(modules_dep, string_builder_steal(&sb), fd);
if (err) {
if (drgn_error_is_fatal(err))
return err;
drgn_error_log_warning(prog, err,
"couldn't open depmod index: ");
drgn_error_destroy(err);
goto fail;
}
drgn_log_debug(prog, "found depmod index %s", modules_dep->path);
return NULL;
}
static struct drgn_error *
drgn_module_try_depmod_in_debug_directories(struct drgn_module *module,
const struct drgn_debug_info_options *options,
struct string_builder *sb,
const char *depmod_path, size_t ko_len)
{
struct drgn_error *err;
for (size_t i = 0; options->directories[i]; i++) {
const char *debug_dir = options->directories[i];
sb->len = 0;
// Debian, Ubuntu:
// $debug_dir/lib/modules/$(uname -r)/$ko_name
if (!string_builder_append(sb, debug_dir)
|| !string_builder_append(sb, "/lib/modules/")
|| !string_builder_append(sb,
module->prog->vmcoreinfo.osrelease)
|| !string_builder_appendc(sb, '/')
|| !string_builder_appendn(sb, depmod_path, ko_len)
|| !string_builder_null_terminate(sb))
return &drgn_enomem;
err = drgn_module_try_standard_file(module, options, sb->str,
-1, true, NULL);
if (err || !drgn_module_wants_file(module))
return err;
// Fedora, CentOS, SUSE:
// $debug_dir/lib/modules/$(uname -r)/$ko_name.debug
if (!string_builder_append(sb, ".debug")
|| !string_builder_null_terminate(sb))
return &drgn_enomem;
err = drgn_module_try_standard_file(module, options, sb->str,
-1, true, NULL);
if (err || !drgn_module_wants_file(module))
return err;
}
return NULL;
}
static struct drgn_error *
drgn_module_try_linux_kmod_depmod(struct drgn_module *module,
const struct drgn_debug_info_options *options,
struct drgn_standard_debug_info_find_state *state)
{
struct drgn_error *err;
struct drgn_program *prog = module->prog;
const char *depmod_path;
size_t depmod_path_len;
err = depmod_index_find(&state->modules_dep, module->name, &depmod_path,
&depmod_path_len);
if (err) {
drgn_error_log_warning(prog, err,
"couldn't parse depmod index: ");
drgn_error_destroy(err);
return NULL;
}
if (!depmod_path) {
drgn_log_debug(prog, "couldn't find %s in depmod index",
module->name);
return NULL;
}
drgn_log_debug(prog, "found %.*s in depmod index",
depmod_path_len > INT_MAX
? INT_MAX : (int)depmod_path_len,
depmod_path);
// Get the length of the path with one extension after ".ko" removed if
// present (e.g., ".gz", ".xz", or ".zst").
const char *name = memrchr(depmod_path, '/', depmod_path_len);
if (name)
name = name + 1;
else
name = depmod_path;
const char *name_end = depmod_path + depmod_path_len;
size_t ko_len = depmod_path_len;
for (int j = 0; j < 2; j++) {
char *dot = memrchr(name, '.', name_end - name);
if (!dot)
break;
if (name_end - dot == 3
&& dot[1] == 'k' && dot[2] == 'o') {
ko_len = name_end - depmod_path;
break;
}
name_end = dot;
}
STRING_BUILDER(sb);
for (size_t i = 0; options->kernel_directories[i]; i++) {
const char *kernel_dir = options->kernel_directories[i];
if (kernel_dir[0]) {
sb.len = 0;
if (!string_builder_append(&sb, kernel_dir))
return &drgn_enomem;
} else {
// Empty path. Try under the debug directories first.
err = drgn_module_try_depmod_in_debug_directories(module,
options,
&sb,
depmod_path,
ko_len);
if (err || !drgn_module_wants_file(module))
return err;
// Try /lib/modules/$osrelease as the kernel directory.
sb.len = 0;
if (!string_builder_append(&sb, "/lib/modules/")
|| !string_builder_append(&sb,
prog->vmcoreinfo.osrelease))
return &drgn_enomem;
}
if (!string_builder_appendc(&sb, '/')
|| !string_builder_appendn(&sb, depmod_path, depmod_path_len)
|| !string_builder_null_terminate(&sb))
return &drgn_enomem;
err = drgn_module_try_standard_file(module, options, sb.str, -1,
true, NULL);
if (err || !drgn_module_wants_file(module))
return err;
}
return NULL;
}
static struct drgn_error *
drgn_kmod_walk_next_dir(struct drgn_program *prog,
const struct drgn_debug_info_options *options,
struct drgn_kmod_walk_state *state)
{
struct string_builder *path = &state->path;
for (;;) {
if (state->next_debug_dir) {
const char *debug_dir = *state->next_debug_dir++;
path->len = 0;
if (debug_dir) {
if (!string_builder_append(path, debug_dir))
return &drgn_enomem;
} else {
state->next_debug_dir = NULL;
}
if (!string_builder_append(path, "/lib/modules/")
|| !string_builder_append(path,
prog->vmcoreinfo.osrelease))
return &drgn_enomem;
} else {
const char *kernel_dir = *state->next_kernel_dir;
if (!kernel_dir)
return &drgn_stop;
state->next_kernel_dir++;
if (kernel_dir[0]) {
path->len = 0;
if (!string_builder_append(path, kernel_dir))
return &drgn_enomem;
} else {
state->next_debug_dir = options->directories;
continue;
}
}
if (!string_builder_null_terminate(path))
return &drgn_enomem;
struct drgn_kmod_walk_stack_entry entry = {
.dir = opendir(path->str),
.path_len = path->len,
};
if (!entry.dir) {
drgn_log_debug(prog, "opendir: %s: %m", path->str);
continue;
}
if (!drgn_kmod_walk_stack_append(&state->stack, &entry)) {
closedir(entry.dir);
return &drgn_enomem;
}
drgn_log_debug(prog, "searching for kernel modules in %s",
path->str);
return NULL;
}
}
static struct drgn_error *
drgn_kmod_walk(struct drgn_program *prog,
const struct drgn_debug_info_options *options,
struct drgn_kmod_walk_state *state,
struct drgn_kmod_walk_module_map_entry *current)
{
struct drgn_error *err;
struct string_builder *path = &state->path;
for (;;) {
if (drgn_kmod_walk_stack_empty(&state->stack)) {
err = drgn_kmod_walk_next_dir(prog, options, state);
if (err)
return err;
}
struct drgn_kmod_walk_stack_entry *top =
drgn_kmod_walk_stack_last(&state->stack);
errno = 0;
struct dirent *ent = readdir(top->dir);
if (!ent) {
if (errno) {
path->str[top->path_len] = '\0';
drgn_log_debug(prog, "%s: readdir: %m",
path->str);
}
closedir(top->dir);
drgn_kmod_walk_stack_pop(&state->stack);
continue;
}
// Skip "." and "..".
if (ent->d_name[0] == '.'
&& (!ent->d_name[1]
|| (ent->d_name[1] == '.' && !ent->d_name[2])))
continue;
bool is_directory = false;
if (ent->d_type == DT_LNK || ent->d_type == DT_UNKNOWN) {
struct stat st;
if (fstatat(dirfd(top->dir), ent->d_name, &st, 0) < 0) {
path->str[top->path_len] = '\0';
drgn_log_debug(prog, "%s/%s: fstatat: %m",
path->str, ent->d_name);
continue;
}
if (S_ISDIR(st.st_mode))
is_directory = true;
else if (!S_ISREG(st.st_mode))
continue;
} else if (ent->d_type == DT_DIR) {
is_directory = true;
} else if (ent->d_type != DT_REG) {
continue;
}
if (is_directory) {
path->len = top->path_len;
if (!string_builder_appendc(path, '/')
|| !string_builder_append(path, ent->d_name)
|| !string_builder_null_terminate(path))
return &drgn_enomem;
_cleanup_close_ int fd =
openat(dirfd(top->dir), ent->d_name,
O_RDONLY | O_DIRECTORY);
if (fd < 0) {
drgn_log_debug(prog, "openat: %s: %m",
path->str);
continue;
}
struct stat st;
if (fstat(fd, &st) < 0) {
drgn_log_debug(prog, "fstat: %s: %m",
path->str);
continue;
}
struct drgn_kmod_walk_inode inode = {
.dev = st.st_dev,
.ino = st.st_ino,
};
int r = drgn_kmod_walk_inode_set_insert(&state->visited_dirs,
&inode, NULL);
if (r < 0)
return &drgn_enomem;
if (r == 0) {
drgn_log_debug(prog,
"%s is cycle or duplicate; skipping",
path->str);
continue;
}
struct drgn_kmod_walk_stack_entry entry = {
.dir = fdopendir(fd),
.path_len = path->len,
};
if (!entry.dir) {
drgn_log_debug(prog, "fdopendir: %s: %m",
path->str);
continue;
}
fd = -1; // entry.dir owns fd now.
if (!drgn_kmod_walk_stack_append(&state->stack,
&entry)) {
closedir(entry.dir);
return &drgn_enomem;
}
} else {
// Match anything where the first extension is ".ko".
char *dot = strchr(ent->d_name, '.');
if (!dot || dot[1] != 'k' || dot[2] != 'o'
|| (dot[3] != '\0' && dot[3] != '.'))
continue;
// Borrow the path string builder to build the module
// name (removing extensions and replacing '-' with
// '_').
path->len = top->path_len;
if (!string_builder_appendn(path, ent->d_name,
dot - ent->d_name)
|| !string_builder_null_terminate(path))
return &drgn_enomem;
char *dash = &path->str[top->path_len];
while ((dash = strchr(dash, '-')))
*dash++ = '_';
// Find the module (if wanted).
const char *module_name = &path->str[top->path_len];
auto it = drgn_kmod_walk_module_map_search(&state->modules,
&module_name);
if (!it.entry)
continue;
size_t name_len = strlen(ent->d_name);
size_t path_len;
if (__builtin_add_overflow(top->path_len, name_len,
&path_len)
|| __builtin_add_overflow(path_len, 2, &path_len))
return &drgn_enomem;
_cleanup_free_ char *file_path = malloc(path_len);
if (!file_path)
return &drgn_enomem;
memcpy(file_path, path->str, top->path_len);
file_path[top->path_len] = '/';
memcpy(&file_path[top->path_len + 1], ent->d_name,
name_len + 1);
drgn_log_debug(prog, "found kernel module %s", file_path);
if (!char_p_vector_append(&it.entry->value, &file_path))
return &drgn_enomem;
file_path = NULL; // it.entry->value owns file_path now.
// If the file matches the current module, return it.
// Otherwise, keep going.
if (it.entry == current)
return NULL;
}
}
}
struct drgn_error *
drgn_module_try_linux_kmod_files(struct drgn_module *module,
const struct drgn_debug_info_options *options,
struct drgn_standard_debug_info_find_state *state)
{
struct drgn_error *err;
if (options->try_kmod == DRGN_KMOD_SEARCH_NONE)
return NULL;
if (options->try_kmod != DRGN_KMOD_SEARCH_WALK) {
err = drgn_open_modules_dep(module->prog, options,
&state->modules_dep);
if (err)
return err;
if (state->modules_dep.len > 0) {
err = drgn_module_try_linux_kmod_depmod(module, options,
state);
if (err
|| options->try_kmod != DRGN_KMOD_SEARCH_DEPMOD_AND_WALK
|| !drgn_module_wants_file(module))
return err;
}
if (options->try_kmod == DRGN_KMOD_SEARCH_DEPMOD)
return NULL;
}
if (drgn_kmod_walk_module_map_empty(&state->kmod_walk.modules)) {
for (size_t i = 0; i < state->num_modules; i++) {
if (!drgn_module_wants_file(state->modules[i]))
continue;
struct drgn_kmod_walk_module_map_entry entry = {
.key = state->modules[i]->name,
.value = VECTOR_INIT,
};
if (drgn_kmod_walk_module_map_insert(&state->kmod_walk.modules,
&entry, NULL) < 0)
return &drgn_enomem;
}
}
const char *module_name = module->name;
auto it = drgn_kmod_walk_module_map_search(&state->kmod_walk.modules,
&module_name);
size_t i = 0;
for (;;) {
if (i >= char_p_vector_size(&it.entry->value)) {
// No matches remaining for this module. Clear the old
// matches and find another one.
vector_for_each(char_p_vector, path, &it.entry->value)
free(*path);
char_p_vector_clear(&it.entry->value);
i = 0;
err = drgn_kmod_walk(module->prog, options,
&state->kmod_walk, it.entry);
if (err == &drgn_stop)
break;
else if (err)
return err;
}
char *path = *char_p_vector_at(&it.entry->value, i++);
err = drgn_module_try_standard_file(module, options, path, -1,
true, NULL);
if (err)
return err;
if (!drgn_module_wants_file(module))
break;
}
// We won't need any more matches for this module.
drgn_kmod_walk_module_map_entry_deinit(it.entry);
drgn_kmod_walk_module_map_delete_iterator(&state->kmod_walk.modules,
it);
return NULL;
}
// This has a weird calling convention so that the caller can call
// drgn_error_format_os() itself.
static const char *get_gnu_build_id_from_note_file(int fd,
void **bufp,
size_t *buf_capacityp,
const void **build_id_ret,
size_t *build_id_len_ret)
{
struct stat st;
if (fstat(fd, &st) < 0)
return "fstat";
if (st.st_size > SSIZE_MAX
|| !alloc_or_reuse(bufp, buf_capacityp, st.st_size))
return "";
ssize_t r = read_all(fd, *bufp, st.st_size);
if (r < 0)
return "read";
*build_id_len_ret = parse_gnu_build_id_from_notes(*bufp, r, 4, false,
build_id_ret);
return NULL;
}
static struct drgn_error *
get_build_id_from_sys_kernel_notes(void **buf_ret,
const void **build_id_ret,
size_t *build_id_len_ret)
{
static const char path[] = "/sys/kernel/notes";
_cleanup_close_ int fd = open(path, O_RDONLY);
if (fd == -1)
return drgn_error_create_os("open", errno, path);
_cleanup_free_ void *buf = NULL;
size_t buf_capacity = 0;
const char *message = get_gnu_build_id_from_note_file(fd, &buf,
&buf_capacity,
build_id_ret,
build_id_len_ret);
if (message && message[0])
return drgn_error_create_os(message, errno, path);
else if (message)
return &drgn_enomem;
*buf_ret = no_cleanup_ptr(buf);
return NULL;
}
// Arbitrary limit on the number iterations to make through the modules list in
// order to avoid getting stuck in a cycle.
static const int MAX_MODULE_LIST_ITERATIONS = 10000;
struct linux_kernel_loaded_module_iterator {
struct drgn_module_iterator it;
bool yielded_vmlinux;
int module_list_iterations_remaining;
// `struct module` type.
struct drgn_qualified_type module_type;
// `struct list_head *` in next module to yield.
struct drgn_object node;
// Address of `struct list_head modules`.
uint64_t modules_head;
};
static void
linux_kernel_loaded_module_iterator_destroy(struct drgn_module_iterator *_it)
{
struct linux_kernel_loaded_module_iterator *it =
container_of(_it, struct linux_kernel_loaded_module_iterator, it);
drgn_object_deinit(&it->node);
free(it);
}
static struct drgn_error *
yield_vmlinux(struct linux_kernel_loaded_module_iterator *it,
struct drgn_module **ret, bool *new_ret)
{
struct drgn_error *err;
struct drgn_program *prog = it->it.prog;
_cleanup_(drgn_module_deletep) struct drgn_module *module = NULL;
bool new;
err = drgn_module_find_or_create_main(prog, "kernel", &module, &new);
if (err)
return err;
if (!new) {
*ret = no_cleanup_ptr(module);
if (new_ret)
*new_ret = new;
return NULL;
}
if (prog->vmcoreinfo.build_id_len > 0) {
// Since Linux kernel commit 0935288c6e00 ("kdump: append kernel
// build-id string to VMCOREINFO") (in v5.9), we can get the
// build ID from VMCOREINFO.
err = drgn_module_set_build_id(module, prog->vmcoreinfo.build_id,
prog->vmcoreinfo.build_id_len);
if (err)
return err;
drgn_log_debug(prog,
"found kernel build ID %s in VMCOREINFO",
module->build_id_str);
} else if (prog->flags & DRGN_PROGRAM_IS_LIVE) {
// Before that, on the live kernel, we can get the build ID from
// /sys/kernel/notes.
_cleanup_free_ void *build_id_buf = NULL;
const void *build_id;
size_t build_id_len;
err = get_build_id_from_sys_kernel_notes(&build_id_buf,
&build_id,
&build_id_len);
if (err)
return err;
if (build_id_len > 0) {
err = drgn_module_set_build_id(module, build_id,
build_id_len);
if (err)
return err;
drgn_log_debug(prog,
"found kernel build ID %s in /sys/kernel/notes",
module->build_id_str);
} else {
drgn_log_debug(prog,
"couldn't find kernel build ID in /sys/kernel/notes");
}
} else {
// Otherwise, we can't get the build ID.
drgn_log_debug(prog, "couldn't find kernel build ID");
}
*ret = no_cleanup_ptr(module);
if (new_ret)
*new_ret = new;
return NULL;
}
enum kernel_module_address_ranges_version {
// Since Linux kernel commit ac3b43283923 ("module: replace
// module_layout with module_memory") (in v6.4), `struct module`
// contains an array, `struct module_memory mem[]`, of discontiguous
// allocations per memory type (`module->mem[type].base` and
// `module->mem[type].size`). The module address is
// `module->mem[MOD_TEXT].base`.
MODULE_MEMORY,
// Between that and Linux kernel commit 7523e4dc5057 ("module: use a
// structure to encapsulate layout.") (in v4.5), `struct module`
// contains a `struct module_layout core_layout` member with the base
// address (`module->core_layout.base`) and contiguous size
// (`module->core_layout.size`).
MODULE_LAYOUT,
// Before that, `struct module` contains the base address
// (`module->module_core`) and contiguous size (`module->core_size`)
// directly.
IN_MODULE,
};
static struct drgn_error *
kernel_module_address(const struct drgn_object *module_obj,
struct drgn_object *mem,
enum kernel_module_address_ranges_version *version_ret,
uint64_t *address_ret)
{
struct drgn_program *prog = drgn_object_program(module_obj);
struct drgn_error *err;
DRGN_OBJECT(tmp, prog);
err = drgn_object_member(mem, module_obj, "mem");
if (!err) {
*version_ret = MODULE_MEMORY;
if (!prog->mod_text_cached) {
err = drgn_program_find_object(prog, "MOD_TEXT", NULL,
DRGN_FIND_OBJECT_CONSTANT,
&tmp);
if (err)
return err;
union drgn_value mod_text_value;
err = drgn_object_read_integer(&tmp, &mod_text_value);
if (err)
return err;
prog->mod_text = mod_text_value.uvalue;
prog->mod_text_cached = true;
}
err = drgn_object_subscript(&tmp, mem, prog->mod_text);
if (err)
return err;
err = drgn_object_member(&tmp, &tmp, "base");
} else if (drgn_error_catch(&err, DRGN_ERROR_LOOKUP)) {
err = drgn_object_member(mem, module_obj, "core_layout");
if (!err) {
*version_ret = MODULE_LAYOUT;
err = drgn_object_member(&tmp, mem, "base");
} else if (drgn_error_catch(&err, DRGN_ERROR_LOOKUP)) {
*version_ret = IN_MODULE;
err = drgn_object_member(&tmp, module_obj,
"module_core");
}
}
if (err)
return err;
return drgn_object_read_unsigned(&tmp, address_ret);
}
// If version is MODULE_MEMORY, mem is struct module::mem. If version is
// MODULE_LAYOUT, mem is struct module::core_layout.
static struct drgn_error *
kernel_module_set_address_ranges(struct drgn_module *module,
enum kernel_module_address_ranges_version version,
const struct drgn_object *module_obj,
const struct drgn_object *mem,
uint64_t address)
{
struct drgn_program *prog = module->prog;
struct drgn_error *err;
DRGN_OBJECT(tmp, prog);
if (version != MODULE_MEMORY) {
if (version == IN_MODULE)
err = drgn_object_member(&tmp, module_obj, "core_size");
else
err = drgn_object_member(&tmp, mem, "size");
if (err)
return err;
uint64_t size;
err = drgn_object_read_unsigned(&tmp, &size);
if (err)
return err;
drgn_log_debug(prog, "module size is %" PRIu64, size);
return drgn_module_set_address_range(module, address,
address + size);
}
struct drgn_type *mem_array_type = drgn_underlying_type(mem->type);
if (drgn_type_kind(mem_array_type) != DRGN_TYPE_ARRAY) {
return drgn_error_create(DRGN_ERROR_TYPE,
"struct module::mem is not an array");
}
uint64_t length = drgn_type_length(mem_array_type);
if (length > SIZE_MAX)
return &drgn_enomem;
_cleanup_free_ uint64_t (*ranges)[2] =
malloc_array(length, sizeof(*ranges));
if (!ranges)
return &drgn_enomem;
DRGN_OBJECT(element, prog);
size_t num_ranges = 0;
for (size_t i = 0; i < length; i++) {
err = drgn_object_subscript(&element, mem, i);
if (err)
return err;
err = drgn_object_member(&tmp, &element, "size");
if (err)
return err;
uint64_t size;
err = drgn_object_read_unsigned(&tmp, &size);
if (err)
return err;
if (!size)
continue;
err = drgn_object_member(&tmp, &element, "base");
if (err)
return err;
uint64_t base;
err = drgn_object_read_unsigned(&tmp, &base);
if (err)
return err;
drgn_log_debug(prog, "module has address range %" PRIu64 "-%" PRIu64,
base, base + size);
ranges[num_ranges][0] = base;
ranges[num_ranges][1] = base + size;
num_ranges++;
}
return drgn_module_set_address_ranges(module, ranges, num_ranges);
}
static struct drgn_error *
kernel_module_set_build_id_live(struct drgn_module *module)
{
struct drgn_error *err;
struct drgn_program *prog = module->prog;
_cleanup_free_ char *path;
if (asprintf(&path, "/sys/module/%s/notes", module->name) < 0) {
path = NULL;
return &drgn_enomem;
}
_cleanup_closedir_ DIR *dir = opendir(path);
if (!dir) {
if (errno == ENOENT) {
drgn_log_debug(prog, "opendir: %s: %m", path);
return NULL;
} else {
return drgn_error_create_os("opendir", errno, path);
}
}
_cleanup_free_ void *buf = NULL;
size_t capacity = 0;
struct dirent *ent;
while ((errno = 0, ent = readdir(dir))) {
if (ent->d_type == DT_DIR)
continue;
_cleanup_close_ int fd = openat(dirfd(dir), ent->d_name,
O_RDONLY);
if (fd < 0) {
return drgn_error_format_os("openat", errno, "%s/%s",
path, ent->d_name);
}
const void *build_id;
size_t build_id_len;
const char *message =
get_gnu_build_id_from_note_file(fd, &buf, &capacity,
&build_id,
&build_id_len);
if (message && message[0]) {
return drgn_error_format_os(message, errno, "%s/%s",
path, ent->d_name);
} else if (message) {
return &drgn_enomem;
}
if (build_id_len > 0) {
err = drgn_module_set_build_id(module, build_id,
build_id_len);
if (!err) {
drgn_log_debug(prog,
"found build ID %s in %s/%s",
module->build_id_str, path,
ent->d_name);
}
return err;
}
}
if (errno)
return drgn_error_create_os("readdir", errno, path);
drgn_log_debug(prog, "couldn't find build ID in %s", path);
return NULL;
}
static struct drgn_error *
kernel_module_set_build_id(struct drgn_module *module,
const struct drgn_object *module_obj,
bool use_sys_module)
{
if (use_sys_module)
return kernel_module_set_build_id_live(module);
struct drgn_error *err;
struct drgn_program *prog = module->prog;
const bool bswap = drgn_platform_bswap(&prog->platform);
DRGN_OBJECT(attrs, prog);
DRGN_OBJECT(attr, prog);
DRGN_OBJECT(tmp, prog);
_cleanup_free_ void *buf = NULL;
size_t capacity = 0;
err = drgn_object_member(&attrs, module_obj, "notes_attrs");
if (err)
return err;
bool group = true;
uint64_t n;
err = drgn_object_member_dereference(&attrs, &attrs, "grp");
if (!err) {
// Since Linux kernel commit 4723f16de64e ("module: sysfs: Add
// notes attributes through attribute_group") (in v6.14), we
// have to iterate over struct attribute_group::bin_attrs, a
// null-terminated array of struct bin_attribute pointers.
// attr = mod->notes_attrs->grp.bin_attrs
err = drgn_object_member(&attrs, &attrs, "bin_attrs");
if (err)
return err;
} else if (drgn_error_catch(&err, DRGN_ERROR_LOOKUP)) {
// Before that, there was no struct attribute_group for notes,
// so we iterate over struct module_notes_attrs::attrs, an array
// of struct bin_attribute with a length given by struct
// module_notes_attrs::notes.
group = false;
// n = mod->notes_attrs->notes
err = drgn_object_member_dereference(&tmp, &attrs, "notes");
if (err)
return err;
err = drgn_object_read_unsigned(&tmp, &n);
if (err)
return err;
// attrs = mod->notes_attrs->attrs
err = drgn_object_member_dereference(&attrs, &attrs, "attrs");
if (err)
return err;
} else {
return err;
}
// If we're not using struct attribute_group, we know how many
// attributes there are.
for (uint64_t i = 0; group || i < n; i++) {
// attr = attrs[i]
err = drgn_object_subscript(&attr, &attrs, i);
if (err)
return err;
if (group) {
// If we're using struct attribute_group, we stop when
// we hit a NULL pointer.
err = drgn_object_read(&attr, &attr);
if (err)
return err;
bool truthy;
err = drgn_object_bool(&attr, &truthy);
if (err)
return err;
if (!truthy)
break;
} else {
// attr = &attrs[i]
err = drgn_object_address_of(&attr, &attr);
if (err)
return err;
}
// address = attr->private
err = drgn_object_member_dereference(&tmp, &attr, "private");
if (err)
return err;
uint64_t address;
err = drgn_object_read_unsigned(&tmp, &address);
if (err)
return err;
// size = attr->size
err = drgn_object_member_dereference(&tmp, &attr, "size");
if (err)
return err;
uint64_t size;
err = drgn_object_read_unsigned(&tmp, &size);
if (err)
return err;
if (size > SIZE_MAX || !alloc_or_reuse(&buf, &capacity, size))
return &drgn_enomem;
err = drgn_program_read_memory(prog, buf, address, size, false);
if (err)
return err;
const void *build_id;
size_t build_id_len =
parse_gnu_build_id_from_notes(buf, size, 4, bswap,
&build_id);
if (build_id_len > 0) {
err = drgn_module_set_build_id(module, build_id,
build_id_len);
if (!err) {
drgn_log_debug(prog,
"found build ID %s in notes_attrs",
module->build_id_str);
}
return err;
}
}
drgn_log_debug(prog,
"couldn't find build ID in notes_attrs");
return NULL;
}
static struct drgn_error *
kernel_module_set_section_addresses_live(struct drgn_module *module)
{
struct drgn_error *err;
struct drgn_program *prog = module->prog;
bool logged = false;
_cleanup_free_ char *path;
if (asprintf(&path, "/sys/module/%s/sections", module->name) < 0) {
path = NULL;
return &drgn_enomem;
}
_cleanup_closedir_ DIR *dir = opendir(path);
if (!dir)
return drgn_error_create_os("opendir", errno, path);
struct dirent *ent;
while ((errno = 0, ent = readdir(dir))) {
if (ent->d_type == DT_DIR)
continue;
_cleanup_close_ int fd = openat(dirfd(dir), ent->d_name,
O_RDONLY);
if (fd < 0) {
return drgn_error_format_os("openat", errno, "%s/%s",
path, ent->d_name);
}
_cleanup_fclose_ FILE *file = fdopen(fd, "r");
if (!file)
return drgn_error_create_os("fdopen", errno, NULL);
uint64_t address;
if (fscanf(file, "%" SCNx64, &address) != 1) {
return drgn_error_format(DRGN_ERROR_OTHER,
"could not parse %s/%s",
path, ent->d_name);
}
if (!logged) {
drgn_log_debug(prog,
"getting section addresses from %s",
path);
logged = true;
}
err = drgn_module_set_section_address(module, ent->d_name,
address);
if (err)
return err;
}
if (errno)
return drgn_error_create_os("readdir", errno, path);
return NULL;
}
static struct drgn_error *
kernel_module_set_section_addresses(struct drgn_module *module,
const struct drgn_object *module_obj,
bool use_sys_module)
{
struct drgn_error *err;
struct drgn_program *prog = module->prog;
DRGN_OBJECT(tmp, prog);
// As of Linux 6.0, the .data..percpu section is not included in the
// section attributes. (kernel/module/sysfs.c:add_sect_attrs() only
// creates attributes for sections with the SHF_ALLOC flag set, but
// kernel/module/main.c:layout_and_allocate() clears the SHF_ALLOC flag
// for the .data..percpu section.) However, we need this address so that
// global per-CPU variables will be relocated correctly. Get it from
// `struct module`.
err = drgn_object_member(&tmp, module_obj, "percpu");
if (!err) {
uint64_t address;
err = drgn_object_read_unsigned(&tmp, &address);
if (err)
return err;
drgn_log_debug(prog, "module percpu is 0x%" PRIx64, address);
// struct module::percpu is NULL if the module doesn't have any
// per-CPU data.
if (address) {
err = drgn_module_set_section_address(module,
".data..percpu",
address);
if (err)
return err;
}
} else if (err->code == DRGN_ERROR_LOOKUP) {
// struct module::percpu doesn't exist if !SMP.
drgn_error_destroy(err);
} else {
return err;
}
if (use_sys_module) {
err = kernel_module_set_section_addresses_live(module);
// We could be debugging /proc/kcore without root privileges via
// an fd that we were passed. If we didn't have permission to
// access the files in /sys/module/$module/sections, fall back
// to the non-live path.
if (!err || err->code != DRGN_ERROR_OS || err->errnum != EACCES)
return err;
drgn_error_log_debug(prog, err,
"falling back to section addresses from sect_attrs: ");
drgn_error_destroy(err);
} else {
drgn_log_debug(prog,
"getting section addresses from sect_attrs");
}
DRGN_OBJECT(attrs, prog);
DRGN_OBJECT(attr, prog);
err = drgn_object_member(&attrs, module_obj, "sect_attrs");
if (err)
return err;
bool group = true;
uint64_t nsections;
err = drgn_object_member_dereference(&tmp, &attrs, "nsections");
if (drgn_error_catch(&err, DRGN_ERROR_LOOKUP)) {
// Since Linux kernel commit d8959b947a8d ("module: sysfs: Drop
// member 'module_sect_attrs::nsections'") (in v6.14), we have
// to iterate over struct attribute_group::bin_attrs, a
// null-terminated array of struct bin_attribute pointers.
// attrs = mod->sect_attrs->grp.bin_attrs
err = drgn_object_member_dereference(&attrs, &attrs, "grp");
if (err)
return err;
err = drgn_object_member(&attrs, &attrs, "bin_attrs");
if (err)
return err;
} else if (!err) {
// Before that, struct module_sect_attrs::grp still exists.
// However, since Linux kernel commit ed66f991bb19 ("module:
// Refactor section attr into bin attribute") (in v5.8), the
// sections are in struct attribute_group::bin_attrs, and before
// that, they're in struct attribute_group::attrs. Additionally,
// we'd then have to get the containing struct module_sect_attr
// to get the section address.
//
// Instead, it's easier to iterate over struct
// module_sect_attrs::attrs, an array of struct module_sect_attr
// with a length given by struct module_sect_attrs::nsections.
group = false;
// nsections = mod->sect_attrs->nsections
err = drgn_object_read_unsigned(&tmp, &nsections);
if (err)
return err;
// attrs = mod->sect_attrs->attrs
err = drgn_object_member_dereference(&attrs, &attrs, "attrs");
if (err)
return err;
} else {
return err;
}
// If we're not using struct attribute_group, we know how many
// attributes there are.
for (uint64_t i = 0; group || i < nsections; i++) {
// attr = attrs[i]
err = drgn_object_subscript(&attr, &attrs, i);
if (err)
return err;
if (group) {
// If we're using struct attribute_group, we stop when
// we hit a NULL pointer.
err = drgn_object_read(&attr, &attr);
if (err)
return err;
bool truthy;
err = drgn_object_bool(&attr, &truthy);
if (err)
return err;
if (!truthy)
break;
// Since Linux kernel commit 4b2c11e4aaf7 ("module:
// sysfs: Drop member 'module_sect_attr::address'") (in
// v6.14), the section address is in struct
// bin_attribute::private.
err = drgn_object_member_dereference(&tmp, &attr,
"private");
} else {
// Before that, the section address is in struct
// module_sect_attr::address.
err = drgn_object_member(&tmp, &attr, "address");
if (err)
return err;
}
uint64_t address;
err = drgn_object_read_unsigned(&tmp, &address);
if (err)
return err;
if (group) {
// attr = attr->attr
err = drgn_object_member_dereference(&attr, &attr,
"attr");
if (err)
return err;
} else {
// Since Linux kernel commit ed66f991bb19 ("module:
// Refactor section attr into bin attribute") (in v5.8),
// the section name is module_sect_attr.battr.attr.name.
// Before that, it is simply module_sect_attr.name.
// attr = attr.battr.attr
err = drgn_object_member(&attr, &attr, "battr");
if (!err) {
err = drgn_object_member(&attr, &attr, "attr");
if (err)
return err;
} else if (!drgn_error_catch(&err, DRGN_ERROR_LOOKUP)) {
return err;
}
}
err = drgn_object_member(&tmp, &attr, "name");
if (err)
return err;
_cleanup_free_ char *name = NULL;
err = drgn_object_read_c_string(&tmp, &name);
if (err)
return err;
err = drgn_module_set_section_address(module, name, address);
if (err)
return err;
}
return NULL;
}
static struct drgn_error *
kernel_module_find_or_create_internal(const struct drgn_object *module_ptr,
const struct drgn_object *module_obj,
struct drgn_module **ret, bool *new_ret,
bool create, bool log)
{
struct drgn_error *err;
struct drgn_program *prog = drgn_object_program(module_obj);
uint64_t name_offset;
err = drgn_type_offsetof(module_obj->type, "name", &name_offset);
if (err)
return err;
if (name_offset >= drgn_object_size(module_obj)
|| !memchr(drgn_object_buffer(module_obj) + name_offset, '\0',
drgn_object_size(module_obj) - name_offset)) {
return drgn_error_create(DRGN_ERROR_OTHER,
"couldn't read module name");
}
const char *name = drgn_object_buffer(module_obj) + name_offset;
DRGN_OBJECT(mem, prog);
enum kernel_module_address_ranges_version version;
uint64_t address;
err = kernel_module_address(module_obj, &mem, &version, &address);
if (err)
return err;
if (log) {
drgn_log_debug(prog, "found loaded kernel module %s@0x%" PRIx64,
name, address);
}
if (!create) {
*ret = drgn_module_find_relocatable(prog, name, address);
if (new_ret)
*new_ret = false;
return NULL;
}
_cleanup_(drgn_module_deletep) struct drgn_module *module = NULL;
bool new;
err = drgn_module_find_or_create_relocatable(prog, name, address,
&module, &new);
if (err)
return err;
if (!new) {
*ret = no_cleanup_ptr(module);
if (new_ret)
*new_ret = new;
return NULL;
}
err = drgn_module_set_object(module, module_ptr);
if (err)
return err;
err = kernel_module_set_address_ranges(module, version, module_obj,
&mem, address);
if (err)
return err;
// If we're debugging the running kernel, we can use
// /sys/module/$module/notes and /sys/module/$module/sections instead of
// getting the equivalent information from the core dump. This fast path
// can be disabled via an environment variable for testing. It may also
// be disabled if we encounter permission issues using
// /sys/module/$module/sections.
bool use_sys_module = false;
if (prog->flags & DRGN_PROGRAM_IS_LOCAL) {
char *env = getenv("DRGN_USE_SYS_MODULE");
use_sys_module = !env || atoi(env);
}
err = kernel_module_set_build_id(module, module_obj, use_sys_module);
if (err)
return err;
err = kernel_module_set_section_addresses(module, module_obj,
use_sys_module);
if (err)
return err;
*ret = no_cleanup_ptr(module);
if (new_ret)
*new_ret = new;
return NULL;
}
static struct drgn_error *
drgn_module_find_or_create_linux_kernel_loadable_internal(const struct drgn_object *module_ptr,
struct drgn_module **ret,
bool *new_ret,
bool create)
{
struct drgn_error *err;
struct drgn_program *prog = drgn_object_program(module_ptr);
if (drgn_type_kind(drgn_underlying_type(module_ptr->type))
!= DRGN_TYPE_POINTER)
return drgn_error_create(DRGN_ERROR_TYPE,
"struct module * is required");
DRGN_OBJECT(module_obj, prog);
err = drgn_object_dereference(&module_obj, module_ptr);
if (err)
return err;
err = drgn_object_read(&module_obj, &module_obj);
if (err)
return err;
return kernel_module_find_or_create_internal(module_ptr, &module_obj, ret, new_ret,
create, false);
}
LIBDRGN_PUBLIC struct drgn_error *
drgn_module_find_linux_kernel_loadable(const struct drgn_object *module_ptr,
struct drgn_module **ret)
{
return drgn_module_find_or_create_linux_kernel_loadable_internal(module_ptr, ret,
NULL, false);
}
LIBDRGN_PUBLIC struct drgn_error *
drgn_module_find_or_create_linux_kernel_loadable(const struct drgn_object *module_ptr,
struct drgn_module **ret,
bool *new_ret)
{
return drgn_module_find_or_create_linux_kernel_loadable_internal(module_ptr, ret,
new_ret, true);
}
static struct drgn_error *
yield_kernel_module(struct linux_kernel_loaded_module_iterator *it,
struct drgn_module **ret, bool *new_ret)
{
struct drgn_error *err;
struct drgn_program *prog = it->it.prog;
DRGN_OBJECT(mod, prog);
DRGN_OBJECT(mod_ptr, prog);
for (;;) {
uint64_t addr;
err = drgn_object_read_unsigned(&it->node, &addr);
if (err) {
list_walk_err:
if (!drgn_error_is_fatal(err)) {
drgn_error_log_warning(prog, err,
"can't find remaining kernel modules: "
"couldn't read next module: ");
drgn_error_destroy(err);
*ret = NULL;
err = NULL;
}
return err;
}
if (addr == it->modules_head) {
drgn_log_debug(prog,
"found end of loaded kernel module list");
*ret = NULL;
return NULL;
}
if (it->module_list_iterations_remaining == 0) {
drgn_log_warning(prog,
"can't find remaining kernel modules: "
"too many entries or cycle in modules list");
*ret = NULL;
return NULL;
}
it->module_list_iterations_remaining--;
err = drgn_object_container_of(&mod_ptr, &it->node, it->module_type,
"list");
if (err)
goto list_walk_err;
err = drgn_object_dereference(&mod, &mod_ptr);
if (err)
goto list_walk_err;
// We need several fields from the `struct module`. Especially
// for /proc/kcore, it is faster to read the entire structure
// (which is <2kB as of Linux 6.5) from the core dump all at
// once than it is to read each field individually.
err = drgn_object_read(&mod, &mod);
if (err)
goto list_walk_err;
err = drgn_object_member(&it->node, &mod, "list");
if (err)
goto list_walk_err;
err = drgn_object_member(&it->node, &it->node, "next");
if (err)
goto list_walk_err;
err = kernel_module_find_or_create_internal(&mod_ptr, &mod, ret,
new_ret, true, true);
if (err && !drgn_error_is_fatal(err)) {
drgn_error_log_warning(prog, err, "ignoring module: ");
drgn_error_destroy(err);
continue;
}
return err;
}
}
static struct drgn_error *
linux_kernel_loaded_module_iterator_next(struct drgn_module_iterator *_it,
struct drgn_module **ret,
bool *new_ret)
{
struct drgn_error *err;
struct linux_kernel_loaded_module_iterator *it =
container_of(_it, struct linux_kernel_loaded_module_iterator, it);
struct drgn_program *prog = it->it.prog;
if (!it->yielded_vmlinux) {
it->yielded_vmlinux = true;
return yield_vmlinux(it, ret, new_ret);
}
// Start the module list walk if we haven't yet.
if (!it->module_type.type) {
for (int attempt = 1; attempt <= 2; attempt++) {
err = drgn_program_find_type(prog, "struct module",
NULL, &it->module_type);
if (!err) {
err = drgn_program_find_object(prog, "modules",
NULL,
DRGN_FIND_OBJECT_VARIABLE,
&it->node);
}
if (err && err->code == DRGN_ERROR_LOOKUP) {
drgn_error_destroy(err);
if (attempt == 1 && prog->dbinfo.main_module) {
struct drgn_module *module =
prog->dbinfo.main_module;
if (module->debug_file_status
== DRGN_MODULE_FILE_DONT_WANT) {
module->debug_file_status =
DRGN_MODULE_FILE_WANT;
}
if (drgn_module_wants_debug_file(module)) {
err = drgn_load_module_debug_info(&module,
&(size_t){1});
if (err)
return err;
continue;
}
}
if (!prog->dbinfo.main_module
|| drgn_module_wants_debug_file(prog->dbinfo.main_module)) {
drgn_log(it->it.for_load_debug_info
? DRGN_LOG_DEBUG
: DRGN_LOG_WARNING,
prog,
"can't find loaded modules without kernel debug info");
} else {
drgn_log_debug(prog,
"kernel does not have loadable module support");
}
*ret = NULL;
return NULL;
} else if (err) {
return err;
}
}
if (it->node.kind != DRGN_OBJECT_REFERENCE) {
drgn_log_warning(prog,
"can't find kernel modules: "
"can't get address of modules list");
*ret = NULL;
return NULL;
}
it->modules_head = it->node.address;
err = drgn_object_member(&it->node, &it->node, "next");
if (!err)
err = drgn_object_read(&it->node, &it->node);
if (err) {
if (drgn_error_is_fatal(err))
return err;
drgn_error_log_warning(prog, err,
"can't find kernel modules: "
"couldn't read modules list: ");
drgn_error_destroy(err);
*ret = NULL;
return NULL;
}
}
return yield_kernel_module(it, ret, new_ret);
}
struct drgn_error *
linux_kernel_loaded_module_iterator_create(struct drgn_program *prog,
struct drgn_module_iterator **ret)
{
struct linux_kernel_loaded_module_iterator *it = calloc(1, sizeof(*it));
if (!it)
return &drgn_enomem;
drgn_module_iterator_init(&it->it, prog,
linux_kernel_loaded_module_iterator_destroy,
linux_kernel_loaded_module_iterator_next);
it->module_list_iterations_remaining = MAX_MODULE_LIST_ITERATIONS;
drgn_object_init(&it->node, prog);
*ret = &it->it;
return NULL;
}
static struct drgn_error *
linux_cpu_present_mask(struct drgn_program *prog, uint64_t **bitmap_ret,
size_t *size_ret)
{
// This C implementation is not exposed as a drgn helper because it doesn't
// really provide any benefit over the Python implementation. We would need
// to wrap this in another Python function in order to provide the existing
// "default program" behavior that cpu_present_mask() already provides.
// Rather than add the extra boilerplate and complexity, have this copy for
// internal use.
struct drgn_error *err;
DRGN_OBJECT(tmp, prog);
err = drgn_program_find_object(prog, "__cpu_present_mask", NULL,
DRGN_FIND_OBJECT_VARIABLE, &tmp);
if (drgn_error_catch(&err, DRGN_ERROR_LOOKUP)) {
err = drgn_program_find_object(prog, "cpu_present_mask", NULL,
DRGN_FIND_OBJECT_VARIABLE, &tmp);
if (err)
return err;
err = drgn_object_dereference(&tmp, &tmp);
}
if (err)
return err;
err = drgn_object_member(&tmp, &tmp, "bits");
if (err)
return err;
uint64_t bitmap_addr = tmp.address;
DRGN_OBJECT(nr_cpu_ids_obj, prog);
uint64_t nr_cpu_ids;
err = drgn_program_find_object(prog, "nr_cpu_ids", NULL,
DRGN_FIND_OBJECT_VARIABLE, &nr_cpu_ids_obj);
if (err) {
if (drgn_error_catch(&err, DRGN_ERROR_LOOKUP))
nr_cpu_ids = 1;
else
return err;
} else {
err = drgn_object_read_unsigned(&nr_cpu_ids_obj, &nr_cpu_ids);
if (err)
return err;
}
// A bogus value could overflow a 32-bit size_t, validate it here
if (nr_cpu_ids > SIZE_MAX)
return &drgn_enomem;
bool is_64_bit;
err = drgn_program_is_64_bit(prog, &is_64_bit);
if (err)
return err;
bool bswap;
err = drgn_program_bswap(prog, &bswap);
if (err)
return err;
size_t size = nr_cpu_ids / 64 + ((nr_cpu_ids % 64) ? 1 : 0);
_cleanup_free_ uint64_t *bitmap = calloc(size, sizeof(*bitmap));
if (!bitmap)
return &drgn_enomem;
if (is_64_bit) {
err = drgn_program_read_memory(prog, bitmap, bitmap_addr, size * 8, false);
if (err)
return err;
if (bswap)
for (size_t i = 0; i < size; i++)
bitmap[i] = bswap_64(bitmap[i]);
} else {
size_t nr_words = nr_cpu_ids / 32 + ((nr_cpu_ids % 32) ? 1 : 0);
_cleanup_free_ uint32_t *orig = malloc_array(nr_words, sizeof(*orig));
if (!bitmap)
return &drgn_enomem;
err = drgn_program_read_memory(prog, orig, bitmap_addr, nr_words * 4, false);
if (err)
return err;
for (size_t i = 0; i < nr_words; i++) {
uint32_t value = bswap ? bswap_32(orig[i]) : orig[i];
if (i & 1)
bitmap[i >> 1] |= (uint64_t) value << 32;
else
bitmap[i >> 1] |= value;
}
}
*bitmap_ret = no_cleanup_ptr(bitmap);
*size_ret = nr_cpu_ids;
return NULL;
}
DEFINE_VECTOR(uint64_vector, uint64_t);
struct drgn_error *
drgn_program_is_irq_regs(struct drgn_program *prog, uint64_t addr,
bool *ret)
{
if (!(prog->flags & DRGN_PROGRAM_IS_LINUX_KERNEL) ||
(prog->flags & DRGN_PROGRAM_IS_LIVE)) {
*ret = false;
return NULL;
}
if (!prog->irq_regs_cached) {
struct drgn_error *err;
DRGN_OBJECT(irq_regs_obj, prog);
err = drgn_program_find_object(prog, "__irq_regs", NULL,
DRGN_FIND_OBJECT_VARIABLE, &irq_regs_obj);
if (err)
return err;
err = drgn_object_address_of(&irq_regs_obj, &irq_regs_obj);
if (err)
return err;
_cleanup_free_ uint64_t *cpumask = NULL;
size_t nr_cpus;
err = linux_cpu_present_mask(prog, &cpumask, &nr_cpus);
if (err)
return err;
DRGN_OBJECT(percpu_regs, prog);
VECTOR(uint64_vector, addresses);
uint64_t regs_ptr;
for (size_t word_index = 0; word_index * 64 < nr_cpus; word_index++) {
uint64_t word = cpumask[word_index];
unsigned int i;
for_each_bit(i, word) {
size_t cpu = word_index * 64 + i;
err = linux_helper_per_cpu_ptr(&percpu_regs, &irq_regs_obj, cpu);
if (err)
return err;
err = drgn_object_dereference(&percpu_regs, &percpu_regs);
if (err)
return err;
err = drgn_object_read_unsigned(&percpu_regs, ®s_ptr);
if (err)
return err;
if (!regs_ptr)
continue;
drgn_log_debug(prog, "irq_regs: cpu %zu: %"PRIx64, cpu, regs_ptr);
if (!uint64_vector_append(&addresses, ®s_ptr))
return &drgn_enomem;
}
}
drgn_log_debug(prog, "irq_regs: loaded %zu per-cpu __irq_regs",
uint64_vector_size(&addresses));
// A signal value so we don't need to store length in the
// program. The array won't need random access, so this is a
// reasonable tradeoff.
regs_ptr = 0;
if (!uint64_vector_append(&addresses, ®s_ptr))
return &drgn_enomem;
uint64_vector_shrink_to_fit(&addresses);
uint64_vector_steal(&addresses, &prog->irq_regs_cached, NULL);
}
for (size_t i = 0; prog->irq_regs_cached[i]; i++) {
if (prog->irq_regs_cached[i] == addr) {
*ret = true;
return NULL;
}
}
*ret = false;
return NULL;
}
|