#include "postgres.h"
#include "access/amapi.h"
#include "access/relscan.h"
#include "access/transam.h"
#include "access/xlog.h"
#include "catalog/catalog.h"
#include "catalog/index.h"
#include "pgstat.h"
#include "storage/bufmgr.h"
#include "storage/lmgr.h"
#include "storage/predicate.h"
#include "utils/snapmgr.h"
#include "utils/tqual.h"

Include dependency graph for indexam.c:

Macros
#define	RELATION_CHECKS

#define	SCAN_CHECKS

#define	CHECK_REL_PROCEDURE(pname)

#define	CHECK_SCAN_PROCEDURE(pname)

Functions
static IndexScanDesc	index_beginscan_internal (Relation indexRelation, int nkeys, int norderbys, Snapshot snapshot, ParallelIndexScanDesc pscan, bool temp_snap)

Relation	index_open (Oid relationId, LOCKMODE lockmode)

void	index_close (Relation relation, LOCKMODE lockmode)

bool	index_insert (Relation indexRelation, Datum values, bool isnull, ItemPointer heap_t_ctid, Relation heapRelation, IndexUniqueCheck checkUnique, IndexInfo *indexInfo)

IndexScanDesc	index_beginscan (Relation heapRelation, Relation indexRelation, Snapshot snapshot, int nkeys, int norderbys)

IndexScanDesc	index_beginscan_bitmap (Relation indexRelation, Snapshot snapshot, int nkeys)

void	index_rescan (IndexScanDesc scan, ScanKey keys, int nkeys, ScanKey orderbys, int norderbys)

void	index_endscan (IndexScanDesc scan)

void	index_markpos (IndexScanDesc scan)

void	index_restrpos (IndexScanDesc scan)

Size	index_parallelscan_estimate (Relation indexRelation, Snapshot snapshot)

void	index_parallelscan_initialize (Relation heapRelation, Relation indexRelation, Snapshot snapshot, ParallelIndexScanDesc target)

void	index_parallelrescan (IndexScanDesc scan)

IndexScanDesc	index_beginscan_parallel (Relation heaprel, Relation indexrel, int nkeys, int norderbys, ParallelIndexScanDesc pscan)

ItemPointer	index_getnext_tid (IndexScanDesc scan, ScanDirection direction)

HeapTuple	index_fetch_heap (IndexScanDesc scan)

HeapTuple	index_getnext (IndexScanDesc scan, ScanDirection direction)

int64	index_getbitmap (IndexScanDesc scan, TIDBitmap *bitmap)

IndexBulkDeleteResult *	index_bulk_delete (IndexVacuumInfo info, IndexBulkDeleteResult stats, IndexBulkDeleteCallback callback, void *callback_state)

IndexBulkDeleteResult *	index_vacuum_cleanup (IndexVacuumInfo info, IndexBulkDeleteResult stats)

bool	index_can_return (Relation indexRelation, int attno)

RegProcedure	index_getprocid (Relation irel, AttrNumber attnum, uint16 procnum)

FmgrInfo *	index_getprocinfo (Relation irel, AttrNumber attnum, uint16 procnum)

Macro Definition Documentation

#define CHECK_REL_PROCEDURE ( pname )

Value:

do { \
    if (indexRelation->rd_amroutine->pname == NULL) \
		elog(ERROR, "function %s is not defined for index %s", \
             CppAsString(pname), RelationGetRelationName(indexRelation)); \
} while(0)

Definition at line 112 of file indexam.c.

Referenced by index_beginscan_internal(), index_bulk_delete(), index_insert(), and index_vacuum_cleanup().

#define CHECK_SCAN_PROCEDURE ( pname )

Value:

do { \
    if (scan->indexRelation->rd_amroutine->pname == NULL) \
		elog(ERROR, "function %s is not defined for index %s", \
             CppAsString(pname), RelationGetRelationName(scan->indexRelation)); \
} while(0)

Definition at line 119 of file indexam.c.

Referenced by index_endscan(), index_getbitmap(), index_getnext_tid(), index_markpos(), index_rescan(), and index_restrpos().

#define RELATION_CHECKS

Value:

( \
	AssertMacro(RelationIsValid(indexRelation)), \
	AssertMacro(PointerIsValid(indexRelation->rd_amroutine)), \
	AssertMacro(!ReindexIsProcessingIndex(RelationGetRelid(indexRelation))) \
)

Definition at line 98 of file indexam.c.

Referenced by index_beginscan_internal(), index_bulk_delete(), index_can_return(), index_insert(), index_parallelscan_estimate(), index_parallelscan_initialize(), and index_vacuum_cleanup().

#define SCAN_CHECKS

Value:

( \
	AssertMacro(IndexScanIsValid(scan)), \
	AssertMacro(RelationIsValid(scan->indexRelation)), \
	AssertMacro(PointerIsValid(scan->indexRelation->rd_amroutine)) \
)

Definition at line 105 of file indexam.c.

Referenced by index_endscan(), index_getbitmap(), index_getnext_tid(), index_markpos(), index_parallelrescan(), index_rescan(), and index_restrpos().

Function Documentation

IndexScanDesc index_beginscan	(	Relation	heapRelation,
		Relation	indexRelation,
		Snapshot	snapshot,
		int	nkeys,
		int	norderbys
	)

Definition at line 221 of file indexam.c.

References IndexScanDescData::heapRelation, index_beginscan_internal(), NULL, and IndexScanDescData::xs_snapshot.

Referenced by check_exclusion_or_unique_constraint(), copy_heap_data(), get_actual_variable_range(), IndexNext(), IndexNextWithReorder(), IndexOnlyNext(), RelationFindReplTupleByIndex(), systable_beginscan(), and systable_beginscan_ordered().

 {
     IndexScanDesc scan;
 
     scan = index_beginscan_internal(indexRelation, nkeys, norderbys, snapshot, NULL, false);
 
     /*
      * Save additional parameters into the scandesc.  Everything else was set
      * up by RelationGetIndexScan.
      */
     scan->heapRelation = heapRelation;
     scan->xs_snapshot = snapshot;
 
     return scan;
 }

IndexScanDesc index_beginscan_bitmap	(	Relation	indexRelation,
		Snapshot	snapshot,
		int	nkeys
	)

Definition at line 247 of file indexam.c.

References index_beginscan_internal(), NULL, and IndexScanDescData::xs_snapshot.

Referenced by ExecInitBitmapIndexScan().

 {
     IndexScanDesc scan;
 
     scan = index_beginscan_internal(indexRelation, nkeys, 0, snapshot, NULL, false);
 
     /*
      * Save additional parameters into the scandesc.  Everything else was set
      * up by RelationGetIndexScan.
      */
     scan->xs_snapshot = snapshot;
 
     return scan;
 }

static IndexScanDesc index_beginscan_internal	(	Relation	indexRelation,
		int	nkeys,
		int	norderbys,
		Snapshot	snapshot,
		ParallelIndexScanDesc	pscan,
		bool	temp_snap
	)

static

Definition at line 268 of file indexam.c.

References IndexAmRoutine::ambeginscan, IndexAmRoutine::ampredlocks, CHECK_REL_PROCEDURE, IndexScanDescData::parallel_scan, PredicateLockRelation(), RelationData::rd_amroutine, RELATION_CHECKS, RelationIncrementReferenceCount(), and IndexScanDescData::xs_temp_snap.

Referenced by index_beginscan(), index_beginscan_bitmap(), and index_beginscan_parallel().

 {
     IndexScanDesc scan;
 
     RELATION_CHECKS;
     CHECK_REL_PROCEDURE(ambeginscan);
 
     if (!(indexRelation->rd_amroutine->ampredlocks))
         PredicateLockRelation(indexRelation, snapshot);
 
     /*
      * We hold a reference count to the relcache entry throughout the scan.
      */
     RelationIncrementReferenceCount(indexRelation);
 
     /*
      * Tell the AM to open a scan.
      */
     scan = indexRelation->rd_amroutine->ambeginscan(indexRelation, nkeys,
                                                     norderbys);
     /* Initialize information for parallel scan. */
     scan->parallel_scan = pscan;
     scan->xs_temp_snap = temp_snap;
 
     return scan;
 }

IndexScanDesc index_beginscan_parallel	(	Relation	heaprel,
		Relation	indexrel,
		int	nkeys,
		int	norderbys,
		ParallelIndexScanDesc	pscan
	)

Definition at line 496 of file indexam.c.

References Assert, IndexScanDescData::heapRelation, index_beginscan_internal(), ParallelIndexScanDescData::ps_relid, ParallelIndexScanDescData::ps_snapshot_data, RegisterSnapshot(), RelationGetRelid, RestoreSnapshot(), and IndexScanDescData::xs_snapshot.

Referenced by ExecIndexOnlyScanInitializeDSM(), ExecIndexOnlyScanInitializeWorker(), ExecIndexScanInitializeDSM(), and ExecIndexScanInitializeWorker().

 {
     Snapshot    snapshot;
     IndexScanDesc scan;
 
     Assert(RelationGetRelid(heaprel) == pscan->ps_relid);
     snapshot = RestoreSnapshot(pscan->ps_snapshot_data);
     RegisterSnapshot(snapshot);
     scan = index_beginscan_internal(indexrel, nkeys, norderbys, snapshot,
                                     pscan, true);
 
     /*
      * Save additional parameters into the scandesc.  Everything else was set
      * up by index_beginscan_internal.
      */
     scan->heapRelation = heaprel;
     scan->xs_snapshot = snapshot;
 
     return scan;
 }

IndexBulkDeleteResult* index_bulk_delete	(	IndexVacuumInfo *	info,
		IndexBulkDeleteResult *	stats,
		IndexBulkDeleteCallback	callback,
		void *	callback_state
	)

Definition at line 743 of file indexam.c.

References IndexAmRoutine::ambulkdelete, CHECK_REL_PROCEDURE, IndexVacuumInfo::index, RelationData::rd_amroutine, and RELATION_CHECKS.

Referenced by lazy_vacuum_index(), and validate_index().

 {
     Relation    indexRelation = info->index;
 
     RELATION_CHECKS;
     CHECK_REL_PROCEDURE(ambulkdelete);
 
     return indexRelation->rd_amroutine->ambulkdelete(info, stats,
                                                      callback, callback_state);
 }

bool index_can_return	(	Relation	indexRelation,
		int	attno
	)

Definition at line 783 of file indexam.c.

References IndexAmRoutine::amcanreturn, NULL, RelationData::rd_amroutine, and RELATION_CHECKS.

Referenced by get_relation_info(), and indexam_property().

 {
     RELATION_CHECKS;
 
     /* amcanreturn is optional; assume FALSE if not provided by AM */
     if (indexRelation->rd_amroutine->amcanreturn == NULL)
         return false;
 
     return indexRelation->rd_amroutine->amcanreturn(indexRelation, attno);
 }

void index_close	(	Relation	relation,
		LOCKMODE	lockmode
	)

Definition at line 176 of file indexam.c.

References Assert, LockInfoData::lockRelId, MAX_LOCKMODES, NoLock, RelationData::rd_lockInfo, RelationClose(), and UnlockRelationId().

Referenced by ATExecAddIndex(), ATExecAddIndexConstraint(), ATExecReplicaIdentity(), brin_page_items(), brincostestimate(), bt_index_check_internal(), build_indices(), BuildEventTriggerCache(), check_index_is_clusterable(), CheckIndexCompatible(), close_lo_relation(), copy_heap_data(), DefineIndex(), enum_endpoint(), enum_range_internal(), ExecCloseIndices(), ExecEndBitmapIndexScan(), ExecEndIndexOnlyScan(), ExecEndIndexScan(), ExecRefreshMatView(), get_actual_variable_range(), get_relation_info(), gin_clean_pending_list(), gincostestimate(), hash_bitmap_info(), index_create(), index_drop(), indexam_property(), infer_arbiter_indexes(), InitCatCachePhase2(), lookup_ts_config_cache(), pgstathashindex(), refresh_by_match_merge(), reindex_index(), ReindexIndex(), RelationFindReplTupleByIndex(), RelationGetIndexAttrBitmap(), RelationTruncateIndexes(), systable_endscan(), toast_close_indexes(), transformTableLikeClause(), TryReuseIndex(), unique_key_recheck(), vac_close_indexes(), vac_open_indexes(), and validate_index().

 {
     LockRelId   relid = relation->rd_lockInfo.lockRelId;
 
     Assert(lockmode >= NoLock && lockmode < MAX_LOCKMODES);
 
     /* The relcache does the real work... */
     RelationClose(relation);
 
     if (lockmode != NoLock)
         UnlockRelationId(&relid, lockmode);
 }

void index_endscan ( IndexScanDesc scan )

Definition at line 340 of file indexam.c.

References IndexAmRoutine::amendscan, BufferIsValid, CHECK_SCAN_PROCEDURE, IndexScanDescData::indexRelation, IndexScanEnd(), InvalidBuffer, RelationData::rd_amroutine, RelationDecrementReferenceCount(), ReleaseBuffer(), SCAN_CHECKS, UnregisterSnapshot(), IndexScanDescData::xs_cbuf, IndexScanDescData::xs_snapshot, and IndexScanDescData::xs_temp_snap.

Referenced by check_exclusion_or_unique_constraint(), copy_heap_data(), ExecEndBitmapIndexScan(), ExecEndIndexOnlyScan(), ExecEndIndexScan(), get_actual_variable_range(), RelationFindReplTupleByIndex(), systable_endscan(), and systable_endscan_ordered().

 {
     SCAN_CHECKS;
     CHECK_SCAN_PROCEDURE(amendscan);
 
     /* Release any held pin on a heap page */
     if (BufferIsValid(scan->xs_cbuf))
     {
         ReleaseBuffer(scan->xs_cbuf);
         scan->xs_cbuf = InvalidBuffer;
     }
 
     /* End the AM's scan */
     scan->indexRelation->rd_amroutine->amendscan(scan);
 
     /* Release index refcount acquired by index_beginscan */
     RelationDecrementReferenceCount(scan->indexRelation);
 
     if (scan->xs_temp_snap)
         UnregisterSnapshot(scan->xs_snapshot);
 
     /* Release the scan data structure itself */
     IndexScanEnd(scan);
 }

HeapTuple index_fetch_heap ( IndexScanDesc scan )

Definition at line 583 of file indexam.c.

References BUFFER_LOCK_SHARE, BUFFER_LOCK_UNLOCK, heap_hot_search_buffer(), heap_page_prune_opt(), IndexScanDescData::heapRelation, IndexScanDescData::indexRelation, IsMVCCSnapshot, ItemPointerGetBlockNumber, IndexScanDescData::kill_prior_tuple, LockBuffer(), NULL, pgstat_count_heap_fetch, ReleaseAndReadBuffer(), HeapTupleData::t_self, IndexScanDescData::xactStartedInRecovery, IndexScanDescData::xs_cbuf, IndexScanDescData::xs_continue_hot, IndexScanDescData::xs_ctup, and IndexScanDescData::xs_snapshot.

Referenced by index_getnext(), and IndexOnlyNext().

 {
     ItemPointer tid = &scan->xs_ctup.t_self;
     bool        all_dead = false;
     bool        got_heap_tuple;
 
     /* We can skip the buffer-switching logic if we're in mid-HOT chain. */
     if (!scan->xs_continue_hot)
     {
         /* Switch to correct buffer if we don't have it already */
         Buffer      prev_buf = scan->xs_cbuf;
 
         scan->xs_cbuf = ReleaseAndReadBuffer(scan->xs_cbuf,
                                              scan->heapRelation,
                                              ItemPointerGetBlockNumber(tid));
 
         /*
          * Prune page, but only if we weren't already on this page
          */
         if (prev_buf != scan->xs_cbuf)
             heap_page_prune_opt(scan->heapRelation, scan->xs_cbuf);
     }
 
     /* Obtain share-lock on the buffer so we can examine visibility */
     LockBuffer(scan->xs_cbuf, BUFFER_LOCK_SHARE);
     got_heap_tuple = heap_hot_search_buffer(tid, scan->heapRelation,
                                             scan->xs_cbuf,
                                             scan->xs_snapshot,
                                             &scan->xs_ctup,
                                             &all_dead,
                                             !scan->xs_continue_hot);
     LockBuffer(scan->xs_cbuf, BUFFER_LOCK_UNLOCK);
 
     if (got_heap_tuple)
     {
         /*
          * Only in a non-MVCC snapshot can more than one member of the HOT
          * chain be visible.
          */
         scan->xs_continue_hot = !IsMVCCSnapshot(scan->xs_snapshot);
         pgstat_count_heap_fetch(scan->indexRelation);
         return &scan->xs_ctup;
     }
 
     /* We've reached the end of the HOT chain. */
     scan->xs_continue_hot = false;
 
     /*
      * If we scanned a whole HOT chain and found only dead tuples, tell index
      * AM to kill its entry for that TID (this will take effect in the next
      * amgettuple call, in index_getnext_tid).  We do not do this when in
      * recovery because it may violate MVCC to do so.  See comments in
      * RelationGetIndexScan().
      */
     if (!scan->xactStartedInRecovery)
         scan->kill_prior_tuple = all_dead;
 
     return NULL;
 }

int64 index_getbitmap	(	IndexScanDesc	scan,
		TIDBitmap *	bitmap
	)

Definition at line 713 of file indexam.c.

References IndexAmRoutine::amgetbitmap, CHECK_SCAN_PROCEDURE, IndexScanDescData::indexRelation, IndexScanDescData::kill_prior_tuple, pgstat_count_index_tuples, RelationData::rd_amroutine, and SCAN_CHECKS.

Referenced by MultiExecBitmapIndexScan().

 {
     int64       ntids;
 
     SCAN_CHECKS;
     CHECK_SCAN_PROCEDURE(amgetbitmap);
 
     /* just make sure this is false... */
     scan->kill_prior_tuple = false;
 
     /*
      * have the am's getbitmap proc do all the work.
      */
     ntids = scan->indexRelation->rd_amroutine->amgetbitmap(scan, bitmap);
 
     pgstat_count_index_tuples(scan->indexRelation, ntids);
 
     return ntids;
 }

HeapTuple index_getnext	(	IndexScanDesc	scan,
		ScanDirection	direction
	)

Definition at line 659 of file indexam.c.

References Assert, BufferGetBlockNumber(), BufferIsValid, index_fetch_heap(), index_getnext_tid(), ItemPointerGetBlockNumber, NULL, HeapTupleData::t_self, IndexScanDescData::xs_cbuf, IndexScanDescData::xs_continue_hot, and IndexScanDescData::xs_ctup.

Referenced by check_exclusion_or_unique_constraint(), copy_heap_data(), get_actual_variable_range(), IndexNext(), IndexNextWithReorder(), RelationFindReplTupleByIndex(), systable_getnext(), and systable_getnext_ordered().

 {
     HeapTuple   heapTuple;
     ItemPointer tid;
 
     for (;;)
     {
         if (scan->xs_continue_hot)
         {
             /*
              * We are resuming scan of a HOT chain after having returned an
              * earlier member.  Must still hold pin on current heap page.
              */
             Assert(BufferIsValid(scan->xs_cbuf));
             Assert(ItemPointerGetBlockNumber(&scan->xs_ctup.t_self) ==
                    BufferGetBlockNumber(scan->xs_cbuf));
         }
         else
         {
             /* Time to fetch the next TID from the index */
             tid = index_getnext_tid(scan, direction);
 
             /* If we're out of index entries, we're done */
             if (tid == NULL)
                 break;
         }
 
         /*
          * Fetch the next (or only) visible heap tuple for this index entry.
          * If we don't find anything, loop around and grab the next TID from
          * the index.
          */
         heapTuple = index_fetch_heap(scan);
         if (heapTuple != NULL)
             return heapTuple;
     }
 
     return NULL;                /* failure exit */
 }

ItemPointer index_getnext_tid	(	IndexScanDesc	scan,
		ScanDirection	direction
	)

Definition at line 526 of file indexam.c.

References IndexAmRoutine::amgettuple, Assert, BufferIsValid, CHECK_SCAN_PROCEDURE, IndexScanDescData::indexRelation, InvalidBuffer, IndexScanDescData::kill_prior_tuple, NULL, pgstat_count_index_tuples, RelationData::rd_amroutine, RecentGlobalXmin, ReleaseBuffer(), SCAN_CHECKS, HeapTupleData::t_self, TransactionIdIsValid, IndexScanDescData::xs_cbuf, and IndexScanDescData::xs_ctup.

Referenced by index_getnext(), and IndexOnlyNext().

 {
     bool        found;
 
     SCAN_CHECKS;
     CHECK_SCAN_PROCEDURE(amgettuple);
 
     Assert(TransactionIdIsValid(RecentGlobalXmin));
 
     /*
      * The AM's amgettuple proc finds the next index entry matching the scan
      * keys, and puts the TID into scan->xs_ctup.t_self.  It should also set
      * scan->xs_recheck and possibly scan->xs_itup/scan->xs_hitup, though we
      * pay no attention to those fields here.
      */
     found = scan->indexRelation->rd_amroutine->amgettuple(scan, direction);
 
     /* Reset kill flag immediately for safety */
     scan->kill_prior_tuple = false;
 
     /* If we're out of index entries, we're done */
     if (!found)
     {
         /* ... but first, release any held pin on a heap page */
         if (BufferIsValid(scan->xs_cbuf))
         {
             ReleaseBuffer(scan->xs_cbuf);
             scan->xs_cbuf = InvalidBuffer;
         }
         return NULL;
     }
 
     pgstat_count_index_tuples(scan->indexRelation, 1);
 
     /* Return the TID of the tuple we found. */
     return &scan->xs_ctup.t_self;
 }

RegProcedure index_getprocid	(	Relation	irel,
		AttrNumber	attnum,
		uint16	procnum
	)

Definition at line 821 of file indexam.c.

References IndexAmRoutine::amsupport, Assert, NULL, RelationData::rd_amroutine, and RelationData::rd_support.

Referenced by _hash_init(), gistcanreturn(), inclusion_get_procinfo(), initGinState(), and initGISTstate().

 {
     RegProcedure *loc;
     int         nproc;
     int         procindex;
 
     nproc = irel->rd_amroutine->amsupport;
 
     Assert(procnum > 0 && procnum <= (uint16) nproc);
 
     procindex = (nproc * (attnum - 1)) + (procnum - 1);
 
     loc = irel->rd_support;
 
     Assert(loc != NULL);
 
     return loc[procindex];
 }

FmgrInfo* index_getprocinfo	(	Relation	irel,
		AttrNumber	attnum,
		uint16	procnum
	)

Definition at line 855 of file indexam.c.

References IndexAmRoutine::amsupport, Assert, elog, ERROR, fmgr_info_cxt(), FmgrInfo::fn_oid, InvalidOid, NULL, RelationData::rd_amroutine, RelationData::rd_indexcxt, RelationData::rd_support, RelationData::rd_supportinfo, RegProcedureIsValid, and RelationGetRelationName.

Referenced by _bt_first(), _bt_mkscankey(), _bt_mkscankey_nodata(), _hash_datum2hashkey(), brin_build_desc(), brinbuildCallback(), bringetbitmap(), brininsert(), doPickSplit(), inclusion_get_procinfo(), initBloomState(), initGinState(), initGISTstate(), spgdoinsert(), spgGetCache(), spgLeafTest(), spgWalk(), and union_tuples().

 {
     FmgrInfo   *locinfo;
     int         nproc;
     int         procindex;
 
     nproc = irel->rd_amroutine->amsupport;
 
     Assert(procnum > 0 && procnum <= (uint16) nproc);
 
     procindex = (nproc * (attnum - 1)) + (procnum - 1);
 
     locinfo = irel->rd_supportinfo;
 
     Assert(locinfo != NULL);
 
     locinfo += procindex;
 
     /* Initialize the lookup info if first time through */
     if (locinfo->fn_oid == InvalidOid)
     {
         RegProcedure *loc = irel->rd_support;
         RegProcedure procId;
 
         Assert(loc != NULL);
 
         procId = loc[procindex];
 
         /*
          * Complain if function was not found during IndexSupportInitialize.
          * This should not happen unless the system tables contain bogus
          * entries for the index opclass.  (If an AM wants to allow a support
          * function to be optional, it can use index_getprocid.)
          */
         if (!RegProcedureIsValid(procId))
             elog(ERROR, "missing support function %d for attribute %d of index \"%s\"",
                  procnum, attnum, RelationGetRelationName(irel));
 
         fmgr_info_cxt(procId, locinfo, irel->rd_indexcxt);
     }
 
     return locinfo;
 }

bool index_insert	(	Relation	indexRelation,
		Datum *	values,
		bool *	isnull,
		ItemPointer	heap_t_ctid,
		Relation	heapRelation,
		IndexUniqueCheck	checkUnique,
		IndexInfo *	indexInfo
	)

Definition at line 194 of file indexam.c.

References IndexAmRoutine::aminsert, IndexAmRoutine::ampredlocks, CHECK_REL_PROCEDURE, CheckForSerializableConflictIn(), InvalidBuffer, NULL, RelationData::rd_amroutine, and RELATION_CHECKS.

Referenced by CatalogIndexInsert(), ExecInsertIndexTuples(), toast_save_datum(), unique_key_recheck(), and validate_index_heapscan().

 {
     RELATION_CHECKS;
     CHECK_REL_PROCEDURE(aminsert);
 
     if (!(indexRelation->rd_amroutine->ampredlocks))
         CheckForSerializableConflictIn(indexRelation,
                                        (HeapTuple) NULL,
                                        InvalidBuffer);
 
     return indexRelation->rd_amroutine->aminsert(indexRelation, values, isnull,
                                                  heap_t_ctid, heapRelation,
                                                  checkUnique, indexInfo);
 }

void index_markpos ( IndexScanDesc scan )

Definition at line 370 of file indexam.c.

References IndexAmRoutine::ammarkpos, CHECK_SCAN_PROCEDURE, IndexScanDescData::indexRelation, RelationData::rd_amroutine, and SCAN_CHECKS.

Referenced by ExecIndexMarkPos(), and ExecIndexOnlyMarkPos().

 {
     SCAN_CHECKS;
     CHECK_SCAN_PROCEDURE(ammarkpos);
 
     scan->indexRelation->rd_amroutine->ammarkpos(scan);
 }

Relation index_open	(	Oid	relationId,
		LOCKMODE	lockmode
	)

Definition at line 151 of file indexam.c.

References ereport, errcode(), errmsg(), ERROR, RelationData::rd_rel, relation_open(), RelationGetRelationName, and RELKIND_INDEX.

Referenced by ATExecAddIndex(), ATExecAddIndexConstraint(), ATExecReplicaIdentity(), brin_desummarize_range(), brin_page_items(), brin_summarize_range(), brincostestimate(), bt_index_check_internal(), build_indices(), BuildEventTriggerCache(), check_index_is_clusterable(), CheckIndexCompatible(), copy_heap_data(), DefineIndex(), enum_endpoint(), enum_range_internal(), ExecInitBitmapIndexScan(), ExecInitIndexOnlyScan(), ExecInitIndexScan(), ExecOpenIndices(), ExecRefreshMatView(), get_actual_variable_range(), get_relation_info(), gin_clean_pending_list(), gincostestimate(), hash_bitmap_info(), index_drop(), indexam_property(), infer_arbiter_indexes(), InitCatCachePhase2(), lookup_ts_config_cache(), open_lo_relation(), pgstathashindex(), refresh_by_match_merge(), reindex_index(), ReindexIndex(), RelationFindReplTupleByIndex(), RelationGetIndexAttrBitmap(), RelationTruncateIndexes(), systable_beginscan(), toast_open_indexes(), transformIndexConstraint(), transformTableLikeClause(), TryReuseIndex(), unique_key_recheck(), vac_open_indexes(), and validate_index().

 {
     Relation    r;
 
     r = relation_open(relationId, lockmode);
 
     if (r->rd_rel->relkind != RELKIND_INDEX)
         ereport(ERROR,
                 (errcode(ERRCODE_WRONG_OBJECT_TYPE),
                  errmsg("\"%s\" is not an index",
                         RelationGetRelationName(r))));
 
     return r;
 }

void index_parallelrescan ( IndexScanDesc scan )

Definition at line 481 of file indexam.c.

References IndexAmRoutine::amparallelrescan, IndexScanDescData::indexRelation, NULL, RelationData::rd_amroutine, and SCAN_CHECKS.

Referenced by ExecReScanIndexOnlyScan(), and ExecReScanIndexScan().

 {
     SCAN_CHECKS;
 
     /* amparallelrescan is optional; assume no-op if not provided by AM */
     if (scan->indexRelation->rd_amroutine->amparallelrescan != NULL)
         scan->indexRelation->rd_amroutine->amparallelrescan(scan);
 }

Size index_parallelscan_estimate	(	Relation	indexRelation,
		Snapshot	snapshot
	)

Definition at line 417 of file indexam.c.

References add_size(), IndexAmRoutine::amestimateparallelscan, EstimateSnapshotSpace(), MAXALIGN, NULL, offsetof, RelationData::rd_amroutine, and RELATION_CHECKS.

Referenced by ExecIndexOnlyScanEstimate(), and ExecIndexScanEstimate().

 {
     Size        nbytes;
 
     RELATION_CHECKS;
 
     nbytes = offsetof(ParallelIndexScanDescData, ps_snapshot_data);
     nbytes = add_size(nbytes, EstimateSnapshotSpace(snapshot));
     nbytes = MAXALIGN(nbytes);
 
     /*
      * If amestimateparallelscan is not provided, assume there is no
      * AM-specific data needed.  (It's hard to believe that could work, but
      * it's easy enough to cater to it here.)
      */
     if (indexRelation->rd_amroutine->amestimateparallelscan != NULL)
         nbytes = add_size(nbytes,
                           indexRelation->rd_amroutine->amestimateparallelscan());
 
     return nbytes;
 }

void index_parallelscan_initialize	(	Relation	heapRelation,
		Relation	indexRelation,
		Snapshot	snapshot,
		ParallelIndexScanDesc	target
	)

Definition at line 450 of file indexam.c.

References add_size(), IndexAmRoutine::aminitparallelscan, EstimateSnapshotSpace(), MAXALIGN, NULL, offsetof, OffsetToPointer, ParallelIndexScanDescData::ps_indexid, ParallelIndexScanDescData::ps_offset, ParallelIndexScanDescData::ps_relid, ParallelIndexScanDescData::ps_snapshot_data, RelationData::rd_amroutine, RELATION_CHECKS, RelationGetRelid, and SerializeSnapshot().

Referenced by ExecIndexOnlyScanInitializeDSM(), and ExecIndexScanInitializeDSM().

 {
     Size        offset;
 
     RELATION_CHECKS;
 
     offset = add_size(offsetof(ParallelIndexScanDescData, ps_snapshot_data),
                       EstimateSnapshotSpace(snapshot));
     offset = MAXALIGN(offset);
 
     target->ps_relid = RelationGetRelid(heapRelation);
     target->ps_indexid = RelationGetRelid(indexRelation);
     target->ps_offset = offset;
     SerializeSnapshot(snapshot, target->ps_snapshot_data);
 
     /* aminitparallelscan is optional; assume no-op if not provided by AM */
     if (indexRelation->rd_amroutine->aminitparallelscan != NULL)
     {
         void       *amtarget;
 
         amtarget = OffsetToPointer(target, offset);
         indexRelation->rd_amroutine->aminitparallelscan(amtarget);
     }
 }

void index_rescan	(	IndexScanDesc	scan,
		ScanKey	keys,
		int	nkeys,
		ScanKey	orderbys,
		int	norderbys
	)

Definition at line 310 of file indexam.c.

References IndexAmRoutine::amrescan, Assert, BufferIsValid, CHECK_SCAN_PROCEDURE, IndexScanDescData::indexRelation, InvalidBuffer, IndexScanDescData::kill_prior_tuple, IndexScanDescData::numberOfKeys, IndexScanDescData::numberOfOrderBys, RelationData::rd_amroutine, ReleaseBuffer(), SCAN_CHECKS, IndexScanDescData::xs_cbuf, and IndexScanDescData::xs_continue_hot.

Referenced by check_exclusion_or_unique_constraint(), copy_heap_data(), ExecIndexOnlyScanInitializeDSM(), ExecIndexOnlyScanInitializeWorker(), ExecIndexScanInitializeDSM(), ExecIndexScanInitializeWorker(), ExecInitBitmapIndexScan(), ExecReScanBitmapIndexScan(), ExecReScanIndexOnlyScan(), ExecReScanIndexScan(), get_actual_variable_range(), IndexNext(), IndexNextWithReorder(), IndexOnlyNext(), MultiExecBitmapIndexScan(), RelationFindReplTupleByIndex(), systable_beginscan(), and systable_beginscan_ordered().

 {
     SCAN_CHECKS;
     CHECK_SCAN_PROCEDURE(amrescan);
 
     Assert(nkeys == scan->numberOfKeys);
     Assert(norderbys == scan->numberOfOrderBys);
 
     /* Release any held pin on a heap page */
     if (BufferIsValid(scan->xs_cbuf))
     {
         ReleaseBuffer(scan->xs_cbuf);
         scan->xs_cbuf = InvalidBuffer;
     }
 
     scan->xs_continue_hot = false;
 
     scan->kill_prior_tuple = false; /* for safety */
 
     scan->indexRelation->rd_amroutine->amrescan(scan, keys, nkeys,
                                                 orderbys, norderbys);
 }

void index_restrpos ( IndexScanDesc scan )

Definition at line 395 of file indexam.c.

References IndexAmRoutine::amrestrpos, Assert, CHECK_SCAN_PROCEDURE, IndexScanDescData::indexRelation, IsMVCCSnapshot, IndexScanDescData::kill_prior_tuple, RelationData::rd_amroutine, SCAN_CHECKS, IndexScanDescData::xs_continue_hot, and IndexScanDescData::xs_snapshot.

Referenced by ExecIndexOnlyRestrPos(), and ExecIndexRestrPos().

 {
     Assert(IsMVCCSnapshot(scan->xs_snapshot));
 
     SCAN_CHECKS;
     CHECK_SCAN_PROCEDURE(amrestrpos);
 
     scan->xs_continue_hot = false;
 
     scan->kill_prior_tuple = false; /* for safety */
 
     scan->indexRelation->rd_amroutine->amrestrpos(scan);
 }

IndexBulkDeleteResult* index_vacuum_cleanup	(	IndexVacuumInfo *	info,
		IndexBulkDeleteResult *	stats
	)

Definition at line 764 of file indexam.c.

References IndexAmRoutine::amvacuumcleanup, CHECK_REL_PROCEDURE, IndexVacuumInfo::index, RelationData::rd_amroutine, and RELATION_CHECKS.

Referenced by do_analyze_rel(), and lazy_cleanup_index().

 {
     Relation    indexRelation = info->index;
 
     RELATION_CHECKS;
     CHECK_REL_PROCEDURE(amvacuumcleanup);
 
     return indexRelation->rd_amroutine->amvacuumcleanup(info, stats);
 }

Macros

Functions

Macro Definition Documentation

Function Documentation