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
|
/*
* pg_filedump.c - PostgreSQL file dump utility for dumping and
* formatting heap (data), index and control files.
*
* Copyright (c) 2002-2010 Red Hat, Inc.
* Copyright (c) 2011-2025, PostgreSQL Global Development Group
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Original Author: Patrick Macdonald <patrickm@redhat.com>
*/
#include "pg_filedump.h"
#include <utils/pg_crc.h>
/* checksum_impl.h uses Assert, which doesn't work outside the server */
#undef Assert
#define Assert(X)
#include "storage/checksum.h"
#include "storage/checksum_impl.h"
#include "decode.h"
#include <inttypes.h>
/*
* Global variables for ease of use mostly
*/
/* Options for Block formatting operations */
unsigned int blockOptions = 0;
/* Segment-related options */
unsigned int segmentOptions = 0;
/* -R[start]:Block range start */
int blockStart = -1;
/* -R[end]:Block range end */
int blockEnd = -1;
/* Options for Item formatting operations */
unsigned int itemOptions = 0;
/* Options for Control File formatting operations */
unsigned int controlOptions = 0;
unsigned int specialType = SPEC_SECT_NONE;
static bool verbose = false;
/* File to dump or format */
static FILE *fp = NULL;
/* File name for display */
char *fileName = NULL;
/* Current block size */
static unsigned int blockSize = 0;
/* Segment size in bytes */
static unsigned int segmentSize = RELSEG_SIZE * BLCKSZ;
/* Number of current segment */
static unsigned int segmentNumber = 0;
/* Offset of current block */
static unsigned int pageOffset = 0;
/* Number of bytes to format */
static unsigned int bytesToFormat = 0;
/* Block version number */
static unsigned int blockVersion = 0;
/* Flag to indicate pg_filenode.map file */
static bool isRelMapFile = false;
/* Program exit code */
static int exitCode = 0;
/* Relmapper structs */
typedef struct RelMapping
{
Oid mapoid; /* OID of a catalog */
Oid mapfilenode; /* its filenode number */
} RelMapping;
/* crc and pad are ignored here, even though they are
* present in the backend code. We assume that anyone
* seeking to inspect the contents of pg_filenode.map
* probably have a corrupted or non-functional cluster */
typedef struct RelMapFile
{
int32 magic; /* always RELMAPPER_FILEMAGIC */
int32 num_mappings; /* number of valid RelMapping entries */
RelMapping mappings[FLEXIBLE_ARRAY_MEMBER];
} RelMapFile;
/*
* Function Prototypes
*/
unsigned int GetBlockSize(FILE *fp);
static void DisplayOptions(unsigned int validOptions);
static unsigned int ConsumeOptions(int numOptions, char **options);
static int GetOptionValue(char *optionString);
static void FormatBlock(unsigned int blockOptions,
unsigned int controlOptions,
char *buffer,
BlockNumber currentBlock,
unsigned int blockSize,
bool isToast,
Oid toastOid,
uint32 *want_chunk_id,
unsigned int toastExternalSize,
char *toastValue,
unsigned int *toastRead);
static unsigned int GetSpecialSectionType(char *buffer, Page page);
static bool IsBtreeMetaPage(Page page);
static void CreateDumpFileHeader(int numOptions, char **options);
static int FormatHeader(char *buffer,
Page page,
BlockNumber blkno,
bool isToast);
static void FormatItemBlock(char *buffer,
Page page,
bool isToast,
Oid toastOid,
uint32 *want_chunk_id,
unsigned int toastExternalSize,
char *toastValue,
unsigned int *toastRead);
static void FormatItem(char *buffer,
unsigned int numBytes,
unsigned int startIndex,
unsigned int formatAs);
static void FormatSpecial(char *buffer);
static void FormatControl(char *buffer);
static void FormatBinary(char *buffer,
unsigned int numBytes, unsigned int startIndex);
static void DumpBinaryBlock(char *buffer);
static int PrintRelMappings(void);
static ItemPointer ginPostingListDecodeAllSegmentsItems(
GinPostingList *segment,
int len,
int *ndecoded_out);
static ItemPointer ginReadTupleItems(
IndexTuple itup,
int *nitems);
/* Send properly formed usage information to the user. */
static void
DisplayOptions(unsigned int validOptions)
{
if (validOptions == OPT_RC_COPYRIGHT)
printf
("\nVersion %s (for %s)"
"\nCopyright (c) 2002-2010 Red Hat, Inc."
"\nCopyright (c) 2011-2025, PostgreSQL Global Development Group\n",
FD_VERSION, FD_PG_VERSION);
printf
("\nUsage: pg_filedump [-abcdfhikxy] [-R startblock [endblock]] [-D attrlist] [-S blocksize] [-s segsize] [-n segnumber] file\n\n"
"Display formatted contents of a PostgreSQL heap/index/control file\n"
"Defaults are: relative addressing, range of the entire file, block\n"
" size as listed on block 0 in the file\n\n"
"The following options are valid for heap and index files:\n"
" -a Display absolute addresses when formatting (Block header\n"
" information is always block relative)\n"
" -b Display binary block images within a range (Option will turn\n"
" off all formatting options)\n"
" -d Display formatted block content dump (Option will turn off\n"
" all other formatting options)\n"
" -D Decode tuples using given comma separated list of types\n"
" Supported types:\n"
" bigint bigserial bool char charN date float float4 float8 int\n"
" json macaddr name numeric oid real serial smallint smallserial text\n"
" time timestamp timestamptz timetz uuid varchar varcharN xid xml\n"
" ~ ignores all attributes left in a tuple\n"
" -f Display formatted block content dump along with interpretation\n"
" -h Display this information\n"
" -i Display interpreted item details\n"
" -k Verify block checksums\n"
" -o Do not dump old values.\n"
" -R Display specific block ranges within the file (Blocks are\n"
" indexed from 0)\n"
" [startblock]: block to start at\n"
" [endblock]: block to end at\n"
" A startblock without an endblock will format the single block\n"
" -s Force segment size to [segsize]\n"
" -t Dump TOAST files\n"
" -v Ouput additional information about TOAST relations\n"
" -n Force segment number to [segnumber]\n"
" -S Force block size to [blocksize]\n"
" -x Force interpreted formatting of block items as index items\n"
" -y Force interpreted formatting of block items as heap items\n\n"
"The following options are valid for control files:\n"
" -c Interpret the file listed as a control file\n"
" -f Display formatted content dump along with interpretation\n"
" -S Force block size to [blocksize]\n"
"Additional functions:\n"
" -m Interpret file as pg_filenode.map file and print contents (all\n"
" other options will be ignored)\n"
"\nReport bugs to <pgsql-bugs@postgresql.org>\n");
}
/*
* Determine segment number by segment file name. For instance, if file
* name is /path/to/xxxx.7 procedure returns 7. Default return value is 0.
*/
static unsigned int
GetSegmentNumberFromFileName(const char *fileName)
{
int segnumOffset = strlen(fileName) - 1;
if (segnumOffset < 0)
return 0;
while (isdigit(fileName[segnumOffset]))
{
segnumOffset--;
if (segnumOffset < 0)
return 0;
}
if (fileName[segnumOffset] != '.')
return 0;
return atoi(&fileName[segnumOffset + 1]);
}
/* Iterate through the provided options and set the option flags.
* An error will result in a positive rc and will force a display
* of the usage information. This routine returns enum
* optionReturnCode values. */
static unsigned int
ConsumeOptions(int numOptions, char **options)
{
unsigned int rc = OPT_RC_VALID;
unsigned int x;
unsigned int optionStringLength;
char *optionString;
char duplicateSwitch = 0x00;
for (x = 1; x < numOptions; x++)
{
optionString = options[x];
optionStringLength = strlen(optionString);
/* Range is a special case where we have to consume the next 1 or 2
* parameters to mark the range start and end */
if ((optionStringLength == 2) && (strcmp(optionString, "-R") == 0))
{
int range = 0;
SET_OPTION(blockOptions, BLOCK_RANGE, 'R');
/* Only accept the range option once */
if (rc == OPT_RC_DUPLICATE)
break;
/* Make sure there are options after the range identifier */
if (x >= (numOptions - 2))
{
rc = OPT_RC_INVALID;
printf("Error: Missing range start identifier.\n");
exitCode = 1;
break;
}
/*
* Mark that we have the range and advance the option to what
* should be the range start. Check the value of the next
* parameter */
optionString = options[++x];
if ((range = GetOptionValue(optionString)) < 0)
{
rc = OPT_RC_INVALID;
printf("Error: Invalid range start identifier <%s>.\n",
optionString);
exitCode = 1;
break;
}
/* The default is to dump only one block */
blockStart = blockEnd = (unsigned int) range;
/* We have our range start marker, check if there is an end
* marker on the option line. Assume that the last option
* is the file we are dumping, so check if there are options
* range start marker and the file */
if (x <= (numOptions - 3))
{
if ((range = GetOptionValue(options[x + 1])) >= 0)
{
/* End range must be => start range */
if (blockStart <= range)
{
blockEnd = (unsigned int) range;
x++;
}
else
{
rc = OPT_RC_INVALID;
printf("Error: Requested block range start <%d> is "
"greater than end <%d>.\n", blockStart, range);
exitCode = 1;
break;
}
}
}
}
/* Check for the special case where the user forces a block size
* instead of having the tool determine it. This is useful if
* the header of block 0 is corrupt and gives a garbage block size */
else if ((optionStringLength == 2)
&& (strcmp(optionString, "-S") == 0))
{
int localBlockSize;
SET_OPTION(blockOptions, BLOCK_FORCED, 'S');
/* Only accept the forced size option once */
if (rc == OPT_RC_DUPLICATE)
break;
/* The token immediately following -S is the block size */
if (x >= (numOptions - 2))
{
rc = OPT_RC_INVALID;
printf("Error: Missing block size identifier.\n");
break;
}
/* Next option encountered must be forced block size */
optionString = options[++x];
if ((localBlockSize = GetOptionValue(optionString)) > 0)
blockSize = (unsigned int) localBlockSize;
else
{
rc = OPT_RC_INVALID;
printf("Error: Invalid block size requested <%s>.\n",
optionString);
exitCode = 1;
break;
}
}
/* Check for the special case where the user forces a segment size. */
else if ((optionStringLength == 2)
&& (strcmp(optionString, "-s") == 0))
{
int localSegmentSize;
SET_OPTION(segmentOptions, SEGMENT_SIZE_FORCED, 's');
/* Only accept the forced size option once */
if (rc == OPT_RC_DUPLICATE)
break;
/* The token immediately following -s is the segment size */
if (x >= (numOptions - 2))
{
rc = OPT_RC_INVALID;
printf("Error: Missing segment size identifier.\n");
exitCode = 1;
break;
}
/* Next option encountered must be forced segment size */
optionString = options[++x];
if ((localSegmentSize = GetOptionValue(optionString)) > 0)
segmentSize = (unsigned int) localSegmentSize;
else
{
rc = OPT_RC_INVALID;
printf("Error: Invalid segment size requested <%s>.\n",
optionString);
exitCode = 1;
break;
}
}
/* Check for the special case where the user forces tuples decoding. */
else if ((optionStringLength == 2)
&& (strcmp(optionString, "-D") == 0))
{
SET_OPTION(blockOptions, BLOCK_DECODE, 'D');
/* Only accept the decode option once */
if (rc == OPT_RC_DUPLICATE)
break;
/* The token immediately following -D is attrubute types string */
if (x >= (numOptions - 2))
{
rc = OPT_RC_INVALID;
printf("Error: Missing attribute types string.\n");
exitCode = 1;
break;
}
/* Next option encountered must be attribute types string */
optionString = options[++x];
if (ParseAttributeTypesString(optionString) < 0)
{
rc = OPT_RC_INVALID;
printf("Error: Invalid attribute types string <%s>.\n",
optionString);
exitCode = 1;
break;
}
}
/* Check for the special case where the user forces a segment number
* instead of having the tool determine it by file name. */
else if ((optionStringLength == 2)
&& (strcmp(optionString, "-n") == 0))
{
int localSegmentNumber;
SET_OPTION(segmentOptions, SEGMENT_NUMBER_FORCED, 'n');
/* Only accept the forced segment number option once */
if (rc == OPT_RC_DUPLICATE)
break;
/* The token immediately following -n is the segment number */
if (x >= (numOptions - 2))
{
rc = OPT_RC_INVALID;
printf("Error: Missing segment number identifier.\n");
exitCode = 1;
break;
}
/* Next option encountered must be forced segment number */
optionString = options[++x];
if ((localSegmentNumber = GetOptionValue(optionString)) > 0)
segmentNumber = (unsigned int) localSegmentNumber;
else
{
rc = OPT_RC_INVALID;
printf("Error: Invalid segment number requested <%s>.\n",
optionString);
exitCode = 1;
break;
}
}
/* The last option MUST be the file name */
else if (x == (numOptions - 1))
{
/* Check to see if this looks like an option string before opening */
if (optionString[0] != '-')
{
fp = fopen(optionString, "rb");
if (fp)
{
fileName = options[x];
if (!(segmentOptions & SEGMENT_NUMBER_FORCED))
segmentNumber = GetSegmentNumberFromFileName(fileName);
}
else
{
rc = OPT_RC_FILE;
printf("Error: Could not open file <%s>.\n", optionString);
exitCode = 1;
break;
}
}
else
{
/* Could be the case where the help flag is used without a
* filename. Otherwise, the last option isn't a file */
if (strcmp(optionString, "-h") == 0)
rc = OPT_RC_COPYRIGHT;
else
{
rc = OPT_RC_FILE;
printf("Error: Missing file name to dump.\n");
exitCode = 1;
}
break;
}
}
else
{
unsigned int y;
/* Option strings must start with '-' and contain switches */
if (optionString[0] != '-')
{
rc = OPT_RC_INVALID;
printf("Error: Invalid option string <%s>.\n", optionString);
exitCode = 1;
break;
}
/* Iterate through the singular option string, throw out
* garbage, duplicates and set flags to be used in formatting */
for (y = 1; y < optionStringLength; y++)
{
switch (optionString[y])
{
/* Use absolute addressing */
case 'a':
SET_OPTION(blockOptions, BLOCK_ABSOLUTE, 'a');
break;
/* Dump the binary contents of the page */
case 'b':
SET_OPTION(blockOptions, BLOCK_BINARY, 'b');
break;
/* Dump the listed file as a control file */
case 'c':
SET_OPTION(controlOptions, CONTROL_DUMP, 'c');
break;
/* Do not interpret the data. Format to hex and ascii. */
case 'd':
SET_OPTION(blockOptions, BLOCK_NO_INTR, 'd');
break;
/*
* Format the contents of the block with
* interpretation of the headers */
case 'f':
SET_OPTION(blockOptions, BLOCK_FORMAT, 'f');
break;
/* Display the usage screen */
case 'h':
rc = OPT_RC_COPYRIGHT;
break;
/* Format the items in detail */
case 'i':
SET_OPTION(itemOptions, ITEM_DETAIL, 'i');
break;
/* Verify block checksums */
case 'k':
SET_OPTION(blockOptions, BLOCK_CHECKSUMS, 'k');
break;
/* Treat file as pg_filenode.map file */
case 'm':
isRelMapFile = true;
break;
/* Display old values. Ignore Xmax */
case 'o':
SET_OPTION(blockOptions, BLOCK_IGNORE_OLD, 'o');
break;
case 't':
SET_OPTION(blockOptions, BLOCK_DECODE_TOAST, 't');
break;
case 'v':
verbose = true;
break;
/* Interpret items as standard index values */
case 'x':
SET_OPTION(itemOptions, ITEM_INDEX, 'x');
if (itemOptions & ITEM_HEAP)
{
rc = OPT_RC_INVALID;
printf("Error: Options <y> and <x> are "
"mutually exclusive.\n");
exitCode = 1;
}
break;
/* Interpret items as heap values */
case 'y':
SET_OPTION(itemOptions, ITEM_HEAP, 'y');
if (itemOptions & ITEM_INDEX)
{
rc = OPT_RC_INVALID;
printf("Error: Options <x> and <y> are "
"mutually exclusive.\n");
exitCode = 1;
}
break;
default:
rc = OPT_RC_INVALID;
printf("Error: Unknown option <%c>.\n", optionString[y]);
exitCode = 1;
break;
}
if (rc)
break;
}
}
}
if (rc == OPT_RC_DUPLICATE)
{
printf("Error: Duplicate option listed <%c>.\n", duplicateSwitch);
exitCode = 1;
}
/* If the user requested a control file dump, a pure binary
* block dump or a non-interpreted formatted dump, mask off
* all other block level options (with a few exceptions) */
if (rc == OPT_RC_VALID)
{
/* The user has requested a control file dump, only -f and */
/* -S are valid... turn off all other formatting */
if (controlOptions & CONTROL_DUMP)
{
if ((blockOptions & ~(BLOCK_FORMAT | BLOCK_FORCED))
|| (itemOptions))
{
rc = OPT_RC_INVALID;
printf("Error: Invalid options used for Control File dump.\n"
" Only options <Sf> may be used with <c>.\n");
exitCode = 1;
}
else
{
controlOptions |=
(blockOptions & (BLOCK_FORMAT | BLOCK_FORCED));
blockOptions = itemOptions = 0;
}
}
/* The user has requested a binary block dump... only -R and -f
* are honoured */
else if (blockOptions & BLOCK_BINARY)
{
blockOptions &= (BLOCK_BINARY | BLOCK_RANGE | BLOCK_FORCED);
itemOptions = 0;
}
/* The user has requested a non-interpreted dump... only -a, -R
* and -f are honoured */
else if (blockOptions & BLOCK_NO_INTR)
{
blockOptions &=
(BLOCK_NO_INTR | BLOCK_ABSOLUTE | BLOCK_RANGE | BLOCK_FORCED);
itemOptions = 0;
}
}
return (rc);
}
/* Given the index into the parameter list, convert and return the
* current string to a number if possible */
static int
GetOptionValue(char *optionString)
{
unsigned int x;
int value = -1;
int optionStringLength = strlen(optionString);
/* Verify the next option looks like a number */
for (x = 0; x < optionStringLength; x++)
if (!isdigit((int) optionString[x]))
break;
/* Convert the string to a number if it looks good */
if (x == optionStringLength)
value = atoi(optionString);
return (value);
}
/* Read the page header off of block 0 to determine the block size
* used in this file. Can be overridden using the -S option. The
* returned value is the block size of block 0 on disk */
unsigned int
GetBlockSize(FILE *fp)
{
unsigned int localSize = 0;
int bytesRead = 0;
char localCache[sizeof(PageHeaderData)];
/* Read the first header off of block 0 to determine the block size */
bytesRead = fread(&localCache, 1, sizeof(PageHeaderData), fp);
rewind(fp);
if (bytesRead == sizeof(PageHeaderData))
localSize = (unsigned int) PageGetPageSize(localCache);
else
{
printf("Error: Unable to read full page header from block 0.\n"
" ===> Read %u bytes\n", bytesRead);
exitCode = 1;
}
if (localSize == 0)
{
printf("Notice: Block size determined from reading block 0 is zero, using default %d instead.\n", BLCKSZ);
printf("Hint: Use -S <size> to specify the size manually.\n");
localSize = BLCKSZ;
}
return (localSize);
}
/* Determine the contents of the special section on the block and
* return this enum value */
static unsigned int
GetSpecialSectionType(char *buffer, Page page)
{
unsigned int rc;
unsigned int specialOffset;
unsigned int specialSize;
unsigned int specialValue;
PageHeader pageHeader = (PageHeader) page;
/* If this is not a partial header, check the validity of the
* special section offset and contents */
if (bytesToFormat > sizeof(PageHeaderData))
{
specialOffset = (unsigned int) pageHeader->pd_special;
/* Check that the special offset can remain on the block or
* the partial block */
if ((specialOffset == 0) ||
(specialOffset > blockSize) || (specialOffset > bytesToFormat))
rc = SPEC_SECT_ERROR_BOUNDARY;
else
{
/* we may need to examine last 2 bytes of page to identify index */
uint16 *ptype = (uint16 *) (buffer + blockSize - sizeof(uint16));
specialSize = blockSize - specialOffset;
/* If there is a special section, use its size to guess its
* contents, checking the last 2 bytes of the page in cases
* that are ambiguous. Note we don't attempt to dereference
* the pointers without checking bytesToFormat == blockSize. */
if (specialSize == 0)
rc = SPEC_SECT_NONE;
else if (specialSize == MAXALIGN(sizeof(uint32)))
{
/* If MAXALIGN is 8, this could be either a sequence or
* SP-GiST or GIN. */
if (bytesToFormat == blockSize)
{
specialValue = *((int *) (buffer + specialOffset));
if (specialValue == SEQUENCE_MAGIC)
rc = SPEC_SECT_SEQUENCE;
else if (specialSize == MAXALIGN(sizeof(SpGistPageOpaqueData)) &&
*ptype == SPGIST_PAGE_ID)
rc = SPEC_SECT_INDEX_SPGIST;
else if (specialSize == MAXALIGN(sizeof(GinPageOpaqueData)))
rc = SPEC_SECT_INDEX_GIN;
else
rc = SPEC_SECT_ERROR_UNKNOWN;
}
else
rc = SPEC_SECT_ERROR_UNKNOWN;
}
/* SP-GiST and GIN have same size special section, so check
* the page ID bytes first. */
else if (specialSize == MAXALIGN(sizeof(SpGistPageOpaqueData)) &&
bytesToFormat == blockSize &&
*ptype == SPGIST_PAGE_ID)
rc = SPEC_SECT_INDEX_SPGIST;
else if (specialSize == MAXALIGN(sizeof(GinPageOpaqueData)))
rc = SPEC_SECT_INDEX_GIN;
else if (specialSize > 2 && bytesToFormat == blockSize)
{
/* As of 8.3, BTree, Hash, and GIST all have the same size
* special section, but the last two bytes of the section
* can be checked to determine what's what. */
if (*ptype <= MAX_BT_CYCLE_ID &&
specialSize == MAXALIGN(sizeof(BTPageOpaqueData)))
rc = SPEC_SECT_INDEX_BTREE;
else if (*ptype == HASHO_PAGE_ID &&
specialSize == MAXALIGN(sizeof(HashPageOpaqueData)))
rc = SPEC_SECT_INDEX_HASH;
else if (*ptype == GIST_PAGE_ID &&
specialSize == MAXALIGN(sizeof(GISTPageOpaqueData)))
rc = SPEC_SECT_INDEX_GIST;
else
rc = SPEC_SECT_ERROR_UNKNOWN;
}
else
rc = SPEC_SECT_ERROR_UNKNOWN;
}
}
else
rc = SPEC_SECT_ERROR_UNKNOWN;
return (rc);
}
/* Check whether page is a btree meta page */
static bool
IsBtreeMetaPage(Page page)
{
PageHeader pageHeader = (PageHeader) page;
if ((PageGetSpecialSize(page) == (MAXALIGN(sizeof(BTPageOpaqueData))))
&& (bytesToFormat == blockSize))
{
BTPageOpaque btpo =
(BTPageOpaque) ((char *) page + pageHeader->pd_special);
/* Must check the cycleid to be sure it's really btree. */
if ((btpo->btpo_cycleid <= MAX_BT_CYCLE_ID) &&
(btpo->btpo_flags & BTP_META))
return true;
}
return false;
}
/* Check whether page is a gin meta page */
static bool
IsGinMetaPage(Page page)
{
if ((PageGetSpecialSize(page) == (MAXALIGN(sizeof(GinPageOpaqueData))))
&& (bytesToFormat == blockSize))
{
GinPageOpaque gpo = GinPageGetOpaque(page);
if (gpo->flags & GIN_META)
return true;
}
return false;
}
/* Check whether page is a SpGist meta page */
static bool
IsSpGistMetaPage(Page page)
{
if ((PageGetSpecialSize(page) == (MAXALIGN(sizeof(SpGistPageOpaqueData))))
&& (bytesToFormat == blockSize))
{
SpGistPageOpaque spgpo = SpGistPageGetOpaque(page);
if ((spgpo->spgist_page_id == SPGIST_PAGE_ID) &&
(spgpo->flags & SPGIST_META))
return true;
}
return false;
}
/* Display a header for the dump so we know the file name, the options
* used and the time the dump was taken */
static void
CreateDumpFileHeader(int numOptions, char **options)
{
unsigned int x;
char optionBuffer[52] = "\0";
/* Iterate through the options and cache them.
* The maximum we can display is 50 option characters + spaces. */
for (x = 1; x < (numOptions - 1); x++)
{
if ((strlen(optionBuffer) + strlen(options[x])) > 50)
break;
strcat(optionBuffer, options[x]);
if (x < numOptions - 2)
strcat(optionBuffer, " ");
}
printf
("\n*******************************************************************\n"
"* PostgreSQL File/Block Formatted Dump Utility\n"
"*\n"
"* File: %s\n"
"* Options used: %s\n"
"*******************************************************************\n",
fileName, (strlen(optionBuffer)) ? optionBuffer : "None");
}
/* Dump out a formatted block header for the requested block */
static int
FormatHeader(char *buffer, Page page, BlockNumber blkno, bool isToast)
{
int rc = 0;
unsigned int headerBytes;
PageHeader pageHeader = (PageHeader) page;
char *indent = isToast ? "\t" : "";
if (!isToast || verbose)
printf("%s<Header> -----\n", indent);
/* Only attempt to format the header if the entire header (minus the item
* array) is available */
if (bytesToFormat < offsetof(PageHeaderData, pd_linp[0]))
{
headerBytes = bytesToFormat;
rc = EOF_ENCOUNTERED;
}
else
{
XLogRecPtr pageLSN = PageGetLSN(page);
int maxOffset = PageGetMaxOffsetNumber(page);
char flagString[100];
headerBytes = offsetof(PageHeaderData, pd_linp[0]);
blockVersion = (unsigned int) PageGetPageLayoutVersion(page);
/* The full header exists but we have to check that the item array
* is available or how far we can index into it */
if (maxOffset > 0)
{
unsigned int itemsLength = maxOffset * sizeof(ItemIdData);
if (bytesToFormat < (headerBytes + itemsLength))
{
headerBytes = bytesToFormat;
rc = EOF_ENCOUNTERED;
}
else
headerBytes += itemsLength;
}
flagString[0] = '\0';
if (pageHeader->pd_flags & PD_HAS_FREE_LINES)
strcat(flagString, "HAS_FREE_LINES|");
if (pageHeader->pd_flags & PD_PAGE_FULL)
strcat(flagString, "PAGE_FULL|");
if (pageHeader->pd_flags & PD_ALL_VISIBLE)
strcat(flagString, "ALL_VISIBLE|");
if (strlen(flagString))
flagString[strlen(flagString) - 1] = '\0';
/* Interpret the content of the header */
if (!isToast || verbose)
{
printf("%s Block Offset: 0x%08x Offsets: Lower %4u (0x%04hx)\n",
indent, pageOffset, pageHeader->pd_lower, pageHeader->pd_lower);
printf("%s Block: Size %4d Version %4u Upper %4u (0x%04hx)\n",
indent, (int) PageGetPageSize(page), blockVersion,
pageHeader->pd_upper, pageHeader->pd_upper);
printf("%s LSN: logid %6d recoff 0x%08x Special %4u (0x%04hx)\n",
indent, (uint32) (pageLSN >> 32), (uint32) pageLSN,
pageHeader->pd_special, pageHeader->pd_special);
printf("%s Items: %4d Free Space: %4u\n",
indent, maxOffset, pageHeader->pd_upper - pageHeader->pd_lower);
printf("%s Checksum: 0x%04x Prune XID: 0x%08x Flags: 0x%04x (%s)\n",
indent, pageHeader->pd_checksum, pageHeader->pd_prune_xid,
pageHeader->pd_flags, flagString);
printf("%s Length (including item array): %u\n\n",
indent, headerBytes);
}
/* If it's a btree meta page, print the contents of the meta block. */
if (IsBtreeMetaPage(page))
{
BTMetaPageData *btpMeta = BTPageGetMeta(buffer);
if (!isToast || verbose)
{
printf("%s BTree Meta Data: Magic (0x%08x) Version (%u)\n",
indent, btpMeta->btm_magic, btpMeta->btm_version);
printf("%s Root: Block (%u) Level (%u)\n",
indent, btpMeta->btm_root, btpMeta->btm_level);
printf("%s FastRoot: Block (%u) Level (%u)\n\n",
indent, btpMeta->btm_fastroot, btpMeta->btm_fastlevel);
}
headerBytes += sizeof(BTMetaPageData);
}
else if (IsGinMetaPage(page))
{
GinMetaPageData *gpMeta = GinPageGetMeta(buffer);
if (!isToast || verbose)
{
printf("%s GIN Meta Data: Version (%u)\n",
indent, gpMeta->ginVersion);
printf("%s Pending list: Head: (%u) Tail: (%u) Tail Free Size: (%u)\n",
indent, gpMeta->head, gpMeta->tail, gpMeta->tailFreeSize);
printf("%s Num of Pending Pages: (%u) Num of Pending Heap Tuples: (%" PRIu64 ")\n",
indent, gpMeta->nPendingPages, gpMeta->nPendingHeapTuples);
printf("%s Statistic for planner: Num of Total Pages: (%u) Num of Entry Pages: (%u)\n",
indent, gpMeta->nTotalPages, gpMeta->nEntryPages);
printf("%s Num of Data Pages: (%u) Num of Entries: (%" PRIu64 ")\n\n",
indent, gpMeta->nDataPages, gpMeta->nEntries);
}
headerBytes += sizeof(GinMetaPageData);
}
/* Eye the contents of the header and alert the user to possible
* problems. */
if ((maxOffset < 0) ||
(maxOffset > blockSize) ||
(blockVersion != PG_PAGE_LAYOUT_VERSION) || /* only one we support */
(pageHeader->pd_upper > blockSize) ||
(pageHeader->pd_upper > pageHeader->pd_special) ||
(pageHeader->pd_lower <
(sizeof(PageHeaderData) - sizeof(ItemIdData)))
|| (pageHeader->pd_lower > blockSize)
|| (pageHeader->pd_upper < pageHeader->pd_lower)
|| (pageHeader->pd_special > blockSize))
{
printf(" Error: Invalid header information.\n\n");
exitCode = 1;
}
if (blockOptions & BLOCK_CHECKSUMS)
{
uint32 delta = (segmentSize / blockSize) * segmentNumber;
uint16 calc_checksum = pg_checksum_page(page, delta + blkno);
if (calc_checksum != pageHeader->pd_checksum)
{
printf(" Error: checksum failure: calculated 0x%04x.\n\n",
calc_checksum);
exitCode = 1;
}
}
}
/* If we have reached the end of file while interpreting the header, let
* the user know about it */
if (rc == EOF_ENCOUNTERED)
{
if (!isToast || verbose)
{
printf("%s Error: End of block encountered within the header."
" Bytes read: %4u.\n\n", indent, bytesToFormat);
}
exitCode = 1;
}
/* A request to dump the formatted binary of the block (header,
* items and special section). It's best to dump even on an error
* so the user can see the raw image. */
if (blockOptions & BLOCK_FORMAT)
FormatBinary(buffer, headerBytes, 0);
return (rc);
}
/* Copied from ginpostinglist.c */
#define MaxHeapTuplesPerPageBits 11
static uint64
itemptr_to_uint64(const ItemPointer iptr)
{
uint64 val;
val = GinItemPointerGetBlockNumber(iptr);
val <<= MaxHeapTuplesPerPageBits;
val |= GinItemPointerGetOffsetNumber(iptr);
return val;
}
static void
uint64_to_itemptr(uint64 val, ItemPointer iptr)
{
GinItemPointerSetOffsetNumber(iptr, val & ((1 << MaxHeapTuplesPerPageBits) - 1));
val = val >> MaxHeapTuplesPerPageBits;
GinItemPointerSetBlockNumber(iptr, val);
}
/*
* Decode varbyte-encoded integer at *ptr. *ptr is incremented to next integer.
*/
static uint64
decode_varbyte(unsigned char **ptr)
{
uint64 val;
unsigned char *p = *ptr;
uint64 c;
/* 1st byte */
c = *(p++);
val = c & 0x7F;
if (c & 0x80)
{
/* 2nd byte */
c = *(p++);
val |= (c & 0x7F) << 7;
if (c & 0x80)
{
/* 3rd byte */
c = *(p++);
val |= (c & 0x7F) << 14;
if (c & 0x80)
{
/* 4th byte */
c = *(p++);
val |= (c & 0x7F) << 21;
if (c & 0x80)
{
/* 5th byte */
c = *(p++);
val |= (c & 0x7F) << 28;
if (c & 0x80)
{
/* 6th byte */
c = *(p++);
val |= (c & 0x7F) << 35;
if (c & 0x80)
{
/* 7th byte, should not have continuation bit */
c = *(p++);
val |= c << 42;
Assert((c & 0x80) == 0);
}
}
}
}
}
}
*ptr = p;
return val;
}
static ItemPointer
ginPostingListDecodeAllSegmentsItems(GinPostingList *segment, int len, int *ndecoded_out)
{
ItemPointer result;
int nallocated;
uint64 val;
char *endseg = ((char *) segment) + len;
int ndecoded;
unsigned char *ptr;
unsigned char *endptr;
/*
* Guess an initial size of the array.
*/
nallocated = segment->nbytes * 2 + 1;
result = palloc(nallocated * sizeof(ItemPointerData));
ndecoded = 0;
while ((char *) segment < endseg)
{
/* enlarge output array if needed */
if (ndecoded >= nallocated)
{
nallocated *= 2;
result = repalloc(result, nallocated * sizeof(ItemPointerData));
}
/* copy the first item */
result[ndecoded] = segment->first;
ndecoded++;
val = itemptr_to_uint64(&segment->first);
ptr = segment->bytes;
endptr = segment->bytes + segment->nbytes;
while (ptr < endptr)
{
/* enlarge output array if needed */
if (ndecoded >= nallocated)
{
nallocated *= 2;
result = repalloc(result, nallocated * sizeof(ItemPointerData));
}
val += decode_varbyte(&ptr);
uint64_to_itemptr(val, &result[ndecoded]);
ndecoded++;
}
segment = GinNextPostingListSegment(segment);
}
if (ndecoded_out)
*ndecoded_out = ndecoded;
return result;
}
static ItemPointer
ginReadTupleItems(IndexTuple itup, int *nitems)
{
Pointer ptr = GinGetPosting(itup);
int nipd = GinGetNPosting(itup);
ItemPointer ipd;
if (GinItupIsCompressed(itup))
{
if (nipd > 0)
{
ipd = ginPostingListDecodeAllSegmentsItems((GinPostingList *)ptr, SizeOfGinPostingList((GinPostingList *)ptr), nitems);
}
else
{
ipd = palloc(0);
}
}
else
{
ipd = (ItemPointer) palloc(sizeof(ItemPointerData) * nipd);
memcpy(ipd, ptr, sizeof(ItemPointerData) * nipd);
}
*nitems = nipd;
return ipd;
}
/* Dump out gin-specific content of block */
static void
FormatGinBlock(char *buffer,
bool isToast,
Oid toastOid,
unsigned int toastExternalSize,
char *toastValue,
unsigned int *toastRead)
{
Page page = (Page) buffer;
char *indent = isToast ? "\t" : "";
if (isToast && !verbose)
return;
if (GinPageIsDeleted(page))
{
printf("%s Deleted page.\n\n", indent);
return;
}
printf("%s<Data> -----\n", indent);
if (GinPageIsData(page) && GinPageIsLeaf(page))
{
printf("\n%s Leaf Page of TID B-tree\n",indent);
if (GinPageIsCompressed(page))
{
GinPostingList *seg = GinDataLeafPageGetPostingList(page);
int plist_idx = 1;
Size len = GinDataLeafPageGetPostingListSize(page);
Pointer endptr = ((Pointer) seg) + len;
ItemPointer cur;
while ((Pointer) seg < endptr)
{
int item_idx = 1;
uint64 val;
unsigned char *endseg = seg->bytes + seg->nbytes;
unsigned char *ptr = seg->bytes;
cur = &seg->first;
printf("\n%s Posting List %3d -- Length: %4u\n",
indent, plist_idx, seg->nbytes);
printf("%s ItemPointer %3d -- Block Id: %4u linp Index: %4u\n",
indent, item_idx,
((uint32) ((cur->ip_blkid.bi_hi << 16) |
(uint16) cur->ip_blkid.bi_lo)),
cur->ip_posid);
val = itemptr_to_uint64(&seg->first);
while (ptr < endseg)
{
val += decode_varbyte(&ptr);
item_idx++;
uint64_to_itemptr(val, cur);
printf("%s ItemPointer %3d -- Block Id: %4u linp Index: %4u\n",
indent, item_idx,
((uint32) ((cur->ip_blkid.bi_hi << 16) |
(uint16) cur->ip_blkid.bi_lo)),
cur->ip_posid);
}
plist_idx++;
seg = GinNextPostingListSegment(seg);
}
}
else
{
int i,
nitems = GinPageGetOpaque(page)->maxoff;
ItemPointer items = (ItemPointer) GinDataPageGetData(page);
for (i = 0; i < nitems; i++)
{
printf("%s ItemPointer %d -- Block Id: %u linp Index: %u\n",
indent, i + 1,
((uint32) ((items[i].ip_blkid.bi_hi << 16) |
(uint16) items[i].ip_blkid.bi_lo)),
items[i].ip_posid);
}
}
}
else if (!GinPageIsData(page) && GinPageIsLeaf(page))
{
printf("\n%s Leaf Page of Element B-tree", indent);
for (int offset = FirstOffsetNumber; offset <= PageGetMaxOffsetNumber(page); offset++)
{
IndexTuple itup;
itup = (IndexTuple) PageGetItem(page, PageGetItemId(page, offset));
if (!GinIsPostingTree(itup))
{
int nitems;
ItemPointer items = ginReadTupleItems(itup, &nitems);
printf("\n%s Posting List %3d -- Length: %4u -- isCompressed: %d\n",
indent, offset, nitems, GinItupIsCompressed(itup));
for (int i = 0; i < nitems; i++)
{
printf("%s ItemPointer %d -- Block Id: %u linp Index: %u\n",
indent, i + 1,
((uint32) ((items[i].ip_blkid.bi_hi << 16) |
(uint16) items[i].ip_blkid.bi_lo)),
items[i].ip_posid);
}
pfree(items);
} else
{
BlockNumber rootPostingTree = GinGetPostingTree(itup);
printf("\n%s Root posting tree -- Block Id: %u\n",
indent, rootPostingTree);
}
}
}
else if (!GinPageIsLeaf(page) && GinPageIsData(page))
{
OffsetNumber cur,
high = GinPageGetOpaque(page)->maxoff; /* number of PostingItems on GIN_DATA & ~GIN_LEAF page.*/
PostingItem *pitem = NULL;
ItemPointer rightBound = GinDataPageGetRightBound(page);
printf("%s Internal Page of TID B-tree -- Block Id: %u linp Index: %u\n",
indent,
((uint32) ((rightBound->ip_blkid.bi_hi << 16) |
(uint16) rightBound->ip_blkid.bi_lo)),
rightBound->ip_posid);
for (cur = FirstOffsetNumber; cur <= high; cur = OffsetNumberNext(cur))
{
pitem = GinDataPageGetPostingItem(page, cur);
printf("%s PostingItem %d -- child Block Id: (%u) Key Block Id: %u Key linp Index: %u\n",
indent, cur,
((uint32) ((pitem->child_blkno.bi_hi << 16) |
(uint16) pitem->child_blkno.bi_lo)),
((uint32) ((pitem->key.ip_blkid.bi_hi << 16) |
(uint16) pitem->key.ip_blkid.bi_lo)),
pitem->key.ip_posid);
}
}
else if (GinPageIsList(page))
{
printf("\n%s Pending List Page -- Length: %4u\n", indent, GinPageGetOpaque(page)->maxoff);
//Fast list index page, not compressed
for (OffsetNumber offset = FirstOffsetNumber; offset <= GinPageGetOpaque(page)->maxoff; offset = OffsetNumberNext(offset))
{
IndexTuple itup;
itup = (IndexTuple) PageGetItem(page, PageGetItemId(page, offset));
printf("%s ItemPointer -- Block Id: %u linp Index: %u\n",
indent,
((uint32) ((itup->t_tid.ip_blkid.bi_hi << 16) |
(uint16) itup->t_tid.ip_blkid.bi_lo)),
itup->t_tid.ip_posid);
}
}
else if (GinPageGetOpaque(page)->flags == 0)
{
/*details postgrespro/src/backend/access/gin/ginentrypage::GinFormInteriorTuple,
*the specified child block number is inserted into t_tid.
*/
printf("\n%s Internal Page of Element B-tree \n", indent);
for (OffsetNumber offset = FirstOffsetNumber; offset <= PageGetMaxOffsetNumber(page); offset = OffsetNumberNext(offset))
{
IndexTuple itup;
itup = (IndexTuple) PageGetItem(page, PageGetItemId(page, offset));
printf("%s ItemPointer -- Block Id: %u linp Index: %u\n",
indent,
((uint32) ((itup->t_tid.ip_blkid.bi_hi << 16) |
(uint16) itup->t_tid.ip_blkid.bi_lo)),
itup->t_tid.ip_posid);
}
}
else
{
printf("%s Error: Unknown page type.\n", indent);
exitCode = 1;
}
printf("\n");
}
/* Dump out formatted items that reside on this block */
static void
FormatItemBlock(char *buffer,
Page page,
bool isToast,
Oid toastOid,
uint32 *want_chunk_id,
unsigned int toastExternalSize,
char *toastValue,
unsigned int *toastRead)
{
unsigned int x;
unsigned int itemSize;
unsigned int itemOffset;
unsigned int itemFlags;
ItemId itemId;
int maxOffset = PageGetMaxOffsetNumber(page);
char *indent = isToast ? "\t" : "";
/* If it's a btree meta page, the meta block is where items would normally
* be; don't print garbage. */
if (IsBtreeMetaPage(page))
return;
/* Same as above */
if (IsSpGistMetaPage(page))
return;
/* Same as above */
if (IsGinMetaPage(page))
return;
/* Leaf pages of GIN index contain posting lists
* instead of item array.
*/
if (specialType == SPEC_SECT_INDEX_GIN)
{
FormatGinBlock(buffer, isToast, toastOid,
toastExternalSize, toastValue,
toastRead);
return;
}
if (!isToast || verbose)
printf("%s<Data> -----\n", indent);
/* Loop through the items on the block. Check if the block is
* empty and has a sensible item array listed before running
* through each item */
if (maxOffset == 0)
{
if (!isToast || verbose)
printf("%s Empty block - no items listed \n\n", indent);
}
else if ((maxOffset < 0) || (maxOffset > blockSize))
{
if (!isToast || verbose)
printf("%s Error: Item index corrupt on block. Offset: <%d>.\n\n",
indent,
maxOffset);
exitCode = 1;
}
else
{
int formatAs;
char textFlags[16];
uint32 chunkId;
unsigned int chunkSize = 0;
/* First, honour requests to format items a special way, then
* use the special section to determine the format style */
if (itemOptions & ITEM_INDEX)
formatAs = ITEM_INDEX;
else if (itemOptions & ITEM_HEAP)
formatAs = ITEM_HEAP;
else
switch (specialType)
{
case SPEC_SECT_INDEX_BTREE:
case SPEC_SECT_INDEX_HASH:
case SPEC_SECT_INDEX_GIST:
case SPEC_SECT_INDEX_GIN:
formatAs = ITEM_INDEX;
break;
case SPEC_SECT_INDEX_SPGIST:
{
SpGistPageOpaque spgpo =
(SpGistPageOpaque) ((char *) page +
((PageHeader) page)->pd_special);
if (spgpo->flags & SPGIST_LEAF)
formatAs = ITEM_SPG_LEAF;
else
formatAs = ITEM_SPG_INNER;
}
break;
default:
formatAs = ITEM_HEAP;
break;
}
for (x = 1; x < (maxOffset + 1); x++)
{
itemId = PageGetItemId(page, x);
itemFlags = (unsigned int) ItemIdGetFlags(itemId);
itemSize = (unsigned int) ItemIdGetLength(itemId);
itemOffset = (unsigned int) ItemIdGetOffset(itemId);
switch (itemFlags)
{
case LP_UNUSED:
strcpy(textFlags, "UNUSED");
break;
case LP_NORMAL:
strcpy(textFlags, "NORMAL");
break;
case LP_REDIRECT:
strcpy(textFlags, "REDIRECT");
break;
case LP_DEAD:
strcpy(textFlags, "DEAD");
break;
default:
/* shouldn't be possible */
sprintf(textFlags, "0x%02x", itemFlags);
break;
}
if (!isToast || verbose)
printf("%s Item %3u -- Length: %4u Offset: %4u (0x%04x)"
" Flags: %s\n",
indent,
x,
itemSize,
itemOffset,
itemOffset,
textFlags);
/* Make sure the item can physically fit on this block before
* formatting */
if ((itemOffset + itemSize > blockSize) ||
(itemOffset + itemSize > bytesToFormat))
{
if (!isToast || verbose)
printf("%s Error: Item contents extend beyond block.\n"
"%s BlockSize<%d> Bytes Read<%d> Item Start<%d>.\n",
indent, indent, blockSize, bytesToFormat, itemOffset + itemSize);
exitCode = 1;
}
else if (itemFlags != LP_UNUSED)
{
HeapTupleHeader tuple_header;
TransactionId xmax;
/* If the user requests that the items be interpreted as
* heap or index items... */
if (itemOptions & ITEM_DETAIL)
FormatItem(buffer, itemSize, itemOffset, formatAs);
/* Dump the items contents in hex and ascii */
if (blockOptions & BLOCK_FORMAT)
FormatBinary(buffer, itemSize, itemOffset);
/* Check if tuple was deleted */
tuple_header = (HeapTupleHeader) (&buffer[itemOffset]);
xmax = HeapTupleHeaderGetRawXmax(tuple_header);
if ((blockOptions & BLOCK_IGNORE_OLD) && (xmax != 0))
{
if (!isToast || verbose)
printf("%stuple was removed by transaction #%d\n",
indent,
xmax);
}
else if (isToast)
{
Oid read_toast_oid;
ToastChunkDecode(&buffer[itemOffset], itemSize, toastOid,
&read_toast_oid, &chunkId, want_chunk_id, toastValue + *toastRead,
&chunkSize);
if (verbose && read_toast_oid == toastOid)
{
if (chunkId == *want_chunk_id - 1) /* value already incremented */
printf("%s Read TOAST chunk. TOAST Oid: %d, chunk id: %d, "
"chunk data size: %d\n",
indent, toastOid, chunkId, chunkSize);
else
printf("%s Skipped out-of-order TOAST chunk. TOAST Oid: %d, chunk id: %d\n",
indent, toastOid, chunkId);
}
*toastRead += chunkSize;
if (*toastRead >= toastExternalSize)
break;
}
else if ((blockOptions & BLOCK_DECODE) && (itemFlags == LP_NORMAL))
{
/* Decode tuple data */
FormatDecode(&buffer[itemOffset], itemSize);
}
}
if (!isToast && x == maxOffset)
printf("\n");
}
}
}
/* Interpret the contents of the item based on whether it has a special
* section and/or the user has hinted */
static void
FormatItem(char *buffer, unsigned int numBytes, unsigned int startIndex,
unsigned int formatAs)
{
static const char *const spgist_tupstates[4] = {
"LIVE",
"REDIRECT",
"DEAD",
"PLACEHOLDER"
};
if (formatAs == ITEM_INDEX)
{
/* It is an IndexTuple item, so dump the index header */
if (numBytes < sizeof(ItemPointerData))
{
if (numBytes)
{
printf(" Error: This item does not look like an index item.\n");
exitCode = 1;
}
}
else
{
IndexTuple itup = (IndexTuple) (&(buffer[startIndex]));
printf(" Block Id: %u linp Index: %u Size: %d\n"
" Has Nulls: %u Has Varwidths: %u\n\n",
((uint32) ((itup->t_tid.ip_blkid.bi_hi << 16) |
(uint16) itup->t_tid.ip_blkid.bi_lo)),
itup->t_tid.ip_posid,
(int) IndexTupleSize(itup),
IndexTupleHasNulls(itup) ? 1 : 0,
IndexTupleHasVarwidths(itup) ? 1 : 0);
if (numBytes != IndexTupleSize(itup))
{
printf(" Error: Index item size difference. Given <%u>, "
"Internal <%d>.\n", numBytes, (int) IndexTupleSize(itup));
exitCode = 1;
}
}
}
else if (formatAs == ITEM_SPG_INNER)
{
/* It is an SpGistInnerTuple item, so dump the index header */
if (numBytes < SGITHDRSZ)
{
if (numBytes)
{
printf(" Error: This item does not look like an SPGiST item.\n");
exitCode = 1;
}
}
else
{
SpGistInnerTuple itup = (SpGistInnerTuple) (&(buffer[startIndex]));
printf(" State: %s allTheSame: %d nNodes: %u prefixSize: %u\n\n",
spgist_tupstates[itup->tupstate],
itup->allTheSame,
itup->nNodes,
itup->prefixSize);
if (numBytes != itup->size)
{
printf(" Error: SPGiST inner item size difference. Given <%u>, "
"Internal <%d>.\n", numBytes, (int) itup->size);
exitCode = 1;
}
else if (itup->prefixSize == MAXALIGN(itup->prefixSize))
{
int i;
SpGistNodeTuple node;
/* Dump the prefix contents in hex and ascii */
if ((blockOptions & BLOCK_FORMAT) &&
SGITHDRSZ + itup->prefixSize <= numBytes)
FormatBinary(buffer,
SGITHDRSZ + itup->prefixSize, startIndex);
/* Try to print the nodes, but only while pointer is sane */
SGITITERATE(itup, i, node)
{
int off = (char *) node - (char *) itup;
if (off + SGNTHDRSZ > numBytes)
break;
printf(" Node %2u: Downlink: %u/%u Size: %d Null: %u\n",
i,
((uint32) ((node->t_tid.ip_blkid.bi_hi << 16) |
(uint16) node->t_tid.ip_blkid.bi_lo)),
node->t_tid.ip_posid,
(int) IndexTupleSize(node),
IndexTupleHasNulls(node) ? 1 : 0);
/* Dump the node's contents in hex and ascii */
if ((blockOptions & BLOCK_FORMAT) &&
off + IndexTupleSize(node) <= numBytes)
FormatBinary(buffer,
IndexTupleSize(node), startIndex + off);
if (IndexTupleSize(node) != MAXALIGN(IndexTupleSize(node)))
break;
}
}
printf("\n");
}
}
else if (formatAs == ITEM_SPG_LEAF)
{
/* It is an SpGistLeafTuple item, so dump the index header */
#if PG_VERSION_NUM >= 140000
if (numBytes < SGLTHDRSZ(SGLT_GET_HASNULLMASK((SpGistLeafTuple) &(buffer[startIndex]))))
#else
if (numBytes < SGLTHDRSZ)
#endif
{
if (numBytes)
{
printf(" Error: This item does not look like an SPGiST item.\n");
exitCode = 1;
}
}
else
{
SpGistLeafTuple itup = (SpGistLeafTuple) (&(buffer[startIndex]));
printf(" State: %s nextOffset: %u Block Id: %u linp Index: %u\n\n",
spgist_tupstates[itup->tupstate],
#if PG_VERSION_NUM >= 140000
SGLT_GET_NEXTOFFSET(itup),
#else
itup->nextOffset,
#endif
((uint32) ((itup->heapPtr.ip_blkid.bi_hi << 16) |
(uint16) itup->heapPtr.ip_blkid.bi_lo)),
itup->heapPtr.ip_posid);
if (numBytes != itup->size)
{
printf(" Error: SPGiST leaf item size difference. Given <%u>, "
"Internal <%d>.\n", numBytes, (int) itup->size);
exitCode = 1;
}
}
}
else
{
/* It is a HeapTuple item, so dump the heap header */
int alignedSize = MAXALIGN(sizeof(HeapTupleHeaderData));
if (numBytes < alignedSize)
{
if (numBytes)
{
printf(" Error: This item does not look like a heap item.\n");
exitCode = 1;
}
}
else
{
char flagString[256];
unsigned int x;
unsigned int bitmapLength = 0;
unsigned int oidLength = 0;
unsigned int computedLength;
unsigned int infoMask;
unsigned int infoMask2;
int localNatts;
unsigned int localHoff;
bits8 *localBits;
unsigned int localBitOffset;
HeapTupleHeader htup = (HeapTupleHeader) (&buffer[startIndex]);
infoMask = htup->t_infomask;
infoMask2 = htup->t_infomask2;
localBits = &(htup->t_bits[0]);
localNatts = HeapTupleHeaderGetNatts(htup);
localHoff = htup->t_hoff;
localBitOffset = offsetof(HeapTupleHeaderData, t_bits);
printf(" XMIN: %u XMAX: %u CID|XVAC: %u",
HeapTupleHeaderGetXmin(htup),
HeapTupleHeaderGetRawXmax(htup),
HeapTupleHeaderGetRawCommandId(htup));
#if PG_VERSION_NUM < 120000
if (infoMask & HEAP_HASOID)
printf(" OID: %u",
HeapTupleHeaderGetOid(htup));
#endif
printf("\n"
" Block Id: %u linp Index: %u Attributes: %d Size: %d\n",
((uint32)
((htup->t_ctid.ip_blkid.bi_hi << 16) | (uint16) htup->
t_ctid.ip_blkid.bi_lo)), htup->t_ctid.ip_posid,
localNatts, htup->t_hoff);
/* Place readable versions of the tuple info mask into a buffer.
* Assume that the string can not expand beyond 256. */
flagString[0] = '\0';
if (infoMask & HEAP_HASNULL)
strcat(flagString, "HASNULL|");
if (infoMask & HEAP_HASVARWIDTH)
strcat(flagString, "HASVARWIDTH|");
if (infoMask & HEAP_HASEXTERNAL)
strcat(flagString, "HASEXTERNAL|");
#if PG_VERSION_NUM < 120000
if (infoMask & HEAP_HASOID)
strcat(flagString, "HASOID|");
#endif
if (infoMask & HEAP_XMAX_KEYSHR_LOCK)
strcat(flagString, "XMAX_KEYSHR_LOCK|");
if (infoMask & HEAP_COMBOCID)
strcat(flagString, "COMBOCID|");
if (infoMask & HEAP_XMAX_EXCL_LOCK)
strcat(flagString, "XMAX_EXCL_LOCK|");
if (infoMask & HEAP_XMAX_LOCK_ONLY)
strcat(flagString, "XMAX_LOCK_ONLY|");
if (infoMask & HEAP_XMIN_COMMITTED)
strcat(flagString, "XMIN_COMMITTED|");
if (infoMask & HEAP_XMIN_INVALID)
strcat(flagString, "XMIN_INVALID|");
if (infoMask & HEAP_XMAX_COMMITTED)
strcat(flagString, "XMAX_COMMITTED|");
if (infoMask & HEAP_XMAX_INVALID)
strcat(flagString, "XMAX_INVALID|");
if (infoMask & HEAP_XMAX_IS_MULTI)
strcat(flagString, "XMAX_IS_MULTI|");
if (infoMask & HEAP_UPDATED)
strcat(flagString, "UPDATED|");
if (infoMask & HEAP_MOVED_OFF)
strcat(flagString, "MOVED_OFF|");
if (infoMask & HEAP_MOVED_IN)
strcat(flagString, "MOVED_IN|");
if (infoMask2 & HEAP_KEYS_UPDATED)
strcat(flagString, "KEYS_UPDATED|");
if (infoMask2 & HEAP_HOT_UPDATED)
strcat(flagString, "HOT_UPDATED|");
if (infoMask2 & HEAP_ONLY_TUPLE)
strcat(flagString, "HEAP_ONLY|");
if (strlen(flagString))
flagString[strlen(flagString) - 1] = '\0';
printf(" infomask: 0x%04x (%s) \n", infoMask, flagString);
/* As t_bits is a variable length array, determine the length of
* the header proper */
if (infoMask & HEAP_HASNULL)
bitmapLength = BITMAPLEN(localNatts);
else
bitmapLength = 0;
#if PG_VERSION_NUM < 120000
if (infoMask & HEAP_HASOID)
oidLength += sizeof(Oid);
#endif
computedLength =
MAXALIGN(localBitOffset + bitmapLength + oidLength);
/* Inform the user of a header size mismatch or dump the t_bits
* array */
if (computedLength != localHoff)
{
printf
(" Error: Computed header length not equal to header size.\n"
" Computed <%u> Header: <%d>\n", computedLength,
localHoff);
exitCode = 1;
}
else if ((infoMask & HEAP_HASNULL) && bitmapLength)
{
printf(" t_bits: ");
for (x = 0; x < bitmapLength; x++)
{
printf("[%u]: 0x%02x ", x, localBits[x]);
if (((x & 0x03) == 0x03) && (x < bitmapLength - 1))
printf("\n ");
}
printf("\n");
}
printf("\n");
}
}
}
/* On blocks that have special sections, print the contents
* according to previously determined special section type */
static void
FormatSpecial(char *buffer)
{
PageHeader pageHeader = (PageHeader) buffer;
char flagString[100] = "\0";
unsigned int specialOffset = pageHeader->pd_special;
unsigned int specialSize =
(blockSize >= specialOffset) ? (blockSize - specialOffset) : 0;
printf("<Special Section> -----\n");
switch (specialType)
{
case SPEC_SECT_ERROR_UNKNOWN:
case SPEC_SECT_ERROR_BOUNDARY:
printf(" Error: Invalid special section encountered.\n");
exitCode = 1;
break;
case SPEC_SECT_SEQUENCE:
printf(" Sequence: 0x%08x\n", SEQUENCE_MAGIC);
break;
/* Btree index section */
case SPEC_SECT_INDEX_BTREE:
{
BTPageOpaque btreeSection = (BTPageOpaque) (buffer + specialOffset);
if (btreeSection->btpo_flags & BTP_LEAF)
strcat(flagString, "LEAF|");
if (btreeSection->btpo_flags & BTP_ROOT)
strcat(flagString, "ROOT|");
if (btreeSection->btpo_flags & BTP_DELETED)
strcat(flagString, "DELETED|");
if (btreeSection->btpo_flags & BTP_META)
strcat(flagString, "META|");
if (btreeSection->btpo_flags & BTP_HALF_DEAD)
strcat(flagString, "HALFDEAD|");
if (btreeSection->btpo_flags & BTP_SPLIT_END)
strcat(flagString, "SPLITEND|");
if (btreeSection->btpo_flags & BTP_HAS_GARBAGE)
strcat(flagString, "HASGARBAGE|");
if (btreeSection->btpo_flags & BTP_INCOMPLETE_SPLIT)
strcat(flagString, "INCOMPLETESPLIT|");
#if PG_VERSION_NUM >= 140000
if (btreeSection->btpo_flags & BTP_HAS_FULLXID)
strcat(flagString, "HASFULLXID|");
#endif
if (strlen(flagString))
flagString[strlen(flagString) - 1] = '\0';
printf(" BTree Index Section:\n"
" Flags: 0x%04x (%s)\n"
" Blocks: Previous (%d) Next (%d) %s (%d) CycleId (%d)\n\n",
btreeSection->btpo_flags, flagString,
btreeSection->btpo_prev, btreeSection->btpo_next,
(btreeSection->
btpo_flags & BTP_DELETED) ? "Next XID" : "Level",
#if PG_VERSION_NUM >= 140000
btreeSection->btpo_level,
#else
btreeSection->btpo.level,
#endif
btreeSection->btpo_cycleid);
}
break;
/* Hash index section */
case SPEC_SECT_INDEX_HASH:
{
HashPageOpaque hashSection = (HashPageOpaque) (buffer + specialOffset);
if ((hashSection->hasho_flag & LH_PAGE_TYPE) == LH_UNUSED_PAGE)
strcat(flagString, "UNUSED|");
if (hashSection->hasho_flag & LH_OVERFLOW_PAGE)
strcat(flagString, "OVERFLOW|");
if (hashSection->hasho_flag & LH_BUCKET_PAGE)
strcat(flagString, "BUCKET|");
if (hashSection->hasho_flag & LH_BITMAP_PAGE)
strcat(flagString, "BITMAP|");
if (hashSection->hasho_flag & LH_META_PAGE)
strcat(flagString, "META|");
if (hashSection->hasho_flag & LH_BUCKET_BEING_POPULATED)
strcat(flagString, "BUCKET_BEING_POPULATED|");
if (hashSection->hasho_flag & LH_BUCKET_BEING_SPLIT)
strcat(flagString, "BUCKET_BEING_SPLIT|");
if (hashSection->hasho_flag & LH_BUCKET_NEEDS_SPLIT_CLEANUP)
strcat(flagString, "BUCKET_NEEDS_SPLIT_CLEANUP|");
if (hashSection->hasho_flag & LH_PAGE_HAS_DEAD_TUPLES)
strcat(flagString, "PAGE_HAS_DEAD_TUPLES|");
if (strlen(flagString))
flagString[strlen(flagString) - 1] = '\0';
printf(" Hash Index Section:\n"
" Flags: 0x%04x (%s)\n"
" Bucket Number: 0x%04x\n"
" Blocks: Previous (%d) Next (%d)\n\n",
hashSection->hasho_flag, flagString,
hashSection->hasho_bucket,
hashSection->hasho_prevblkno, hashSection->hasho_nextblkno);
}
break;
/* GIST index section */
case SPEC_SECT_INDEX_GIST:
{
GISTPageOpaque gistSection = (GISTPageOpaque) (buffer + specialOffset);
if (gistSection->flags & F_LEAF)
strcat(flagString, "LEAF|");
if (gistSection->flags & F_DELETED)
strcat(flagString, "DELETED|");
if (gistSection->flags & F_TUPLES_DELETED)
strcat(flagString, "TUPLES_DELETED|");
if (gistSection->flags & F_FOLLOW_RIGHT)
strcat(flagString, "FOLLOW_RIGHT|");
if (gistSection->flags & F_HAS_GARBAGE)
strcat(flagString, "HAS_GARBAGE|");
if (strlen(flagString))
flagString[strlen(flagString) - 1] = '\0';
printf(" GIST Index Section:\n"
" NSN: 0x%08x/0x%08x\n"
" RightLink: %d\n"
" Flags: 0x%08x (%s)\n\n",
gistSection->nsn.xlogid, gistSection->nsn.xrecoff,
gistSection->rightlink,
gistSection->flags, flagString);
}
break;
/* GIN index section */
case SPEC_SECT_INDEX_GIN:
{
GinPageOpaque ginSection = (GinPageOpaque) (buffer + specialOffset);
if (ginSection->flags & GIN_DATA)
strcat(flagString, "DATA|");
if (ginSection->flags & GIN_LEAF)
strcat(flagString, "LEAF|");
if (ginSection->flags & GIN_DELETED)
strcat(flagString, "DELETED|");
if (ginSection->flags & GIN_META)
strcat(flagString, "META|");
if (ginSection->flags & GIN_LIST)
strcat(flagString, "LIST|");
if (ginSection->flags & GIN_LIST_FULLROW)
strcat(flagString, "FULLROW|");
if (ginSection->flags & GIN_INCOMPLETE_SPLIT)
strcat(flagString, "INCOMPLETESPLIT|");
if (ginSection->flags & GIN_COMPRESSED)
strcat(flagString, "COMPRESSED|");
if (strlen(flagString))
flagString[strlen(flagString) - 1] = '\0';
printf(" GIN Index Section:\n"
" Flags: 0x%08x (%s) Maxoff: %d\n"
" Blocks: RightLink (%d)\n\n",
ginSection->flags, flagString,
ginSection->maxoff,
ginSection->rightlink);
}
break;
/* SP-GIST index section */
case SPEC_SECT_INDEX_SPGIST:
{
SpGistPageOpaque spgistSection = (SpGistPageOpaque) (buffer + specialOffset);
if (spgistSection->flags & SPGIST_META)
strcat(flagString, "META|");
if (spgistSection->flags & SPGIST_DELETED)
strcat(flagString, "DELETED|");
if (spgistSection->flags & SPGIST_LEAF)
strcat(flagString, "LEAF|");
if (spgistSection->flags & SPGIST_NULLS)
strcat(flagString, "NULLS|");
if (strlen(flagString))
flagString[strlen(flagString) - 1] = '\0';
printf(" SPGIST Index Section:\n"
" Flags: 0x%08x (%s)\n"
" nRedirection: %d\n"
" nPlaceholder: %d\n\n",
spgistSection->flags, flagString,
spgistSection->nRedirection,
spgistSection->nPlaceholder);
}
break;
/* No idea what type of special section this is */
default:
printf(" Unknown special section type. Type: <%u>.\n", specialType);
exitCode = 1;
break;
}
/* Dump the formatted contents of the special section */
if (blockOptions & BLOCK_FORMAT)
{
if (specialType == SPEC_SECT_ERROR_BOUNDARY)
{
printf(" Error: Special section points off page."
" Unable to dump contents.\n");
exitCode = 1;
}
else
FormatBinary(buffer, specialSize, specialOffset);
}
}
/* For each block, dump out formatted header and content information */
static void
FormatBlock(unsigned int blockOptions,
unsigned int controlOptions,
char *buffer,
BlockNumber currentBlock,
unsigned int blockSize,
bool isToast,
Oid toastOid,
uint32 *want_chunk_id,
unsigned int toastExternalSize,
char *toastValue,
unsigned int *toastRead)
{
Page page = (Page) buffer;
char *indent = isToast ? "\t" : "";
pageOffset = blockSize * currentBlock;
specialType = GetSpecialSectionType(buffer, page);
if (!isToast || verbose)
printf("\n%sBlock %4u **%s***************************************\n",
indent,
currentBlock,
(bytesToFormat ==
blockSize) ? "***************" : " PARTIAL BLOCK ");
/* Either dump out the entire block in hex+acsii fashion or
* interpret the data based on block structure */
if (blockOptions & BLOCK_NO_INTR)
FormatBinary(buffer, bytesToFormat, 0);
else
{
int rc;
/* Every block contains a header, items and possibly a special
* section. Beware of partial block reads though */
rc = FormatHeader(buffer, page, currentBlock, isToast);
/* If we didn't encounter a partial read in the header, carry on... */
if (rc != EOF_ENCOUNTERED)
{
FormatItemBlock(buffer,
page,
isToast,
toastOid,
want_chunk_id,
toastExternalSize,
toastValue,
toastRead);
if (specialType != SPEC_SECT_NONE)
FormatSpecial(buffer);
}
}
}
/* Dump out the content of the PG control file */
static void
FormatControl(char *buffer)
{
unsigned int localPgVersion = 0;
unsigned int controlFileSize = 0;
time_t cd_time;
time_t cp_time;
printf
("\n<pg_control Contents> *********************************************\n\n");
/* Check the version */
if (bytesToFormat >= offsetof(ControlFileData, catalog_version_no))
localPgVersion = ((ControlFileData *) buffer)->pg_control_version;
if (localPgVersion >= 72)
controlFileSize = sizeof(ControlFileData);
else
{
printf("pg_filedump: pg_control version %u not supported.\n",
localPgVersion);
return;
}
/* Interpret the control file if it's all there */
if (bytesToFormat >= controlFileSize)
{
ControlFileData *controlData = (ControlFileData *) buffer;
CheckPoint *checkPoint = &(controlData->checkPointCopy);
pg_crc32 crcLocal;
char *dbState;
/* Compute a local copy of the CRC to verify the one on disk */
INIT_CRC32C(crcLocal);
COMP_CRC32C(crcLocal, buffer, offsetof(ControlFileData, crc));
FIN_CRC32C(crcLocal);
/* Grab a readable version of the database state */
switch (controlData->state)
{
case DB_STARTUP:
dbState = "STARTUP";
break;
case DB_SHUTDOWNED:
dbState = "SHUTDOWNED";
break;
case DB_SHUTDOWNED_IN_RECOVERY:
dbState = "SHUTDOWNED_IN_RECOVERY";
break;
case DB_SHUTDOWNING:
dbState = "SHUTDOWNING";
break;
case DB_IN_CRASH_RECOVERY:
dbState = "IN CRASH RECOVERY";
break;
case DB_IN_ARCHIVE_RECOVERY:
dbState = "IN ARCHIVE RECOVERY";
break;
case DB_IN_PRODUCTION:
dbState = "IN PRODUCTION";
break;
default:
dbState = "UNKNOWN";
break;
}
/* convert timestamps to system's time_t width */
cd_time = controlData->time;
cp_time = checkPoint->time;
printf(" CRC: %s\n"
" pg_control Version: %u%s\n"
" Catalog Version: %u\n"
" System Identifier: " UINT64_FORMAT "\n"
" State: %s\n"
" Last Mod Time: %s"
" Last Checkpoint Record: Log File (%u) Offset (0x%08x)\n"
#if PG_VERSION_NUM < 110000
" Previous Checkpoint Record: Log File (%u) Offset (0x%08x)\n"
#endif
" Last Checkpoint Record Redo: Log File (%u) Offset (0x%08x)\n"
" |- TimeLineID: %u\n"
" |- Next XID: %u/%u\n"
" |- Next OID: %u\n"
" |- Next Multi: %u\n"
" |- Next MultiOff: %u\n"
" |- Time: %s"
" Minimum Recovery Point: Log File (%u) Offset (0x%08x)\n"
" Maximum Data Alignment: %u\n"
" Floating-Point Sample: %.7g%s\n"
" Database Block Size: %u\n"
" Blocks Per Segment: %u\n"
" XLOG Block Size: %u\n"
" XLOG Segment Size: %u\n"
" Maximum Identifier Length: %u\n"
" Maximum Index Keys: %u\n"
" TOAST Chunk Size: %u\n\n",
EQ_CRC32C(crcLocal,
controlData->crc) ? "Correct" : "Not Correct",
controlData->pg_control_version,
(controlData->pg_control_version == PG_CONTROL_VERSION ?
"" : " (Not Correct!)"),
controlData->catalog_version_no,
controlData->system_identifier,
dbState,
ctime(&(cd_time)),
(uint32) (controlData->checkPoint >> 32), (uint32) controlData->checkPoint,
#if PG_VERSION_NUM < 110000
(uint32) (controlData->prevCheckPoint >> 32), (uint32) controlData->prevCheckPoint,
#endif
(uint32) (checkPoint->redo >> 32), (uint32) checkPoint->redo,
checkPoint->ThisTimeLineID,
#if PG_VERSION_NUM < 120000
checkPoint->nextXidEpoch, checkPoint->nextXid,
#elif PG_VERSION_NUM < 140000
EpochFromFullTransactionId(checkPoint->nextFullXid),
XidFromFullTransactionId(checkPoint->nextFullXid),
#else
EpochFromFullTransactionId(checkPoint->nextXid),
XidFromFullTransactionId(checkPoint->nextXid),
#endif
checkPoint->nextOid,
checkPoint->nextMulti, checkPoint->nextMultiOffset,
ctime(&cp_time),
(uint32) (controlData->minRecoveryPoint >> 32), (uint32) controlData->minRecoveryPoint,
controlData->maxAlign,
controlData->floatFormat,
(controlData->floatFormat == FLOATFORMAT_VALUE ?
"" : " (Not Correct!)"),
controlData->blcksz,
controlData->relseg_size,
controlData->xlog_blcksz,
controlData->xlog_seg_size,
controlData->nameDataLen,
controlData->indexMaxKeys,
controlData->toast_max_chunk_size);
}
else
{
printf(" Error: pg_control file size incorrect.\n"
" Size: Correct <%u> Received <%u>.\n\n",
controlFileSize, bytesToFormat);
/* If we have an error, force a formatted dump so we can see
* where things are going wrong */
controlOptions |= CONTROL_FORMAT;
exitCode = 1;
}
/* Dump hex and ascii representation of data */
if (controlOptions & CONTROL_FORMAT)
{
printf("<pg_control Formatted Dump> *****************"
"**********************\n\n");
FormatBinary(buffer, bytesToFormat, 0);
}
}
/* Dump out the contents of the block in hex and ascii.
* BYTES_PER_LINE bytes are formatted in each line. */
static void
FormatBinary(char *buffer, unsigned int numBytes, unsigned int startIndex)
{
unsigned int index = 0;
unsigned int stopIndex = 0;
unsigned int x = 0;
unsigned int lastByte = startIndex + numBytes;
if (numBytes)
{
/* Iterate through a printable row detailing the current
* address, the hex and ascii values */
for (index = startIndex; index < lastByte; index += BYTES_PER_LINE)
{
stopIndex = index + BYTES_PER_LINE;
/* Print out the address */
if (blockOptions & BLOCK_ABSOLUTE)
printf(" %08x: ", (unsigned int) (pageOffset + index));
else
printf(" %04x: ", (unsigned int) index);
/* Print out the hex version of the data */
for (x = index; x < stopIndex; x++)
{
if (x < lastByte)
printf("%02x", 0xff & ((unsigned) buffer[x]));
else
printf(" ");
if ((x & 0x03) == 0x03)
printf(" ");
}
printf(" ");
/* Print out the ascii version of the data */
for (x = index; x < stopIndex; x++)
{
if (x < lastByte)
printf("%c", isprint(buffer[x]) ? buffer[x] : '.');
else
printf(" ");
}
printf("\n");
}
printf("\n");
}
}
/* Dump the binary image of the block */
static void
DumpBinaryBlock(char *buffer)
{
unsigned int x;
for (x = 0; x < bytesToFormat; x++)
putchar(buffer[x]);
}
/* Control the dumping of the blocks within the file */
int
DumpFileContents(unsigned int blockOptions,
unsigned int controlOptions,
FILE *fp,
unsigned int blockSize,
int blockStart,
int blockEnd,
bool isToast,
Oid toastOid,
uint32 *want_chunk_id,
unsigned int toastExternalSize,
char *toastValue,
unsigned int *toastDataRead)
{
unsigned int initialRead = 1;
unsigned int contentsToDump = 1;
BlockNumber currentBlock = 0;
int result = 0;
/* On a positive block size, allocate a local buffer to store
* the subsequent blocks */
char *block = (char *)malloc(blockSize);
if (!block)
{
printf("\nError: Unable to create buffer of size <%d>.\n",
blockSize);
result = 1;
}
/* If the user requested a block range, seek to the correct position
* within the file for the start block. */
if (result == 0 && blockOptions & BLOCK_RANGE)
{
unsigned int position = blockSize * blockStart;
if (fseek(fp, position, SEEK_SET) != 0)
{
printf("Error: Seek error encountered before requested "
"start block <%d>.\n", blockStart);
contentsToDump = 0;
result = 1;
}
else
currentBlock = blockStart;
}
/* Iterate through the blocks in the file until you reach the end or
* the requested range end */
while (contentsToDump && result == 0)
{
bytesToFormat = fread(block, 1, blockSize, fp);
if (bytesToFormat == 0)
{
/* fseek() won't pop an error if you seek passed eof. The next
* subsequent read gets the error. */
if (initialRead)
printf("Error: Premature end of file encountered.\n");
else if (!(blockOptions & BLOCK_BINARY) && (!isToast || verbose))
printf("\n*** End of File Encountered. Last Block "
"Read: %d ***\n", currentBlock - 1);
contentsToDump = 0;
}
else
{
if (blockOptions & BLOCK_BINARY)
DumpBinaryBlock(block);
else
{
if (controlOptions & CONTROL_DUMP)
{
FormatControl(block);
contentsToDump = false;
}
else
{
FormatBlock(blockOptions,
controlOptions,
block,
currentBlock,
blockSize,
isToast,
toastOid,
want_chunk_id,
toastExternalSize,
toastValue,
toastDataRead);
}
}
}
/* Check to see if we are at the end of the requested range. */
if ((blockOptions & BLOCK_RANGE) &&
(currentBlock >= blockEnd) && (contentsToDump))
{
/* Don't print out message if we're doing a binary dump */
if (!(blockOptions & BLOCK_BINARY))
printf("\n*** End of Requested Range Encountered. "
"Last Block Read: %d ***\n", currentBlock);
contentsToDump = 0;
}
else
currentBlock++;
initialRead = 0;
/* If TOAST data is read */
if (isToast && *toastDataRead >= toastExternalSize)
break;
}
free(block);
return result;
}
int
PrintRelMappings(void)
{
// For storing ingested data
char charbuf[RELMAPPER_FILESIZE];
RelMapFile *map;
RelMapping *mappings;
RelMapping m;
int bytesRead;
// For confirming Magic Number correctness
char m1[RELMAPPER_MAGICSIZE];
char m2[RELMAPPER_MAGICSIZE];
int magic_ref = RELMAPPER_FILEMAGIC;
int magic_val;
int num_loops;
// Read in the file
rewind(fp); // Make sure to start from the beginning
bytesRead = fread(charbuf,1,RELMAPPER_FILESIZE,fp);
if ( bytesRead != RELMAPPER_FILESIZE ) {
printf("Read %d bytes, expected %d\n", bytesRead, RELMAPPER_FILESIZE);
return 0;
}
// Convert to RelMapFile type for usability
map = (RelMapFile *) charbuf;
// Check and print Magic Number correctness
printf("Magic Number: 0x%x",map->magic);
magic_val = map->magic;
memcpy(m1,&magic_ref,RELMAPPER_MAGICSIZE);
memcpy(m2,&magic_val,RELMAPPER_MAGICSIZE);
if ( memcmp(m1,m2,RELMAPPER_MAGICSIZE) == 0 ) {
printf(" (CORRECT)\n");
} else {
printf(" (INCORRECT)\n");
}
// Print Mappings
printf("Num Mappings: %d\n",map->num_mappings);
printf("Detailed Mappings list:\n");
mappings = map->mappings;
// Limit number of mappings as per MAX_MAPPINGS
num_loops = map->num_mappings;
if ( map->num_mappings > MAX_MAPPINGS ) {
num_loops = MAX_MAPPINGS;
printf(" NOTE: listing has been limited to the first %d mappings\n", MAX_MAPPINGS);
printf(" (perhaps your file is not a valid pg_filenode.map file?)\n");
}
for (int i=0; i < num_loops; i++) {
m = mappings[i];
printf("OID: %u\tFilenode: %u\n",
m.mapoid,
m.mapfilenode);
}
return 1;
}
/* Consume the options and iterate through the given file, formatting as
* requested. */
int
main(int argv, char **argc)
{
/* If there is a parameter list, validate the options */
unsigned int validOptions;
validOptions = (argv < 2) ? OPT_RC_COPYRIGHT : ConsumeOptions(argv, argc);
/* Display valid options if no parameters are received or invalid options
* where encountered */
if (validOptions != OPT_RC_VALID)
DisplayOptions(validOptions);
else if (isRelMapFile)
{
CreateDumpFileHeader(argv, argc);
exitCode = PrintRelMappings();
}
else
{
/* Don't dump the header if we're dumping binary pages */
if (!(blockOptions & BLOCK_BINARY))
CreateDumpFileHeader(argv, argc);
/* If the user has not forced a block size, use the size of the
* control file data or the information from the block 0 header */
if (controlOptions)
{
if (!(controlOptions & CONTROL_FORCED))
blockSize = sizeof(ControlFileData);
}
else if (!(blockOptions & BLOCK_FORCED))
blockSize = GetBlockSize(fp);
exitCode = DumpFileContents(blockOptions,
controlOptions,
fp,
blockSize,
blockStart,
blockEnd,
false /* is toast realtion */,
0, /* no toast Oid */
NULL, /* no current TOAST chunk */
0, /* no toast external size */
NULL, /* no out toast value */
NULL /* no toast value length */
);
}
if (fp)
fclose(fp);
exit(exitCode);
}
|