indexam.c File Reference

#include "postgres.h"
#include "access/amapi.h"
#include "access/relation.h"
#include "access/reloptions.h"
#include "access/relscan.h"
#include "access/tableam.h"
#include "catalog/index.h"
#include "catalog/pg_type.h"
#include "nodes/execnodes.h"
#include "pgstat.h"
#include "storage/lmgr.h"
#include "storage/predicate.h"
#include "utils/ruleutils.h"
#include "utils/snapmgr.h"
#include "utils/syscache.h"

Include dependency graph for indexam.c:

Go to the source code of this file.

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)
static void	validate_relation_kind (Relation r)
Relation	index_open (Oid relationId, LOCKMODE lockmode)
Relation	try_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, bool indexUnchanged, IndexInfo *indexInfo)
void	index_insert_cleanup (Relation indexRelation, 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, int nkeys, int norderbys, 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)
bool	index_fetch_heap (IndexScanDesc scan, TupleTableSlot *slot)
bool	index_getnext_slot (IndexScanDesc scan, ScanDirection direction, TupleTableSlot *slot)
int64	index_getbitmap (IndexScanDesc scan, TIDBitmap *bitmap)
IndexBulkDeleteResult *	index_bulk_delete (IndexVacuumInfo *info, IndexBulkDeleteResult *istat, IndexBulkDeleteCallback callback, void *callback_state)
IndexBulkDeleteResult *	index_vacuum_cleanup (IndexVacuumInfo *info, IndexBulkDeleteResult *istat)
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)
void	index_store_float8_orderby_distances (IndexScanDesc scan, Oid *orderByTypes, IndexOrderByDistance *distances, bool recheckOrderBy)
bytea *	index_opclass_options (Relation indrel, AttrNumber attnum, Datum attoptions, bool validate)

Macro Definition Documentation

CHECK_REL_PROCEDURE

#define CHECK_REL_PROCEDURE

(

pname

)

Value:

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

Definition at line 93 of file indexam.c.

CHECK_SCAN_PROCEDURE

#define CHECK_SCAN_PROCEDURE

(

pname

)

Value:

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

Definition at line 100 of file indexam.c.

RELATION_CHECKS

#define RELATION_CHECKS

Value:

do { \
    Assert(RelationIsValid(indexRelation)); \
    Assert(PointerIsValid(indexRelation->rd_indam)); \
    if (unlikely(ReindexIsProcessingIndex(RelationGetRelid(indexRelation)))) \
        ereport(ERROR, \
                (errcode(ERRCODE_FEATURE_NOT_SUPPORTED), \
                 errmsg("cannot access index \"%s\" while it is being reindexed", \
                        RelationGetRelationName(indexRelation)))); \
} while(0)

Definition at line 75 of file indexam.c.

SCAN_CHECKS

#define SCAN_CHECKS

Value:

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

Definition at line 86 of file indexam.c.

Function Documentation

index_beginscan()

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

Definition at line 256 of file indexam.c.

{
    IndexScanDesc scan;
 
    Assert(snapshot != InvalidSnapshot);
 
    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;
 
    /* prepare to fetch index matches from table */
    scan->xs_heapfetch = table_index_fetch_begin(heapRelation);
 
    return scan;
}

References Assert, IndexScanDescData::heapRelation, index_beginscan_internal(), InvalidSnapshot, table_index_fetch_begin(), IndexScanDescData::xs_heapfetch, and IndexScanDescData::xs_snapshot.

Referenced by check_exclusion_or_unique_constraint(), get_actual_variable_endpoint(), heapam_relation_copy_for_cluster(), IndexNext(), IndexNextWithReorder(), IndexOnlyNext(), RelationFindReplTupleByIndex(), systable_beginscan(), and systable_beginscan_ordered().

index_beginscan_bitmap()

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

Definition at line 287 of file indexam.c.

{
    IndexScanDesc scan;
 
    Assert(snapshot != InvalidSnapshot);
 
    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;
}

References Assert, index_beginscan_internal(), InvalidSnapshot, and IndexScanDescData::xs_snapshot.

Referenced by ExecInitBitmapIndexScan().

index_beginscan_internal()

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

static

Definition at line 310 of file indexam.c.

{
    IndexScanDesc scan;
 
    RELATION_CHECKS;
    CHECK_REL_PROCEDURE(ambeginscan);
 
    if (!(indexRelation->rd_indam->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_indam->ambeginscan(indexRelation, nkeys,
                                                norderbys);
    /* Initialize information for parallel scan. */
    scan->parallel_scan = pscan;
    scan->xs_temp_snap = temp_snap;
 
    return scan;
}

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

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

index_beginscan_parallel()

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

Definition at line 541 of file indexam.c.

{
    Snapshot    snapshot;
    IndexScanDesc scan;
 
    Assert(RelFileLocatorEquals(heaprel->rd_locator, pscan->ps_locator));
    Assert(RelFileLocatorEquals(indexrel->rd_locator, pscan->ps_indexlocator));
 
    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;
 
    /* prepare to fetch index matches from table */
    scan->xs_heapfetch = table_index_fetch_begin(heaprel);
 
    return scan;
}

References Assert, IndexScanDescData::heapRelation, index_beginscan_internal(), ParallelIndexScanDescData::ps_indexlocator, ParallelIndexScanDescData::ps_locator, ParallelIndexScanDescData::ps_snapshot_data, RelationData::rd_locator, RegisterSnapshot(), RelFileLocatorEquals, RestoreSnapshot(), table_index_fetch_begin(), IndexScanDescData::xs_heapfetch, and IndexScanDescData::xs_snapshot.

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

index_bulk_delete()

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

Definition at line 750 of file indexam.c.

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

References IndexAmRoutine::ambulkdelete, callback(), CHECK_REL_PROCEDURE, IndexVacuumInfo::index, RelationData::rd_indam, and RELATION_CHECKS.

Referenced by vac_bulkdel_one_index(), and validate_index().

index_can_return()

bool index_can_return	(	Relation	indexRelation,
		int	attno
	)

Definition at line 790 of file indexam.c.

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

References IndexAmRoutine::amcanreturn, RelationData::rd_indam, and RELATION_CHECKS.

Referenced by get_relation_info(), and indexam_property().

index_close()

void index_close	(	Relation	relation,
		LOCKMODE	lockmode
	)

Definition at line 177 of file indexam.c.

{
    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);
}

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

Referenced by _brin_parallel_build_main(), _bt_parallel_build_main(), ATExecAddIndex(), ATExecAddIndexConstraint(), ATExecReplicaIdentity(), AttachPartitionEnsureIndexes(), brin_page_items(), brincostestimate(), bt_index_check_internal(), build_index_value_desc(), build_indices(), BuildEventTriggerCache(), check_index_is_clusterable(), CheckIndexCompatible(), close_lo_relation(), copy_table_data(), DefineIndex(), DefineRelation(), DetachPartitionFinalize(), enum_endpoint(), enum_range_internal(), ExecCloseIndices(), ExecEndBitmapIndexScan(), ExecEndIndexOnlyScan(), ExecEndIndexScan(), expandTableLikeClause(), FindReplTupleInLocalRel(), FindUsableIndexForReplicaIdentityFull(), get_actual_variable_range(), get_relation_info(), gin_clean_pending_list(), gincostestimate(), gist_page_items(), hash_bitmap_info(), index_concurrently_build(), index_concurrently_create_copy(), index_concurrently_set_dead(), index_create(), index_drop(), indexam_property(), infer_arbiter_indexes(), InitCatCachePhase2(), lookup_ts_config_cache(), pg_nextoid(), pgstathashindex(), plan_create_index_workers(), refresh_by_match_merge(), RefreshMatViewByOid(), reindex_index(), ReindexRelationConcurrently(), RelationFindReplTupleByIndex(), RelationGetIndexAttrBitmap(), RelationTruncateIndexes(), SetIndexStorageProperties(), systable_endscan(), toast_close_indexes(), TryReuseIndex(), vac_close_indexes(), vac_open_indexes(), and validate_index().

index_endscan()

void index_endscan

(

IndexScanDesc

scan

)

Definition at line 378 of file indexam.c.

{
    SCAN_CHECKS;
    CHECK_SCAN_PROCEDURE(amendscan);
 
    /* Release resources (like buffer pins) from table accesses */
    if (scan->xs_heapfetch)
    {
        table_index_fetch_end(scan->xs_heapfetch);
        scan->xs_heapfetch = NULL;
    }
 
    /* End the AM's scan */
    scan->indexRelation->rd_indam->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);
}

References IndexAmRoutine::amendscan, CHECK_SCAN_PROCEDURE, IndexScanDescData::indexRelation, IndexScanEnd(), RelationData::rd_indam, RelationDecrementReferenceCount(), SCAN_CHECKS, table_index_fetch_end(), UnregisterSnapshot(), IndexScanDescData::xs_heapfetch, IndexScanDescData::xs_snapshot, and IndexScanDescData::xs_temp_snap.

Referenced by check_exclusion_or_unique_constraint(), ExecEndBitmapIndexScan(), ExecEndIndexOnlyScan(), ExecEndIndexScan(), get_actual_variable_endpoint(), heapam_relation_copy_for_cluster(), RelationFindReplTupleByIndex(), systable_endscan(), and systable_endscan_ordered().

index_fetch_heap()

bool index_fetch_heap	(	IndexScanDesc	scan,
		TupleTableSlot *	slot
	)

Definition at line 634 of file indexam.c.

{
    bool        all_dead = false;
    bool        found;
 
    found = table_index_fetch_tuple(scan->xs_heapfetch, &scan->xs_heaptid,
                                    scan->xs_snapshot, slot,
                                    &scan->xs_heap_continue, &all_dead);
 
    if (found)
        pgstat_count_heap_fetch(scan->indexRelation);
 
    /*
     * 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 found;
}

References IndexScanDescData::indexRelation, IndexScanDescData::kill_prior_tuple, pgstat_count_heap_fetch, table_index_fetch_tuple(), IndexScanDescData::xactStartedInRecovery, IndexScanDescData::xs_heap_continue, IndexScanDescData::xs_heapfetch, IndexScanDescData::xs_heaptid, and IndexScanDescData::xs_snapshot.

Referenced by get_actual_variable_endpoint(), index_getnext_slot(), and IndexOnlyNext().

index_getbitmap()

int64 index_getbitmap	(	IndexScanDesc	scan,
		TIDBitmap *	bitmap
	)

Definition at line 720 of file indexam.c.

{
    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_indam->amgetbitmap(scan, bitmap);
 
    pgstat_count_index_tuples(scan->indexRelation, ntids);
 
    return ntids;
}

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

Referenced by MultiExecBitmapIndexScan().

index_getnext_slot()

bool index_getnext_slot	(	IndexScanDesc	scan,
		ScanDirection	direction,
		TupleTableSlot *	slot
	)

Definition at line 675 of file indexam.c.

{
    for (;;)
    {
        if (!scan->xs_heap_continue)
        {
            ItemPointer tid;
 
            /* 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;
 
            Assert(ItemPointerEquals(tid, &scan->xs_heaptid));
        }
 
        /*
         * 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.
         */
        Assert(ItemPointerIsValid(&scan->xs_heaptid));
        if (index_fetch_heap(scan, slot))
            return true;
    }
 
    return false;
}

References Assert, index_fetch_heap(), index_getnext_tid(), ItemPointerEquals(), ItemPointerIsValid(), IndexScanDescData::xs_heap_continue, and IndexScanDescData::xs_heaptid.

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

index_getnext_tid()

ItemPointer index_getnext_tid	(	IndexScanDesc	scan,
		ScanDirection	direction
	)

Definition at line 576 of file indexam.c.

{
    bool        found;
 
    SCAN_CHECKS;
    CHECK_SCAN_PROCEDURE(amgettuple);
 
    /* XXX: we should assert that a snapshot is pushed or registered */
    Assert(TransactionIdIsValid(RecentXmin));
 
    /*
     * The AM's amgettuple proc finds the next index entry matching the scan
     * keys, and puts the TID into scan->xs_heaptid.  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_indam->amgettuple(scan, direction);
 
    /* Reset kill flag immediately for safety */
    scan->kill_prior_tuple = false;
    scan->xs_heap_continue = false;
 
    /* If we're out of index entries, we're done */
    if (!found)
    {
        /* release resources (like buffer pins) from table accesses */
        if (scan->xs_heapfetch)
            table_index_fetch_reset(scan->xs_heapfetch);
 
        return NULL;
    }
    Assert(ItemPointerIsValid(&scan->xs_heaptid));
 
    pgstat_count_index_tuples(scan->indexRelation, 1);
 
    /* Return the TID of the tuple we found. */
    return &scan->xs_heaptid;
}

References IndexAmRoutine::amgettuple, Assert, CHECK_SCAN_PROCEDURE, IndexScanDescData::indexRelation, ItemPointerIsValid(), IndexScanDescData::kill_prior_tuple, pgstat_count_index_tuples, RelationData::rd_indam, RecentXmin, SCAN_CHECKS, table_index_fetch_reset(), TransactionIdIsValid, IndexScanDescData::xs_heap_continue, IndexScanDescData::xs_heapfetch, and IndexScanDescData::xs_heaptid.

Referenced by get_actual_variable_endpoint(), index_getnext_slot(), and IndexOnlyNext().

index_getprocid()

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

Definition at line 828 of file indexam.c.

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

References IndexAmRoutine::amsupport, Assert, attnum, RelationData::rd_indam, and RelationData::rd_support.

Referenced by _hash_init(), bloom_get_procinfo(), gistbuild(), gistcanreturn(), inclusion_get_procinfo(), index_opclass_options(), initGinState(), initGISTstate(), minmax_multi_get_procinfo(), spgdoinsert(), and spgGetCache().

index_getprocinfo()

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

Definition at line 862 of file indexam.c.

{
    FmgrInfo   *locinfo;
    int         nproc;
    int         optsproc;
    int         procindex;
 
    nproc = irel->rd_indam->amsupport;
    optsproc = irel->rd_indam->amoptsprocnum;
 
    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);
 
        if (procnum != optsproc)
        {
            /* Initialize locinfo->fn_expr with opclass options Const */
            bytea     **attoptions = RelationGetIndexAttOptions(irel, false);
            MemoryContext oldcxt = MemoryContextSwitchTo(irel->rd_indexcxt);
 
            set_fn_opclass_options(locinfo, attoptions[attnum - 1]);
 
            MemoryContextSwitchTo(oldcxt);
        }
    }
 
    return locinfo;
}

References IndexAmRoutine::amoptsprocnum, IndexAmRoutine::amsupport, Assert, attnum, elog, ERROR, fmgr_info_cxt(), FmgrInfo::fn_oid, InvalidOid, MemoryContextSwitchTo(), RelationData::rd_indam, RelationData::rd_indexcxt, RelationData::rd_support, RelationData::rd_supportinfo, RegProcedureIsValid, RelationGetIndexAttOptions(), RelationGetRelationName, and set_fn_opclass_options().

Referenced by _bt_first(), _bt_mkscankey(), _bt_setup_array_cmp(), _hash_datum2hashkey(), add_values_to_range(), bloom_get_procinfo(), brin_build_desc(), bringetbitmap(), doPickSplit(), inclusion_get_procinfo(), index_opclass_options(), initBloomState(), initGinState(), initGISTstate(), minmax_multi_get_procinfo(), spgbeginscan(), spgdoinsert(), spgGetCache(), and union_tuples().

index_insert()

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

Definition at line 213 of file indexam.c.

{
    RELATION_CHECKS;
    CHECK_REL_PROCEDURE(aminsert);
 
    if (!(indexRelation->rd_indam->ampredlocks))
        CheckForSerializableConflictIn(indexRelation,
                                       (ItemPointer) NULL,
                                       InvalidBlockNumber);
 
    return indexRelation->rd_indam->aminsert(indexRelation, values, isnull,
                                             heap_t_ctid, heapRelation,
                                             checkUnique, indexUnchanged,
                                             indexInfo);
}

References IndexAmRoutine::aminsert, IndexAmRoutine::ampredlocks, CHECK_REL_PROCEDURE, CheckForSerializableConflictIn(), InvalidBlockNumber, RelationData::rd_indam, RELATION_CHECKS, and values.

Referenced by CatalogIndexInsert(), ExecInsertIndexTuples(), heapam_index_validate_scan(), and toast_save_datum().

index_insert_cleanup()

void index_insert_cleanup	(	Relation	indexRelation,
		IndexInfo *	indexInfo
	)

Definition at line 241 of file indexam.c.

{
    RELATION_CHECKS;
 
    if (indexRelation->rd_indam->aminsertcleanup)
        indexRelation->rd_indam->aminsertcleanup(indexRelation, indexInfo);
}

References IndexAmRoutine::aminsertcleanup, RelationData::rd_indam, and RELATION_CHECKS.

Referenced by ExecCloseIndices(), and validate_index().

index_markpos()

void index_markpos

(

IndexScanDesc

scan

)

Definition at line 408 of file indexam.c.

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

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

Referenced by ExecIndexMarkPos(), and ExecIndexOnlyMarkPos().

index_opclass_options()

bytea* index_opclass_options	(	Relation	indrel,
		AttrNumber	attnum,
		Datum	attoptions,
		bool	validate
	)

Definition at line 998 of file indexam.c.

{
    int         amoptsprocnum = indrel->rd_indam->amoptsprocnum;
    Oid         procid = InvalidOid;
    FmgrInfo   *procinfo;
    local_relopts relopts;
 
    /* fetch options support procedure if specified */
    if (amoptsprocnum != 0)
        procid = index_getprocid(indrel, attnum, amoptsprocnum);
 
    if (!OidIsValid(procid))
    {
        Oid         opclass;
        Datum       indclassDatum;
        oidvector  *indclass;
 
        if (!DatumGetPointer(attoptions))
            return NULL;        /* ok, no options, no procedure */
 
        /*
         * Report an error if the opclass's options-parsing procedure does not
         * exist but the opclass options are specified.
         */
        indclassDatum = SysCacheGetAttrNotNull(INDEXRELID, indrel->rd_indextuple,
                                               Anum_pg_index_indclass);
        indclass = (oidvector *) DatumGetPointer(indclassDatum);
        opclass = indclass->values[attnum - 1];
 
        ereport(ERROR,
                (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                 errmsg("operator class %s has no options",
                        generate_opclass_name(opclass))));
    }
 
    init_local_reloptions(&relopts, 0);
 
    procinfo = index_getprocinfo(indrel, attnum, amoptsprocnum);
 
    (void) FunctionCall1(procinfo, PointerGetDatum(&relopts));
 
    return build_local_reloptions(&relopts, attoptions, validate);
}

References IndexAmRoutine::amoptsprocnum, attnum, build_local_reloptions(), DatumGetPointer(), ereport, errcode(), errmsg(), ERROR, FunctionCall1, generate_opclass_name(), index_getprocid(), index_getprocinfo(), init_local_reloptions(), InvalidOid, OidIsValid, PointerGetDatum(), RelationData::rd_indam, RelationData::rd_indextuple, SysCacheGetAttrNotNull(), and oidvector::values.

Referenced by index_create(), and RelationGetIndexAttOptions().

index_open()

Relation index_open	(	Oid	relationId,
		LOCKMODE	lockmode
	)

Definition at line 133 of file indexam.c.

{
    Relation    r;
 
    r = relation_open(relationId, lockmode);
 
    validate_relation_kind(r);
 
    return r;
}

References relation_open(), and validate_relation_kind().

Referenced by _brin_parallel_build_main(), _bt_parallel_build_main(), ATExecAddIndex(), ATExecAddIndexConstraint(), ATExecReplicaIdentity(), AttachPartitionEnsureIndexes(), brin_desummarize_range(), brin_page_items(), brin_summarize_range(), brincostestimate(), bt_index_check_internal(), build_index_value_desc(), build_indices(), BuildEventTriggerCache(), check_index_is_clusterable(), CheckIndexCompatible(), copy_table_data(), DefineIndex(), DefineRelation(), DetachPartitionFinalize(), enum_endpoint(), enum_range_internal(), ExecInitBitmapIndexScan(), ExecInitIndexOnlyScan(), ExecInitIndexScan(), ExecOpenIndices(), expandTableLikeClause(), FindReplTupleInLocalRel(), FindUsableIndexForReplicaIdentityFull(), get_actual_variable_range(), get_relation_info(), gin_clean_pending_list(), gincostestimate(), gist_page_items(), index_concurrently_build(), index_concurrently_create_copy(), index_concurrently_set_dead(), index_drop(), indexam_property(), infer_arbiter_indexes(), InitCatCachePhase2(), lookup_ts_config_cache(), open_lo_relation(), pg_nextoid(), plan_create_index_workers(), refresh_by_match_merge(), RefreshMatViewByOid(), reindex_index(), ReindexRelationConcurrently(), RelationFindReplTupleByIndex(), RelationGetIndexAttrBitmap(), RelationTruncateIndexes(), SetIndexStorageProperties(), systable_beginscan(), toast_open_indexes(), transformIndexConstraint(), TryReuseIndex(), vac_open_indexes(), and validate_index().

index_parallelrescan()

void index_parallelrescan

(

IndexScanDesc

scan

)

Definition at line 523 of file indexam.c.

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

References IndexAmRoutine::amparallelrescan, IndexScanDescData::indexRelation, RelationData::rd_indam, SCAN_CHECKS, table_index_fetch_reset(), and IndexScanDescData::xs_heapfetch.

Referenced by ExecIndexOnlyScanReInitializeDSM(), and ExecIndexScanReInitializeDSM().

index_parallelscan_estimate()

Size index_parallelscan_estimate	(	Relation	indexRelation,
		int	nkeys,
		int	norderbys,
		Snapshot	snapshot
	)

Definition at line 453 of file indexam.c.

{
    Size        nbytes;
 
    Assert(snapshot != InvalidSnapshot);
 
    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_indam->amestimateparallelscan != NULL)
        nbytes = add_size(nbytes,
                          indexRelation->rd_indam->amestimateparallelscan(nkeys,
                                                                          norderbys));
 
    return nbytes;
}

References add_size(), IndexAmRoutine::amestimateparallelscan, Assert, EstimateSnapshotSpace(), InvalidSnapshot, MAXALIGN, RelationData::rd_indam, and RELATION_CHECKS.

Referenced by ExecIndexOnlyScanEstimate(), and ExecIndexScanEstimate().

index_parallelscan_initialize()

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

Definition at line 490 of file indexam.c.

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

References add_size(), IndexAmRoutine::aminitparallelscan, Assert, EstimateSnapshotSpace(), InvalidSnapshot, MAXALIGN, OffsetToPointer, ParallelIndexScanDescData::ps_indexlocator, ParallelIndexScanDescData::ps_locator, ParallelIndexScanDescData::ps_offset, ParallelIndexScanDescData::ps_snapshot_data, RelationData::rd_indam, RelationData::rd_locator, RELATION_CHECKS, and SerializeSnapshot().

Referenced by ExecIndexOnlyScanInitializeDSM(), and ExecIndexScanInitializeDSM().

index_rescan()

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

Definition at line 352 of file indexam.c.

{
    SCAN_CHECKS;
    CHECK_SCAN_PROCEDURE(amrescan);
 
    Assert(nkeys == scan->numberOfKeys);
    Assert(norderbys == scan->numberOfOrderBys);
 
    /* Release resources (like buffer pins) from table accesses */
    if (scan->xs_heapfetch)
        table_index_fetch_reset(scan->xs_heapfetch);
 
    scan->kill_prior_tuple = false; /* for safety */
    scan->xs_heap_continue = false;
 
    scan->indexRelation->rd_indam->amrescan(scan, keys, nkeys,
                                            orderbys, norderbys);
}

References IndexAmRoutine::amrescan, Assert, CHECK_SCAN_PROCEDURE, IndexScanDescData::indexRelation, IndexScanDescData::kill_prior_tuple, IndexScanDescData::numberOfKeys, IndexScanDescData::numberOfOrderBys, RelationData::rd_indam, SCAN_CHECKS, table_index_fetch_reset(), IndexScanDescData::xs_heap_continue, and IndexScanDescData::xs_heapfetch.

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

index_restrpos()

void index_restrpos

(

IndexScanDesc

scan

)

Definition at line 432 of file indexam.c.

{
    Assert(IsMVCCSnapshot(scan->xs_snapshot));
 
    SCAN_CHECKS;
    CHECK_SCAN_PROCEDURE(amrestrpos);
 
    /* release resources (like buffer pins) from table accesses */
    if (scan->xs_heapfetch)
        table_index_fetch_reset(scan->xs_heapfetch);
 
    scan->kill_prior_tuple = false; /* for safety */
    scan->xs_heap_continue = false;
 
    scan->indexRelation->rd_indam->amrestrpos(scan);
}

References IndexAmRoutine::amrestrpos, Assert, CHECK_SCAN_PROCEDURE, IndexScanDescData::indexRelation, IsMVCCSnapshot, IndexScanDescData::kill_prior_tuple, RelationData::rd_indam, SCAN_CHECKS, table_index_fetch_reset(), IndexScanDescData::xs_heap_continue, IndexScanDescData::xs_heapfetch, and IndexScanDescData::xs_snapshot.

Referenced by ExecIndexOnlyRestrPos(), and ExecIndexRestrPos().

index_store_float8_orderby_distances()

void index_store_float8_orderby_distances	(	IndexScanDesc	scan,
		Oid *	orderByTypes,
		IndexOrderByDistance *	distances,
		bool	recheckOrderBy
	)

Definition at line 930 of file indexam.c.

{
    int         i;
 
    Assert(distances || !recheckOrderBy);
 
    scan->xs_recheckorderby = recheckOrderBy;
 
    for (i = 0; i < scan->numberOfOrderBys; i++)
    {
        if (orderByTypes[i] == FLOAT8OID)
        {
#ifndef USE_FLOAT8_BYVAL
            /* must free any old value to avoid memory leakage */
            if (!scan->xs_orderbynulls[i])
                pfree(DatumGetPointer(scan->xs_orderbyvals[i]));
#endif
            if (distances && !distances[i].isnull)
            {
                scan->xs_orderbyvals[i] = Float8GetDatum(distances[i].value);
                scan->xs_orderbynulls[i] = false;
            }
            else
            {
                scan->xs_orderbyvals[i] = (Datum) 0;
                scan->xs_orderbynulls[i] = true;
            }
        }
        else if (orderByTypes[i] == FLOAT4OID)
        {
            /* convert distance function's result to ORDER BY type */
            if (distances && !distances[i].isnull)
            {
                scan->xs_orderbyvals[i] = Float4GetDatum((float4) distances[i].value);
                scan->xs_orderbynulls[i] = false;
            }
            else
            {
                scan->xs_orderbyvals[i] = (Datum) 0;
                scan->xs_orderbynulls[i] = true;
            }
        }
        else
        {
            /*
             * If the ordering operator's return value is anything else, we
             * don't know how to convert the float8 bound calculated by the
             * distance function to that.  The executor won't actually need
             * the order by values we return here, if there are no lossy
             * results, so only insist on converting if the *recheck flag is
             * set.
             */
            if (scan->xs_recheckorderby)
                elog(ERROR, "ORDER BY operator must return float8 or float4 if the distance function is lossy");
            scan->xs_orderbynulls[i] = true;
        }
    }
}

References Assert, DatumGetPointer(), elog, ERROR, Float4GetDatum(), Float8GetDatum(), i, IndexScanDescData::numberOfOrderBys, pfree(), value, IndexScanDescData::xs_orderbynulls, IndexScanDescData::xs_orderbyvals, and IndexScanDescData::xs_recheckorderby.

Referenced by getNextNearest(), and spggettuple().

index_vacuum_cleanup()

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

Definition at line 771 of file indexam.c.

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

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

Referenced by do_analyze_rel(), and vac_cleanup_one_index().

try_index_open()

Relation try_index_open	(	Oid	relationId,
		LOCKMODE	lockmode
	)

Definition at line 152 of file indexam.c.

{
    Relation    r;
 
    r = try_relation_open(relationId, lockmode);
 
    /* leave if index does not exist */
    if (!r)
        return NULL;
 
    validate_relation_kind(r);
 
    return r;
}

References try_relation_open(), and validate_relation_kind().

Referenced by reindex_index().

validate_relation_kind()

static void validate_relation_kind ( Relation  r )

inlinestatic

Definition at line 197 of file indexam.c.

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

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

Referenced by index_open(), and try_index_open().