3 #include "access/genam.h"
4 #include "access/gin.h"
5 #if PG_VERSION_NUM >= 90400
6 #include "utils/snapmgr.h"
8 #if PG_VERSION_NUM >= 90100
9 #include "access/gin_private.h"
11 #include "access/gist.h"
12 #include "access/gist_private.h"
13 #include "access/gistscan.h"
14 #if PG_VERSION_NUM >= 90200
15 #include "access/spgist_private.h"
16 #include "access/spgist.h"
17 #include "utils/datum.h"
19 #include "access/heapam.h"
20 #include "catalog/index.h"
21 #include "miscadmin.h"
22 #include "storage/lmgr.h"
23 #include "catalog/namespace.h"
24 #if PG_VERSION_NUM >= 80300
25 #include <tsearch/ts_utils.h>
27 #include <utils/tqual.h>
28 #include "utils/builtins.h"
29 #include "utils/lsyscache.h"
30 #include "utils/datum.h"
31 #include "utils/fmgroids.h"
34 #include <access/heapam.h>
35 #include <catalog/pg_type.h>
36 #include <access/relscan.h>
39 #define PAGESIZE (BLCKSZ - MAXALIGN(sizeof(PageHeaderData) + sizeof(ItemIdData)))
42 #define PG_NARGS() (fcinfo->nargs)
45 #if PG_VERSION_NUM >= 90600
47 #define ISNOTNULL false
48 #define heap_formtuple heap_form_tuple
56 char *out=palloc(VARSIZE(in));
58 memcpy(out, VARDATA(in), VARSIZE(in)-VARHDRSZ);
59 out[ VARSIZE(in)-VARHDRSZ ] ='\0';
70 static Relation checkOpenedRelation(Relation r, Oid PgAmOid);
72 #ifdef PG_MODULE_MAGIC
78 gist_index_open(RangeVar *relvar) {
79 #if PG_VERSION_NUM < 90200
80 Oid relOid = RangeVarGetRelid(relvar, false);
82 Oid relOid = RangeVarGetRelid(relvar, NoLock, false);
84 return checkOpenedRelation(
85 index_open(relOid, AccessExclusiveLock), GIST_AM_OID);
88 #define gist_index_close(r) index_close((r), AccessExclusiveLock)
91 gin_index_open(RangeVar *relvar) {
92 #if PG_VERSION_NUM < 90200
93 Oid relOid = RangeVarGetRelid(relvar, false);
95 Oid relOid = RangeVarGetRelid(relvar, NoLock, false);
97 return checkOpenedRelation(
98 index_open(relOid, AccessShareLock), GIN_AM_OID);
101 #define gin_index_close(r) index_close((r), AccessShareLock)
106 gist_index_open(RangeVar *relvar) {
107 Relation rel = index_openrv(relvar);
109 LockRelation(rel, AccessExclusiveLock);
110 return checkOpenedRelation(rel, GIST_AM_OID);
114 gist_index_close(Relation rel) {
115 UnlockRelation(rel, AccessExclusiveLock);
120 gin_index_open(RangeVar *relvar) {
121 Relation rel = index_openrv(relvar);
123 LockRelation(rel, AccessShareLock);
124 return checkOpenedRelation(rel, GIN_AM_OID);
128 gin_index_close(Relation rel) {
129 UnlockRelation(rel, AccessShareLock);
135 #if PG_VERSION_NUM >= 80300
136 #define stringToQualifiedNameList(x,y) stringToQualifiedNameList(x)
139 #if PG_VERSION_NUM < 80300
140 #define SET_VARSIZE(p,l) VARATT_SIZEP(p)=(l)
144 checkOpenedRelation(Relation r, Oid PgAmOid) {
145 if ( r->rd_am == NULL )
146 elog(ERROR, "Relation %s.%s is not an index",
147 get_namespace_name(RelationGetNamespace(r)),
148 RelationGetRelationName(r)
151 if ( r->rd_rel->relam != PgAmOid )
152 elog(ERROR, "Index %s.%s has wrong type",
153 get_namespace_name(RelationGetNamespace(r)),
154 RelationGetRelationName(r)
161 gist_dumptree(Relation r, int level, BlockNumber blk, OffsetNumber coff, IdxInfo *info) {
171 pred = (char *) palloc(sizeof(char) * level * 4 + 1);
172 MemSet(pred, ' ', level*4);
173 pred[level*4] = '\0';
175 buffer = ReadBuffer(r, blk);
176 page = (Page) BufferGetPage(buffer);
178 maxoff = PageGetMaxOffsetNumber(page);
181 while ( (info->ptr-((char*)info->txt)) + level*4 + 128 >= info->len ) {
182 int dist=info->ptr-((char*)info->txt);
184 info->txt=(text*)repalloc(info->txt, info->len);
185 info->ptr = ((char*)info->txt)+dist;
188 sprintf(info->ptr, "%s%d(l:%d) blk: %u numTuple: %d free: %db(%.2f%%) rightlink:%u (%s)\n",
194 (int) PageGetFreeSpace(page),
195 100.0*(((float)PAGESIZE)-(float)PageGetFreeSpace(page))/((float)PAGESIZE),
196 GistPageGetOpaque(page)->rightlink,
197 ( GistPageGetOpaque(page)->rightlink == InvalidBlockNumber ) ? "InvalidBlockNumber" : "OK" );
198 info->ptr=strchr(info->ptr,'\0');
200 if (!GistPageIsLeaf(page) && ( info->maxlevel<0 || level<info->maxlevel ) )
201 for (i = FirstOffsetNumber; i <= maxoff; i = OffsetNumberNext(i)) {
202 iid = PageGetItemId(page, i);
203 which = (IndexTuple) PageGetItem(page, iid);
204 cblk = ItemPointerGetBlockNumber(&(which->t_tid));
205 gist_dumptree(r, level + 1, cblk, i, info);
207 ReleaseBuffer(buffer);
211 PG_FUNCTION_INFO_V1(gist_tree);
212 Datum gist_tree(PG_FUNCTION_ARGS);
214 gist_tree(PG_FUNCTION_ARGS) {
215 text *name=PG_GETARG_TEXT_P(0);
216 char *relname=t2c(name);
222 relname_list = stringToQualifiedNameList(relname, "gist_tree");
223 relvar = makeRangeVarFromNameList(relname_list);
224 index = gist_index_open(relvar);
225 PG_FREE_IF_COPY(name,0);
227 info.maxlevel = ( PG_NARGS() > 1 ) ? PG_GETARG_INT32(1) : -1;
229 info.txt=(text*)palloc( info.len );
230 info.ptr=((char*)info.txt)+VARHDRSZ;
232 gist_dumptree(index, 0, GIST_ROOT_BLKNO, 0, &info);
234 gist_index_close(index);
237 SET_VARSIZE(info.txt, info.ptr-((char*)info.txt));
238 PG_RETURN_POINTER(info.txt);
249 uint64 leaftuplesize;
254 gist_stattree(Relation r, int level, BlockNumber blk, OffsetNumber coff, IdxStat *info) {
264 pred = (char *) palloc(sizeof(char) * level * 4 + 1);
265 MemSet(pred, ' ', level*4);
266 pred[level*4] = '\0';
268 buffer = ReadBuffer(r, blk);
269 page = (Page) BufferGetPage(buffer);
271 maxoff = PageGetMaxOffsetNumber(page);
274 info->tuplesize+=PAGESIZE-PageGetFreeSpace(page);
275 info->totalsize+=BLCKSZ;
276 info->numtuple+=maxoff;
277 if ( info->level < level )
280 if (GistPageIsLeaf(page)) {
281 info->numleafpages++;
282 info->leaftuplesize+=PAGESIZE-PageGetFreeSpace(page);
283 info->numleaftuple+=maxoff;
285 for (i = FirstOffsetNumber; i <= maxoff; i = OffsetNumberNext(i)) {
286 iid = PageGetItemId(page, i);
287 which = (IndexTuple) PageGetItem(page, iid);
288 if ( GistTupleIsInvalid(which) )
289 info->numinvalidtuple++;
290 cblk = ItemPointerGetBlockNumber(&(which->t_tid));
291 gist_stattree(r, level + 1, cblk, i, info);
295 ReleaseBuffer(buffer);
299 PG_FUNCTION_INFO_V1(gist_stat);
300 Datum gist_stat(PG_FUNCTION_ARGS);
302 gist_stat(PG_FUNCTION_ARGS) {
303 text *name=PG_GETARG_TEXT_P(0);
304 char *relname=t2c(name);
309 text *out=(text*)palloc(1024);
310 char *ptr=((char*)out)+VARHDRSZ;
313 relname_list = stringToQualifiedNameList(relname, "gist_tree");
314 relvar = makeRangeVarFromNameList(relname_list);
315 index = gist_index_open(relvar);
316 PG_FREE_IF_COPY(name,0);
318 memset(&info, 0, sizeof(IdxStat));
320 gist_stattree(index, 0, GIST_ROOT_BLKNO, 0, &info);
322 gist_index_close(index);
326 "Number of levels: %d\n"
327 "Number of pages: %d\n"
328 "Number of leaf pages: %d\n"
329 "Number of tuples: %d\n"
330 "Number of invalid tuples: %d\n"
331 "Number of leaf tuples: %d\n"
332 "Total size of tuples: "INT64_FORMAT" bytes\n"
333 "Total size of leaf tuples: "INT64_FORMAT" bytes\n"
334 "Total size of index: "INT64_FORMAT" bytes\n",
339 info.numinvalidtuple,
345 ptr=strchr(ptr,'\0');
347 SET_VARSIZE(out, ptr-((char*)out));
348 PG_RETURN_POINTER(out);
351 typedef struct GPItem {
364 #if PG_VERSION_NUM >= 90600
373 openGPPage( FuncCallContext *funcctx, BlockNumber blk ) {
375 MemoryContext oldcontext;
376 Relation index = ( (TypeStorage*)(funcctx->user_fctx) )->index;
378 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
379 nitem = (GPItem*)palloc( sizeof(GPItem) );
380 memset(nitem,0,sizeof(GPItem));
382 nitem->buffer = ReadBuffer(index, blk);
383 nitem->page = (Page) BufferGetPage(nitem->buffer);
384 nitem->offset=FirstOffsetNumber;
385 nitem->next = ( (TypeStorage*)(funcctx->user_fctx) )->item;
386 nitem->level = ( nitem->next ) ? nitem->next->level+1 : 1;
387 ( (TypeStorage*)(funcctx->user_fctx) )->item = nitem;
389 MemoryContextSwitchTo(oldcontext);
394 closeGPPage( FuncCallContext *funcctx ) {
395 GPItem *oitem = ( (TypeStorage*)(funcctx->user_fctx) )->item;
397 ( (TypeStorage*)(funcctx->user_fctx) )->item = oitem->next;
399 ReleaseBuffer(oitem->buffer);
401 return ( (TypeStorage*)(funcctx->user_fctx) )->item;
405 setup_firstcall(FuncCallContext *funcctx, text *name) {
406 MemoryContext oldcontext;
408 char *relname=t2c(name);
410 char attname[NAMEDATALEN];
413 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
415 st=(TypeStorage*)palloc( sizeof(TypeStorage) );
416 memset(st,0,sizeof(TypeStorage));
417 st->relname_list = stringToQualifiedNameList(relname, "gist_tree");
418 st->relvar = makeRangeVarFromNameList(st->relname_list);
419 st->index = gist_index_open(st->relvar);
420 funcctx->user_fctx = (void*)st;
422 tupdesc = CreateTemplateTupleDesc(st->index->rd_att->natts+2, false);
423 TupleDescInitEntry(tupdesc, 1, "level", INT4OID, -1, 0);
424 TupleDescInitEntry(tupdesc, 2, "valid", BOOLOID, -1, 0);
425 for (i = 0; i < st->index->rd_att->natts; i++) {
426 sprintf(attname, "z%d", i+2);
431 st->index->rd_att->attrs[i]->atttypid,
432 st->index->rd_att->attrs[i]->atttypmod,
433 st->index->rd_att->attrs[i]->attndims
437 st->dvalues = (Datum *) palloc((tupdesc->natts+2) * sizeof(Datum));
438 st->nulls = (char *) palloc((tupdesc->natts+2) * sizeof(*st->nulls));
440 funcctx->slot = TupleDescGetSlot(tupdesc);
441 funcctx->attinmeta = TupleDescGetAttInMetadata(tupdesc);
443 MemoryContextSwitchTo(oldcontext);
446 st->item=openGPPage(funcctx, GIST_ROOT_BLKNO);
450 close_call( FuncCallContext *funcctx ) {
451 TypeStorage *st = (TypeStorage*)(funcctx->user_fctx);
453 while(st->item && closeGPPage(funcctx));
458 gist_index_close(st->index);
461 PG_FUNCTION_INFO_V1(gist_print);
462 Datum gist_print(PG_FUNCTION_ARGS);
464 gist_print(PG_FUNCTION_ARGS) {
465 FuncCallContext *funcctx;
467 Datum result=(Datum)0;
474 if (SRF_IS_FIRSTCALL()) {
475 text *name=PG_GETARG_TEXT_P(0);
476 funcctx = SRF_FIRSTCALL_INIT();
477 setup_firstcall(funcctx, name);
478 PG_FREE_IF_COPY(name,0);
481 funcctx = SRF_PERCALL_SETUP();
482 st = (TypeStorage*)(funcctx->user_fctx);
486 SRF_RETURN_DONE(funcctx);
489 while( st->item->offset > PageGetMaxOffsetNumber( st->item->page ) ) {
490 if ( ! closeGPPage(funcctx) ) {
492 SRF_RETURN_DONE(funcctx);
496 iid = PageGetItemId( st->item->page, st->item->offset );
497 ituple = (IndexTuple) PageGetItem(st->item->page, iid);
499 st->dvalues[0] = Int32GetDatum( st->item->level );
500 st->nulls[0] = ISNOTNULL;
501 st->dvalues[1] = BoolGetDatum( (!GistPageIsLeaf(st->item->page) && GistTupleIsInvalid(ituple)) ? false : true );
502 st->nulls[1] = ISNOTNULL;
503 for(i=2; i<funcctx->attinmeta->tupdesc->natts; i++) {
504 if ( !GistPageIsLeaf(st->item->page) && GistTupleIsInvalid(ituple) ) {
505 st->dvalues[i] = (Datum)0;
506 st->nulls[i] = ISNULL;
508 st->dvalues[i] = index_getattr(ituple, i-1, st->index->rd_att, &isnull);
509 st->nulls[i] = ( isnull ) ? ISNULL : ISNOTNULL;
513 htuple = heap_formtuple(funcctx->attinmeta->tupdesc, st->dvalues, st->nulls);
514 result = TupleGetDatum(funcctx->slot, htuple);
515 st->item->offset = OffsetNumberNext(st->item->offset);
516 if ( !GistPageIsLeaf(st->item->page) )
517 openGPPage(funcctx, ItemPointerGetBlockNumber(&(ituple->t_tid)) );
519 SRF_RETURN_NEXT(funcctx, result);
522 typedef struct GinStatState {
530 #if PG_VERSION_NUM >= 90100
531 GinNullCategory category;
538 moveRightIfItNeeded( GinStatState *st )
540 Page page = BufferGetPage(st->buffer);
542 if ( st->offset > PageGetMaxOffsetNumber(page) ) {
544 * We scaned the whole page, so we should take right page
546 BlockNumber blkno = GinPageGetOpaque(page)->rightlink;
548 if ( GinPageRightMost(page) )
549 return false; /* no more page */
551 LockBuffer(st->buffer, GIN_UNLOCK);
552 st->buffer = ReleaseAndReadBuffer(st->buffer, st->index, blkno);
553 LockBuffer(st->buffer, GIN_SHARE);
554 st->offset = FirstOffsetNumber;
561 * Refinds a previois position, at returns it has correctly
562 * set offset and buffer is locked
565 refindPosition(GinStatState *st)
569 /* find left if needed (it causes only for first search) */
574 LockBuffer(st->buffer, GIN_SHARE);
576 page = BufferGetPage(st->buffer);
577 if (GinPageIsLeaf(page))
580 itup = (IndexTuple) PageGetItem(page, PageGetItemId(page, FirstOffsetNumber));
581 blkno = GinItemPointerGetBlockNumber(&(itup)->t_tid);
583 LockBuffer(st->buffer,GIN_UNLOCK);
584 st->buffer = ReleaseAndReadBuffer(st->buffer, st->index, blkno);
587 if (st->offset == InvalidOffsetNumber) {
588 return (PageGetMaxOffsetNumber(page) >= FirstOffsetNumber ) ? true : false; /* first one */
593 #if PG_VERSION_NUM >= 90100
594 GinNullCategory category;
595 #elif PG_VERSION_NUM < 80400
601 if (moveRightIfItNeeded(st)==false)
604 itup = (IndexTuple) PageGetItem(page, PageGetItemId(page, st->offset));
605 #if PG_VERSION_NUM >= 90100
606 datum = gintuple_get_key(&st->ginstate, itup, &category);
607 cmp = ginCompareAttEntries(&st->ginstate,
608 st->attnum + 1, st->curval, st->category,
609 gintuple_get_attrnum(&st->ginstate, itup), datum, category);
610 #elif PG_VERSION_NUM >= 80400
611 datum = gin_index_getattr(&st->ginstate, itup);
613 cmp = compareAttEntries(&st->ginstate,
614 st->attnum + 1, st->curval,
615 gintuple_get_attrnum(&st->ginstate, itup), datum);
617 datum = index_getattr(itup, FirstOffsetNumber, st->ginstate.tupdesc, &isnull);
621 &st->ginstate.compareFn,
628 if ( !st->index->rd_att->attrs[st->attnum]->attbyval )
629 pfree( (void*) st->curval );
640 gin_setup_firstcall(FuncCallContext *funcctx, text *name, int attnum) {
641 MemoryContext oldcontext;
643 char *relname=t2c(name);
646 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
648 st=(GinStatState*)palloc( sizeof(GinStatState) );
649 memset(st,0,sizeof(GinStatState));
650 st->index = gin_index_open(
651 makeRangeVarFromNameList(stringToQualifiedNameList(relname, "gin_stat")));
652 initGinState( &st->ginstate, st->index );
654 #if PG_VERSION_NUM >= 80400
655 if (attnum < 0 || attnum >= st->index->rd_att->natts)
656 elog(ERROR,"Wrong column's number");
662 funcctx->user_fctx = (void*)st;
664 tupdesc = CreateTemplateTupleDesc(2, false);
665 TupleDescInitEntry(tupdesc, 1, "value",
666 st->index->rd_att->attrs[st->attnum]->atttypid,
667 st->index->rd_att->attrs[st->attnum]->atttypmod,
668 st->index->rd_att->attrs[st->attnum]->attndims);
669 TupleDescInitEntry(tupdesc, 2, "nrow", INT4OID, -1, 0);
671 memset( st->nulls, ISNOTNULL, 2*sizeof(*st->nulls) );
673 funcctx->slot = TupleDescGetSlot(tupdesc);
674 funcctx->attinmeta = TupleDescGetAttInMetadata(tupdesc);
676 MemoryContextSwitchTo(oldcontext);
679 st->offset = InvalidOffsetNumber;
680 st->buffer = ReadBuffer( st->index, GIN_ROOT_BLKNO );
684 processTuple( FuncCallContext *funcctx, GinStatState *st, IndexTuple itup ) {
685 MemoryContext oldcontext;
686 #if PG_VERSION_NUM < 80400
690 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
691 st->curval = datumCopy(
692 #if PG_VERSION_NUM >= 90100
693 gintuple_get_key(&st->ginstate, itup, &st->category),
694 #elif PG_VERSION_NUM >= 80400
695 gin_index_getattr(&st->ginstate, itup),
697 index_getattr(itup, FirstOffsetNumber, st->ginstate.tupdesc, &isnull),
699 st->index->rd_att->attrs[st->attnum]->attbyval,
700 st->index->rd_att->attrs[st->attnum]->attlen );
701 MemoryContextSwitchTo(oldcontext);
703 st->dvalues[0] = st->curval;
704 #if PG_VERSION_NUM >= 90100
705 /* do no distiguish various null category */
706 st->nulls[0] = (st->category == GIN_CAT_NORM_KEY) ? ISNOTNULL : ISNULL;
709 if ( GinIsPostingTree(itup) ) {
710 BlockNumber rootblkno = GinGetPostingTree(itup);
711 #if PG_VERSION_NUM >= 90400
713 GinBtreeStack *stack;
714 ItemPointerData minItem;
718 GinPostingTreeScan *gdi;
722 uint32 predictNumber;
724 LockBuffer(st->buffer, GIN_UNLOCK);
725 #if PG_VERSION_NUM >= 90400
726 stack = ginScanBeginPostingTree(&btree, st->index, rootblkno);
727 page = BufferGetPage(stack->buffer);
728 ItemPointerSetMin(&minItem);
729 list = GinDataLeafPageGetItems(page, &nlist, minItem);
731 predictNumber = stack->predictNumber;
732 #elif PG_VERSION_NUM >= 90100
733 gdi = ginPrepareScanPostingTree(st->index, rootblkno, TRUE);
734 entrybuffer = ginScanBeginPostingTree(gdi);
735 page = BufferGetPage(entrybuffer);
736 predictNumber = gdi->stack->predictNumber;
738 gdi = prepareScanPostingTree(st->index, rootblkno, TRUE);
739 entrybuffer = scanBeginPostingTree(gdi);
740 page = BufferGetPage(entrybuffer);
741 predictNumber = gdi->stack->predictNumber;
744 st->dvalues[1] = Int32GetDatum( predictNumber * GinPageGetOpaque(page)->maxoff );
746 #if PG_VERSION_NUM < 90400
747 LockBuffer(entrybuffer, GIN_UNLOCK);
748 freeGinBtreeStack(gdi->stack);
751 LockBuffer(stack->buffer, GIN_UNLOCK);
752 freeGinBtreeStack(stack);
755 st->dvalues[1] = Int32GetDatum( GinGetNPosting(itup) );
756 LockBuffer(st->buffer, GIN_UNLOCK);
760 PG_FUNCTION_INFO_V1(gin_stat);
761 Datum gin_stat(PG_FUNCTION_ARGS);
763 gin_stat(PG_FUNCTION_ARGS) {
764 FuncCallContext *funcctx;
766 Datum result=(Datum)0;
771 if (SRF_IS_FIRSTCALL()) {
772 text *name=PG_GETARG_TEXT_P(0);
773 funcctx = SRF_FIRSTCALL_INIT();
774 gin_setup_firstcall(funcctx, name, (PG_NARGS()==2) ? PG_GETARG_INT32(1) : 0 );
775 PG_FREE_IF_COPY(name,0);
778 funcctx = SRF_PERCALL_SETUP();
779 st = (GinStatState*)(funcctx->user_fctx);
781 if ( refindPosition(st) == false ) {
782 UnlockReleaseBuffer( st->buffer );
783 gin_index_close(st->index);
785 SRF_RETURN_DONE(funcctx);
791 if (moveRightIfItNeeded(st)==false) {
792 UnlockReleaseBuffer( st->buffer );
793 gin_index_close(st->index);
795 SRF_RETURN_DONE(funcctx);
798 page = BufferGetPage(st->buffer);
799 ituple = (IndexTuple) PageGetItem(page, PageGetItemId(page, st->offset));
801 #if PG_VERSION_NUM >= 80400
802 if (st->attnum + 1 == gintuple_get_attrnum(&st->ginstate, ituple))
807 processTuple( funcctx, st, ituple );
809 htuple = heap_formtuple(funcctx->attinmeta->tupdesc, st->dvalues, st->nulls);
810 result = TupleGetDatum(funcctx->slot, htuple);
812 SRF_RETURN_NEXT(funcctx, result);
815 PG_FUNCTION_INFO_V1(gin_count_estimate);
816 Datum gin_count_estimate(PG_FUNCTION_ARGS);
817 #if PG_VERSION_NUM >= 80300
819 gin_count_estimate(PG_FUNCTION_ARGS) {
820 text *name=PG_GETARG_TEXT_P(0);
824 char *relname=t2c(name);
826 #if PG_VERSION_NUM >= 80400
827 TIDBitmap *bitmap = tbm_create(work_mem * 1024L);
830 ItemPointerData tids[MAXTIDS];
835 index = gin_index_open(
836 makeRangeVarFromNameList(stringToQualifiedNameList(relname, "gin_count_estimate")));
838 if ( index->rd_opcintype[0] != TSVECTOROID ) {
839 gin_index_close(index);
840 elog(ERROR, "Column type is not a tsvector");
845 key.sk_strategy = TSearchStrategyNumber;
847 key.sk_argument = PG_GETARG_DATUM(1);
849 fmgr_info( F_TS_MATCH_VQ , &key.sk_func );
851 #if PG_VERSION_NUM >= 90100
852 #if PG_VERSION_NUM >= 90400
853 scan = index_beginscan_bitmap(index, SnapshotSelf, 1);
855 scan = index_beginscan_bitmap(index, SnapshotNow, 1);
857 index_rescan(scan, &key, 1, NULL, 0);
859 count = index_getbitmap(scan, bitmap);
861 #elif PG_VERSION_NUM >= 80400
862 scan = index_beginscan_bitmap(index, SnapshotNow, 1, &key);
864 count = index_getbitmap(scan, bitmap);
867 scan = index_beginscan_multi(index, SnapshotNow, 1, &key);
870 more = index_getmulti(scan, tids, MAXTIDS, &returned_tids);
871 count += returned_tids;
875 index_endscan( scan );
876 gin_index_close(index);
878 PG_RETURN_INT64(count);
882 gin_count_estimate(PG_FUNCTION_ARGS) {
883 elog(NOTICE, "Function is not working under PgSQL < 8.3");
889 PG_FUNCTION_INFO_V1(spgist_stat);
890 Datum spgist_stat(PG_FUNCTION_ARGS);
892 spgist_stat(PG_FUNCTION_ARGS)
894 #if PG_VERSION_NUM < 90200
895 elog(NOTICE, "Function is not working under PgSQL < 9.2");
897 PG_RETURN_TEXT_P(CStringGetTextDatum("???"));
899 text *name = PG_GETARG_TEXT_P(0);
903 BlockNumber totalPages = 0,
908 double usedSpace = 0.0,
910 usedInnerSpace = 0.0;
913 int64 innerTuples = 0,
916 nLeafPlaceholder = 0,
917 nInnerPlaceholder = 0,
921 #define IS_INDEX(r) ((r)->rd_rel->relkind == RELKIND_INDEX)
922 #define IS_SPGIST(r) ((r)->rd_rel->relam == SPGIST_AM_OID)
924 relvar = makeRangeVarFromNameList(textToQualifiedNameList(name));
925 index = relation_openrv(relvar, AccessExclusiveLock);
927 if (!IS_INDEX(index) || !IS_SPGIST(index))
928 elog(ERROR, "relation \"%s\" is not an SPGiST index",
929 RelationGetRelationName(index));
931 totalPages = RelationGetNumberOfBlocks(index);
933 for (blkno = SPGIST_ROOT_BLKNO; blkno < totalPages; blkno++)
939 buffer = ReadBuffer(index, blkno);
940 LockBuffer(buffer, BUFFER_LOCK_SHARE);
942 page = BufferGetPage(buffer);
944 if (PageIsNew(page) || SpGistPageIsDeleted(page))
947 UnlockReleaseBuffer(buffer);
951 if (SpGistPageIsLeaf(page))
954 leafTuples += PageGetMaxOffsetNumber(page);
955 nLeafPlaceholder += SpGistPageGetOpaque(page)->nPlaceholder;
956 nLeafRedirect += SpGistPageGetOpaque(page)->nRedirection;
964 max = PageGetMaxOffsetNumber(page);
966 nInnerPlaceholder += SpGistPageGetOpaque(page)->nPlaceholder;
967 nInnerRedirect += SpGistPageGetOpaque(page)->nRedirection;
968 for (i = FirstOffsetNumber; i <= max; i++)
972 it = (SpGistInnerTuple) PageGetItem(page,
973 PageGetItemId(page, i));
980 bufferSize = BufferGetPageSize(buffer)
981 - MAXALIGN(sizeof(SpGistPageOpaqueData))
982 - SizeOfPageHeaderData;
984 pageFree = PageGetExactFreeSpace(page);
986 usedSpace += bufferSize - pageFree;
987 if (SpGistPageIsLeaf(page))
988 usedLeafSpace += bufferSize - pageFree;
990 usedInnerSpace += bufferSize - pageFree;
992 if (pageFree == bufferSize)
995 UnlockReleaseBuffer(buffer);
998 index_close(index, AccessExclusiveLock);
1000 totalPages--; /* discount metapage */
1002 snprintf(res, sizeof(res),
1004 "deletedPages: %u\n"
1008 "usedSpace: %.2f kbytes\n"
1009 "usedInnerSpace: %.2f kbytes\n"
1010 "usedLeafSpace: %.2f kbytes\n"
1011 "freeSpace: %.2f kbytes\n"
1012 "fillRatio: %.2f%%\n"
1013 "leafTuples: " INT64_FORMAT "\n"
1014 "innerTuples: " INT64_FORMAT "\n"
1015 "innerAllTheSame: " INT64_FORMAT "\n"
1016 "leafPlaceholders: " INT64_FORMAT "\n"
1017 "innerPlaceholders: " INT64_FORMAT "\n"
1018 "leafRedirects: " INT64_FORMAT "\n"
1019 "innerRedirects: " INT64_FORMAT,
1020 totalPages, deletedPages, innerPages, leafPages, emptyPages,
1022 usedInnerSpace / 1024.0,
1023 usedLeafSpace / 1024.0,
1024 (((double) bufferSize) * ((double) totalPages) - usedSpace) / 1024,
1025 100.0 * (usedSpace / (((double) bufferSize) * ((double) totalPages))),
1026 leafTuples, innerTuples, nAllTheSame,
1027 nLeafPlaceholder, nInnerPlaceholder,
1028 nLeafRedirect, nInnerRedirect);
1030 PG_RETURN_TEXT_P(CStringGetTextDatum(res));
1034 #if PG_VERSION_NUM >= 90200
1036 typedef struct SPGistPrintStackElem {
1037 ItemPointerData iptr;
1040 } SPGistPrintStackElem;
1042 typedef struct SPGistPrint {
1045 Datum dvalues[8 /* see CreateTemplateTupleDesc call */];
1046 char nulls[8 /* see CreateTemplateTupleDesc call */];
1051 pushSPGistPrint(FuncCallContext *funcctx, SPGistPrint *prst, ItemPointer ip, int level) {
1052 MemoryContext oldcontext;
1053 SPGistPrintStackElem *e;
1055 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
1057 e = palloc(sizeof(*e));
1061 prst->stack = lcons(e, prst->stack);
1063 MemoryContextSwitchTo(oldcontext);
1067 close_spgist_print(SPGistPrint *prst) {
1068 index_close(prst->index, AccessExclusiveLock);
1072 PG_FUNCTION_INFO_V1(spgist_print);
1073 Datum spgist_print(PG_FUNCTION_ARGS);
1075 spgist_print(PG_FUNCTION_ARGS)
1077 #if PG_VERSION_NUM < 90200
1078 elog(NOTICE, "Function is not working under PgSQL < 9.2");
1080 PG_RETURN_TEXT_P(CStringGetTextDatum("???"));
1082 FuncCallContext *funcctx;
1084 SPGistPrintStackElem *s;
1087 MemoryContext oldcontext;
1089 if (SRF_IS_FIRSTCALL()) {
1090 text *name=PG_GETARG_TEXT_P(0);
1093 ItemPointerData ipd;
1096 funcctx = SRF_FIRSTCALL_INIT();
1097 relvar = makeRangeVarFromNameList(textToQualifiedNameList(name));
1098 index = relation_openrv(relvar, AccessExclusiveLock);
1100 if (!IS_INDEX(index) || !IS_SPGIST(index))
1101 elog(ERROR, "relation \"%s\" is not an SPGiST index",
1102 RelationGetRelationName(index));
1104 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
1106 prst = palloc(sizeof(*prst));
1108 prst->index = index;
1109 initSpGistState(&prst->state, index);
1111 tupdesc = CreateTemplateTupleDesc(3 /* types */ + 1 /* level */ + 1 /* nlabel */ + 2 /* tids */ + 1, false);
1112 TupleDescInitEntry(tupdesc, 1, "tid", TIDOID, -1, 0);
1113 TupleDescInitEntry(tupdesc, 2, "allthesame", BOOLOID, -1, 0);
1114 TupleDescInitEntry(tupdesc, 3, "node", INT4OID, -1, 0);
1115 TupleDescInitEntry(tupdesc, 4, "level", INT4OID, -1, 0);
1116 TupleDescInitEntry(tupdesc, 5, "tid_pointer", TIDOID, -1, 0);
1117 TupleDescInitEntry(tupdesc, 6, "prefix",
1118 (prst->state.attPrefixType.type == VOIDOID) ? INT4OID : prst->state.attPrefixType.type, -1, 0);
1119 TupleDescInitEntry(tupdesc, 7, "label",
1120 (prst->state.attLabelType.type == VOIDOID) ? INT4OID : prst->state.attLabelType.type, -1, 0);
1121 TupleDescInitEntry(tupdesc, 8, "leaf",
1122 (prst->state.attType.type == VOIDOID) ? INT4OID : prst->state.attType.type, -1, 0);
1124 funcctx->slot = TupleDescGetSlot(tupdesc);
1125 funcctx->attinmeta = TupleDescGetAttInMetadata(tupdesc);
1127 funcctx->user_fctx = (void*)prst;
1129 MemoryContextSwitchTo(oldcontext);
1131 ItemPointerSet(&ipd, SPGIST_ROOT_BLKNO, FirstOffsetNumber);
1133 pushSPGistPrint(funcctx, prst, &ipd, 1);
1135 PG_FREE_IF_COPY(name,0);
1138 funcctx = SRF_PERCALL_SETUP();
1139 prst = (SPGistPrint*)(funcctx->user_fctx);
1143 if ( prst->stack == NIL ) {
1144 close_spgist_print(prst);
1145 SRF_RETURN_DONE(funcctx);
1148 CHECK_FOR_INTERRUPTS();
1150 s = (SPGistPrintStackElem*)linitial(prst->stack);
1151 prst->stack = list_delete_first(prst->stack);
1153 if (ItemPointerIsValid(&s->iptr))
1161 SpGistDeadTuple dtuple;
1164 buffer = ReadBuffer(prst->index, ItemPointerGetBlockNumber(&s->iptr));
1165 LockBuffer(buffer, BUFFER_LOCK_SHARE);
1167 page = BufferGetPage(buffer);
1168 if (ItemPointerGetOffsetNumber(&s->iptr) > PageGetMaxOffsetNumber(page)) {
1169 UnlockReleaseBuffer(buffer);
1174 dtuple = (SpGistDeadTuple)PageGetItem(page, PageGetItemId(page, ItemPointerGetOffsetNumber(&s->iptr)));
1176 if (dtuple->tupstate != SPGIST_LIVE) {
1177 UnlockReleaseBuffer(buffer);
1182 if (SpGistPageIsLeaf(page)) {
1183 SpGistLeafTuple leafTuple = (SpGistLeafTuple)dtuple;
1185 tid = palloc(sizeof(ItemPointerData));
1187 prst->dvalues[0] = PointerGetDatum(tid);
1188 prst->nulls[0] = ISNOTNULL;
1189 prst->nulls[1] = ISNULL;
1190 prst->nulls[2] = ISNULL;
1191 prst->dvalues[3] = s->level;
1192 prst->nulls[3] = ISNOTNULL;
1193 prst->nulls[4] = ISNULL;
1194 prst->nulls[5] = ISNULL;
1195 prst->nulls[6] = ISNULL;
1196 prst->dvalues[7] = datumCopy(SGLTDATUM(leafTuple, &prst->state),
1197 prst->state.attType.attbyval, prst->state.attType.attlen);
1198 prst->nulls[7] = ISNOTNULL;
1200 SpGistInnerTuple innerTuple = (SpGistInnerTuple)dtuple;
1202 SpGistNodeTuple node;
1204 SGITITERATE(innerTuple, i, node) {
1205 if (ItemPointerIsValid(&node->t_tid)) {
1211 if (i >= innerTuple->nNodes) {
1212 UnlockReleaseBuffer(buffer);
1217 tid = palloc(sizeof(ItemPointerData));
1219 prst->dvalues[0] = PointerGetDatum(tid);
1220 prst->nulls[0] = ISNOTNULL;
1221 prst->dvalues[1] = innerTuple->allTheSame;
1222 prst->nulls[1] = ISNOTNULL;
1223 prst->dvalues[2] = Int32GetDatum(s->nlabel);
1224 prst->nulls[2] = ISNOTNULL;
1225 prst->dvalues[3] = s->level;
1226 prst->nulls[3] = ISNOTNULL;
1227 tid = palloc(sizeof(ItemPointerData));
1229 prst->dvalues[4] = PointerGetDatum(tid);
1230 prst->nulls[5] = ISNOTNULL;
1231 if (innerTuple->prefixSize > 0) {
1232 prst->dvalues[5] = datumCopy(SGITDATUM(innerTuple, &prst->state),
1233 prst->state.attPrefixType.attbyval, prst->state.attPrefixType.attlen);
1234 prst->nulls[5] = ISNOTNULL;
1236 prst->nulls[5] = ISNULL;
1237 if (!IndexTupleHasNulls(node)) {
1238 prst->dvalues[6] = datumCopy(SGNTDATUM(node, &prst->state),
1239 prst->state.attLabelType.attbyval, prst->state.attLabelType.attlen);
1240 prst->nulls[6] = ISNOTNULL;
1242 prst->nulls[6] = ISNULL;
1243 prst->nulls[7] = ISNULL;
1245 pushSPGistPrint(funcctx, prst, &node->t_tid, s->level + 1);
1247 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
1248 prst->stack = lcons(s, prst->stack);
1249 MemoryContextSwitchTo(oldcontext);
1253 UnlockReleaseBuffer(buffer);
1257 htuple = heap_formtuple(funcctx->attinmeta->tupdesc, prst->dvalues, prst->nulls);
1258 result = TupleGetDatum(funcctx->slot, htuple);
1260 SRF_RETURN_NEXT(funcctx, result);
1265 PG_FUNCTION_INFO_V1(gin_statpage);
1266 Datum gin_statpage(PG_FUNCTION_ARGS);
1268 gin_statpage(PG_FUNCTION_ARGS)
1270 #if PG_VERSION_NUM < 90400
1271 elog(NOTICE, "Function is not working under PgSQL < 9.4");
1273 PG_RETURN_TEXT_P(CStringGetTextDatum("???"));
1275 text *name = PG_GETARG_TEXT_P(0);
1285 entryInnerPages = 0,
1288 uint64 dataInnerFreeSpace = 0,
1289 dataLeafFreeSpace = 0,
1290 dataInnerTuplesCount = 0,
1291 dataLeafIptrsCount = 0,
1292 entryInnerFreeSpace = 0,
1293 entryLeafFreeSpace = 0,
1294 entryInnerTuplesCount = 0,
1295 entryLeafTuplesCount = 0,
1296 entryPostingSize = 0,
1297 entryPostingCount = 0,
1301 relvar = makeRangeVarFromNameList(textToQualifiedNameList(name));
1302 index = relation_openrv(relvar, AccessExclusiveLock);
1304 if (index->rd_rel->relkind != RELKIND_INDEX ||
1305 index->rd_rel->relam != GIN_AM_OID)
1306 elog(ERROR, "relation \"%s\" is not an SPGiST index",
1307 RelationGetRelationName(index));
1309 totalPages = RelationGetNumberOfBlocks(index);
1311 for (blkno = GIN_ROOT_BLKNO; blkno < totalPages; blkno++)
1317 buffer = ReadBuffer(index, blkno);
1318 LockBuffer(buffer, BUFFER_LOCK_SHARE);
1320 page = BufferGetPage(buffer);
1321 header = (PageHeader)page;
1323 if (GinPageIsData(page))
1326 if (GinPageIsLeaf(page))
1328 ItemPointerData minItem;
1332 dataLeafFreeSpace += header->pd_upper - header->pd_lower;
1333 ItemPointerSetMin(&minItem);
1334 pfree(GinDataLeafPageGetItems(page, &nlist, minItem));
1335 dataLeafIptrsCount += nlist;
1340 dataInnerFreeSpace += header->pd_upper - header->pd_lower;
1341 dataInnerTuplesCount += GinPageGetOpaque(page)->maxoff;
1347 OffsetNumber i, maxoff;
1349 maxoff = PageGetMaxOffsetNumber(page);
1352 if (GinPageIsLeaf(page))
1355 entryLeafFreeSpace += header->pd_upper - header->pd_lower;
1356 entryLeafTuplesCount += maxoff;
1361 entryInnerFreeSpace += header->pd_upper - header->pd_lower;
1362 entryInnerTuplesCount += maxoff;
1365 for (i = 1; i <= maxoff; i++)
1367 itup = (IndexTuple) PageGetItem(page, PageGetItemId(page, i));
1369 if (GinPageIsLeaf(page))
1371 GinPostingList *list = (GinPostingList *)GinGetPosting(itup);
1372 entryPostingCount += GinGetNPosting(itup);
1373 entryPostingSize += SizeOfGinPostingList(list);
1374 entryAttrSize += GinGetPostingOffset(itup) - IndexInfoFindDataOffset((itup)->t_info);
1378 entryAttrSize += IndexTupleSize(itup) - IndexInfoFindDataOffset((itup)->t_info);
1383 UnlockReleaseBuffer(buffer);
1386 index_close(index, AccessExclusiveLock);
1389 snprintf(res, sizeof(res),
1392 "dataInnerPages: %u\n"
1393 "dataLeafPages: %u\n"
1394 "dataInnerFreeSpace: " INT64_FORMAT "\n"
1395 "dataLeafFreeSpace: " INT64_FORMAT "\n"
1396 "dataInnerTuplesCount: " INT64_FORMAT "\n"
1397 "dataLeafIptrsCount: " INT64_FORMAT "\n"
1399 "entryInnerPages: %u\n"
1400 "entryLeafPages: %u\n"
1401 "entryInnerFreeSpace: " INT64_FORMAT "\n"
1402 "entryLeafFreeSpace: " INT64_FORMAT "\n"
1403 "entryInnerTuplesCount: " INT64_FORMAT "\n"
1404 "entryLeafTuplesCount: " INT64_FORMAT "\n"
1405 "entryPostingSize: " INT64_FORMAT "\n"
1406 "entryPostingCount: " INT64_FORMAT "\n"
1407 "entryAttrSize: " INT64_FORMAT "\n"
1415 dataInnerTuplesCount,
1420 entryInnerFreeSpace,
1422 entryInnerTuplesCount,
1423 entryLeafTuplesCount,
1429 PG_RETURN_TEXT_P(CStringGetTextDatum(res));