PostgreSQL Source Code: contrib/pageinspect/gistfuncs.c Source File

PostgreSQL Source Code git master
gistfuncs.c
Go to the documentation of this file.
1/*
2 * gistfuncs.c
3 * Functions to investigate the content of GiST indexes
4 *
5 * Copyright (c) 2014-2025, PostgreSQL Global Development Group
6 *
7 * IDENTIFICATION
8 * contrib/pageinspect/gistfuncs.c
9 */
10#include "postgres.h"
11
12#include "access/gist.h"
13#include "access/htup.h"
14#include "access/htup_details.h"
15#include "access/relation.h"
16#include "catalog/pg_am_d.h"
17#include "funcapi.h"
18#include "miscadmin.h"
19#include "pageinspect.h"
20#include "storage/itemptr.h"
21#include "utils/array.h"
22#include "utils/builtins.h"
23#include "utils/lsyscache.h"
24#include "utils/pg_lsn.h"
25#include "utils/rel.h"
26#include "utils/ruleutils.h"
27
28 PG_FUNCTION_INFO_V1(gist_page_opaque_info);
29 PG_FUNCTION_INFO_V1(gist_page_items);
30 PG_FUNCTION_INFO_V1(gist_page_items_bytea);
31
32 #define IS_GIST(r) ((r)->rd_rel->relam == GIST_AM_OID)
33
34
35static Page verify_gist_page(bytea *raw_page);
36
37/*
38 * Verify that the given bytea contains a GIST page or die in the attempt.
39 * A pointer to the page is returned.
40 */
41static Page
42 verify_gist_page(bytea *raw_page)
43{
44 Page page = get_page_from_raw(raw_page);
45 GISTPageOpaque opaq;
46
47 if (PageIsNew(page))
48 return page;
49
50 /* verify the special space has the expected size */
51 if (PageGetSpecialSize(page) != MAXALIGN(sizeof(GISTPageOpaqueData)))
52 ereport(ERROR,
53 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
54 errmsg("input page is not a valid %s page", "GiST"),
55 errdetail("Expected special size %d, got %d.",
56 (int) MAXALIGN(sizeof(GISTPageOpaqueData)),
57 (int) PageGetSpecialSize(page))));
58
59 opaq = GistPageGetOpaque(page);
60 if (opaq->gist_page_id != GIST_PAGE_ID)
61 ereport(ERROR,
62 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
63 errmsg("input page is not a valid %s page", "GiST"),
64 errdetail("Expected %08x, got %08x.",
65 GIST_PAGE_ID,
66 opaq->gist_page_id)));
67
68 return page;
69}
70
71Datum
72 gist_page_opaque_info(PG_FUNCTION_ARGS)
73{
74 bytea *raw_page = PG_GETARG_BYTEA_P(0);
75 TupleDesc tupdesc;
76 Page page;
77 HeapTuple resultTuple;
78 Datum values[4];
79 bool nulls[4];
80 Datum flags[16];
81 int nflags = 0;
82 uint16 flagbits;
83
84 if (!superuser())
85 ereport(ERROR,
86 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
87 errmsg("must be superuser to use raw page functions")));
88
89 page = verify_gist_page(raw_page);
90
91 if (PageIsNew(page))
92 PG_RETURN_NULL();
93
94 /* Build a tuple descriptor for our result type */
95 if (get_call_result_type(fcinfo, NULL, &tupdesc) != TYPEFUNC_COMPOSITE)
96 elog(ERROR, "return type must be a row type");
97
98 /* Convert the flags bitmask to an array of human-readable names */
99 flagbits = GistPageGetOpaque(page)->flags;
100 if (flagbits & F_LEAF)
101 flags[nflags++] = CStringGetTextDatum("leaf");
102 if (flagbits & F_DELETED)
103 flags[nflags++] = CStringGetTextDatum("deleted");
104 if (flagbits & F_TUPLES_DELETED)
105 flags[nflags++] = CStringGetTextDatum("tuples_deleted");
106 if (flagbits & F_FOLLOW_RIGHT)
107 flags[nflags++] = CStringGetTextDatum("follow_right");
108 if (flagbits & F_HAS_GARBAGE)
109 flags[nflags++] = CStringGetTextDatum("has_garbage");
110 flagbits &= ~(F_LEAF | F_DELETED | F_TUPLES_DELETED | F_FOLLOW_RIGHT | F_HAS_GARBAGE);
111 if (flagbits)
112 {
113 /* any flags we don't recognize are printed in hex */
114 flags[nflags++] = DirectFunctionCall1(to_hex32, Int32GetDatum(flagbits));
115 }
116
117 memset(nulls, 0, sizeof(nulls));
118
119 values[0] = LSNGetDatum(PageGetLSN(page));
120 values[1] = LSNGetDatum(GistPageGetNSN(page));
121 values[2] = Int64GetDatum(GistPageGetOpaque(page)->rightlink);
122 values[3] = PointerGetDatum(construct_array_builtin(flags, nflags, TEXTOID));
123
124 /* Build and return the result tuple. */
125 resultTuple = heap_form_tuple(tupdesc, values, nulls);
126
127 return HeapTupleGetDatum(resultTuple);
128}
129
130Datum
131 gist_page_items_bytea(PG_FUNCTION_ARGS)
132{
133 bytea *raw_page = PG_GETARG_BYTEA_P(0);
134 ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo;
135 Page page;
136 OffsetNumber offset;
137 OffsetNumber maxoff = InvalidOffsetNumber;
138
139 if (!superuser())
140 ereport(ERROR,
141 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
142 errmsg("must be superuser to use raw page functions")));
143
144 InitMaterializedSRF(fcinfo, 0);
145
146 page = verify_gist_page(raw_page);
147
148 if (PageIsNew(page))
149 PG_RETURN_NULL();
150
151 /* Avoid bogus PageGetMaxOffsetNumber() call with deleted pages */
152 if (GistPageIsDeleted(page))
153 elog(NOTICE, "page is deleted");
154 else
155 maxoff = PageGetMaxOffsetNumber(page);
156
157 for (offset = FirstOffsetNumber;
158 offset <= maxoff;
159 offset++)
160 {
161 Datum values[5];
162 bool nulls[5];
163 ItemId id;
164 IndexTuple itup;
165 bytea *tuple_bytea;
166 int tuple_len;
167
168 id = PageGetItemId(page, offset);
169
170 if (!ItemIdIsValid(id))
171 elog(ERROR, "invalid ItemId");
172
173 itup = (IndexTuple) PageGetItem(page, id);
174 tuple_len = IndexTupleSize(itup);
175
176 memset(nulls, 0, sizeof(nulls));
177
178 values[0] = Int16GetDatum(offset);
179 values[1] = ItemPointerGetDatum(&itup->t_tid);
180 values[2] = Int32GetDatum((int) IndexTupleSize(itup));
181
182 tuple_bytea = (bytea *) palloc(tuple_len + VARHDRSZ);
183 SET_VARSIZE(tuple_bytea, tuple_len + VARHDRSZ);
184 memcpy(VARDATA(tuple_bytea), itup, tuple_len);
185 values[3] = BoolGetDatum(ItemIdIsDead(id));
186 values[4] = PointerGetDatum(tuple_bytea);
187
188 tuplestore_putvalues(rsinfo->setResult, rsinfo->setDesc, values, nulls);
189 }
190
191 return (Datum) 0;
192}
193
194Datum
195 gist_page_items(PG_FUNCTION_ARGS)
196{
197 bytea *raw_page = PG_GETARG_BYTEA_P(0);
198 Oid indexRelid = PG_GETARG_OID(1);
199 ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo;
200 Relation indexRel;
201 TupleDesc tupdesc;
202 Page page;
203 uint16 flagbits;
204 bits16 printflags = 0;
205 OffsetNumber offset;
206 OffsetNumber maxoff = InvalidOffsetNumber;
207 char *index_columns;
208
209 if (!superuser())
210 ereport(ERROR,
211 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
212 errmsg("must be superuser to use raw page functions")));
213
214 InitMaterializedSRF(fcinfo, 0);
215
216 /* Open the relation */
217 indexRel = index_open(indexRelid, AccessShareLock);
218
219 if (!IS_GIST(indexRel))
220 ereport(ERROR,
221 (errcode(ERRCODE_WRONG_OBJECT_TYPE),
222 errmsg("\"%s\" is not a %s index",
223 RelationGetRelationName(indexRel), "GiST")));
224
225 page = verify_gist_page(raw_page);
226
227 if (PageIsNew(page))
228 {
229 index_close(indexRel, AccessShareLock);
230 PG_RETURN_NULL();
231 }
232
233 flagbits = GistPageGetOpaque(page)->flags;
234
235 /*
236 * Included attributes are added when dealing with leaf pages, discarded
237 * for non-leaf pages as these include only data for key attributes.
238 */
239 printflags |= RULE_INDEXDEF_PRETTY;
240 if (flagbits & F_LEAF)
241 {
242 tupdesc = RelationGetDescr(indexRel);
243 }
244 else
245 {
246 tupdesc = CreateTupleDescTruncatedCopy(RelationGetDescr(indexRel),
247 IndexRelationGetNumberOfKeyAttributes(indexRel));
248 printflags |= RULE_INDEXDEF_KEYS_ONLY;
249 }
250
251 index_columns = pg_get_indexdef_columns_extended(indexRelid,
252 printflags);
253
254 /* Avoid bogus PageGetMaxOffsetNumber() call with deleted pages */
255 if (GistPageIsDeleted(page))
256 elog(NOTICE, "page is deleted");
257 else
258 maxoff = PageGetMaxOffsetNumber(page);
259
260 for (offset = FirstOffsetNumber;
261 offset <= maxoff;
262 offset++)
263 {
264 Datum values[5];
265 bool nulls[5];
266 ItemId id;
267 IndexTuple itup;
268 Datum itup_values[INDEX_MAX_KEYS];
269 bool itup_isnull[INDEX_MAX_KEYS];
270 StringInfoData buf;
271 int i;
272
273 id = PageGetItemId(page, offset);
274
275 if (!ItemIdIsValid(id))
276 elog(ERROR, "invalid ItemId");
277
278 itup = (IndexTuple) PageGetItem(page, id);
279
280 index_deform_tuple(itup, tupdesc,
281 itup_values, itup_isnull);
282
283 memset(nulls, 0, sizeof(nulls));
284
285 values[0] = Int16GetDatum(offset);
286 values[1] = ItemPointerGetDatum(&itup->t_tid);
287 values[2] = Int32GetDatum((int) IndexTupleSize(itup));
288 values[3] = BoolGetDatum(ItemIdIsDead(id));
289
290 if (index_columns)
291 {
292 initStringInfo(&buf);
293 appendStringInfo(&buf, "(%s)=(", index_columns);
294
295 /* Most of this is copied from record_out(). */
296 for (i = 0; i < tupdesc->natts; i++)
297 {
298 char *value;
299 char *tmp;
300 bool nq = false;
301
302 if (itup_isnull[i])
303 value = "null";
304 else
305 {
306 Oid foutoid;
307 bool typisvarlena;
308 Oid typoid;
309
310 typoid = TupleDescAttr(tupdesc, i)->atttypid;
311 getTypeOutputInfo(typoid, &foutoid, &typisvarlena);
312 value = OidOutputFunctionCall(foutoid, itup_values[i]);
313 }
314
315 if (i == IndexRelationGetNumberOfKeyAttributes(indexRel))
316 appendStringInfoString(&buf, ") INCLUDE (");
317 else if (i > 0)
318 appendStringInfoString(&buf, ", ");
319
320 /* Check whether we need double quotes for this value */
321 nq = (value[0] == '0円'); /* force quotes for empty string */
322 for (tmp = value; *tmp; tmp++)
323 {
324 char ch = *tmp;
325
326 if (ch == '"' || ch == '\\' ||
327 ch == '(' || ch == ')' || ch == ',' ||
328 isspace((unsigned char) ch))
329 {
330 nq = true;
331 break;
332 }
333 }
334
335 /* And emit the string */
336 if (nq)
337 appendStringInfoCharMacro(&buf, '"');
338 for (tmp = value; *tmp; tmp++)
339 {
340 char ch = *tmp;
341
342 if (ch == '"' || ch == '\\')
343 appendStringInfoCharMacro(&buf, ch);
344 appendStringInfoCharMacro(&buf, ch);
345 }
346 if (nq)
347 appendStringInfoCharMacro(&buf, '"');
348 }
349
350 appendStringInfoChar(&buf, ')');
351
352 values[4] = CStringGetTextDatum(buf.data);
353 nulls[4] = false;
354 }
355 else
356 {
357 values[4] = (Datum) 0;
358 nulls[4] = true;
359 }
360
361 tuplestore_putvalues(rsinfo->setResult, rsinfo->setDesc, values, nulls);
362 }
363
364 relation_close(indexRel, AccessShareLock);
365
366 return (Datum) 0;
367}
ArrayType * construct_array_builtin(Datum *elems, int nelems, Oid elmtype)
Definition: arrayfuncs.c:3382
static Datum values[MAXATTR]
Definition: bootstrap.c:153
static uint16 PageGetSpecialSize(const PageData *page)
Definition: bufpage.h:317
static Item PageGetItem(const PageData *page, const ItemIdData *itemId)
Definition: bufpage.h:354
static bool PageIsNew(const PageData *page)
Definition: bufpage.h:234
static ItemId PageGetItemId(Page page, OffsetNumber offsetNumber)
Definition: bufpage.h:244
PageData * Page
Definition: bufpage.h:82
static XLogRecPtr PageGetLSN(const PageData *page)
Definition: bufpage.h:386
static OffsetNumber PageGetMaxOffsetNumber(const PageData *page)
Definition: bufpage.h:372
#define CStringGetTextDatum(s)
Definition: builtins.h:97
uint16 bits16
Definition: c.h:546
#define MAXALIGN(LEN)
Definition: c.h:810
#define VARHDRSZ
Definition: c.h:697
uint16_t uint16
Definition: c.h:537
int errdetail(const char *fmt,...)
Definition: elog.c:1207
int errcode(int sqlerrcode)
Definition: elog.c:854
int errmsg(const char *fmt,...)
Definition: elog.c:1071
#define ERROR
Definition: elog.h:39
#define elog(elevel,...)
Definition: elog.h:226
#define NOTICE
Definition: elog.h:35
#define ereport(elevel,...)
Definition: elog.h:150
char * OidOutputFunctionCall(Oid functionId, Datum val)
Definition: fmgr.c:1763
#define PG_GETARG_OID(n)
Definition: fmgr.h:275
#define DirectFunctionCall1(func, arg1)
Definition: fmgr.h:682
#define PG_RETURN_NULL()
Definition: fmgr.h:345
#define PG_GETARG_BYTEA_P(n)
Definition: fmgr.h:335
#define PG_FUNCTION_ARGS
Definition: fmgr.h:193
void InitMaterializedSRF(FunctionCallInfo fcinfo, bits32 flags)
Definition: funcapi.c:76
TypeFuncClass get_call_result_type(FunctionCallInfo fcinfo, Oid *resultTypeId, TupleDesc *resultTupleDesc)
Definition: funcapi.c:276
@ TYPEFUNC_COMPOSITE
Definition: funcapi.h:149
static Datum HeapTupleGetDatum(const HeapTupleData *tuple)
Definition: funcapi.h:230
#define F_TUPLES_DELETED
Definition: gist.h:51
#define GIST_PAGE_ID
Definition: gist.h:112
#define F_LEAF
Definition: gist.h:49
#define F_FOLLOW_RIGHT
Definition: gist.h:52
#define GistPageIsDeleted(page)
Definition: gist.h:173
#define GistPageGetOpaque(page)
Definition: gist.h:168
#define F_HAS_GARBAGE
Definition: gist.h:53
#define F_DELETED
Definition: gist.h:50
#define GistPageGetNSN(page)
Definition: gist.h:187
PG_FUNCTION_INFO_V1(gist_page_opaque_info)
Datum gist_page_items_bytea(PG_FUNCTION_ARGS)
Definition: gistfuncs.c:131
static Page verify_gist_page(bytea *raw_page)
Definition: gistfuncs.c:42
#define IS_GIST(r)
Definition: gistfuncs.c:32
Datum gist_page_items(PG_FUNCTION_ARGS)
Definition: gistfuncs.c:195
Datum gist_page_opaque_info(PG_FUNCTION_ARGS)
Definition: gistfuncs.c:72
HeapTuple heap_form_tuple(TupleDesc tupleDescriptor, const Datum *values, const bool *isnull)
Definition: heaptuple.c:1117
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:177
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:133
void index_deform_tuple(IndexTuple tup, TupleDesc tupleDescriptor, Datum *values, bool *isnull)
Definition: indextuple.c:456
static struct @169 value
i
int i
Definition: isn.c:77
if(TABLE==NULL||TABLE_index==NULL)
Definition: isn.c:81
#define ItemIdIsDead(itemId)
Definition: itemid.h:113
#define ItemIdIsValid(itemId)
Definition: itemid.h:86
static Datum ItemPointerGetDatum(const ItemPointerData *X)
Definition: itemptr.h:237
IndexTupleData * IndexTuple
Definition: itup.h:53
static Size IndexTupleSize(const IndexTupleData *itup)
Definition: itup.h:71
#define AccessShareLock
Definition: lockdefs.h:36
void getTypeOutputInfo(Oid type, Oid *typOutput, bool *typIsVarlena)
Definition: lsyscache.c:3074
void * palloc(Size size)
Definition: mcxt.c:1365
#define InvalidOffsetNumber
Definition: off.h:26
uint16 OffsetNumber
Definition: off.h:24
#define FirstOffsetNumber
Definition: off.h:27
Page get_page_from_raw(bytea *raw_page)
Definition: rawpage.c:218
#define INDEX_MAX_KEYS
static Datum LSNGetDatum(XLogRecPtr X)
Definition: pg_lsn.h:31
static char * buf
Definition: pg_test_fsync.c:72
static Datum Int64GetDatum(int64 X)
Definition: postgres.h:403
static Datum PointerGetDatum(const void *X)
Definition: postgres.h:332
static Datum Int16GetDatum(int16 X)
Definition: postgres.h:182
static Datum BoolGetDatum(bool X)
Definition: postgres.h:112
uint64_t Datum
Definition: postgres.h:70
static Datum Int32GetDatum(int32 X)
Definition: postgres.h:222
unsigned int Oid
Definition: postgres_ext.h:32
#define RelationGetDescr(relation)
Definition: rel.h:540
#define RelationGetRelationName(relation)
Definition: rel.h:548
#define IndexRelationGetNumberOfKeyAttributes(relation)
Definition: rel.h:533
char * pg_get_indexdef_columns_extended(Oid indexrelid, bits16 flags)
Definition: ruleutils.c:1249
#define RULE_INDEXDEF_PRETTY
Definition: ruleutils.h:24
#define RULE_INDEXDEF_KEYS_ONLY
Definition: ruleutils.h:25
void relation_close(Relation relation, LOCKMODE lockmode)
Definition: relation.c:205
void appendStringInfo(StringInfo str, const char *fmt,...)
Definition: stringinfo.c:145
void appendStringInfoString(StringInfo str, const char *s)
Definition: stringinfo.c:230
void appendStringInfoChar(StringInfo str, char ch)
Definition: stringinfo.c:242
void initStringInfo(StringInfo str)
Definition: stringinfo.c:97
#define appendStringInfoCharMacro(str, ch)
Definition: stringinfo.h:231
uint16 gist_page_id
Definition: gist.h:83
ItemPointerData t_tid
Definition: itup.h:37
Definition: itemid.h:26
Definition: rel.h:56
TupleDesc setDesc
Definition: execnodes.h:364
Tuplestorestate * setResult
Definition: execnodes.h:363
Definition: c.h:692
bool superuser(void)
Definition: superuser.c:46
TupleDesc CreateTupleDescTruncatedCopy(TupleDesc tupdesc, int natts)
Definition: tupdesc.c:296
static FormData_pg_attribute * TupleDescAttr(TupleDesc tupdesc, int i)
Definition: tupdesc.h:160
void tuplestore_putvalues(Tuplestorestate *state, TupleDesc tdesc, const Datum *values, const bool *isnull)
Definition: tuplestore.c:784
static char * VARDATA(const void *PTR)
Definition: varatt.h:305
static void SET_VARSIZE(void *PTR, Size len)
Definition: varatt.h:432
Datum to_hex32(PG_FUNCTION_ARGS)
Definition: varlena.c:4090

AltStyle によって変換されたページ (->オリジナル) /