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