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
|
// Copyright (c) Meta Platforms, Inc. and affiliates.
// SPDX-License-Identifier: LGPL-2.1-or-later
#include <assert.h>
#include <byteswap.h>
#include <elf.h>
#include <elfutils/libdw.h>
#include <elfutils/version.h>
#include <gelf.h>
#include <inttypes.h>
#include <limits.h>
#include <stdlib.h>
#include <string.h>
#include "array.h"
#include "binary_buffer.h"
#include "binary_search.h"
#include "cleanup.h"
#include "debug_info.h" // IWYU pragma: associated
#include "dwarf_constants.h"
#include "elf_file.h"
#include "error.h"
#include "language.h"
#include "lazy_object.h"
#include "log.h"
#include "minmax.h"
#include "object.h"
#include "openmp.h"
#include "path.h"
#include "program.h"
#include "platform.h"
#include "register_state.h"
#include "serialize.h"
#include "type.h"
#include "util.h"
#if !_ELFUTILS_PREREQ(0, 191)
static inline int dwarf_cu_dwp_section_info(Dwarf_CU *cu, unsigned int section,
Dwarf_Off *offsetp,
Dwarf_Off *sizep)
{
*offsetp = 0;
if (sizep)
*sizep = 0;
return 0;
}
#endif
void drgn_module_dwarf_info_deinit(struct drgn_module *module)
{
free(module->dwarf.eh_frame.fdes);
free(module->dwarf.eh_frame.cies);
free(module->dwarf.debug_frame.fdes);
free(module->dwarf.debug_frame.cies);
}
DEFINE_VECTOR_FUNCTIONS(drgn_dwarf_index_die_vector);
DEFINE_HASH_MAP_FUNCTIONS(drgn_dwarf_index_die_map, nstring_hash_pair,
nstring_eq);
static inline struct nstring
drgn_namespace_key(struct drgn_namespace_dwarf_index * const *entry)
{
return (struct nstring){ (*entry)->name, (*entry)->name_len };
}
DEFINE_HASH_TABLE_FUNCTIONS(drgn_namespace_table, drgn_namespace_key,
nstring_hash_pair, nstring_eq);
DEFINE_HASH_MAP_FUNCTIONS(drgn_dwarf_base_type_map, nstring_hash_pair,
nstring_eq);
DEFINE_HASH_MAP_FUNCTIONS(drgn_dwarf_specification_map, int_key_hash_pair,
scalar_key_eq);
/** DWARF compilation unit indexed in a @ref drgn_namespace_dwarf_index. */
struct drgn_dwarf_index_cu {
/** File containing CU. */
struct drgn_elf_file *file;
/** Address of CU data. */
const char *buf;
/** Length of CU data. */
size_t len;
/** DWARF version from CU header. */
uint8_t version;
/** `DW_UT_*` type from CU header. */
uint8_t unit_type;
/** Address size from CU header. */
uint8_t address_size;
/** Whether CU uses 64-bit DWARF format. */
bool is_64_bit;
/**
* Section containing CU (@ref DRGN_SCN_DEBUG_INFO or @ref
* DRGN_SCN_DEBUG_TYPES).
*/
enum drgn_section_index scn;
/**
* Mapping from DWARF abbreviation code to instructions for that
* abbreviation.
*
* This is indexed on the DWARF abbreviation code minus one. I.e.,
* `abbrev_insns[abbrev_decls[abbrev_code - 1]]` is the first
* instruction for that abbreviation code.
*
* Technically, abbreviation codes don't have to be sequential. In
* practice, GCC and Clang seem to always generate sequential codes
* starting at one, so we can get away with a flat array.
*/
uint32_t *abbrev_decls;
union {
/** Number of abbreviation codes. */
size_t num_abbrev_decls;
/**
* Pointer in .debug_abbrev for this CU.
*
* This is only used before indexing, then it is replaced by @c
* abbrev_decls, @c num_abbrev_decls, and @c abbrev_insns. It is
* a union with @c num_abbrev_decls rather than one of the other
* two fields because that way we don't need to worry about
* accidentally freeing it.
*/
const char *pending_abbrev;
};
/**
* Buffer of @ref drgn_dwarf_index_abbrev_insn instructions for all
* abbreviation codes.
*
* These are all stored in one array for cache locality.
*/
uint8_t *abbrev_insns;
/**
* Pointer in `.debug_str_offsets` section to string offset entries for
* this CU.
*/
const char *str_offsets;
/** libdw structure for this CU. */
Dwarf_CU *libdw_cu;
};
/** Indexed CU lookup table entry. */
struct drgn_dwarf_index_cu_lookup {
/** Address of CU data (@ref drgn_dwarf_index_cu::buf). */
uintptr_t buf;
/** Index of CU in @ref drgn_dwarf_info::index_cus. */
size_t index;
};
DEFINE_VECTOR_FUNCTIONS(drgn_dwarf_index_cu_vector);
DEFINE_VECTOR(drgn_module_vector, struct drgn_module *);
DEFINE_HASH_MAP_FUNCTIONS(drgn_dwarf_type_map, ptr_key_hash_pair,
scalar_key_eq);
static void
drgn_namespace_dwarf_index_init(struct drgn_namespace_dwarf_index *dindex,
const char *name, size_t name_len,
struct drgn_namespace_dwarf_index *parent)
{
dindex->dbinfo = parent->dbinfo;
dindex->name = name;
dindex->name_len = name_len;
dindex->parent = parent;
drgn_namespace_table_init(&dindex->children);
array_for_each(tag_map, dindex->map)
drgn_dwarf_index_die_map_init(tag_map);
dindex->cus_indexed = 0;
memset(dindex->dies_indexed, 0, sizeof(dindex->dies_indexed));
dindex->saved_err = NULL;
}
static void
drgn_namespace_dwarf_index_deinit(struct drgn_namespace_dwarf_index *dindex)
{
drgn_error_destroy(dindex->saved_err);
array_for_each(tag_map, dindex->map) {
hash_table_for_each(drgn_dwarf_index_die_map, it, tag_map)
drgn_dwarf_index_die_vector_deinit(&it.entry->value);
drgn_dwarf_index_die_map_deinit(tag_map);
}
hash_table_for_each(drgn_namespace_table, it, &dindex->children) {
drgn_namespace_dwarf_index_deinit(*it.entry);
free(*it.entry);
}
drgn_namespace_table_deinit(&dindex->children);
}
void drgn_dwarf_info_init(struct drgn_debug_info *dbinfo)
{
dbinfo->dwarf.global.dbinfo = dbinfo;
drgn_namespace_dwarf_index_init(&dbinfo->dwarf.global, "", 0,
&dbinfo->dwarf.global);
dbinfo->dwarf.global.parent = NULL;
drgn_dwarf_base_type_map_init(&dbinfo->dwarf.base_types);
drgn_dwarf_specification_map_init(&dbinfo->dwarf.specifications);
free(dbinfo->dwarf.index_cu_lookup);
drgn_dwarf_index_cu_vector_init(&dbinfo->dwarf.index_cus);
drgn_dwarf_type_map_init(&dbinfo->dwarf.types);
drgn_dwarf_type_map_init(&dbinfo->dwarf.cant_be_incomplete_array_types);
}
static void drgn_dwarf_index_cu_deinit(struct drgn_dwarf_index_cu *cu)
{
free(cu->abbrev_insns);
free(cu->abbrev_decls);
}
void drgn_dwarf_info_deinit(struct drgn_debug_info *dbinfo)
{
drgn_dwarf_type_map_deinit(&dbinfo->dwarf.cant_be_incomplete_array_types);
drgn_dwarf_type_map_deinit(&dbinfo->dwarf.types);
vector_for_each(drgn_dwarf_index_cu_vector, cu,
&dbinfo->dwarf.index_cus)
drgn_dwarf_index_cu_deinit(cu);
drgn_dwarf_index_cu_vector_deinit(&dbinfo->dwarf.index_cus);
drgn_dwarf_specification_map_deinit(&dbinfo->dwarf.specifications);
drgn_dwarf_base_type_map_deinit(&dbinfo->dwarf.base_types);
drgn_namespace_dwarf_index_deinit(&dbinfo->dwarf.global);
}
/*
* Diagnostics.
*/
/** Like @ref dw_tag_str(), but takes a @c Dwarf_Die. */
static const char *dwarf_tag_str(Dwarf_Die *die, char buf[DW_TAG_STR_BUF_LEN])
{
return dw_tag_str(dwarf_tag(die), buf);
}
static inline struct drgn_error *drgn_check_address_size(uint8_t address_size)
{
if (address_size < 1 || address_size > 8) {
return drgn_error_format(DRGN_ERROR_OTHER,
"unsupported address size %" PRIu8,
address_size);
}
return NULL;
}
/*
* Indexing.
*
* A core part of debugger functionality is looking up types, variables, etc. by
* name. DWARF information can be very large, so scanning through all of it for
* every lookup would be too slow. Instead, when we load debugging information,
* we build an index of DIEs by name.
*
* This indexing step is parallelized and highly optimized. It is implemented as
* a bespoke DWARF parser specialized for the task of scanning over DIEs
* quickly.
*
* Although the DWARF standard defines ".debug_pubnames" and ".debug_names"
* sections, GCC and Clang currently don't emit them by default, so we don't use
* them.
*
* Every namespace has a separate index (@ref drgn_namespace_dwarf_index). The
* global namespace is indexed immediately upon loading debugging information.
* Other namespaces are indexed when they are first accessed.
*/
/**
* DWARF abbreviation table instructions.
*
* The DWARF abbreviation table can be large and contains more information than
* is strictly necessary for indexing. So, we translate the table into a series
* of instructions which specify how to process a DIE. This instruction stream
* omits unnecessary information and is more compact (and thus more cache
* friendly), which is important for the tight DIE parsing loop.
*/
enum drgn_dwarf_index_abbrev_insn {
// Instructions > 0 and <= INSN_MAX_SKIP indicate a number of bytes to
// be skipped over.
INSN_MAX_SKIP = 219,
// These instructions indicate an attribute that can be skipped over.
INSN_SKIP_BLOCK,
INSN_SKIP_BLOCK1,
INSN_SKIP_BLOCK2,
INSN_SKIP_BLOCK4,
INSN_SKIP_LEB128,
INSN_SKIP_STRING,
// These instructions indicate an attribute that should be parsed.
INSN_SIBLING_REF1,
INSN_SIBLING_REF2,
INSN_SIBLING_REF4,
INSN_SIBLING_REF8,
INSN_SIBLING_REF_UDATA,
INSN_NAME_STRP4,
INSN_NAME_STRP8,
INSN_NAME_STRING,
INSN_NAME_STRX,
INSN_NAME_STRX1,
INSN_NAME_STRX2,
INSN_NAME_STRX3,
INSN_NAME_STRX4,
INSN_NAME_STRP_ALT4,
INSN_NAME_STRP_ALT8,
INSN_DECLARATION_FLAG,
// "Specification" is overloaded to mean DW_AT_specification,
// DW_AT_abstract_origin, or DW_AT_import.
INSN_SPECIFICATION_REF1,
INSN_SPECIFICATION_REF2,
INSN_SPECIFICATION_REF4,
INSN_SPECIFICATION_REF8,
INSN_SPECIFICATION_REF_UDATA,
INSN_SPECIFICATION_REF_ADDR4,
INSN_SPECIFICATION_REF_ADDR8,
INSN_SPECIFICATION_REF_ALT4,
INSN_SPECIFICATION_REF_ALT8,
INSN_INDIRECT,
INSN_SIBLING_INDIRECT,
INSN_NAME_INDIRECT,
INSN_DECLARATION_INDIRECT,
INSN_SPECIFICATION_INDIRECT,
NUM_INSNS,
// Every sequence of instructions for a DIE is terminated by a zero
// byte.
INSN_END = 0,
// The byte after INSN_END contains the DIE flags, which are a bitmask
// of flags combined with the tag (either a drgn_dwarf_index_tag or one
// of the special INSN_DIE_TAG_ tags below).
INSN_DIE_FLAG_TAG_MASK = 0x1f,
// Tags that need special handling but don't need to be indexed
// themselves.
INSN_DIE_TAG_imported_unit = DRGN_DWARF_INDEX_NUM_TAGS,
INSN_DIE_NUM_TAGS,
// DIE is DW_TAG_subprogram with no DW_AT_low_pc or DW_AT_ranges.
INSN_DIE_FLAG_SUBPROGRAM_NO_PC = 0x20,
// DIE is a declaration.
INSN_DIE_FLAG_DECLARATION = 0x40,
// DIE has children.
INSN_DIE_FLAG_CHILDREN = 0x80,
};
// We use INSN_DIE_FLAG_TAG_MASK as a sentinel when the DIE shouldn't be
// indexed, so this is < and not <=.
static_assert((int)INSN_DIE_NUM_TAGS < (int)INSN_DIE_FLAG_TAG_MASK,
"too many instruction DIE tags");
// Instructions are 8 bits.
static_assert(NUM_INSNS - 1 == UINT8_MAX,
"maximum DWARF index instruction is invalid");
DEFINE_VECTOR(uint8_vector, uint8_t);
DEFINE_VECTOR(uint32_vector, uint32_t);
DEFINE_VECTOR(uint64_vector, uint64_t);
struct drgn_dwarf_index_cu_buffer {
struct binary_buffer bb;
struct drgn_dwarf_index_cu *cu;
// Depth of current DIE relative to starting DIE, which has depth 0.
unsigned int depth;
};
static struct drgn_error *
drgn_dwarf_index_cu_buffer_error(struct binary_buffer *bb, const char *pos,
const char *message)
{
struct drgn_dwarf_index_cu_buffer *buffer =
container_of(bb, struct drgn_dwarf_index_cu_buffer, bb);
return drgn_elf_file_section_error(buffer->cu->file,
buffer->cu->file->scns[buffer->cu->scn],
buffer->cu->file->scn_data[buffer->cu->scn],
pos, message);
}
static void
drgn_dwarf_index_cu_buffer_init(struct drgn_dwarf_index_cu_buffer *buffer,
struct drgn_dwarf_index_cu *cu)
{
binary_buffer_init(&buffer->bb, cu->buf, cu->len,
drgn_elf_file_is_little_endian(cu->file),
drgn_dwarf_index_cu_buffer_error);
buffer->cu = cu;
buffer->depth = 0;
}
// Returns NULL if die_addr is not from an indexed CU.
static struct drgn_dwarf_index_cu *
drgn_dwarf_index_find_cu(struct drgn_debug_info *dbinfo, uintptr_t die_addr)
{
struct drgn_dwarf_index_cu_lookup *lookup =
dbinfo->dwarf.index_cu_lookup;
#define less_than_cu_lookup_buf(a, b) (*(a) < (b)->buf)
size_t i = binary_search_gt(lookup,
drgn_dwarf_index_cu_vector_size(&dbinfo->dwarf.index_cus),
&die_addr, less_than_cu_lookup_buf);
#undef less_than_cu_buf
if (i == 0)
return NULL;
struct drgn_dwarf_index_cu *cu =
drgn_dwarf_index_cu_vector_at(&dbinfo->dwarf.index_cus,
lookup[i - 1].index);
if (die_addr - lookup[i - 1].buf >= cu->len)
return NULL;
return cu;
}
static const char *drgn_dwarf_dwo_name(Dwarf_Die *die)
{
Dwarf_Attribute attr_mem, *attr;
if ((attr = dwarf_attr(die, DW_AT_dwo_name, &attr_mem))
|| (attr = dwarf_attr(die, DW_AT_GNU_dwo_name, &attr_mem)))
return dwarf_formstring(attr);
return NULL;
}
static struct drgn_error *
drgn_dwarf_index_read_file(struct drgn_elf_file *file,
struct drgn_dwarf_index_cu_vector *cus,
struct drgn_dwarf_index_cu_vector *partial_units);
static struct drgn_error *
drgn_dwarf_index_read_cus(struct drgn_elf_file *file,
enum drgn_section_index scn,
struct drgn_dwarf_index_cu_vector *cus,
struct drgn_dwarf_index_cu_vector *partial_units)
{
struct drgn_error *err;
Dwarf *dwarf;
err = drgn_elf_file_get_dwarf(file, &dwarf);
if (err)
return err;
Dwarf_Off off, next_off;
size_t header_size;
Dwarf_Half version;
Dwarf_Off abbrev_offset;
uint8_t address_size;
uint8_t offset_size;
uint64_t v4_type_signature;
uint64_t *v4_type_signaturep =
scn == DRGN_SCN_DEBUG_TYPES ? &v4_type_signature : NULL;
int ret;
for (off = 0;
(ret = dwarf_next_unit(dwarf, off, &next_off, &header_size,
&version, &abbrev_offset, &address_size,
&offset_size, v4_type_signaturep,
NULL)) == 0;
off = next_off) {
Dwarf_Die cudie;
if (scn == DRGN_SCN_DEBUG_TYPES) {
if (!dwarf_offdie_types(dwarf, off + header_size,
&cudie))
return drgn_error_libdw();
} else {
if (!dwarf_offdie(dwarf, off + header_size, &cudie))
return drgn_error_libdw();
}
uint8_t unit_type;
#if _ELFUTILS_PREREQ(0, 171)
Dwarf_Die subdie;
if (dwarf_cu_info(cudie.cu, NULL, &unit_type, &cudie, &subdie,
NULL, NULL, NULL))
return drgn_error_libdw();
if (unit_type == DW_UT_skeleton && subdie.cu) {
Dwarf *split_dwarf = dwarf_cu_getdwarf(subdie.cu);
struct drgn_elf_file *split_file =
drgn_module_find_dwarf_file(file->module,
split_dwarf);
if (!split_file) {
const char *dwo_name =
drgn_dwarf_dwo_name(&cudie);
if (!dwo_name)
dwo_name = "";
err = drgn_module_create_split_dwarf_file(file->module,
dwo_name,
split_dwarf,
&split_file);
if (err)
return err;
err = drgn_dwarf_index_read_file(split_file,
cus,
partial_units);
if (err)
return err;
}
continue;
} else if (unit_type == DW_UT_skeleton) {
if (drgn_log_is_enabled(file->module->prog,
DRGN_LOG_WARNING)) {
const char *dwo_name =
drgn_dwarf_dwo_name(&cudie);
drgn_log_warning(file->module->prog,
"%s: split DWARF file%s%s not found",
file->path ?: "",
dwo_name ? " " : "",
dwo_name ? dwo_name : "");
}
continue;
} else {
Dwarf_Off dwp_offset;
if (dwarf_cu_dwp_section_info(cudie.cu, DW_SECT_ABBREV,
&dwp_offset, NULL))
return drgn_error_libdw();
abbrev_offset += dwp_offset;
}
#else
switch (dwarf_tag(&cudie)) {
case DW_TAG_type_unit:
unit_type = DW_UT_type;
break;
case DW_TAG_partial_unit:
unit_type = DW_UT_partial;
break;
default:
unit_type = DW_UT_compile;
break;
}
#endif
if (!elf_data_contains_ptr(file->scn_data[scn],
cudie.addr)) {
return drgn_elf_file_section_error(file, NULL, NULL,
cudie.addr,
"unit DIE from unexpected section");
}
const char *cu_buf = (char *)file->scn_data[scn]->d_buf + off;
if (version < 2 || version > 5) {
return drgn_elf_file_section_errorf(file,
file->scns[scn],
file->scn_data[scn],
cu_buf,
"unknown DWARF unit version %" PRIu16,
version);
}
if (address_size > 8) {
return drgn_elf_file_section_errorf(file,
file->scns[scn],
file->scn_data[scn],
cu_buf,
"unsupported DWARF unit address size %" PRIu8,
address_size);
}
Elf_Data *debug_abbrev = file->scn_data[DRGN_SCN_DEBUG_ABBREV];
if (abbrev_offset > debug_abbrev->d_size) {
return drgn_elf_file_section_error(file,
file->scns[scn],
file->scn_data[scn],
cu_buf,
"debug_abbrev_offset is out of bounds");
}
const char *pending_abbrev =
(char *)debug_abbrev->d_buf + abbrev_offset;
Elf_Data *debug_str_offsets =
file->scn_data[DRGN_SCN_DEBUG_STR_OFFSETS];
const char *str_offsets = NULL;
if (debug_str_offsets) {
Dwarf_Word str_offsets_base;
if (version >= 5) {
Dwarf_Attribute attr_mem, *attr;
if ((attr = dwarf_attr(&cudie,
DW_AT_str_offsets_base,
&attr_mem))) {
if (dwarf_formudata(attr,
&str_offsets_base))
return drgn_error_libdw();
} else {
// The default str_offsets_base is the
// first entry in .debug_str_offsets
// after the first header. (This isn't
// explicit in the DWARF 5
// specification, but it seems to be the
// consensus.)
str_offsets_base = 2 * offset_size;
}
} else {
// GNU Debug Fission doesn't have
// DW_AT_str_offsets_base; the base is always 0.
str_offsets_base = 0;
}
Dwarf_Off dwp_offset;
if (dwarf_cu_dwp_section_info(cudie.cu,
DW_SECT_STR_OFFSETS,
&dwp_offset, NULL))
return drgn_error_libdw();
str_offsets_base += dwp_offset;
if (str_offsets_base > debug_str_offsets->d_size) {
return drgn_elf_file_section_error(file,
file->scns[scn],
file->scn_data[scn],
cudie.addr,
".debug_str_offsets base is out of bounds");
}
str_offsets =
(char *)debug_str_offsets->d_buf
+ str_offsets_base;
}
struct drgn_dwarf_index_cu *cu =
drgn_dwarf_index_cu_vector_append_entry(unit_type == DW_UT_partial
? partial_units : cus);
if (!cu)
return &drgn_enomem;
*cu = (struct drgn_dwarf_index_cu){
.file = file,
.buf = cu_buf,
.len = min(next_off, (Dwarf_Off)file->scn_data[scn]->d_size) - off,
.version = version,
.unit_type = unit_type,
.address_size = address_size,
.is_64_bit = offset_size == 8,
.scn = scn,
.pending_abbrev = pending_abbrev,
.str_offsets = str_offsets,
.libdw_cu = cudie.cu,
};
}
if (ret < 0)
return drgn_error_libdw();
return NULL;
}
static struct drgn_error *
drgn_dwarf_index_read_file(struct drgn_elf_file *file,
struct drgn_dwarf_index_cu_vector *cus,
struct drgn_dwarf_index_cu_vector *partial_units)
{
struct drgn_error *err;
for (int scn = 0; scn < DRGN_SECTION_INDEX_NUM_DWARF_INDEX; scn++) {
if (file->scns[scn]) {
Elf_Data *data;
err = drgn_elf_file_read_section(file, scn, &data);
if (err)
return err;
}
}
err = drgn_dwarf_index_read_cus(file, DRGN_SCN_DEBUG_INFO, cus,
partial_units);
if (err)
return err;
if (file->scns[DRGN_SCN_DEBUG_TYPES]) {
err = drgn_dwarf_index_read_cus(file, DRGN_SCN_DEBUG_TYPES,
cus, partial_units);
if (err)
return err;
}
if (file == file->module->debug_file
&& file->module->supplementary_debug_file) {
err = drgn_dwarf_index_read_file(file->module->supplementary_debug_file,
cus, partial_units);
if (err)
return err;
file->alt_debug_info_data =
file->module->supplementary_debug_file->scn_data[DRGN_SCN_DEBUG_INFO];
file->alt_debug_str_data =
file->module->supplementary_debug_file->scn_data[DRGN_SCN_DEBUG_STR];
}
return err;
}
static struct drgn_error *read_strx(struct drgn_dwarf_index_cu_buffer *buffer,
uint64_t strx, const char **ret)
{
if (!buffer->cu->str_offsets) {
return binary_buffer_error(&buffer->bb,
"string index without .debug_str_offsets section");
}
Elf_Data *debug_str_offsets =
buffer->cu->file->scn_data[DRGN_SCN_DEBUG_STR_OFFSETS];
size_t offset_size = buffer->cu->is_64_bit ? 8 : 4;
if (((char *)debug_str_offsets->d_buf + debug_str_offsets->d_size
- buffer->cu->str_offsets)
/ offset_size <= strx) {
return binary_buffer_error(&buffer->bb,
"string index out of bounds");
}
uint64_t strp;
if (buffer->cu->is_64_bit) {
memcpy(&strp, (uint64_t *)buffer->cu->str_offsets + strx,
sizeof(strp));
if (buffer->bb.bswap)
strp = bswap_64(strp);
} else {
uint32_t strp32;
memcpy(&strp32, (uint32_t *)buffer->cu->str_offsets + strx,
sizeof(strp32));
if (buffer->bb.bswap)
strp32 = bswap_32(strp32);
strp = strp32;
}
if (strp >= buffer->cu->file->scn_data[DRGN_SCN_DEBUG_STR]->d_size) {
return binary_buffer_error(&buffer->bb,
"indirect string is out of bounds");
}
*ret = ((char *)buffer->cu->file->scn_data[DRGN_SCN_DEBUG_STR]->d_buf
+ strp);
return NULL;
}
static struct drgn_error *dw_form_to_insn(struct drgn_dwarf_index_cu *cu,
struct binary_buffer *bb,
uint64_t form, uint8_t *insn_ret)
{
struct drgn_error *err;
switch (form) {
case DW_FORM_addr:
*insn_ret = cu->address_size;
return NULL;
case DW_FORM_data1:
case DW_FORM_ref1:
case DW_FORM_flag:
case DW_FORM_strx1:
case DW_FORM_addrx1:
*insn_ret = 1;
return NULL;
case DW_FORM_data2:
case DW_FORM_ref2:
case DW_FORM_strx2:
case DW_FORM_addrx2:
*insn_ret = 2;
return NULL;
case DW_FORM_strx3:
case DW_FORM_addrx3:
*insn_ret = 3;
return NULL;
case DW_FORM_data4:
case DW_FORM_ref4:
case DW_FORM_ref_sup4:
case DW_FORM_strx4:
case DW_FORM_addrx4:
*insn_ret = 4;
return NULL;
case DW_FORM_data8:
case DW_FORM_ref8:
case DW_FORM_ref_sig8:
case DW_FORM_ref_sup8:
*insn_ret = 8;
return NULL;
case DW_FORM_data16:
*insn_ret = 16;
return NULL;
case DW_FORM_block:
case DW_FORM_exprloc:
*insn_ret = INSN_SKIP_BLOCK;
return NULL;
case DW_FORM_block1:
*insn_ret = INSN_SKIP_BLOCK1;
return NULL;
case DW_FORM_block2:
*insn_ret = INSN_SKIP_BLOCK2;
return NULL;
case DW_FORM_block4:
*insn_ret = INSN_SKIP_BLOCK4;
return NULL;
case DW_FORM_sdata:
case DW_FORM_udata:
case DW_FORM_ref_udata:
case DW_FORM_strx:
case DW_FORM_addrx:
case DW_FORM_loclistx:
case DW_FORM_rnglistx:
case DW_FORM_GNU_addr_index:
case DW_FORM_GNU_str_index:
*insn_ret = INSN_SKIP_LEB128;
return NULL;
case DW_FORM_ref_addr:
if (cu->version < 3) {
*insn_ret = cu->address_size;
return NULL;
}
fallthrough;
case DW_FORM_sec_offset:
case DW_FORM_strp:
case DW_FORM_strp_sup:
case DW_FORM_line_strp:
case DW_FORM_GNU_ref_alt:
case DW_FORM_GNU_strp_alt:
*insn_ret = cu->is_64_bit ? 8 : 4;
return NULL;
case DW_FORM_string:
*insn_ret = INSN_SKIP_STRING;
return NULL;
case DW_FORM_implicit_const:
if ((err = binary_buffer_skip_leb128(bb)))
return err;
fallthrough;
case DW_FORM_flag_present:
*insn_ret = 0;
return NULL;
case DW_FORM_indirect:
*insn_ret = INSN_INDIRECT;
return NULL;
default:
return binary_buffer_error(bb,
"unknown attribute form %#" PRIx64,
form);
}
}
static struct drgn_error *dw_at_sibling_to_insn(struct binary_buffer *bb,
uint64_t form,
uint8_t *insn_ret)
{
switch (form) {
case DW_FORM_ref1:
*insn_ret = INSN_SIBLING_REF1;
return NULL;
case DW_FORM_ref2:
*insn_ret = INSN_SIBLING_REF2;
return NULL;
case DW_FORM_ref4:
*insn_ret = INSN_SIBLING_REF4;
return NULL;
case DW_FORM_ref8:
*insn_ret = INSN_SIBLING_REF8;
return NULL;
case DW_FORM_ref_udata:
*insn_ret = INSN_SIBLING_REF_UDATA;
return NULL;
case DW_FORM_indirect:
*insn_ret = INSN_SIBLING_INDIRECT;
return NULL;
default:
return binary_buffer_error(bb,
"unknown attribute form %#" PRIx64 " for DW_AT_sibling",
form);
}
}
static struct drgn_error *dw_at_name_to_insn(struct drgn_dwarf_index_cu *cu,
struct binary_buffer *bb,
uint64_t form, uint8_t *insn_ret)
{
switch (form) {
case DW_FORM_strp:
if (!cu->file->scn_data[DRGN_SCN_DEBUG_STR]) {
return binary_buffer_error(bb,
"DW_FORM_strp without .debug_str section");
}
if (cu->is_64_bit)
*insn_ret = INSN_NAME_STRP8;
else
*insn_ret = INSN_NAME_STRP4;
return NULL;
case DW_FORM_string:
*insn_ret = INSN_NAME_STRING;
return NULL;
case DW_FORM_strx:
case DW_FORM_GNU_str_index:
*insn_ret = INSN_NAME_STRX;
return NULL;
case DW_FORM_strx1:
*insn_ret = INSN_NAME_STRX1;
return NULL;
case DW_FORM_strx2:
*insn_ret = INSN_NAME_STRX2;
return NULL;
case DW_FORM_strx3:
*insn_ret = INSN_NAME_STRX3;
return NULL;
case DW_FORM_strx4:
*insn_ret = INSN_NAME_STRX4;
return NULL;
case DW_FORM_GNU_strp_alt:
if (!cu->file->alt_debug_str_data) {
return binary_buffer_error(bb,
"DW_FORM_GNU_strp_alt without alternate .debug_str section");
}
if (cu->is_64_bit)
*insn_ret = INSN_NAME_STRP_ALT8;
else
*insn_ret = INSN_NAME_STRP_ALT4;
return NULL;
case DW_FORM_indirect:
*insn_ret = INSN_NAME_INDIRECT;
return NULL;
default:
return binary_buffer_error(bb,
"unknown attribute form %#" PRIx64 " for DW_AT_name",
form);
}
}
static struct drgn_error *
dw_at_declaration_to_insn(struct binary_buffer *bb, uint64_t form,
uint8_t *insn_ret, uint8_t *die_flags)
{
switch (form) {
case DW_FORM_flag:
*insn_ret = INSN_DECLARATION_FLAG;
return NULL;
case DW_FORM_flag_present:
/*
* This could be an instruction, but as long as we have a free
* DIE flag bit, we might as well use it.
*/
*insn_ret = 0;
*die_flags |= INSN_DIE_FLAG_DECLARATION;
return NULL;
case DW_FORM_indirect:
*insn_ret = INSN_DECLARATION_INDIRECT;
return NULL;
default:
return binary_buffer_error(bb,
"unknown attribute form %#" PRIx64 " for DW_AT_declaration",
form);
}
}
static struct drgn_error *
dw_at_specification_to_insn(struct drgn_dwarf_index_cu *cu,
struct binary_buffer *bb, uint64_t form,
uint8_t *insn_ret)
{
switch (form) {
case DW_FORM_ref1:
*insn_ret = INSN_SPECIFICATION_REF1;
return NULL;
case DW_FORM_ref2:
*insn_ret = INSN_SPECIFICATION_REF2;
return NULL;
case DW_FORM_ref4:
*insn_ret = INSN_SPECIFICATION_REF4;
return NULL;
case DW_FORM_ref8:
*insn_ret = INSN_SPECIFICATION_REF8;
return NULL;
case DW_FORM_ref_udata:
*insn_ret = INSN_SPECIFICATION_REF_UDATA;
return NULL;
case DW_FORM_ref_addr:
if (cu->version >= 3) {
if (cu->is_64_bit)
*insn_ret = INSN_SPECIFICATION_REF_ADDR8;
else
*insn_ret = INSN_SPECIFICATION_REF_ADDR4;
} else {
if (cu->address_size == 8)
*insn_ret = INSN_SPECIFICATION_REF_ADDR8;
else if (cu->address_size == 4)
*insn_ret = INSN_SPECIFICATION_REF_ADDR4;
else
return binary_buffer_error(bb,
"unsupported address size %" PRIu8 " for DW_FORM_ref_addr",
cu->address_size);
}
return NULL;
case DW_FORM_GNU_ref_alt:
if (!cu->file->alt_debug_info_data) {
return binary_buffer_error(bb,
"DW_FORM_GNU_ref_alt without alternate .debug_info section");
}
if (cu->is_64_bit)
*insn_ret = INSN_SPECIFICATION_REF_ALT8;
else
*insn_ret = INSN_SPECIFICATION_REF_ALT4;
return NULL;
case DW_FORM_indirect:
*insn_ret = INSN_SPECIFICATION_INDIRECT;
return NULL;
default:
return binary_buffer_error(bb,
"unknown attribute form %#" PRIx64 " for DW_AT_specification, DW_AT_abstract_origin, or DW_AT_import",
form);
}
}
static struct drgn_error *
read_abbrev_decl(struct drgn_elf_file_section_buffer *buffer,
struct drgn_dwarf_index_cu *cu, struct uint32_vector *decls,
struct uint8_vector *insns)
{
struct drgn_error *err;
uint64_t code;
if ((err = binary_buffer_next_uleb128(&buffer->bb, &code)))
return err;
if (code == 0)
return &drgn_stop;
if (code != uint32_vector_size(decls) + 1) {
return binary_buffer_error(&buffer->bb,
"DWARF abbreviation table is not sequential");
}
uint32_t insn_index = uint8_vector_size(insns);
if (!uint32_vector_append(decls, &insn_index))
return &drgn_enomem;
uint64_t tag;
if ((err = binary_buffer_next_uleb128(&buffer->bb, &tag)))
return err;
uint8_t die_flags;
bool should_index = true;
switch (tag) {
#define X(name) case DW_TAG_##name: die_flags = DRGN_DWARF_INDEX_##name; break;
DRGN_DWARF_INDEX_TAGS
#undef X
case DW_TAG_imported_unit:
die_flags = INSN_DIE_TAG_imported_unit;
should_index = false;
break;
default:
die_flags = INSN_DIE_FLAG_TAG_MASK;
should_index = false;
break;
}
if (tag == DW_TAG_subprogram)
die_flags |= INSN_DIE_FLAG_SUBPROGRAM_NO_PC;
uint8_t children;
if ((err = binary_buffer_next_u8(&buffer->bb, &children)))
return err;
if (children)
die_flags |= INSN_DIE_FLAG_CHILDREN;
uint8_t insn, last_insn = UINT8_MAX;
for (;;) {
uint64_t name, form;
if ((err = binary_buffer_next_uleb128(&buffer->bb, &name)))
return err;
if ((err = binary_buffer_next_uleb128(&buffer->bb, &form)))
return err;
if (name == 0 && form == 0)
break;
if (name == DW_AT_sibling) {
err = dw_at_sibling_to_insn(&buffer->bb, form, &insn);
} else if (name == DW_AT_name && should_index) {
err = dw_at_name_to_insn(cu, &buffer->bb, form, &insn);
} else if (name == DW_AT_declaration && should_index) {
err = dw_at_declaration_to_insn(&buffer->bb, form,
&insn, &die_flags);
} else if ((should_index
&& (name == DW_AT_specification
|| (tag == DW_TAG_subprogram
&& name == DW_AT_abstract_origin)))
|| (tag == DW_TAG_imported_unit
&& name == DW_AT_import)) {
err = dw_at_specification_to_insn(cu, &buffer->bb, form,
&insn);
} else {
if (name == DW_AT_low_pc || name == DW_AT_ranges)
die_flags &= ~INSN_DIE_FLAG_SUBPROGRAM_NO_PC;
err = dw_form_to_insn(cu, &buffer->bb, form, &insn);
}
if (err)
return err;
if (insn != 0) {
if (insn <= INSN_MAX_SKIP) {
if (last_insn + insn <= INSN_MAX_SKIP) {
*uint8_vector_last(insns) += insn;
continue;
} else if (last_insn < INSN_MAX_SKIP) {
insn = last_insn + insn - INSN_MAX_SKIP;
*uint8_vector_last(insns) = INSN_MAX_SKIP;
}
}
last_insn = insn;
if (!uint8_vector_append(insns, &insn))
return &drgn_enomem;
}
}
insn = INSN_END;
if (!uint8_vector_append(insns, &insn) ||
!uint8_vector_append(insns, &die_flags))
return &drgn_enomem;
return NULL;
}
static struct drgn_error *read_cu(struct drgn_dwarf_index_cu *cu)
{
struct drgn_elf_file_section_buffer buffer;
drgn_elf_file_section_buffer_init_index(&buffer, cu->file,
DRGN_SCN_DEBUG_ABBREV);
buffer.bb.pos = cu->pending_abbrev;
struct uint32_vector decls = VECTOR_INIT;
struct uint8_vector insns = VECTOR_INIT;
for (;;) {
struct drgn_error *err = read_abbrev_decl(&buffer, cu, &decls,
&insns);
if (err == &drgn_stop) {
break;
} else if (err) {
uint8_vector_deinit(&insns);
uint32_vector_deinit(&decls);
return err;
}
}
uint8_vector_shrink_to_fit(&insns);
uint32_vector_shrink_to_fit(&decls);
uint32_vector_steal(&decls, &cu->abbrev_decls, &cu->num_abbrev_decls);
uint8_vector_steal(&insns, &cu->abbrev_insns, NULL);
return NULL;
}
/* Get the size of a unit header beyond that of a normal compilation unit. */
static size_t cu_header_extra_size(struct drgn_dwarf_index_cu *cu)
{
switch (cu->unit_type) {
case DW_UT_compile:
case DW_UT_partial:
return 0;
case DW_UT_skeleton:
case DW_UT_split_compile:
/* dwo_id */
return cu->version >= 5 ? 8 : 0;
case DW_UT_type:
case DW_UT_split_type:
/* type_signature and type_offset */
return cu->is_64_bit ? 16 : 12;
default:
UNREACHABLE();
}
}
static size_t cu_header_size(struct drgn_dwarf_index_cu *cu)
{
size_t size = cu->is_64_bit ? 23 : 11;
if (cu->version >= 5)
size++;
size += cu_header_extra_size(cu);
return size;
}
static bool
index_specification(struct drgn_dwarf_specification_map *specifications,
uintptr_t declaration, uintptr_t addr)
{
struct drgn_dwarf_specification_map_entry entry = {
.key = declaration,
.value = addr,
};
struct hash_pair hp = drgn_dwarf_specification_map_hash(&declaration);
// There may be duplicates if multiple DIEs reference one declaration,
// but we ignore them.
return drgn_dwarf_specification_map_insert_hashed(specifications, &entry,
hp, NULL) >= 0;
}
static struct drgn_error *read_indirect_insn(struct drgn_dwarf_index_cu *cu,
struct binary_buffer *bb,
uint8_t insn, uint8_t *insn_ret,
uint8_t *die_flags)
{
struct drgn_error *err;
uint64_t form;
if ((err = binary_buffer_next_uleb128(bb, &form)))
return err;
if (form == DW_FORM_implicit_const) {
return binary_buffer_error(bb,
"DW_FORM_implicit_const in DW_FORM_indirect");
}
switch (insn) {
case INSN_INDIRECT:
return dw_form_to_insn(cu, bb, form, insn_ret);
case INSN_SIBLING_INDIRECT:
return dw_at_sibling_to_insn(bb, form, insn_ret);
case INSN_NAME_INDIRECT:
return dw_at_name_to_insn(cu, bb, form, insn_ret);
case INSN_DECLARATION_INDIRECT:
return dw_at_declaration_to_insn(bb, form, insn_ret, die_flags);
case INSN_SPECIFICATION_INDIRECT:
return dw_at_specification_to_insn(cu, bb, form, insn_ret);
default:
UNREACHABLE();
}
}
// Stack of CU buffers. The bottom is the initial unit/DIE, and
// DW_TAG_imported_unit DIEs push additional buffers. We use an inline size of 1
// to avoid an allocation in the common case of no imports.
DEFINE_VECTOR(drgn_dwarf_index_cu_buffer_stack,
struct drgn_dwarf_index_cu_buffer, 1);
static const size_t MAX_IMPORTED_UNIT_DEPTH = 128;
/*
* First pass: index DIEs with DW_AT_specification and DW_AT_abstract_origin.
* This recurses into namespaces.
*/
static struct drgn_error *
index_cu_first_pass(struct drgn_dwarf_specification_map *specifications,
struct drgn_dwarf_index_cu_buffer_stack *stack)
{
struct drgn_error *err;
struct drgn_dwarf_index_cu_buffer *buffer =
drgn_dwarf_index_cu_buffer_stack_last(stack);
struct drgn_dwarf_index_cu *cu = buffer->cu;
for (;;) {
uintptr_t die_addr = (uintptr_t)buffer->bb.pos;
uint64_t code;
if ((err = binary_buffer_next_uleb128(&buffer->bb, &code)))
return err;
if (code == 0) {
if (buffer->depth > 1) {
buffer->depth--;
} else {
pop:
drgn_dwarf_index_cu_buffer_stack_pop(stack);
if (drgn_dwarf_index_cu_buffer_stack_empty(stack))
break;
buffer = drgn_dwarf_index_cu_buffer_stack_last(stack);
cu = buffer->cu;
}
continue;
} else if (code > cu->num_abbrev_decls) {
return binary_buffer_error(&buffer->bb,
"unknown abbreviation code %" PRIu64,
code);
}
uint8_t *insnp = &cu->abbrev_insns[cu->abbrev_decls[code - 1]];
bool declaration = false;
const char *specification = NULL;
const char *sibling = NULL;
uint8_t insn;
uint8_t extra_die_flags = 0;
while ((insn = *insnp++) != INSN_END) {
indirect_insn:;
uint64_t skip, tmp;
switch (insn) {
case INSN_SKIP_BLOCK:
if ((err = binary_buffer_next_uleb128(&buffer->bb,
&skip)))
return err;
goto skip;
case INSN_SKIP_BLOCK1:
if ((err = binary_buffer_next_u8_into_u64(&buffer->bb,
&skip)))
return err;
goto skip;
case INSN_SKIP_BLOCK2:
if ((err = binary_buffer_next_u16_into_u64(&buffer->bb,
&skip)))
return err;
goto skip;
case INSN_SKIP_BLOCK4:
if ((err = binary_buffer_next_u32_into_u64(&buffer->bb,
&skip)))
return err;
goto skip;
case INSN_SKIP_LEB128:
case INSN_NAME_STRX:
if ((err = binary_buffer_skip_leb128(&buffer->bb)))
return err;
break;
case INSN_SKIP_STRING:
case INSN_NAME_STRING:
if ((err = binary_buffer_skip_string(&buffer->bb)))
return err;
break;
case INSN_SIBLING_REF1:
if ((err = binary_buffer_next_u8_into_u64(&buffer->bb,
&tmp)))
return err;
goto sibling;
case INSN_SIBLING_REF2:
if ((err = binary_buffer_next_u16_into_u64(&buffer->bb,
&tmp)))
return err;
goto sibling;
case INSN_SIBLING_REF4:
if ((err = binary_buffer_next_u32_into_u64(&buffer->bb,
&tmp)))
return err;
goto sibling;
case INSN_SIBLING_REF8:
if ((err = binary_buffer_next_u64(&buffer->bb,
&tmp)))
return err;
goto sibling;
case INSN_SIBLING_REF_UDATA:
if ((err = binary_buffer_next_uleb128(&buffer->bb,
&tmp)))
return err;
sibling:
if (tmp > cu->len) {
return binary_buffer_error(&buffer->bb,
"DW_AT_sibling is out of bounds");
}
sibling = cu->buf + tmp;
__builtin_prefetch(sibling);
if (sibling < buffer->bb.pos) {
return binary_buffer_error(&buffer->bb,
"DW_AT_sibling points backwards");
}
break;
case INSN_NAME_STRX1:
skip = 1;
goto skip;
case INSN_NAME_STRX2:
skip = 2;
goto skip;
case INSN_NAME_STRX3:
skip = 3;
goto skip;
case INSN_NAME_STRP4:
case INSN_NAME_STRX4:
case INSN_NAME_STRP_ALT4:
skip = 4;
goto skip;
case INSN_NAME_STRP8:
case INSN_NAME_STRP_ALT8:
skip = 8;
goto skip;
case INSN_DECLARATION_FLAG: {
uint8_t flag;
if ((err = binary_buffer_next_u8(&buffer->bb,
&flag)))
return err;
if (flag)
declaration = true;
break;
}
case INSN_SPECIFICATION_REF1:
if ((err = binary_buffer_next_u8_into_u64(&buffer->bb,
&tmp)))
return err;
goto specification;
case INSN_SPECIFICATION_REF2:
if ((err = binary_buffer_next_u16_into_u64(&buffer->bb,
&tmp)))
return err;
goto specification;
case INSN_SPECIFICATION_REF4:
if ((err = binary_buffer_next_u32_into_u64(&buffer->bb,
&tmp)))
return err;
goto specification;
case INSN_SPECIFICATION_REF8:
if ((err = binary_buffer_next_u64(&buffer->bb,
&tmp)))
return err;
goto specification;
case INSN_SPECIFICATION_REF_UDATA:
if ((err = binary_buffer_next_uleb128(&buffer->bb,
&tmp)))
return err;
specification:
if (tmp >= cu->len) {
return binary_buffer_error(&buffer->bb,
"reference is out of bounds");
}
specification = cu->buf + tmp;
break;
case INSN_SPECIFICATION_REF_ADDR4:
if ((err = binary_buffer_next_u32_into_u64(&buffer->bb,
&tmp)))
return err;
goto specification_ref_addr;
case INSN_SPECIFICATION_REF_ADDR8:
if ((err = binary_buffer_next_u64(&buffer->bb,
&tmp)))
return err;
specification_ref_addr:
if (tmp >= cu->file->scn_data[cu->scn]->d_size) {
return binary_buffer_error(&buffer->bb,
"reference is out of bounds");
}
specification = (char *)cu->file->scn_data[cu->scn]->d_buf
+ tmp;
break;
case INSN_SPECIFICATION_REF_ALT4:
if ((err = binary_buffer_next_u32_into_u64(&buffer->bb,
&tmp)))
return err;
goto specification_ref_alt;
case INSN_SPECIFICATION_REF_ALT8:
if ((err = binary_buffer_next_u64(&buffer->bb,
&tmp)))
return err;
specification_ref_alt:
if (tmp >= cu->file->alt_debug_info_data->d_size) {
return binary_buffer_error(&buffer->bb,
"reference is out of bounds");
}
specification = (char *)cu->file->alt_debug_info_data->d_buf
+ tmp;
break;
case INSN_INDIRECT:
case INSN_SIBLING_INDIRECT:
case INSN_NAME_INDIRECT:
case INSN_DECLARATION_INDIRECT:
case INSN_SPECIFICATION_INDIRECT:
if ((err = read_indirect_insn(cu, &buffer->bb,
insn, &insn,
&extra_die_flags)))
return err;
if (insn)
goto indirect_insn;
else
continue;
default:
skip = insn;
skip:
if ((err = binary_buffer_skip(&buffer->bb,
skip)))
return err;
break;
}
}
insn = *insnp | extra_die_flags;
uint8_t tag = insn & INSN_DIE_FLAG_TAG_MASK;
if (specification && tag != INSN_DIE_TAG_imported_unit) {
if (insn & INSN_DIE_FLAG_DECLARATION)
declaration = true;
/*
* For now, we don't handle DIEs with
* DW_AT_specification which are themselves
* declarations. We may need to handle
* DW_AT_specification "chains" in the future.
*/
if (!declaration
&& !index_specification(specifications,
(uintptr_t)specification,
die_addr))
return &drgn_enomem;
}
unsigned int orig_depth = buffer->depth;
if (insn & INSN_DIE_FLAG_CHILDREN) {
// We descend into a DIE's children in these cases:
// 1. The DIE doesn't have a sibling pointer, in which
// case we have no choice.
// 2. The DIE is the unit that we're indexing.
// 3. The DIE is a namespace.
// In cases 2 and 3, we ignore the DIE's sibling pointer
// if it has one.
//
// Otherwise, we skip over the DIE's children by
// following the sibling pointer.
if (!sibling
|| buffer->depth == 0
|| tag == DRGN_DWARF_INDEX_namespace)
buffer->depth++;
else
buffer->bb.pos = sibling;
} else if (buffer->depth == 0) {
goto pop;
}
// We only need to follow imported_unit DIEs whose parent is a
// unit or namespace. To do that, we'd need to track extra
// information. In practice, imported_unit DIEs are mainly used
// in that case anyways, so we don't bother checking and take
// the risk of unnecessary imports.
//
// imported_unit DIEs at depth 0 are malformed, so we ignore
// those.
if (tag == INSN_DIE_TAG_imported_unit && orig_depth > 0) {
if (!specification) {
return binary_buffer_error(&buffer->bb,
"DW_TAG_imported_unit is missing DW_AT_import");
}
cu = drgn_dwarf_index_find_cu(&cu->file->module->prog->dbinfo,
(uintptr_t)specification);
if (!cu) {
return binary_buffer_error(&buffer->bb,
"imported unit not found");
}
if (drgn_dwarf_index_cu_buffer_stack_size(stack)
>= MAX_IMPORTED_UNIT_DEPTH) {
return binary_buffer_error(&buffer->bb,
"maximum DWARF imported unit depth exceeded");
}
buffer = drgn_dwarf_index_cu_buffer_stack_append_entry(stack);
if (!buffer)
return &drgn_enomem;
drgn_dwarf_index_cu_buffer_init(buffer, cu);
buffer->bb.pos = specification;
}
}
return NULL;
}
/**
* Find the address of a top-level DIE with a @c DW_AT_specification or @c
* DW_AT_abstract_origin attribute that refers to the given DIE address.
*
* This can be used to find the definition of a declaration or the concrete
* out-of-line instance of an abstract instance root.
*
* @param[in] die_addr Address of a DIE.
* @param[out] ret Returned address of the definition DIE.
* @return @c true if a definition DIE was found, @c false if not (in which case
* `*ret` is not modified).
*/
static bool drgn_dwarf_find_definition(struct drgn_debug_info *dbinfo,
uintptr_t die_addr, uintptr_t *ret)
{
struct drgn_dwarf_specification_map_iterator it =
drgn_dwarf_specification_map_search(&dbinfo->dwarf.specifications,
&die_addr);
if (!it.entry)
return false;
*ret = it.entry->value;
return true;
}
static bool
index_die(struct drgn_dwarf_index_die_map map[static DRGN_DWARF_INDEX_MAP_SIZE],
struct drgn_dwarf_base_type_map *base_types, const char *name,
int tag, uintptr_t addr)
{
size_t name_len = strlen(name);
if (tag != DRGN_DWARF_INDEX_base_type) {
struct drgn_dwarf_index_die_map_entry entry = {
.key = { name, name_len },
.value = VECTOR_INIT,
};
struct hash_pair hp = drgn_dwarf_index_die_map_hash(&entry.key);
auto it = drgn_dwarf_index_die_map_search_hashed(&map[tag],
&entry.key,
hp);
if (!it.entry
&& drgn_dwarf_index_die_map_insert_searched(&map[tag],
&entry, hp,
&it) < 0)
return false;
return drgn_dwarf_index_die_vector_append(&it.entry->value,
&addr);
} else if (base_types) {
struct drgn_dwarf_base_type_map_entry entry = {
.key = { name, name_len },
.value = addr,
};
struct hash_pair hp = drgn_dwarf_base_type_map_hash(&entry.key);
return drgn_dwarf_base_type_map_insert_hashed(base_types,
&entry, hp,
NULL) >= 0;
}
return true;
}
/* Second pass: index the actual DIEs. */
static struct drgn_error *
index_cu_second_pass(struct drgn_debug_info *dbinfo,
struct drgn_dwarf_index_die_map map[static DRGN_DWARF_INDEX_MAP_SIZE],
struct drgn_dwarf_base_type_map *base_types,
struct drgn_dwarf_index_cu_buffer_stack *stack)
{
struct drgn_error *err;
struct drgn_dwarf_index_cu_buffer *buffer =
drgn_dwarf_index_cu_buffer_stack_last(stack);
struct drgn_dwarf_index_cu *cu = buffer->cu;
uint8_t depth1_tag = 0;
uintptr_t depth1_addr = 0;
for (;;) {
uintptr_t die_addr = (uintptr_t)buffer->bb.pos;
uint64_t code;
if ((err = binary_buffer_next_uleb128(&buffer->bb, &code)))
return err;
if (code == 0) {
if (buffer->depth > 1) {
buffer->depth--;
} else {
pop:
drgn_dwarf_index_cu_buffer_stack_pop(stack);
if (drgn_dwarf_index_cu_buffer_stack_empty(stack))
break;
buffer = drgn_dwarf_index_cu_buffer_stack_last(stack);
cu = buffer->cu;
}
continue;
} else if (code > cu->num_abbrev_decls) {
return binary_buffer_error(&buffer->bb,
"unknown abbreviation code %" PRIu64,
code);
}
uint8_t *insnp = &cu->abbrev_insns[cu->abbrev_decls[code - 1]];
const char *name = NULL;
bool declaration = false;
const char *specification = NULL;
const char *sibling = NULL;
uint8_t insn;
uint8_t extra_die_flags = 0;
while ((insn = *insnp++) != INSN_END) {
indirect_insn:;
uint64_t skip, tmp;
switch (insn) {
case INSN_SKIP_BLOCK:
if ((err = binary_buffer_next_uleb128(&buffer->bb,
&skip)))
return err;
goto skip;
case INSN_SKIP_BLOCK1:
if ((err = binary_buffer_next_u8_into_u64(&buffer->bb,
&skip)))
return err;
goto skip;
case INSN_SKIP_BLOCK2:
if ((err = binary_buffer_next_u16_into_u64(&buffer->bb,
&skip)))
return err;
goto skip;
case INSN_SKIP_BLOCK4:
if ((err = binary_buffer_next_u32_into_u64(&buffer->bb,
&skip)))
return err;
goto skip;
case INSN_SKIP_LEB128:
if ((err = binary_buffer_skip_leb128(&buffer->bb)))
return err;
break;
case INSN_NAME_STRING:
name = buffer->bb.pos;
fallthrough;
case INSN_SKIP_STRING:
if ((err = binary_buffer_skip_string(&buffer->bb)))
return err;
break;
case INSN_SIBLING_REF1:
if ((err = binary_buffer_next_u8_into_u64(&buffer->bb,
&tmp)))
return err;
goto sibling;
case INSN_SIBLING_REF2:
if ((err = binary_buffer_next_u16_into_u64(&buffer->bb,
&tmp)))
return err;
goto sibling;
case INSN_SIBLING_REF4:
if ((err = binary_buffer_next_u32_into_u64(&buffer->bb,
&tmp)))
return err;
goto sibling;
case INSN_SIBLING_REF8:
if ((err = binary_buffer_next_u64(&buffer->bb,
&tmp)))
return err;
goto sibling;
case INSN_SIBLING_REF_UDATA:
if ((err = binary_buffer_next_uleb128(&buffer->bb,
&tmp)))
return err;
sibling:
if (tmp > cu->len) {
return binary_buffer_error(&buffer->bb,
"DW_AT_sibling is out of bounds");
}
sibling = cu->buf + tmp;
__builtin_prefetch(sibling);
if (sibling < buffer->bb.pos) {
return binary_buffer_error(&buffer->bb,
"DW_AT_sibling points backwards");
}
break;
case INSN_NAME_STRP4:
if ((err = binary_buffer_next_u32_into_u64(&buffer->bb,
&tmp)))
return err;
goto strp;
case INSN_NAME_STRP8:
if ((err = binary_buffer_next_u64(&buffer->bb, &tmp)))
return err;
strp:
if (tmp >= cu->file->scn_data[DRGN_SCN_DEBUG_STR]->d_size) {
return binary_buffer_error(&buffer->bb,
"DW_AT_name is out of bounds");
}
name = (const char *)cu->file->scn_data[DRGN_SCN_DEBUG_STR]->d_buf
+ tmp;
__builtin_prefetch(name);
break;
case INSN_NAME_STRX:
if ((err = binary_buffer_next_uleb128(&buffer->bb,
&tmp)))
return err;
goto name_strx;
case INSN_NAME_STRX1:
if ((err = binary_buffer_next_u8_into_u64(&buffer->bb,
&tmp)))
return err;
goto name_strx;
case INSN_NAME_STRX2:
if ((err = binary_buffer_next_u16_into_u64(&buffer->bb,
&tmp)))
return err;
goto name_strx;
case INSN_NAME_STRX3:
if ((err = binary_buffer_next_uint(&buffer->bb,
3, &tmp)))
return err;
goto name_strx;
case INSN_NAME_STRX4:
if ((err = binary_buffer_next_u32_into_u64(&buffer->bb,
&tmp)))
return err;
name_strx:
if ((err = read_strx(buffer, tmp, &name)))
return err;
__builtin_prefetch(name);
break;
case INSN_NAME_STRP_ALT4:
if ((err = binary_buffer_next_u32_into_u64(&buffer->bb,
&tmp)))
return err;
goto name_alt_strp;
case INSN_NAME_STRP_ALT8:
if ((err = binary_buffer_next_u64(&buffer->bb, &tmp)))
return err;
name_alt_strp:
if (tmp >= cu->file->alt_debug_str_data->d_size) {
return binary_buffer_error(&buffer->bb,
"DW_AT_name is out of bounds");
}
name = (const char *)cu->file->alt_debug_str_data->d_buf + tmp;
__builtin_prefetch(name);
break;
case INSN_DECLARATION_FLAG: {
uint8_t flag;
if ((err = binary_buffer_next_u8(&buffer->bb,
&flag)))
return err;
if (flag)
declaration = true;
break;
}
case INSN_SPECIFICATION_REF1:
if ((err = binary_buffer_next_u8_into_u64(&buffer->bb,
&tmp)))
return err;
goto specification;
case INSN_SPECIFICATION_REF2:
if ((err = binary_buffer_next_u16_into_u64(&buffer->bb,
&tmp)))
return err;
goto specification;
case INSN_SPECIFICATION_REF4:
if ((err = binary_buffer_next_u32_into_u64(&buffer->bb,
&tmp)))
return err;
goto specification;
case INSN_SPECIFICATION_REF8:
if ((err = binary_buffer_next_u64(&buffer->bb,
&tmp)))
return err;
goto specification;
case INSN_SPECIFICATION_REF_UDATA:
if ((err = binary_buffer_next_uleb128(&buffer->bb,
&tmp)))
return err;
specification:
if (tmp >= cu->len) {
return binary_buffer_error(&buffer->bb,
"reference is out of bounds");
}
specification = cu->buf + tmp;
break;
case INSN_SPECIFICATION_REF_ADDR4:
if ((err = binary_buffer_next_u32_into_u64(&buffer->bb,
&tmp)))
return err;
goto specification_ref_addr;
case INSN_SPECIFICATION_REF_ADDR8:
if ((err = binary_buffer_next_u64(&buffer->bb,
&tmp)))
return err;
specification_ref_addr:
if (tmp >= cu->file->scn_data[cu->scn]->d_size) {
return binary_buffer_error(&buffer->bb,
"reference is out of bounds");
}
specification = (char *)cu->file->scn_data[cu->scn]->d_buf
+ tmp;
break;
case INSN_SPECIFICATION_REF_ALT4:
if ((err = binary_buffer_next_u32_into_u64(&buffer->bb,
&tmp)))
return err;
goto specification_ref_alt;
case INSN_SPECIFICATION_REF_ALT8:
if ((err = binary_buffer_next_u64(&buffer->bb,
&tmp)))
return err;
specification_ref_alt:
if (tmp >= cu->file->alt_debug_info_data->d_size) {
return binary_buffer_error(&buffer->bb,
"reference is out of bounds");
}
specification = (char *)cu->file->alt_debug_info_data->d_buf
+ tmp;
break;
case INSN_INDIRECT:
case INSN_SIBLING_INDIRECT:
case INSN_NAME_INDIRECT:
case INSN_DECLARATION_INDIRECT:
case INSN_SPECIFICATION_INDIRECT:
if ((err = read_indirect_insn(cu, &buffer->bb,
insn, &insn,
&extra_die_flags)))
return err;
if (insn)
goto indirect_insn;
else
continue;
default:
skip = insn;
skip:
if ((err = binary_buffer_skip(&buffer->bb,
skip)))
return err;
break;
}
}
insn = *insnp | extra_die_flags;
uint8_t tag = insn & INSN_DIE_FLAG_TAG_MASK;
if (buffer->depth == 1) {
depth1_tag = tag;
depth1_addr = die_addr;
}
if (buffer->depth == (tag == DRGN_DWARF_INDEX_enumerator ? 2 : 1)
&& name && !specification) {
if (insn & INSN_DIE_FLAG_DECLARATION)
declaration = true;
if (tag == DRGN_DWARF_INDEX_enumerator) {
if (depth1_tag != DRGN_DWARF_INDEX_enumeration_type)
goto next;
/*
* NB: the enumerator name points to the
* enumeration_type DIE. Also, enumerators can't
* be declared in C/C++, so we don't check for
* that.
*/
die_addr = depth1_addr;
} else if (declaration) {
// Declaration class, struct, and union DIEs
// with children are treated like namespaces.
if ((insn & INSN_DIE_FLAG_CHILDREN)
&& (tag == DRGN_DWARF_INDEX_class_type
|| tag == DRGN_DWARF_INDEX_structure_type
|| tag == DRGN_DWARF_INDEX_union_type)
&& !index_die(map, base_types, name,
DRGN_DWARF_INDEX_namespace,
die_addr))
return &drgn_enomem;
if (!drgn_dwarf_find_definition(dbinfo,
die_addr,
&die_addr))
goto next;
}
// A subprogram DIE without an address may be the
// abstract instance root for an inlined function, or a
// subprogram DIE in a supplementary file. Check for a
// concrete instance or a definition in the main debug
// file, respectively.
//
// Note that if the original DIE was a declaration, then
// this is technically checking whether the declaration
// itself has an address, not the definition. Since
// declarations don't have an address, this always does
// an extra lookup for definitions of declarations.
//
// The extra lookup is redundant for normal definitions,
// but we actually need it in the case that the
// definition is an abstract instance root (so we need
// to go from declaration -> abstract instance root ->
// concrete instance). Avoiding redundant lookups would
// require storing an extra flag in the specification
// map, which empirically isn't worth it.
if (insn & INSN_DIE_FLAG_SUBPROGRAM_NO_PC) {
drgn_dwarf_find_definition(dbinfo, die_addr,
&die_addr);
}
if (!index_die(map, base_types, name, tag, die_addr))
return &drgn_enomem;
}
next:;
unsigned int orig_depth = buffer->depth;
if (insn & INSN_DIE_FLAG_CHILDREN) {
// We descend into a DIE's children in these cases:
// 1. The DIE doesn't have a sibling pointer, in which
// case we have no choice.
// 2. The DIE is the unit or namespace that we're
// indexing.
// 3. The DIE is a top-level enumeration_type DIE, so we
// want to index its children enumerator DIEs.
// In cases 2 and 3, we ignore the DIE's sibling pointer
// if it has one.
//
// Otherwise, we skip over the DIE's children by
// following the sibling pointer.
if (!sibling
|| buffer->depth == 0
|| (buffer->depth == 1 && tag == DRGN_DWARF_INDEX_enumeration_type))
buffer->depth++;
else
buffer->bb.pos = sibling;
} else if (buffer->depth == 0) {
goto pop;
}
// Each buffer actually has two depths: the physical depth in
// the file of the current DIE relative to where the buffer was
// initialized (either the partial unit that we imported or the
// unit or namespace DIE where we started indexing), and the
// logical depth, treating the children of a partial unit as if
// they were siblings of the imported_unit DIE. Therefore, the
// logical depth of the children of a partial unit is equal to
// the logical depth of the imported_unit DIE, and the logical
// depth of the partial unit itself is the logical depth of the
// imported_unit DIE minus 1.
//
// Other than enumerator DIEs, we only index DIEs at logical
// depth 1. We assume that partial units will not have top-level
// enumerator DIEs, or alternatively that an enumeration_type
// DIE will not have an imported_unit DIE child.
//
// imported_unit DIEs at logical depth > 1 can only contain DIEs
// at logical depth > 1, which we would ignore anyways.
// imported_unit DIEs at depth 0 are malformed. Therefore, we
// only follow imported_unit DIEs at logical depth 1 and ignore
// others.
//
// This lets us avoid tracking the depth and logical depth
// separately: since we only follow imports at logical depth 1,
// depth == logical depth.
//
// If our assumption about enumerator DIEs is incorrect, then we
// will need to track depth and logical depth separately, update
// everything to use the appropriate one, and also take imports
// into account for depth1_{tag,addr}.
if (tag == INSN_DIE_TAG_imported_unit && orig_depth == 1) {
if (!specification) {
return binary_buffer_error(&buffer->bb,
"DW_TAG_imported_unit is missing DW_AT_import");
}
cu = drgn_dwarf_index_find_cu(&cu->file->module->prog->dbinfo,
(uintptr_t)specification);
if (!cu) {
return binary_buffer_error(&buffer->bb,
"imported unit not found");
}
if (drgn_dwarf_index_cu_buffer_stack_size(stack)
>= MAX_IMPORTED_UNIT_DEPTH) {
return binary_buffer_error(&buffer->bb,
"maximum DWARF imported unit depth exceeded");
}
buffer = drgn_dwarf_index_cu_buffer_stack_append_entry(stack);
if (!buffer)
return &drgn_enomem;
drgn_dwarf_index_cu_buffer_init(buffer, cu);
buffer->bb.pos = specification;
}
}
return NULL;
}
static inline int drgn_dwarf_index_cu_lookup_cmp(const void *_a, const void *_b)
{
uintptr_t a = ((struct drgn_dwarf_index_cu_lookup *)_a)->buf;
uintptr_t b = ((struct drgn_dwarf_index_cu_lookup *)_b)->buf;
return (a > b) - (a < b);
}
static void
drgn_dwarf_index_cus_merge_partial(struct drgn_dwarf_index_cu_vector *dst,
struct drgn_dwarf_index_cu_vector *src_partial,
size_t *partial_pos)
{
if (!drgn_dwarf_index_cu_vector_empty(src_partial)) {
memcpy(drgn_dwarf_index_cu_vector_at(dst, *partial_pos),
drgn_dwarf_index_cu_vector_begin(src_partial),
drgn_dwarf_index_cu_vector_size(src_partial)
* sizeof(struct drgn_dwarf_index_cu));
*partial_pos += drgn_dwarf_index_cu_vector_size(src_partial);
}
drgn_dwarf_index_cu_vector_deinit(src_partial);
}
static void
drgn_dwarf_index_cus_merge(struct drgn_dwarf_index_cu_vector *dst,
struct drgn_dwarf_index_cu_vector *src,
struct drgn_dwarf_index_cu_vector *src_partial,
size_t *pos, size_t *partial_pos)
{
if (!drgn_dwarf_index_cu_vector_empty(src)) {
memcpy(drgn_dwarf_index_cu_vector_at(dst, *pos),
drgn_dwarf_index_cu_vector_begin(src),
drgn_dwarf_index_cu_vector_size(src)
* sizeof(struct drgn_dwarf_index_cu));
*pos += drgn_dwarf_index_cu_vector_size(src);
}
drgn_dwarf_index_cu_vector_deinit(src);
drgn_dwarf_index_cus_merge_partial(dst, src_partial, partial_pos);
}
// If there wasn't already an error, merge src into dst, and return an error if
// that fails. If there was already an error, return the original error. Free
// src whether or not there was an error.
static struct drgn_error *
drgn_dwarf_specification_map_merge(struct drgn_dwarf_specification_map *dst,
struct drgn_dwarf_specification_map *src,
struct drgn_error *err)
{
if (!err) {
hash_table_for_each(drgn_dwarf_specification_map, it, src) {
if (drgn_dwarf_specification_map_insert(dst, it.entry,
NULL) < 0) {
err = &drgn_enomem;
break;
}
}
}
drgn_dwarf_specification_map_deinit(src);
return err;
}
static struct drgn_error *
drgn_dwarf_index_die_map_merge(struct drgn_dwarf_index_die_map *dst,
struct drgn_dwarf_index_die_map *src,
struct drgn_error *err)
{
auto src_it = drgn_dwarf_index_die_map_first(src);
for (; !err && src_it.entry;
src_it = drgn_dwarf_index_die_map_next(src_it)) {
struct drgn_dwarf_index_die_vector *src_vector =
&src_it.entry->value;
struct hash_pair hp =
drgn_dwarf_index_die_map_hash(&src_it.entry->key);
auto dst_it = drgn_dwarf_index_die_map_search_hashed(dst,
&src_it.entry->key,
hp);
// If dst already has the key, extend its vector with
// src_vector, and free src_vector. Otherwise, move src_vector
// into dst.
if (dst_it.entry) {
if (!drgn_dwarf_index_die_vector_extend(&dst_it.entry->value,
src_vector))
err = &drgn_enomem;
} else if (drgn_dwarf_index_die_map_insert_searched(dst,
src_it.entry,
hp,
NULL) < 0) {
err = &drgn_enomem;
} else {
// We stole src_vector; don't free it.
continue;
}
drgn_dwarf_index_die_vector_deinit(src_vector);
}
for (; src_it.entry; src_it = drgn_dwarf_index_die_map_next(src_it))
drgn_dwarf_index_die_vector_deinit(&src_it.entry->value);
drgn_dwarf_index_die_map_deinit(src);
return err;
}
static struct drgn_error *
drgn_dwarf_base_type_map_merge(struct drgn_dwarf_base_type_map *dst,
struct drgn_dwarf_base_type_map *src,
struct drgn_error *err)
{
if (!err) {
hash_table_for_each(drgn_dwarf_base_type_map, it, src) {
if (drgn_dwarf_base_type_map_insert(dst, it.entry, NULL)
< 0) {
err = &drgn_enomem;
break;
}
}
}
drgn_dwarf_base_type_map_deinit(src);
return err;
}
static struct drgn_error *
drgn_dwarf_index_update(struct drgn_debug_info *dbinfo)
{
if (!dbinfo->modules_pending_indexing)
return NULL;
if (dbinfo->dwarf.global.saved_err)
return drgn_error_copy(dbinfo->dwarf.global.saved_err);
drgn_init_num_threads();
// Gather linked list of modules into a vector that we can parallelize.
VECTOR(drgn_module_vector, modules);
{
struct drgn_module *module = dbinfo->modules_pending_indexing;
do {
if (!drgn_module_vector_append(&modules, &module))
return &drgn_enomem;
module = module->pending_indexing_next;
} while (module);
}
// Per-thread structures to populate. Thread 0 uses the structures in
// the dbinfo directly. These are merged into the dbinfo and freed.
_cleanup_free_ union {
// For reading modules.
struct {
struct drgn_dwarf_index_cu_vector cus;
struct drgn_dwarf_index_cu_vector partial_units;
};
// For first pass.
struct drgn_dwarf_specification_map specifications;
// For second pass.
struct {
struct drgn_dwarf_index_die_map map[DRGN_DWARF_INDEX_MAP_SIZE];
struct drgn_dwarf_base_type_map base_types;
};
} *threads = NULL;
if (drgn_num_threads > 1) {
threads = malloc_array(drgn_num_threads - 1, sizeof(threads[0]));
if (!threads)
return &drgn_enomem;
}
// Thread 0 needs its own temporary partial_units vector.
struct drgn_dwarf_index_cu_vector partial_units0;
struct drgn_error *err = NULL;
size_t new_cus_size;
#pragma omp parallel num_threads(drgn_num_threads)
{
struct drgn_error *thread_err = NULL;
int thread_num = omp_get_thread_num();
// Enumerate CUs in new modules.
struct drgn_dwarf_index_cu_vector *cus, *partial_units;
if (thread_num == 0) {
cus = &dbinfo->dwarf.index_cus;
partial_units = &partial_units0;
} else {
cus = &threads[thread_num - 1].cus;
partial_units = &threads[thread_num - 1].partial_units;
drgn_dwarf_index_cu_vector_init(cus);
}
drgn_dwarf_index_cu_vector_init(partial_units);
#pragma omp for schedule(dynamic) nowait
for (size_t i = 0; i < drgn_module_vector_size(&modules); i++) {
if (thread_err)
continue;
struct drgn_module *module =
*drgn_module_vector_at(&modules, i);
thread_err =
drgn_dwarf_index_read_file(module->debug_file,
cus, partial_units);
}
if (thread_err) {
#pragma omp critical(drgn_dwarf_info_update_index_error)
if (err)
drgn_error_destroy(thread_err);
else
err = thread_err;
thread_err = NULL;
}
#pragma omp barrier
// Merge the per-thread CUs into dbinfo (and free them). Partial
// units are placed at the end and excluded from new_cus_size so
// that they are not indexed.
#pragma omp master
{
if (!err) {
size_t cus_pos = new_cus_size =
drgn_dwarf_index_cu_vector_size(&dbinfo->dwarf.index_cus);
size_t new_partial_units =
drgn_dwarf_index_cu_vector_size(&partial_units0);
for (int i = 0; i < drgn_num_threads - 1; i++) {
new_cus_size += drgn_dwarf_index_cu_vector_size(&threads[i].cus);
new_partial_units += drgn_dwarf_index_cu_vector_size(&threads[i].partial_units);
}
if (new_cus_size + new_partial_units
> dbinfo->dwarf.global.cus_indexed) {
if (drgn_dwarf_index_cu_vector_resize(&dbinfo->dwarf.index_cus,
new_cus_size
+ new_partial_units)) {
size_t partial_pos = new_cus_size;
drgn_dwarf_index_cus_merge_partial(&dbinfo->dwarf.index_cus,
&partial_units0,
&partial_pos);
for (int i = 0; i < drgn_num_threads - 1; i++) {
drgn_dwarf_index_cus_merge(&dbinfo->dwarf.index_cus,
&threads[i].cus,
&threads[i].partial_units,
&cus_pos,
&partial_pos);
}
} else {
err = &drgn_enomem;
}
}
}
if (err) {
for (int i = 0; i < drgn_num_threads - 1; i++) {
drgn_dwarf_index_cu_vector_deinit(&threads[i].partial_units);
drgn_dwarf_index_cu_vector_deinit(&threads[i].cus);
}
drgn_dwarf_index_cu_vector_deinit(&partial_units0);
// If there was an error, we'd like to avoid
// doing any more work, but we can't break out
// of an OpenMP parallel region. Set the number
// of CUs to the old number so the remaining
// loops are essentially no-ops.
new_cus_size = dbinfo->dwarf.global.cus_indexed;
drgn_dwarf_index_cu_vector_resize(&dbinfo->dwarf.index_cus,
new_cus_size);
}
}
#pragma omp barrier
// Update the CU lookup table. This can be done by one thread in
// parallel with reading CUs.
#pragma omp master
if (drgn_dwarf_index_cu_vector_size(&dbinfo->dwarf.index_cus)
> dbinfo->dwarf.global.cus_indexed) {
struct drgn_dwarf_index_cu_lookup *lookup =
realloc_array(dbinfo->dwarf.index_cu_lookup,
drgn_dwarf_index_cu_vector_size(&dbinfo->dwarf.index_cus),
sizeof(lookup[0]));
if (lookup) {
dbinfo->dwarf.index_cu_lookup = lookup;
for (size_t i = dbinfo->dwarf.global.cus_indexed;
i < drgn_dwarf_index_cu_vector_size(&dbinfo->dwarf.index_cus);
i++) {
struct drgn_dwarf_index_cu *cu =
drgn_dwarf_index_cu_vector_at(&dbinfo->dwarf.index_cus, i);
lookup[i].buf = (uintptr_t)cu->buf;
lookup[i].index = i;
}
qsort(lookup,
drgn_dwarf_index_cu_vector_size(&dbinfo->dwarf.index_cus),
sizeof(lookup[0]),
drgn_dwarf_index_cu_lookup_cmp);
} else {
thread_err = &drgn_enomem;
}
}
// Read the abbreviation tables of new CUs.
#pragma omp for schedule(dynamic) nowait
for (size_t i = dbinfo->dwarf.global.cus_indexed;
i < drgn_dwarf_index_cu_vector_size(&dbinfo->dwarf.index_cus);
i++) {
if (thread_err)
continue;
struct drgn_dwarf_index_cu *cu =
drgn_dwarf_index_cu_vector_at(&dbinfo->dwarf.index_cus, i);
thread_err = read_cu(cu);
}
if (thread_err) {
#pragma omp critical(drgn_dwarf_info_update_index_error)
{
if (err)
drgn_error_destroy(thread_err);
else
err = thread_err;
// Same error handling trick as above, except
// that we can't resize the vector anymore for a
// couple of reasons: the CUs now need to be
// properly deinitialized by
// drgn_dwarf_index_cu_deinit(), and we can't
// change the iteration count of the above loop
// while it is running on other threads.
new_cus_size = dbinfo->dwarf.global.cus_indexed;
}
thread_err = NULL;
}
#pragma omp barrier
// Do the first indexing pass.
struct drgn_dwarf_specification_map *specifications;
if (thread_num == 0) {
specifications = &dbinfo->dwarf.specifications;
} else {
specifications = &threads[thread_num - 1].specifications;
drgn_dwarf_specification_map_init(specifications);
}
VECTOR(drgn_dwarf_index_cu_buffer_stack, buffer_stack);
#pragma omp for schedule(dynamic) nowait
for (size_t i = dbinfo->dwarf.global.cus_indexed;
i < new_cus_size; i++) {
if (thread_err)
continue;
struct drgn_dwarf_index_cu *cu =
drgn_dwarf_index_cu_vector_at(&dbinfo->dwarf.index_cus, i);
drgn_dwarf_index_cu_buffer_stack_clear(&buffer_stack);
struct drgn_dwarf_index_cu_buffer *buffer =
drgn_dwarf_index_cu_buffer_stack_append_entry(&buffer_stack);
drgn_dwarf_index_cu_buffer_init(buffer, cu);
buffer->bb.pos += cu_header_size(cu);
thread_err = index_cu_first_pass(specifications,
&buffer_stack);
}
if (thread_err) {
#pragma omp critical(drgn_dwarf_info_update_index_error)
if (err)
drgn_error_destroy(thread_err);
else
err = thread_err;
thread_err = NULL;
}
#pragma omp barrier
// Merge the per-thread specification maps into dbinfo (and free
// them).
#pragma omp master
{
for (int i = 0; i < drgn_num_threads - 1; i++) {
err = drgn_dwarf_specification_map_merge(&dbinfo->dwarf.specifications,
&threads[i].specifications,
err);
}
// Same error handling trick as above.
if (err)
new_cus_size = dbinfo->dwarf.global.cus_indexed;
}
#pragma omp barrier
// Do the second indexing pass.
struct drgn_dwarf_index_die_map *map;
struct drgn_dwarf_base_type_map *base_types;
if (thread_num == 0) {
map = dbinfo->dwarf.global.map;
base_types = &dbinfo->dwarf.base_types;
} else {
array_for_each(tag_map, threads[thread_num - 1].map)
drgn_dwarf_index_die_map_init(tag_map);
map = threads[thread_num - 1].map;
base_types = &threads[thread_num - 1].base_types;
drgn_dwarf_base_type_map_init(base_types);
}
#pragma omp for schedule(dynamic)
for (size_t i = dbinfo->dwarf.global.cus_indexed;
i < new_cus_size; i++) {
if (thread_err)
continue;
struct drgn_dwarf_index_cu *cu =
drgn_dwarf_index_cu_vector_at(&dbinfo->dwarf.index_cus, i);
drgn_dwarf_index_cu_buffer_stack_clear(&buffer_stack);
struct drgn_dwarf_index_cu_buffer *buffer =
drgn_dwarf_index_cu_buffer_stack_append_entry(&buffer_stack);
drgn_dwarf_index_cu_buffer_init(buffer, cu);
buffer->bb.pos += cu_header_size(cu);
thread_err = index_cu_second_pass(dbinfo, map,
base_types,
&buffer_stack);
}
// Merge the per-thread DIE and base type maps into dbinfo (and
// free them).
#pragma omp for schedule(dynamic) nowait
for (size_t i = 0; i <= array_size(dbinfo->dwarf.global.map); i++) {
if (i < array_size(dbinfo->dwarf.global.map)) {
for (int j = 0; j < drgn_num_threads - 1; j++) {
thread_err =
drgn_dwarf_index_die_map_merge(&dbinfo->dwarf.global.map[i],
&threads[j].map[i],
thread_err);
}
} else {
for (int j = 0; j < drgn_num_threads - 1; j++) {
thread_err =
drgn_dwarf_base_type_map_merge(&dbinfo->dwarf.base_types,
&threads[j].base_types,
thread_err);
}
}
}
if (thread_err) {
#pragma omp critical(drgn_dwarf_info_update_index_error)
if (err)
drgn_error_destroy(thread_err);
else
err = thread_err;
}
}
if (err) {
dbinfo->dwarf.global.saved_err = err;
return drgn_error_copy(err);
}
dbinfo->modules_pending_indexing = NULL;
dbinfo->dwarf.global.cus_indexed =
drgn_dwarf_index_cu_vector_size(&dbinfo->dwarf.index_cus);
return NULL;
}
static struct drgn_error *index_namespace_impl(struct drgn_namespace_dwarf_index *ns)
{
struct drgn_error *err;
size_t num_index_cus =
drgn_dwarf_index_cu_vector_size(&ns->dbinfo->dwarf.index_cus);
if (ns->cus_indexed >= num_index_cus)
return NULL;
if (ns->saved_err)
return drgn_error_copy(ns->saved_err);
// The parent namespace must be indexed first so that the DIEs for this
// namespace are populated.
err = index_namespace_impl(ns->parent);
if (err)
return err;
struct drgn_dwarf_index_die_vector
*die_vectors_to_index[DRGN_DWARF_INDEX_NUM_NAMESPACE_TAGS];
int tags_to_index[DRGN_DWARF_INDEX_NUM_NAMESPACE_TAGS];
int num_tags_to_index = 0;
struct nstring key = { ns->name, ns->name_len };
struct hash_pair hp = drgn_dwarf_index_die_map_hash(&key);
for (int i = 0; i < DRGN_DWARF_INDEX_NUM_NAMESPACE_TAGS; i++) {
auto it = drgn_dwarf_index_die_map_search_hashed(&ns->parent->map[i],
&key, hp);
if (!it.entry)
continue;
struct drgn_dwarf_index_die_vector *dies = &it.entry->value;
if (ns->dies_indexed[i]
>= drgn_dwarf_index_die_vector_size(dies))
continue;
die_vectors_to_index[num_tags_to_index] = dies;
tags_to_index[num_tags_to_index] = i;
num_tags_to_index++;
}
if (num_tags_to_index == 0) {
ns->cus_indexed = num_index_cus;
return NULL;
}
_cleanup_free_ struct drgn_dwarf_index_die_map
(*maps)[DRGN_DWARF_INDEX_MAP_SIZE] = NULL;
if (drgn_num_threads > 1) {
maps = malloc_array(drgn_num_threads - 1, sizeof(maps[0]));
if (!maps)
return &drgn_enomem;
}
err = NULL;
#pragma omp parallel num_threads(drgn_num_threads)
{
struct drgn_error *thread_err = NULL;
struct drgn_dwarf_index_die_map *map;
int thread_num = omp_get_thread_num();
if (thread_num == 0) {
map = ns->map;
} else {
array_for_each(tag_map, maps[thread_num - 1])
drgn_dwarf_index_die_map_init(tag_map);
map = maps[thread_num - 1];
}
VECTOR(drgn_dwarf_index_cu_buffer_stack, buffer_stack);
for (int i = 0; i < num_tags_to_index; i++) {
struct drgn_dwarf_index_die_vector *dies =
die_vectors_to_index[i];
#pragma omp for schedule(dynamic) nowait
for (uint32_t j = ns->dies_indexed[tags_to_index[i]];
j < drgn_dwarf_index_die_vector_size(dies); j++) {
if (thread_err)
continue;
uintptr_t die_addr =
*drgn_dwarf_index_die_vector_at(dies, j);
struct drgn_dwarf_index_cu *cu =
drgn_dwarf_index_find_cu(ns->dbinfo, die_addr);
drgn_dwarf_index_cu_buffer_stack_clear(&buffer_stack);
struct drgn_dwarf_index_cu_buffer *buffer =
drgn_dwarf_index_cu_buffer_stack_append_entry(&buffer_stack);
drgn_dwarf_index_cu_buffer_init(buffer, cu);
buffer->bb.pos = (void *)die_addr;
thread_err = index_cu_second_pass(ns->dbinfo,
map, NULL,
&buffer_stack);
}
}
#pragma omp barrier
#pragma omp for schedule(dynamic) nowait
for (size_t i = 0; i < array_size(ns->map); i++) {
for (int j = 0; j < drgn_num_threads - 1; j++) {
thread_err =
drgn_dwarf_index_die_map_merge(&ns->map[i],
&maps[j][i],
thread_err);
}
}
if (thread_err) {
#pragma omp critical(drgn_index_namespace_error)
if (err)
drgn_error_destroy(thread_err);
else
err = thread_err;
}
}
if (err) {
ns->saved_err = err;
return drgn_error_copy(ns->saved_err);
}
ns->cus_indexed = num_index_cus;
for (int i = 0; i < num_tags_to_index; i++) {
ns->dies_indexed[tags_to_index[i]] =
drgn_dwarf_index_die_vector_size(die_vectors_to_index[i]);
}
return NULL;
}
static struct drgn_error *index_namespace(struct drgn_namespace_dwarf_index *ns)
{
if (!ns->dbinfo->modules_pending_indexing
&& (ns->cus_indexed
>= drgn_dwarf_index_cu_vector_size(&ns->dbinfo->dwarf.index_cus)))
return NULL;
drgn_blocking_guard(blocking_state);
struct drgn_error *err = drgn_dwarf_index_update(ns->dbinfo);
if (err)
return err;
return index_namespace_impl(ns);
}
struct drgn_error *drgn_dwarf_info_update_index(struct drgn_debug_info *dbinfo)
{
return index_namespace(&dbinfo->dwarf.global);
}
/**
* Iterator over DWARF debugging information.
*
* An iterator is initialized with @ref drgn_dwarf_index_iterator_init(). It is
* advanced with @ref drgn_dwarf_index_iterator_next().
*/
struct drgn_dwarf_index_iterator {
struct drgn_namespace_dwarf_index *ns;
const char *name;
size_t name_len;
const enum drgn_dwarf_index_tag *tags;
size_t num_tags;
struct drgn_dwarf_index_die_vector *dies;
uint32_t index;
};
/**
* Create an iterator over DIEs in a DWARF index namespace.
*
* @param[out] it DWARF index iterator to initialize.
* @param[in] ns Namespace DWARF index.
* @param[in] name Name of DIE to search for.
* @param[in] name_len Length of @c name.
* @param[in] tags List of DIE tags to search for.
* @param[in] num_tags Number of tags in @p tags, or zero to search for any tag.
* @return @c NULL on success, non-@c NULL on error.
*/
static struct drgn_error *
drgn_dwarf_index_iterator_init(struct drgn_dwarf_index_iterator *it,
struct drgn_namespace_dwarf_index *ns,
const char *name, size_t name_len,
const enum drgn_dwarf_index_tag *tags,
size_t num_tags)
{
struct drgn_error *err = index_namespace(ns);
if (err)
return err;
it->ns = ns;
it->name = name;
it->name_len = name_len;
it->tags = tags;
it->num_tags = num_tags;
// Sentinel to simplify first iteration.
static const struct drgn_dwarf_index_die_vector empty_dies = VECTOR_INIT;
it->dies = (struct drgn_dwarf_index_die_vector *)&empty_dies;
it->index = 0;
return NULL;
}
/**
* Get the next matching DIE from a DWARF index iterator.
*
* Note the quirks in @ref drgn_namespace_dwarf_index::map about
* `DW_TAG_enumerator` and `DW_TAG_namespace`.
*
* @param[in] it DWARF index iterator.
* @param[out] die_ret Returned DIE.
* @param[out] file_ret If not @c NULL, returned file that DIE came from.
* @return @c true on success, @c false if there are no more matching DIEs.
*/
static bool
drgn_dwarf_index_iterator_next(struct drgn_dwarf_index_iterator *it,
Dwarf_Die *die_ret,
struct drgn_elf_file **file_ret)
{
uintptr_t die_addr;
if (it->index < drgn_dwarf_index_die_vector_size(it->dies)) {
die_addr = *drgn_dwarf_index_die_vector_at(it->dies,
it->index++);
} else {
for (;;) {
if (it->num_tags == 0)
return false;
int tag = *it->tags++;
it->num_tags--;
if (tag == DRGN_DWARF_INDEX_base_type) {
// Only look up base types in the global
// namespace.
if (it->ns->parent)
continue;
struct nstring key = { it->name, it->name_len };
auto map_it = drgn_dwarf_base_type_map_search(&it->ns->dbinfo->dwarf.base_types,
&key);
if (map_it.entry) {
die_addr = map_it.entry->value;
break;
}
} else {
struct nstring key = { it->name, it->name_len };
auto map_it =
drgn_dwarf_index_die_map_search(&it->ns->map[tag],
&key);
if (map_it.entry) {
die_addr = *drgn_dwarf_index_die_vector_first(&map_it.entry->value);
it->dies = &map_it.entry->value;
it->index = 1;
break;
}
}
}
}
struct drgn_dwarf_index_cu *cu =
drgn_dwarf_index_find_cu(it->ns->dbinfo, die_addr);
*die_ret = (Dwarf_Die){
.addr = (void *)die_addr,
.cu = cu->libdw_cu,
};
if (file_ret)
*file_ret = cu->file;
return true;
}
static struct drgn_error *
drgn_namespace_find_child(struct drgn_namespace_dwarf_index *ns,
const char *name, size_t name_len,
struct drgn_namespace_dwarf_index **ret)
{
struct drgn_error *err = index_namespace(ns);
if (err)
return err;
struct nstring key = { name, name_len };
struct hash_pair hp = nstring_hash_pair(&key);
auto it = drgn_namespace_table_search_hashed(&ns->children, &key, hp);
if (it.entry) {
*ret = *it.entry;
return NULL;
}
for (int i = 0; i < DRGN_DWARF_INDEX_NUM_NAMESPACE_TAGS; i++) {
auto die_it =
drgn_dwarf_index_die_map_search_hashed(&ns->map[i],
&key, hp);
if (die_it.entry) {
struct drgn_namespace_dwarf_index *new_ns =
malloc(sizeof(*new_ns));
if (!new_ns)
return &drgn_enomem;
// Use the name from the DIE map, which has the same
// lifetime as the namespace table.
drgn_namespace_dwarf_index_init(new_ns,
die_it.entry->key.str,
die_it.entry->key.len,
ns);
if (drgn_namespace_table_insert_searched(&ns->children,
&new_ns, hp,
NULL) < 0) {
drgn_namespace_dwarf_index_deinit(new_ns);
free(new_ns);
return &drgn_enomem;
}
*ret = new_ns;
return NULL;
}
}
return &drgn_not_found;
}
/*
* Language support.
*/
/**
* Return the @ref drgn_language of the CU of the given DIE.
*
* @param[in] fall_back Whether to fall back if the language is not found or
* unknown. If @c true, @ref drgn_default_language is returned in this case. If
* @c false, @c NULL is returned.
* @param[out] ret Returned language.
* @return @c NULL on success, non-@c NULL on error.
*/
static struct drgn_error *drgn_language_from_die(Dwarf_Die *die, bool fall_back,
const struct drgn_language **ret)
{
Dwarf_Die cudie;
if (!dwarf_cu_die(die->cu, &cudie, NULL, NULL, NULL, NULL, NULL, NULL))
return drgn_error_libdw();
switch (dwarf_srclang(&cudie)) {
case DW_LANG_C:
case DW_LANG_C89:
case DW_LANG_C99:
case DW_LANG_C11:
*ret = &drgn_language_c;
break;
case DW_LANG_C_plus_plus:
case DW_LANG_C_plus_plus_03:
case DW_LANG_C_plus_plus_11:
case DW_LANG_C_plus_plus_14:
*ret = &drgn_language_cpp;
break;
default:
*ret = fall_back ? &drgn_default_language : NULL;
break;
}
return NULL;
}
const struct drgn_language *
drgn_debug_info_main_language(struct drgn_debug_info *dbinfo)
{
struct drgn_error *err;
struct drgn_dwarf_index_iterator it;
const enum drgn_dwarf_index_tag tag = DRGN_DWARF_INDEX_subprogram;
err = drgn_dwarf_index_iterator_init(&it, &dbinfo->dwarf.global, "main",
strlen("main"), &tag, 1);
if (err) {
drgn_error_destroy(err);
return NULL;
}
Dwarf_Die die;
while (drgn_dwarf_index_iterator_next(&it, &die, NULL)) {
const struct drgn_language *lang;
err = drgn_language_from_die(&die, false, &lang);
if (err) {
drgn_error_destroy(err);
continue;
}
if (lang)
return lang;
}
return NULL;
}
/*
* DIE iteration.
*/
DEFINE_VECTOR(dwarf_die_vector, Dwarf_Die);
/** Iterator over DWARF DIEs in a @ref drgn_module. */
struct drgn_dwarf_die_iterator {
/** Stack of current DIE and its ancestors. */
struct dwarf_die_vector dies;
/**
* Dwarf handle that we're iterating over. For split DWARF, this is the
* main file.
*/
Dwarf *dwarf;
/**
* End of current CU (for bounds checking). For split DWARF, this is in
* the split file.
*/
const char *cu_end;
/** Offset of next CU. For split DWARF, this is in the main file. */
Dwarf_Off next_cu_off;
/** Whether current CU is from .debug_types. */
bool debug_types;
};
static void drgn_dwarf_die_iterator_init(struct drgn_dwarf_die_iterator *it,
Dwarf *dwarf)
{
dwarf_die_vector_init(&it->dies);
it->dwarf = dwarf;
it->next_cu_off = 0;
it->debug_types = false;
}
static void drgn_dwarf_die_iterator_deinit(struct drgn_dwarf_die_iterator *it)
{
dwarf_die_vector_deinit(&it->dies);
}
/**
* Return the next DWARF DIE in a @ref drgn_dwarf_die_iterator.
*
* The first call returns the top-level DIE for the first unit in the module.
* Subsequent calls return children, siblings, and unit DIEs.
*
* This includes the .debug_types section.
*
* @param[in,out] it Iterator containing the returned DIE and its ancestors. The
* last entry in `it->dies` is the DIE itself, the entry before that is its
* parent, the entry before that is its grandparent, etc.
* @param[in] children If @c true and the last returned DIE has children, return
* its first child (this is a pre-order traversal). Otherwise, return the next
* DIE at the level less than or equal to the last returned DIE, i.e., the last
* returned DIE's sibling, or its ancestor's sibling, or the next top-level unit
* DIE.
* @param[in] subtree If zero, iterate over all DIEs in all units. If non-zero,
* stop after returning all DIEs in the subtree rooted at the DIE that was
* returned in the last call as entry `subtree - 1` in `it->dies`.
* @return @c NULL on success, `&drgn_stop` if there are no more DIEs, in which
* case the size of `it->dies` equals @p subtree and `it->dies` refers to the
* root of the iterated subtree, non-@c NULL on error, in which case this should
* not be called again.
*/
static struct drgn_error *
drgn_dwarf_die_iterator_next(struct drgn_dwarf_die_iterator *it, bool children,
size_t subtree)
{
#define TOP() (dwarf_die_vector_last(&it->dies))
int r;
Dwarf_Die die;
assert(subtree <= dwarf_die_vector_size(&it->dies));
if (dwarf_die_vector_empty(&it->dies)) {
/* This is the first call. Get the first unit DIE. */
if (!dwarf_die_vector_append_entry(&it->dies))
return &drgn_enomem;
} else {
if (children) {
r = dwarf_child(TOP(), &die);
if (r == 0) {
/* The previous DIE has a child. Return it. */
if (!dwarf_die_vector_append(&it->dies, &die))
return &drgn_enomem;
return NULL;
} else if (r < 0) {
return drgn_error_libdw();
}
/* The previous DIE has no children. */
}
if (dwarf_die_vector_size(&it->dies) == subtree) {
/*
* The previous DIE is the root of the subtree. We're
* done.
*/
return &drgn_stop;
}
if (dwarf_die_vector_size(&it->dies) > 1) {
r = dwarf_siblingof(TOP(), &die);
if (r == 0) {
/* The previous DIE has a sibling. Return it. */
*TOP() = die;
return NULL;
} else if (r > 0) {
if (!die.addr)
goto next_unit;
/*
* The previous DIE is the last child of its
* parent.
*/
char *addr = die.addr;
do {
/*
* addr points to the null terminator
* for the list of siblings. Go back up
* to its parent. The next byte is
* either the parent's sibling or
* another null terminator.
*/
dwarf_die_vector_pop(&it->dies);
addr++;
if (dwarf_die_vector_size(&it->dies)
== subtree) {
/*
* We're back to the root of the
* subtree. We're done.
*/
return &drgn_stop;
}
if (dwarf_die_vector_size(&it->dies) == 1
|| addr >= it->cu_end)
goto next_unit;
} while (*addr == '\0');
/*
* addr now points to the next DIE. Return it.
*/
*TOP() = (Dwarf_Die){
.cu = dwarf_die_vector_first(&it->dies)->cu,
.addr = addr,
};
return NULL;
} else {
return drgn_error_libdw();
}
}
}
next_unit:;
/* There are no more DIEs in the current unit. */
Dwarf_Off cu_off = it->next_cu_off;
size_t cu_header_size;
uint64_t type_signature;
r = dwarf_next_unit(it->dwarf, cu_off, &it->next_cu_off,
&cu_header_size, NULL, NULL, NULL, NULL,
it->debug_types ? &type_signature : NULL, NULL);
if (r == 0) {
/* Got the next unit. Return the unit DIE. */
Dwarf_Off offset = cu_off + cu_header_size;
if (it->debug_types)
r = !dwarf_offdie_types(it->dwarf, offset, TOP());
else
r = !dwarf_offdie(it->dwarf, offset, TOP());
if (r)
return drgn_error_libdw();
Dwarf_Off cu_end_off = it->next_cu_off;
#if _ELFUTILS_PREREQ(0, 171)
// If the unit is a skeleton, replace it with the split unit.
Dwarf_Die subdie;
uint8_t unit_type;
if (dwarf_cu_info(TOP()->cu, NULL, &unit_type, NULL, &subdie,
NULL, NULL, NULL))
return drgn_error_libdw();
if (unit_type == DW_UT_skeleton && subdie.cu) {
offset = dwarf_dieoffset(&subdie);
if (dwarf_next_unit(dwarf_cu_getdwarf(subdie.cu),
offset - dwarf_cuoffset(&subdie),
&cu_end_off, NULL, NULL, NULL, NULL,
NULL, NULL, NULL))
return drgn_error_libdw();
*TOP() = subdie;
}
#endif
it->cu_end = ((const char *)TOP()->addr
- offset
+ cu_end_off);
return NULL;
} else if (r > 0) {
// Note that in split DWARF, there are no skeleton units for
// type units, and the main file doesn't have a .debug_types
// section. Instead, the split files contain a .debug_types.dwo
// section per type unit. elfutils as of 0.189 doesn't support
// multiple sections with the same name, so we don't support
// type units with split DWARF.
if (!it->debug_types) {
it->next_cu_off = 0;
it->debug_types = true;
goto next_unit;
}
/* There are no more units. */
dwarf_die_vector_pop(&it->dies);
return &drgn_stop;
} else {
return drgn_error_libdw();
}
#undef TOP
}
struct drgn_error *drgn_module_find_dwarf_scopes(struct drgn_module *module,
uint64_t pc,
uint64_t *bias_ret,
Dwarf_Die **dies_ret,
size_t *length_ret)
{
struct drgn_error *err;
if (!module->debug_file) {
*bias_ret = 0;
*dies_ret = NULL;
*length_ret = 0;
return NULL;
}
Dwarf *dwarf;
err = drgn_elf_file_get_dwarf(module->debug_file, &dwarf);
if (err)
return err;
*bias_ret = module->debug_file_bias;
pc -= module->debug_file_bias;
/* First, try to get the CU containing the PC. */
Dwarf_Aranges *aranges;
size_t naranges;
if (dwarf_getaranges(dwarf, &aranges, &naranges) < 0)
return drgn_error_libdw();
_cleanup_(drgn_dwarf_die_iterator_deinit)
struct drgn_dwarf_die_iterator it;
drgn_dwarf_die_iterator_init(&it, dwarf);
size_t subtree;
Dwarf_Off offset;
if (dwarf_getarangeinfo(dwarf_getarange_addr(aranges, pc), NULL, NULL,
&offset) >= 0) {
Dwarf_Die *cu_die = dwarf_die_vector_append_entry(&it.dies);
if (!cu_die)
return &drgn_enomem;
if (!dwarf_offdie(dwarf, offset, cu_die))
return drgn_error_libdw();
#if _ELFUTILS_PREREQ(0, 171)
// If the unit is a skeleton, replace it with the split unit.
Dwarf_Die subdie;
uint8_t unit_type;
if (dwarf_cu_info(cu_die->cu, NULL, &unit_type, NULL, &subdie,
NULL, NULL, NULL))
return drgn_error_libdw();
if (unit_type == DW_UT_skeleton && subdie.cu) {
dwarf = dwarf_cu_getdwarf(subdie.cu);
offset = dwarf_dieoffset(&subdie);
*cu_die = subdie;
}
#endif
if (dwarf_next_unit(dwarf, offset - dwarf_cuoffset(cu_die),
&it.next_cu_off, NULL, NULL, NULL, NULL,
NULL, NULL, NULL))
return drgn_error_libdw();
it.cu_end = ((const char *)cu_die->addr
- offset
+ it.next_cu_off);
subtree = 1;
} else {
/*
* Range was not found. .debug_aranges could be missing or
* incomplete, so fall back to checking each CU.
*/
subtree = 0;
}
/*
* Now find the most specific DIE containing the PC. Entry subtree - 1
* in it.dies is the most specific DIE we have found so far. We iterate
* over all of its children until we find a more specific DIE, then we
* descend into that one.
*
* We only want to descend into children DIEs when the last DIE
* contained the PC, which is when size(it.dies) == subtree.
*/
while (!(err = drgn_dwarf_die_iterator_next(&it,
dwarf_die_vector_size(&it.dies)
== subtree,
subtree))) {
int r = dwarf_haspc(dwarf_die_vector_last(&it.dies), pc);
if (r > 0) {
subtree = dwarf_die_vector_size(&it.dies);
} else if (r < 0) {
return drgn_error_libdw();
}
}
if (err != &drgn_stop)
return err;
dwarf_die_vector_steal(&it.dies, dies_ret, length_ret);
return NULL;
}
struct drgn_error *drgn_find_die_ancestors(Dwarf_Die *die, Dwarf_Die **dies_ret,
size_t *length_ret)
{
Dwarf *dwarf = dwarf_cu_getdwarf(die->cu);
if (!dwarf)
return drgn_error_libdw();
VECTOR(dwarf_die_vector, dies);
Dwarf_Die *cu_die = dwarf_die_vector_append_entry(&dies);
if (!cu_die)
return &drgn_enomem;
Dwarf_Half cu_version;
Dwarf_Off type_offset;
if (!dwarf_cu_die(die->cu, cu_die, &cu_version, NULL, NULL, NULL, NULL,
&type_offset))
return drgn_error_libdw();
Dwarf_Off cu_die_offset = dwarf_dieoffset(cu_die);
bool debug_types = cu_version == 4 && type_offset != 0;
Dwarf_Off next_cu_offset;
uint64_t type_signature;
if (dwarf_next_unit(dwarf, cu_die_offset - dwarf_cuoffset(cu_die),
&next_cu_offset, NULL, NULL, NULL, NULL, NULL,
debug_types ? &type_signature : NULL, NULL))
return drgn_error_libdw();
const unsigned char *cu_end =
(unsigned char *)cu_die->addr - cu_die_offset + next_cu_offset;
#define TOP() (dwarf_die_vector_last(&dies))
while ((char *)TOP()->addr <= (char *)die->addr) {
if (TOP()->addr == die->addr) {
dwarf_die_vector_steal(&dies, dies_ret, length_ret);
(*length_ret)--;
return NULL;
}
Dwarf_Attribute attr;
if (dwarf_attr(TOP(), DW_AT_sibling, &attr)) {
/* The top DIE has a DW_AT_sibling attribute. */
Dwarf_Die sibling;
if (!dwarf_formref_die(&attr, &sibling))
return drgn_error_libdw();
if (sibling.cu != TOP()->cu ||
(char *)sibling.addr <= (char *)TOP()->addr)
return drgn_error_create(DRGN_ERROR_OTHER,
"invalid DW_AT_sibling");
if ((char *)sibling.addr > (char *)die->addr) {
/*
* The top DIE's sibling is after the target
* DIE. Therefore, the target DIE must be a
* descendant of the top DIE.
*/
Dwarf_Die *child =
dwarf_die_vector_append_entry(&dies);
if (!child)
return &drgn_enomem;
int r = dwarf_child(TOP() - 1, child);
if (r < 0) {
return drgn_error_libdw();
} else if (r > 0) {
/*
* The top DIE didn't have any children,
* which should be impossible.
*/
goto not_found;
}
} else {
/*
* The top DIE's sibling is before or equal to
* the target DIE. Therefore, the target DIE
* isn't a descendant of the top DIE. Skip to
* the sibling.
*/
*TOP() = sibling;
}
} else {
/*
* The top DIE does not have a DW_AT_sibling attribute.
* Instead, we found the end of the top DIE.
*/
unsigned char *addr = attr.valp;
if (!addr || addr >= cu_end)
goto not_found;
/*
* If the top DIE has children, then addr is its first
* child. Otherwise, then addr is its sibling. (Unless
* it is a null terminator.)
*/
size_t new_size = dwarf_die_vector_size(&dies);
if (dwarf_haschildren(TOP()) > 0)
new_size++;
while (*addr == '\0') {
/*
* addr points to the null terminator for the
* list of siblings. Go back up to its parent.
* The next byte is either the parent's sibling
* or another null terminator.
*/
new_size--;
addr++;
if (new_size <= 1 || addr >= cu_end)
goto not_found;
}
/* addr now points to the next DIE. Go to it. */
if (new_size > dwarf_die_vector_size(&dies)) {
if (!dwarf_die_vector_append_entry(&dies))
return &drgn_enomem;
} else {
dwarf_die_vector_resize(&dies, new_size);
}
*TOP() = (Dwarf_Die){
.cu = dwarf_die_vector_first(&dies)->cu,
.addr = addr,
};
}
}
#undef TOP
not_found:
return drgn_error_create(DRGN_ERROR_OTHER,
"could not find DWARF DIE ancestors");
}
/*
* Location lists.
*/
static struct drgn_error *drgn_dwarf_next_addrx(struct binary_buffer *bb,
struct drgn_elf_file *file,
Dwarf_Die *cu_die,
uint8_t address_size,
const char **addr_base,
uint64_t *ret)
{
struct drgn_error *err;
// For split DWARF, .debug_addr is in the main debug file.
file = file->module->debug_file;
// addr_base is a cache of the address table base for the compilation
// unit.
if (!*addr_base) {
Dwarf_Attribute attr_mem, *attr;
if (!(attr = dwarf_attr_integrate(cu_die, DW_AT_addr_base,
&attr_mem)) &&
!(attr = dwarf_attr_integrate(cu_die, DW_AT_GNU_addr_base,
&attr_mem))) {
return drgn_error_create(DRGN_ERROR_OTHER,
"indirect address without DW_AT_addr_base");
}
Dwarf_Word base;
if (dwarf_formudata(attr, &base))
return drgn_error_libdw();
if (!file->scns[DRGN_SCN_DEBUG_ADDR]) {
return drgn_error_create(DRGN_ERROR_OTHER,
"indirect address without .debug_addr section");
}
Elf_Data *data;
err = drgn_elf_file_read_section(file, DRGN_SCN_DEBUG_ADDR, &data);
if (err)
return err;
if (base > data->d_size) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_AT_addr_base is out of bounds");
}
*addr_base = (char *)data->d_buf + base;
// In DWARF 5, there is a header immediately before addr_base,
// which ends with a segment selector size. We don't support a
// segment selector yet. In GNU Debug Fission, .debug_addr
// doesn't contain any headers or segment selectors.
if (attr->code != DW_AT_GNU_addr_base) {
if (base == 0) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_AT_addr_base is out of bounds");
}
uint8_t segment_selector_size = ((uint8_t *)*addr_base)[-1];
if (segment_selector_size != 0) {
return drgn_error_format(DRGN_ERROR_OTHER,
"unsupported segment selector size %" PRIu8,
segment_selector_size);
}
}
}
uint64_t index;
if ((err = binary_buffer_next_uleb128(bb, &index)))
return err;
// The data must was cached when we cached addr_base.
Elf_Data *data = file->scn_data[DRGN_SCN_DEBUG_ADDR];
if (index >=
((char *)data->d_buf + data->d_size - *addr_base) / address_size) {
return binary_buffer_error(bb,
"address index is out of bounds");
}
copy_lsbytes(ret, sizeof(*ret), HOST_LITTLE_ENDIAN,
*addr_base + index * address_size, address_size,
drgn_elf_file_is_little_endian(file));
return NULL;
}
static struct drgn_error *drgn_dwarf_read_loclistx(struct drgn_elf_file *file,
Dwarf_Die *cu_die,
uint8_t offset_size,
Dwarf_Word index,
Dwarf_Word *ret)
{
struct drgn_error *err;
assert(offset_size == 4 || offset_size == 8);
Dwarf_Attribute attr_mem, *attr;
Dwarf_Word base;
if ((attr = dwarf_attr(cu_die, DW_AT_loclists_base, &attr_mem))) {
if (dwarf_formudata(attr, &base))
return drgn_error_libdw();
} else {
// The DWARF 5 specification doesn't say what it means if there
// is no DW_AT_loclists_base. In practice, it seems like split
// units don't have DW_AT_loclist_base, and the base is intended
// to be the first entry in .debug_loclists immediately after
// the first header.
base = offset_size == 8 ? 20 : 12;
}
Dwarf_Off dwp_offset;
if (dwarf_cu_dwp_section_info(cu_die->cu, DW_SECT_LOCLISTS, &dwp_offset,
NULL))
return drgn_error_libdw();
base += dwp_offset;
if (!file->scns[DRGN_SCN_DEBUG_LOCLISTS]) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_FORM_loclistx without .debug_loclists section");
}
Elf_Data *data;
err = drgn_elf_file_read_section(file, DRGN_SCN_DEBUG_LOCLISTS, &data);
if (err)
return err;
if (base > data->d_size) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_AT_loclists_base is out of bounds");
}
if (index >= (data->d_size - base) / offset_size) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_FORM_loclistx is out of bounds");
}
const char *basep = (char *)data->d_buf + base;
if (offset_size == 8) {
uint64_t offset;
memcpy(&offset, (uint64_t *)basep + index, sizeof(offset));
if (drgn_elf_file_bswap(file))
offset = bswap_64(offset);
*ret = base + offset;
} else {
uint32_t offset;
memcpy(&offset, (uint32_t *)basep + index, sizeof(offset));
if (drgn_elf_file_bswap(file))
offset = bswap_32(offset);
*ret = base + offset;
}
return NULL;
}
static struct drgn_error *drgn_dwarf5_location_list(struct drgn_elf_file *file,
Dwarf_Word offset,
Dwarf_Die *cu_die,
uint8_t address_size,
uint64_t pc,
const char **expr_ret,
size_t *expr_size_ret)
{
struct drgn_error *err;
if (!file->scns[DRGN_SCN_DEBUG_LOCLISTS]) {
return drgn_error_create(DRGN_ERROR_OTHER,
"loclist without .debug_loclists section");
}
struct drgn_elf_file_section_buffer buffer;
err = drgn_elf_file_section_buffer_read(&buffer, file,
DRGN_SCN_DEBUG_LOCLISTS);
if (err)
return err;
if (offset > buffer.bb.end - buffer.bb.pos) {
return drgn_error_create(DRGN_ERROR_OTHER,
"loclist is out of bounds");
}
buffer.bb.pos += offset;
const char *addr_base = NULL;
uint64_t base;
bool base_valid = false;
/* Default is unknown. May be overridden by DW_LLE_default_location. */
*expr_ret = NULL;
*expr_size_ret = 0;
for (;;) {
uint8_t kind;
if ((err = binary_buffer_next_u8(&buffer.bb, &kind)))
return err;
uint64_t start, length, expr_size;
switch (kind) {
case DW_LLE_end_of_list:
return NULL;
case DW_LLE_base_addressx:
if ((err = drgn_dwarf_next_addrx(&buffer.bb, file,
cu_die, address_size,
&addr_base, &base)))
return err;
base_valid = true;
break;
case DW_LLE_startx_endx:
if ((err = drgn_dwarf_next_addrx(&buffer.bb, file,
cu_die, address_size,
&addr_base, &start)) ||
(err = drgn_dwarf_next_addrx(&buffer.bb, file,
cu_die, address_size,
&addr_base, &length)))
return err;
length -= start;
counted_location_description:
if ((err = binary_buffer_next_uleb128(&buffer.bb,
&expr_size)))
return err;
if (expr_size > buffer.bb.end - buffer.bb.pos) {
return binary_buffer_error(&buffer.bb,
"location description size is out of bounds");
}
if (pc >= start && pc - start < length) {
*expr_ret = buffer.bb.pos;
*expr_size_ret = expr_size;
return NULL;
}
buffer.bb.pos += expr_size;
break;
case DW_LLE_startx_length:
if ((err = drgn_dwarf_next_addrx(&buffer.bb, file,
cu_die, address_size,
&addr_base, &start)) ||
(err = binary_buffer_next_uleb128(&buffer.bb,
&length)))
return err;
goto counted_location_description;
case DW_LLE_offset_pair:
if ((err = binary_buffer_next_uleb128(&buffer.bb,
&start)) ||
(err = binary_buffer_next_uleb128(&buffer.bb,
&length)))
return err;
length -= start;
if (!base_valid) {
Dwarf_Addr low_pc;
if (dwarf_lowpc(cu_die, &low_pc))
return drgn_error_libdw();
base = low_pc;
base_valid = true;
}
start += base;
goto counted_location_description;
case DW_LLE_default_location:
if ((err = binary_buffer_next_uleb128(&buffer.bb,
&expr_size)))
return err;
if (expr_size > buffer.bb.end - buffer.bb.pos) {
return binary_buffer_error(&buffer.bb,
"location description size is out of bounds");
}
*expr_ret = buffer.bb.pos;
*expr_size_ret = expr_size;
buffer.bb.pos += expr_size;
break;
case DW_LLE_base_address:
if ((err = binary_buffer_next_uint(&buffer.bb,
address_size,
&base)))
return err;
base_valid = true;
break;
case DW_LLE_start_end:
if ((err = binary_buffer_next_uint(&buffer.bb,
address_size,
&start)) ||
(err = binary_buffer_next_uint(&buffer.bb,
address_size,
&length)))
return err;
length -= start;
goto counted_location_description;
case DW_LLE_start_length:
if ((err = binary_buffer_next_uint(&buffer.bb,
address_size,
&start)) ||
(err = binary_buffer_next_uleb128(&buffer.bb,
&length)))
return err;
goto counted_location_description;
default:
return binary_buffer_error(&buffer.bb,
"unknown location list entry kind %#" PRIx8,
kind);
}
}
}
static struct drgn_error *
drgn_dwarf4_split_location_list(struct drgn_elf_file *file, Dwarf_Word offset,
Dwarf_Die *cu_die, uint8_t address_size,
uint64_t pc, const char **expr_ret,
size_t *expr_size_ret)
{
struct drgn_error *err;
if (!file->scns[DRGN_SCN_DEBUG_LOC]) {
return drgn_error_create(DRGN_ERROR_OTHER,
"loclistptr without .debug_loc section");
}
Dwarf_Off dwp_offset;
if (dwarf_cu_dwp_section_info(cu_die->cu, DW_SECT_LOCLISTS, &dwp_offset,
NULL))
return drgn_error_libdw();
offset += dwp_offset;
struct drgn_elf_file_section_buffer buffer;
err = drgn_elf_file_section_buffer_read(&buffer, file,
DRGN_SCN_DEBUG_LOC);
if (err)
return err;
if (offset > buffer.bb.end - buffer.bb.pos) {
return drgn_error_create(DRGN_ERROR_OTHER,
"loclistptr is out of bounds");
}
buffer.bb.pos += offset;
const char *addr_base = NULL;
uint64_t base;
bool base_valid = false;
*expr_ret = NULL;
*expr_size_ret = 0;
for (;;) {
uint8_t kind;
if ((err = binary_buffer_next_u8(&buffer.bb, &kind)))
return err;
uint64_t start, length;
switch (kind) {
// The GNU Debug Fission design document
// (https://gcc.gnu.org/wiki/DebugFission) uses slightly
// different names for entry kinds than DWARF 5, but they're the
// same as the DWARF 5 versions except as noted below.
case DW_LLE_end_of_list: // DW_LLE_end_of_list_entry
return NULL;
case DW_LLE_base_addressx: // DW_LLE_base_address_selection_entry
if ((err = drgn_dwarf_next_addrx(&buffer.bb, file,
cu_die, address_size,
&addr_base, &base)))
return err;
base_valid = true;
break;
case DW_LLE_startx_endx: // DW_LLE_start_end_entry
if ((err = drgn_dwarf_next_addrx(&buffer.bb, file,
cu_die, address_size,
&addr_base, &start)) ||
(err = drgn_dwarf_next_addrx(&buffer.bb, file,
cu_die, address_size,
&addr_base, &length)))
return err;
length -= start;
counted_location_description:;
// Note: this is ULEB128 in DWARF 5.
uint16_t expr_size;
if ((err = binary_buffer_next_u16(&buffer.bb,
&expr_size)))
return err;
if (expr_size > buffer.bb.end - buffer.bb.pos) {
return binary_buffer_error(&buffer.bb,
"location description size is out of bounds");
}
if (pc >= start && pc - start < length) {
*expr_ret = buffer.bb.pos;
*expr_size_ret = expr_size;
return NULL;
}
buffer.bb.pos += expr_size;
break;
case DW_LLE_startx_length: // DW_LLE_start_length_entry
if ((err = drgn_dwarf_next_addrx(&buffer.bb, file,
cu_die, address_size,
&addr_base, &start)) ||
// Note: this is ULEB128 in DWARF 5.
(err = binary_buffer_next_u32_into_u64(&buffer.bb,
&length)))
return err;
goto counted_location_description;
case DW_LLE_offset_pair: // DW_LLE_offset_pair_entry
// Note: these are ULEB128 in DWARF 5.
if ((err = binary_buffer_next_u32_into_u64(&buffer.bb,
&start)) ||
(err = binary_buffer_next_u32_into_u64(&buffer.bb,
&length)))
return err;
length -= start;
if (!base_valid) {
Dwarf_Addr low_pc;
if (dwarf_lowpc(cu_die, &low_pc))
return drgn_error_libdw();
base = low_pc;
base_valid = true;
}
start += base;
goto counted_location_description;
default:
return binary_buffer_error(&buffer.bb,
"unknown location list entry kind %#" PRIx8,
kind);
}
}
}
static struct drgn_error *drgn_dwarf4_location_list(struct drgn_elf_file *file,
Dwarf_Word offset,
Dwarf_Die *cu_die,
uint8_t address_size,
uint64_t pc,
const char **expr_ret,
size_t *expr_size_ret)
{
struct drgn_error *err;
if (!file->scns[DRGN_SCN_DEBUG_LOC]) {
return drgn_error_create(DRGN_ERROR_OTHER,
"loclistptr without .debug_loc section");
}
struct drgn_elf_file_section_buffer buffer;
err = drgn_elf_file_section_buffer_read(&buffer, file,
DRGN_SCN_DEBUG_LOC);
if (err)
return err;
if (offset > buffer.bb.end - buffer.bb.pos) {
return drgn_error_create(DRGN_ERROR_OTHER,
"loclistptr is out of bounds");
}
buffer.bb.pos += offset;
uint64_t address_max = uint_max(address_size);
uint64_t base;
bool base_valid = false;
for (;;) {
uint64_t start, end;
if ((err = binary_buffer_next_uint(&buffer.bb, address_size,
&start)) ||
(err = binary_buffer_next_uint(&buffer.bb, address_size,
&end)))
return err;
if (start == 0 && end == 0) {
*expr_ret = NULL;
*expr_size_ret = 0;
return NULL;
} else if (start == address_max) {
base = end;
base_valid = true;
} else {
if (!base_valid) {
Dwarf_Addr low_pc;
if (dwarf_lowpc(cu_die, &low_pc))
return drgn_error_libdw();
base = low_pc;
base_valid = true;
}
uint16_t expr_size;
if ((err = binary_buffer_next_u16(&buffer.bb,
&expr_size)))
return err;
if (expr_size > buffer.bb.end - buffer.bb.pos) {
return binary_buffer_error(&buffer.bb,
"location description size is out of bounds");
}
if (base + start <= pc && pc < base + end) {
*expr_ret = buffer.bb.pos;
*expr_size_ret = expr_size;
return NULL;
}
buffer.bb.pos += expr_size;
}
}
}
static struct drgn_error *
drgn_dwarf_location(struct drgn_elf_file *file, Dwarf_Attribute *attr,
const struct drgn_register_state *regs,
const char **expr_ret, size_t *expr_size_ret)
{
struct drgn_error *err;
switch (attr->form) {
/* DWARF 3 */
case DW_FORM_data4:
case DW_FORM_data8:
/* DWARF 4-5 */
case DW_FORM_sec_offset:
/* DWARF 5 */
case DW_FORM_loclistx: {
Dwarf_Half cu_version;
uint8_t unit_type;
Dwarf_Die cu_die;
uint8_t address_size;
uint8_t offset_size;
#if _ELFUTILS_PREREQ(0, 171)
if (dwarf_cu_info(attr->cu, &cu_version, &unit_type, &cu_die,
NULL, NULL, &address_size, &offset_size))
return drgn_error_libdw();
#else
unit_type = DW_UT_compile;
if (!dwarf_cu_die(attr->cu, &cu_die, &cu_version, NULL,
&address_size, &offset_size, NULL, NULL))
return drgn_error_libdw();
#endif
if ((err = drgn_check_address_size(address_size)))
return err;
Dwarf_Word offset;
if (dwarf_formudata(attr, &offset))
return drgn_error_libdw();
if (attr->form == DW_FORM_loclistx &&
((err = drgn_dwarf_read_loclistx(file, &cu_die, offset_size,
offset, &offset))))
return err;
struct optional_uint64 pc;
if (!regs ||
!(pc = drgn_register_state_get_pc(regs)).has_value) {
*expr_ret = NULL;
*expr_size_ret = 0;
return NULL;
}
pc.value -= !regs->interrupted + file->module->debug_file_bias;
if (cu_version >= 5) {
return drgn_dwarf5_location_list(file, offset, &cu_die,
address_size, pc.value,
expr_ret,
expr_size_ret);
} else if (unit_type == DW_UT_split_compile
|| unit_type == DW_UT_split_type) {
return drgn_dwarf4_split_location_list(file, offset,
&cu_die,
address_size,
pc.value,
expr_ret,
expr_size_ret);
} else {
return drgn_dwarf4_location_list(file, offset, &cu_die,
address_size, pc.value,
expr_ret,
expr_size_ret);
}
}
default: {
Dwarf_Block block;
if (dwarf_formblock(attr, &block))
return drgn_error_libdw();
*expr_ret = (char *)block.data;
*expr_size_ret = block.length;
return NULL;
}
}
}
/*
* DWARF expressions.
*/
/**
* Arbitrary limit for number of operations to execute in a DWARF expression to
* avoid infinite loops.
*/
static const int MAX_DWARF_EXPR_OPS = 10000;
/* A DWARF expression and the context it is being evaluated in. */
struct drgn_dwarf_expression_context {
struct binary_buffer bb;
const char *start;
struct drgn_program *prog;
struct drgn_elf_file *file;
uint8_t address_size;
Dwarf_Die cu_die;
const char *cu_addr_base;
Dwarf_Die *function;
const struct drgn_register_state *regs;
};
static struct drgn_error *
drgn_dwarf_expression_buffer_error(struct binary_buffer *bb, const char *pos,
const char *message)
{
struct drgn_dwarf_expression_context *ctx =
container_of(bb, struct drgn_dwarf_expression_context, bb);
return drgn_elf_file_section_error(ctx->file, NULL, NULL, pos, message);
}
static inline struct drgn_error *
drgn_dwarf_expression_context_init(struct drgn_dwarf_expression_context *ctx,
struct drgn_program *prog,
struct drgn_elf_file *file, Dwarf_CU *cu,
Dwarf_Die *function,
const struct drgn_register_state *regs,
const char *expr, size_t expr_size)
{
struct drgn_error *err;
binary_buffer_init(&ctx->bb, expr, expr_size,
drgn_elf_file_is_little_endian(file),
drgn_dwarf_expression_buffer_error);
ctx->start = expr;
ctx->prog = prog;
ctx->file = file;
if (cu) {
if (!dwarf_cu_die(cu, &ctx->cu_die, NULL, NULL,
&ctx->address_size, NULL, NULL, NULL))
return drgn_error_libdw();
if ((err = drgn_check_address_size(ctx->address_size)))
return err;
} else {
ctx->cu_die.addr = NULL;
ctx->address_size = drgn_elf_file_address_size(file);
}
ctx->cu_addr_base = NULL;
ctx->function = function;
ctx->regs = regs;
return NULL;
}
static struct drgn_error *
drgn_dwarf_frame_base(struct drgn_program *prog, struct drgn_elf_file *file,
Dwarf_Die *die, const struct drgn_register_state *regs,
int *remaining_ops, uint64_t *ret);
static struct drgn_error drgn_unknown_dwarf_opcode = {
.code = DRGN_ERROR_NOT_IMPLEMENTED,
.message = "unknown DWARF expression opcode",
};
static bool drgn_dwarf_opcode_is_known(uint8_t opcode)
{
#define X(name, _) if (opcode == name) return true;
DW_OP_DEFINITIONS
#undef X
return false;
}
static struct drgn_error *
drgn_handle_unknown_dwarf_opcode(struct drgn_dwarf_expression_context *ctx,
uint8_t opcode,
bool after_simple_location_description)
{
// We warn the first time that we see an opcode that appears to be
// valid.
static bool warned;
enum drgn_log_level log_level = DRGN_LOG_DEBUG;
if (drgn_dwarf_opcode_is_known(opcode)
&& !__atomic_test_and_set(&warned, __ATOMIC_SEQ_CST))
log_level = DRGN_LOG_WARNING;
if (drgn_log_is_enabled(ctx->prog, log_level)) {
struct drgn_error *err;
char op_buf[DW_OP_STR_BUF_LEN];
err = binary_buffer_error(&ctx->bb,
"unknown DWARF expression opcode %s%s; "
"please report this to %s",
dw_op_str(opcode, op_buf),
after_simple_location_description
? " after simple location description"
: "",
PACKAGE_BUGREPORT);
drgn_error_log(log_level, ctx->prog, err, "");
drgn_error_destroy(err);
}
return &drgn_unknown_dwarf_opcode;
}
/*
* Evaluate a DWARF expression up to the next location description operation or
* operation that can't be evaluated in the given context.
*
* Returns &drgn_not_found if it tried to use an unknown register value.
*/
static struct drgn_error *
drgn_eval_dwarf_expression(struct drgn_dwarf_expression_context *ctx,
struct uint64_vector *stack,
int *remaining_ops)
{
struct drgn_error *err;
bool little_endian =
drgn_elf_file_is_little_endian(ctx->file);
uint8_t address_size = ctx->address_size;
uint8_t address_bits = address_size * CHAR_BIT;
uint64_t address_mask = uint_max(address_size);
const struct drgn_register_layout *register_layout =
ctx->file->platform.arch->register_layout;
drgn_register_number (*dwarf_regno_to_internal)(uint64_t) =
ctx->file->platform.arch->dwarf_regno_to_internal;
#define CHECK(n) do { \
size_t _n = (n); \
if (uint64_vector_size(stack) < _n) { \
return binary_buffer_error(&ctx->bb, \
"DWARF expression stack underflow"); \
} \
} while (0)
#define ELEM(i) *uint64_vector_at(stack, uint64_vector_size(stack) - 1 - (i))
#define PUSH(x) do { \
uint64_t push = (x); \
if (!uint64_vector_append(stack, &push)) \
return &drgn_enomem; \
} while (0)
#define PUSH_MASK(x) PUSH((x) & address_mask)
while (binary_buffer_has_next(&ctx->bb)) {
if (*remaining_ops <= 0) {
return binary_buffer_error(&ctx->bb,
"DWARF expression executed too many operations");
}
(*remaining_ops)--;
uint8_t opcode;
if ((err = binary_buffer_next_u8(&ctx->bb, &opcode)))
return err;
uint64_t uvalue;
uint64_t dwarf_regno;
uint8_t deref_size;
switch (opcode) {
/* Literal encodings. */
case DW_OP_lit0 ... DW_OP_lit31:
PUSH(opcode - DW_OP_lit0);
break;
case DW_OP_addr:
if ((err = binary_buffer_next_uint(&ctx->bb,
address_size,
&uvalue)))
return err;
addr:
/*
* If the address is not in the module's address range,
* then it's probably something special like a Linux
* per-CPU variable (which isn't actually a variable
* address but an offset). Don't apply the bias in that
* case.
*/
if (drgn_module_contains_address(ctx->file->module,
uvalue + ctx->file->module->debug_file_bias))
uvalue += ctx->file->module->debug_file_bias;
PUSH(uvalue);
break;
case DW_OP_const1u:
if ((err = binary_buffer_next_u8_into_u64(&ctx->bb,
&uvalue)))
return err;
PUSH(uvalue);
break;
case DW_OP_const2u:
if ((err = binary_buffer_next_u16_into_u64(&ctx->bb,
&uvalue)))
return err;
PUSH_MASK(uvalue);
break;
case DW_OP_const4u:
if ((err = binary_buffer_next_u32_into_u64(&ctx->bb,
&uvalue)))
return err;
PUSH_MASK(uvalue);
break;
case DW_OP_const8u:
if ((err = binary_buffer_next_u64(&ctx->bb, &uvalue)))
return err;
PUSH_MASK(uvalue);
break;
case DW_OP_const1s:
if ((err = binary_buffer_next_s8_into_u64(&ctx->bb,
&uvalue)))
return err;
PUSH_MASK(uvalue);
break;
case DW_OP_const2s:
if ((err = binary_buffer_next_s16_into_u64(&ctx->bb,
&uvalue)))
return err;
PUSH_MASK(uvalue);
break;
case DW_OP_const4s:
if ((err = binary_buffer_next_s32_into_u64(&ctx->bb,
&uvalue)))
return err;
PUSH_MASK(uvalue);
break;
case DW_OP_const8s:
if ((err = binary_buffer_next_s64_into_u64(&ctx->bb,
&uvalue)))
return err;
PUSH_MASK(uvalue);
break;
case DW_OP_constu:
if ((err = binary_buffer_next_uleb128(&ctx->bb,
&uvalue)))
return err;
PUSH_MASK(uvalue);
break;
case DW_OP_consts:
if ((err = binary_buffer_next_sleb128_into_u64(&ctx->bb,
&uvalue)))
return err;
PUSH_MASK(uvalue);
break;
case DW_OP_addrx:
case DW_OP_GNU_addr_index:
if (!ctx->cu_die.addr) {
ctx->bb.pos = ctx->bb.prev;
return NULL;
}
if ((err = drgn_dwarf_next_addrx(&ctx->bb, ctx->file,
&ctx->cu_die,
address_size,
&ctx->cu_addr_base,
&uvalue)))
return err;
goto addr;
case DW_OP_constx:
case DW_OP_GNU_const_index:
if (!ctx->cu_die.addr) {
ctx->bb.pos = ctx->bb.prev;
return NULL;
}
if ((err = drgn_dwarf_next_addrx(&ctx->bb, ctx->file,
&ctx->cu_die,
address_size,
&ctx->cu_addr_base,
&uvalue)))
return err;
PUSH(uvalue);
break;
/* Register values. */
case DW_OP_fbreg: {
err = drgn_dwarf_frame_base(ctx->prog, ctx->file,
ctx->function, ctx->regs,
remaining_ops, &uvalue);
if (err)
return err;
int64_t svalue;
if ((err = binary_buffer_next_sleb128(&ctx->bb,
&svalue)))
return err;
PUSH_MASK(uvalue + svalue);
break;
}
case DW_OP_breg0 ... DW_OP_breg31:
dwarf_regno = opcode - DW_OP_breg0;
goto breg;
case DW_OP_bregx:
if ((err = binary_buffer_next_uleb128(&ctx->bb,
&dwarf_regno)))
return err;
breg:
{
if (!ctx->regs)
return &drgn_not_found;
drgn_register_number regno =
dwarf_regno_to_internal(dwarf_regno);
if (!drgn_register_state_has_register(ctx->regs, regno))
return &drgn_not_found;
const struct drgn_register_layout *layout =
®ister_layout[regno];
copy_lsbytes(&uvalue, sizeof(uvalue),
HOST_LITTLE_ENDIAN,
&ctx->regs->buf[layout->offset],
layout->size, little_endian);
int64_t svalue;
if ((err = binary_buffer_next_sleb128(&ctx->bb,
&svalue)))
return err;
PUSH_MASK(uvalue + svalue);
break;
}
/* Stack operations. */
case DW_OP_dup:
CHECK(1);
PUSH(ELEM(0));
break;
case DW_OP_drop:
CHECK(1);
uint64_vector_pop(stack);
break;
case DW_OP_pick: {
uint8_t index;
if ((err = binary_buffer_next_u8(&ctx->bb, &index)))
return err;
CHECK(index + 1);
PUSH(ELEM(index));
break;
}
case DW_OP_over:
CHECK(2);
PUSH(ELEM(1));
break;
case DW_OP_swap:
CHECK(2);
uvalue = ELEM(0);
ELEM(0) = ELEM(1);
ELEM(1) = uvalue;
break;
case DW_OP_rot:
CHECK(3);
uvalue = ELEM(0);
ELEM(0) = ELEM(1);
ELEM(1) = ELEM(2);
ELEM(2) = uvalue;
break;
case DW_OP_deref:
deref_size = address_size;
goto deref;
case DW_OP_deref_size:
if ((err = binary_buffer_next_u8(&ctx->bb,
&deref_size)))
return err;
if (deref_size > address_size) {
return binary_buffer_error(&ctx->bb,
"DW_OP_deref_size has invalid size");
}
deref:
{
CHECK(1);
char deref_buf[8];
err = drgn_program_read_memory(ctx->prog, deref_buf,
ELEM(0), deref_size,
false);
if (err)
return err;
copy_lsbytes(&ELEM(0), sizeof(ELEM(0)),
HOST_LITTLE_ENDIAN, deref_buf, deref_size,
little_endian);
break;
}
case DW_OP_call_frame_cfa: {
if (!ctx->regs)
return &drgn_not_found;
/*
* The DWARF 5 specification says that
* DW_OP_call_frame_cfa cannot be used for CFI. For
* DW_CFA_def_cfa_expression, it is clearly invalid to
* define the CFA in terms of the CFA, and it will fail
* naturally below. This restriction doesn't make sense
* for DW_CFA_expression and DW_CFA_val_expression, as
* they push the CFA and thus depend on it anyways, so
* we don't bother enforcing it.
*/
struct optional_uint64 cfa =
drgn_register_state_get_cfa(ctx->regs);
if (!cfa.has_value)
return &drgn_not_found;
PUSH(cfa.value);
break;
}
/* Arithmetic and logical operations. */
#define UNOP_MASK(op) do { \
CHECK(1); \
ELEM(0) = (op ELEM(0)) & address_mask; \
} while (0)
#define BINOP(op) do { \
CHECK(2); \
ELEM(1) = ELEM(1) op ELEM(0); \
uint64_vector_pop(stack); \
} while (0)
#define BINOP_MASK(op) do { \
CHECK(2); \
ELEM(1) = (ELEM(1) op ELEM(0)) & address_mask; \
uint64_vector_pop(stack); \
} while (0)
case DW_OP_abs:
CHECK(1);
if (ELEM(0) & (UINT64_C(1) << (address_bits - 1)))
ELEM(0) = -ELEM(0) & address_mask;
break;
case DW_OP_and:
BINOP(&);
break;
case DW_OP_div:
CHECK(2);
if (ELEM(0) == 0) {
return binary_buffer_error(&ctx->bb,
"division by zero in DWARF expression");
}
ELEM(1) = ((truncate_signed(ELEM(1), address_bits)
/ truncate_signed(ELEM(0), address_bits))
& address_mask);
uint64_vector_pop(stack);
break;
case DW_OP_minus:
BINOP_MASK(-);
break;
case DW_OP_mod:
CHECK(2);
if (ELEM(0) == 0) {
return binary_buffer_error(&ctx->bb,
"modulo by zero in DWARF expression");
}
ELEM(1) = ELEM(1) % ELEM(0);
uint64_vector_pop(stack);
break;
case DW_OP_mul:
BINOP_MASK(*);
break;
case DW_OP_neg:
UNOP_MASK(-);
break;
case DW_OP_not:
UNOP_MASK(~);
break;
case DW_OP_or:
BINOP(|);
break;
case DW_OP_plus:
BINOP_MASK(+);
break;
case DW_OP_plus_uconst:
CHECK(1);
if ((err = binary_buffer_next_uleb128(&ctx->bb,
&uvalue)))
return err;
ELEM(0) = (ELEM(0) + uvalue) & address_mask;
break;
case DW_OP_shl:
CHECK(2);
if (ELEM(0) < address_bits)
ELEM(1) = (ELEM(1) << ELEM(0)) & address_mask;
else
ELEM(1) = 0;
uint64_vector_pop(stack);
break;
case DW_OP_shr:
CHECK(2);
if (ELEM(0) < address_bits)
ELEM(1) >>= ELEM(0);
else
ELEM(1) = 0;
uint64_vector_pop(stack);
break;
case DW_OP_shra:
CHECK(2);
if (ELEM(0) < address_bits) {
ELEM(1) = ((truncate_signed(ELEM(1), address_bits)
>> ELEM(0))
& address_mask);
} else if (ELEM(1) & (UINT64_C(1) << (address_bits - 1))) {
ELEM(1) = -INT64_C(1) & address_mask;
} else {
ELEM(1) = 0;
}
uint64_vector_pop(stack);
break;
case DW_OP_xor:
BINOP(^);
break;
#undef BINOP_MASK
#undef BINOP
#undef UNOP_MASK
/* Control flow operations. */
#define RELOP(op) do { \
CHECK(2); \
ELEM(1) = (truncate_signed(ELEM(1), address_bits) op \
truncate_signed(ELEM(0), address_bits)); \
uint64_vector_pop(stack); \
} while (0)
case DW_OP_le:
RELOP(<=);
break;
case DW_OP_ge:
RELOP(>=);
break;
case DW_OP_eq:
RELOP(==);
break;
case DW_OP_lt:
RELOP(<);
break;
case DW_OP_gt:
RELOP(>);
break;
case DW_OP_ne:
RELOP(!=);
break;
#undef RELOP
case DW_OP_skip:
branch:
{
int16_t skip;
if ((err = binary_buffer_next_s16(&ctx->bb, &skip)))
return err;
if ((skip >= 0 && skip > ctx->bb.end - ctx->bb.pos) ||
(skip < 0 && -skip > ctx->bb.pos - ctx->start)) {
return binary_buffer_error(&ctx->bb,
"DWARF expression branch is out of bounds");
}
ctx->bb.pos += skip;
break;
}
case DW_OP_bra:
CHECK(1);
if (ELEM(0)) {
uint64_vector_pop(stack);
goto branch;
} else {
uint64_vector_pop(stack);
if ((err = binary_buffer_skip(&ctx->bb, 2)))
return err;
}
break;
/* Special operations. */
case DW_OP_nop:
break;
case DW_OP_entry_value:
case DW_OP_GNU_entry_value:
// TODO: DW_OP_(GNU_)entry_value followed by
// DW_OP_reg<n> means the value of the register when the
// current subprogram was entered. We could recover this
// by finding the DW_TAG_(GNU_)call_site for the return
// address and using the DW_AT_(GNU_)call_value of a
// DW_TAG_(GNU_)call_parameter with a DW_AT_location
// matching that register.
if (drgn_log_is_enabled(ctx->prog, DRGN_LOG_DEBUG)) {
char op_buf[DW_OP_STR_BUF_LEN];
err = binary_buffer_error(&ctx->bb,
"unimplemented DWARF expression opcode %s; "
"please upvote https://github.com/osandov/drgn/issues/337",
dw_op_str(opcode, op_buf));
drgn_error_log_debug(ctx->prog, err, "");
drgn_error_destroy(err);
}
return &drgn_not_found;
/* Location description operations. */
case DW_OP_reg0 ... DW_OP_reg31:
case DW_OP_regx:
case DW_OP_implicit_value:
case DW_OP_stack_value:
case DW_OP_piece:
case DW_OP_bit_piece:
/* The caller must handle it. */
ctx->bb.pos = ctx->bb.prev;
return NULL;
/*
* We don't yet support:
*
* - DW_OP_push_object_address
* - DW_OP_form_tls_address
* DW_OP_implicit_pointer
* - Procedure calls: DW_OP_call2, DW_OP_call4, DW_OP_call_ref.
* - Typed operations: DW_OP_const_type, DW_OP_regval_type,
* DW_OP_deref_type, DW_OP_convert, DW_OP_reinterpret.
* - Operations for multiple address spaces: DW_OP_xderef,
* DW_OP_xderef_size, DW_OP_xderef_type.
*/
default:
return drgn_handle_unknown_dwarf_opcode(ctx, opcode,
false);
}
}
#undef PUSH_MASK
#undef PUSH
#undef ELEM
#undef CHECK
return NULL;
}
static struct drgn_error *
drgn_dwarf_frame_base(struct drgn_program *prog, struct drgn_elf_file *file,
Dwarf_Die *die, const struct drgn_register_state *regs,
int *remaining_ops, uint64_t *ret)
{
struct drgn_error *err;
bool little_endian = drgn_elf_file_is_little_endian(file);
const struct drgn_register_layout *register_layout =
file->platform.arch->register_layout;
drgn_register_number (*dwarf_regno_to_internal)(uint64_t) =
file->platform.arch->dwarf_regno_to_internal;
if (!die)
return &drgn_not_found;
Dwarf_Attribute attr_mem, *attr;
if (!(attr = dwarf_attr_integrate(die, DW_AT_frame_base, &attr_mem)))
return &drgn_not_found;
const char *expr;
size_t expr_size;
err = drgn_dwarf_location(file, attr, regs, &expr, &expr_size);
if (err)
return err;
struct drgn_dwarf_expression_context ctx;
if ((err = drgn_dwarf_expression_context_init(&ctx, prog, file, die->cu,
NULL, regs, expr,
expr_size)))
return err;
VECTOR(uint64_vector, stack);
for (;;) {
err = drgn_eval_dwarf_expression(&ctx, &stack, remaining_ops);
if (err)
return err;
if (binary_buffer_has_next(&ctx.bb)) {
uint8_t opcode;
if ((err = binary_buffer_next_u8(&ctx.bb, &opcode)))
return err;
uint64_t dwarf_regno;
switch (opcode) {
case DW_OP_reg0 ... DW_OP_reg31:
dwarf_regno = opcode - DW_OP_reg0;
goto reg;
case DW_OP_regx:
if ((err = binary_buffer_next_uleb128(&ctx.bb,
&dwarf_regno)))
return err;
reg:
{
if (!regs)
return &drgn_not_found;
drgn_register_number regno =
dwarf_regno_to_internal(dwarf_regno);
if (!drgn_register_state_has_register(regs,
regno))
return &drgn_not_found;
const struct drgn_register_layout *layout =
®ister_layout[regno];
/*
* Note that this doesn't mask the address since
* the caller does that.
*/
copy_lsbytes(ret, sizeof(*ret),
HOST_LITTLE_ENDIAN,
®s->buf[layout->offset],
layout->size, little_endian);
if (binary_buffer_has_next(&ctx.bb)) {
return binary_buffer_error(&ctx.bb,
"stray operations in DW_AT_frame_base expression");
} else {
return NULL;
}
}
default:
return binary_buffer_error(&ctx.bb,
"invalid opcode %#" PRIx8 " for DW_AT_frame_base expression",
opcode);
}
} else if (!uint64_vector_empty(&stack)) {
*ret = *uint64_vector_last(&stack);
return NULL;
} else {
return &drgn_not_found;
}
}
}
/*
* Type and object parsing.
*/
/**
* Return whether a DWARF DIE is little-endian.
*
* @param[in] check_attr Whether to check the DW_AT_endianity attribute. If @c
* false, only the ELF header is checked and this function cannot fail.
* @return @c NULL on success, non-@c NULL on error.
*/
static struct drgn_error *dwarf_die_is_little_endian(Dwarf_Die *die,
bool check_attr, bool *ret)
{
Dwarf_Attribute endianity_attr_mem, *endianity_attr;
Dwarf_Word endianity;
if (check_attr &&
(endianity_attr = dwarf_attr_integrate(die, DW_AT_endianity,
&endianity_attr_mem))) {
if (dwarf_formudata(endianity_attr, &endianity)) {
return drgn_error_create(DRGN_ERROR_OTHER,
"invalid DW_AT_endianity");
}
} else {
endianity = DW_END_default;
}
switch (endianity) {
case DW_END_default: {
Elf *elf = dwarf_getelf(dwarf_cu_getdwarf(die->cu));
*ret = elf_getident(elf, NULL)[EI_DATA] == ELFDATA2LSB;
return NULL;
}
case DW_END_little:
*ret = true;
return NULL;
case DW_END_big:
*ret = false;
return NULL;
default:
return drgn_error_create(DRGN_ERROR_OTHER,
"unknown DW_AT_endianity");
}
}
/** Like dwarf_die_is_little_endian(), but returns a @ref drgn_byte_order. */
static struct drgn_error *dwarf_die_byte_order(Dwarf_Die *die, bool check_attr,
enum drgn_byte_order *ret)
{
bool little_endian;
struct drgn_error *err = dwarf_die_is_little_endian(die, check_attr,
&little_endian);
/*
* dwarf_die_is_little_endian() can't fail if check_attr is false, so
* the !check_attr test suppresses maybe-uninitialized warnings.
*/
if (!err || !check_attr)
*ret = drgn_byte_order_from_little_endian(little_endian);
return err;
}
static int dwarf_type(Dwarf_Die *die, Dwarf_Die *ret)
{
Dwarf_Attribute attr_mem;
Dwarf_Attribute *attr;
if (!(attr = dwarf_attr_integrate(die, DW_AT_type, &attr_mem)))
return 1;
return dwarf_formref_die(attr, ret) ? 0 : -1;
}
static int dwarf_flag(Dwarf_Die *die, unsigned int name, bool *ret)
{
Dwarf_Attribute attr_mem;
Dwarf_Attribute *attr;
if (!(attr = dwarf_attr(die, name, &attr_mem))) {
*ret = false;
return 0;
}
return dwarf_formflag(attr, ret);
}
static int dwarf_flag_integrate(Dwarf_Die *die, unsigned int name, bool *ret)
{
Dwarf_Attribute attr_mem;
Dwarf_Attribute *attr;
if (!(attr = dwarf_attr_integrate(die, name, &attr_mem))) {
*ret = false;
return 0;
}
return dwarf_formflag(attr, ret);
}
struct drgn_error *drgn_dwarf_type_alignment(struct drgn_type *type,
uint64_t *ret)
{
uintptr_t die_addr = drgn_type_die_addr(type);
if (!die_addr)
return &drgn_not_found;
struct drgn_dwarf_index_cu *cu =
drgn_dwarf_index_find_cu(&drgn_type_program(type)->dbinfo,
die_addr);
if (!cu) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DIE from unknown DWARF CU");
}
Dwarf_Die die = {
.addr = (void *)die_addr,
.cu = cu->libdw_cu,
};
Dwarf_Attribute attr_mem, *attr;
if (!(attr = dwarf_attr_integrate(&die, DW_AT_alignment, &attr_mem)))
return &drgn_not_found;
Dwarf_Word alignment;
if (dwarf_formudata(attr, &alignment) || alignment <= 0) {
return drgn_error_create(DRGN_ERROR_OTHER,
"invalid DW_AT_alignment");
}
*ret = alignment;
return NULL;
}
/**
* Parse a type from a DWARF debugging information entry.
*
* This is the same as @ref drgn_type_from_dwarf() except that it can be used to
* work around a bug in GCC < 9.0 that zero length array types are encoded the
* same as incomplete array types. There are a few places where GCC allows
* zero-length arrays but not incomplete arrays:
*
* - As the type of a member of a structure with only one member.
* - As the type of a structure member other than the last member.
* - As the type of a union member.
* - As the element type of an array.
*
* In these cases, we know that what appears to be an incomplete array type must
* actually have a length of zero. In other cases, a subrange DIE without
* DW_AT_count or DW_AT_upper_bound is ambiguous; we return an incomplete array
* type.
*
* @param[in] dbinfo Debugging information.
* @param[in] file File containing @p die.
* @param[in] die DIE to parse.
* @param[in] can_be_incomplete_array Whether the type can be an incomplete
* array type. If this is @c false and the type appears to be an incomplete
* array type, its length is set to zero instead.
* @param[out] is_incomplete_array_ret Whether the encoded type is an incomplete
* array type or a typedef of an incomplete array type (regardless of @p
* can_be_incomplete_array).
* @param[out] ret Returned type.
* @return @c NULL on success, non-@c NULL on error.
*/
static struct drgn_error *
drgn_type_from_dwarf_internal(struct drgn_debug_info *dbinfo,
struct drgn_elf_file *file, Dwarf_Die *die,
bool can_be_incomplete_array,
bool *is_incomplete_array_ret,
struct drgn_qualified_type *ret);
/**
* Parse a type from a DWARF debugging information entry.
*
* @param[in] dbinfo Debugging information.
* @param[in] file File containing @p die.
* @param[in] die DIE to parse.
* @param[out] ret Returned type.
* @return @c NULL on success, non-@c NULL on error.
*/
static inline struct drgn_error *
drgn_type_from_dwarf(struct drgn_debug_info *dbinfo, struct drgn_elf_file *file,
Dwarf_Die *die, struct drgn_qualified_type *ret)
{
return drgn_type_from_dwarf_internal(dbinfo, file, die, true, NULL,
ret);
}
/**
* Parse a type from the @c DW_AT_type attribute of a DWARF debugging
* information entry.
*
* @param[in] dbinfo Debugging information.
* @param[in] file File containing @p die.
* @param[in] die DIE with @c DW_AT_type attribute.
* @param[in] lang Language of @p die if it is already known, @c NULL if it
* should be determined from @p die.
* @param[in] can_be_void Whether the @c DW_AT_type attribute may be missing,
* which is interpreted as a void type. If this is false and the @c DW_AT_type
* attribute is missing, an error is returned.
* @param[in] can_be_incomplete_array See @ref drgn_type_from_dwarf_internal().
* @param[in] is_incomplete_array_ret See @ref drgn_type_from_dwarf_internal().
* @param[out] ret Returned type.
* @return @c NULL on success, non-@c NULL on error.
*/
static struct drgn_error *
drgn_type_from_dwarf_attr(struct drgn_debug_info *dbinfo,
struct drgn_elf_file *file, Dwarf_Die *die,
const struct drgn_language *lang,
bool can_be_void, bool can_be_incomplete_array,
bool *is_incomplete_array_ret,
struct drgn_qualified_type *ret)
{
struct drgn_error *err;
char tag_buf[DW_TAG_STR_BUF_LEN];
Dwarf_Attribute attr_mem;
Dwarf_Attribute *attr;
if (!(attr = dwarf_attr_integrate(die, DW_AT_type, &attr_mem))) {
if (can_be_void) {
if (!lang) {
err = drgn_language_from_die(die, true, &lang);
if (err)
return err;
}
ret->type = drgn_void_type(dbinfo->prog, lang);
ret->qualifiers = 0;
return NULL;
} else {
return drgn_error_format(DRGN_ERROR_OTHER,
"%s is missing DW_AT_type",
dwarf_tag_str(die, tag_buf));
}
}
Dwarf_Die type_die;
if (!dwarf_formref_die(attr, &type_die)) {
return drgn_error_format(DRGN_ERROR_OTHER,
"%s has invalid DW_AT_type",
dwarf_tag_str(die, tag_buf));
}
return drgn_type_from_dwarf_internal(dbinfo, file, &type_die,
can_be_incomplete_array,
is_incomplete_array_ret, ret);
}
static struct drgn_error *
drgn_object_from_dwarf_enumerator(struct drgn_debug_info *dbinfo,
struct drgn_elf_file *file, Dwarf_Die *die,
const char *name, struct drgn_object *ret)
{
struct drgn_error *err;
struct drgn_qualified_type qualified_type;
err = drgn_type_from_dwarf(dbinfo, file, die, &qualified_type);
if (err)
return err;
const struct drgn_type_enumerator *enumerators =
drgn_type_enumerators(qualified_type.type);
size_t num_enumerators = drgn_type_num_enumerators(qualified_type.type);
for (size_t i = 0; i < num_enumerators; i++) {
if (strcmp(enumerators[i].name, name) != 0)
continue;
if (drgn_enum_type_is_signed(qualified_type.type)) {
return drgn_object_set_signed(ret, qualified_type,
enumerators[i].svalue, 0);
} else {
return drgn_object_set_unsigned(ret, qualified_type,
enumerators[i].uvalue,
0);
}
}
UNREACHABLE();
}
static struct drgn_error *
drgn_object_from_dwarf_subprogram(struct drgn_debug_info *dbinfo,
struct drgn_elf_file *file, Dwarf_Die *die,
struct drgn_object *ret)
{
struct drgn_qualified_type qualified_type;
struct drgn_error *err = drgn_type_from_dwarf(dbinfo, file, die,
&qualified_type);
if (err)
return err;
Dwarf_Addr low_pc;
if (dwarf_lowpc(die, &low_pc) == -1) {
return drgn_object_set_absent(ret, qualified_type,
DRGN_ABSENCE_REASON_OPTIMIZED_OUT,
0);
}
return drgn_object_set_reference(ret, qualified_type,
low_pc + file->module->debug_file_bias,
0, 0);
}
static struct drgn_error *read_bits(struct drgn_program *prog, void *dst,
unsigned int dst_bit_offset, uint64_t src,
unsigned int src_bit_offset,
uint64_t bit_size, bool lsb0)
{
struct drgn_error *err;
assert(dst_bit_offset < 8);
assert(src_bit_offset < 8);
if (bit_size == 0)
return NULL;
if (dst_bit_offset == src_bit_offset) {
/*
* We can read directly into the the destination buffer, but we
* may have to preserve some bits at the start and/or end.
*/
uint8_t *d = dst;
uint64_t last_bit = dst_bit_offset + bit_size - 1;
uint8_t first_byte = d[0];
uint8_t last_byte = d[last_bit / 8];
err = drgn_program_read_memory(prog, d, src, last_bit / 8 + 1,
false);
if (err)
return err;
if (dst_bit_offset != 0) {
uint8_t mask =
copy_bits_first_mask(dst_bit_offset, lsb0);
d[0] = (first_byte & ~mask) | (d[0] & mask);
}
if (last_bit % 8 != 7) {
uint8_t mask = copy_bits_last_mask(last_bit, lsb0);
d[last_bit / 8] = ((last_byte & ~mask)
| (d[last_bit / 8] & mask));
}
return NULL;
} else {
/*
* If the source and destination have different offsets, then
* depending on the size and source offset, we may have to read
* one more byte than is available in the destination. To keep
* things simple, we always read into a temporary buffer (rather
* than adding a special case for reading directly into the
* destination and shifting bits around).
*/
uint64_t src_bytes = (src_bit_offset + bit_size - 1) / 8 + 1;
char stack_tmp[16], *tmp;
if (src_bytes <= sizeof(stack_tmp)) {
tmp = stack_tmp;
} else {
tmp = malloc64(src_bytes);
if (!tmp)
return &drgn_enomem;
}
err = drgn_program_read_memory(prog, tmp, src, src_bytes,
false);
if (!err) {
copy_bits(dst, dst_bit_offset, tmp, src_bit_offset,
bit_size, lsb0);
}
if (src_bytes > sizeof(stack_tmp))
free(tmp);
return err;
}
}
static struct drgn_error *
drgn_object_from_dwarf_location(struct drgn_program *prog,
struct drgn_elf_file *file, Dwarf_Die *die,
struct drgn_qualified_type qualified_type,
const char *expr, size_t expr_size,
Dwarf_Die *function_die,
const struct drgn_register_state *regs,
struct drgn_object *ret)
{
struct drgn_error *err;
bool little_endian = drgn_elf_file_is_little_endian(file);
uint64_t address_mask = drgn_elf_file_address_mask(file);
const struct drgn_register_layout *register_layout =
file->platform.arch->register_layout;
drgn_register_number (*dwarf_regno_to_internal)(uint64_t) =
file->platform.arch->dwarf_regno_to_internal;
struct drgn_object_type type;
err = drgn_object_type(qualified_type, 0, &type);
if (err)
return err;
union drgn_value value;
char *value_buf = NULL;
uint64_t address = 0; /* GCC thinks this may be used uninitialized. */
int bit_offset = -1; /* -1 means that we don't have an address. */
enum drgn_absence_reason absence_reason =
DRGN_ABSENCE_REASON_OPTIMIZED_OUT;
uint64_t bit_pos = 0;
int remaining_ops = MAX_DWARF_EXPR_OPS;
struct drgn_dwarf_expression_context ctx;
if ((err = drgn_dwarf_expression_context_init(&ctx, prog, file, die->cu,
function_die, regs, expr,
expr_size)))
return err;
struct uint64_vector stack = VECTOR_INIT;
do {
uint64_vector_clear(&stack);
err = drgn_eval_dwarf_expression(&ctx, &stack, &remaining_ops);
if (err) {
if (err == &drgn_unknown_dwarf_opcode)
absence_reason = DRGN_ABSENCE_REASON_NOT_IMPLEMENTED;
else if (err != &drgn_not_found)
goto out;
goto absent;
}
if (err == &drgn_not_found)
goto absent;
else if (err)
goto out;
const void *src = NULL;
// Silence -Wmaybe-uninitialized false positive last seen with
// GCC 13.
size_t src_size = 0;
if (binary_buffer_has_next(&ctx.bb)) {
uint8_t opcode;
if ((err = binary_buffer_next_u8(&ctx.bb, &opcode)))
goto out;
uint64_t uvalue;
uint64_t dwarf_regno;
drgn_register_number regno;
switch (opcode) {
case DW_OP_reg0 ... DW_OP_reg31:
dwarf_regno = opcode - DW_OP_reg0;
goto reg;
case DW_OP_regx:
if ((err = binary_buffer_next_uleb128(&ctx.bb,
&dwarf_regno)))
goto out;
reg:
if (!regs)
goto absent;
regno = dwarf_regno_to_internal(dwarf_regno);
if (!drgn_register_state_has_register(regs,
regno))
goto absent;
const struct drgn_register_layout *layout =
®ister_layout[regno];
src = ®s->buf[layout->offset];
src_size = layout->size;
break;
case DW_OP_implicit_value:
if ((err = binary_buffer_next_uleb128(&ctx.bb,
&uvalue)))
goto out;
if (uvalue > ctx.bb.end - ctx.bb.pos) {
err = binary_buffer_error(&ctx.bb,
"DW_OP_implicit_value size is out of bounds");
goto out;
}
src = ctx.bb.pos;
src_size = uvalue;
ctx.bb.pos += uvalue;
break;
case DW_OP_stack_value:
if (uint64_vector_empty(&stack))
goto absent;
if (little_endian != HOST_LITTLE_ENDIAN) {
*uint64_vector_last(&stack) =
bswap_64(*uint64_vector_last(&stack));
}
src = uint64_vector_last(&stack);
src_size = sizeof(uint64_t);
break;
default:
ctx.bb.pos = ctx.bb.prev;
break;
}
}
uint64_t piece_bit_size;
uint64_t piece_bit_offset;
if (binary_buffer_has_next(&ctx.bb)) {
uint8_t opcode;
if ((err = binary_buffer_next_u8(&ctx.bb, &opcode)))
goto out;
switch (opcode) {
case DW_OP_piece:
if ((err = binary_buffer_next_uleb128(&ctx.bb,
&piece_bit_size)))
goto out;
/*
* It's probably bogus for the piece size to be
* larger than the remaining value size, but
* that's not explicitly stated in the DWARF 5
* specification, so clamp it instead.
*/
if (__builtin_mul_overflow(piece_bit_size, 8U,
&piece_bit_size) ||
piece_bit_size > type.bit_size - bit_pos)
piece_bit_size = type.bit_size - bit_pos;
piece_bit_offset = 0;
break;
case DW_OP_bit_piece:
if ((err = binary_buffer_next_uleb128(&ctx.bb,
&piece_bit_size)) ||
(err = binary_buffer_next_uleb128(&ctx.bb,
&piece_bit_offset)))
goto out;
if (piece_bit_size > type.bit_size - bit_pos)
piece_bit_size = type.bit_size - bit_pos;
break;
default:
drgn_handle_unknown_dwarf_opcode(&ctx, opcode,
true);
absence_reason = DRGN_ABSENCE_REASON_NOT_IMPLEMENTED;
goto absent;
}
} else {
piece_bit_size = type.bit_size - bit_pos;
piece_bit_offset = 0;
}
/*
* TODO: there are a few cases that a DWARF location can
* describe that can't be represented in drgn's object model:
*
* 1. An object that is partially known and partially unknown.
* 2. An object that is partially in memory and partially a
* value.
* 3. An object that is in memory at non-contiguous addresses.
* 4. A pointer object whose pointer value is not known but
* whose referenced value is known (DW_OP_implicit_pointer).
*
* For case 1, we consider the whole object as absent. For cases
* 2 and 3, we convert the whole object to a value. Case 4 is
* not supported at all. We should add a way to represent all of
* these situations precisely.
*/
if (src && piece_bit_size == 0) {
/* Ignore empty value. */
} else if (src) {
if (!value_buf &&
!drgn_value_zalloc(drgn_value_size(type.bit_size),
&value, &value_buf)) {
err = &drgn_enomem;
goto out;
}
if (bit_offset >= 0) {
/*
* We previously had an address. Read it into
* the value.
*/
err = read_bits(prog, value_buf, 0, address,
bit_offset, bit_pos,
little_endian);
if (err)
goto out;
bit_offset = -1;
}
/*
* It's probably safe to assume that we don't have an
* implicit value larger than 2 exabytes.
*/
assert(src_size <= UINT64_MAX / 8);
uint64_t src_bit_size = UINT64_C(8) * src_size;
if (piece_bit_offset > src_bit_size)
piece_bit_offset = src_bit_size;
uint64_t copy_bit_size =
min(piece_bit_size,
src_bit_size - piece_bit_offset);
uint64_t copy_bit_offset = bit_pos;
if (!little_endian) {
copy_bit_offset += piece_bit_size - copy_bit_size;
piece_bit_offset = (src_bit_size
- copy_bit_size
- piece_bit_offset);
}
copy_bits(&value_buf[copy_bit_offset / 8],
copy_bit_offset % 8,
(const char *)src + (piece_bit_offset / 8),
piece_bit_offset % 8, copy_bit_size,
little_endian);
} else if (!uint64_vector_empty(&stack)) {
uint64_t piece_address =
((*uint64_vector_last(&stack)
+ piece_bit_offset / 8)
& address_mask);
piece_bit_offset %= 8;
if (bit_pos > 0 && bit_offset >= 0) {
/*
* We already had an address. Merge the pieces
* if the addresses are contiguous, otherwise
* convert to a value.
*
* The obvious way to write this is
* (address + (bit_pos + bit_offset) / 8), but
* (bit_pos + bit_offset) can overflow uint64_t.
*/
uint64_t end_address =
((address
+ bit_pos / 8
+ (bit_pos % 8 + bit_offset) / 8)
& address_mask);
unsigned int end_bit_offset =
(bit_offset + bit_pos) % 8;
if (piece_bit_size == 0 ||
(piece_address == end_address &&
piece_bit_offset == end_bit_offset)) {
/* Piece is contiguous. */
piece_address = address;
piece_bit_offset = bit_offset;
} else {
if (!drgn_value_zalloc(drgn_value_size(type.bit_size),
&value,
&value_buf)) {
err = &drgn_enomem;
goto out;
}
err = read_bits(prog, value_buf, 0,
address, bit_offset,
bit_pos, little_endian);
if (err)
goto out;
bit_offset = -1;
}
}
if (value_buf) {
/* We already have a value. Read into it. */
err = read_bits(prog, &value_buf[bit_pos / 8],
bit_pos % 8, piece_address,
piece_bit_offset,
piece_bit_size, little_endian);
if (err)
goto out;
} else {
address = piece_address;
bit_offset = piece_bit_offset;
}
} else if (piece_bit_size > 0) {
goto absent;
}
bit_pos += piece_bit_size;
} while (binary_buffer_has_next(&ctx.bb));
if (bit_pos < type.bit_size || (bit_offset < 0 && !value_buf)) {
absent:
if (dwarf_tag(die) == DW_TAG_template_value_parameter) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_AT_template_value_parameter is missing value");
}
drgn_object_set_absent_internal(ret, &type, absence_reason);
err = NULL;
} else if (bit_offset >= 0) {
err = drgn_object_set_reference_internal(ret, &type, address,
bit_offset);
} else if (type.encoding == DRGN_OBJECT_ENCODING_BUFFER) {
drgn_object_reinit(ret, &type, DRGN_OBJECT_VALUE);
ret->value = value;
value_buf = NULL;
err = NULL;
} else {
err = drgn_object_set_from_buffer_internal(ret, &type,
value_buf, 0);
}
out:
if (value_buf != value.ibuf)
free(value_buf);
uint64_vector_deinit(&stack);
return err;
}
static struct drgn_error *
drgn_object_from_dwarf_constant(struct drgn_debug_info *dbinfo, Dwarf_Die *die,
struct drgn_qualified_type qualified_type,
Dwarf_Attribute *attr, struct drgn_object *ret)
{
struct drgn_object_type type;
struct drgn_error *err = drgn_object_type(qualified_type, 0, &type);
if (err)
return err;
Dwarf_Block block;
if (dwarf_formblock(attr, &block) == 0) {
if (block.length < drgn_value_size(type.bit_size)) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_AT_const_value block is too small");
}
return drgn_object_set_from_buffer_internal(ret, &type,
block.data, 0);
} else if (type.encoding == DRGN_OBJECT_ENCODING_SIGNED) {
Dwarf_Sword svalue;
if (dwarf_formsdata(attr, &svalue)) {
return drgn_error_create(DRGN_ERROR_OTHER,
"invalid DW_AT_const_value");
}
return drgn_object_set_signed_internal(ret, &type, svalue);
} else if (type.encoding == DRGN_OBJECT_ENCODING_UNSIGNED) {
Dwarf_Word uvalue;
if (dwarf_formudata(attr, &uvalue)) {
return drgn_error_create(DRGN_ERROR_OTHER,
"invalid DW_AT_const_value");
}
return drgn_object_set_unsigned_internal(ret, &type, uvalue);
} else {
return drgn_error_create(DRGN_ERROR_OTHER,
"unknown DW_AT_const_value form");
}
}
struct drgn_error *
drgn_object_from_dwarf(struct drgn_debug_info *dbinfo,
struct drgn_elf_file *file, Dwarf_Die *die,
Dwarf_Die *type_die, Dwarf_Die *function_die,
const struct drgn_register_state *regs,
struct drgn_object *ret)
{
struct drgn_error *err;
if (dwarf_tag(die) == DW_TAG_subprogram) {
return drgn_object_from_dwarf_subprogram(dbinfo, file, die,
ret);
}
/*
* The DWARF 5 specifications mentions that data object entries can have
* DW_AT_endianity, but that doesn't seem to be used in practice. It
* would be inconvenient to support, so ignore it for now.
*/
struct drgn_qualified_type qualified_type;
if (type_die) {
err = drgn_type_from_dwarf(dbinfo, file, type_die,
&qualified_type);
} else {
err = drgn_type_from_dwarf_attr(dbinfo, file, die, NULL, true,
true, NULL, &qualified_type);
}
if (err)
return err;
Dwarf_Attribute attr_mem, *attr;
const char *expr;
size_t expr_size;
if ((attr = dwarf_attr_integrate(die, DW_AT_location, &attr_mem))) {
err = drgn_dwarf_location(file, attr, regs, &expr, &expr_size);
if (err)
return err;
} else if ((attr = dwarf_attr_integrate(die, DW_AT_const_value,
&attr_mem))) {
return drgn_object_from_dwarf_constant(dbinfo, die,
qualified_type, attr,
ret);
} else {
expr = NULL;
expr_size = 0;
}
return drgn_object_from_dwarf_location(dbinfo->prog, file, die,
qualified_type, expr, expr_size,
function_die, regs, ret);
}
DEFINE_VECTOR(const_char_p_vector, const char *);
static struct drgn_error *add_dwarf_enumerators(Dwarf_Die *enumeration_type,
struct const_char_p_vector *vec)
{
Dwarf_Die child;
int r = dwarf_child(enumeration_type, &child);
while (r == 0) {
if (dwarf_tag(&child) == DW_TAG_enumerator) {
const char *die_name = dwarf_diename(&child);
if (!die_name)
continue;
if (!const_char_p_vector_append(vec, &die_name))
return &drgn_enomem;
}
r = dwarf_siblingof(&child, &child);
}
if (r < 0)
return drgn_error_libdw();
return NULL;
}
struct drgn_error *drgn_dwarf_scopes_names(Dwarf_Die *scopes,
size_t num_scopes,
const char ***names_ret,
size_t *count_ret)
{
struct drgn_error *err;
Dwarf_Die die;
VECTOR(const_char_p_vector, vec);
for (size_t scope = 0; scope < num_scopes; scope++) {
if (dwarf_child(&scopes[scope], &die) != 0)
continue;
do {
switch (dwarf_tag(&die)) {
case DW_TAG_variable:
case DW_TAG_formal_parameter:
case DW_TAG_subprogram: {
const char *die_name = dwarf_diename(&die);
if (!die_name)
continue;
if (!const_char_p_vector_append(&vec,
&die_name))
return &drgn_enomem;
break;
}
case DW_TAG_enumeration_type: {
bool enum_class;
if (dwarf_flag_integrate(&die, DW_AT_enum_class,
&enum_class))
return drgn_error_libdw();
if (!enum_class) {
err = add_dwarf_enumerators(&die, &vec);
if (err)
return err;
}
break;
}
default:
continue;
}
} while (dwarf_siblingof(&die, &die) == 0);
}
const_char_p_vector_shrink_to_fit(&vec);
const_char_p_vector_steal(&vec, names_ret, count_ret);
return NULL;
}
static struct drgn_error *find_dwarf_enumerator(Dwarf_Die *enumeration_type,
const char *name,
Dwarf_Die *ret)
{
int r = dwarf_child(enumeration_type, ret);
while (r == 0) {
if (dwarf_tag(ret) == DW_TAG_enumerator) {
const char *die_name = dwarf_diename(ret);
if (die_name && strcmp(die_name, name) == 0)
return NULL;
}
r = dwarf_siblingof(ret, ret);
}
if (r < 0)
return drgn_error_libdw();
ret->addr = NULL;
return NULL;
}
struct drgn_error *drgn_find_in_dwarf_scopes(Dwarf_Die *scopes,
size_t num_scopes,
const char *name,
Dwarf_Die *die_ret,
Dwarf_Die *type_ret)
{
struct drgn_error *err;
Dwarf_Die die;
for (size_t scope = num_scopes; scope--;) {
bool have_declaration = false;
if (dwarf_child(&scopes[scope], &die) != 0)
continue;
do {
switch (dwarf_tag(&die)) {
case DW_TAG_variable:
case DW_TAG_formal_parameter:
case DW_TAG_subprogram: {
const char *die_name = dwarf_diename(&die);
if (die_name && strcmp(die_name, name) == 0) {
*die_ret = die;
bool declaration;
if (dwarf_flag(&die, DW_AT_declaration,
&declaration))
return drgn_error_libdw();
if (declaration)
have_declaration = true;
else
return NULL;
}
break;
}
case DW_TAG_enumeration_type: {
bool enum_class;
if (dwarf_flag_integrate(&die, DW_AT_enum_class,
&enum_class))
return drgn_error_libdw();
if (!enum_class) {
Dwarf_Die enumerator;
err = find_dwarf_enumerator(&die, name,
&enumerator);
if (err)
return err;
if (enumerator.addr) {
*die_ret = enumerator;
*type_ret = die;
return NULL;
}
}
break;
}
default:
continue;
}
} while (dwarf_siblingof(&die, &die) == 0);
if (have_declaration)
return NULL;
}
die_ret->addr = NULL;
return NULL;
}
static struct drgn_error *
drgn_base_type_from_dwarf(struct drgn_debug_info *dbinfo,
struct drgn_elf_file *file, Dwarf_Die *die,
const struct drgn_language *lang,
struct drgn_type **ret)
{
struct drgn_error *err;
const char *name = dwarf_diename(die);
if (!name) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_TAG_base_type has missing or invalid DW_AT_name");
}
Dwarf_Attribute attr;
Dwarf_Word encoding;
if (!dwarf_attr_integrate(die, DW_AT_encoding, &attr) ||
dwarf_formudata(&attr, &encoding)) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_TAG_base_type has missing or invalid DW_AT_encoding");
}
int size = dwarf_bytesize(die);
if (size == -1) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_TAG_base_type has missing or invalid DW_AT_byte_size");
}
enum drgn_byte_order byte_order;
err = dwarf_die_byte_order(die, true, &byte_order);
if (err)
return err;
switch (encoding) {
case DW_ATE_boolean:
return drgn_bool_type_create(dbinfo->prog, name, size,
byte_order, lang, ret);
case DW_ATE_float:
return drgn_float_type_create(dbinfo->prog, name, size,
byte_order, lang, ret);
case DW_ATE_signed:
case DW_ATE_signed_char:
return drgn_int_type_create(dbinfo->prog, name, size, true,
byte_order, lang, ret);
case DW_ATE_unsigned:
case DW_ATE_unsigned_char:
case DW_ATE_UTF:
return drgn_int_type_create(dbinfo->prog, name, size, false,
byte_order, lang, ret);
/* We don't support complex types yet. */
case DW_ATE_complex_float:
default:
return drgn_error_format(DRGN_ERROR_OTHER,
"DW_TAG_base_type has unknown DWARF encoding 0x%llx",
(unsigned long long)encoding);
}
}
static struct drgn_error *
find_namespace_containing_die(struct drgn_debug_info *dbinfo,
Dwarf_Die *die, const struct drgn_language *lang,
struct drgn_namespace_dwarf_index **ret)
{
struct drgn_error *err;
struct drgn_namespace_dwarf_index *ns = &dbinfo->dwarf.global;
if (!lang->has_namespaces) {
*ret = ns;
return NULL;
}
Dwarf_Die *ancestors;
size_t num_ancestors;
err = drgn_find_die_ancestors(die, &ancestors, &num_ancestors);
if (err)
return err;
for (size_t i = 0; i < num_ancestors; i++) {
switch (dwarf_tag(&ancestors[i])) {
#define X(name) case DW_TAG_##name: break;
DRGN_DWARF_INDEX_NAMESPACE_TAGS
#undef X
default:
continue;
}
Dwarf_Attribute attr_mem, *attr;
if (!(attr = dwarf_attr_integrate(&ancestors[i], DW_AT_name,
&attr_mem)))
continue;
const char *name = dwarf_formstring(attr);
if (!name) {
err = drgn_error_libdw();
goto out;
}
err = drgn_namespace_find_child(ns, name, strlen(name), &ns);
if (err)
goto out;
}
*ret = ns;
out:
free(ancestors);
return err;
}
/*
* DW_TAG_structure_type, DW_TAG_union_type, DW_TAG_class_type, and
* DW_TAG_enumeration_type can be incomplete (i.e., have a DW_AT_declaration of
* true). This tries to find the complete type. If it succeeds, it returns NULL.
* If it can't find a complete type, it returns &drgn_not_found. Otherwise, it
* returns an error.
*/
static struct drgn_error *
drgn_debug_info_find_complete(struct drgn_debug_info *dbinfo, int tag,
const char *name, Dwarf_Die *incomplete_die,
const struct drgn_language *lang,
struct drgn_type **ret)
{
struct drgn_error *err;
struct drgn_namespace_dwarf_index *ns;
err = find_namespace_containing_die(dbinfo, incomplete_die, lang, &ns);
if (err)
return err;
enum drgn_dwarf_index_tag dwarf_index_tag;
switch (tag) {
#define X(name) case DW_TAG_##name: dwarf_index_tag = DRGN_DWARF_INDEX_##name; break;
DRGN_DWARF_INDEX_TAGS
#undef X
default:
return NULL;
}
struct drgn_dwarf_index_iterator it;
err = drgn_dwarf_index_iterator_init(&it, ns, name, strlen(name),
&dwarf_index_tag, 1);
if (err)
return err;
/*
* Find a matching DIE. Note that drgn_namespace_dwarf_index does not
* contain DIEs with DW_AT_declaration, so this will always be a
* complete type.
*/
Dwarf_Die die;
struct drgn_elf_file *file;
if (!drgn_dwarf_index_iterator_next(&it, &die, &file))
return &drgn_not_found;
struct drgn_qualified_type qualified_type;
err = drgn_type_from_dwarf(dbinfo, file, &die, &qualified_type);
if (err)
return err;
*ret = qualified_type.type;
return NULL;
}
struct drgn_dwarf_member_thunk_arg {
struct drgn_elf_file *file;
Dwarf_Die die;
bool can_be_incomplete_array;
};
static struct drgn_error *
drgn_dwarf_member_thunk_fn(struct drgn_object *res, void *arg_)
{
struct drgn_error *err;
struct drgn_dwarf_member_thunk_arg *arg = arg_;
if (res) {
struct drgn_qualified_type qualified_type;
err = drgn_type_from_dwarf_attr(&drgn_object_program(res)->dbinfo,
arg->file, &arg->die, NULL,
false,
arg->can_be_incomplete_array,
NULL, &qualified_type);
if (err)
return err;
Dwarf_Attribute attr_mem, *attr;
uint64_t bit_field_size;
if ((attr = dwarf_attr_integrate(&arg->die, DW_AT_bit_size,
&attr_mem))) {
Dwarf_Word bit_size;
if (dwarf_formudata(attr, &bit_size)) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_TAG_member has invalid DW_AT_bit_size");
}
bit_field_size = bit_size;
} else {
bit_field_size = 0;
}
err = drgn_object_set_absent(res, qualified_type,
DRGN_ABSENCE_REASON_OTHER,
bit_field_size);
if (err)
return err;
}
free(arg);
return NULL;
}
static inline bool drgn_dwarf_attribute_is_block(Dwarf_Attribute *attr)
{
switch (attr->form) {
case DW_FORM_block1:
case DW_FORM_block2:
case DW_FORM_block4:
case DW_FORM_block:
return true;
default:
return false;
}
}
static inline bool drgn_dwarf_attribute_is_ptr(Dwarf_Attribute *attr)
{
switch (attr->form) {
case DW_FORM_sec_offset:
return true;
case DW_FORM_data4:
case DW_FORM_data8: {
/*
* dwarf_cu_die() always returns the DIE. We should use
* dwarf_cu_info(), but that requires elfutils >= 0.171.
*/
Dwarf_Die unused;
Dwarf_Half cu_version;
dwarf_cu_die(attr->cu, &unused, &cu_version, NULL, NULL, NULL,
NULL, NULL);
return cu_version <= 3;
}
default:
return false;
}
}
static struct drgn_error *invalid_data_member_location(struct binary_buffer *bb,
const char *pos,
const char *message)
{
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_TAG_member has invalid DW_AT_data_member_location");
}
static struct drgn_error *
drgn_parse_dwarf_data_member_location(Dwarf_Attribute *attr, uint64_t *ret)
{
struct drgn_error *err;
if (drgn_dwarf_attribute_is_block(attr)) {
Dwarf_Block block;
if (dwarf_formblock(attr, &block))
return drgn_error_libdw();
/*
* In DWARF 2, DW_AT_data_member_location is always a location
* description. We can translate a DW_OP_plus_uconst expression
* into a constant offset; other expressions aren't supported
* yet.
*/
struct binary_buffer bb;
/*
* Right now we only parse u8 and ULEB128, so the byte order
* doesn't matter.
*/
binary_buffer_init(&bb, block.data, block.length,
HOST_LITTLE_ENDIAN,
invalid_data_member_location);
uint8_t opcode;
err = binary_buffer_next_u8(&bb, &opcode);
if (err)
return err;
if (opcode != DW_OP_plus_uconst) {
unsupported:
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_TAG_member has unsupported DW_AT_data_member_location");
}
err = binary_buffer_next_uleb128(&bb, ret);
if (err)
return err;
if (binary_buffer_has_next(&bb))
goto unsupported;
} else if (drgn_dwarf_attribute_is_ptr(attr)) {
goto unsupported;
} else {
Dwarf_Word word;
if (dwarf_formudata(attr, &word))
return invalid_data_member_location(NULL, NULL, NULL);
*ret = word;
}
return NULL;
}
static struct drgn_error *
parse_member_offset(Dwarf_Die *die, union drgn_lazy_object *member_object,
bool little_endian, uint64_t *ret)
{
struct drgn_error *err;
Dwarf_Attribute attr_mem;
Dwarf_Attribute *attr;
/*
* The simplest case is when we have DW_AT_data_bit_offset, which is
* already the offset in bits from the beginning of the containing
* object to the beginning of the member (which may be a bit field).
*/
attr = dwarf_attr_integrate(die, DW_AT_data_bit_offset, &attr_mem);
if (attr) {
Dwarf_Word bit_offset;
if (dwarf_formudata(attr, &bit_offset)) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_TAG_member has invalid DW_AT_data_bit_offset");
}
*ret = bit_offset;
return NULL;
}
/*
* Otherwise, we might have DW_AT_data_member_location, which is the
* offset in bytes from the beginning of the containing object.
*/
attr = dwarf_attr_integrate(die, DW_AT_data_member_location, &attr_mem);
if (attr) {
err = drgn_parse_dwarf_data_member_location(attr, ret);
if (err)
return err;
*ret *= 8;
} else {
*ret = 0;
}
/*
* In addition to DW_AT_data_member_location, a bit field might have
* DW_AT_bit_offset, which is the offset in bits of the most significant
* bit of the bit field from the most significant bit of the containing
* object.
*/
attr = dwarf_attr_integrate(die, DW_AT_bit_offset, &attr_mem);
if (attr) {
Dwarf_Word bit_offset;
if (dwarf_formudata(attr, &bit_offset)) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_TAG_member has invalid DW_AT_bit_offset");
}
/*
* If the architecture is little-endian, then we must compute
* the location of the most significant bit from the size of the
* member, then subtract the bit offset and bit size to get the
* location of the beginning of the bit field.
*
* If the architecture is big-endian, then the most significant
* bit of the bit field is the beginning.
*/
if (little_endian) {
err = drgn_lazy_object_evaluate(member_object);
if (err)
return err;
attr = dwarf_attr_integrate(die, DW_AT_byte_size,
&attr_mem);
/*
* If the member has an explicit byte size, we can use
* that. Otherwise, we have to get it from the member
* type.
*/
uint64_t byte_size;
if (attr) {
Dwarf_Word word;
if (dwarf_formudata(attr, &word)) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_TAG_member has invalid DW_AT_byte_size");
}
byte_size = word;
} else {
if (!drgn_type_has_size(member_object->obj.type)) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_TAG_member bit field type does not have size");
}
err = drgn_type_sizeof(member_object->obj.type,
&byte_size);
if (err)
return err;
}
*ret += 8 * byte_size - bit_offset - member_object->obj.bit_size;
} else {
*ret += bit_offset;
}
}
return NULL;
}
static struct drgn_error *
parse_member(struct drgn_debug_info *dbinfo, struct drgn_elf_file *file,
Dwarf_Die *die, bool little_endian, bool can_be_incomplete_array,
struct drgn_compound_type_builder *builder)
{
struct drgn_error *err;
Dwarf_Attribute attr_mem, *attr;
const char *name;
if ((attr = dwarf_attr_integrate(die, DW_AT_name, &attr_mem))) {
name = dwarf_formstring(attr);
if (!name) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_TAG_member has invalid DW_AT_name");
}
} else {
name = NULL;
}
struct drgn_dwarf_member_thunk_arg *thunk_arg =
malloc(sizeof(*thunk_arg));
if (!thunk_arg)
return &drgn_enomem;
thunk_arg->file = file;
thunk_arg->die = *die;
thunk_arg->can_be_incomplete_array = can_be_incomplete_array;
union drgn_lazy_object member_object;
drgn_lazy_object_init_thunk(&member_object, dbinfo->prog,
drgn_dwarf_member_thunk_fn, thunk_arg);
uint64_t bit_offset;
err = parse_member_offset(die, &member_object, little_endian,
&bit_offset);
if (err)
goto err;
err = drgn_compound_type_builder_add_member(builder, &member_object,
name, bit_offset);
if (err)
goto err;
return NULL;
err:
drgn_lazy_object_deinit(&member_object);
return err;
}
struct drgn_dwarf_die_thunk_arg {
struct drgn_elf_file *file;
Dwarf_Die die;
};
static struct drgn_error *
drgn_dwarf_template_type_parameter_thunk_fn(struct drgn_object *res, void *arg_)
{
struct drgn_error *err;
struct drgn_dwarf_die_thunk_arg *arg = arg_;
if (res) {
struct drgn_qualified_type qualified_type;
err = drgn_type_from_dwarf_attr(&drgn_object_program(res)->dbinfo,
arg->file, &arg->die, NULL,
true, true, NULL,
&qualified_type);
if (err)
return err;
err = drgn_object_set_absent(res, qualified_type,
DRGN_ABSENCE_REASON_OTHER, 0);
if (err)
return err;
}
free(arg);
return NULL;
}
static struct drgn_error *
drgn_dwarf_template_value_parameter_thunk_fn(struct drgn_object *res,
void *arg_)
{
struct drgn_error *err;
struct drgn_dwarf_die_thunk_arg *arg = arg_;
if (res) {
err = drgn_object_from_dwarf(&drgn_object_program(res)->dbinfo,
arg->file, &arg->die, NULL, NULL,
NULL, res);
if (err)
return err;
}
free(arg);
return NULL;
}
static struct drgn_error *
maybe_parse_template_parameter(struct drgn_debug_info *dbinfo,
struct drgn_elf_file *file, Dwarf_Die *die,
struct drgn_template_parameters_builder *builder)
{
drgn_object_thunk_fn *thunk_fn;
switch (dwarf_tag(die)) {
case DW_TAG_template_type_parameter:
thunk_fn = drgn_dwarf_template_type_parameter_thunk_fn;
break;
case DW_TAG_template_value_parameter:
thunk_fn = drgn_dwarf_template_value_parameter_thunk_fn;
break;
default:
return NULL;
}
char tag_buf[DW_TAG_STR_BUF_LEN];
Dwarf_Attribute attr_mem, *attr;
const char *name;
if ((attr = dwarf_attr_integrate(die, DW_AT_name, &attr_mem))) {
name = dwarf_formstring(attr);
if (!name) {
return drgn_error_format(DRGN_ERROR_OTHER,
"%s has invalid DW_AT_name",
dwarf_tag_str(die, tag_buf));
}
} else {
name = NULL;
}
bool defaulted;
if (dwarf_flag_integrate(die, DW_AT_default_value, &defaulted)) {
return drgn_error_format(DRGN_ERROR_OTHER,
"%s has invalid DW_AT_default_value",
dwarf_tag_str(die, tag_buf));
}
struct drgn_dwarf_die_thunk_arg *thunk_arg =
malloc(sizeof(*thunk_arg));
if (!thunk_arg)
return &drgn_enomem;
thunk_arg->file = file;
thunk_arg->die = *die;
union drgn_lazy_object argument;
drgn_lazy_object_init_thunk(&argument, dbinfo->prog, thunk_fn,
thunk_arg);
struct drgn_error *err =
drgn_template_parameters_builder_add(builder, &argument, name,
defaulted);
if (err)
drgn_lazy_object_deinit(&argument);
return err;
}
static struct drgn_error *
drgn_parse_template_parameter_pack(struct drgn_debug_info *dbinfo,
struct drgn_elf_file *file, Dwarf_Die *die,
struct drgn_template_parameters_builder *builder)
{
struct drgn_error *err;
Dwarf_Die child;
int r = dwarf_child(die, &child);
while (r == 0) {
err = maybe_parse_template_parameter(dbinfo, file, &child, builder);
if (err)
return err;
r = dwarf_siblingof(&child, &child);
}
if (r == -1) {
return drgn_error_create(DRGN_ERROR_OTHER,
"libdw could not parse DIE children");
}
return NULL;
}
static struct drgn_error *
drgn_compound_type_from_dwarf(struct drgn_debug_info *dbinfo,
struct drgn_elf_file *file, Dwarf_Die *die,
const struct drgn_language *lang,
enum drgn_type_kind kind, struct drgn_type **ret)
{
struct drgn_error *err;
char tag_buf[DW_TAG_STR_BUF_LEN];
Dwarf_Attribute attr_mem;
Dwarf_Attribute *attr = dwarf_attr_integrate(die, DW_AT_name,
&attr_mem);
const char *tag;
if (attr) {
tag = dwarf_formstring(attr);
if (!tag) {
return drgn_error_format(DRGN_ERROR_OTHER,
"%s has invalid DW_AT_name",
dwarf_tag_str(die, tag_buf));
}
} else {
tag = NULL;
}
bool declaration;
if (dwarf_flag(die, DW_AT_declaration, &declaration)) {
return drgn_error_format(DRGN_ERROR_OTHER,
"%s has invalid DW_AT_declaration",
dwarf_tag_str(die, tag_buf));
}
if (declaration && tag) {
err = drgn_debug_info_find_complete(dbinfo, dwarf_tag(die), tag,
die, lang, ret);
if (err != &drgn_not_found)
return err;
}
struct drgn_compound_type_builder builder;
drgn_compound_type_builder_init(&builder, dbinfo->prog, kind);
int size;
bool little_endian;
if (declaration) {
size = 0;
} else {
size = dwarf_bytesize(die);
if (size == -1) {
return drgn_error_format(DRGN_ERROR_OTHER,
"%s has missing or invalid DW_AT_byte_size",
dwarf_tag_str(die, tag_buf));
}
dwarf_die_is_little_endian(die, false, &little_endian);
}
Dwarf_Die member = {}, child;
bool first_member = true;
int r = dwarf_child(die, &child);
while (r == 0) {
switch (dwarf_tag(&child)) {
case DW_TAG_member:
if (!declaration) {
if (member.addr) {
err = parse_member(dbinfo, file,
&member,
little_endian, false,
&builder);
if (err)
goto err;
first_member = false;
}
member = child;
}
break;
case DW_TAG_template_type_parameter:
case DW_TAG_template_value_parameter:
err = maybe_parse_template_parameter(dbinfo, file, &child,
&builder.template_builder);
if (err)
goto err;
break;
case DW_TAG_GNU_template_parameter_pack:
err = drgn_parse_template_parameter_pack(dbinfo, file, &child,
&builder.template_builder);
if (err)
goto err;
break;
default:
break;
}
r = dwarf_siblingof(&child, &child);
}
if (r == -1) {
err = drgn_error_create(DRGN_ERROR_OTHER,
"libdw could not parse DIE children");
goto err;
}
/*
* Flexible array members are only allowed as the last member of a
* structure with at least one other member.
*/
if (member.addr) {
err = parse_member(dbinfo, file, &member, little_endian,
kind != DRGN_TYPE_UNION && !first_member,
&builder);
if (err)
goto err;
}
err = drgn_compound_type_create(&builder, tag, size, !declaration, lang,
ret);
if (err)
goto err;
return NULL;
err:
drgn_compound_type_builder_deinit(&builder);
return err;
}
static struct drgn_error *
parse_enumerator(Dwarf_Die *die, struct drgn_enum_type_builder *builder,
bool *is_signed)
{
const char *name = dwarf_diename(die);
if (!name) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_TAG_enumerator has missing or invalid DW_AT_name");
}
Dwarf_Attribute attr_mem, *attr;
if (!(attr = dwarf_attr_integrate(die, DW_AT_const_value, &attr_mem))) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_TAG_enumerator is missing DW_AT_const_value");
}
struct drgn_error *err;
if (attr->form == DW_FORM_sdata ||
attr->form == DW_FORM_implicit_const) {
Dwarf_Sword svalue;
if (dwarf_formsdata(attr, &svalue))
goto invalid;
err = drgn_enum_type_builder_add_signed(builder, name,
svalue);
/*
* GCC before 7.1 didn't include DW_AT_encoding for
* DW_TAG_enumeration_type DIEs, so we have to guess the sign
* for enum_compatible_type_fallback().
*/
if (!err && svalue < 0)
*is_signed = true;
} else {
Dwarf_Word uvalue;
if (dwarf_formudata(attr, &uvalue))
goto invalid;
err = drgn_enum_type_builder_add_unsigned(builder, name,
uvalue);
}
return err;
invalid:
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_TAG_enumerator has invalid DW_AT_const_value");
}
/*
* GCC before 5.1 did not include DW_AT_type for DW_TAG_enumeration_type DIEs,
* so we have to fabricate the compatible type.
*/
static struct drgn_error *
enum_compatible_type_fallback(struct drgn_debug_info *dbinfo,
Dwarf_Die *die, bool is_signed,
const struct drgn_language *lang,
struct drgn_type **ret)
{
int size = dwarf_bytesize(die);
if (size == -1) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_TAG_enumeration_type has missing or invalid DW_AT_byte_size");
}
enum drgn_byte_order byte_order;
dwarf_die_byte_order(die, false, &byte_order);
return drgn_int_type_create(dbinfo->prog, "<unknown>", size, is_signed,
byte_order, lang, ret);
}
static struct drgn_error *
drgn_enum_type_from_dwarf(struct drgn_debug_info *dbinfo,
struct drgn_elf_file *file, Dwarf_Die *die,
const struct drgn_language *lang,
struct drgn_type **ret)
{
struct drgn_error *err;
Dwarf_Attribute attr_mem;
Dwarf_Attribute *attr = dwarf_attr_integrate(die, DW_AT_name,
&attr_mem);
const char *tag;
if (attr) {
tag = dwarf_formstring(attr);
if (!tag)
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_TAG_enumeration_type has invalid DW_AT_name");
} else {
tag = NULL;
}
bool declaration;
if (dwarf_flag(die, DW_AT_declaration, &declaration)) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_TAG_enumeration_type has invalid DW_AT_declaration");
}
if (declaration && tag) {
err = drgn_debug_info_find_complete(dbinfo,
DW_TAG_enumeration_type,
tag, die, lang, ret);
if (err != &drgn_not_found)
return err;
}
if (declaration) {
return drgn_incomplete_enum_type_create(dbinfo->prog, tag, lang,
ret);
}
struct drgn_enum_type_builder builder;
drgn_enum_type_builder_init(&builder, dbinfo->prog);
bool is_signed = false;
Dwarf_Die child;
int r = dwarf_child(die, &child);
while (r == 0) {
if (dwarf_tag(&child) == DW_TAG_enumerator) {
err = parse_enumerator(&child, &builder, &is_signed);
if (err)
goto err;
}
r = dwarf_siblingof(&child, &child);
}
if (r == -1) {
err = drgn_error_create(DRGN_ERROR_OTHER,
"libdw could not parse DIE children");
goto err;
}
struct drgn_type *compatible_type;
r = dwarf_type(die, &child);
if (r == -1) {
err = drgn_error_create(DRGN_ERROR_OTHER,
"DW_TAG_enumeration_type has invalid DW_AT_type");
goto err;
} else if (r) {
err = enum_compatible_type_fallback(dbinfo, die, is_signed,
lang, &compatible_type);
if (err)
goto err;
} else {
struct drgn_qualified_type qualified_compatible_type;
err = drgn_type_from_dwarf(dbinfo, file, &child,
&qualified_compatible_type);
if (err)
goto err;
compatible_type =
drgn_underlying_type(qualified_compatible_type.type);
if (drgn_type_kind(compatible_type) != DRGN_TYPE_INT) {
err = drgn_error_create(DRGN_ERROR_OTHER,
"DW_AT_type of DW_TAG_enumeration_type is not an integer type");
goto err;
}
}
err = drgn_enum_type_create(&builder, tag, compatible_type, lang, ret);
if (err)
goto err;
return NULL;
err:
drgn_enum_type_builder_deinit(&builder);
return err;
}
static struct drgn_error *
drgn_typedef_type_from_dwarf(struct drgn_debug_info *dbinfo,
struct drgn_elf_file *file, Dwarf_Die *die,
const struct drgn_language *lang,
bool can_be_incomplete_array,
bool *is_incomplete_array_ret,
struct drgn_type **ret)
{
const char *name = dwarf_diename(die);
if (!name) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_TAG_typedef has missing or invalid DW_AT_name");
}
struct drgn_qualified_type aliased_type;
struct drgn_error *err = drgn_type_from_dwarf_attr(dbinfo, file, die,
lang, true,
can_be_incomplete_array,
is_incomplete_array_ret,
&aliased_type);
if (err)
return err;
return drgn_typedef_type_create(dbinfo->prog, name, aliased_type, lang,
ret);
}
static struct drgn_error *
drgn_pointer_type_from_dwarf(struct drgn_debug_info *dbinfo,
struct drgn_elf_file *file, Dwarf_Die *die,
const struct drgn_language *lang,
struct drgn_type **ret)
{
struct drgn_qualified_type referenced_type;
struct drgn_error *err = drgn_type_from_dwarf_attr(dbinfo, file, die,
lang, true, true,
NULL,
&referenced_type);
if (err)
return err;
Dwarf_Attribute attr_mem, *attr;
uint64_t size;
if ((attr = dwarf_attr_integrate(die, DW_AT_byte_size, &attr_mem))) {
Dwarf_Word word;
if (dwarf_formudata(attr, &word)) {
return drgn_error_format(DRGN_ERROR_OTHER,
"DW_TAG_pointer_type has invalid DW_AT_byte_size");
}
size = word;
} else {
// dwarf_diecu() always returns the DIE. We should use
// dwarf_cu_info(), but that requires elfutils >= 0.171.
Dwarf_Die unused;
uint8_t address_size;
dwarf_diecu(die, &unused, &address_size, NULL);
size = address_size;
}
/*
* The DWARF 5 specification doesn't mention DW_AT_endianity for
* DW_TAG_pointer_type DIEs, and GCC as of version 10.2 doesn't emit it
* even for pointers stored in the opposite byte order (e.g., when using
* scalar_storage_order), but it probably should.
*/
enum drgn_byte_order byte_order;
dwarf_die_byte_order(die, false, &byte_order);
return drgn_pointer_type_create(dbinfo->prog, referenced_type, size,
byte_order, lang, ret);
}
struct array_dimension {
uint64_t length;
bool is_complete;
};
DEFINE_VECTOR(array_dimension_vector, struct array_dimension);
static struct drgn_error *subrange_length(Dwarf_Die *die,
struct array_dimension *dimension)
{
Dwarf_Attribute attr_mem;
Dwarf_Attribute *attr;
Dwarf_Word word;
if (!(attr = dwarf_attr_integrate(die, DW_AT_upper_bound, &attr_mem)) &&
!(attr = dwarf_attr_integrate(die, DW_AT_count, &attr_mem))) {
dimension->is_complete = false;
return NULL;
}
if (dwarf_formudata(attr, &word)) {
return drgn_error_format(DRGN_ERROR_OTHER,
"DW_TAG_subrange_type has invalid %s",
attr->code == DW_AT_upper_bound ?
"DW_AT_upper_bound" :
"DW_AT_count");
}
dimension->is_complete = true;
/*
* GCC emits a DW_FORM_sdata or DW_FORM_data8 DW_AT_upper_bound of -1
* for empty array variables without an explicit size
* (e.g., `int arr[] = {};`).
*/
if (attr->code == DW_AT_upper_bound && word == (Dwarf_Word)-1) {
dimension->length = 0;
} else if (attr->code == DW_AT_upper_bound) {
if (word >= UINT64_MAX) {
return drgn_error_create(DRGN_ERROR_OVERFLOW,
"DW_AT_upper_bound is too large");
}
dimension->length = (uint64_t)word + 1;
} else {
if (word > UINT64_MAX) {
return drgn_error_create(DRGN_ERROR_OVERFLOW,
"DW_AT_count is too large");
}
dimension->length = word;
}
return NULL;
}
static struct drgn_error *
drgn_array_type_from_dwarf(struct drgn_debug_info *dbinfo,
struct drgn_elf_file *file, Dwarf_Die *die,
const struct drgn_language *lang,
bool can_be_incomplete_array,
bool *is_incomplete_array_ret,
struct drgn_type **ret)
{
struct drgn_error *err;
VECTOR(array_dimension_vector, dimensions);
struct array_dimension *dimension;
Dwarf_Die child;
int r = dwarf_child(die, &child);
while (r == 0) {
if (dwarf_tag(&child) == DW_TAG_subrange_type) {
dimension = array_dimension_vector_append_entry(&dimensions);
if (!dimension)
return &drgn_enomem;
err = subrange_length(&child, dimension);
if (err)
return err;
}
r = dwarf_siblingof(&child, &child);
}
if (r == -1) {
return drgn_error_create(DRGN_ERROR_OTHER,
"libdw could not parse DIE children");
}
if (array_dimension_vector_empty(&dimensions)) {
dimension = array_dimension_vector_append_entry(&dimensions);
if (!dimension)
return &drgn_enomem;
dimension->is_complete = false;
}
struct drgn_qualified_type element_type;
err = drgn_type_from_dwarf_attr(dbinfo, file, die, lang, false, false,
NULL, &element_type);
if (err)
return err;
*is_incomplete_array_ret =
!array_dimension_vector_first(&dimensions)->is_complete;
struct drgn_type *type;
do {
dimension = array_dimension_vector_pop(&dimensions);
if (dimension->is_complete) {
err = drgn_array_type_create(dbinfo->prog, element_type,
dimension->length, lang,
&type);
} else if (!array_dimension_vector_empty(&dimensions)
|| !can_be_incomplete_array) {
err = drgn_array_type_create(dbinfo->prog, element_type,
0, lang, &type);
} else {
err = drgn_incomplete_array_type_create(dbinfo->prog,
element_type,
lang, &type);
}
if (err)
return err;
element_type.type = type;
element_type.qualifiers = 0;
} while (!array_dimension_vector_empty(&dimensions));
*ret = type;
return NULL;
}
static struct drgn_error *
drgn_dwarf_formal_parameter_thunk_fn(struct drgn_object *res, void *arg_)
{
struct drgn_error *err;
struct drgn_dwarf_die_thunk_arg *arg = arg_;
if (res) {
struct drgn_qualified_type qualified_type;
err = drgn_type_from_dwarf_attr(&drgn_object_program(res)->dbinfo,
arg->file, &arg->die, NULL,
false, true, NULL,
&qualified_type);
if (err)
return err;
err = drgn_object_set_absent(res, qualified_type,
DRGN_ABSENCE_REASON_OTHER, 0);
if (err)
return err;
}
free(arg);
return NULL;
}
static struct drgn_error *
parse_formal_parameter(struct drgn_debug_info *dbinfo,
struct drgn_elf_file *file, Dwarf_Die *die,
struct drgn_function_type_builder *builder)
{
Dwarf_Attribute attr_mem, *attr;
const char *name;
if ((attr = dwarf_attr_integrate(die, DW_AT_name, &attr_mem))) {
name = dwarf_formstring(attr);
if (!name) {
return drgn_error_create(DRGN_ERROR_OTHER,
"DW_TAG_formal_parameter has invalid DW_AT_name");
}
} else {
name = NULL;
}
struct drgn_dwarf_die_thunk_arg *thunk_arg =
malloc(sizeof(*thunk_arg));
if (!thunk_arg)
return &drgn_enomem;
thunk_arg->file = file;
thunk_arg->die = *die;
union drgn_lazy_object default_argument;
drgn_lazy_object_init_thunk(&default_argument, dbinfo->prog,
drgn_dwarf_formal_parameter_thunk_fn,
thunk_arg);
struct drgn_error *err =
drgn_function_type_builder_add_parameter(builder,
&default_argument,
name);
if (err)
drgn_lazy_object_deinit(&default_argument);
return err;
}
static struct drgn_error *
drgn_function_type_from_dwarf(struct drgn_debug_info *dbinfo,
struct drgn_elf_file *file, Dwarf_Die *die,
const struct drgn_language *lang,
struct drgn_type **ret)
{
struct drgn_error *err;
char tag_buf[DW_TAG_STR_BUF_LEN];
struct drgn_function_type_builder builder;
drgn_function_type_builder_init(&builder, dbinfo->prog);
bool is_variadic = false;
Dwarf_Die child;
int r = dwarf_child(die, &child);
while (r == 0) {
switch (dwarf_tag(&child)) {
case DW_TAG_formal_parameter:
if (is_variadic) {
err = drgn_error_format(DRGN_ERROR_OTHER,
"%s has DW_TAG_formal_parameter child after DW_TAG_unspecified_parameters child",
dwarf_tag_str(die,
tag_buf));
goto err;
}
err = parse_formal_parameter(dbinfo, file, &child,
&builder);
if (err)
goto err;
break;
case DW_TAG_unspecified_parameters:
if (is_variadic) {
err = drgn_error_format(DRGN_ERROR_OTHER,
"%s has multiple DW_TAG_unspecified_parameters children",
dwarf_tag_str(die,
tag_buf));
goto err;
}
is_variadic = true;
break;
case DW_TAG_template_type_parameter:
case DW_TAG_template_value_parameter:
err = maybe_parse_template_parameter(dbinfo, file, &child,
&builder.template_builder);
if (err)
goto err;
break;
case DW_TAG_GNU_template_parameter_pack:
err = drgn_parse_template_parameter_pack(dbinfo, file, &child,
&builder.template_builder);
if (err)
goto err;
break;
default:
break;
}
r = dwarf_siblingof(&child, &child);
}
if (r == -1) {
err = drgn_error_create(DRGN_ERROR_OTHER,
"libdw could not parse DIE children");
goto err;
}
struct drgn_qualified_type return_type;
err = drgn_type_from_dwarf_attr(dbinfo, file, die, lang, true, true,
NULL, &return_type);
if (err)
goto err;
err = drgn_function_type_create(&builder, return_type, is_variadic,
lang, ret);
if (err)
goto err;
return NULL;
err:
drgn_function_type_builder_deinit(&builder);
return err;
}
static struct drgn_error *
drgn_type_from_dwarf_internal(struct drgn_debug_info *dbinfo,
struct drgn_elf_file *file, Dwarf_Die *die,
bool can_be_incomplete_array,
bool *is_incomplete_array_ret,
struct drgn_qualified_type *ret)
{
drgn_recursion_guard(1000, "maximum DWARF type parsing depth exceeded");
/* If the DIE has a type unit signature, follow it. */
Dwarf_Die definition_die;
{
Dwarf_Attribute attr_mem, *attr;
if ((attr = dwarf_attr_integrate(die, DW_AT_signature,
&attr_mem))) {
if (!dwarf_formref_die(attr, &definition_die))
return drgn_error_libdw();
die = &definition_die;
}
}
/* If we got a declaration, try to find the definition. */
bool declaration;
if (dwarf_flag(die, DW_AT_declaration, &declaration))
return drgn_error_libdw();
if (declaration) {
uintptr_t die_addr;
if (drgn_dwarf_find_definition(dbinfo, (uintptr_t)die->addr,
&die_addr)) {
struct drgn_dwarf_index_cu *cu =
drgn_dwarf_index_find_cu(dbinfo, die_addr);
definition_die = (Dwarf_Die){
.addr = (void *)die_addr,
.cu = cu->libdw_cu,
};
die = &definition_die;
file = cu->file;
}
}
struct drgn_dwarf_type_map_entry entry = {
.key = die->addr,
};
struct hash_pair hp = drgn_dwarf_type_map_hash(&entry.key);
struct drgn_dwarf_type_map_iterator it =
drgn_dwarf_type_map_search_hashed(&dbinfo->dwarf.types,
&entry.key, hp);
if (it.entry) {
if (!can_be_incomplete_array &&
it.entry->value.is_incomplete_array) {
it = drgn_dwarf_type_map_search_hashed(&dbinfo->dwarf.cant_be_incomplete_array_types,
&entry.key, hp);
}
if (it.entry) {
ret->type = it.entry->value.type;
ret->qualifiers = it.entry->value.qualifiers;
return NULL;
}
}
const struct drgn_language *lang;
struct drgn_error *err = drgn_language_from_die(die, true, &lang);
if (err)
return err;
ret->qualifiers = 0;
entry.value.is_incomplete_array = false;
switch (dwarf_tag(die)) {
case DW_TAG_const_type:
err = drgn_type_from_dwarf_attr(dbinfo, file, die, lang, true,
can_be_incomplete_array,
&entry.value.is_incomplete_array,
ret);
ret->qualifiers |= DRGN_QUALIFIER_CONST;
break;
case DW_TAG_restrict_type:
err = drgn_type_from_dwarf_attr(dbinfo, file, die, lang, true,
can_be_incomplete_array,
&entry.value.is_incomplete_array,
ret);
ret->qualifiers |= DRGN_QUALIFIER_RESTRICT;
break;
case DW_TAG_volatile_type:
err = drgn_type_from_dwarf_attr(dbinfo, file, die, lang, true,
can_be_incomplete_array,
&entry.value.is_incomplete_array,
ret);
ret->qualifiers |= DRGN_QUALIFIER_VOLATILE;
break;
case DW_TAG_atomic_type:
err = drgn_type_from_dwarf_attr(dbinfo, file, die, lang, true,
can_be_incomplete_array,
&entry.value.is_incomplete_array,
ret);
ret->qualifiers |= DRGN_QUALIFIER_ATOMIC;
break;
case DW_TAG_base_type:
err = drgn_base_type_from_dwarf(dbinfo, file, die, lang,
&ret->type);
break;
case DW_TAG_structure_type:
err = drgn_compound_type_from_dwarf(dbinfo, file, die, lang,
DRGN_TYPE_STRUCT,
&ret->type);
break;
case DW_TAG_union_type:
err = drgn_compound_type_from_dwarf(dbinfo, file, die, lang,
DRGN_TYPE_UNION,
&ret->type);
break;
case DW_TAG_class_type:
err = drgn_compound_type_from_dwarf(dbinfo, file, die, lang,
DRGN_TYPE_CLASS,
&ret->type);
break;
case DW_TAG_enumeration_type:
err = drgn_enum_type_from_dwarf(dbinfo, file, die, lang,
&ret->type);
break;
case DW_TAG_typedef:
err = drgn_typedef_type_from_dwarf(dbinfo, file, die, lang,
can_be_incomplete_array,
&entry.value.is_incomplete_array,
&ret->type);
break;
case DW_TAG_pointer_type:
err = drgn_pointer_type_from_dwarf(dbinfo, file, die, lang,
&ret->type);
break;
case DW_TAG_array_type:
err = drgn_array_type_from_dwarf(dbinfo, file, die, lang,
can_be_incomplete_array,
&entry.value.is_incomplete_array,
&ret->type);
break;
case DW_TAG_subroutine_type:
case DW_TAG_subprogram:
err = drgn_function_type_from_dwarf(dbinfo, file, die, lang,
&ret->type);
break;
default:
err = drgn_error_format(DRGN_ERROR_OTHER,
"unknown DWARF type tag 0x%x",
dwarf_tag(die));
break;
}
if (err)
return err;
if (drgn_type_has_die_addr(ret->type))
drgn_type_init_die_addr(ret->type, (uintptr_t)die->addr);
entry.value.type = ret->type;
entry.value.qualifiers = ret->qualifiers;
struct drgn_dwarf_type_map *map;
if (!can_be_incomplete_array && entry.value.is_incomplete_array)
map = &dbinfo->dwarf.cant_be_incomplete_array_types;
else
map = &dbinfo->dwarf.types;
if (drgn_dwarf_type_map_insert_searched(map, &entry, hp, NULL) == -1) {
/*
* This will "leak" the type we created, but it'll still be
* cleaned up when the program is freed.
*/
return &drgn_enomem;
}
if (is_incomplete_array_ret)
*is_incomplete_array_ret = entry.value.is_incomplete_array;
return NULL;
}
static struct drgn_error *
find_enclosing_namespace(struct drgn_namespace_dwarf_index *global_namespace,
const char **name, size_t *name_len,
struct drgn_namespace_dwarf_index **namespace_ret)
{
struct drgn_error *err;
*namespace_ret = global_namespace;
if (*name_len >= 2 && memcmp(*name, "::", 2) == 0) {
/* Explicit global namespace. */
*name_len -= 2;
*name += 2;
}
const char *template_parameters_start = memchr(*name, '<', *name_len);
ptrdiff_t searchable_len =
template_parameters_start ?
template_parameters_start - *name:
*name_len;
const char *colons;
while ((colons = memmem(*name, searchable_len, "::", 2))) {
err = drgn_namespace_find_child(*namespace_ret, *name,
colons - *name, namespace_ret);
if (err)
return err;
size_t chars_consumed = colons + 2 - *name;
searchable_len -= chars_consumed;
*name_len -= chars_consumed;
*name = colons + 2;
}
return NULL;
}
struct drgn_error *drgn_debug_info_find_type(uint64_t kinds, const char *name,
size_t name_len,
const char *filename, void *arg,
struct drgn_qualified_type *ret)
{
struct drgn_error *err;
struct drgn_debug_info *dbinfo = arg;
enum drgn_dwarf_index_tag tags[6];
size_t num_tags = 0;
if (kinds & ((1 << DRGN_TYPE_INT)
| (1 << DRGN_TYPE_BOOL)
| (1 << DRGN_TYPE_FLOAT)))
tags[num_tags++] = DRGN_DWARF_INDEX_base_type;
if (kinds & (1 << DRGN_TYPE_STRUCT))
tags[num_tags++] = DRGN_DWARF_INDEX_structure_type;
if (kinds & (1 << DRGN_TYPE_UNION))
tags[num_tags++] = DRGN_DWARF_INDEX_union_type;
if (kinds & (1 << DRGN_TYPE_CLASS))
tags[num_tags++] = DRGN_DWARF_INDEX_class_type;
if (kinds & (1 << DRGN_TYPE_ENUM))
tags[num_tags++] = DRGN_DWARF_INDEX_enumeration_type;
if (kinds & (1 << DRGN_TYPE_TYPEDEF))
tags[num_tags++] = DRGN_DWARF_INDEX_typedef;
struct drgn_namespace_dwarf_index *namespace;
err = find_enclosing_namespace(&dbinfo->dwarf.global,
&name, &name_len, &namespace);
if (err)
return err;
struct drgn_dwarf_index_iterator it;
err = drgn_dwarf_index_iterator_init(&it, namespace, name, name_len,
tags, num_tags);
if (err)
return err;
Dwarf_Die die;
struct drgn_elf_file *file;
while (drgn_dwarf_index_iterator_next(&it, &die, &file)) {
if (die_matches_filename(&die, filename)) {
err = drgn_type_from_dwarf(dbinfo, file, &die, ret);
if (err)
return err;
/*
* For base_type, we need to check that the type we
* found was the right kind.
*/
if (kinds & (UINT64_C(1) << drgn_type_kind(ret->type)))
return NULL;
}
}
return &drgn_not_found;
}
struct drgn_error *
drgn_debug_info_find_object(const char *name, size_t name_len,
const char *filename,
enum drgn_find_object_flags flags, void *arg,
struct drgn_object *ret)
{
struct drgn_error *err;
struct drgn_debug_info *dbinfo = arg;
struct drgn_namespace_dwarf_index *ns;
err = find_enclosing_namespace(&dbinfo->dwarf.global,
&name, &name_len, &ns);
if (err)
return err;
enum drgn_dwarf_index_tag tags[3];
size_t num_tags = 0;
if (flags & DRGN_FIND_OBJECT_CONSTANT)
tags[num_tags++] = DRGN_DWARF_INDEX_enumerator;
if (flags & DRGN_FIND_OBJECT_FUNCTION)
tags[num_tags++] = DRGN_DWARF_INDEX_subprogram;
if (flags & DRGN_FIND_OBJECT_VARIABLE)
tags[num_tags++] = DRGN_DWARF_INDEX_variable;
struct drgn_dwarf_index_iterator it;
err = drgn_dwarf_index_iterator_init(&it, ns, name, name_len, tags,
num_tags);
if (err)
return err;
Dwarf_Die die;
struct drgn_elf_file *file;
while (drgn_dwarf_index_iterator_next(&it, &die, &file)) {
if (!die_matches_filename(&die, filename))
continue;
if (dwarf_tag(&die) == DW_TAG_enumeration_type) {
return drgn_object_from_dwarf_enumerator(dbinfo, file,
&die, name,
ret);
} else {
return drgn_object_from_dwarf(dbinfo, file, &die, NULL,
NULL, NULL, ret);
}
}
return &drgn_not_found;
}
/*
* Call frame information.
*/
struct drgn_dwarf_cie {
/* Size of an address in this CIE in bytes. */
uint8_t address_size;
/* DW_EH_PE_* encoding of addresses in this CIE. */
uint8_t address_encoding;
/* Whether this CIE has a 'z' augmentation. */
bool have_augmentation_length;
/* Whether this CIE is for a signal handler ('S' augmentation). */
bool signal_frame;
drgn_register_number return_address_register;
uint64_t code_alignment_factor;
int64_t data_alignment_factor;
const char *initial_instructions;
size_t initial_instructions_size;
};
DEFINE_VECTOR(drgn_dwarf_fde_vector, struct drgn_dwarf_fde);
DEFINE_VECTOR(drgn_dwarf_cie_vector, struct drgn_dwarf_cie);
DEFINE_HASH_MAP(drgn_dwarf_cie_map, size_t, size_t, int_key_hash_pair,
scalar_key_eq);
static struct drgn_error *
drgn_dwarf_cfi_next_encoded(struct drgn_elf_file_section_buffer *buffer,
uint8_t address_size, uint8_t encoding,
uint64_t func_addr, uint64_t *ret)
{
struct drgn_error *err;
/* Not currently used for CFI. */
if (encoding & DW_EH_PE_indirect) {
unknown_fde_encoding:
return binary_buffer_error(&buffer->bb,
"unknown EH encoding %#" PRIx8,
encoding);
}
size_t pos = buffer->bb.pos - (char *)buffer->data->d_buf;
uint64_t base;
switch (encoding & 0x70) {
case DW_EH_PE_absptr:
base = 0;
break;
case DW_EH_PE_pcrel:
base = buffer->file->module->dwarf.pcrel_base + pos;
break;
case DW_EH_PE_textrel:
base = buffer->file->module->dwarf.textrel_base;
break;
case DW_EH_PE_datarel:
base = buffer->file->module->dwarf.datarel_base;
break;
case DW_EH_PE_funcrel:
/* Relative to the FDE's initial location. */
base = func_addr;
break;
case DW_EH_PE_aligned:
base = 0;
if (pos % address_size != 0 &&
(err = binary_buffer_skip(&buffer->bb,
address_size - pos % address_size)))
return err;
break;
default:
goto unknown_fde_encoding;
}
uint64_t offset;
switch (encoding & 0xf) {
case DW_EH_PE_absptr:
if ((err = binary_buffer_next_uint(&buffer->bb, address_size,
&offset)))
return err;
break;
case DW_EH_PE_uleb128:
if ((err = binary_buffer_next_uleb128(&buffer->bb, &offset)))
return err;
break;
case DW_EH_PE_udata2:
if ((err = binary_buffer_next_u16_into_u64(&buffer->bb,
&offset)))
return err;
break;
case DW_EH_PE_udata4:
if ((err = binary_buffer_next_u32_into_u64(&buffer->bb,
&offset)))
return err;
break;
case DW_EH_PE_udata8:
if ((err = binary_buffer_next_u64(&buffer->bb, &offset)))
return err;
break;
case DW_EH_PE_sleb128:
if ((err = binary_buffer_next_sleb128_into_u64(&buffer->bb,
&offset)))
return err;
break;
case DW_EH_PE_sdata2:
if ((err = binary_buffer_next_s16_into_u64(&buffer->bb,
&offset)))
return err;
break;
case DW_EH_PE_sdata4:
if ((err = binary_buffer_next_s32_into_u64(&buffer->bb,
&offset)))
return err;
break;
case DW_EH_PE_sdata8:
if ((err = binary_buffer_next_s64_into_u64(&buffer->bb,
&offset)))
return err;
break;
default:
goto unknown_fde_encoding;
}
*ret = (base + offset) & uint_max(address_size);
return NULL;
}
static struct drgn_error *drgn_parse_dwarf_cie(struct drgn_elf_file *file,
enum drgn_section_index scn,
size_t cie_pointer,
struct drgn_dwarf_cie *cie)
{
bool is_eh = scn == DRGN_SCN_EH_FRAME;
struct drgn_error *err;
struct drgn_elf_file_section_buffer buffer;
drgn_elf_file_section_buffer_init_index(&buffer, file, scn);
buffer.bb.pos += cie_pointer;
uint32_t tmp;
if ((err = binary_buffer_next_u32(&buffer.bb, &tmp)))
return err;
bool is_64_bit = tmp == UINT32_C(0xffffffff);
uint64_t length;
if (is_64_bit) {
if ((err = binary_buffer_next_u64(&buffer.bb, &length)))
return err;
} else {
length = tmp;
}
if (length > buffer.bb.end - buffer.bb.pos) {
return binary_buffer_error(&buffer.bb,
"entry length is out of bounds");
}
buffer.bb.end = buffer.bb.pos + length;
uint64_t cie_id, expected_cie_id;
if (is_64_bit) {
if ((err = binary_buffer_next_u64(&buffer.bb, &cie_id)))
return err;
expected_cie_id = is_eh ? 0 : UINT64_C(0xffffffffffffffff);
} else {
if ((err = binary_buffer_next_u32_into_u64(&buffer.bb,
&cie_id)))
return err;
expected_cie_id = is_eh ? 0 : UINT64_C(0xffffffff);
}
if (cie_id != expected_cie_id)
return binary_buffer_error(&buffer.bb, "invalid CIE ID");
uint8_t version;
if ((err = binary_buffer_next_u8(&buffer.bb, &version)))
return err;
if (version < 1 || version == 2 || version > 4) {
return binary_buffer_error(&buffer.bb,
"unknown CIE version %" PRIu8,
version);
}
const char *augmentation;
size_t augmentation_len;
if ((err = binary_buffer_next_string(&buffer.bb, &augmentation,
&augmentation_len)))
return err;
cie->have_augmentation_length = augmentation[0] == 'z';
cie->signal_frame = false;
for (size_t i = 0; i < augmentation_len; i++) {
switch (augmentation[i]) {
case 'z':
if (i != 0)
goto unknown_augmentation;
break;
case 'L':
case 'P':
case 'R':
if (augmentation[0] != 'z' || !is_eh)
goto unknown_augmentation;
break;
case 'S':
cie->signal_frame = true;
break;
default:
unknown_augmentation:
/*
* We could ignore this CIE and all FDEs that reference
* it or skip the augmentation if we have its length,
* but let's fail loudly so that we find out about
* missing support.
*/
return binary_buffer_error_at(&buffer.bb,
&augmentation[i],
"unknown CFI augmentation %s",
augmentation);
}
}
if (version >= 4) {
if ((err = binary_buffer_next_u8(&buffer.bb,
&cie->address_size)))
return err;
if (cie->address_size < 1 || cie->address_size > 8) {
return binary_buffer_error(&buffer.bb,
"unsupported address size %" PRIu8,
cie->address_size);
}
uint8_t segment_selector_size;
if ((err = binary_buffer_next_u8(&buffer.bb,
&segment_selector_size)))
return err;
if (segment_selector_size) {
return binary_buffer_error(&buffer.bb,
"unsupported segment selector size %" PRIu8,
segment_selector_size);
}
} else {
cie->address_size = drgn_elf_file_address_size(file);
}
if ((err = binary_buffer_next_uleb128(&buffer.bb,
&cie->code_alignment_factor)) ||
(err = binary_buffer_next_sleb128(&buffer.bb,
&cie->data_alignment_factor)))
return err;
uint64_t return_address_register;
if (version >= 3) {
if ((err = binary_buffer_next_uleb128(&buffer.bb,
&return_address_register)))
return err;
} else {
if ((err = binary_buffer_next_u8_into_u64(&buffer.bb,
&return_address_register)))
return err;
}
cie->return_address_register =
file->platform.arch->dwarf_regno_to_internal(return_address_register);
if (cie->return_address_register == DRGN_REGISTER_NUMBER_UNKNOWN) {
return binary_buffer_error(&buffer.bb,
"unknown return address register");
}
cie->address_encoding = DW_EH_PE_absptr;
if (augmentation[0] == 'z') {
for (size_t i = 0; i < augmentation_len; i++) {
switch (augmentation[i]) {
case 'z':
if ((err = binary_buffer_skip_leb128(&buffer.bb)))
return err;
break;
case 'L':
if ((err = binary_buffer_skip(&buffer.bb, 1)))
return err;
break;
case 'P': {
uint8_t encoding;
if ((err = binary_buffer_next_u8(&buffer.bb, &encoding)))
return err;
/*
* We don't need the result, so don't bother
* dereferencing.
*/
encoding &= ~DW_EH_PE_indirect;
uint64_t unused;
if ((err = drgn_dwarf_cfi_next_encoded(&buffer,
cie->address_size,
encoding,
0,
&unused)))
return err;
break;
}
case 'R':
if ((err = binary_buffer_next_u8(&buffer.bb,
&cie->address_encoding)))
return err;
break;
}
}
}
cie->initial_instructions = buffer.bb.pos;
cie->initial_instructions_size = buffer.bb.end - buffer.bb.pos;
return NULL;
}
static void drgn_debug_info_cache_sh_addr(struct drgn_elf_file *file,
enum drgn_section_index scn,
uint64_t *addr)
{
if (file->scns[scn]) {
GElf_Shdr shdr_mem;
GElf_Shdr *shdr = gelf_getshdr(file->scns[scn], &shdr_mem);
if (shdr)
*addr = shdr->sh_addr;
}
}
static int drgn_dwarf_fde_compar(const void *_a, const void *_b)
{
const struct drgn_dwarf_fde *a = _a;
const struct drgn_dwarf_fde *b = _b;
if (a->initial_location < b->initial_location)
return -1;
else if (a->initial_location > b->initial_location)
return 1;
else
return 0;
}
static struct drgn_error *drgn_parse_dwarf_cfi(struct drgn_dwarf_cfi *cfi,
struct drgn_elf_file *file,
enum drgn_section_index scn)
{
const bool is_eh = scn == DRGN_SCN_EH_FRAME;
struct drgn_error *err;
if (!file->scns[scn])
return NULL;
if (is_eh) {
drgn_debug_info_cache_sh_addr(file, DRGN_SCN_EH_FRAME,
&file->module->dwarf.pcrel_base);
drgn_debug_info_cache_sh_addr(file, DRGN_SCN_TEXT,
&file->module->dwarf.textrel_base);
drgn_debug_info_cache_sh_addr(file, DRGN_SCN_GOT,
&file->module->dwarf.datarel_base);
}
VECTOR(drgn_dwarf_cie_vector, cies);
VECTOR(drgn_dwarf_fde_vector, fdes);
HASH_TABLE(drgn_dwarf_cie_map, cie_map);
struct drgn_elf_file_section_buffer buffer;
err = drgn_elf_file_section_buffer_read(&buffer, file, scn);
if (err)
return err;
while (binary_buffer_has_next(&buffer.bb)) {
uint32_t tmp;
if ((err = binary_buffer_next_u32(&buffer.bb, &tmp)))
return err;
bool is_64_bit = tmp == UINT32_C(0xffffffff);
uint64_t length;
if (is_64_bit) {
if ((err = binary_buffer_next_u64(&buffer.bb, &length)))
return err;
} else {
length = tmp;
}
/*
* Technically, a length of zero is only a terminator in
* .eh_frame, but other consumers (binutils, elfutils, GDB)
* handle it the same way in .debug_frame.
*/
if (length == 0)
break;
if (length > buffer.bb.end - buffer.bb.pos) {
return binary_buffer_error(&buffer.bb,
"entry length is out of bounds");
}
buffer.bb.end = buffer.bb.pos + length;
/*
* The Linux Standard Base Core Specification [1] states that
* the CIE ID in .eh_frame is always 4 bytes. However, other
* consumers handle it the same as in .debug_frame (8 bytes for
* the 64-bit format).
*
* 1: https://refspecs.linuxfoundation.org/LSB_5.0.0/LSB-Core-generic/LSB-Core-generic/ehframechpt.html
*/
uint64_t cie_pointer, cie_id;
if (is_64_bit) {
if ((err = binary_buffer_next_u64(&buffer.bb,
&cie_pointer)))
return err;
cie_id = is_eh ? 0 : UINT64_C(0xffffffffffffffff);
} else {
if ((err = binary_buffer_next_u32_into_u64(&buffer.bb,
&cie_pointer)))
return err;
cie_id = is_eh ? 0 : UINT64_C(0xffffffff);
}
if (cie_pointer != cie_id) {
if (is_eh) {
size_t pointer_offset =
(buffer.bb.pos
- (is_64_bit ? 8 : 4)
- (char *)buffer.data->d_buf);
if (cie_pointer > pointer_offset) {
return binary_buffer_error(&buffer.bb,
"CIE pointer is out of bounds");
}
cie_pointer = pointer_offset - cie_pointer;
} else if (cie_pointer > buffer.data->d_size) {
return binary_buffer_error(&buffer.bb,
"CIE pointer is out of bounds");
}
struct drgn_dwarf_fde *fde =
drgn_dwarf_fde_vector_append_entry(&fdes);
if (!fde)
return &drgn_enomem;
struct drgn_dwarf_cie_map_entry entry = {
.key = cie_pointer,
.value = drgn_dwarf_cie_vector_size(&cies),
};
struct drgn_dwarf_cie_map_iterator it;
int r = drgn_dwarf_cie_map_insert(&cie_map, &entry,
&it);
struct drgn_dwarf_cie *cie;
if (r > 0) {
cie = drgn_dwarf_cie_vector_append_entry(&cies);
if (!cie)
return &drgn_enomem;
err = drgn_parse_dwarf_cie(file, scn,
cie_pointer, cie);
if (err)
return err;
} else if (r == 0) {
cie = drgn_dwarf_cie_vector_at(&cies,
it.entry->value);
} else {
return &drgn_enomem;
}
if ((err = drgn_dwarf_cfi_next_encoded(&buffer,
cie->address_size,
cie->address_encoding,
0,
&fde->initial_location)) ||
(err = drgn_dwarf_cfi_next_encoded(&buffer,
cie->address_size,
cie->address_encoding & 0xf,
0,
&fde->address_range)))
return err;
if (cie->have_augmentation_length) {
uint64_t augmentation_length;
if ((err = binary_buffer_next_uleb128(&buffer.bb,
&augmentation_length)))
return err;
if (augmentation_length >
buffer.bb.end - buffer.bb.pos) {
return binary_buffer_error(&buffer.bb,
"augmentation length is out of bounds");
}
buffer.bb.pos += augmentation_length;
}
fde->cie = it.entry->value;
fde->instructions = buffer.bb.pos;
fde->instructions_size = buffer.bb.end - buffer.bb.pos;
}
buffer.bb.pos = buffer.bb.end;
buffer.bb.end = (const char *)buffer.data->d_buf
+ buffer.data->d_size;
}
drgn_dwarf_cie_vector_shrink_to_fit(&cies);
drgn_dwarf_fde_vector_shrink_to_fit(&fdes);
qsort(drgn_dwarf_fde_vector_begin(&fdes),
drgn_dwarf_fde_vector_size(&fdes), sizeof(struct drgn_dwarf_fde),
drgn_dwarf_fde_compar);
drgn_dwarf_cie_vector_steal(&cies, &cfi->cies, NULL);
drgn_dwarf_fde_vector_steal(&fdes, &cfi->fdes, &cfi->num_fdes);
return NULL;
}
static struct drgn_dwarf_fde *drgn_find_dwarf_fde(struct drgn_dwarf_cfi *cfi,
uint64_t unbiased_pc)
{
#define less_than_initial_location(a, b) (*(a) < (b)->initial_location)
size_t i = binary_search_gt(cfi->fdes, cfi->num_fdes, &unbiased_pc,
less_than_initial_location);
#undef less_than_initial_location
if (i == 0
|| (unbiased_pc - cfi->fdes[i - 1].initial_location
>= cfi->fdes[i - 1].address_range))
return NULL;
return &cfi->fdes[i - 1];
}
static struct drgn_error *
drgn_dwarf_cfi_next_offset(struct drgn_elf_file_section_buffer *buffer,
int64_t *ret)
{
struct drgn_error *err;
uint64_t offset;
if ((err = binary_buffer_next_uleb128(&buffer->bb, &offset)))
return err;
if (offset > INT64_MAX)
return binary_buffer_error(&buffer->bb, "offset is too large");
*ret = offset;
return NULL;
}
static struct drgn_error *
drgn_dwarf_cfi_next_offset_sf(struct drgn_elf_file_section_buffer *buffer,
struct drgn_dwarf_cie *cie, int64_t *ret)
{
struct drgn_error *err;
int64_t factored;
if ((err = binary_buffer_next_sleb128(&buffer->bb, &factored)))
return err;
if (__builtin_mul_overflow(factored, cie->data_alignment_factor, ret))
return binary_buffer_error(&buffer->bb, "offset is too large");
return NULL;
}
static struct drgn_error *
drgn_dwarf_cfi_next_offset_f(struct drgn_elf_file_section_buffer *buffer,
struct drgn_dwarf_cie *cie, int64_t *ret)
{
struct drgn_error *err;
uint64_t factored;
if ((err = binary_buffer_next_uleb128(&buffer->bb, &factored)))
return err;
if (__builtin_mul_overflow(factored, cie->data_alignment_factor, ret))
return binary_buffer_error(&buffer->bb, "offset is too large");
return NULL;
}
static struct drgn_error *
drgn_dwarf_cfi_next_block(struct drgn_elf_file_section_buffer *buffer,
const char **buf_ret, size_t *size_ret)
{
struct drgn_error *err;
uint64_t size;
if ((err = binary_buffer_next_uleb128(&buffer->bb, &size)))
return err;
if (size > buffer->bb.end - buffer->bb.pos) {
return binary_buffer_error(&buffer->bb,
"block is out of bounds");
}
*buf_ret = buffer->bb.pos;
buffer->bb.pos += size;
*size_ret = size;
return NULL;
}
DEFINE_VECTOR(drgn_cfi_row_vector, struct drgn_cfi_row *);
static struct drgn_error *
drgn_eval_dwarf_cfi(struct drgn_elf_file *file, enum drgn_section_index scn,
struct drgn_dwarf_cie *cie, struct drgn_dwarf_fde *fde,
const struct drgn_cfi_row *initial_row, uint64_t target,
const char *instructions, size_t instructions_size,
struct drgn_cfi_row **row)
{
struct drgn_error *err;
drgn_register_number (*dwarf_regno_to_internal)(uint64_t) =
file->platform.arch->dwarf_regno_to_internal;
uint64_t pc = fde->initial_location;
struct drgn_cfi_row_vector state_stack = VECTOR_INIT;
struct drgn_elf_file_section_buffer buffer;
drgn_elf_file_section_buffer_init_index(&buffer, file, scn);
buffer.bb.pos = instructions;
buffer.bb.end = instructions + instructions_size;
while (binary_buffer_has_next(&buffer.bb)) {
uint8_t opcode;
if ((err = binary_buffer_next_u8(&buffer.bb, &opcode)))
goto out;
uint64_t dwarf_regno;
drgn_register_number regno;
struct drgn_cfi_rule rule;
uint64_t tmp;
switch ((opcode & 0xc0) ? (opcode & 0xc0) : opcode) {
case DW_CFA_set_loc:
if (!initial_row)
goto invalid_for_initial;
if ((err = drgn_dwarf_cfi_next_encoded(&buffer,
cie->address_size,
cie->address_encoding,
fde->initial_location,
&tmp)))
goto out;
if (tmp <= pc) {
err = binary_buffer_error(&buffer.bb,
"DW_CFA_set_loc location is not greater than current location");
goto out;
}
pc = tmp;
if (pc > target)
goto found;
break;
case DW_CFA_advance_loc:
if (!initial_row)
goto invalid_for_initial;
tmp = opcode & 0x3f;
goto advance_loc;
case DW_CFA_advance_loc1:
if (!initial_row)
goto invalid_for_initial;
if ((err = binary_buffer_next_u8_into_u64(&buffer.bb,
&tmp)))
goto out;
goto advance_loc;
case DW_CFA_advance_loc2:
if (!initial_row)
goto invalid_for_initial;
if ((err = binary_buffer_next_u16_into_u64(&buffer.bb,
&tmp)))
goto out;
goto advance_loc;
case DW_CFA_advance_loc4:
if (!initial_row)
goto invalid_for_initial;
if ((err = binary_buffer_next_u32_into_u64(&buffer.bb,
&tmp)))
goto out;
advance_loc:
if (__builtin_mul_overflow(tmp,
cie->code_alignment_factor,
&tmp) ||
__builtin_add_overflow(pc, tmp, &pc) ||
pc > uint_max(cie->address_size)) {
err = drgn_error_create(DRGN_ERROR_OTHER,
"DW_CFA_advance_loc* overflows location");
goto out;
}
if (pc > target)
goto found;
break;
case DW_CFA_def_cfa:
rule.kind = DRGN_CFI_RULE_REGISTER_PLUS_OFFSET;
if ((err = binary_buffer_next_uleb128(&buffer.bb,
&dwarf_regno)) ||
(err = drgn_dwarf_cfi_next_offset(&buffer, &rule.offset)))
goto out;
if ((rule.regno = dwarf_regno_to_internal(dwarf_regno)) ==
DRGN_REGISTER_NUMBER_UNKNOWN)
rule.kind = DRGN_CFI_RULE_UNDEFINED;
goto set_cfa;
case DW_CFA_def_cfa_sf:
rule.kind = DRGN_CFI_RULE_REGISTER_PLUS_OFFSET;
if ((err = binary_buffer_next_uleb128(&buffer.bb,
&dwarf_regno)) ||
(err = drgn_dwarf_cfi_next_offset_sf(&buffer, cie,
&rule.offset)))
goto out;
if ((rule.regno = dwarf_regno_to_internal(dwarf_regno)) ==
DRGN_REGISTER_NUMBER_UNKNOWN)
rule.kind = DRGN_CFI_RULE_UNDEFINED;
goto set_cfa;
case DW_CFA_def_cfa_register:
drgn_cfi_row_get_cfa(*row, &rule);
if (rule.kind != DRGN_CFI_RULE_REGISTER_PLUS_OFFSET) {
err = binary_buffer_error(&buffer.bb,
"DW_CFA_def_cfa_register with incompatible CFA rule");
goto out;
}
if ((err = binary_buffer_next_uleb128(&buffer.bb,
&dwarf_regno)))
goto out;
if ((rule.regno = dwarf_regno_to_internal(dwarf_regno)) ==
DRGN_REGISTER_NUMBER_UNKNOWN)
rule.kind = DRGN_CFI_RULE_UNDEFINED;
goto set_cfa;
case DW_CFA_def_cfa_offset:
drgn_cfi_row_get_cfa(*row, &rule);
if (rule.kind != DRGN_CFI_RULE_REGISTER_PLUS_OFFSET) {
err = binary_buffer_error(&buffer.bb,
"DW_CFA_def_cfa_offset with incompatible CFA rule");
goto out;
}
if ((err = drgn_dwarf_cfi_next_offset(&buffer,
&rule.offset)))
goto out;
goto set_cfa;
case DW_CFA_def_cfa_offset_sf:
drgn_cfi_row_get_cfa(*row, &rule);
if (rule.kind != DRGN_CFI_RULE_REGISTER_PLUS_OFFSET) {
err = binary_buffer_error(&buffer.bb,
"DW_CFA_def_cfa_offset_sf with incompatible CFA rule");
goto out;
}
if ((err = drgn_dwarf_cfi_next_offset_sf(&buffer, cie,
&rule.offset)))
goto out;
goto set_cfa;
case DW_CFA_def_cfa_expression:
rule.kind = DRGN_CFI_RULE_DWARF_EXPRESSION;
rule.push_cfa = false;
if ((err = drgn_dwarf_cfi_next_block(&buffer,
&rule.expr,
&rule.expr_size)))
goto out;
set_cfa:
if (!drgn_cfi_row_set_cfa(row, &rule)) {
err = &drgn_enomem;
goto out;
}
break;
case DW_CFA_undefined:
rule.kind = DRGN_CFI_RULE_UNDEFINED;
if ((err = binary_buffer_next_uleb128(&buffer.bb,
&dwarf_regno)))
goto out;
if ((regno = dwarf_regno_to_internal(dwarf_regno)) ==
DRGN_REGISTER_NUMBER_UNKNOWN)
break;
goto set_reg;
case DW_CFA_same_value:
rule.kind = DRGN_CFI_RULE_REGISTER_PLUS_OFFSET;
rule.offset = 0;
if ((err = binary_buffer_next_uleb128(&buffer.bb,
&dwarf_regno)))
goto out;
if ((regno = dwarf_regno_to_internal(dwarf_regno)) ==
DRGN_REGISTER_NUMBER_UNKNOWN)
break;
rule.regno = regno;
goto set_reg;
case DW_CFA_offset:
rule.kind = DRGN_CFI_RULE_AT_CFA_PLUS_OFFSET;
if ((err = drgn_dwarf_cfi_next_offset_f(&buffer, cie,
&rule.offset)))
goto out;
if ((regno = dwarf_regno_to_internal(opcode & 0x3f)) ==
DRGN_REGISTER_NUMBER_UNKNOWN)
break;
goto set_reg;
case DW_CFA_offset_extended:
rule.kind = DRGN_CFI_RULE_AT_CFA_PLUS_OFFSET;
goto reg_offset_f;
case DW_CFA_offset_extended_sf:
rule.kind = DRGN_CFI_RULE_AT_CFA_PLUS_OFFSET;
goto reg_offset_sf;
case DW_CFA_val_offset:
rule.kind = DRGN_CFI_RULE_CFA_PLUS_OFFSET;
reg_offset_f:
if ((err = binary_buffer_next_uleb128(&buffer.bb,
&dwarf_regno)) ||
(err = drgn_dwarf_cfi_next_offset_f(&buffer, cie,
&rule.offset)))
goto out;
if ((regno = dwarf_regno_to_internal(dwarf_regno)) ==
DRGN_REGISTER_NUMBER_UNKNOWN)
break;
goto set_reg;
case DW_CFA_val_offset_sf:
rule.kind = DRGN_CFI_RULE_CFA_PLUS_OFFSET;
reg_offset_sf:
if ((err = binary_buffer_next_uleb128(&buffer.bb,
&dwarf_regno)) ||
(err = drgn_dwarf_cfi_next_offset_sf(&buffer, cie,
&rule.offset)))
goto out;
if ((regno = dwarf_regno_to_internal(dwarf_regno)) ==
DRGN_REGISTER_NUMBER_UNKNOWN)
break;
goto set_reg;
case DW_CFA_register: {
rule.kind = DRGN_CFI_RULE_REGISTER_PLUS_OFFSET;
rule.offset = 0;
uint64_t dwarf_regno2;
if ((err = binary_buffer_next_uleb128(&buffer.bb,
&dwarf_regno)) ||
(err = binary_buffer_next_uleb128(&buffer.bb,
&dwarf_regno2)))
goto out;
if ((regno = dwarf_regno_to_internal(dwarf_regno)) ==
DRGN_REGISTER_NUMBER_UNKNOWN)
break;
if ((rule.regno = dwarf_regno_to_internal(dwarf_regno2)) ==
DRGN_REGISTER_NUMBER_UNKNOWN)
rule.kind = DRGN_CFI_RULE_UNDEFINED;
goto set_reg;
}
case DW_CFA_expression:
rule.kind = DRGN_CFI_RULE_AT_DWARF_EXPRESSION;
goto reg_expression;
case DW_CFA_val_expression:
rule.kind = DRGN_CFI_RULE_DWARF_EXPRESSION;
reg_expression:
rule.push_cfa = true;
if ((err = binary_buffer_next_uleb128(&buffer.bb,
&dwarf_regno)) ||
(err = drgn_dwarf_cfi_next_block(&buffer,
&rule.expr,
&rule.expr_size)))
goto out;
if ((regno = dwarf_regno_to_internal(dwarf_regno)) ==
DRGN_REGISTER_NUMBER_UNKNOWN)
break;
goto set_reg;
case DW_CFA_restore:
if (!initial_row)
goto invalid_for_initial;
dwarf_regno = opcode & 0x3f;
goto restore;
case DW_CFA_restore_extended:
if (!initial_row) {
invalid_for_initial:
err = binary_buffer_error(&buffer.bb,
"invalid initial DWARF CFI opcode %#" PRIx8,
opcode);
goto out;
}
if ((err = binary_buffer_next_uleb128(&buffer.bb,
&dwarf_regno)))
goto out;
restore:
if ((regno = dwarf_regno_to_internal(dwarf_regno)) ==
DRGN_REGISTER_NUMBER_UNKNOWN)
break;
drgn_cfi_row_get_register(initial_row, regno, &rule);
set_reg:
if (!drgn_cfi_row_set_register(row, regno, &rule)) {
err = &drgn_enomem;
goto out;
}
break;
case DW_CFA_remember_state: {
struct drgn_cfi_row **state =
drgn_cfi_row_vector_append_entry(&state_stack);
if (!state) {
err = &drgn_enomem;
goto out;
}
*state = drgn_empty_cfi_row;
if (!drgn_cfi_row_copy(state, *row)) {
err = &drgn_enomem;
goto out;
}
break;
}
case DW_CFA_restore_state:
if (drgn_cfi_row_vector_empty(&state_stack)) {
err = binary_buffer_error(&buffer.bb,
"DW_CFA_restore_state with empty state stack");
goto out;
}
drgn_cfi_row_destroy(*row);
*row = *drgn_cfi_row_vector_pop(&state_stack);
break;
case DW_CFA_nop:
break;
// Note that this is the same opcode as DW_CFA_GNU_window_save,
// which is used on Sparc.
case DW_CFA_AARCH64_negate_ra_state:
if (drgn_platform_arch(&file->platform)
== DRGN_ARCH_AARCH64) {
regno = DRGN_AARCH64_RA_SIGN_STATE_REGNO;
drgn_cfi_row_get_register(*row, regno, &rule);
if (rule.kind != DRGN_CFI_RULE_CONSTANT) {
err = binary_buffer_error(&buffer.bb,
"DW_CFA_AARCH64_negate_ra_state mixed with another rule");
goto out;
}
rule.constant ^= 1;
goto set_reg;
}
fallthrough;
case DW_CFA_GNU_args_size:
// We have no use for this. Skip it.
if ((err = binary_buffer_skip_leb128(&buffer.bb)))
goto out;
break;
default:
err = binary_buffer_error(&buffer.bb,
"unknown DWARF CFI opcode %#" PRIx8,
opcode);
goto out;
}
}
found:
err = NULL;
out:
vector_for_each(drgn_cfi_row_vector, it, &state_stack)
drgn_cfi_row_destroy(*it);
drgn_cfi_row_vector_deinit(&state_stack);
return err;
}
static struct drgn_error *
drgn_find_cfi_row_in_dwarf_fde(struct drgn_dwarf_cfi *cfi,
struct drgn_elf_file *file,
enum drgn_section_index scn,
struct drgn_dwarf_fde *fde, uint64_t unbiased_pc,
struct drgn_cfi_row **ret)
{
struct drgn_error *err;
struct drgn_dwarf_cie *cie = &cfi->cies[fde->cie];
struct drgn_cfi_row *initial_row =
(struct drgn_cfi_row *)file->platform.arch->default_dwarf_cfi_row;
err = drgn_eval_dwarf_cfi(file, scn, cie, fde, NULL, unbiased_pc,
cie->initial_instructions,
cie->initial_instructions_size, &initial_row);
if (err)
goto out;
if (!drgn_cfi_row_copy(ret, initial_row)) {
err = &drgn_enomem;
goto out;
}
err = drgn_eval_dwarf_cfi(file, scn, cie, fde, initial_row, unbiased_pc,
fde->instructions, fde->instructions_size,
ret);
out:
drgn_cfi_row_destroy(initial_row);
return err;
}
static struct drgn_error *
drgn_find_dwarf_cfi(struct drgn_dwarf_cfi *cfi, struct drgn_elf_file *file,
enum drgn_section_index scn, uint64_t unbiased_pc,
struct drgn_cfi_row **row_ret, bool *interrupted_ret,
drgn_register_number *ret_addr_regno_ret)
{
struct drgn_error *err;
struct drgn_dwarf_fde *fde = drgn_find_dwarf_fde(cfi, unbiased_pc);
if (!fde)
return &drgn_not_found;
err = drgn_find_cfi_row_in_dwarf_fde(cfi, file, scn, fde, unbiased_pc,
row_ret);
if (err)
return err;
*interrupted_ret = cfi->cies[fde->cie].signal_frame;
*ret_addr_regno_ret = cfi->cies[fde->cie].return_address_register;
return NULL;
}
struct drgn_error *drgn_module_parse_debug_frame(struct drgn_module *module)
{
return drgn_parse_dwarf_cfi(&module->dwarf.debug_frame,
module->debug_file, DRGN_SCN_DEBUG_FRAME);
}
struct drgn_error *
drgn_module_find_dwarf_cfi(struct drgn_module *module, uint64_t pc,
struct drgn_cfi_row **row_ret, bool *interrupted_ret,
drgn_register_number *ret_addr_regno_ret)
{
return drgn_find_dwarf_cfi(&module->dwarf.debug_frame,
module->debug_file, DRGN_SCN_DEBUG_FRAME,
pc - module->debug_file_bias, row_ret,
interrupted_ret, ret_addr_regno_ret);
}
struct drgn_error *drgn_module_parse_eh_frame(struct drgn_module *module)
{
return drgn_parse_dwarf_cfi(&module->dwarf.eh_frame,
module->loaded_file, DRGN_SCN_EH_FRAME);
}
struct drgn_error *
drgn_module_find_eh_cfi(struct drgn_module *module, uint64_t pc,
struct drgn_cfi_row **row_ret, bool *interrupted_ret,
drgn_register_number *ret_addr_regno_ret)
{
return drgn_find_dwarf_cfi(&module->dwarf.eh_frame, module->loaded_file,
DRGN_SCN_EH_FRAME,
pc - module->loaded_file_bias, row_ret,
interrupted_ret, ret_addr_regno_ret);
}
struct drgn_error *
drgn_eval_cfi_dwarf_expression(struct drgn_program *prog,
struct drgn_elf_file *file,
const struct drgn_cfi_rule *rule,
const struct drgn_register_state *regs,
void *buf, size_t size)
{
struct drgn_error *err;
VECTOR(uint64_vector, stack);
if (rule->push_cfa) {
struct optional_uint64 cfa = drgn_register_state_get_cfa(regs);
if (!cfa.has_value)
return &drgn_not_found;
if (!uint64_vector_append(&stack, &cfa.value))
return &drgn_enomem;
}
int remaining_ops = MAX_DWARF_EXPR_OPS;
struct drgn_dwarf_expression_context ctx;
drgn_dwarf_expression_context_init(&ctx, prog, file, NULL, NULL, regs,
rule->expr, rule->expr_size);
err = drgn_eval_dwarf_expression(&ctx, &stack, &remaining_ops);
if (err) {
if (err == &drgn_unknown_dwarf_opcode)
err = &drgn_not_found;
return err;
}
if (binary_buffer_has_next(&ctx.bb)) {
uint8_t opcode;
err = binary_buffer_next_u8(&ctx.bb, &opcode);
if (!err) {
err = binary_buffer_error(&ctx.bb,
"invalid opcode %#" PRIx8 " for CFI expression",
opcode);
}
return err;
}
if (uint64_vector_empty(&stack)) {
return &drgn_not_found;
} else if (rule->kind == DRGN_CFI_RULE_AT_DWARF_EXPRESSION) {
return drgn_program_read_memory(prog, buf,
*uint64_vector_last(&stack),
size, false);
} else {
copy_lsbytes(buf, size, drgn_elf_file_is_little_endian(file),
uint64_vector_last(&stack), sizeof(uint64_t),
HOST_LITTLE_ENDIAN);
return NULL;
}
}
|