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 0 : 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 0 : PG_FUNCTION_INFO_V1(get_raw_page_1_9);
47 :
48 : Datum
49 0 : get_raw_page_1_9(PG_FUNCTION_ARGS)
50 : {
51 0 : text *relname = PG_GETARG_TEXT_PP(0);
52 0 : int64 blkno = PG_GETARG_INT64(1);
53 0 : bytea *raw_page;
54 :
55 0 : if (blkno < 0 || blkno > MaxBlockNumber)
56 0 : ereport(ERROR,
57 : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
58 : errmsg("invalid block number")));
59 :
60 0 : raw_page = get_raw_page_internal(relname, MAIN_FORKNUM, blkno);
61 :
62 0 : PG_RETURN_BYTEA_P(raw_page);
63 0 : }
64 :
65 : /*
66 : * entry point for old extension version
67 : */
68 0 : PG_FUNCTION_INFO_V1(get_raw_page);
69 :
70 : Datum
71 0 : get_raw_page(PG_FUNCTION_ARGS)
72 : {
73 0 : text *relname = PG_GETARG_TEXT_PP(0);
74 0 : uint32 blkno = PG_GETARG_UINT32(1);
75 0 : 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 0 : 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 0 : raw_page = get_raw_page_internal(relname, MAIN_FORKNUM, blkno);
88 :
89 0 : PG_RETURN_BYTEA_P(raw_page);
90 0 : }
91 :
92 : /*
93 : * get_raw_page_fork
94 : *
95 : * Same, for any fork
96 : */
97 0 : PG_FUNCTION_INFO_V1(get_raw_page_fork_1_9);
98 :
99 : Datum
100 0 : get_raw_page_fork_1_9(PG_FUNCTION_ARGS)
101 : {
102 0 : text *relname = PG_GETARG_TEXT_PP(0);
103 0 : text *forkname = PG_GETARG_TEXT_PP(1);
104 0 : int64 blkno = PG_GETARG_INT64(2);
105 0 : bytea *raw_page;
106 0 : ForkNumber forknum;
107 :
108 0 : forknum = forkname_to_number(text_to_cstring(forkname));
109 :
110 0 : if (blkno < 0 || blkno > MaxBlockNumber)
111 0 : ereport(ERROR,
112 : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
113 : errmsg("invalid block number")));
114 :
115 0 : raw_page = get_raw_page_internal(relname, forknum, blkno);
116 :
117 0 : PG_RETURN_BYTEA_P(raw_page);
118 0 : }
119 :
120 : /*
121 : * Entry point for old extension version
122 : */
123 0 : PG_FUNCTION_INFO_V1(get_raw_page_fork);
124 :
125 : Datum
126 0 : get_raw_page_fork(PG_FUNCTION_ARGS)
127 : {
128 0 : text *relname = PG_GETARG_TEXT_PP(0);
129 0 : text *forkname = PG_GETARG_TEXT_PP(1);
130 0 : uint32 blkno = PG_GETARG_UINT32(2);
131 0 : bytea *raw_page;
132 0 : ForkNumber forknum;
133 :
134 0 : forknum = forkname_to_number(text_to_cstring(forkname));
135 :
136 0 : raw_page = get_raw_page_internal(relname, forknum, blkno);
137 :
138 0 : PG_RETURN_BYTEA_P(raw_page);
139 0 : }
140 :
141 : /*
142 : * workhorse
143 : */
144 : static bytea *
145 0 : get_raw_page_internal(text *relname, ForkNumber forknum, BlockNumber blkno)
146 : {
147 0 : bytea *raw_page;
148 0 : RangeVar *relrv;
149 0 : Relation rel;
150 0 : char *raw_page_data;
151 0 : Buffer buf;
152 :
153 0 : if (!superuser())
154 0 : ereport(ERROR,
155 : (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
156 : errmsg("must be superuser to use raw page functions")));
157 :
158 0 : relrv = makeRangeVarFromNameList(textToQualifiedNameList(relname));
159 0 : rel = relation_openrv(relrv, AccessShareLock);
160 :
161 0 : if (!RELKIND_HAS_STORAGE(rel->rd_rel->relkind))
162 0 : 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 0 : 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 0 : if (blkno >= RelationGetNumberOfBlocksInFork(rel, forknum))
179 0 : 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 0 : raw_page = (bytea *) palloc(BLCKSZ + VARHDRSZ);
186 0 : SET_VARSIZE(raw_page, BLCKSZ + VARHDRSZ);
187 0 : raw_page_data = VARDATA(raw_page);
188 :
189 : /* Take a verbatim copy of the page */
190 :
191 0 : buf = ReadBufferExtended(rel, forknum, blkno, RBM_NORMAL, NULL);
192 0 : LockBuffer(buf, BUFFER_LOCK_SHARE);
193 :
194 0 : memcpy(raw_page_data, BufferGetPage(buf), BLCKSZ);
195 :
196 0 : LockBuffer(buf, BUFFER_LOCK_UNLOCK);
197 0 : ReleaseBuffer(buf);
198 :
199 0 : relation_close(rel, AccessShareLock);
200 :
201 0 : return raw_page;
202 0 : }
203 :
204 :
205 : /*
206 : * get_page_from_raw
207 : *
208 : * Get a palloc'd, maxalign'ed page image from the result of get_raw_page()
209 : *
210 : * On machines with MAXALIGN = 8, the payload of a bytea is not maxaligned,
211 : * since it will start 4 bytes into a palloc'd value. On alignment-picky
212 : * machines, this will cause failures in accesses to 8-byte-wide values
213 : * within the page. We don't need to worry if accessing only 4-byte or
214 : * smaller fields, but when examining a struct that contains 8-byte fields,
215 : * use this function for safety.
216 : */
217 : Page
218 0 : get_page_from_raw(bytea *raw_page)
219 : {
220 0 : Page page;
221 0 : int raw_page_size;
222 :
223 0 : raw_page_size = VARSIZE_ANY_EXHDR(raw_page);
224 :
225 0 : if (raw_page_size != BLCKSZ)
226 0 : ereport(ERROR,
227 : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
228 : errmsg("invalid page size"),
229 : errdetail("Expected %d bytes, got %d.",
230 : BLCKSZ, raw_page_size)));
231 :
232 0 : page = palloc(raw_page_size);
233 :
234 0 : memcpy(page, VARDATA_ANY(raw_page), raw_page_size);
235 :
236 0 : return page;
237 0 : }
238 :
239 :
240 : /*
241 : * page_header
242 : *
243 : * Allows inspection of page header fields of a raw page
244 : */
245 :
246 0 : PG_FUNCTION_INFO_V1(page_header);
247 :
248 : Datum
249 0 : page_header(PG_FUNCTION_ARGS)
250 : {
251 0 : bytea *raw_page = PG_GETARG_BYTEA_P(0);
252 :
253 0 : TupleDesc tupdesc;
254 :
255 0 : Datum result;
256 0 : HeapTuple tuple;
257 0 : Datum values[9];
258 0 : bool nulls[9];
259 :
260 0 : Page page;
261 0 : PageHeader pageheader;
262 0 : XLogRecPtr lsn;
263 :
264 0 : if (!superuser())
265 0 : ereport(ERROR,
266 : (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
267 : errmsg("must be superuser to use raw page functions")));
268 :
269 0 : page = get_page_from_raw(raw_page);
270 0 : pageheader = (PageHeader) page;
271 :
272 : /* Build a tuple descriptor for our result type */
273 0 : if (get_call_result_type(fcinfo, NULL, &tupdesc) != TYPEFUNC_COMPOSITE)
274 0 : elog(ERROR, "return type must be a row type");
275 :
276 : /* Extract information from the page header */
277 :
278 0 : lsn = PageGetLSN(page);
279 :
280 : /* pageinspect >= 1.2 uses pg_lsn instead of text for the LSN field. */
281 0 : if (TupleDescAttr(tupdesc, 0)->atttypid == TEXTOID)
282 : {
283 0 : char lsnchar[64];
284 :
285 0 : snprintf(lsnchar, sizeof(lsnchar), "%X/%08X", LSN_FORMAT_ARGS(lsn));
286 0 : values[0] = CStringGetTextDatum(lsnchar);
287 0 : }
288 : else
289 0 : values[0] = LSNGetDatum(lsn);
290 0 : values[1] = UInt16GetDatum(pageheader->pd_checksum);
291 0 : values[2] = UInt16GetDatum(pageheader->pd_flags);
292 :
293 : /* pageinspect >= 1.10 uses int4 instead of int2 for those fields */
294 0 : switch (TupleDescAttr(tupdesc, 3)->atttypid)
295 : {
296 : case INT2OID:
297 0 : Assert(TupleDescAttr(tupdesc, 4)->atttypid == INT2OID &&
298 : TupleDescAttr(tupdesc, 5)->atttypid == INT2OID &&
299 : TupleDescAttr(tupdesc, 6)->atttypid == INT2OID);
300 0 : values[3] = UInt16GetDatum(pageheader->pd_lower);
301 0 : values[4] = UInt16GetDatum(pageheader->pd_upper);
302 0 : values[5] = UInt16GetDatum(pageheader->pd_special);
303 0 : values[6] = UInt16GetDatum(PageGetPageSize(page));
304 0 : break;
305 : case INT4OID:
306 0 : Assert(TupleDescAttr(tupdesc, 4)->atttypid == INT4OID &&
307 : TupleDescAttr(tupdesc, 5)->atttypid == INT4OID &&
308 : TupleDescAttr(tupdesc, 6)->atttypid == INT4OID);
309 0 : values[3] = Int32GetDatum(pageheader->pd_lower);
310 0 : values[4] = Int32GetDatum(pageheader->pd_upper);
311 0 : values[5] = Int32GetDatum(pageheader->pd_special);
312 0 : values[6] = Int32GetDatum(PageGetPageSize(page));
313 0 : break;
314 : default:
315 0 : elog(ERROR, "incorrect output types");
316 0 : break;
317 : }
318 :
319 0 : values[7] = UInt16GetDatum(PageGetPageLayoutVersion(page));
320 0 : values[8] = TransactionIdGetDatum(pageheader->pd_prune_xid);
321 :
322 : /* Build and return the tuple. */
323 :
324 0 : memset(nulls, 0, sizeof(nulls));
325 :
326 0 : tuple = heap_form_tuple(tupdesc, values, nulls);
327 0 : result = HeapTupleGetDatum(tuple);
328 :
329 0 : PG_RETURN_DATUM(result);
330 0 : }
331 :
332 : /*
333 : * page_checksum
334 : *
335 : * Compute checksum of a raw page
336 : */
337 :
338 0 : PG_FUNCTION_INFO_V1(page_checksum_1_9);
339 0 : PG_FUNCTION_INFO_V1(page_checksum);
340 :
341 : static Datum
342 0 : page_checksum_internal(PG_FUNCTION_ARGS, enum pageinspect_version ext_version)
343 : {
344 0 : bytea *raw_page = PG_GETARG_BYTEA_P(0);
345 0 : int64 blkno = (ext_version == PAGEINSPECT_V1_8 ? PG_GETARG_UINT32(1) : PG_GETARG_INT64(1));
346 0 : Page page;
347 :
348 0 : if (!superuser())
349 0 : ereport(ERROR,
350 : (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
351 : errmsg("must be superuser to use raw page functions")));
352 :
353 0 : if (blkno < 0 || blkno > MaxBlockNumber)
354 0 : ereport(ERROR,
355 : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
356 : errmsg("invalid block number")));
357 :
358 0 : page = get_page_from_raw(raw_page);
359 :
360 0 : if (PageIsNew(page))
361 0 : PG_RETURN_NULL();
362 :
363 0 : PG_RETURN_INT16(pg_checksum_page(page, blkno));
364 0 : }
365 :
366 : Datum
367 0 : page_checksum_1_9(PG_FUNCTION_ARGS)
368 : {
369 0 : return page_checksum_internal(fcinfo, PAGEINSPECT_V1_9);
370 : }
371 :
372 : /*
373 : * Entry point for old extension version
374 : */
375 : Datum
376 0 : page_checksum(PG_FUNCTION_ARGS)
377 : {
378 0 : return page_checksum_internal(fcinfo, PAGEINSPECT_V1_8);
379 : }
|
