PostgreSQL Source Code git master
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
pg_walsummary.c File Reference
#include "postgres_fe.h"
#include <fcntl.h>
#include <limits.h>
#include "common/blkreftable.h"
#include "common/int.h"
#include "common/logging.h"
#include "fe_utils/option_utils.h"
#include "getopt_long.h"
Include dependency graph for pg_walsummary.c:

Go to the source code of this file.

Data Structures

struct  ws_options
 
struct  ws_file_info
 

Typedefs

typedef struct ws_options ws_options
 
typedef struct ws_file_info ws_file_info
 

Functions

static void dump_one_relation (ws_options *opt, RelFileLocator *rlocator, ForkNumber forknum, BlockNumber limit_block, BlockRefTableReader *reader)
 
static void help (const char *progname)
 
static int compare_block_numbers (const void *a, const void *b)
 
static int walsummary_read_callback (void *callback_arg, void *data, int length)
 
static void walsummary_error_callback (void *callback_arg, char *fmt,...) pg_attribute_printf(2
 
static void int main (int argc, char *argv[])
 

Variables

static BlockNumberblock_buffer = NULL
 
static unsigned block_buffer_size = 512
 

Typedef Documentation

◆ ws_file_info

typedef struct ws_file_info ws_file_info

◆ ws_options

typedef struct ws_options ws_options

Function Documentation

◆ compare_block_numbers()

static int compare_block_numbers ( const void *  a,
const void *  b 
)
static

Definition at line 218 of file pg_walsummary.c.

219{
220 BlockNumber aa = *(BlockNumber *) a;
221 BlockNumber bb = *(BlockNumber *) b;
222
223 return pg_cmp_u32(aa, bb);
224}
uint32 BlockNumber
Definition: block.h:31
static int pg_cmp_u32(uint32 a, uint32 b)
Definition: int.h:652
int b
Definition: isn.c:69
int a
Definition: isn.c:68

References a, b, and pg_cmp_u32().

Referenced by dump_one_relation().

◆ dump_one_relation()

static void dump_one_relation ( ws_options opt,
RelFileLocator rlocator,
ForkNumber  forknum,
BlockNumber  limit_block,
BlockRefTableReader reader 
)
static

Definition at line 128 of file pg_walsummary.c.

131{
132 unsigned i = 0;
133 unsigned nblocks;
134 BlockNumber startblock = InvalidBlockNumber;
136
137 /* Dump limit block, if any. */
138 if (limit_block != InvalidBlockNumber)
139 printf("TS %u, DB %u, REL %u, FORK %s: limit %u\n",
140 rlocator->spcOid, rlocator->dbOid, rlocator->relNumber,
141 forkNames[forknum], limit_block);
142
143 /* If we haven't allocated a block buffer yet, do that now. */
144 if (block_buffer == NULL)
146
147 /* Try to fill the block buffer. */
148 nblocks = BlockRefTableReaderGetBlocks(reader,
151
152 /* If we filled the block buffer completely, we must enlarge it. */
153 while (nblocks >= block_buffer_size)
154 {
155 unsigned new_size;
156
157 /* Double the size, being careful about overflow. */
158 new_size = block_buffer_size * 2;
159 if (new_size < block_buffer_size)
160 new_size = PG_UINT32_MAX;
162
163 /* Try to fill the newly-allocated space. */
164 nblocks +=
167 new_size - block_buffer_size);
168
169 /* Save the new size for later calls. */
170 block_buffer_size = new_size;
171 }
172
173 /* If we don't need to produce any output, skip the rest of this. */
174 if (opt->quiet)
175 return;
176
177 /*
178 * Sort the returned block numbers. If the block reference table was using
179 * the bitmap representation for a given chunk, the block numbers in that
180 * chunk will already be sorted, but when the array-of-offsets
181 * representation is used, we can receive block numbers here out of order.
182 */
184
185 /* Dump block references. */
186 while (i < nblocks)
187 {
188 /*
189 * Find the next range of blocks to print, but if --individual was
190 * specified, then consider each block a separate range.
191 */
192 startblock = endblock = block_buffer[i++];
193 if (!opt->individual)
194 {
195 while (i < nblocks && block_buffer[i] == endblock + 1)
196 {
197 endblock++;
198 i++;
199 }
200 }
201
202 /* Format this range of block numbers as a string. */
203 if (startblock == endblock)
204 printf("TS %u, DB %u, REL %u, FORK %s: block %u\n",
205 rlocator->spcOid, rlocator->dbOid, rlocator->relNumber,
206 forkNames[forknum], startblock);
207 else
208 printf("TS %u, DB %u, REL %u, FORK %s: blocks %u..%u\n",
209 rlocator->spcOid, rlocator->dbOid, rlocator->relNumber,
210 forkNames[forknum], startblock, endblock);
211 }
212}
unsigned BlockRefTableReaderGetBlocks(BlockRefTableReader *reader, BlockNumber *blocks, int nblocks)
Definition: blkreftable.c:689
#define InvalidBlockNumber
Definition: block.h:33
#define PG_UINT32_MAX
Definition: c.h:544
#define repalloc_array(pointer, type, count)
Definition: fe_memutils.h:78
#define palloc_array(type, count)
Definition: fe_memutils.h:76
int i
Definition: isn.c:72
static int compare_block_numbers(const void *a, const void *b)
static BlockNumber * block_buffer
Definition: pg_walsummary.c:36
static unsigned block_buffer_size
Definition: pg_walsummary.c:37
#define qsort(a, b, c, d)
Definition: port.h:447
#define printf(...)
Definition: port.h:244
const char *const forkNames[]
Definition: relpath.c:33
RelFileNumber relNumber
bool individual
Definition: pg_walsummary.c:26

References block_buffer, block_buffer_size, BlockRefTableReaderGetBlocks(), compare_block_numbers(), RelFileLocator::dbOid, forkNames, i, ws_options::individual, InvalidBlockNumber, palloc_array, PG_UINT32_MAX, printf, qsort, ws_options::quiet, RelFileLocator::relNumber, repalloc_array, and RelFileLocator::spcOid.

Referenced by main().

◆ help()

static void help ( const char *  progname)
static

Definition at line 264 of file pg_walsummary.c.

265{
266 printf(_("%s prints the contents of a WAL summary file.\n\n"), progname);
267 printf(_("Usage:\n"));
268 printf(_(" %s [OPTION]... FILE...\n"), progname);
269 printf(_("\nOptions:\n"));
270 printf(_(" -i, --individual list block numbers individually, not as ranges\n"));
271 printf(_(" -q, --quiet don't print anything, just parse the files\n"));
272 printf(_(" -V, --version output version information, then exit\n"));
273 printf(_(" -?, --help show this help, then exit\n"));
274
275 printf(_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
276 printf(_("%s home page: <%s>\n"), PACKAGE_NAME, PACKAGE_URL);
277}
#define _(x)
Definition: elog.c:90
const char * progname
Definition: main.c:44

References _, printf, and progname.

Referenced by main().

◆ main()

static void int main ( int  argc,
char *  argv[] 
)

Definition at line 52 of file pg_walsummary.c.

53{
54 static struct option long_options[] = {
55 {"individual", no_argument, NULL, 'i'},
56 {"quiet", no_argument, NULL, 'q'},
57 {NULL, 0, NULL, 0}
58 };
59
60 const char *progname;
61 int optindex;
62 int c;
63 ws_options opt;
64
65 memset(&opt, 0, sizeof(ws_options));
66
67 pg_logging_init(argv[0]);
68 progname = get_progname(argv[0]);
69 set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pg_walsummary"));
71
72 /* process command-line options */
73 while ((c = getopt_long(argc, argv, "iq",
74 long_options, &optindex)) != -1)
75 {
76 switch (c)
77 {
78 case 'i':
79 opt.individual = true;
80 break;
81 case 'q':
82 opt.quiet = true;
83 break;
84 default:
85 /* getopt_long already emitted a complaint */
86 pg_log_error_hint("Try \"%s --help\" for more information.", progname);
87 exit(1);
88 }
89 }
90
91 if (optind >= argc)
92 {
93 pg_log_error("no input files specified");
94 pg_log_error_hint("Try \"%s --help\" for more information.", progname);
95 exit(1);
96 }
97
98 while (optind < argc)
99 {
100 ws_file_info ws;
101 BlockRefTableReader *reader;
102 RelFileLocator rlocator;
103 ForkNumber forknum;
104 BlockNumber limit_block;
105
106 ws.filename = argv[optind++];
107 if ((ws.fd = open(ws.filename, O_RDONLY | PG_BINARY, 0)) < 0)
108 pg_fatal("could not open file \"%s\": %m", ws.filename);
109
111 ws.filename,
113 while (BlockRefTableReaderNextRelation(reader, &rlocator, &forknum,
114 &limit_block))
115 dump_one_relation(&opt, &rlocator, forknum, limit_block, reader);
116
118 close(ws.fd);
119 }
120
121 exit(0);
122}
bool BlockRefTableReaderNextRelation(BlockRefTableReader *reader, RelFileLocator *rlocator, ForkNumber *forknum, BlockNumber *limit_block)
Definition: blkreftable.c:613
BlockRefTableReader * CreateBlockRefTableReader(io_callback_fn read_callback, void *read_callback_arg, char *error_filename, report_error_fn error_callback, void *error_callback_arg)
Definition: blkreftable.c:577
void DestroyBlockRefTableReader(BlockRefTableReader *reader)
Definition: blkreftable.c:773
#define PG_TEXTDOMAIN(domain)
Definition: c.h:1168
#define PG_BINARY
Definition: c.h:1227
void set_pglocale_pgservice(const char *argv0, const char *app)
Definition: exec.c:429
int getopt_long(int argc, char *const argv[], const char *optstring, const struct option *longopts, int *longindex)
Definition: getopt_long.c:60
#define no_argument
Definition: getopt_long.h:24
#define close(a)
Definition: win32.h:12
exit(1)
void pg_logging_init(const char *argv0)
Definition: logging.c:83
#define pg_log_error(...)
Definition: logging.h:106
#define pg_log_error_hint(...)
Definition: logging.h:112
void handle_help_version_opts(int argc, char *argv[], const char *fixed_progname, help_handler hlp)
Definition: option_utils.c:24
#define pg_fatal(...)
PGDLLIMPORT int optind
Definition: getopt.c:51
static void walsummary_error_callback(void *callback_arg, char *fmt,...) pg_attribute_printf(2
static void help(const char *progname)
static void dump_one_relation(ws_options *opt, RelFileLocator *rlocator, ForkNumber forknum, BlockNumber limit_block, BlockRefTableReader *reader)
static int walsummary_read_callback(void *callback_arg, void *data, int length)
const char * get_progname(const char *argv0)
Definition: path.c:575
char * c
ForkNumber
Definition: relpath.h:56
char * filename
Definition: pg_walsummary.c:33

References BlockRefTableReaderNextRelation(), close, CreateBlockRefTableReader(), DestroyBlockRefTableReader(), dump_one_relation(), exit(), ws_file_info::fd, ws_file_info::filename, get_progname(), getopt_long(), handle_help_version_opts(), help(), ws_options::individual, no_argument, optind, PG_BINARY, pg_fatal, pg_log_error, pg_log_error_hint, pg_logging_init(), PG_TEXTDOMAIN, progname, ws_options::quiet, set_pglocale_pgservice(), walsummary_error_callback(), and walsummary_read_callback().

◆ walsummary_error_callback()

void walsummary_error_callback ( void *  callback_arg,
char *  fmt,
  ... 
)
static

Definition at line 230 of file pg_walsummary.c.

231{
232 va_list ap;
233
234 va_start(ap, fmt);
236 va_end(ap);
237
238 exit(1);
239}
static void const char * fmt
va_end(args)
va_start(args, fmt)
void pg_log_generic_v(enum pg_log_level level, enum pg_log_part part, const char *pg_restrict fmt, va_list ap)
Definition: logging.c:219
@ PG_LOG_PRIMARY
Definition: logging.h:67
@ PG_LOG_ERROR
Definition: logging.h:43

References exit(), fmt, PG_LOG_ERROR, pg_log_generic_v(), PG_LOG_PRIMARY, va_end(), and va_start().

Referenced by main().

◆ walsummary_read_callback()

int walsummary_read_callback ( void *  callback_arg,
void *  data,
int  length 
)
static

Definition at line 245 of file pg_walsummary.c.

246{
247 ws_file_info *ws = callback_arg;
248 int rc;
249
250 if ((rc = read(ws->fd, data, length)) < 0)
251 pg_fatal("could not read file \"%s\": %m", ws->filename);
252
253 return rc;
254}
#define read(a, b, c)
Definition: win32.h:13
const void * data

References data, ws_file_info::fd, ws_file_info::filename, pg_fatal, and read.

Referenced by main().

Variable Documentation

◆ block_buffer

BlockNumber* block_buffer = NULL
static

Definition at line 36 of file pg_walsummary.c.

Referenced by dump_one_relation().

◆ block_buffer_size

unsigned block_buffer_size = 512
static

Definition at line 37 of file pg_walsummary.c.

Referenced by dump_one_relation().