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, bool indexUnchanged, 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 *istat, IndexBulkDeleteCallback callback, void *callback_state)
 
IndexBulkDeleteResultindex_vacuum_cleanup (IndexVacuumInfo *info, IndexBulkDeleteResult *istat)
 
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:46
#define RelationGetRelationName(relation)
Definition: rel.h:511
#define CppAsString(identifier)
Definition: c.h:288

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:46
#define RelationGetRelationName(relation)
Definition: rel.h:511
#define CppAsString(identifier)
Definition: c.h:288

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:450
bool ReindexIsProcessingIndex(Oid indexOid)
Definition: index.c:3969
#define PointerIsValid(pointer)
Definition: c.h:698
#define RelationGetRelid(relation)
Definition: rel.h:477

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:450
#define IndexScanIsValid(scan)
Definition: genam.h:138
#define PointerIsValid(pointer)
Definition: c.h:698

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

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

◆ index_beginscan_bitmap()

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

Definition at line 234 of file indexam.c.

References index_beginscan_internal(), and IndexScanDescData::xs_snapshot.

Referenced by ExecInitBitmapIndexScan().

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

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

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

◆ index_beginscan_parallel()

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

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

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

◆ index_bulk_delete()

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

Definition at line 691 of file indexam.c.

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

Referenced by lazy_vacuum_one_index(), and validate_index().

695 {
696  Relation indexRelation = info->index;
697 
699  CHECK_REL_PROCEDURE(ambulkdelete);
700 
701  return indexRelation->rd_indam->ambulkdelete(info, istat,
702  callback, callback_state);
703 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:201
ambulkdelete_function ambulkdelete
Definition: amapi.h:262
#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 731 of file indexam.c.

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

Referenced by get_relation_info(), and indexam_property().

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

◆ 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(), ATExecReplicaIdentity(), 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(), DetachPartitionFinalize(), 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(), SetIndexStorageProperties(), 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:45
void UnlockRelationId(LockRelId *relid, LOCKMODE lockmode)
Definition: lmgr.c:185
Definition: rel.h:37
#define NoLock
Definition: lockdefs.h:34
LockInfoData rd_lockInfo
Definition: rel.h:112
void RelationClose(Relation relation)
Definition: relcache.c:2101
#define MAX_LOCKMODES
Definition: lock.h:86
#define Assert(condition)
Definition: c.h:804

◆ index_endscan()

void index_endscan ( IndexScanDesc  scan)

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

324 {
325  SCAN_CHECKS;
326  CHECK_SCAN_PROCEDURE(amendscan);
327 
328  /* Release resources (like buffer pins) from table accesses */
329  if (scan->xs_heapfetch)
330  {
332  scan->xs_heapfetch = NULL;
333  }
334 
335  /* End the AM's scan */
336  scan->indexRelation->rd_indam->amendscan(scan);
337 
338  /* Release index refcount acquired by index_beginscan */
340 
341  if (scan->xs_temp_snap)
343 
344  /* Release the scan data structure itself */
345  IndexScanEnd(scan);
346 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:201
struct SnapshotData * xs_snapshot
Definition: relscan.h:119
#define CHECK_SCAN_PROCEDURE(pname)
Definition: indexam.c:100
Relation indexRelation
Definition: relscan.h:118
void RelationDecrementReferenceCount(Relation rel)
Definition: relcache.c:2081
amendscan_function amendscan
Definition: amapi.h:275
void IndexScanEnd(IndexScanDesc scan)
Definition: genam.c:145
void UnregisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:852
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:150
#define SCAN_CHECKS
Definition: indexam.c:86
static void table_index_fetch_end(struct IndexFetchTableData *scan)
Definition: tableam.h:1180

◆ index_fetch_heap()

bool index_fetch_heap ( IndexScanDesc  scan,
TupleTableSlot slot 
)

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

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

◆ index_getbitmap()

int64 index_getbitmap ( IndexScanDesc  scan,
TIDBitmap bitmap 
)

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

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

◆ index_getnext_slot()

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

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

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

◆ index_getnext_tid()

ItemPointer index_getnext_tid ( IndexScanDesc  scan,
ScanDirection  direction 
)

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

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

◆ index_getprocid()

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

Definition at line 769 of file indexam.c.

References IndexAmRoutine::amsupport, Assert, 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(), RelationGetIndexRawAttOptions(), spgdoinsert(), and spgGetCache().

772 {
773  RegProcedure *loc;
774  int nproc;
775  int procindex;
776 
777  nproc = irel->rd_indam->amsupport;
778 
779  Assert(procnum > 0 && procnum <= (uint16) nproc);
780 
781  procindex = (nproc * (attnum - 1)) + (procnum - 1);
782 
783  loc = irel->rd_support;
784 
785  Assert(loc != NULL);
786 
787  return loc[procindex];
788 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:201
uint16 amsupport
Definition: amapi.h:216
regproc RegProcedure
Definition: c.h:585
unsigned short uint16
Definition: c.h:440
RegProcedure * rd_support
Definition: rel.h:204
int16 attnum
Definition: pg_attribute.h:83
#define Assert(condition)
Definition: c.h:804

◆ index_getprocinfo()

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

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

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

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

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

◆ index_markpos()

void index_markpos ( IndexScanDesc  scan)

Definition at line 353 of file indexam.c.

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

Referenced by ExecIndexMarkPos(), and ExecIndexOnlyMarkPos().

354 {
355  SCAN_CHECKS;
356  CHECK_SCAN_PROCEDURE(ammarkpos);
357 
358  scan->indexRelation->rd_indam->ammarkpos(scan);
359 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:201
#define CHECK_SCAN_PROCEDURE(pname)
Definition: indexam.c:100
Relation indexRelation
Definition: relscan.h:118
#define SCAN_CHECKS
Definition: indexam.c:86
ammarkpos_function ammarkpos
Definition: amapi.h:276

◆ index_opclass_options()

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

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

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

◆ 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(), ATExecReplicaIdentity(), 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(), DetachPartitionFinalize(), enum_endpoint(), enum_range_internal(), ExecInitBitmapIndexScan(), ExecInitIndexOnlyScan(), ExecInitIndexScan(), ExecOpenIndices(), ExecRefreshMatView(), expandTableLikeClause(), 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_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(), SetIndexStorageProperties(), 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:698
Form_pg_class rd_rel
Definition: rel.h:109
#define ERROR
Definition: elog.h:46
Relation relation_open(Oid relationId, LOCKMODE lockmode)
Definition: relation.c:48
#define RelationGetRelationName(relation)
Definition: rel.h:511
#define ereport(elevel,...)
Definition: elog.h:157
int errmsg(const char *fmt,...)
Definition: elog.c:909

◆ index_parallelrescan()

void index_parallelrescan ( IndexScanDesc  scan)

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

467 {
468  SCAN_CHECKS;
469 
470  if (scan->xs_heapfetch)
472 
473  /* amparallelrescan is optional; assume no-op if not provided by AM */
474  if (scan->indexRelation->rd_indam->amparallelrescan != NULL)
476 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:201
amparallelrescan_function amparallelrescan
Definition: amapi.h:282
Relation indexRelation
Definition: relscan.h:118
static void table_index_fetch_reset(struct IndexFetchTableData *scan)
Definition: tableam.h:1171
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:150
#define SCAN_CHECKS
Definition: indexam.c:86

◆ index_parallelscan_estimate()

Size index_parallelscan_estimate ( Relation  indexRelation,
Snapshot  snapshot 
)

Definition at line 402 of file indexam.c.

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

Referenced by ExecIndexOnlyScanEstimate(), and ExecIndexScanEstimate().

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

◆ index_parallelscan_initialize()

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

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

437 {
438  Size offset;
439 
441 
442  offset = add_size(offsetof(ParallelIndexScanDescData, ps_snapshot_data),
443  EstimateSnapshotSpace(snapshot));
444  offset = MAXALIGN(offset);
445 
446  target->ps_relid = RelationGetRelid(heapRelation);
447  target->ps_indexid = RelationGetRelid(indexRelation);
448  target->ps_offset = offset;
449  SerializeSnapshot(snapshot, target->ps_snapshot_data);
450 
451  /* aminitparallelscan is optional; assume no-op if not provided by AM */
452  if (indexRelation->rd_indam->aminitparallelscan != NULL)
453  {
454  void *amtarget;
455 
456  amtarget = OffsetToPointer(target, offset);
457  indexRelation->rd_indam->aminitparallelscan(amtarget);
458  }
459 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:201
#define RELATION_CHECKS
Definition: indexam.c:79
char ps_snapshot_data[FLEXIBLE_ARRAY_MEMBER]
Definition: relscan.h:175
void SerializeSnapshot(Snapshot snapshot, char *start_address)
Definition: snapmgr.c:2102
#define OffsetToPointer(base, offset)
Definition: c.h:707
Size EstimateSnapshotSpace(Snapshot snap)
Definition: snapmgr.c:2078
Size add_size(Size s1, Size s2)
Definition: shmem.c:502
size_t Size
Definition: c.h:540
#define MAXALIGN(LEN)
Definition: c.h:757
#define RelationGetRelid(relation)
Definition: rel.h:477
#define offsetof(type, field)
Definition: c.h:727
aminitparallelscan_function aminitparallelscan
Definition: amapi.h:281

◆ index_rescan()

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

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

300 {
301  SCAN_CHECKS;
302  CHECK_SCAN_PROCEDURE(amrescan);
303 
304  Assert(nkeys == scan->numberOfKeys);
305  Assert(norderbys == scan->numberOfOrderBys);
306 
307  /* Release resources (like buffer pins) from table accesses */
308  if (scan->xs_heapfetch)
310 
311  scan->kill_prior_tuple = false; /* for safety */
312  scan->xs_heap_continue = false;
313 
314  scan->indexRelation->rd_indam->amrescan(scan, keys, nkeys,
315  orderbys, norderbys);
316 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:201
#define CHECK_SCAN_PROCEDURE(pname)
Definition: indexam.c:100
Relation indexRelation
Definition: relscan.h:118
amrescan_function amrescan
Definition: amapi.h:272
static void table_index_fetch_reset(struct IndexFetchTableData *scan)
Definition: tableam.h:1171
#define Assert(condition)
Definition: c.h:804
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:150
#define SCAN_CHECKS
Definition: indexam.c:86
bool xs_heap_continue
Definition: relscan.h:148
bool kill_prior_tuple
Definition: relscan.h:128
int numberOfOrderBys
Definition: relscan.h:121

◆ index_restrpos()

void index_restrpos ( IndexScanDesc  scan)

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

378 {
380 
381  SCAN_CHECKS;
382  CHECK_SCAN_PROCEDURE(amrestrpos);
383 
384  /* release resources (like buffer pins) from table accesses */
385  if (scan->xs_heapfetch)
387 
388  scan->kill_prior_tuple = false; /* for safety */
389  scan->xs_heap_continue = false;
390 
391  scan->indexRelation->rd_indam->amrestrpos(scan);
392 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:201
struct SnapshotData * xs_snapshot
Definition: relscan.h:119
#define CHECK_SCAN_PROCEDURE(pname)
Definition: indexam.c:100
Relation indexRelation
Definition: relscan.h:118
#define IsMVCCSnapshot(snapshot)
Definition: snapmgr.h:96
static void table_index_fetch_reset(struct IndexFetchTableData *scan)
Definition: tableam.h:1171
#define Assert(condition)
Definition: c.h:804
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:150
#define SCAN_CHECKS
Definition: indexam.c:86
bool xs_heap_continue
Definition: relscan.h:148
bool kill_prior_tuple
Definition: relscan.h:128
amrestrpos_function amrestrpos
Definition: amapi.h:277

◆ index_store_float8_orderby_distances()

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

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

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

◆ index_vacuum_cleanup()

IndexBulkDeleteResult* index_vacuum_cleanup ( IndexVacuumInfo info,
IndexBulkDeleteResult istat 
)

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

714 {
715  Relation indexRelation = info->index;
716 
718  CHECK_REL_PROCEDURE(amvacuumcleanup);
719 
720  return indexRelation->rd_indam->amvacuumcleanup(info, istat);
721 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:201
#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:263