PostgreSQL Source Code  git master
indexam.c File Reference
#include "postgres.h"
#include "access/amapi.h"
#include "access/heapam.h"
#include "access/reloptions.h"
#include "access/relscan.h"
#include "access/tableam.h"
#include "access/transam.h"
#include "access/xlog.h"
#include "catalog/index.h"
#include "catalog/pg_amproc.h"
#include "catalog/pg_type.h"
#include "commands/defrem.h"
#include "nodes/makefuncs.h"
#include "pgstat.h"
#include "storage/bufmgr.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)
 
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)
 
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)
 
IndexBulkDeleteResultindex_bulk_delete (IndexVacuumInfo *info, IndexBulkDeleteResult *stats, IndexBulkDeleteCallback callback, void *callback_state)
 
IndexBulkDeleteResultindex_vacuum_cleanup (IndexVacuumInfo *info, IndexBulkDeleteResult *stats)
 
bool index_can_return (Relation indexRelation, int attno)
 
RegProcedure index_getprocid (Relation irel, AttrNumber attnum, uint16 procnum)
 
FmgrInfoindex_getprocinfo (Relation irel, AttrNumber attnum, uint16 procnum)
 
void index_store_float8_orderby_distances (IndexScanDesc scan, Oid *orderByTypes, IndexOrderByDistance *distances, bool recheckOrderBy)
 
byteaindex_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)
#define ERROR
Definition: elog.h:43
#define RelationGetRelationName(relation)
Definition: rel.h:490
#define CppAsString(identifier)
Definition: c.h:222

Definition at line 93 of file indexam.c.

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

◆ 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)
#define ERROR
Definition: elog.h:43
#define RelationGetRelationName(relation)
Definition: rel.h:490
#define CppAsString(identifier)
Definition: c.h:222

Definition at line 100 of file indexam.c.

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

◆ RELATION_CHECKS

#define RELATION_CHECKS
Value:
( \
AssertMacro(RelationIsValid(indexRelation)), \
AssertMacro(PointerIsValid(indexRelation->rd_indam)), \
AssertMacro(!ReindexIsProcessingIndex(RelationGetRelid(indexRelation))) \
)
#define RelationIsValid(relation)
Definition: rel.h:429
bool ReindexIsProcessingIndex(Oid indexOid)
Definition: index.c:3845
#define PointerIsValid(pointer)
Definition: c.h:640
#define RelationGetRelid(relation)
Definition: rel.h:456

Definition at line 79 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().

◆ SCAN_CHECKS

#define SCAN_CHECKS
Value:
( \
AssertMacro(IndexScanIsValid(scan)), \
AssertMacro(RelationIsValid(scan->indexRelation)), \
AssertMacro(PointerIsValid(scan->indexRelation->rd_indam)) \
)
#define RelationIsValid(relation)
Definition: rel.h:429
#define IndexScanIsValid(scan)
Definition: genam.h:136
#define PointerIsValid(pointer)
Definition: c.h:640

Definition at line 86 of file indexam.c.

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

Function Documentation

◆ index_beginscan()

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

Definition at line 203 of file indexam.c.

References IndexScanDescData::heapRelation, index_beginscan_internal(), 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().

207 {
208  IndexScanDesc scan;
209 
210  scan = index_beginscan_internal(indexRelation, nkeys, norderbys, snapshot, NULL, false);
211 
212  /*
213  * Save additional parameters into the scandesc. Everything else was set
214  * up by RelationGetIndexScan.
215  */
216  scan->heapRelation = heapRelation;
217  scan->xs_snapshot = snapshot;
218 
219  /* prepare to fetch index matches from table */
220  scan->xs_heapfetch = table_index_fetch_begin(heapRelation);
221 
222  return scan;
223 }
static IndexFetchTableData * table_index_fetch_begin(Relation rel)
Definition: tableam.h:975
struct SnapshotData * xs_snapshot
Definition: relscan.h:116
Relation heapRelation
Definition: relscan.h:114
static IndexScanDesc index_beginscan_internal(Relation indexRelation, int nkeys, int norderbys, Snapshot snapshot, ParallelIndexScanDesc pscan, bool temp_snap)
Definition: indexam.c:253
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:147

◆ index_beginscan_bitmap()

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

Definition at line 232 of file indexam.c.

References index_beginscan_internal(), and IndexScanDescData::xs_snapshot.

Referenced by ExecInitBitmapIndexScan().

235 {
236  IndexScanDesc scan;
237 
238  scan = index_beginscan_internal(indexRelation, nkeys, 0, snapshot, NULL, false);
239 
240  /*
241  * Save additional parameters into the scandesc. Everything else was set
242  * up by RelationGetIndexScan.
243  */
244  scan->xs_snapshot = snapshot;
245 
246  return scan;
247 }
struct SnapshotData * xs_snapshot
Definition: relscan.h:116
static IndexScanDesc index_beginscan_internal(Relation indexRelation, int nkeys, int norderbys, Snapshot snapshot, ParallelIndexScanDesc pscan, bool temp_snap)
Definition: indexam.c:253

◆ 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 253 of file indexam.c.

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().

256 {
257  IndexScanDesc scan;
258 
260  CHECK_REL_PROCEDURE(ambeginscan);
261 
262  if (!(indexRelation->rd_indam->ampredlocks))
263  PredicateLockRelation(indexRelation, snapshot);
264 
265  /*
266  * We hold a reference count to the relcache entry throughout the scan.
267  */
268  RelationIncrementReferenceCount(indexRelation);
269 
270  /*
271  * Tell the AM to open a scan.
272  */
273  scan = indexRelation->rd_indam->ambeginscan(indexRelation, nkeys,
274  norderbys);
275  /* Initialize information for parallel scan. */
276  scan->parallel_scan = pscan;
277  scan->xs_temp_snap = temp_snap;
278 
279  return scan;
280 }
ambeginscan_function ambeginscan
Definition: amapi.h:270
struct IndexAmRoutine * rd_indam
Definition: rel.h:188
#define RELATION_CHECKS
Definition: indexam.c:79
void PredicateLockRelation(Relation relation, Snapshot snapshot)
Definition: predicate.c:2498
bool ampredlocks
Definition: amapi.h:239
#define CHECK_REL_PROCEDURE(pname)
Definition: indexam.c:93
struct ParallelIndexScanDescData * parallel_scan
Definition: relscan.h:163
void RelationIncrementReferenceCount(Relation rel)
Definition: relcache.c:2077

◆ index_beginscan_parallel()

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

Definition at line 482 of file indexam.c.

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

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

484 {
485  Snapshot snapshot;
486  IndexScanDesc scan;
487 
488  Assert(RelationGetRelid(heaprel) == pscan->ps_relid);
489  snapshot = RestoreSnapshot(pscan->ps_snapshot_data);
490  RegisterSnapshot(snapshot);
491  scan = index_beginscan_internal(indexrel, nkeys, norderbys, snapshot,
492  pscan, true);
493 
494  /*
495  * Save additional parameters into the scandesc. Everything else was set
496  * up by index_beginscan_internal.
497  */
498  scan->heapRelation = heaprel;
499  scan->xs_snapshot = snapshot;
500 
501  /* prepare to fetch index matches from table */
502  scan->xs_heapfetch = table_index_fetch_begin(heaprel);
503 
504  return scan;
505 }
Snapshot RestoreSnapshot(char *start_address)
Definition: snapmgr.c:2157
Snapshot RegisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:810
static IndexFetchTableData * table_index_fetch_begin(Relation rel)
Definition: tableam.h:975
struct SnapshotData * xs_snapshot
Definition: relscan.h:116
char ps_snapshot_data[FLEXIBLE_ARRAY_MEMBER]
Definition: relscan.h:172
Relation heapRelation
Definition: relscan.h:114
static IndexScanDesc index_beginscan_internal(Relation indexRelation, int nkeys, int norderbys, Snapshot snapshot, ParallelIndexScanDesc pscan, bool temp_snap)
Definition: indexam.c:253
#define Assert(condition)
Definition: c.h:746
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:147
#define RelationGetRelid(relation)
Definition: rel.h:456

◆ index_bulk_delete()

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

Definition at line 689 of file indexam.c.

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

Referenced by lazy_vacuum_index(), and validate_index().

693 {
694  Relation indexRelation = info->index;
695 
697  CHECK_REL_PROCEDURE(ambulkdelete);
698 
699  return indexRelation->rd_indam->ambulkdelete(info, stats,
700  callback, callback_state);
701 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:188
ambulkdelete_function ambulkdelete
Definition: amapi.h:261
#define RELATION_CHECKS
Definition: indexam.c:79
Relation index
Definition: genam.h:46
#define CHECK_REL_PROCEDURE(pname)
Definition: indexam.c:93
static void callback(struct sockaddr *addr, struct sockaddr *mask, void *unused)
Definition: test_ifaddrs.c:48

◆ index_can_return()

bool index_can_return ( Relation  indexRelation,
int  attno 
)

Definition at line 729 of file indexam.c.

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

Referenced by get_relation_info(), and indexam_property().

730 {
732 
733  /* amcanreturn is optional; assume false if not provided by AM */
734  if (indexRelation->rd_indam->amcanreturn == NULL)
735  return false;
736 
737  return indexRelation->rd_indam->amcanreturn(indexRelation, attno);
738 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:188
#define RELATION_CHECKS
Definition: indexam.c:79
amcanreturn_function amcanreturn
Definition: amapi.h:263

◆ index_close()

void index_close ( Relation  relation,
LOCKMODE  lockmode 
)

Definition at line 158 of file indexam.c.

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

Referenced by _bt_parallel_build_main(), ATExecAddIndex(), ATExecAddIndexConstraint(), ATExecDetachPartition(), ATExecReplicaIdentity(), ATExecSetStorage(), AttachPartitionEnsureIndexes(), brin_page_items(), brincostestimate(), bt_index_check_internal(), build_indices(), BuildEventTriggerCache(), check_index_is_clusterable(), CheckIndexCompatible(), close_lo_relation(), copy_table_data(), DefineIndex(), DefineRelation(), enum_endpoint(), enum_range_internal(), ExecCloseIndices(), ExecEndBitmapIndexScan(), ExecEndIndexOnlyScan(), ExecEndIndexScan(), ExecRefreshMatView(), expandTableLikeClause(), get_actual_variable_range(), get_relation_info(), gin_clean_pending_list(), gincostestimate(), 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(), reindex_index(), ReindexRelationConcurrently(), RelationFindReplTupleByIndex(), RelationGetIndexAttrBitmap(), RelationTruncateIndexes(), systable_endscan(), toast_close_indexes(), TryReuseIndex(), unique_key_recheck(), vac_close_indexes(), vac_open_indexes(), and validate_index().

159 {
160  LockRelId relid = relation->rd_lockInfo.lockRelId;
161 
162  Assert(lockmode >= NoLock && lockmode < MAX_LOCKMODES);
163 
164  /* The relcache does the real work... */
165  RelationClose(relation);
166 
167  if (lockmode != NoLock)
168  UnlockRelationId(&relid, lockmode);
169 }
LockRelId lockRelId
Definition: rel.h:44
void UnlockRelationId(LockRelId *relid, LOCKMODE lockmode)
Definition: lmgr.c:184
Definition: rel.h:36
#define NoLock
Definition: lockdefs.h:34
LockInfoData rd_lockInfo
Definition: rel.h:112
void RelationClose(Relation relation)
Definition: relcache.c:2110
#define MAX_LOCKMODES
Definition: lock.h:84
#define Assert(condition)
Definition: c.h:746

◆ index_endscan()

void index_endscan ( IndexScanDesc  scan)

Definition at line 321 of file indexam.c.

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().

322 {
323  SCAN_CHECKS;
324  CHECK_SCAN_PROCEDURE(amendscan);
325 
326  /* Release resources (like buffer pins) from table accesses */
327  if (scan->xs_heapfetch)
328  {
330  scan->xs_heapfetch = NULL;
331  }
332 
333  /* End the AM's scan */
334  scan->indexRelation->rd_indam->amendscan(scan);
335 
336  /* Release index refcount acquired by index_beginscan */
338 
339  if (scan->xs_temp_snap)
341 
342  /* Release the scan data structure itself */
343  IndexScanEnd(scan);
344 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:188
struct SnapshotData * xs_snapshot
Definition: relscan.h:116
#define CHECK_SCAN_PROCEDURE(pname)
Definition: indexam.c:100
Relation indexRelation
Definition: relscan.h:115
void RelationDecrementReferenceCount(Relation rel)
Definition: relcache.c:2090
amendscan_function amendscan
Definition: amapi.h:274
void IndexScanEnd(IndexScanDesc scan)
Definition: genam.c:145
void UnregisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:852
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:147
#define SCAN_CHECKS
Definition: indexam.c:86
static void table_index_fetch_end(struct IndexFetchTableData *scan)
Definition: tableam.h:994

◆ index_fetch_heap()

bool index_fetch_heap ( IndexScanDesc  scan,
TupleTableSlot slot 
)

Definition at line 573 of file indexam.c.

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().

574 {
575  bool all_dead = false;
576  bool found;
577 
578  found = table_index_fetch_tuple(scan->xs_heapfetch, &scan->xs_heaptid,
579  scan->xs_snapshot, slot,
580  &scan->xs_heap_continue, &all_dead);
581 
582  if (found)
584 
585  /*
586  * If we scanned a whole HOT chain and found only dead tuples, tell index
587  * AM to kill its entry for that TID (this will take effect in the next
588  * amgettuple call, in index_getnext_tid). We do not do this when in
589  * recovery because it may violate MVCC to do so. See comments in
590  * RelationGetIndexScan().
591  */
592  if (!scan->xactStartedInRecovery)
593  scan->kill_prior_tuple = all_dead;
594 
595  return found;
596 }
struct SnapshotData * xs_snapshot
Definition: relscan.h:116
Relation indexRelation
Definition: relscan.h:115
#define pgstat_count_heap_fetch(rel)
Definition: pgstat.h:1486
ItemPointerData xs_heaptid
Definition: relscan.h:144
bool xactStartedInRecovery
Definition: relscan.h:127
static bool table_index_fetch_tuple(struct IndexFetchTableData *scan, ItemPointer tid, Snapshot snapshot, TupleTableSlot *slot, bool *call_again, bool *all_dead)
Definition: tableam.h:1024
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:147
bool xs_heap_continue
Definition: relscan.h:145
bool kill_prior_tuple
Definition: relscan.h:125

◆ index_getbitmap()

int64 index_getbitmap ( IndexScanDesc  scan,
TIDBitmap bitmap 
)

Definition at line 659 of file indexam.c.

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().

660 {
661  int64 ntids;
662 
663  SCAN_CHECKS;
664  CHECK_SCAN_PROCEDURE(amgetbitmap);
665 
666  /* just make sure this is false... */
667  scan->kill_prior_tuple = false;
668 
669  /*
670  * have the am's getbitmap proc do all the work.
671  */
672  ntids = scan->indexRelation->rd_indam->amgetbitmap(scan, bitmap);
673 
675 
676  return ntids;
677 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:188
#define CHECK_SCAN_PROCEDURE(pname)
Definition: indexam.c:100
Relation indexRelation
Definition: relscan.h:115
amgetbitmap_function amgetbitmap
Definition: amapi.h:273
#define SCAN_CHECKS
Definition: indexam.c:86
#define pgstat_count_index_tuples(rel, n)
Definition: pgstat.h:1496
bool kill_prior_tuple
Definition: relscan.h:125

◆ index_getnext_slot()

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

Definition at line 614 of file indexam.c.

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().

615 {
616  for (;;)
617  {
618  if (!scan->xs_heap_continue)
619  {
620  ItemPointer tid;
621 
622  /* Time to fetch the next TID from the index */
623  tid = index_getnext_tid(scan, direction);
624 
625  /* If we're out of index entries, we're done */
626  if (tid == NULL)
627  break;
628 
629  Assert(ItemPointerEquals(tid, &scan->xs_heaptid));
630  }
631 
632  /*
633  * Fetch the next (or only) visible heap tuple for this index entry.
634  * If we don't find anything, loop around and grab the next TID from
635  * the index.
636  */
638  if (index_fetch_heap(scan, slot))
639  return true;
640  }
641 
642  return false;
643 }
#define ItemPointerIsValid(pointer)
Definition: itemptr.h:82
ItemPointer index_getnext_tid(IndexScanDesc scan, ScanDirection direction)
Definition: indexam.c:515
ItemPointerData xs_heaptid
Definition: relscan.h:144
#define Assert(condition)
Definition: c.h:746
bool xs_heap_continue
Definition: relscan.h:145
bool ItemPointerEquals(ItemPointer pointer1, ItemPointer pointer2)
Definition: itemptr.c:29
bool index_fetch_heap(IndexScanDesc scan, TupleTableSlot *slot)
Definition: indexam.c:573

◆ index_getnext_tid()

ItemPointer index_getnext_tid ( IndexScanDesc  scan,
ScanDirection  direction 
)

Definition at line 515 of file indexam.c.

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().

516 {
517  bool found;
518 
519  SCAN_CHECKS;
520  CHECK_SCAN_PROCEDURE(amgettuple);
521 
522  /* XXX: we should assert that a snapshot is pushed or registered */
524 
525  /*
526  * The AM's amgettuple proc finds the next index entry matching the scan
527  * keys, and puts the TID into scan->xs_heaptid. It should also set
528  * scan->xs_recheck and possibly scan->xs_itup/scan->xs_hitup, though we
529  * pay no attention to those fields here.
530  */
531  found = scan->indexRelation->rd_indam->amgettuple(scan, direction);
532 
533  /* Reset kill flag immediately for safety */
534  scan->kill_prior_tuple = false;
535  scan->xs_heap_continue = false;
536 
537  /* If we're out of index entries, we're done */
538  if (!found)
539  {
540  /* release resources (like buffer pins) from table accesses */
541  if (scan->xs_heapfetch)
543 
544  return NULL;
545  }
547 
549 
550  /* Return the TID of the tuple we found. */
551  return &scan->xs_heaptid;
552 }
#define ItemPointerIsValid(pointer)
Definition: itemptr.h:82
struct IndexAmRoutine * rd_indam
Definition: rel.h:188
amgettuple_function amgettuple
Definition: amapi.h:272
TransactionId RecentXmin
Definition: snapmgr.c:113
#define CHECK_SCAN_PROCEDURE(pname)
Definition: indexam.c:100
Relation indexRelation
Definition: relscan.h:115
ItemPointerData xs_heaptid
Definition: relscan.h:144
static void table_index_fetch_reset(struct IndexFetchTableData *scan)
Definition: tableam.h:985
#define Assert(condition)
Definition: c.h:746
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:147
#define SCAN_CHECKS
Definition: indexam.c:86
bool xs_heap_continue
Definition: relscan.h:145
#define pgstat_count_index_tuples(rel, n)
Definition: pgstat.h:1496
bool kill_prior_tuple
Definition: relscan.h:125
#define TransactionIdIsValid(xid)
Definition: transam.h:41

◆ index_getprocid()

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

Definition at line 767 of file indexam.c.

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

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

770 {
771  RegProcedure *loc;
772  int nproc;
773  int procindex;
774 
775  nproc = irel->rd_indam->amsupport;
776 
777  Assert(procnum > 0 && procnum <= (uint16) nproc);
778 
779  procindex = (nproc * (attnum - 1)) + (procnum - 1);
780 
781  loc = irel->rd_support;
782 
783  Assert(loc != NULL);
784 
785  return loc[procindex];
786 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:188
uint16 amsupport
Definition: amapi.h:215
regproc RegProcedure
Definition: c.h:519
unsigned short uint16
Definition: c.h:374
RegProcedure * rd_support
Definition: rel.h:191
int16 attnum
Definition: pg_attribute.h:79
#define Assert(condition)
Definition: c.h:746

◆ index_getprocinfo()

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

Definition at line 801 of file indexam.c.

References IndexAmRoutine::amoptsprocnum, IndexAmRoutine::amsupport, Assert, 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(), _hash_datum2hashkey(), brin_build_desc(), brinbuildCallback(), bringetbitmap(), brininsert(), doPickSplit(), inclusion_get_procinfo(), index_opclass_options(), initBloomState(), initGinState(), initGISTstate(), spgbeginscan(), spgdoinsert(), spgGetCache(), and union_tuples().

804 {
805  FmgrInfo *locinfo;
806  int nproc;
807  int optsproc;
808  int procindex;
809 
810  nproc = irel->rd_indam->amsupport;
811  optsproc = irel->rd_indam->amoptsprocnum;
812 
813  Assert(procnum > 0 && procnum <= (uint16) nproc);
814 
815  procindex = (nproc * (attnum - 1)) + (procnum - 1);
816 
817  locinfo = irel->rd_supportinfo;
818 
819  Assert(locinfo != NULL);
820 
821  locinfo += procindex;
822 
823  /* Initialize the lookup info if first time through */
824  if (locinfo->fn_oid == InvalidOid)
825  {
826  RegProcedure *loc = irel->rd_support;
827  RegProcedure procId;
828 
829  Assert(loc != NULL);
830 
831  procId = loc[procindex];
832 
833  /*
834  * Complain if function was not found during IndexSupportInitialize.
835  * This should not happen unless the system tables contain bogus
836  * entries for the index opclass. (If an AM wants to allow a support
837  * function to be optional, it can use index_getprocid.)
838  */
839  if (!RegProcedureIsValid(procId))
840  elog(ERROR, "missing support function %d for attribute %d of index \"%s\"",
841  procnum, attnum, RelationGetRelationName(irel));
842 
843  fmgr_info_cxt(procId, locinfo, irel->rd_indexcxt);
844 
845  if (procnum != optsproc)
846  {
847  /* Initialize locinfo->fn_expr with opclass options Const */
848  bytea **attoptions = RelationGetIndexAttOptions(irel, false);
850 
851  set_fn_opclass_options(locinfo, attoptions[attnum - 1]);
852 
853  MemoryContextSwitchTo(oldcxt);
854  }
855  }
856 
857  return locinfo;
858 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:188
Definition: fmgr.h:56
uint16 amsupport
Definition: amapi.h:215
struct FmgrInfo * rd_supportinfo
Definition: rel.h:192
regproc RegProcedure
Definition: c.h:519
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
void set_fn_opclass_options(FmgrInfo *flinfo, bytea *options)
Definition: fmgr.c:1964
unsigned short uint16
Definition: c.h:374
#define ERROR
Definition: elog.h:43
#define RegProcedureIsValid(p)
Definition: c.h:654
#define RelationGetRelationName(relation)
Definition: rel.h:490
void fmgr_info_cxt(Oid functionId, FmgrInfo *finfo, MemoryContext mcxt)
Definition: fmgr.c:136
RegProcedure * rd_support
Definition: rel.h:191
#define InvalidOid
Definition: postgres_ext.h:36
int16 attnum
Definition: pg_attribute.h:79
Oid fn_oid
Definition: fmgr.h:59
#define Assert(condition)
Definition: c.h:746
uint16 amoptsprocnum
Definition: amapi.h:217
#define elog(elevel,...)
Definition: elog.h:214
MemoryContext rd_indexcxt
Definition: rel.h:186
Definition: c.h:563
bytea ** RelationGetIndexAttOptions(Relation relation, bool copy)
Definition: relcache.c:5436

◆ index_insert()

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

Definition at line 176 of file indexam.c.

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

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

183 {
185  CHECK_REL_PROCEDURE(aminsert);
186 
187  if (!(indexRelation->rd_indam->ampredlocks))
188  CheckForSerializableConflictIn(indexRelation,
189  (ItemPointer) NULL,
191 
192  return indexRelation->rd_indam->aminsert(indexRelation, values, isnull,
193  heap_t_ctid, heapRelation,
194  checkUnique, indexInfo);
195 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:188
#define RELATION_CHECKS
Definition: indexam.c:79
bool ampredlocks
Definition: amapi.h:239
aminsert_function aminsert
Definition: amapi.h:260
#define CHECK_REL_PROCEDURE(pname)
Definition: indexam.c:93
void CheckForSerializableConflictIn(Relation relation, ItemPointer tid, BlockNumber blkno)
Definition: predicate.c:4375
#define InvalidBlockNumber
Definition: block.h:33
static Datum values[MAXATTR]
Definition: bootstrap.c:165

◆ index_markpos()

void index_markpos ( IndexScanDesc  scan)

Definition at line 351 of file indexam.c.

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

Referenced by ExecIndexMarkPos(), and ExecIndexOnlyMarkPos().

352 {
353  SCAN_CHECKS;
354  CHECK_SCAN_PROCEDURE(ammarkpos);
355 
356  scan->indexRelation->rd_indam->ammarkpos(scan);
357 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:188
#define CHECK_SCAN_PROCEDURE(pname)
Definition: indexam.c:100
Relation indexRelation
Definition: relscan.h:115
#define SCAN_CHECKS
Definition: indexam.c:86
ammarkpos_function ammarkpos
Definition: amapi.h:275

◆ index_opclass_options()

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

Definition at line 937 of file indexam.c.

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

Referenced by index_create(), and RelationGetIndexAttOptions().

939 {
940  int amoptsprocnum = indrel->rd_indam->amoptsprocnum;
941  Oid procid = InvalidOid;
942  FmgrInfo *procinfo;
943  local_relopts relopts;
944 
945  /* fetch options support procedure if specified */
946  if (amoptsprocnum != 0)
947  procid = index_getprocid(indrel, attnum, amoptsprocnum);
948 
949  if (!OidIsValid(procid))
950  {
951  Oid opclass;
952  Datum indclassDatum;
953  oidvector *indclass;
954  bool isnull;
955 
956  if (!DatumGetPointer(attoptions))
957  return NULL; /* ok, no options, no procedure */
958 
959  /*
960  * Report an error if the opclass's options-parsing procedure does not
961  * exist but the opclass options are specified.
962  */
963  indclassDatum = SysCacheGetAttr(INDEXRELID, indrel->rd_indextuple,
964  Anum_pg_index_indclass, &isnull);
965  Assert(!isnull);
966  indclass = (oidvector *) DatumGetPointer(indclassDatum);
967  opclass = indclass->values[attnum - 1];
968 
969  ereport(ERROR,
970  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
971  errmsg("operator class %s has no options",
972  generate_opclass_name(opclass))));
973  }
974 
975  init_local_reloptions(&relopts, 0);
976 
977  procinfo = index_getprocinfo(indrel, attnum, amoptsprocnum);
978 
979  (void) FunctionCall1(procinfo, PointerGetDatum(&relopts));
980 
981  return build_local_reloptions(&relopts, attoptions, validate);
982 }
Definition: c.h:602
struct IndexAmRoutine * rd_indam
Definition: rel.h:188
Definition: fmgr.h:56
void init_local_reloptions(local_relopts *opts, Size relopt_struct_size)
Definition: reloptions.c:710
FmgrInfo * index_getprocinfo(Relation irel, AttrNumber attnum, uint16 procnum)
Definition: indexam.c:801
#define PointerGetDatum(X)
Definition: postgres.h:556
void * build_local_reloptions(local_relopts *relopts, Datum options, bool validate)
Definition: reloptions.c:1924
int errcode(int sqlerrcode)
Definition: elog.c:610
unsigned int Oid
Definition: postgres_ext.h:31
#define OidIsValid(objectId)
Definition: c.h:652
struct HeapTupleData * rd_indextuple
Definition: rel.h:176
#define ERROR
Definition: elog.h:43
Oid values[FLEXIBLE_ARRAY_MEMBER]
Definition: c.h:610
char * generate_opclass_name(Oid opclass)
Definition: ruleutils.c:10579
uintptr_t Datum
Definition: postgres.h:367
Datum SysCacheGetAttr(int cacheId, HeapTuple tup, AttrNumber attributeNumber, bool *isNull)
Definition: syscache.c:1377
#define InvalidOid
Definition: postgres_ext.h:36
int16 attnum
Definition: pg_attribute.h:79
#define ereport(elevel,...)
Definition: elog.h:144
#define Assert(condition)
Definition: c.h:746
#define DatumGetPointer(X)
Definition: postgres.h:549
int errmsg(const char *fmt,...)
Definition: elog.c:821
uint16 amoptsprocnum
Definition: amapi.h:217
#define FunctionCall1(flinfo, arg1)
Definition: fmgr.h:642
RegProcedure index_getprocid(Relation irel, AttrNumber attnum, uint16 procnum)
Definition: indexam.c:767

◆ index_open()

Relation index_open ( Oid  relationId,
LOCKMODE  lockmode 
)

Definition at line 132 of file indexam.c.

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

Referenced by _bt_parallel_build_main(), ATExecAddIndex(), ATExecAddIndexConstraint(), ATExecDetachPartition(), ATExecReplicaIdentity(), ATExecSetStorage(), AttachPartitionEnsureIndexes(), brin_desummarize_range(), brin_page_items(), brin_summarize_range(), brincostestimate(), bt_index_check_internal(), build_indices(), BuildEventTriggerCache(), check_index_is_clusterable(), CheckIndexCompatible(), copy_table_data(), DefineIndex(), DefineRelation(), enum_endpoint(), enum_range_internal(), ExecInitBitmapIndexScan(), ExecInitIndexOnlyScan(), ExecInitIndexScan(), ExecOpenIndices(), ExecRefreshMatView(), expandTableLikeClause(), get_actual_variable_range(), get_relation_info(), gin_clean_pending_list(), gincostestimate(), hash_bitmap_info(), 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(), pgstathashindex(), plan_create_index_workers(), refresh_by_match_merge(), reindex_index(), ReindexRelationConcurrently(), RelationFindReplTupleByIndex(), RelationGetIndexAttrBitmap(), RelationTruncateIndexes(), systable_beginscan(), toast_open_indexes(), transformIndexConstraint(), TryReuseIndex(), unique_key_recheck(), vac_open_indexes(), and validate_index().

133 {
134  Relation r;
135 
136  r = relation_open(relationId, lockmode);
137 
138  if (r->rd_rel->relkind != RELKIND_INDEX &&
139  r->rd_rel->relkind != RELKIND_PARTITIONED_INDEX)
140  ereport(ERROR,
141  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
142  errmsg("\"%s\" is not an index",
144 
145  return r;
146 }
int errcode(int sqlerrcode)
Definition: elog.c:610
Form_pg_class rd_rel
Definition: rel.h:109
#define ERROR
Definition: elog.h:43
Relation relation_open(Oid relationId, LOCKMODE lockmode)
Definition: relation.c:48
#define RelationGetRelationName(relation)
Definition: rel.h:490
#define ereport(elevel,...)
Definition: elog.h:144
int errmsg(const char *fmt,...)
Definition: elog.c:821

◆ index_parallelrescan()

void index_parallelrescan ( IndexScanDesc  scan)

Definition at line 464 of file indexam.c.

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

Referenced by ExecIndexOnlyScanReInitializeDSM(), and ExecIndexScanReInitializeDSM().

465 {
466  SCAN_CHECKS;
467 
468  if (scan->xs_heapfetch)
470 
471  /* amparallelrescan is optional; assume no-op if not provided by AM */
472  if (scan->indexRelation->rd_indam->amparallelrescan != NULL)
474 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:188
amparallelrescan_function amparallelrescan
Definition: amapi.h:281
Relation indexRelation
Definition: relscan.h:115
static void table_index_fetch_reset(struct IndexFetchTableData *scan)
Definition: tableam.h:985
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:147
#define SCAN_CHECKS
Definition: indexam.c:86

◆ index_parallelscan_estimate()

Size index_parallelscan_estimate ( Relation  indexRelation,
Snapshot  snapshot 
)

Definition at line 400 of file indexam.c.

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

Referenced by ExecIndexOnlyScanEstimate(), and ExecIndexScanEstimate().

401 {
402  Size nbytes;
403 
405 
406  nbytes = offsetof(ParallelIndexScanDescData, ps_snapshot_data);
407  nbytes = add_size(nbytes, EstimateSnapshotSpace(snapshot));
408  nbytes = MAXALIGN(nbytes);
409 
410  /*
411  * If amestimateparallelscan is not provided, assume there is no
412  * AM-specific data needed. (It's hard to believe that could work, but
413  * it's easy enough to cater to it here.)
414  */
415  if (indexRelation->rd_indam->amestimateparallelscan != NULL)
416  nbytes = add_size(nbytes,
417  indexRelation->rd_indam->amestimateparallelscan());
418 
419  return nbytes;
420 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:188
#define RELATION_CHECKS
Definition: indexam.c:79
Size EstimateSnapshotSpace(Snapshot snap)
Definition: snapmgr.c:2074
Size add_size(Size s1, Size s2)
Definition: shmem.c:498
size_t Size
Definition: c.h:474
#define MAXALIGN(LEN)
Definition: c.h:699
amestimateparallelscan_function amestimateparallelscan
Definition: amapi.h:279
#define offsetof(type, field)
Definition: c.h:669

◆ index_parallelscan_initialize()

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

Definition at line 433 of file indexam.c.

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

Referenced by ExecIndexOnlyScanInitializeDSM(), and ExecIndexScanInitializeDSM().

435 {
436  Size offset;
437 
439 
440  offset = add_size(offsetof(ParallelIndexScanDescData, ps_snapshot_data),
441  EstimateSnapshotSpace(snapshot));
442  offset = MAXALIGN(offset);
443 
444  target->ps_relid = RelationGetRelid(heapRelation);
445  target->ps_indexid = RelationGetRelid(indexRelation);
446  target->ps_offset = offset;
447  SerializeSnapshot(snapshot, target->ps_snapshot_data);
448 
449  /* aminitparallelscan is optional; assume no-op if not provided by AM */
450  if (indexRelation->rd_indam->aminitparallelscan != NULL)
451  {
452  void *amtarget;
453 
454  amtarget = OffsetToPointer(target, offset);
455  indexRelation->rd_indam->aminitparallelscan(amtarget);
456  }
457 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:188
#define RELATION_CHECKS
Definition: indexam.c:79
char ps_snapshot_data[FLEXIBLE_ARRAY_MEMBER]
Definition: relscan.h:172
void SerializeSnapshot(Snapshot snapshot, char *start_address)
Definition: snapmgr.c:2098
#define OffsetToPointer(base, offset)
Definition: c.h:649
Size EstimateSnapshotSpace(Snapshot snap)
Definition: snapmgr.c:2074
Size add_size(Size s1, Size s2)
Definition: shmem.c:498
size_t Size
Definition: c.h:474
#define MAXALIGN(LEN)
Definition: c.h:699
#define RelationGetRelid(relation)
Definition: rel.h:456
#define offsetof(type, field)
Definition: c.h:669
aminitparallelscan_function aminitparallelscan
Definition: amapi.h:280

◆ index_rescan()

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

Definition at line 295 of file indexam.c.

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().

298 {
299  SCAN_CHECKS;
300  CHECK_SCAN_PROCEDURE(amrescan);
301 
302  Assert(nkeys == scan->numberOfKeys);
303  Assert(norderbys == scan->numberOfOrderBys);
304 
305  /* Release resources (like buffer pins) from table accesses */
306  if (scan->xs_heapfetch)
308 
309  scan->kill_prior_tuple = false; /* for safety */
310  scan->xs_heap_continue = false;
311 
312  scan->indexRelation->rd_indam->amrescan(scan, keys, nkeys,
313  orderbys, norderbys);
314 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:188
#define CHECK_SCAN_PROCEDURE(pname)
Definition: indexam.c:100
Relation indexRelation
Definition: relscan.h:115
amrescan_function amrescan
Definition: amapi.h:271
static void table_index_fetch_reset(struct IndexFetchTableData *scan)
Definition: tableam.h:985
#define Assert(condition)
Definition: c.h:746
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:147
#define SCAN_CHECKS
Definition: indexam.c:86
bool xs_heap_continue
Definition: relscan.h:145
bool kill_prior_tuple
Definition: relscan.h:125
int numberOfOrderBys
Definition: relscan.h:118

◆ index_restrpos()

void index_restrpos ( IndexScanDesc  scan)

Definition at line 375 of file indexam.c.

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().

376 {
378 
379  SCAN_CHECKS;
380  CHECK_SCAN_PROCEDURE(amrestrpos);
381 
382  /* release resources (like buffer pins) from table accesses */
383  if (scan->xs_heapfetch)
385 
386  scan->kill_prior_tuple = false; /* for safety */
387  scan->xs_heap_continue = false;
388 
389  scan->indexRelation->rd_indam->amrestrpos(scan);
390 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:188
struct SnapshotData * xs_snapshot
Definition: relscan.h:116
#define CHECK_SCAN_PROCEDURE(pname)
Definition: indexam.c:100
Relation indexRelation
Definition: relscan.h:115
#define IsMVCCSnapshot(snapshot)
Definition: snapmgr.h:97
static void table_index_fetch_reset(struct IndexFetchTableData *scan)
Definition: tableam.h:985
#define Assert(condition)
Definition: c.h:746
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:147
#define SCAN_CHECKS
Definition: indexam.c:86
bool xs_heap_continue
Definition: relscan.h:145
bool kill_prior_tuple
Definition: relscan.h:125
amrestrpos_function amrestrpos
Definition: amapi.h:276

◆ index_store_float8_orderby_distances()

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

Definition at line 869 of file indexam.c.

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().

872 {
873  int i;
874 
875  Assert(distances || !recheckOrderBy);
876 
877  scan->xs_recheckorderby = recheckOrderBy;
878 
879  for (i = 0; i < scan->numberOfOrderBys; i++)
880  {
881  if (orderByTypes[i] == FLOAT8OID)
882  {
883 #ifndef USE_FLOAT8_BYVAL
884  /* must free any old value to avoid memory leakage */
885  if (!scan->xs_orderbynulls[i])
887 #endif
888  if (distances && !distances[i].isnull)
889  {
890  scan->xs_orderbyvals[i] = Float8GetDatum(distances[i].value);
891  scan->xs_orderbynulls[i] = false;
892  }
893  else
894  {
895  scan->xs_orderbyvals[i] = (Datum) 0;
896  scan->xs_orderbynulls[i] = true;
897  }
898  }
899  else if (orderByTypes[i] == FLOAT4OID)
900  {
901  /* convert distance function's result to ORDER BY type */
902  if (distances && !distances[i].isnull)
903  {
904  scan->xs_orderbyvals[i] = Float4GetDatum((float4) distances[i].value);
905  scan->xs_orderbynulls[i] = false;
906  }
907  else
908  {
909  scan->xs_orderbyvals[i] = (Datum) 0;
910  scan->xs_orderbynulls[i] = true;
911  }
912  }
913  else
914  {
915  /*
916  * If the ordering operator's return value is anything else, we
917  * don't know how to convert the float8 bound calculated by the
918  * distance function to that. The executor won't actually need
919  * the order by values we return here, if there are no lossy
920  * results, so only insist on converting if the *recheck flag is
921  * set.
922  */
923  if (scan->xs_recheckorderby)
924  elog(ERROR, "ORDER BY operator must return float8 or float4 if the distance function is lossy");
925  scan->xs_orderbynulls[i] = true;
926  }
927  }
928 }
static Datum Float4GetDatum(float4 X)
Definition: postgres.h:681
Datum * xs_orderbyvals
Definition: relscan.h:158
bool xs_recheckorderby
Definition: relscan.h:160
Datum Float8GetDatum(float8 X)
Definition: fmgr.c:1710
bool * xs_orderbynulls
Definition: relscan.h:159
void pfree(void *pointer)
Definition: mcxt.c:1057
#define ERROR
Definition: elog.h:43
float float4
Definition: c.h:498
uintptr_t Datum
Definition: postgres.h:367
static struct @143 value
#define Assert(condition)
Definition: c.h:746
#define DatumGetPointer(X)
Definition: postgres.h:549
#define elog(elevel,...)
Definition: elog.h:214
int i
int numberOfOrderBys
Definition: relscan.h:118

◆ index_vacuum_cleanup()

IndexBulkDeleteResult* index_vacuum_cleanup ( IndexVacuumInfo info,
IndexBulkDeleteResult stats 
)

Definition at line 710 of file indexam.c.

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

Referenced by do_analyze_rel(), and lazy_cleanup_index().

712 {
713  Relation indexRelation = info->index;
714 
716  CHECK_REL_PROCEDURE(amvacuumcleanup);
717 
718  return indexRelation->rd_indam->amvacuumcleanup(info, stats);
719 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:188
#define RELATION_CHECKS
Definition: indexam.c:79
Relation index
Definition: genam.h:46
#define CHECK_REL_PROCEDURE(pname)
Definition: indexam.c:93
amvacuumcleanup_function amvacuumcleanup
Definition: amapi.h:262