-
Notifications
You must be signed in to change notification settings - Fork 18
/
pg_filedump.c
2421 lines (2160 loc) · 66.6 KB
/
pg_filedump.c
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
/*
* 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-2023, 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"
/*
* 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 */
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,
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,
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);
/* 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-2023, 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 gin leaf page */
static bool
IsGinLeafPage(Page page)
{
if ((PageGetSpecialSize(page) == (MAXALIGN(sizeof(GinPageOpaqueData))))
&& (bytesToFormat == blockSize))
{
GinPageOpaque gpo = GinPageGetOpaque(page);
if (gpo->flags & GIN_LEAF)
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);
}
/* 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);