Line data Source code
1 : /*
2 : * contrib/pgstattuple/pgstatindex.c
3 : *
4 : *
5 : * pgstatindex
6 : *
7 : * Copyright (c) 2006 Satoshi Nagayasu <nagayasus@nttdata.co.jp>
8 : *
9 : * Permission to use, copy, modify, and distribute this software and
10 : * its documentation for any purpose, without fee, and without a
11 : * written agreement is hereby granted, provided that the above
12 : * copyright notice and this paragraph and the following two
13 : * paragraphs appear in all copies.
14 : *
15 : * IN NO EVENT SHALL THE AUTHOR BE LIABLE TO ANY PARTY FOR DIRECT,
16 : * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING
17 : * LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS
18 : * DOCUMENTATION, EVEN IF THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED
19 : * OF THE POSSIBILITY OF SUCH DAMAGE.
20 : *
21 : * THE AUTHOR SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT
22 : * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 : * A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS
24 : * IS" BASIS, AND THE AUTHOR HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE,
25 : * SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
26 : */
27 :
28 : #include "postgres.h"
29 :
30 : #include "access/gin_private.h"
31 : #include "access/hash.h"
32 : #include "access/htup_details.h"
33 : #include "access/nbtree.h"
34 : #include "access/relation.h"
35 : #include "catalog/namespace.h"
36 : #include "catalog/pg_am.h"
37 : #include "funcapi.h"
38 : #include "miscadmin.h"
39 : #include "storage/bufmgr.h"
40 : #include "utils/rel.h"
41 : #include "utils/varlena.h"
42 :
43 :
44 : /*
45 : * Because of backward-compatibility issue, we have decided to have
46 : * two types of interfaces, with regclass-type input arg and text-type
47 : * input arg, for each function.
48 : *
49 : * Those functions which have text-type input arg will be deprecated
50 : * in the future release.
51 : */
52 0 : PG_FUNCTION_INFO_V1(pgstatindex);
53 0 : PG_FUNCTION_INFO_V1(pgstatindexbyid);
54 0 : PG_FUNCTION_INFO_V1(pg_relpages);
55 0 : PG_FUNCTION_INFO_V1(pg_relpagesbyid);
56 0 : PG_FUNCTION_INFO_V1(pgstatginindex);
57 0 : PG_FUNCTION_INFO_V1(pgstathashindex);
58 :
59 0 : PG_FUNCTION_INFO_V1(pgstatindex_v1_5);
60 0 : PG_FUNCTION_INFO_V1(pgstatindexbyid_v1_5);
61 0 : PG_FUNCTION_INFO_V1(pg_relpages_v1_5);
62 0 : PG_FUNCTION_INFO_V1(pg_relpagesbyid_v1_5);
63 0 : PG_FUNCTION_INFO_V1(pgstatginindex_v1_5);
64 :
65 : Datum pgstatginindex_internal(Oid relid, FunctionCallInfo fcinfo);
66 :
67 : #define IS_INDEX(r) ((r)->rd_rel->relkind == RELKIND_INDEX)
68 : #define IS_BTREE(r) ((r)->rd_rel->relam == BTREE_AM_OID)
69 : #define IS_GIN(r) ((r)->rd_rel->relam == GIN_AM_OID)
70 : #define IS_HASH(r) ((r)->rd_rel->relam == HASH_AM_OID)
71 :
72 : /* ------------------------------------------------
73 : * A structure for a whole btree index statistics
74 : * used by pgstatindex().
75 : * ------------------------------------------------
76 : */
77 : typedef struct BTIndexStat
78 : {
79 : uint32 version;
80 : uint32 level;
81 : BlockNumber root_blkno;
82 :
83 : uint64 internal_pages;
84 : uint64 leaf_pages;
85 : uint64 empty_pages;
86 : uint64 deleted_pages;
87 :
88 : uint64 max_avail;
89 : uint64 free_space;
90 :
91 : uint64 fragments;
92 : } BTIndexStat;
93 :
94 : /* ------------------------------------------------
95 : * A structure for a whole GIN index statistics
96 : * used by pgstatginindex().
97 : * ------------------------------------------------
98 : */
99 : typedef struct GinIndexStat
100 : {
101 : int32 version;
102 :
103 : BlockNumber pending_pages;
104 : int64 pending_tuples;
105 : } GinIndexStat;
106 :
107 : /* ------------------------------------------------
108 : * A structure for a whole HASH index statistics
109 : * used by pgstathashindex().
110 : * ------------------------------------------------
111 : */
112 : typedef struct HashIndexStat
113 : {
114 : int32 version;
115 : int32 space_per_page;
116 :
117 : BlockNumber bucket_pages;
118 : BlockNumber overflow_pages;
119 : BlockNumber bitmap_pages;
120 : BlockNumber unused_pages;
121 :
122 : int64 live_items;
123 : int64 dead_items;
124 : uint64 free_space;
125 : } HashIndexStat;
126 :
127 : static Datum pgstatindex_impl(Relation rel, FunctionCallInfo fcinfo);
128 : static int64 pg_relpages_impl(Relation rel);
129 : static void GetHashPageStats(Page page, HashIndexStat *stats);
130 :
131 : /* ------------------------------------------------------
132 : * pgstatindex()
133 : *
134 : * Usage: SELECT * FROM pgstatindex('t1_pkey');
135 : *
136 : * The superuser() check here must be kept as the library might be upgraded
137 : * without the extension being upgraded, meaning that in pre-1.5 installations
138 : * these functions could be called by any user.
139 : * ------------------------------------------------------
140 : */
141 : Datum
142 0 : pgstatindex(PG_FUNCTION_ARGS)
143 : {
144 0 : text *relname = PG_GETARG_TEXT_PP(0);
145 0 : Relation rel;
146 0 : RangeVar *relrv;
147 :
148 0 : if (!superuser())
149 0 : ereport(ERROR,
150 : (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
151 : errmsg("must be superuser to use pgstattuple functions")));
152 :
153 0 : relrv = makeRangeVarFromNameList(textToQualifiedNameList(relname));
154 0 : rel = relation_openrv(relrv, AccessShareLock);
155 :
156 0 : PG_RETURN_DATUM(pgstatindex_impl(rel, fcinfo));
157 0 : }
158 :
159 : /*
160 : * As of pgstattuple version 1.5, we no longer need to check if the user
161 : * is a superuser because we REVOKE EXECUTE on the function from PUBLIC.
162 : * Users can then grant access to it based on their policies.
163 : *
164 : * Otherwise identical to pgstatindex (above).
165 : */
166 : Datum
167 0 : pgstatindex_v1_5(PG_FUNCTION_ARGS)
168 : {
169 0 : text *relname = PG_GETARG_TEXT_PP(0);
170 0 : Relation rel;
171 0 : RangeVar *relrv;
172 :
173 0 : relrv = makeRangeVarFromNameList(textToQualifiedNameList(relname));
174 0 : rel = relation_openrv(relrv, AccessShareLock);
175 :
176 0 : PG_RETURN_DATUM(pgstatindex_impl(rel, fcinfo));
177 0 : }
178 :
179 : /*
180 : * The superuser() check here must be kept as the library might be upgraded
181 : * without the extension being upgraded, meaning that in pre-1.5 installations
182 : * these functions could be called by any user.
183 : */
184 : Datum
185 0 : pgstatindexbyid(PG_FUNCTION_ARGS)
186 : {
187 0 : Oid relid = PG_GETARG_OID(0);
188 0 : Relation rel;
189 :
190 0 : if (!superuser())
191 0 : ereport(ERROR,
192 : (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
193 : errmsg("must be superuser to use pgstattuple functions")));
194 :
195 0 : rel = relation_open(relid, AccessShareLock);
196 :
197 0 : PG_RETURN_DATUM(pgstatindex_impl(rel, fcinfo));
198 0 : }
199 :
200 : /* No need for superuser checks in v1.5, see above */
201 : Datum
202 0 : pgstatindexbyid_v1_5(PG_FUNCTION_ARGS)
203 : {
204 0 : Oid relid = PG_GETARG_OID(0);
205 0 : Relation rel;
206 :
207 0 : rel = relation_open(relid, AccessShareLock);
208 :
209 0 : PG_RETURN_DATUM(pgstatindex_impl(rel, fcinfo));
210 0 : }
211 :
212 : static Datum
213 0 : pgstatindex_impl(Relation rel, FunctionCallInfo fcinfo)
214 : {
215 0 : Datum result;
216 0 : BlockNumber nblocks;
217 0 : BlockNumber blkno;
218 0 : BTIndexStat indexStat;
219 0 : BufferAccessStrategy bstrategy = GetAccessStrategy(BAS_BULKREAD);
220 :
221 0 : if (!IS_INDEX(rel) || !IS_BTREE(rel))
222 0 : ereport(ERROR,
223 : (errcode(ERRCODE_WRONG_OBJECT_TYPE),
224 : errmsg("relation \"%s\" is not a btree index",
225 : RelationGetRelationName(rel))));
226 :
227 : /*
228 : * Reject attempts to read non-local temporary relations; we would be
229 : * likely to get wrong data since we have no visibility into the owning
230 : * session's local buffers.
231 : */
232 0 : if (RELATION_IS_OTHER_TEMP(rel))
233 0 : ereport(ERROR,
234 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
235 : errmsg("cannot access temporary tables of other sessions")));
236 :
237 : /*
238 : * A !indisready index could lead to ERRCODE_DATA_CORRUPTED later, so exit
239 : * early. We're capable of assessing an indisready&&!indisvalid index,
240 : * but the results could be confusing. For example, the index's size
241 : * could be too low for a valid index of the table.
242 : */
243 0 : if (!rel->rd_index->indisvalid)
244 0 : ereport(ERROR,
245 : (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
246 : errmsg("index \"%s\" is not valid",
247 : RelationGetRelationName(rel))));
248 :
249 : /*
250 : * Read metapage
251 : */
252 : {
253 0 : Buffer buffer = ReadBufferExtended(rel, MAIN_FORKNUM, 0, RBM_NORMAL, bstrategy);
254 0 : Page page = BufferGetPage(buffer);
255 0 : BTMetaPageData *metad = BTPageGetMeta(page);
256 :
257 0 : indexStat.version = metad->btm_version;
258 0 : indexStat.level = metad->btm_level;
259 0 : indexStat.root_blkno = metad->btm_root;
260 :
261 0 : ReleaseBuffer(buffer);
262 0 : }
263 :
264 : /* -- init counters -- */
265 0 : indexStat.internal_pages = 0;
266 0 : indexStat.leaf_pages = 0;
267 0 : indexStat.empty_pages = 0;
268 0 : indexStat.deleted_pages = 0;
269 :
270 0 : indexStat.max_avail = 0;
271 0 : indexStat.free_space = 0;
272 :
273 0 : indexStat.fragments = 0;
274 :
275 : /*
276 : * Scan all blocks except the metapage
277 : */
278 0 : nblocks = RelationGetNumberOfBlocks(rel);
279 :
280 0 : for (blkno = 1; blkno < nblocks; blkno++)
281 : {
282 0 : Buffer buffer;
283 0 : Page page;
284 0 : BTPageOpaque opaque;
285 :
286 0 : CHECK_FOR_INTERRUPTS();
287 :
288 : /* Read and lock buffer */
289 0 : buffer = ReadBufferExtended(rel, MAIN_FORKNUM, blkno, RBM_NORMAL, bstrategy);
290 0 : LockBuffer(buffer, BUFFER_LOCK_SHARE);
291 :
292 0 : page = BufferGetPage(buffer);
293 0 : opaque = BTPageGetOpaque(page);
294 :
295 : /*
296 : * Determine page type, and update totals.
297 : *
298 : * Note that we arbitrarily bucket deleted pages together without
299 : * considering if they're leaf pages or internal pages.
300 : */
301 0 : if (P_ISDELETED(opaque))
302 0 : indexStat.deleted_pages++;
303 0 : else if (P_IGNORE(opaque))
304 0 : indexStat.empty_pages++; /* this is the "half dead" state */
305 0 : else if (P_ISLEAF(opaque))
306 : {
307 0 : int max_avail;
308 :
309 0 : max_avail = BLCKSZ - (BLCKSZ - ((PageHeader) page)->pd_special + SizeOfPageHeaderData);
310 0 : indexStat.max_avail += max_avail;
311 0 : indexStat.free_space += PageGetExactFreeSpace(page);
312 :
313 0 : indexStat.leaf_pages++;
314 :
315 : /*
316 : * If the next leaf is on an earlier block, it means a
317 : * fragmentation.
318 : */
319 0 : if (opaque->btpo_next != P_NONE && opaque->btpo_next < blkno)
320 0 : indexStat.fragments++;
321 0 : }
322 : else
323 0 : indexStat.internal_pages++;
324 :
325 : /* Unlock and release buffer */
326 0 : LockBuffer(buffer, BUFFER_LOCK_UNLOCK);
327 0 : ReleaseBuffer(buffer);
328 0 : }
329 :
330 0 : relation_close(rel, AccessShareLock);
331 :
332 : /*----------------------------
333 : * Build a result tuple
334 : *----------------------------
335 : */
336 : {
337 0 : TupleDesc tupleDesc;
338 0 : int j;
339 0 : char *values[10];
340 0 : HeapTuple tuple;
341 :
342 : /* Build a tuple descriptor for our result type */
343 0 : if (get_call_result_type(fcinfo, NULL, &tupleDesc) != TYPEFUNC_COMPOSITE)
344 0 : elog(ERROR, "return type must be a row type");
345 :
346 0 : j = 0;
347 0 : values[j++] = psprintf("%d", indexStat.version);
348 0 : values[j++] = psprintf("%d", indexStat.level);
349 0 : values[j++] = psprintf(INT64_FORMAT,
350 0 : (1 + /* include the metapage in index_size */
351 0 : indexStat.leaf_pages +
352 0 : indexStat.internal_pages +
353 0 : indexStat.deleted_pages +
354 0 : indexStat.empty_pages) * BLCKSZ);
355 0 : values[j++] = psprintf("%u", indexStat.root_blkno);
356 0 : values[j++] = psprintf(INT64_FORMAT, indexStat.internal_pages);
357 0 : values[j++] = psprintf(INT64_FORMAT, indexStat.leaf_pages);
358 0 : values[j++] = psprintf(INT64_FORMAT, indexStat.empty_pages);
359 0 : values[j++] = psprintf(INT64_FORMAT, indexStat.deleted_pages);
360 0 : if (indexStat.max_avail > 0)
361 0 : values[j++] = psprintf("%.2f",
362 0 : 100.0 - (double) indexStat.free_space / (double) indexStat.max_avail * 100.0);
363 : else
364 0 : values[j++] = pstrdup("NaN");
365 0 : if (indexStat.leaf_pages > 0)
366 0 : values[j++] = psprintf("%.2f",
367 0 : (double) indexStat.fragments / (double) indexStat.leaf_pages * 100.0);
368 : else
369 0 : values[j++] = pstrdup("NaN");
370 :
371 0 : tuple = BuildTupleFromCStrings(TupleDescGetAttInMetadata(tupleDesc),
372 0 : values);
373 :
374 0 : result = HeapTupleGetDatum(tuple);
375 0 : }
376 :
377 0 : return result;
378 0 : }
379 :
380 : /* --------------------------------------------------------
381 : * pg_relpages()
382 : *
383 : * Get the number of pages of the table/index.
384 : *
385 : * Usage: SELECT pg_relpages('t1');
386 : * SELECT pg_relpages('t1_pkey');
387 : *
388 : * Must keep superuser() check, see above.
389 : * --------------------------------------------------------
390 : */
391 : Datum
392 0 : pg_relpages(PG_FUNCTION_ARGS)
393 : {
394 0 : text *relname = PG_GETARG_TEXT_PP(0);
395 0 : Relation rel;
396 0 : RangeVar *relrv;
397 :
398 0 : if (!superuser())
399 0 : ereport(ERROR,
400 : (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
401 : errmsg("must be superuser to use pgstattuple functions")));
402 :
403 0 : relrv = makeRangeVarFromNameList(textToQualifiedNameList(relname));
404 0 : rel = relation_openrv(relrv, AccessShareLock);
405 :
406 0 : PG_RETURN_INT64(pg_relpages_impl(rel));
407 0 : }
408 :
409 : /* No need for superuser checks in v1.5, see above */
410 : Datum
411 0 : pg_relpages_v1_5(PG_FUNCTION_ARGS)
412 : {
413 0 : text *relname = PG_GETARG_TEXT_PP(0);
414 0 : Relation rel;
415 0 : RangeVar *relrv;
416 :
417 0 : relrv = makeRangeVarFromNameList(textToQualifiedNameList(relname));
418 0 : rel = relation_openrv(relrv, AccessShareLock);
419 :
420 0 : PG_RETURN_INT64(pg_relpages_impl(rel));
421 0 : }
422 :
423 : /* Must keep superuser() check, see above. */
424 : Datum
425 0 : pg_relpagesbyid(PG_FUNCTION_ARGS)
426 : {
427 0 : Oid relid = PG_GETARG_OID(0);
428 0 : Relation rel;
429 :
430 0 : if (!superuser())
431 0 : ereport(ERROR,
432 : (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
433 : errmsg("must be superuser to use pgstattuple functions")));
434 :
435 0 : rel = relation_open(relid, AccessShareLock);
436 :
437 0 : PG_RETURN_INT64(pg_relpages_impl(rel));
438 0 : }
439 :
440 : /* No need for superuser checks in v1.5, see above */
441 : Datum
442 0 : pg_relpagesbyid_v1_5(PG_FUNCTION_ARGS)
443 : {
444 0 : Oid relid = PG_GETARG_OID(0);
445 0 : Relation rel;
446 :
447 0 : rel = relation_open(relid, AccessShareLock);
448 :
449 0 : PG_RETURN_INT64(pg_relpages_impl(rel));
450 0 : }
451 :
452 : static int64
453 0 : pg_relpages_impl(Relation rel)
454 : {
455 0 : int64 relpages;
456 :
457 0 : if (!RELKIND_HAS_STORAGE(rel->rd_rel->relkind))
458 0 : ereport(ERROR,
459 : (errcode(ERRCODE_WRONG_OBJECT_TYPE),
460 : errmsg("cannot get page count of relation \"%s\"",
461 : RelationGetRelationName(rel)),
462 : errdetail_relkind_not_supported(rel->rd_rel->relkind)));
463 :
464 : /* note: this will work OK on non-local temp tables */
465 :
466 0 : relpages = RelationGetNumberOfBlocks(rel);
467 :
468 0 : relation_close(rel, AccessShareLock);
469 :
470 0 : return relpages;
471 0 : }
472 :
473 : /* ------------------------------------------------------
474 : * pgstatginindex()
475 : *
476 : * Usage: SELECT * FROM pgstatginindex('ginindex');
477 : *
478 : * Must keep superuser() check, see above.
479 : * ------------------------------------------------------
480 : */
481 : Datum
482 0 : pgstatginindex(PG_FUNCTION_ARGS)
483 : {
484 0 : Oid relid = PG_GETARG_OID(0);
485 :
486 0 : if (!superuser())
487 0 : ereport(ERROR,
488 : (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
489 : errmsg("must be superuser to use pgstattuple functions")));
490 :
491 0 : PG_RETURN_DATUM(pgstatginindex_internal(relid, fcinfo));
492 0 : }
493 :
494 : /* No need for superuser checks in v1.5, see above */
495 : Datum
496 0 : pgstatginindex_v1_5(PG_FUNCTION_ARGS)
497 : {
498 0 : Oid relid = PG_GETARG_OID(0);
499 :
500 0 : PG_RETURN_DATUM(pgstatginindex_internal(relid, fcinfo));
501 0 : }
502 :
503 : Datum
504 0 : pgstatginindex_internal(Oid relid, FunctionCallInfo fcinfo)
505 : {
506 0 : Relation rel;
507 0 : Buffer buffer;
508 0 : Page page;
509 0 : GinMetaPageData *metadata;
510 0 : GinIndexStat stats;
511 0 : HeapTuple tuple;
512 0 : TupleDesc tupleDesc;
513 0 : Datum values[3];
514 0 : bool nulls[3] = {false, false, false};
515 0 : Datum result;
516 :
517 : /*
518 : * This uses relation_open() and not index_open(). The latter allows
519 : * partitioned indexes, and these are forbidden here.
520 : */
521 0 : rel = relation_open(relid, AccessShareLock);
522 :
523 0 : if (!IS_INDEX(rel) || !IS_GIN(rel))
524 0 : ereport(ERROR,
525 : (errcode(ERRCODE_WRONG_OBJECT_TYPE),
526 : errmsg("relation \"%s\" is not a GIN index",
527 : RelationGetRelationName(rel))));
528 :
529 : /*
530 : * Reject attempts to read non-local temporary relations; we would be
531 : * likely to get wrong data since we have no visibility into the owning
532 : * session's local buffers.
533 : */
534 0 : if (RELATION_IS_OTHER_TEMP(rel))
535 0 : ereport(ERROR,
536 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
537 : errmsg("cannot access temporary indexes of other sessions")));
538 :
539 : /* see pgstatindex_impl */
540 0 : if (!rel->rd_index->indisvalid)
541 0 : ereport(ERROR,
542 : (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
543 : errmsg("index \"%s\" is not valid",
544 : RelationGetRelationName(rel))));
545 :
546 : /*
547 : * Read metapage
548 : */
549 0 : buffer = ReadBuffer(rel, GIN_METAPAGE_BLKNO);
550 0 : LockBuffer(buffer, GIN_SHARE);
551 0 : page = BufferGetPage(buffer);
552 0 : metadata = GinPageGetMeta(page);
553 :
554 0 : stats.version = metadata->ginVersion;
555 0 : stats.pending_pages = metadata->nPendingPages;
556 0 : stats.pending_tuples = metadata->nPendingHeapTuples;
557 :
558 0 : UnlockReleaseBuffer(buffer);
559 0 : relation_close(rel, AccessShareLock);
560 :
561 : /*
562 : * Build a tuple descriptor for our result type
563 : */
564 0 : if (get_call_result_type(fcinfo, NULL, &tupleDesc) != TYPEFUNC_COMPOSITE)
565 0 : elog(ERROR, "return type must be a row type");
566 :
567 0 : values[0] = Int32GetDatum(stats.version);
568 0 : values[1] = UInt32GetDatum(stats.pending_pages);
569 0 : values[2] = Int64GetDatum(stats.pending_tuples);
570 :
571 : /*
572 : * Build and return the tuple
573 : */
574 0 : tuple = heap_form_tuple(tupleDesc, values, nulls);
575 0 : result = HeapTupleGetDatum(tuple);
576 :
577 0 : return result;
578 0 : }
579 :
580 : /* ------------------------------------------------------
581 : * pgstathashindex()
582 : *
583 : * Usage: SELECT * FROM pgstathashindex('hashindex');
584 : * ------------------------------------------------------
585 : */
586 : Datum
587 0 : pgstathashindex(PG_FUNCTION_ARGS)
588 : {
589 0 : Oid relid = PG_GETARG_OID(0);
590 0 : BlockNumber nblocks;
591 0 : BlockNumber blkno;
592 0 : Relation rel;
593 0 : HashIndexStat stats;
594 0 : BufferAccessStrategy bstrategy;
595 0 : HeapTuple tuple;
596 0 : TupleDesc tupleDesc;
597 0 : Datum values[8];
598 0 : bool nulls[8] = {0};
599 0 : Buffer metabuf;
600 0 : HashMetaPage metap;
601 0 : float8 free_percent;
602 0 : uint64 total_space;
603 :
604 : /*
605 : * This uses relation_open() and not index_open(). The latter allows
606 : * partitioned indexes, and these are forbidden here.
607 : */
608 0 : rel = relation_open(relid, AccessShareLock);
609 :
610 0 : if (!IS_INDEX(rel) || !IS_HASH(rel))
611 0 : ereport(ERROR,
612 : (errcode(ERRCODE_WRONG_OBJECT_TYPE),
613 : errmsg("relation \"%s\" is not a hash index",
614 : RelationGetRelationName(rel))));
615 :
616 : /*
617 : * Reject attempts to read non-local temporary relations; we would be
618 : * likely to get wrong data since we have no visibility into the owning
619 : * session's local buffers.
620 : */
621 0 : if (RELATION_IS_OTHER_TEMP(rel))
622 0 : ereport(ERROR,
623 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
624 : errmsg("cannot access temporary indexes of other sessions")));
625 :
626 : /* see pgstatindex_impl */
627 0 : if (!rel->rd_index->indisvalid)
628 0 : ereport(ERROR,
629 : (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
630 : errmsg("index \"%s\" is not valid",
631 : RelationGetRelationName(rel))));
632 :
633 : /* Get the information we need from the metapage. */
634 0 : memset(&stats, 0, sizeof(stats));
635 0 : metabuf = _hash_getbuf(rel, HASH_METAPAGE, HASH_READ, LH_META_PAGE);
636 0 : metap = HashPageGetMeta(BufferGetPage(metabuf));
637 0 : stats.version = metap->hashm_version;
638 0 : stats.space_per_page = metap->hashm_bsize;
639 0 : _hash_relbuf(rel, metabuf);
640 :
641 : /* Get the current relation length */
642 0 : nblocks = RelationGetNumberOfBlocks(rel);
643 :
644 : /* prepare access strategy for this index */
645 0 : bstrategy = GetAccessStrategy(BAS_BULKREAD);
646 :
647 : /* Start from blkno 1 as 0th block is metapage */
648 0 : for (blkno = 1; blkno < nblocks; blkno++)
649 : {
650 0 : Buffer buf;
651 0 : Page page;
652 :
653 0 : CHECK_FOR_INTERRUPTS();
654 :
655 0 : buf = ReadBufferExtended(rel, MAIN_FORKNUM, blkno, RBM_NORMAL,
656 0 : bstrategy);
657 0 : LockBuffer(buf, BUFFER_LOCK_SHARE);
658 0 : page = BufferGetPage(buf);
659 :
660 0 : if (PageIsNew(page))
661 0 : stats.unused_pages++;
662 0 : else if (PageGetSpecialSize(page) !=
663 : MAXALIGN(sizeof(HashPageOpaqueData)))
664 0 : ereport(ERROR,
665 : (errcode(ERRCODE_INDEX_CORRUPTED),
666 : errmsg("index \"%s\" contains corrupted page at block %u",
667 : RelationGetRelationName(rel),
668 : BufferGetBlockNumber(buf))));
669 : else
670 : {
671 0 : HashPageOpaque opaque;
672 0 : int pagetype;
673 :
674 0 : opaque = HashPageGetOpaque(page);
675 0 : pagetype = opaque->hasho_flag & LH_PAGE_TYPE;
676 :
677 0 : if (pagetype == LH_BUCKET_PAGE)
678 : {
679 0 : stats.bucket_pages++;
680 0 : GetHashPageStats(page, &stats);
681 0 : }
682 0 : else if (pagetype == LH_OVERFLOW_PAGE)
683 : {
684 0 : stats.overflow_pages++;
685 0 : GetHashPageStats(page, &stats);
686 0 : }
687 0 : else if (pagetype == LH_BITMAP_PAGE)
688 0 : stats.bitmap_pages++;
689 0 : else if (pagetype == LH_UNUSED_PAGE)
690 0 : stats.unused_pages++;
691 : else
692 0 : ereport(ERROR,
693 : (errcode(ERRCODE_INDEX_CORRUPTED),
694 : errmsg("unexpected page type 0x%04X in HASH index \"%s\" block %u",
695 : opaque->hasho_flag, RelationGetRelationName(rel),
696 : BufferGetBlockNumber(buf))));
697 0 : }
698 0 : UnlockReleaseBuffer(buf);
699 0 : }
700 :
701 : /* Done accessing the index */
702 0 : relation_close(rel, AccessShareLock);
703 :
704 : /* Count unused pages as free space. */
705 0 : stats.free_space += (uint64) stats.unused_pages * stats.space_per_page;
706 :
707 : /*
708 : * Total space available for tuples excludes the metapage and the bitmap
709 : * pages.
710 : */
711 0 : total_space = (uint64) (nblocks - (stats.bitmap_pages + 1)) *
712 0 : stats.space_per_page;
713 :
714 0 : if (total_space == 0)
715 0 : free_percent = 0.0;
716 : else
717 0 : free_percent = 100.0 * stats.free_space / total_space;
718 :
719 : /*
720 : * Build a tuple descriptor for our result type
721 : */
722 0 : if (get_call_result_type(fcinfo, NULL, &tupleDesc) != TYPEFUNC_COMPOSITE)
723 0 : elog(ERROR, "return type must be a row type");
724 :
725 0 : tupleDesc = BlessTupleDesc(tupleDesc);
726 :
727 : /*
728 : * Build and return the tuple
729 : */
730 0 : values[0] = Int32GetDatum(stats.version);
731 0 : values[1] = Int64GetDatum((int64) stats.bucket_pages);
732 0 : values[2] = Int64GetDatum((int64) stats.overflow_pages);
733 0 : values[3] = Int64GetDatum((int64) stats.bitmap_pages);
734 0 : values[4] = Int64GetDatum((int64) stats.unused_pages);
735 0 : values[5] = Int64GetDatum(stats.live_items);
736 0 : values[6] = Int64GetDatum(stats.dead_items);
737 0 : values[7] = Float8GetDatum(free_percent);
738 0 : tuple = heap_form_tuple(tupleDesc, values, nulls);
739 :
740 0 : PG_RETURN_DATUM(HeapTupleGetDatum(tuple));
741 0 : }
742 :
743 : /* -------------------------------------------------
744 : * GetHashPageStats()
745 : *
746 : * Collect statistics of single hash page
747 : * -------------------------------------------------
748 : */
749 : static void
750 0 : GetHashPageStats(Page page, HashIndexStat *stats)
751 : {
752 0 : OffsetNumber maxoff = PageGetMaxOffsetNumber(page);
753 0 : int off;
754 :
755 : /* count live and dead tuples, and free space */
756 0 : for (off = FirstOffsetNumber; off <= maxoff; off++)
757 : {
758 0 : ItemId id = PageGetItemId(page, off);
759 :
760 0 : if (!ItemIdIsDead(id))
761 0 : stats->live_items++;
762 : else
763 0 : stats->dead_items++;
764 0 : }
765 0 : stats->free_space += PageGetExactFreeSpace(page);
766 0 : }
|
