Branch data Line data Source code
1 : : /*-------------------------------------------------------------------------
2 : : *
3 : : * rawpage.c
4 : : * Functions to extract a raw page as bytea and inspect it
5 : : *
6 : : * Access-method specific inspection functions are in separate files.
7 : : *
8 : : * Copyright (c) 2007-2026, PostgreSQL Global Development Group
9 : : *
10 : : * IDENTIFICATION
11 : : * contrib/pageinspect/rawpage.c
12 : : *
13 : : *-------------------------------------------------------------------------
14 : : */
15 : :
16 : : #include "postgres.h"
17 : :
18 : : #include "access/htup_details.h"
19 : : #include "access/relation.h"
20 : : #include "catalog/namespace.h"
21 : : #include "catalog/pg_type.h"
22 : : #include "funcapi.h"
23 : : #include "miscadmin.h"
24 : : #include "pageinspect.h"
25 : : #include "storage/bufmgr.h"
26 : : #include "storage/checksum.h"
27 : : #include "utils/builtins.h"
28 : : #include "utils/pg_lsn.h"
29 : : #include "utils/rel.h"
30 : : #include "utils/varlena.h"
31 : :
32 : 25 : PG_MODULE_MAGIC_EXT(
33 : : .name = "pageinspect",
34 : : .version = PG_VERSION
35 : : );
36 : :
37 : : static bytea *get_raw_page_internal(text *relname, ForkNumber forknum,
38 : : BlockNumber blkno);
39 : :
40 : :
41 : : /*
42 : : * get_raw_page
43 : : *
44 : : * Returns a copy of a page from shared buffers as a bytea
45 : : */
46 : 24 : PG_FUNCTION_INFO_V1(get_raw_page_1_9);
47 : :
48 : : Datum
49 : 121 : get_raw_page_1_9(PG_FUNCTION_ARGS)
50 : : {
51 : 121 : text *relname = PG_GETARG_TEXT_PP(0);
52 : 121 : int64 blkno = PG_GETARG_INT64(1);
53 : : bytea *raw_page;
54 : :
55 [ + + - + ]: 121 : if (blkno < 0 || blkno > MaxBlockNumber)
56 [ + - ]: 1 : ereport(ERROR,
57 : : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
58 : : errmsg("invalid block number")));
59 : :
60 : 120 : raw_page = get_raw_page_internal(relname, MAIN_FORKNUM, blkno);
61 : :
62 : 115 : PG_RETURN_BYTEA_P(raw_page);
63 : : }
64 : :
65 : : /*
66 : : * entry point for old extension version
67 : : */
68 : 8 : PG_FUNCTION_INFO_V1(get_raw_page);
69 : :
70 : : Datum
71 : 2 : get_raw_page(PG_FUNCTION_ARGS)
72 : : {
73 : 2 : text *relname = PG_GETARG_TEXT_PP(0);
74 : 2 : uint32 blkno = PG_GETARG_UINT32(1);
75 : : bytea *raw_page;
76 : :
77 : : /*
78 : : * We don't normally bother to check the number of arguments to a C
79 : : * function, but here it's needed for safety because early 8.4 beta
80 : : * releases mistakenly redefined get_raw_page() as taking three arguments.
81 : : */
82 [ - + ]: 2 : if (PG_NARGS() != 2)
83 [ # # ]: 0 : ereport(ERROR,
84 : : (errmsg("wrong number of arguments to get_raw_page()"),
85 : : errhint("Run the updated pageinspect.sql script.")));
86 : :
87 : 2 : raw_page = get_raw_page_internal(relname, MAIN_FORKNUM, blkno);
88 : :
89 : 2 : PG_RETURN_BYTEA_P(raw_page);
90 : : }
91 : :
92 : : /*
93 : : * get_raw_page_fork
94 : : *
95 : : * Same, for any fork
96 : : */
97 : 9 : PG_FUNCTION_INFO_V1(get_raw_page_fork_1_9);
98 : :
99 : : Datum
100 : 12 : get_raw_page_fork_1_9(PG_FUNCTION_ARGS)
101 : : {
102 : 12 : text *relname = PG_GETARG_TEXT_PP(0);
103 : 12 : text *forkname = PG_GETARG_TEXT_PP(1);
104 : 12 : int64 blkno = PG_GETARG_INT64(2);
105 : : bytea *raw_page;
106 : : ForkNumber forknum;
107 : :
108 : 12 : forknum = forkname_to_number(text_to_cstring(forkname));
109 : :
110 [ + + - + ]: 11 : if (blkno < 0 || blkno > MaxBlockNumber)
111 [ + - ]: 1 : ereport(ERROR,
112 : : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
113 : : errmsg("invalid block number")));
114 : :
115 : 10 : raw_page = get_raw_page_internal(relname, forknum, blkno);
116 : :
117 : 7 : PG_RETURN_BYTEA_P(raw_page);
118 : : }
119 : :
120 : : /*
121 : : * Entry point for old extension version
122 : : */
123 : 8 : PG_FUNCTION_INFO_V1(get_raw_page_fork);
124 : :
125 : : Datum
126 : 1 : get_raw_page_fork(PG_FUNCTION_ARGS)
127 : : {
128 : 1 : text *relname = PG_GETARG_TEXT_PP(0);
129 : 1 : text *forkname = PG_GETARG_TEXT_PP(1);
130 : 1 : uint32 blkno = PG_GETARG_UINT32(2);
131 : : bytea *raw_page;
132 : : ForkNumber forknum;
133 : :
134 : 1 : forknum = forkname_to_number(text_to_cstring(forkname));
135 : :
136 : 1 : raw_page = get_raw_page_internal(relname, forknum, blkno);
137 : :
138 : 1 : PG_RETURN_BYTEA_P(raw_page);
139 : : }
140 : :
141 : : /*
142 : : * workhorse
143 : : */
144 : : static bytea *
145 : 133 : get_raw_page_internal(text *relname, ForkNumber forknum, BlockNumber blkno)
146 : : {
147 : : bytea *raw_page;
148 : : RangeVar *relrv;
149 : : Relation rel;
150 : : char *raw_page_data;
151 : : Buffer buf;
152 : :
153 [ - + ]: 133 : if (!superuser())
154 [ # # ]: 0 : ereport(ERROR,
155 : : (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
156 : : errmsg("must be superuser to use raw page functions")));
157 : :
158 : 133 : relrv = makeRangeVarFromNameList(textToQualifiedNameList(relname));
159 : 133 : rel = relation_openrv(relrv, AccessShareLock);
160 : :
161 [ + + + + : 132 : if (!RELKIND_HAS_STORAGE(rel->rd_rel->relkind))
+ + + - +
- ]
162 [ + - ]: 2 : ereport(ERROR,
163 : : (errcode(ERRCODE_WRONG_OBJECT_TYPE),
164 : : errmsg("cannot get raw page from relation \"%s\"",
165 : : RelationGetRelationName(rel)),
166 : : errdetail_relkind_not_supported(rel->rd_rel->relkind)));
167 : :
168 : : /*
169 : : * Reject attempts to read non-local temporary relations; we would be
170 : : * likely to get wrong data since we have no visibility into the owning
171 : : * session's local buffers.
172 : : */
173 [ + + - + ]: 130 : if (RELATION_IS_OTHER_TEMP(rel))
174 [ # # ]: 0 : ereport(ERROR,
175 : : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
176 : : errmsg("cannot access temporary tables of other sessions")));
177 : :
178 [ + + ]: 130 : if (blkno >= RelationGetNumberOfBlocksInFork(rel, forknum))
179 [ + - ]: 5 : ereport(ERROR,
180 : : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
181 : : errmsg("block number %u is out of range for relation \"%s\"",
182 : : blkno, RelationGetRelationName(rel))));
183 : :
184 : : /* Initialize buffer to copy to */
185 : 125 : raw_page = (bytea *) palloc(BLCKSZ + VARHDRSZ);
186 : 125 : SET_VARSIZE(raw_page, BLCKSZ + VARHDRSZ);
187 : 125 : raw_page_data = VARDATA(raw_page);
188 : :
189 : : /* Take a verbatim copy of the page */
190 : :
191 : 125 : buf = ReadBufferExtended(rel, forknum, blkno, RBM_NORMAL, NULL);
192 : 125 : LockBuffer(buf, BUFFER_LOCK_SHARE);
193 : :
194 : 125 : memcpy(raw_page_data, BufferGetPage(buf), BLCKSZ);
195 : :
196 : 125 : UnlockReleaseBuffer(buf);
197 : :
198 : 125 : relation_close(rel, AccessShareLock);
199 : :
200 : 125 : return raw_page;
201 : : }
202 : :
203 : :
204 : : /*
205 : : * get_page_from_raw
206 : : *
207 : : * Get a palloc'd, maxalign'ed page image from the result of get_raw_page()
208 : : *
209 : : * On machines with MAXALIGN = 8, the payload of a bytea is not maxaligned,
210 : : * since it will start 4 bytes into a palloc'd value. PageHeaderData requires
211 : : * 8 byte alignment, so always use this function when accessing page header
212 : : * fields from a raw page bytea.
213 : : */
214 : : Page
215 : 163 : get_page_from_raw(bytea *raw_page)
216 : : {
217 : : Page page;
218 : : int raw_page_size;
219 : :
220 : 163 : raw_page_size = VARSIZE_ANY_EXHDR(raw_page);
221 : :
222 [ + + ]: 163 : if (raw_page_size != BLCKSZ)
223 [ + - ]: 14 : ereport(ERROR,
224 : : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
225 : : errmsg("invalid page size"),
226 : : errdetail("Expected %d bytes, got %d.",
227 : : BLCKSZ, raw_page_size)));
228 : :
229 : 149 : page = palloc(raw_page_size);
230 : :
231 : 149 : memcpy(page, VARDATA_ANY(raw_page), raw_page_size);
232 : :
233 : 149 : return page;
234 : : }
235 : :
236 : :
237 : : /*
238 : : * page_header
239 : : *
240 : : * Allows inspection of page header fields of a raw page
241 : : */
242 : :
243 : 17 : PG_FUNCTION_INFO_V1(page_header);
244 : :
245 : : Datum
246 : 5 : page_header(PG_FUNCTION_ARGS)
247 : : {
248 : 5 : bytea *raw_page = PG_GETARG_BYTEA_P(0);
249 : :
250 : : TupleDesc tupdesc;
251 : :
252 : : Datum result;
253 : : HeapTuple tuple;
254 : : Datum values[9];
255 : : bool nulls[9];
256 : :
257 : : Page page;
258 : : PageHeader pageheader;
259 : : XLogRecPtr lsn;
260 : :
261 [ - + ]: 5 : if (!superuser())
262 [ # # ]: 0 : ereport(ERROR,
263 : : (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
264 : : errmsg("must be superuser to use raw page functions")));
265 : :
266 : 5 : page = get_page_from_raw(raw_page);
267 : 4 : pageheader = (PageHeader) page;
268 : :
269 : : /* Build a tuple descriptor for our result type */
270 [ - + ]: 4 : if (get_call_result_type(fcinfo, NULL, &tupdesc) != TYPEFUNC_COMPOSITE)
271 [ # # ]: 0 : elog(ERROR, "return type must be a row type");
272 : :
273 : : /* Extract information from the page header */
274 : :
275 : 4 : lsn = PageGetLSN(page);
276 : :
277 : : /* pageinspect >= 1.2 uses pg_lsn instead of text for the LSN field. */
278 [ - + ]: 4 : if (TupleDescAttr(tupdesc, 0)->atttypid == TEXTOID)
279 : : {
280 : : char lsnchar[64];
281 : :
282 : 0 : snprintf(lsnchar, sizeof(lsnchar), "%X/%08X", LSN_FORMAT_ARGS(lsn));
283 : 0 : values[0] = CStringGetTextDatum(lsnchar);
284 : : }
285 : : else
286 : 4 : values[0] = LSNGetDatum(lsn);
287 : 4 : values[1] = UInt16GetDatum(pageheader->pd_checksum);
288 : 4 : values[2] = UInt16GetDatum(pageheader->pd_flags);
289 : :
290 : : /* pageinspect >= 1.10 uses int4 instead of int2 for those fields */
291 [ + + - ]: 4 : switch (TupleDescAttr(tupdesc, 3)->atttypid)
292 : : {
293 : 1 : case INT2OID:
294 : : Assert(TupleDescAttr(tupdesc, 4)->atttypid == INT2OID &&
295 : : TupleDescAttr(tupdesc, 5)->atttypid == INT2OID &&
296 : : TupleDescAttr(tupdesc, 6)->atttypid == INT2OID);
297 : 1 : values[3] = UInt16GetDatum(pageheader->pd_lower);
298 : 1 : values[4] = UInt16GetDatum(pageheader->pd_upper);
299 : 1 : values[5] = UInt16GetDatum(pageheader->pd_special);
300 : 1 : values[6] = UInt16GetDatum(PageGetPageSize(page));
301 : 1 : break;
302 : 3 : case INT4OID:
303 : : Assert(TupleDescAttr(tupdesc, 4)->atttypid == INT4OID &&
304 : : TupleDescAttr(tupdesc, 5)->atttypid == INT4OID &&
305 : : TupleDescAttr(tupdesc, 6)->atttypid == INT4OID);
306 : 3 : values[3] = Int32GetDatum(pageheader->pd_lower);
307 : 3 : values[4] = Int32GetDatum(pageheader->pd_upper);
308 : 3 : values[5] = Int32GetDatum(pageheader->pd_special);
309 : 3 : values[6] = Int32GetDatum(PageGetPageSize(page));
310 : 3 : break;
311 : 0 : default:
312 [ # # ]: 0 : elog(ERROR, "incorrect output types");
313 : : break;
314 : : }
315 : :
316 : 4 : values[7] = UInt16GetDatum(PageGetPageLayoutVersion(page));
317 : 4 : values[8] = TransactionIdGetDatum(pageheader->pd_prune_xid);
318 : :
319 : : /* Build and return the tuple. */
320 : :
321 : 4 : memset(nulls, 0, sizeof(nulls));
322 : :
323 : 4 : tuple = heap_form_tuple(tupdesc, values, nulls);
324 : 4 : result = HeapTupleGetDatum(tuple);
325 : :
326 : 4 : PG_RETURN_DATUM(result);
327 : : }
328 : :
329 : : /*
330 : : * page_checksum
331 : : *
332 : : * Compute checksum of a raw page
333 : : */
334 : :
335 : 9 : PG_FUNCTION_INFO_V1(page_checksum_1_9);
336 : 8 : PG_FUNCTION_INFO_V1(page_checksum);
337 : :
338 : : static Datum
339 : 23 : page_checksum_internal(PG_FUNCTION_ARGS, enum pageinspect_version ext_version)
340 : : {
341 : 23 : bytea *raw_page = PG_GETARG_BYTEA_P(0);
342 [ + + ]: 23 : int64 blkno = (ext_version == PAGEINSPECT_V1_8 ? PG_GETARG_UINT32(1) : PG_GETARG_INT64(1));
343 : : Page page;
344 : :
345 [ - + ]: 23 : if (!superuser())
346 [ # # ]: 0 : ereport(ERROR,
347 : : (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
348 : : errmsg("must be superuser to use raw page functions")));
349 : :
350 [ + + - + ]: 23 : if (blkno < 0 || blkno > MaxBlockNumber)
351 [ + - ]: 1 : ereport(ERROR,
352 : : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
353 : : errmsg("invalid block number")));
354 : :
355 : 22 : page = get_page_from_raw(raw_page);
356 : :
357 [ + + ]: 21 : if (PageIsNew(page))
358 : 1 : PG_RETURN_NULL();
359 : :
360 : 20 : PG_RETURN_INT16(pg_checksum_page(page, blkno));
361 : : }
362 : :
363 : : Datum
364 : 22 : page_checksum_1_9(PG_FUNCTION_ARGS)
365 : : {
366 : 22 : return page_checksum_internal(fcinfo, PAGEINSPECT_V1_9);
367 : : }
368 : :
369 : : /*
370 : : * Entry point for old extension version
371 : : */
372 : : Datum
373 : 1 : page_checksum(PG_FUNCTION_ARGS)
374 : : {
375 : 1 : return page_checksum_internal(fcinfo, PAGEINSPECT_V1_8);
376 : : }
|
