Skip to content

Commit 419d237

Browse files
tglsfdctglsfdc
committed
Fix a passel of inappropriately-named global functions in GIN.
The GIN code has absolutely no business exporting GIN-specific functions with names as generic as compareItemPointers() or newScanKey(); that's just trouble waiting to happen. I got annoyed about this again just now and decided to fix it. This commit ensures that all global symbols defined in access/gin/ have names including "gin" or "Gin". There were a couple of cases, like names involving "PostingItem", where arguably the names were already sufficiently nongeneric; but I figured as long as I was risking creating merge problems for unapplied GIN patches I might as well impose a uniform policy. I didn't touch any static symbol names. There might be some places where it'd be appropriate to rename some static functions to match siblings that are exported, but I'll leave that for another time.
1 parent 48c7d9f commit 419d237

File tree

12 files changed

+103
-102
lines changed

12 files changed

+103
-102
lines changed

‎src/backend/access/gin/ginbtree.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -173,8 +173,8 @@ freeGinBtreeStack(GinBtreeStack *stack)
173173
* with vacuum process
174174
*/
175175
void
176-
findParents(GinBtree btree, GinBtreeStack *stack,
177-
BlockNumber rootBlkno)
176+
ginFindParents(GinBtree btree, GinBtreeStack *stack,
177+
BlockNumber rootBlkno)
178178
{
179179

180180
Page page;
@@ -456,7 +456,7 @@ ginInsertValue(GinBtree btree, GinBtreeStack *stack, GinStatsData *buildStats)
456456
* rightmost page, but we don't find parent, we should use
457457
* plain search...
458458
*/
459-
findParents(btree, stack, rootBlkno);
459+
ginFindParents(btree, stack, rootBlkno);
460460
parent = stack->parent;
461461
page = BufferGetPage(parent->buffer);
462462
break;

‎src/backend/access/gin/ginbulk.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ ginCombineData(RBNode *existing, const RBNode *newdata, void *arg)
4848
{
4949
int res;
5050

51-
res = compareItemPointers(eo->list + eo->number - 1, en->list);
51+
res = ginCompareItemPointers(eo->list + eo->number - 1, en->list);
5252
Assert(res != 0);
5353

5454
if (res > 0)
@@ -67,8 +67,8 @@ cmpEntryAccumulator(const RBNode *a, const RBNode *b, void *arg)
6767
const EntryAccumulator *eb = (const EntryAccumulator *) b;
6868
BuildAccumulator *accum = (BuildAccumulator *) arg;
6969

70-
return compareAttEntries(accum->ginstate, ea->attnum, ea->value,
71-
eb->attnum, eb->value);
70+
return ginCompareAttEntries(accum->ginstate, ea->attnum, ea->value,
71+
eb->attnum, eb->value);
7272
}
7373

7474
/* Allocator function for rbtree.c */
@@ -226,7 +226,7 @@ ginInsertRecordBA(BuildAccumulator *accum, ItemPointer heapptr, OffsetNumber att
226226
static int
227227
qsortCompareItemPointers(const void *a, const void *b)
228228
{
229-
int res = compareItemPointers((ItemPointer) a, (ItemPointer) b);
229+
int res = ginCompareItemPointers((ItemPointer) a, (ItemPointer) b);
230230

231231
Assert(res != 0);
232232
return res;

‎src/backend/access/gin/gindatapage.c

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
#include "utils/rel.h"
2020

2121
int
22-
compareItemPointers(ItemPointer a, ItemPointer b)
22+
ginCompareItemPointers(ItemPointer a, ItemPointer b)
2323
{
2424
if (GinItemPointerGetBlockNumber(a) == GinItemPointerGetBlockNumber(b))
2525
{
@@ -37,17 +37,17 @@ compareItemPointers(ItemPointer a, ItemPointer b)
3737
* Caller is responsible that there is enough space at *dst.
3838
*/
3939
uint32
40-
MergeItemPointers(ItemPointerData *dst,
41-
ItemPointerData *a, uint32 na,
42-
ItemPointerData *b, uint32 nb)
40+
ginMergeItemPointers(ItemPointerData *dst,
41+
ItemPointerData *a, uint32 na,
42+
ItemPointerData *b, uint32 nb)
4343
{
4444
ItemPointerData *dptr = dst;
4545
ItemPointerData *aptr = a,
4646
*bptr = b;
4747

4848
while (aptr - a < na && bptr - b < nb)
4949
{
50-
int cmp = compareItemPointers(aptr, bptr);
50+
int cmp = ginCompareItemPointers(aptr, bptr);
5151

5252
if (cmp > 0)
5353
*dptr++ = *bptr++;
@@ -82,7 +82,7 @@ dataIsMoveRight(GinBtree btree, Page page)
8282
if (GinPageRightMost(page))
8383
return FALSE;
8484

85-
return (compareItemPointers(btree->items + btree->curitem, iptr) > 0) ? TRUE : FALSE;
85+
return (ginCompareItemPointers(btree->items + btree->curitem, iptr) > 0) ? TRUE : FALSE;
8686
}
8787

8888
/*
@@ -131,7 +131,7 @@ dataLocateItem(GinBtree btree, GinBtreeStack *stack)
131131
else
132132
{
133133
pitem = (PostingItem *) GinDataPageGetItem(page, mid);
134-
result = compareItemPointers(btree->items + btree->curitem, &(pitem->key));
134+
result = ginCompareItemPointers(btree->items + btree->curitem, &(pitem->key));
135135
}
136136

137137
if (result == 0)
@@ -189,7 +189,7 @@ dataLocateLeafItem(GinBtree btree, GinBtreeStack *stack)
189189
{
190190
OffsetNumber mid = low + ((high - low) / 2);
191191

192-
result = compareItemPointers(btree->items + btree->curitem, (ItemPointer) GinDataPageGetItem(page, mid));
192+
result = ginCompareItemPointers(btree->items + btree->curitem, (ItemPointer) GinDataPageGetItem(page, mid));
193193

194194
if (result == 0)
195195
{
@@ -297,7 +297,7 @@ GinDataPageAddItem(Page page, void *data, OffsetNumber offset)
297297
* Deletes posting item from non-leaf page
298298
*/
299299
void
300-
PageDeletePostingItem(Page page, OffsetNumber offset)
300+
GinPageDeletePostingItem(Page page, OffsetNumber offset)
301301
{
302302
OffsetNumber maxoff = GinPageGetOpaque(page)->maxoff;
303303

@@ -571,7 +571,7 @@ dataSplitPage(GinBtree btree, Buffer lbuf, Buffer rbuf, OffsetNumber off, XLogRe
571571
* Also called from ginxlog, should not use btree
572572
*/
573573
void
574-
dataFillRoot(GinBtree btree, Buffer root, Buffer lbuf, Buffer rbuf)
574+
ginDataFillRoot(GinBtree btree, Buffer root, Buffer lbuf, Buffer rbuf)
575575
{
576576
Page page = BufferGetPage(root),
577577
lpage = BufferGetPage(lbuf),
@@ -589,7 +589,7 @@ dataFillRoot(GinBtree btree, Buffer root, Buffer lbuf, Buffer rbuf)
589589
}
590590

591591
void
592-
prepareDataScan(GinBtree btree, Relation index)
592+
ginPrepareDataScan(GinBtree btree, Relation index)
593593
{
594594
memset(btree, 0, sizeof(GinBtreeData));
595595

@@ -603,7 +603,7 @@ prepareDataScan(GinBtree btree, Relation index)
603603
btree->isEnoughSpace = dataIsEnoughSpace;
604604
btree->placeToPage = dataPlaceToPage;
605605
btree->splitPage = dataSplitPage;
606-
btree->fillRoot = dataFillRoot;
606+
btree->fillRoot = ginDataFillRoot;
607607

608608
btree->isData = TRUE;
609609
btree->searchMode = FALSE;
@@ -613,11 +613,11 @@ prepareDataScan(GinBtree btree, Relation index)
613613
}
614614

615615
GinPostingTreeScan *
616-
prepareScanPostingTree(Relation index, BlockNumber rootBlkno, bool searchMode)
616+
ginPrepareScanPostingTree(Relation index, BlockNumber rootBlkno, bool searchMode)
617617
{
618618
GinPostingTreeScan *gdi = (GinPostingTreeScan *) palloc0(sizeof(GinPostingTreeScan));
619619

620-
prepareDataScan(&gdi->btree, index);
620+
ginPrepareDataScan(&gdi->btree, index);
621621

622622
gdi->btree.searchMode = searchMode;
623623
gdi->btree.fullScan = searchMode;
@@ -665,7 +665,7 @@ ginInsertItemPointer(GinPostingTreeScan *gdi,
665665
}
666666

667667
Buffer
668-
scanBeginPostingTree(GinPostingTreeScan *gdi)
668+
ginScanBeginPostingTree(GinPostingTreeScan *gdi)
669669
{
670670
gdi->stack = ginFindLeafPage(&gdi->btree, gdi->stack);
671671
return gdi->stack->buffer;

‎src/backend/access/gin/ginentrypage.c

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -172,10 +172,10 @@ entryIsMoveRight(GinBtree btree, Page page)
172172

173173
itup = getRightMostTuple(page);
174174

175-
if (compareAttEntries(btree->ginstate,
176-
btree->entryAttnum, btree->entryValue,
177-
gintuple_get_attrnum(btree->ginstate, itup),
178-
gin_index_getattr(btree->ginstate, itup)) > 0)
175+
if (ginCompareAttEntries(btree->ginstate,
176+
btree->entryAttnum, btree->entryValue,
177+
gintuple_get_attrnum(btree->ginstate, itup),
178+
gin_index_getattr(btree->ginstate, itup)) > 0)
179179
return TRUE;
180180

181181
return FALSE;
@@ -221,8 +221,9 @@ entryLocateEntry(GinBtree btree, GinBtreeStack *stack)
221221
else
222222
{
223223
itup = (IndexTuple) PageGetItem(page, PageGetItemId(page, mid));
224-
result = compareAttEntries(btree->ginstate,
225-
btree->entryAttnum, btree->entryValue,
224+
result = ginCompareAttEntries(btree->ginstate,
225+
btree->entryAttnum,
226+
btree->entryValue,
226227
gintuple_get_attrnum(btree->ginstate, itup),
227228
gin_index_getattr(btree->ginstate, itup));
228229
}
@@ -286,8 +287,9 @@ entryLocateLeafEntry(GinBtree btree, GinBtreeStack *stack)
286287
int result;
287288

288289
itup = (IndexTuple) PageGetItem(page, PageGetItemId(page, mid));
289-
result = compareAttEntries(btree->ginstate,
290-
btree->entryAttnum, btree->entryValue,
290+
result = ginCompareAttEntries(btree->ginstate,
291+
btree->entryAttnum,
292+
btree->entryValue,
291293
gintuple_get_attrnum(btree->ginstate, itup),
292294
gin_index_getattr(btree->ginstate, itup));
293295
if (result == 0)
@@ -636,7 +638,7 @@ ginPageGetLinkItup(Buffer buf)
636638
* Also called from ginxlog, should not use btree
637639
*/
638640
void
639-
entryFillRoot(GinBtree btree, Buffer root, Buffer lbuf, Buffer rbuf)
641+
ginEntryFillRoot(GinBtree btree, Buffer root, Buffer lbuf, Buffer rbuf)
640642
{
641643
Page page;
642644
IndexTuple itup;
@@ -655,7 +657,7 @@ entryFillRoot(GinBtree btree, Buffer root, Buffer lbuf, Buffer rbuf)
655657
}
656658

657659
void
658-
prepareEntryScan(GinBtree btree, Relation index, OffsetNumber attnum, Datum value, GinState *ginstate)
660+
ginPrepareEntryScan(GinBtree btree, Relation index, OffsetNumber attnum, Datum value, GinState *ginstate)
659661
{
660662
memset(btree, 0, sizeof(GinBtreeData));
661663

@@ -670,7 +672,7 @@ prepareEntryScan(GinBtree btree, Relation index, OffsetNumber attnum, Datum valu
670672
btree->isEnoughSpace = entryIsEnoughSpace;
671673
btree->placeToPage = entryPlaceToPage;
672674
btree->splitPage = entrySplitPage;
673-
btree->fillRoot = entryFillRoot;
675+
btree->fillRoot = ginEntryFillRoot;
674676

675677
btree->isData = FALSE;
676678
btree->searchMode = FALSE;

‎src/backend/access/gin/ginfast.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -437,7 +437,7 @@ ginHeapTupleFastCollect(Relation index, GinState *ginstate,
437437
int32 i,
438438
nentries;
439439

440-
entries = extractEntriesSU(ginstate, attnum, value, &nentries);
440+
entries = ginExtractEntriesSU(ginstate, attnum, value, &nentries);
441441

442442
if (nentries == 0)
443443
/* nothing to insert */

‎src/backend/access/gin/ginget.c

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ findItemInPage(Page page, ItemPointer item, OffsetNumber *off)
5151
*/
5252
for (*off = FirstOffsetNumber; *off <= maxoff; (*off)++)
5353
{
54-
res = compareItemPointers(item, (ItemPointer) GinDataPageGetItem(page, *off));
54+
res = ginCompareItemPointers(item, (ItemPointer) GinDataPageGetItem(page, *off));
5555

5656
if (res <= 0)
5757
return true;
@@ -99,9 +99,9 @@ scanForItems(Relation index, GinScanEntry scanEntry, BlockNumber rootPostingTree
9999
Page page;
100100
BlockNumber blkno;
101101

102-
gdi = prepareScanPostingTree(index, rootPostingTree, TRUE);
102+
gdi = ginPrepareScanPostingTree(index, rootPostingTree, TRUE);
103103

104-
buffer = scanBeginPostingTree(gdi);
104+
buffer = ginScanBeginPostingTree(gdi);
105105
IncrBufferRefCount(buffer); /* prevent unpin in freeGinBtreeStack */
106106

107107
freeGinBtreeStack(gdi->stack);
@@ -241,7 +241,8 @@ computePartialMatchList(GinBtreeData *btree, GinBtreeStack *stack, GinScanEntry
241241
if (gintuple_get_attrnum(btree->ginstate, itup) != scanEntry->attnum)
242242
elog(ERROR, "lost saved point in index"); /* must not happen !!! */
243243

244-
if (compareEntries(btree->ginstate, scanEntry->attnum, newDatum, savedDatum) == 0)
244+
if (ginCompareEntries(btree->ginstate, scanEntry->attnum,
245+
newDatum, savedDatum) == 0)
245246
{
246247
/* Found! */
247248
if (btree->ginstate->origTupdesc->attrs[scanEntry->attnum - 1]->attbyval == false)
@@ -298,7 +299,7 @@ startScanEntry(Relation index, GinState *ginstate, GinScanEntry entry)
298299
* posting list in memory
299300
*/
300301

301-
prepareEntryScan(&btreeEntry, index, entry->attnum, entry->entry, ginstate);
302+
ginPrepareEntryScan(&btreeEntry, index, entry->attnum, entry->entry, ginstate);
302303
btreeEntry.searchMode = TRUE;
303304
stackEntry = ginFindLeafPage(&btreeEntry, NULL);
304305
page = BufferGetPage(stackEntry->buffer);
@@ -359,9 +360,9 @@ startScanEntry(Relation index, GinState *ginstate, GinScanEntry entry)
359360
*/
360361
LockBuffer(stackEntry->buffer, GIN_UNLOCK);
361362
needUnlock = FALSE;
362-
gdi = prepareScanPostingTree(index, rootPostingTree, TRUE);
363+
gdi = ginPrepareScanPostingTree(index, rootPostingTree, TRUE);
363364

364-
entry->buffer = scanBeginPostingTree(gdi);
365+
entry->buffer = ginScanBeginPostingTree(gdi);
365366

366367
/*
367368
* We keep buffer pinned because we need to prevent deletion of
@@ -504,8 +505,8 @@ entryGetNextItem(Relation index, GinScanEntry entry)
504505
LockBuffer(entry->buffer, GIN_UNLOCK);
505506

506507
if (!ItemPointerIsValid(&entry->curItem) ||
507-
compareItemPointers(&entry->curItem,
508-
entry->list + entry->offset - 1) == 0)
508+
ginCompareItemPointers(&entry->curItem,
509+
entry->list + entry->offset - 1) == 0)
509510
{
510511
/*
511512
* First pages are deleted or empty, or we found exact
@@ -699,11 +700,11 @@ keyGetItem(Relation index, GinState *ginstate, MemoryContext tempCtx,
699700
entry = key->scanEntry + i;
700701

701702
while (entry->isFinished == FALSE &&
702-
compareItemPointers(&entry->curItem, &myAdvancePast) <= 0)
703+
ginCompareItemPointers(&entry->curItem, &myAdvancePast) <= 0)
703704
entryGetItem(index, entry);
704705

705706
if (entry->isFinished == FALSE &&
706-
compareItemPointers(&entry->curItem, &key->curItem) < 0)
707+
ginCompareItemPointers(&entry->curItem, &key->curItem) < 0)
707708
key->curItem = entry->curItem;
708709
}
709710

@@ -757,7 +758,7 @@ keyGetItem(Relation index, GinState *ginstate, MemoryContext tempCtx,
757758
{
758759
entry = key->scanEntry + i;
759760
if (entry->isFinished == FALSE &&
760-
compareItemPointers(&entry->curItem, &curPageLossy) == 0)
761+
ginCompareItemPointers(&entry->curItem, &curPageLossy) == 0)
761762
{
762763
if (haveLossyEntry)
763764
{
@@ -810,7 +811,7 @@ keyGetItem(Relation index, GinState *ginstate, MemoryContext tempCtx,
810811
{
811812
entry = key->scanEntry + i;
812813
if (entry->isFinished == FALSE &&
813-
compareItemPointers(&entry->curItem, &key->curItem) == 0)
814+
ginCompareItemPointers(&entry->curItem, &key->curItem) == 0)
814815
key->entryRes[i] = TRUE;
815816
else
816817
key->entryRes[i] = FALSE;
@@ -1071,10 +1072,10 @@ collectDatumForItem(IndexScanDesc scan, pendingPosition *pos)
10711072
datum[StopMiddle - 1] = gin_index_getattr(&so->ginstate, itup);
10721073
datumExtracted[StopMiddle - 1] = true;
10731074
}
1074-
res = compareEntries(&so->ginstate,
1075-
entry->attnum,
1076-
entry->entry,
1077-
datum[StopMiddle - 1]);
1075+
res = ginCompareEntries(&so->ginstate,
1076+
entry->attnum,
1077+
entry->entry,
1078+
datum[StopMiddle - 1]);
10781079

10791080
if (res == 0)
10801081
{
@@ -1282,14 +1283,14 @@ scanGetItem(IndexScanDesc scan, ItemPointer advancePast,
12821283
GinScanKey key = so->keys + i;
12831284

12841285
while (key->isFinished == FALSE &&
1285-
compareItemPointers(&key->curItem, &myAdvancePast) <= 0)
1286+
ginCompareItemPointers(&key->curItem, &myAdvancePast) <= 0)
12861287
keyGetItem(scan->indexRelation, &so->ginstate, so->tempCtx,
12871288
key, &myAdvancePast);
12881289

12891290
if (key->isFinished)
12901291
return FALSE; /* finished one of keys */
12911292

1292-
if (compareItemPointers(&key->curItem, item) < 0)
1293+
if (ginCompareItemPointers(&key->curItem, item) < 0)
12931294
*item = key->curItem;
12941295
}
12951296

@@ -1321,7 +1322,7 @@ scanGetItem(IndexScanDesc scan, ItemPointer advancePast,
13211322
{
13221323
GinScanKey key = so->keys + i;
13231324

1324-
if (compareItemPointers(item, &key->curItem) == 0)
1325+
if (ginCompareItemPointers(item, &key->curItem) == 0)
13251326
continue;
13261327
if (ItemPointerIsLossyPage(&key->curItem) &&
13271328
GinItemPointerGetBlockNumber(&key->curItem) ==
@@ -1372,7 +1373,7 @@ gingetbitmap(PG_FUNCTION_ARGS)
13721373
bool recheck;
13731374

13741375
if (GinIsNewKey(scan))
1375-
newScanKey(scan);
1376+
ginNewScanKey(scan);
13761377

13771378
if (GinIsVoidRes(scan))
13781379
PG_RETURN_INT64(0);

0 commit comments

Comments
 (0)