PostgreSQL Source Code  git master
genam.h File Reference
#include "access/sdir.h"
#include "access/skey.h"
#include "nodes/tidbitmap.h"
#include "storage/lockdefs.h"
#include "utils/relcache.h"
#include "utils/snapshot.h"
Include dependency graph for genam.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  IndexBuildResult
 
struct  IndexVacuumInfo
 
struct  IndexBulkDeleteResult
 
struct  IndexOrderByDistance
 

Macros

#define IndexScanIsValid(scan)   PointerIsValid(scan)
 

Typedefs

typedef struct IndexBuildResult IndexBuildResult
 
typedef struct IndexVacuumInfo IndexVacuumInfo
 
typedef struct IndexBulkDeleteResult IndexBulkDeleteResult
 
typedef bool(* IndexBulkDeleteCallback) (ItemPointer itemptr, void *state)
 
typedef struct IndexScanDescDataIndexScanDesc
 
typedef struct SysScanDescDataSysScanDesc
 
typedef struct ParallelIndexScanDescDataParallelIndexScanDesc
 
typedef enum IndexUniqueCheck IndexUniqueCheck
 
typedef struct IndexOrderByDistance IndexOrderByDistance
 

Enumerations

enum  IndexUniqueCheck { UNIQUE_CHECK_NO, UNIQUE_CHECK_YES, UNIQUE_CHECK_PARTIAL, UNIQUE_CHECK_EXISTING }
 

Functions

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, struct 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 indexrel, Snapshot snapshot)
 
void index_parallelscan_initialize (Relation heaprel, Relation indexrel, 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, struct TupleTableSlot *slot)
 
bool index_getnext_slot (IndexScanDesc scan, ScanDirection direction, struct 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)
 
IndexScanDesc RelationGetIndexScan (Relation indexRelation, int nkeys, int norderbys)
 
void IndexScanEnd (IndexScanDesc scan)
 
char * BuildIndexValueDescription (Relation indexRelation, Datum *values, bool *isnull)
 
TransactionId index_compute_xid_horizon_for_tuples (Relation irel, Relation hrel, Buffer ibuf, OffsetNumber *itemnos, int nitems)
 
SysScanDesc systable_beginscan (Relation heapRelation, Oid indexId, bool indexOK, Snapshot snapshot, int nkeys, ScanKey key)
 
HeapTuple systable_getnext (SysScanDesc sysscan)
 
bool systable_recheck_tuple (SysScanDesc sysscan, HeapTuple tup)
 
void systable_endscan (SysScanDesc sysscan)
 
SysScanDesc systable_beginscan_ordered (Relation heapRelation, Relation indexRelation, Snapshot snapshot, int nkeys, ScanKey key)
 
HeapTuple systable_getnext_ordered (SysScanDesc sysscan, ScanDirection direction)
 
void systable_endscan_ordered (SysScanDesc sysscan)
 

Macro Definition Documentation

◆ IndexScanIsValid

#define IndexScanIsValid (   scan)    PointerIsValid(scan)

Definition at line 136 of file genam.h.

Typedef Documentation

◆ IndexBuildResult

◆ IndexBulkDeleteCallback

typedef bool(* IndexBulkDeleteCallback) (ItemPointer itemptr, void *state)

Definition at line 84 of file genam.h.

◆ IndexBulkDeleteResult

◆ IndexOrderByDistance

◆ IndexScanDesc

Definition at line 87 of file genam.h.

◆ IndexUniqueCheck

◆ IndexVacuumInfo

◆ ParallelIndexScanDesc

Definition at line 90 of file genam.h.

◆ SysScanDesc

typedef struct SysScanDescData* SysScanDesc

Definition at line 88 of file genam.h.

Enumeration Type Documentation

◆ IndexUniqueCheck

Enumerator
UNIQUE_CHECK_NO 
UNIQUE_CHECK_YES 
UNIQUE_CHECK_PARTIAL 
UNIQUE_CHECK_EXISTING 

Definition at line 112 of file genam.h.

113 {
114  UNIQUE_CHECK_NO, /* Don't do any uniqueness checking */
115  UNIQUE_CHECK_YES, /* Enforce uniqueness at insertion time */
116  UNIQUE_CHECK_PARTIAL, /* Test uniqueness, but no error */
117  UNIQUE_CHECK_EXISTING /* Check if existing tuple is unique */
IndexUniqueCheck
Definition: genam.h:112

Function Documentation

◆ BuildIndexValueDescription()

char* BuildIndexValueDescription ( Relation  indexRelation,
Datum values,
bool isnull 
)

Definition at line 176 of file genam.c.

References ACL_SELECT, ACLCHECK_OK, appendStringInfo(), appendStringInfoChar(), appendStringInfoString(), Assert, attnum, buf, check_enable_rls(), StringInfoData::data, getTypeOutputInfo(), GetUserId(), i, IndexRelationGetNumberOfKeyAttributes, initStringInfo(), InvalidAttrNumber, InvalidOid, OidOutputFunctionCall(), pg_attribute_aclcheck(), pg_class_aclcheck(), pg_get_indexdef_columns(), RelationData::rd_index, RelationData::rd_opcintype, RelationGetRelid, RLS_ENABLED, and val.

Referenced by _bt_check_unique(), check_exclusion_or_unique_constraint(), and comparetup_index_btree().

178 {
180  Form_pg_index idxrec;
181  int indnkeyatts;
182  int i;
183  int keyno;
184  Oid indexrelid = RelationGetRelid(indexRelation);
185  Oid indrelid;
186  AclResult aclresult;
187 
188  indnkeyatts = IndexRelationGetNumberOfKeyAttributes(indexRelation);
189 
190  /*
191  * Check permissions- if the user does not have access to view all of the
192  * key columns then return NULL to avoid leaking data.
193  *
194  * First check if RLS is enabled for the relation. If so, return NULL to
195  * avoid leaking data.
196  *
197  * Next we need to check table-level SELECT access and then, if there is
198  * no access there, check column-level permissions.
199  */
200  idxrec = indexRelation->rd_index;
201  indrelid = idxrec->indrelid;
202  Assert(indexrelid == idxrec->indexrelid);
203 
204  /* RLS check- if RLS is enabled then we don't return anything. */
205  if (check_enable_rls(indrelid, InvalidOid, true) == RLS_ENABLED)
206  return NULL;
207 
208  /* Table-level SELECT is enough, if the user has it */
209  aclresult = pg_class_aclcheck(indrelid, GetUserId(), ACL_SELECT);
210  if (aclresult != ACLCHECK_OK)
211  {
212  /*
213  * No table-level access, so step through the columns in the index and
214  * make sure the user has SELECT rights on all of them.
215  */
216  for (keyno = 0; keyno < indnkeyatts; keyno++)
217  {
218  AttrNumber attnum = idxrec->indkey.values[keyno];
219 
220  /*
221  * Note that if attnum == InvalidAttrNumber, then this is an index
222  * based on an expression and we return no detail rather than try
223  * to figure out what column(s) the expression includes and if the
224  * user has SELECT rights on them.
225  */
226  if (attnum == InvalidAttrNumber ||
227  pg_attribute_aclcheck(indrelid, attnum, GetUserId(),
229  {
230  /* No access, so clean up and return */
231  return NULL;
232  }
233  }
234  }
235 
236  initStringInfo(&buf);
237  appendStringInfo(&buf, "(%s)=(",
238  pg_get_indexdef_columns(indexrelid, true));
239 
240  for (i = 0; i < indnkeyatts; i++)
241  {
242  char *val;
243 
244  if (isnull[i])
245  val = "null";
246  else
247  {
248  Oid foutoid;
249  bool typisvarlena;
250 
251  /*
252  * The provided data is not necessarily of the type stored in the
253  * index; rather it is of the index opclass's input type. So look
254  * at rd_opcintype not the index tupdesc.
255  *
256  * Note: this is a bit shaky for opclasses that have pseudotype
257  * input types such as ANYARRAY or RECORD. Currently, the
258  * typoutput functions associated with the pseudotypes will work
259  * okay, but we might have to try harder in future.
260  */
261  getTypeOutputInfo(indexRelation->rd_opcintype[i],
262  &foutoid, &typisvarlena);
263  val = OidOutputFunctionCall(foutoid, values[i]);
264  }
265 
266  if (i > 0)
267  appendStringInfoString(&buf, ", ");
268  appendStringInfoString(&buf, val);
269  }
270 
271  appendStringInfoChar(&buf, ')');
272 
273  return buf.data;
274 }
void getTypeOutputInfo(Oid type, Oid *typOutput, bool *typIsVarlena)
Definition: lsyscache.c:2674
AclResult pg_attribute_aclcheck(Oid table_oid, AttrNumber attnum, Oid roleid, AclMode mode)
Definition: aclchk.c:4516
Oid GetUserId(void)
Definition: miscinit.c:380
char * pg_get_indexdef_columns(Oid indexrelid, bool pretty)
Definition: ruleutils.c:1153
unsigned int Oid
Definition: postgres_ext.h:31
Form_pg_index rd_index
Definition: rel.h:143
void appendStringInfo(StringInfo str, const char *fmt,...)
Definition: stringinfo.c:91
void appendStringInfoString(StringInfo str, const char *s)
Definition: stringinfo.c:176
static char * buf
Definition: pg_test_fsync.c:67
#define IndexRelationGetNumberOfKeyAttributes(relation)
Definition: rel.h:442
void appendStringInfoChar(StringInfo str, char ch)
Definition: stringinfo.c:188
void initStringInfo(StringInfo str)
Definition: stringinfo.c:59
FormData_pg_index * Form_pg_index
Definition: pg_index.h:66
AclResult
Definition: acl.h:177
#define ACL_SELECT
Definition: parsenodes.h:75
#define InvalidOid
Definition: postgres_ext.h:36
int16 attnum
Definition: pg_attribute.h:79
int check_enable_rls(Oid relid, Oid checkAsUser, bool noError)
Definition: rls.c:52
#define Assert(condition)
Definition: c.h:733
#define InvalidAttrNumber
Definition: attnum.h:23
AclResult pg_class_aclcheck(Oid table_oid, Oid roleid, AclMode mode)
Definition: aclchk.c:4630
static Datum values[MAXATTR]
Definition: bootstrap.c:167
char * OidOutputFunctionCall(Oid functionId, Datum val)
Definition: fmgr.c:1655
int i
Oid * rd_opcintype
Definition: rel.h:159
int16 AttrNumber
Definition: attnum.h:21
#define RelationGetRelid(relation)
Definition: rel.h:423
long val
Definition: informix.c:684

◆ index_beginscan()

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

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

201 {
202  IndexScanDesc scan;
203 
204  scan = index_beginscan_internal(indexRelation, nkeys, norderbys, snapshot, NULL, false);
205 
206  /*
207  * Save additional parameters into the scandesc. Everything else was set
208  * up by RelationGetIndexScan.
209  */
210  scan->heapRelation = heapRelation;
211  scan->xs_snapshot = snapshot;
212 
213  /* prepare to fetch index matches from table */
214  scan->xs_heapfetch = table_index_fetch_begin(heapRelation);
215 
216  return scan;
217 }
static IndexFetchTableData * table_index_fetch_begin(Relation rel)
Definition: tableam.h:934
struct SnapshotData * xs_snapshot
Definition: relscan.h:104
Relation heapRelation
Definition: relscan.h:102
static IndexScanDesc index_beginscan_internal(Relation indexRelation, int nkeys, int norderbys, Snapshot snapshot, ParallelIndexScanDesc pscan, bool temp_snap)
Definition: indexam.c:247
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:135

◆ index_beginscan_bitmap()

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

Definition at line 226 of file indexam.c.

References index_beginscan_internal(), and IndexScanDescData::xs_snapshot.

Referenced by ExecInitBitmapIndexScan().

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

◆ index_beginscan_parallel()

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

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

478 {
479  Snapshot snapshot;
480  IndexScanDesc scan;
481 
482  Assert(RelationGetRelid(heaprel) == pscan->ps_relid);
483  snapshot = RestoreSnapshot(pscan->ps_snapshot_data);
484  RegisterSnapshot(snapshot);
485  scan = index_beginscan_internal(indexrel, nkeys, norderbys, snapshot,
486  pscan, true);
487 
488  /*
489  * Save additional parameters into the scandesc. Everything else was set
490  * up by index_beginscan_internal.
491  */
492  scan->heapRelation = heaprel;
493  scan->xs_snapshot = snapshot;
494 
495  /* prepare to fetch index matches from table */
496  scan->xs_heapfetch = table_index_fetch_begin(heaprel);
497 
498  return scan;
499 }
Snapshot RestoreSnapshot(char *start_address)
Definition: snapmgr.c:2161
Snapshot RegisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:865
static IndexFetchTableData * table_index_fetch_begin(Relation rel)
Definition: tableam.h:934
struct SnapshotData * xs_snapshot
Definition: relscan.h:104
char ps_snapshot_data[FLEXIBLE_ARRAY_MEMBER]
Definition: relscan.h:160
Relation heapRelation
Definition: relscan.h:102
static IndexScanDesc index_beginscan_internal(Relation indexRelation, int nkeys, int norderbys, Snapshot snapshot, ParallelIndexScanDesc pscan, bool temp_snap)
Definition: indexam.c:247
#define Assert(condition)
Definition: c.h:733
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:135
#define RelationGetRelid(relation)
Definition: rel.h:423

◆ index_bulk_delete()

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

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

686 {
687  Relation indexRelation = info->index;
688 
690  CHECK_REL_PROCEDURE(ambulkdelete);
691 
692  return indexRelation->rd_indam->ambulkdelete(info, stats,
693  callback, callback_state);
694 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:157
ambulkdelete_function ambulkdelete
Definition: amapi.h:213
#define RELATION_CHECKS
Definition: indexam.c:73
Relation index
Definition: genam.h:46
#define CHECK_REL_PROCEDURE(pname)
Definition: indexam.c:87
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 722 of file indexam.c.

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

Referenced by get_relation_info(), and indexam_property().

723 {
725 
726  /* amcanreturn is optional; assume false if not provided by AM */
727  if (indexRelation->rd_indam->amcanreturn == NULL)
728  return false;
729 
730  return indexRelation->rd_indam->amcanreturn(indexRelation, attno);
731 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:157
#define RELATION_CHECKS
Definition: indexam.c:73
amcanreturn_function amcanreturn
Definition: amapi.h:215

◆ index_close()

void index_close ( Relation  relation,
LOCKMODE  lockmode 
)

Definition at line 152 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(), 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(), 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(), ReindexIndex(), ReindexRelationConcurrently(), RelationFindReplTupleByIndex(), RelationGetIndexAttrBitmap(), RelationTruncateIndexes(), systable_endscan(), toast_close_indexes(), transformTableLikeClause(), TryReuseIndex(), unique_key_recheck(), vac_close_indexes(), vac_open_indexes(), and validate_index().

153 {
154  LockRelId relid = relation->rd_lockInfo.lockRelId;
155 
156  Assert(lockmode >= NoLock && lockmode < MAX_LOCKMODES);
157 
158  /* The relcache does the real work... */
159  RelationClose(relation);
160 
161  if (lockmode != NoLock)
162  UnlockRelationId(&relid, lockmode);
163 }
LockRelId lockRelId
Definition: rel.h:43
void UnlockRelationId(LockRelId *relid, LOCKMODE lockmode)
Definition: lmgr.c:184
Definition: rel.h:35
#define NoLock
Definition: lockdefs.h:34
LockInfoData rd_lockInfo
Definition: rel.h:86
void RelationClose(Relation relation)
Definition: relcache.c:2088
#define MAX_LOCKMODES
Definition: lock.h:85
#define Assert(condition)
Definition: c.h:733

◆ index_compute_xid_horizon_for_tuples()

TransactionId index_compute_xid_horizon_for_tuples ( Relation  irel,
Relation  hrel,
Buffer  ibuf,
OffsetNumber itemnos,
int  nitems 
)

Definition at line 281 of file genam.c.

References BufferGetPage, i, InvalidTransactionId, ItemPointerCopy, PageGetItem, PageGetItemId, palloc(), pfree(), IndexTupleData::t_tid, and table_compute_xid_horizon_for_tuples().

Referenced by _bt_delitems_delete(), _hash_vacuum_one_page(), and gistprunepage().

286 {
287  ItemPointerData *ttids =
288  (ItemPointerData *) palloc(sizeof(ItemPointerData) * nitems);
289  TransactionId latestRemovedXid = InvalidTransactionId;
290  Page ipage = BufferGetPage(ibuf);
291  IndexTuple itup;
292 
293  /* identify what the index tuples about to be deleted point to */
294  for (int i = 0; i < nitems; i++)
295  {
296  ItemId iitemid;
297 
298  iitemid = PageGetItemId(ipage, itemnos[i]);
299  itup = (IndexTuple) PageGetItem(ipage, iitemid);
300 
301  ItemPointerCopy(&itup->t_tid, &ttids[i]);
302  }
303 
304  /* determine the actual xid horizon */
305  latestRemovedXid =
306  table_compute_xid_horizon_for_tuples(hrel, ttids, nitems);
307 
308  pfree(ttids);
309 
310  return latestRemovedXid;
311 }
uint32 TransactionId
Definition: c.h:508
ItemPointerData t_tid
Definition: itup.h:37
static TransactionId table_compute_xid_horizon_for_tuples(Relation rel, ItemPointerData *items, int nitems)
Definition: tableam.h:1071
void pfree(void *pointer)
Definition: mcxt.c:1056
IndexTupleData * IndexTuple
Definition: itup.h:53
#define InvalidTransactionId
Definition: transam.h:31
#define BufferGetPage(buffer)
Definition: bufmgr.h:159
#define PageGetItemId(page, offsetNumber)
Definition: bufpage.h:235
void * palloc(Size size)
Definition: mcxt.c:949
int i
#define PageGetItem(page, itemId)
Definition: bufpage.h:340
Pointer Page
Definition: bufpage.h:78
#define ItemPointerCopy(fromPointer, toPointer)
Definition: itemptr.h:161

◆ index_endscan()

void index_endscan ( IndexScanDesc  scan)

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

316 {
317  SCAN_CHECKS;
318  CHECK_SCAN_PROCEDURE(amendscan);
319 
320  /* Release resources (like buffer pins) from table accesses */
321  if (scan->xs_heapfetch)
322  {
324  scan->xs_heapfetch = NULL;
325  }
326 
327  /* End the AM's scan */
328  scan->indexRelation->rd_indam->amendscan(scan);
329 
330  /* Release index refcount acquired by index_beginscan */
332 
333  if (scan->xs_temp_snap)
335 
336  /* Release the scan data structure itself */
337  IndexScanEnd(scan);
338 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:157
struct SnapshotData * xs_snapshot
Definition: relscan.h:104
#define CHECK_SCAN_PROCEDURE(pname)
Definition: indexam.c:94
Relation indexRelation
Definition: relscan.h:103
void RelationDecrementReferenceCount(Relation rel)
Definition: relcache.c:2068
amendscan_function amendscan
Definition: amapi.h:225
void IndexScanEnd(IndexScanDesc scan)
Definition: genam.c:144
void UnregisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:907
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:135
#define SCAN_CHECKS
Definition: indexam.c:80
static void table_index_fetch_end(struct IndexFetchTableData *scan)
Definition: tableam.h:953

◆ index_fetch_heap()

bool index_fetch_heap ( IndexScanDesc  scan,
struct TupleTableSlot slot 
)

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

567 {
568  bool all_dead = false;
569  bool found;
570 
571  found = table_index_fetch_tuple(scan->xs_heapfetch, &scan->xs_heaptid,
572  scan->xs_snapshot, slot,
573  &scan->xs_heap_continue, &all_dead);
574 
575  if (found)
577 
578  /*
579  * If we scanned a whole HOT chain and found only dead tuples, tell index
580  * AM to kill its entry for that TID (this will take effect in the next
581  * amgettuple call, in index_getnext_tid). We do not do this when in
582  * recovery because it may violate MVCC to do so. See comments in
583  * RelationGetIndexScan().
584  */
585  if (!scan->xactStartedInRecovery)
586  scan->kill_prior_tuple = all_dead;
587 
588  return found;
589 }
struct SnapshotData * xs_snapshot
Definition: relscan.h:104
Relation indexRelation
Definition: relscan.h:103
#define pgstat_count_heap_fetch(rel)
Definition: pgstat.h:1368
ItemPointerData xs_heaptid
Definition: relscan.h:132
bool xactStartedInRecovery
Definition: relscan.h:115
static bool table_index_fetch_tuple(struct IndexFetchTableData *scan, ItemPointer tid, Snapshot snapshot, TupleTableSlot *slot, bool *call_again, bool *all_dead)
Definition: tableam.h:981
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:135
bool xs_heap_continue
Definition: relscan.h:133
bool kill_prior_tuple
Definition: relscan.h:113

◆ index_getbitmap()

int64 index_getbitmap ( IndexScanDesc  scan,
TIDBitmap bitmap 
)

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

653 {
654  int64 ntids;
655 
656  SCAN_CHECKS;
657  CHECK_SCAN_PROCEDURE(amgetbitmap);
658 
659  /* just make sure this is false... */
660  scan->kill_prior_tuple = false;
661 
662  /*
663  * have the am's getbitmap proc do all the work.
664  */
665  ntids = scan->indexRelation->rd_indam->amgetbitmap(scan, bitmap);
666 
668 
669  return ntids;
670 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:157
#define CHECK_SCAN_PROCEDURE(pname)
Definition: indexam.c:94
Relation indexRelation
Definition: relscan.h:103
amgetbitmap_function amgetbitmap
Definition: amapi.h:224
#define SCAN_CHECKS
Definition: indexam.c:80
#define pgstat_count_index_tuples(rel, n)
Definition: pgstat.h:1378
bool kill_prior_tuple
Definition: relscan.h:113

◆ index_getnext_slot()

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

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

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

◆ index_getnext_tid()

ItemPointer index_getnext_tid ( IndexScanDesc  scan,
ScanDirection  direction 
)

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

510 {
511  bool found;
512 
513  SCAN_CHECKS;
514  CHECK_SCAN_PROCEDURE(amgettuple);
515 
517 
518  /*
519  * The AM's amgettuple proc finds the next index entry matching the scan
520  * keys, and puts the TID into scan->xs_heaptid. It should also set
521  * scan->xs_recheck and possibly scan->xs_itup/scan->xs_hitup, though we
522  * pay no attention to those fields here.
523  */
524  found = scan->indexRelation->rd_indam->amgettuple(scan, direction);
525 
526  /* Reset kill flag immediately for safety */
527  scan->kill_prior_tuple = false;
528  scan->xs_heap_continue = false;
529 
530  /* If we're out of index entries, we're done */
531  if (!found)
532  {
533  /* release resources (like buffer pins) from table accesses */
534  if (scan->xs_heapfetch)
536 
537  return NULL;
538  }
540 
542 
543  /* Return the TID of the tuple we found. */
544  return &scan->xs_heaptid;
545 }
#define ItemPointerIsValid(pointer)
Definition: itemptr.h:82
struct IndexAmRoutine * rd_indam
Definition: rel.h:157
amgettuple_function amgettuple
Definition: amapi.h:223
#define CHECK_SCAN_PROCEDURE(pname)
Definition: indexam.c:94
Relation indexRelation
Definition: relscan.h:103
ItemPointerData xs_heaptid
Definition: relscan.h:132
TransactionId RecentGlobalXmin
Definition: snapmgr.c:168
static void table_index_fetch_reset(struct IndexFetchTableData *scan)
Definition: tableam.h:944
#define Assert(condition)
Definition: c.h:733
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:135
#define SCAN_CHECKS
Definition: indexam.c:80
bool xs_heap_continue
Definition: relscan.h:133
#define pgstat_count_index_tuples(rel, n)
Definition: pgstat.h:1378
bool kill_prior_tuple
Definition: relscan.h:113
#define TransactionIdIsValid(xid)
Definition: transam.h:41

◆ index_getprocid()

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

Definition at line 760 of file indexam.c.

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

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

763 {
764  RegProcedure *loc;
765  int nproc;
766  int procindex;
767 
768  nproc = irel->rd_indam->amsupport;
769 
770  Assert(procnum > 0 && procnum <= (uint16) nproc);
771 
772  procindex = (nproc * (attnum - 1)) + (procnum - 1);
773 
774  loc = irel->rd_support;
775 
776  Assert(loc != NULL);
777 
778  return loc[procindex];
779 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:157
uint16 amsupport
Definition: amapi.h:173
regproc RegProcedure
Definition: c.h:506
unsigned short uint16
Definition: c.h:358
RegProcedure * rd_support
Definition: rel.h:160
int16 attnum
Definition: pg_attribute.h:79
#define Assert(condition)
Definition: c.h:733

◆ index_getprocinfo()

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

Definition at line 794 of file indexam.c.

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

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

797 {
798  FmgrInfo *locinfo;
799  int nproc;
800  int procindex;
801 
802  nproc = irel->rd_indam->amsupport;
803 
804  Assert(procnum > 0 && procnum <= (uint16) nproc);
805 
806  procindex = (nproc * (attnum - 1)) + (procnum - 1);
807 
808  locinfo = irel->rd_supportinfo;
809 
810  Assert(locinfo != NULL);
811 
812  locinfo += procindex;
813 
814  /* Initialize the lookup info if first time through */
815  if (locinfo->fn_oid == InvalidOid)
816  {
817  RegProcedure *loc = irel->rd_support;
818  RegProcedure procId;
819 
820  Assert(loc != NULL);
821 
822  procId = loc[procindex];
823 
824  /*
825  * Complain if function was not found during IndexSupportInitialize.
826  * This should not happen unless the system tables contain bogus
827  * entries for the index opclass. (If an AM wants to allow a support
828  * function to be optional, it can use index_getprocid.)
829  */
830  if (!RegProcedureIsValid(procId))
831  elog(ERROR, "missing support function %d for attribute %d of index \"%s\"",
832  procnum, attnum, RelationGetRelationName(irel));
833 
834  fmgr_info_cxt(procId, locinfo, irel->rd_indexcxt);
835  }
836 
837  return locinfo;
838 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:157
Definition: fmgr.h:56
uint16 amsupport
Definition: amapi.h:173
struct FmgrInfo * rd_supportinfo
Definition: rel.h:161
regproc RegProcedure
Definition: c.h:506
unsigned short uint16
Definition: c.h:358
#define ERROR
Definition: elog.h:43
#define RegProcedureIsValid(p)
Definition: c.h:641
#define RelationGetRelationName(relation)
Definition: rel.h:457
void fmgr_info_cxt(Oid functionId, FmgrInfo *finfo, MemoryContext mcxt)
Definition: fmgr.c:134
RegProcedure * rd_support
Definition: rel.h:160
#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:733
#define elog(elevel,...)
Definition: elog.h:228
MemoryContext rd_indexcxt
Definition: rel.h:155

◆ index_insert()

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

Definition at line 170 of file indexam.c.

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

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

177 {
179  CHECK_REL_PROCEDURE(aminsert);
180 
181  if (!(indexRelation->rd_indam->ampredlocks))
182  CheckForSerializableConflictIn(indexRelation,
183  (HeapTuple) NULL,
184  InvalidBuffer);
185 
186  return indexRelation->rd_indam->aminsert(indexRelation, values, isnull,
187  heap_t_ctid, heapRelation,
188  checkUnique, indexInfo);
189 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:157
#define RELATION_CHECKS
Definition: indexam.c:73
#define InvalidBuffer
Definition: buf.h:25
bool ampredlocks
Definition: amapi.h:195
aminsert_function aminsert
Definition: amapi.h:212
void CheckForSerializableConflictIn(Relation relation, HeapTuple tuple, Buffer buffer)
Definition: predicate.c:4426
#define CHECK_REL_PROCEDURE(pname)
Definition: indexam.c:87
static Datum values[MAXATTR]
Definition: bootstrap.c:167

◆ index_markpos()

void index_markpos ( IndexScanDesc  scan)

Definition at line 345 of file indexam.c.

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

Referenced by ExecIndexMarkPos(), and ExecIndexOnlyMarkPos().

346 {
347  SCAN_CHECKS;
348  CHECK_SCAN_PROCEDURE(ammarkpos);
349 
350  scan->indexRelation->rd_indam->ammarkpos(scan);
351 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:157
#define CHECK_SCAN_PROCEDURE(pname)
Definition: indexam.c:94
Relation indexRelation
Definition: relscan.h:103
#define SCAN_CHECKS
Definition: indexam.c:80
ammarkpos_function ammarkpos
Definition: amapi.h:226

◆ index_open()

Relation index_open ( Oid  relationId,
LOCKMODE  lockmode 
)

Definition at line 126 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(), 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(), 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(), ReindexIndex(), ReindexRelationConcurrently(), RelationFindReplTupleByIndex(), RelationGetIndexAttrBitmap(), RelationTruncateIndexes(), systable_beginscan(), toast_open_indexes(), transformIndexConstraint(), transformTableLikeClause(), TryReuseIndex(), unique_key_recheck(), vac_open_indexes(), and validate_index().

127 {
128  Relation r;
129 
130  r = relation_open(relationId, lockmode);
131 
132  if (r->rd_rel->relkind != RELKIND_INDEX &&
133  r->rd_rel->relkind != RELKIND_PARTITIONED_INDEX)
134  ereport(ERROR,
135  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
136  errmsg("\"%s\" is not an index",
138 
139  return r;
140 }
int errcode(int sqlerrcode)
Definition: elog.c:608
Form_pg_class rd_rel
Definition: rel.h:83
#define ERROR
Definition: elog.h:43
Relation relation_open(Oid relationId, LOCKMODE lockmode)
Definition: relation.c:48
#define RelationGetRelationName(relation)
Definition: rel.h:457
#define ereport(elevel, rest)
Definition: elog.h:141
int errmsg(const char *fmt,...)
Definition: elog.c:822

◆ index_parallelrescan()

void index_parallelrescan ( IndexScanDesc  scan)

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

459 {
460  SCAN_CHECKS;
461 
462  if (scan->xs_heapfetch)
464 
465  /* amparallelrescan is optional; assume no-op if not provided by AM */
466  if (scan->indexRelation->rd_indam->amparallelrescan != NULL)
468 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:157
amparallelrescan_function amparallelrescan
Definition: amapi.h:232
Relation indexRelation
Definition: relscan.h:103
static void table_index_fetch_reset(struct IndexFetchTableData *scan)
Definition: tableam.h:944
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:135
#define SCAN_CHECKS
Definition: indexam.c:80

◆ index_parallelscan_estimate()

Size index_parallelscan_estimate ( Relation  indexrel,
Snapshot  snapshot 
)

Definition at line 394 of file indexam.c.

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

Referenced by ExecIndexOnlyScanEstimate(), and ExecIndexScanEstimate().

395 {
396  Size nbytes;
397 
399 
400  nbytes = offsetof(ParallelIndexScanDescData, ps_snapshot_data);
401  nbytes = add_size(nbytes, EstimateSnapshotSpace(snapshot));
402  nbytes = MAXALIGN(nbytes);
403 
404  /*
405  * If amestimateparallelscan is not provided, assume there is no
406  * AM-specific data needed. (It's hard to believe that could work, but
407  * it's easy enough to cater to it here.)
408  */
409  if (indexRelation->rd_indam->amestimateparallelscan != NULL)
410  nbytes = add_size(nbytes,
411  indexRelation->rd_indam->amestimateparallelscan());
412 
413  return nbytes;
414 }
#define RELATION_CHECKS
Definition: indexam.c:73
Size EstimateSnapshotSpace(Snapshot snap)
Definition: snapmgr.c:2078
Size add_size(Size s1, Size s2)
Definition: shmem.c:475
size_t Size
Definition: c.h:467
#define MAXALIGN(LEN)
Definition: c.h:686
#define offsetof(type, field)
Definition: c.h:656

◆ index_parallelscan_initialize()

void index_parallelscan_initialize ( Relation  heaprel,
Relation  indexrel,
Snapshot  snapshot,
ParallelIndexScanDesc  target 
)

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

429 {
430  Size offset;
431 
433 
434  offset = add_size(offsetof(ParallelIndexScanDescData, ps_snapshot_data),
435  EstimateSnapshotSpace(snapshot));
436  offset = MAXALIGN(offset);
437 
438  target->ps_relid = RelationGetRelid(heapRelation);
439  target->ps_indexid = RelationGetRelid(indexRelation);
440  target->ps_offset = offset;
441  SerializeSnapshot(snapshot, target->ps_snapshot_data);
442 
443  /* aminitparallelscan is optional; assume no-op if not provided by AM */
444  if (indexRelation->rd_indam->aminitparallelscan != NULL)
445  {
446  void *amtarget;
447 
448  amtarget = OffsetToPointer(target, offset);
449  indexRelation->rd_indam->aminitparallelscan(amtarget);
450  }
451 }
#define RELATION_CHECKS
Definition: indexam.c:73
char ps_snapshot_data[FLEXIBLE_ARRAY_MEMBER]
Definition: relscan.h:160
void SerializeSnapshot(Snapshot snapshot, char *start_address)
Definition: snapmgr.c:2102
#define OffsetToPointer(base, offset)
Definition: c.h:636
Size EstimateSnapshotSpace(Snapshot snap)
Definition: snapmgr.c:2078
Size add_size(Size s1, Size s2)
Definition: shmem.c:475
size_t Size
Definition: c.h:467
#define MAXALIGN(LEN)
Definition: c.h:686
#define RelationGetRelid(relation)
Definition: rel.h:423
#define offsetof(type, field)
Definition: c.h:656

◆ index_rescan()

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

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

292 {
293  SCAN_CHECKS;
294  CHECK_SCAN_PROCEDURE(amrescan);
295 
296  Assert(nkeys == scan->numberOfKeys);
297  Assert(norderbys == scan->numberOfOrderBys);
298 
299  /* Release resources (like buffer pins) from table accesses */
300  if (scan->xs_heapfetch)
302 
303  scan->kill_prior_tuple = false; /* for safety */
304  scan->xs_heap_continue = false;
305 
306  scan->indexRelation->rd_indam->amrescan(scan, keys, nkeys,
307  orderbys, norderbys);
308 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:157
#define CHECK_SCAN_PROCEDURE(pname)
Definition: indexam.c:94
Relation indexRelation
Definition: relscan.h:103
amrescan_function amrescan
Definition: amapi.h:222
static void table_index_fetch_reset(struct IndexFetchTableData *scan)
Definition: tableam.h:944
#define Assert(condition)
Definition: c.h:733
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:135
#define SCAN_CHECKS
Definition: indexam.c:80
bool xs_heap_continue
Definition: relscan.h:133
bool kill_prior_tuple
Definition: relscan.h:113
int numberOfOrderBys
Definition: relscan.h:106

◆ index_restrpos()

void index_restrpos ( IndexScanDesc  scan)

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

370 {
372 
373  SCAN_CHECKS;
374  CHECK_SCAN_PROCEDURE(amrestrpos);
375 
376  /* release resources (like buffer pins) from table accesses */
377  if (scan->xs_heapfetch)
379 
380  scan->kill_prior_tuple = false; /* for safety */
381  scan->xs_heap_continue = false;
382 
383  scan->indexRelation->rd_indam->amrestrpos(scan);
384 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:157
struct SnapshotData * xs_snapshot
Definition: relscan.h:104
#define CHECK_SCAN_PROCEDURE(pname)
Definition: indexam.c:94
Relation indexRelation
Definition: relscan.h:103
#define IsMVCCSnapshot(snapshot)
Definition: snapmgr.h:97
static void table_index_fetch_reset(struct IndexFetchTableData *scan)
Definition: tableam.h:944
#define Assert(condition)
Definition: c.h:733
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:135
#define SCAN_CHECKS
Definition: indexam.c:80
bool xs_heap_continue
Definition: relscan.h:133
bool kill_prior_tuple
Definition: relscan.h:113
amrestrpos_function amrestrpos
Definition: amapi.h:227

◆ index_store_float8_orderby_distances()

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

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

852 {
853  int i;
854 
855  Assert(distances || !recheckOrderBy);
856 
857  scan->xs_recheckorderby = recheckOrderBy;
858 
859  for (i = 0; i < scan->numberOfOrderBys; i++)
860  {
861  if (orderByTypes[i] == FLOAT8OID)
862  {
863 #ifndef USE_FLOAT8_BYVAL
864  /* must free any old value to avoid memory leakage */
865  if (!scan->xs_orderbynulls[i])
867 #endif
868  if (distances && !distances[i].isnull)
869  {
870  scan->xs_orderbyvals[i] = Float8GetDatum(distances[i].value);
871  scan->xs_orderbynulls[i] = false;
872  }
873  else
874  {
875  scan->xs_orderbyvals[i] = (Datum) 0;
876  scan->xs_orderbynulls[i] = true;
877  }
878  }
879  else if (orderByTypes[i] == FLOAT4OID)
880  {
881  /* convert distance function's result to ORDER BY type */
882 #ifndef USE_FLOAT4_BYVAL
883  /* must free any old value to avoid memory leakage */
884  if (!scan->xs_orderbynulls[i])
886 #endif
887  if (distances && !distances[i].isnull)
888  {
889  scan->xs_orderbyvals[i] = Float4GetDatum((float4) distances[i].value);
890  scan->xs_orderbynulls[i] = false;
891  }
892  else
893  {
894  scan->xs_orderbyvals[i] = (Datum) 0;
895  scan->xs_orderbynulls[i] = true;
896  }
897  }
898  else
899  {
900  /*
901  * If the ordering operator's return value is anything else, we
902  * don't know how to convert the float8 bound calculated by the
903  * distance function to that. The executor won't actually need
904  * the order by values we return here, if there are no lossy
905  * results, so only insist on converting if the *recheck flag is
906  * set.
907  */
908  if (scan->xs_recheckorderby)
909  elog(ERROR, "ORDER BY operator must return float8 or float4 if the distance function is lossy");
910  scan->xs_orderbynulls[i] = true;
911  }
912  }
913 }
static struct @145 value
Datum * xs_orderbyvals
Definition: relscan.h:146
bool xs_recheckorderby
Definition: relscan.h:148
Datum Float8GetDatum(float8 X)
Definition: fmgr.c:1723
bool * xs_orderbynulls
Definition: relscan.h:147
void pfree(void *pointer)
Definition: mcxt.c:1056
#define ERROR
Definition: elog.h:43
Datum Float4GetDatum(float4 X)
Definition: fmgr.c:1711
float float4
Definition: c.h:491
uintptr_t Datum
Definition: postgres.h:367
#define Assert(condition)
Definition: c.h:733
#define DatumGetPointer(X)
Definition: postgres.h:549
#define elog(elevel,...)
Definition: elog.h:228
int i
int numberOfOrderBys
Definition: relscan.h:106

◆ index_vacuum_cleanup()

IndexBulkDeleteResult* index_vacuum_cleanup ( IndexVacuumInfo info,
IndexBulkDeleteResult stats 
)

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

705 {
706  Relation indexRelation = info->index;
707 
709  CHECK_REL_PROCEDURE(amvacuumcleanup);
710 
711  return indexRelation->rd_indam->amvacuumcleanup(info, stats);
712 }
struct IndexAmRoutine * rd_indam
Definition: rel.h:157
#define RELATION_CHECKS
Definition: indexam.c:73
Relation index
Definition: genam.h:46
#define CHECK_REL_PROCEDURE(pname)
Definition: indexam.c:87
amvacuumcleanup_function amvacuumcleanup
Definition: amapi.h:214

◆ IndexScanEnd()

void IndexScanEnd ( IndexScanDesc  scan)

Definition at line 144 of file genam.c.

References IndexScanDescData::keyData, IndexScanDescData::orderByData, and pfree().

Referenced by index_endscan().

145 {
146  if (scan->keyData != NULL)
147  pfree(scan->keyData);
148  if (scan->orderByData != NULL)
149  pfree(scan->orderByData);
150 
151  pfree(scan);
152 }
struct ScanKeyData * orderByData
Definition: relscan.h:108
void pfree(void *pointer)
Definition: mcxt.c:1056
struct ScanKeyData * keyData
Definition: relscan.h:107

◆ RelationGetIndexScan()

IndexScanDesc RelationGetIndexScan ( Relation  indexRelation,
int  nkeys,
int  norderbys 
)

Definition at line 80 of file genam.c.

References IndexScanDescData::heapRelation, IndexScanDescData::ignore_killed_tuples, IndexScanDescData::indexRelation, InvalidSnapshot, IndexScanDescData::keyData, IndexScanDescData::kill_prior_tuple, IndexScanDescData::numberOfKeys, IndexScanDescData::numberOfOrderBys, IndexScanDescData::opaque, IndexScanDescData::orderByData, palloc(), TransactionStartedDuringRecovery(), IndexScanDescData::xactStartedInRecovery, IndexScanDescData::xs_heapfetch, IndexScanDescData::xs_hitup, IndexScanDescData::xs_hitupdesc, IndexScanDescData::xs_itup, IndexScanDescData::xs_itupdesc, IndexScanDescData::xs_snapshot, and IndexScanDescData::xs_want_itup.

Referenced by blbeginscan(), brinbeginscan(), btbeginscan(), dibeginscan(), ginbeginscan(), gistbeginscan(), hashbeginscan(), and spgbeginscan().

81 {
82  IndexScanDesc scan;
83 
84  scan = (IndexScanDesc) palloc(sizeof(IndexScanDescData));
85 
86  scan->heapRelation = NULL; /* may be set later */
87  scan->xs_heapfetch = NULL;
88  scan->indexRelation = indexRelation;
89  scan->xs_snapshot = InvalidSnapshot; /* caller must initialize this */
90  scan->numberOfKeys = nkeys;
91  scan->numberOfOrderBys = norderbys;
92 
93  /*
94  * We allocate key workspace here, but it won't get filled until amrescan.
95  */
96  if (nkeys > 0)
97  scan->keyData = (ScanKey) palloc(sizeof(ScanKeyData) * nkeys);
98  else
99  scan->keyData = NULL;
100  if (norderbys > 0)
101  scan->orderByData = (ScanKey) palloc(sizeof(ScanKeyData) * norderbys);
102  else
103  scan->orderByData = NULL;
104 
105  scan->xs_want_itup = false; /* may be set later */
106 
107  /*
108  * During recovery we ignore killed tuples and don't bother to kill them
109  * either. We do this because the xmin on the primary node could easily be
110  * later than the xmin on the standby node, so that what the primary
111  * thinks is killed is supposed to be visible on standby. So for correct
112  * MVCC for queries during recovery we must ignore these hints and check
113  * all tuples. Do *not* set ignore_killed_tuples to true when running in a
114  * transaction that was started during recovery. xactStartedInRecovery
115  * should not be altered by index AMs.
116  */
117  scan->kill_prior_tuple = false;
120 
121  scan->opaque = NULL;
122 
123  scan->xs_itup = NULL;
124  scan->xs_itupdesc = NULL;
125  scan->xs_hitup = NULL;
126  scan->xs_hitupdesc = NULL;
127 
128  return scan;
129 }
bool TransactionStartedDuringRecovery(void)
Definition: xact.c:954
struct ScanKeyData * orderByData
Definition: relscan.h:108
IndexTuple xs_itup
Definition: relscan.h:127
struct TupleDescData * xs_itupdesc
Definition: relscan.h:128
struct TupleDescData * xs_hitupdesc
Definition: relscan.h:130
struct SnapshotData * xs_snapshot
Definition: relscan.h:104
bool ignore_killed_tuples
Definition: relscan.h:114
Relation indexRelation
Definition: relscan.h:103
Relation heapRelation
Definition: relscan.h:102
bool xactStartedInRecovery
Definition: relscan.h:115
ScanKeyData * ScanKey
Definition: skey.h:75
#define InvalidSnapshot
Definition: snapshot.h:123
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:135
struct ScanKeyData * keyData
Definition: relscan.h:107
void * palloc(Size size)
Definition: mcxt.c:949
HeapTuple xs_hitup
Definition: relscan.h:129
bool kill_prior_tuple
Definition: relscan.h:113
int numberOfOrderBys
Definition: relscan.h:106
struct IndexScanDescData * IndexScanDesc
Definition: genam.h:87

◆ systable_beginscan()

SysScanDesc systable_beginscan ( Relation  heapRelation,
Oid  indexId,
bool  indexOK,
Snapshot  snapshot,
int  nkeys,
ScanKey  key 
)

Definition at line 352 of file genam.c.

References AccessShareLock, elog, ERROR, GetCatalogSnapshot(), SysScanDescData::heap_rel, i, IgnoreSystemIndexes, index_beginscan(), index_open(), index_rescan(), IndexRelationGetNumberOfAttributes, SysScanDescData::irel, SysScanDescData::iscan, palloc(), RelationData::rd_index, RegisterSnapshot(), ReindexIsProcessingIndex(), RelationGetRelid, SysScanDescData::scan, ScanKeyData::sk_attno, SysScanDescData::slot, SysScanDescData::snapshot, table_beginscan_strat(), and table_slot_create().

Referenced by AfterTriggerSetState(), AlterConstraintNamespaces(), AlterDatabase(), AlterDatabaseOwner(), AlterDomainDropConstraint(), AlterDomainValidateConstraint(), AlterExtensionNamespace(), AlterPolicy(), AlterSeqNamespaces(), AlterSetting(), ApplyExtensionUpdates(), ApplySetting(), ATExecAddOf(), ATExecAlterColumnType(), ATExecAlterConstraint(), ATExecAttachPartition(), ATExecDropConstraint(), ATExecValidateConstraint(), ATPrepChangePersistence(), AttrDefaultFetch(), change_owner_fix_column_acls(), change_owner_recurse_to_sequences(), changeDependenciesOf(), changeDependenciesOn(), changeDependencyFor(), CheckConstraintFetch(), checkSharedDependencies(), ChooseConstraintName(), CloneFkReferenced(), CloneRowTriggersToPartition(), ConstraintNameExists(), ConstraintNameIsUsed(), copyTemplateDependencies(), CountDBSubscriptions(), CreateComments(), CreateInheritance(), CreatePolicy(), CreateSharedComments(), CreateTrigger(), DefineOpClass(), DefineTSConfiguration(), DeleteAttributeTuples(), DeleteComments(), deleteDependencyRecordsFor(), deleteDependencyRecordsForClass(), DeleteInheritsTuple(), DeleteInitPrivs(), deleteOneObject(), DeleteSecurityLabel(), DeleteSharedComments(), DeleteSharedSecurityLabel(), DeleteSystemAttributeTuples(), drop_parent_dependency(), DropCastById(), DropConfigurationMapping(), dropDatabaseDependencies(), DropRole(), DropTransformById(), EnableDisableTrigger(), EnumValuesDelete(), exec_object_restorecon(), ExecAlterExtensionStmt(), ExecGrant_Largeobject(), extension_config_remove(), fetch_statentries_for_relation(), find_composite_type_dependencies(), find_inheritance_children(), find_language_template(), findDependentObjects(), get_catalog_object_by_oid(), get_constraint_index(), get_database_oid(), get_db_info(), get_domain_constraint_oid(), get_extension_name(), get_extension_oid(), get_extension_schema(), get_index_constraint(), get_index_ref_constraints(), get_object_address_attrdef(), get_partition_parent_worker(), get_pkey_attnames(), get_primary_key_attnos(), get_relation_constraint_attnos(), get_relation_constraint_oid(), get_relation_idx_constraint_oid(), get_relation_policy_oid(), get_rels_with_domain(), get_trigger_oid(), GetAllTablesPublications(), GetComment(), GetDatabaseTuple(), GetDatabaseTupleByOid(), GetDefaultOpClass(), getExtensionOfObject(), GetNewOidWithIndex(), getObjectDescription(), getObjectIdentityParts(), getOwnedSequences_internal(), GetParentedForeignKeyRefs(), GetPublicationRelations(), GetSecurityLabel(), GetSharedSecurityLabel(), GetSubscriptionNotReadyRelations(), GetSubscriptionRelations(), has_superclass(), heap_truncate_find_FKs(), index_concurrently_swap(), IndexSetParentIndex(), isObjectPinned(), isSharedObjectPinned(), LargeObjectDrop(), LargeObjectExists(), load_domaintype_info(), load_enum_cache_data(), LookupOpclassInfo(), makeConfigurationDependencies(), MakeConfigurationMapping(), MergeConstraintsIntoExisting(), MergeWithExistingConstraint(), movedb(), myLargeObjectExists(), pg_extension_config_dump(), pg_extension_ownercheck(), pg_get_constraintdef_worker(), pg_get_serial_sequence(), pg_get_triggerdef_worker(), pg_largeobject_aclmask_snapshot(), pg_largeobject_ownercheck(), RangeDelete(), recordExtensionInitPrivWorker(), recordExtObjInitPriv(), relation_has_policies(), RelationBuildPartitionDesc(), RelationBuildRowSecurity(), RelationBuildRuleLock(), RelationBuildTriggers(), RelationBuildTupleDesc(), RelationGetExclusionInfo(), RelationGetFKeyList(), RelationGetIndexList(), RelationGetStatExtList(), RelationRemoveInheritance(), RelidByRelfilenode(), RemoveAmOpEntryById(), RemoveAmProcEntryById(), RemoveAttrDefault(), RemoveAttrDefaultById(), RemoveCollationById(), RemoveDefaultACLById(), RemoveExtensionById(), RemoveInheritance(), RemovePolicyById(), RemoveRewriteRuleById(), RemoveRoleFromObjectACL(), RemoveRoleFromObjectPolicy(), RemoveStatistics(), RemoveTriggerById(), RemoveTSConfigurationById(), rename_policy(), renametrig(), replorigin_create(), ScanPgRelation(), SearchCatCacheList(), SearchCatCacheMiss(), sepgsql_attribute_post_create(), sepgsql_database_post_create(), sepgsql_proc_post_create(), sepgsql_proc_setattr(), sepgsql_relation_post_create(), sepgsql_relation_setattr(), sepgsql_relation_setattr_extra(), sepgsql_schema_post_create(), sequenceIsOwned(), SetSecurityLabel(), SetSharedSecurityLabel(), shdepChangeDep(), shdepDropDependency(), shdepDropOwned(), shdepReassignOwned(), toastrel_valueid_exists(), tryAttachPartitionForeignKey(), typeInheritsFrom(), vac_update_datfrozenxid(), and validatePartitionedIndex().

357 {
358  SysScanDesc sysscan;
359  Relation irel;
360 
361  if (indexOK &&
363  !ReindexIsProcessingIndex(indexId))
364  irel = index_open(indexId, AccessShareLock);
365  else
366  irel = NULL;
367 
368  sysscan = (SysScanDesc) palloc(sizeof(SysScanDescData));
369 
370  sysscan->heap_rel = heapRelation;
371  sysscan->irel = irel;
372  sysscan->slot = table_slot_create(heapRelation, NULL);
373 
374  if (snapshot == NULL)
375  {
376  Oid relid = RelationGetRelid(heapRelation);
377 
378  snapshot = RegisterSnapshot(GetCatalogSnapshot(relid));
379  sysscan->snapshot = snapshot;
380  }
381  else
382  {
383  /* Caller is responsible for any snapshot. */
384  sysscan->snapshot = NULL;
385  }
386 
387  if (irel)
388  {
389  int i;
390 
391  /* Change attribute numbers to be index column numbers. */
392  for (i = 0; i < nkeys; i++)
393  {
394  int j;
395 
396  for (j = 0; j < IndexRelationGetNumberOfAttributes(irel); j++)
397  {
398  if (key[i].sk_attno == irel->rd_index->indkey.values[j])
399  {
400  key[i].sk_attno = j + 1;
401  break;
402  }
403  }
404  if (j == IndexRelationGetNumberOfAttributes(irel))
405  elog(ERROR, "column is not in index");
406  }
407 
408  sysscan->iscan = index_beginscan(heapRelation, irel,
409  snapshot, nkeys, 0);
410  index_rescan(sysscan->iscan, key, nkeys, NULL, 0);
411  sysscan->scan = NULL;
412  }
413  else
414  {
415  /*
416  * We disallow synchronized scans when forced to use a heapscan on a
417  * catalog. In most cases the desired rows are near the front, so
418  * that the unpredictable start point of a syncscan is a serious
419  * disadvantage; and there are no compensating advantages, because
420  * it's unlikely that such scans will occur in parallel.
421  */
422  sysscan->scan = table_beginscan_strat(heapRelation, snapshot,
423  nkeys, key,
424  true, false);
425  sysscan->iscan = NULL;
426  }
427 
428  return sysscan;
429 }
TupleTableSlot * table_slot_create(Relation relation, List **reglist)
Definition: tableam.c:77
Relation irel
Definition: relscan.h:169
struct SysScanDescData * SysScanDesc
Definition: genam.h:88
Relation heap_rel
Definition: relscan.h:168
Snapshot RegisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:865
struct SnapshotData * snapshot
Definition: relscan.h:172
Snapshot GetCatalogSnapshot(Oid relid)
Definition: snapmgr.c:442
#define AccessShareLock
Definition: lockdefs.h:36
void index_rescan(IndexScanDesc scan, ScanKey keys, int nkeys, ScanKey orderbys, int norderbys)
Definition: indexam.c:289
bool IgnoreSystemIndexes
Definition: miscinit.c:77
unsigned int Oid
Definition: postgres_ext.h:31
struct IndexScanDescData * iscan
Definition: relscan.h:171
struct TupleTableSlot * slot
Definition: relscan.h:173
static TableScanDesc table_beginscan_strat(Relation rel, Snapshot snapshot, int nkeys, struct ScanKeyData *key, bool allow_strat, bool allow_sync)
Definition: tableam.h:760
Form_pg_index rd_index
Definition: rel.h:143
#define ERROR
Definition: elog.h:43
struct TableScanDescData * scan
Definition: relscan.h:170
#define IndexRelationGetNumberOfAttributes(relation)
Definition: rel.h:435
void * palloc(Size size)
Definition: mcxt.c:949
#define elog(elevel,...)
Definition: elog.h:228
int i
bool ReindexIsProcessingIndex(Oid indexOid)
Definition: index.c:3742
#define RelationGetRelid(relation)
Definition: rel.h:423
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:126
AttrNumber sk_attno
Definition: skey.h:67
IndexScanDesc index_beginscan(Relation heapRelation, Relation indexRelation, Snapshot snapshot, int nkeys, int norderbys)
Definition: indexam.c:197

◆ systable_beginscan_ordered()

SysScanDesc systable_beginscan_ordered ( Relation  heapRelation,
Relation  indexRelation,
Snapshot  snapshot,
int  nkeys,
ScanKey  key 
)

Definition at line 565 of file genam.c.

References elog, ERROR, GetCatalogSnapshot(), SysScanDescData::heap_rel, i, IgnoreSystemIndexes, index_beginscan(), index_rescan(), IndexRelationGetNumberOfAttributes, SysScanDescData::irel, SysScanDescData::iscan, palloc(), RelationData::rd_index, RegisterSnapshot(), ReindexIsProcessingIndex(), RelationGetRelationName, RelationGetRelid, SysScanDescData::scan, ScanKeyData::sk_attno, SysScanDescData::slot, SysScanDescData::snapshot, table_slot_create(), and WARNING.

Referenced by BuildEventTriggerCache(), enum_endpoint(), enum_range_internal(), inv_getsize(), inv_read(), inv_truncate(), inv_write(), lookup_ts_config_cache(), toast_delete_datum(), toast_fetch_datum(), and toast_fetch_datum_slice().

569 {
570  SysScanDesc sysscan;
571  int i;
572 
573  /* REINDEX can probably be a hard error here ... */
574  if (ReindexIsProcessingIndex(RelationGetRelid(indexRelation)))
575  elog(ERROR, "cannot do ordered scan on index \"%s\", because it is being reindexed",
576  RelationGetRelationName(indexRelation));
577  /* ... but we only throw a warning about violating IgnoreSystemIndexes */
579  elog(WARNING, "using index \"%s\" despite IgnoreSystemIndexes",
580  RelationGetRelationName(indexRelation));
581 
582  sysscan = (SysScanDesc) palloc(sizeof(SysScanDescData));
583 
584  sysscan->heap_rel = heapRelation;
585  sysscan->irel = indexRelation;
586  sysscan->slot = table_slot_create(heapRelation, NULL);
587 
588  if (snapshot == NULL)
589  {
590  Oid relid = RelationGetRelid(heapRelation);
591 
592  snapshot = RegisterSnapshot(GetCatalogSnapshot(relid));
593  sysscan->snapshot = snapshot;
594  }
595  else
596  {
597  /* Caller is responsible for any snapshot. */
598  sysscan->snapshot = NULL;
599  }
600 
601  /* Change attribute numbers to be index column numbers. */
602  for (i = 0; i < nkeys; i++)
603  {
604  int j;
605 
606  for (j = 0; j < IndexRelationGetNumberOfAttributes(indexRelation); j++)
607  {
608  if (key[i].sk_attno == indexRelation->rd_index->indkey.values[j])
609  {
610  key[i].sk_attno = j + 1;
611  break;
612  }
613  }
614  if (j == IndexRelationGetNumberOfAttributes(indexRelation))
615  elog(ERROR, "column is not in index");
616  }
617 
618  sysscan->iscan = index_beginscan(heapRelation, indexRelation,
619  snapshot, nkeys, 0);
620  index_rescan(sysscan->iscan, key, nkeys, NULL, 0);
621  sysscan->scan = NULL;
622 
623  return sysscan;
624 }
TupleTableSlot * table_slot_create(Relation relation, List **reglist)
Definition: tableam.c:77
Relation irel
Definition: relscan.h:169
struct SysScanDescData * SysScanDesc
Definition: genam.h:88
Relation heap_rel
Definition: relscan.h:168
Snapshot RegisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:865
struct SnapshotData * snapshot
Definition: relscan.h:172
Snapshot GetCatalogSnapshot(Oid relid)
Definition: snapmgr.c:442
void index_rescan(IndexScanDesc scan, ScanKey keys, int nkeys, ScanKey orderbys, int norderbys)
Definition: indexam.c:289
bool IgnoreSystemIndexes
Definition: miscinit.c:77
unsigned int Oid
Definition: postgres_ext.h:31
struct IndexScanDescData * iscan
Definition: relscan.h:171
struct TupleTableSlot * slot
Definition: relscan.h:173
Form_pg_index rd_index
Definition: rel.h:143
#define ERROR
Definition: elog.h:43
struct TableScanDescData * scan
Definition: relscan.h:170
#define IndexRelationGetNumberOfAttributes(relation)
Definition: rel.h:435
#define RelationGetRelationName(relation)
Definition: rel.h:457
#define WARNING
Definition: elog.h:40
void * palloc(Size size)
Definition: mcxt.c:949
#define elog(elevel,...)
Definition: elog.h:228
int i
bool ReindexIsProcessingIndex(Oid indexOid)
Definition: index.c:3742
#define RelationGetRelid(relation)
Definition: rel.h:423
AttrNumber sk_attno
Definition: skey.h:67
IndexScanDesc index_beginscan(Relation heapRelation, Relation indexRelation, Snapshot snapshot, int nkeys, int norderbys)
Definition: indexam.c:197

◆ systable_endscan()

void systable_endscan ( SysScanDesc  sysscan)

Definition at line 525 of file genam.c.

References AccessShareLock, ExecDropSingleTupleTableSlot(), index_close(), index_endscan(), SysScanDescData::irel, SysScanDescData::iscan, pfree(), SysScanDescData::scan, SysScanDescData::slot, SysScanDescData::snapshot, table_endscan(), and UnregisterSnapshot().

Referenced by AfterTriggerSetState(), AlterConstraintNamespaces(), AlterDatabase(), AlterDatabaseOwner(), AlterDomainDropConstraint(), AlterDomainValidateConstraint(), AlterExtensionNamespace(), AlterPolicy(), AlterSeqNamespaces(), AlterSetting(), ApplyExtensionUpdates(), ApplySetting(), ATExecAddOf(), ATExecAlterColumnType(), ATExecAlterConstraint(), ATExecAttachPartition(), ATExecDropConstraint(), ATExecValidateConstraint(), ATPrepChangePersistence(), AttrDefaultFetch(), change_owner_fix_column_acls(), change_owner_recurse_to_sequences(), changeDependenciesOf(), changeDependenciesOn(), changeDependencyFor(), CheckConstraintFetch(), checkSharedDependencies(), ChooseConstraintName(), CloneFkReferenced(), CloneRowTriggersToPartition(), ConstraintNameExists(), ConstraintNameIsUsed(), copyTemplateDependencies(), CountDBSubscriptions(), CreateComments(), CreateInheritance(), CreatePolicy(), CreateSharedComments(), CreateTrigger(), DefineOpClass(), DefineTSConfiguration(), DeleteAttributeTuples(), DeleteComments(), deleteDependencyRecordsFor(), deleteDependencyRecordsForClass(), DeleteInheritsTuple(), DeleteInitPrivs(), deleteOneObject(), DeleteSecurityLabel(), DeleteSharedComments(), DeleteSharedSecurityLabel(), DeleteSystemAttributeTuples(), drop_parent_dependency(), DropCastById(), DropConfigurationMapping(), dropDatabaseDependencies(), DropRole(), DropTransformById(), EnableDisableTrigger(), EnumValuesDelete(), exec_object_restorecon(), ExecAlterExtensionStmt(), ExecGrant_Largeobject(), extension_config_remove(), fetch_statentries_for_relation(), find_composite_type_dependencies(), find_inheritance_children(), find_language_template(), findDependentObjects(), get_catalog_object_by_oid(), get_constraint_index(), get_database_oid(), get_db_info(), get_domain_constraint_oid(), get_extension_name(), get_extension_oid(), get_extension_schema(), get_index_constraint(), get_index_ref_constraints(), get_object_address_attrdef(), get_partition_parent_worker(), get_pkey_attnames(), get_primary_key_attnos(), get_relation_constraint_attnos(), get_relation_constraint_oid(), get_relation_idx_constraint_oid(), get_relation_policy_oid(), get_rels_with_domain(), get_trigger_oid(), GetAllTablesPublications(), GetComment(), GetDatabaseTuple(), GetDatabaseTupleByOid(), GetDefaultOpClass(), getExtensionOfObject(), GetNewOidWithIndex(), getObjectDescription(), getObjectIdentityParts(), getOwnedSequences_internal(), GetParentedForeignKeyRefs(), GetPublicationRelations(), GetSecurityLabel(), GetSharedSecurityLabel(), GetSubscriptionNotReadyRelations(), GetSubscriptionRelations(), has_superclass(), heap_truncate_find_FKs(), index_concurrently_swap(), IndexSetParentIndex(), isObjectPinned(), isSharedObjectPinned(), LargeObjectDrop(), LargeObjectExists(), load_domaintype_info(), load_enum_cache_data(), LookupOpclassInfo(), makeConfigurationDependencies(), MakeConfigurationMapping(), MergeConstraintsIntoExisting(), MergeWithExistingConstraint(), movedb(), myLargeObjectExists(), pg_extension_config_dump(), pg_extension_ownercheck(), pg_get_constraintdef_worker(), pg_get_serial_sequence(), pg_get_triggerdef_worker(), pg_largeobject_aclmask_snapshot(), pg_largeobject_ownercheck(), RangeDelete(), recordExtensionInitPrivWorker(), recordExtObjInitPriv(), relation_has_policies(), RelationBuildPartitionDesc(), RelationBuildRowSecurity(), RelationBuildRuleLock(), RelationBuildTriggers(), RelationBuildTupleDesc(), RelationGetExclusionInfo(), RelationGetFKeyList(), RelationGetIndexList(), RelationGetStatExtList(), RelationRemoveInheritance(), RelidByRelfilenode(), RemoveAmOpEntryById(), RemoveAmProcEntryById(), RemoveAttrDefault(), RemoveAttrDefaultById(), RemoveCollationById(), RemoveDefaultACLById(), RemoveExtensionById(), RemoveInheritance(), RemovePolicyById(), RemoveRewriteRuleById(), RemoveRoleFromObjectACL(), RemoveRoleFromObjectPolicy(), RemoveStatistics(), RemoveTriggerById(), RemoveTSConfigurationById(), rename_policy(), renametrig(), replorigin_create(), ScanPgRelation(), SearchCatCacheList(), SearchCatCacheMiss(), sepgsql_attribute_post_create(), sepgsql_database_post_create(), sepgsql_proc_post_create(), sepgsql_proc_setattr(), sepgsql_relation_post_create(), sepgsql_relation_setattr(), sepgsql_relation_setattr_extra(), sepgsql_schema_post_create(), sequenceIsOwned(), SetSecurityLabel(), SetSharedSecurityLabel(), shdepChangeDep(), shdepDropDependency(), shdepDropOwned(), shdepReassignOwned(), toastrel_valueid_exists(), tryAttachPartitionForeignKey(), typeInheritsFrom(), vac_update_datfrozenxid(), and validatePartitionedIndex().

526 {
527  if (sysscan->slot)
528  {
530  sysscan->slot = NULL;
531  }
532 
533  if (sysscan->irel)
534  {
535  index_endscan(sysscan->iscan);
536  index_close(sysscan->irel, AccessShareLock);
537  }
538  else
539  table_endscan(sysscan->scan);
540 
541  if (sysscan->snapshot)
542  UnregisterSnapshot(sysscan->snapshot);
543 
544  pfree(sysscan);
545 }
Relation irel
Definition: relscan.h:169
struct SnapshotData * snapshot
Definition: relscan.h:172
#define AccessShareLock
Definition: lockdefs.h:36
struct IndexScanDescData * iscan
Definition: relscan.h:171
struct TupleTableSlot * slot
Definition: relscan.h:173
void pfree(void *pointer)
Definition: mcxt.c:1056
struct TableScanDescData * scan
Definition: relscan.h:170
void ExecDropSingleTupleTableSlot(TupleTableSlot *slot)
Definition: execTuples.c:1224
void index_endscan(IndexScanDesc scan)
Definition: indexam.c:315
void UnregisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:907
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:152
static void table_endscan(TableScanDesc scan)
Definition: tableam.h:831

◆ systable_endscan_ordered()

void systable_endscan_ordered ( SysScanDesc  sysscan)

Definition at line 649 of file genam.c.

References Assert, ExecDropSingleTupleTableSlot(), index_endscan(), SysScanDescData::irel, SysScanDescData::iscan, pfree(), SysScanDescData::slot, SysScanDescData::snapshot, and UnregisterSnapshot().

Referenced by BuildEventTriggerCache(), enum_endpoint(), enum_range_internal(), inv_getsize(), inv_read(), inv_truncate(), inv_write(), lookup_ts_config_cache(), toast_delete_datum(), toast_fetch_datum(), and toast_fetch_datum_slice().

650 {
651  if (sysscan->slot)
652  {
654  sysscan->slot = NULL;
655  }
656 
657  Assert(sysscan->irel);
658  index_endscan(sysscan->iscan);
659  if (sysscan->snapshot)
660  UnregisterSnapshot(sysscan->snapshot);
661  pfree(sysscan);
662 }
Relation irel
Definition: relscan.h:169
struct SnapshotData * snapshot
Definition: relscan.h:172
struct IndexScanDescData * iscan
Definition: relscan.h:171
struct TupleTableSlot * slot
Definition: relscan.h:173
void pfree(void *pointer)
Definition: mcxt.c:1056
void ExecDropSingleTupleTableSlot(TupleTableSlot *slot)
Definition: execTuples.c:1224
void index_endscan(IndexScanDesc scan)
Definition: indexam.c:315
void UnregisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:907
#define Assert(condition)
Definition: c.h:733

◆ systable_getnext()

HeapTuple systable_getnext ( SysScanDesc  sysscan)

Definition at line 444 of file genam.c.

References Assert, elog, ERROR, ExecFetchSlotHeapTuple(), ForwardScanDirection, index_getnext_slot(), SysScanDescData::irel, SysScanDescData::iscan, SysScanDescData::scan, SysScanDescData::slot, table_scan_getnextslot(), and IndexScanDescData::xs_recheck.

Referenced by AfterTriggerSetState(), AlterConstraintNamespaces(), AlterDatabase(), AlterDatabaseOwner(), AlterDomainDropConstraint(), AlterDomainValidateConstraint(), AlterExtensionNamespace(), AlterPolicy(), AlterSeqNamespaces(), AlterSetting(), ApplyExtensionUpdates(), ApplySetting(), ATExecAddOf(), ATExecAlterColumnType(), ATExecAlterConstraint(), ATExecAttachPartition(), ATExecDropConstraint(), ATExecValidateConstraint(), ATPrepChangePersistence(), AttrDefaultFetch(), change_owner_fix_column_acls(), change_owner_recurse_to_sequences(), changeDependenciesOf(), changeDependenciesOn(), changeDependencyFor(), CheckConstraintFetch(), checkSharedDependencies(), ChooseConstraintName(), CloneFkReferenced(), CloneRowTriggersToPartition(), ConstraintNameExists(), ConstraintNameIsUsed(), copyTemplateDependencies(), CountDBSubscriptions(), CreateComments(), CreateInheritance(), CreatePolicy(), CreateSharedComments(), CreateTrigger(), DefineOpClass(), DefineTSConfiguration(), DeleteAttributeTuples(), DeleteComments(), deleteDependencyRecordsFor(), deleteDependencyRecordsForClass(), DeleteInheritsTuple(), DeleteInitPrivs(), deleteOneObject(), DeleteSecurityLabel(), DeleteSharedComments(), DeleteSharedSecurityLabel(), DeleteSystemAttributeTuples(), drop_parent_dependency(), DropCastById(), DropConfigurationMapping(), dropDatabaseDependencies(), DropRole(), DropTransformById(), EnableDisableTrigger(), EnumValuesDelete(), exec_object_restorecon(), ExecAlterExtensionStmt(), ExecGrant_Largeobject(), extension_config_remove(), fetch_statentries_for_relation(), find_composite_type_dependencies(), find_inheritance_children(), find_language_template(), findDependentObjects(), get_catalog_object_by_oid(), get_constraint_index(), get_database_oid(), get_db_info(), get_domain_constraint_oid(), get_extension_name(), get_extension_oid(), get_extension_schema(), get_index_constraint(), get_index_ref_constraints(), get_object_address_attrdef(), get_partition_parent_worker(), get_pkey_attnames(), get_primary_key_attnos(), get_relation_constraint_attnos(), get_relation_constraint_oid(), get_relation_idx_constraint_oid(), get_relation_policy_oid(), get_rels_with_domain(), get_trigger_oid(), GetAllTablesPublications(), GetComment(), GetDatabaseTuple(), GetDatabaseTupleByOid(), GetDefaultOpClass(), getExtensionOfObject(), GetNewOidWithIndex(), getObjectDescription(), getObjectIdentityParts(), getOwnedSequences_internal(), GetParentedForeignKeyRefs(), GetPublicationRelations(), GetSecurityLabel(), GetSharedSecurityLabel(), GetSubscriptionNotReadyRelations(), GetSubscriptionRelations(), has_superclass(), heap_truncate_find_FKs(), index_concurrently_swap(), IndexSetParentIndex(), isObjectPinned(), isSharedObjectPinned(), LargeObjectDrop(), LargeObjectExists(), load_domaintype_info(), load_enum_cache_data(), LookupOpclassInfo(), makeConfigurationDependencies(), MakeConfigurationMapping(), MergeConstraintsIntoExisting(), MergeWithExistingConstraint(), movedb(), myLargeObjectExists(), pg_extension_config_dump(), pg_extension_ownercheck(), pg_get_constraintdef_worker(), pg_get_serial_sequence(), pg_get_triggerdef_worker(), pg_largeobject_aclmask_snapshot(), pg_largeobject_ownercheck(), RangeDelete(), recordExtensionInitPrivWorker(), recordExtObjInitPriv(), relation_has_policies(), RelationBuildPartitionDesc(), RelationBuildRowSecurity(), RelationBuildRuleLock(), RelationBuildTriggers(), RelationBuildTupleDesc(), RelationGetExclusionInfo(), RelationGetFKeyList(), RelationGetIndexList(), RelationGetStatExtList(), RelationRemoveInheritance(), RelidByRelfilenode(), RemoveAmOpEntryById(), RemoveAmProcEntryById(), RemoveAttrDefault(), RemoveAttrDefaultById(), RemoveCollationById(), RemoveDefaultACLById(), RemoveExtensionById(), RemoveInheritance(), RemovePolicyById(), RemoveRewriteRuleById(), RemoveRoleFromObjectACL(), RemoveRoleFromObjectPolicy(), RemoveStatistics(), RemoveTriggerById(), RemoveTSConfigurationById(), rename_policy(), renametrig(), replorigin_create(), ScanPgRelation(), SearchCatCacheList(), SearchCatCacheMiss(), sepgsql_attribute_post_create(), sepgsql_database_post_create(), sepgsql_proc_post_create(), sepgsql_proc_setattr(), sepgsql_relation_post_create(), sepgsql_relation_setattr(), sepgsql_relation_setattr_extra(), sepgsql_schema_post_create(), sequenceIsOwned(), SetSecurityLabel(), SetSharedSecurityLabel(), shdepChangeDep(), shdepDropDependency(), shdepDropOwned(), shdepReassignOwned(), toastrel_valueid_exists(), tryAttachPartitionForeignKey(), typeInheritsFrom(), vac_update_datfrozenxid(), and validatePartitionedIndex().

445 {
446  HeapTuple htup = NULL;
447 
448  if (sysscan->irel)
449  {
450  if (index_getnext_slot(sysscan->iscan, ForwardScanDirection, sysscan->slot))
451  {
452  bool shouldFree;
453 
454  htup = ExecFetchSlotHeapTuple(sysscan->slot, false, &shouldFree);
455  Assert(!shouldFree);
456 
457  /*
458  * We currently don't need to support lossy index operators for
459  * any system catalog scan. It could be done here, using the scan
460  * keys to drive the operator calls, if we arranged to save the
461  * heap attnums during systable_beginscan(); this is practical
462  * because we still wouldn't need to support indexes on
463  * expressions.
464  */
465  if (sysscan->iscan->xs_recheck)
466  elog(ERROR, "system catalog scans with lossy index conditions are not implemented");
467  }
468  }
469  else
470  {
471  if (table_scan_getnextslot(sysscan->scan, ForwardScanDirection, sysscan->slot))
472  {
473  bool shouldFree;
474 
475  htup = ExecFetchSlotHeapTuple(sysscan->slot, false, &shouldFree);
476  Assert(!shouldFree);
477  }
478  }
479 
480  return htup;
481 }
Relation irel
Definition: relscan.h:169
static bool table_scan_getnextslot(TableScanDesc sscan, ScanDirection direction, TupleTableSlot *slot)
Definition: tableam.h:872
struct IndexScanDescData * iscan
Definition: relscan.h:171
struct TupleTableSlot * slot
Definition: relscan.h:173
#define ERROR
Definition: elog.h:43
struct TableScanDescData * scan
Definition: relscan.h:170
HeapTuple ExecFetchSlotHeapTuple(TupleTableSlot *slot, bool materialize, bool *shouldFree)
Definition: execTuples.c:1614
#define Assert(condition)
Definition: c.h:733
bool index_getnext_slot(IndexScanDesc scan, ScanDirection direction, TupleTableSlot *slot)
Definition: indexam.c:607
#define elog(elevel,...)
Definition: elog.h:228

◆ systable_getnext_ordered()

HeapTuple systable_getnext_ordered ( SysScanDesc  sysscan,
ScanDirection  direction 
)

Definition at line 630 of file genam.c.

References Assert, elog, ERROR, ExecFetchSlotHeapTuple(), index_getnext_slot(), SysScanDescData::irel, SysScanDescData::iscan, SysScanDescData::slot, and IndexScanDescData::xs_recheck.

Referenced by BuildEventTriggerCache(), enum_endpoint(), enum_range_internal(), inv_getsize(), inv_read(), inv_truncate(), inv_write(), lookup_ts_config_cache(), toast_delete_datum(), toast_fetch_datum(), and toast_fetch_datum_slice().

631 {
632  HeapTuple htup = NULL;
633 
634  Assert(sysscan->irel);
635  if (index_getnext_slot(sysscan->iscan, direction, sysscan->slot))
636  htup = ExecFetchSlotHeapTuple(sysscan->slot, false, NULL);
637 
638  /* See notes in systable_getnext */
639  if (htup && sysscan->iscan->xs_recheck)
640  elog(ERROR, "system catalog scans with lossy index conditions are not implemented");
641 
642  return htup;
643 }
Relation irel
Definition: relscan.h:169
struct IndexScanDescData * iscan
Definition: relscan.h:171
struct TupleTableSlot * slot
Definition: relscan.h:173
#define ERROR
Definition: elog.h:43
HeapTuple ExecFetchSlotHeapTuple(TupleTableSlot *slot, bool materialize, bool *shouldFree)
Definition: execTuples.c:1614
#define Assert(condition)
Definition: c.h:733
bool index_getnext_slot(IndexScanDesc scan, ScanDirection direction, TupleTableSlot *slot)
Definition: indexam.c:607
#define elog(elevel,...)
Definition: elog.h:228

◆ systable_recheck_tuple()

bool systable_recheck_tuple ( SysScanDesc  sysscan,
HeapTuple  tup 
)

Definition at line 497 of file genam.c.

References Assert, ExecFetchSlotHeapTuple(), GetCatalogSnapshot(), SysScanDescData::heap_rel, RelationGetRelid, SysScanDescData::slot, and table_tuple_satisfies_snapshot().

Referenced by findDependentObjects().

498 {
499  Snapshot freshsnap;
500  bool result;
501 
502  Assert(tup == ExecFetchSlotHeapTuple(sysscan->slot, false, NULL));
503 
504  /*
505  * Trust that table_tuple_satisfies_snapshot() and its subsidiaries
506  * (commonly LockBuffer() and HeapTupleSatisfiesMVCC()) do not themselves
507  * acquire snapshots, so we need not register the snapshot. Those
508  * facilities are too low-level to have any business scanning tables.
509  */
510  freshsnap = GetCatalogSnapshot(RelationGetRelid(sysscan->heap_rel));
511 
512  result = table_tuple_satisfies_snapshot(sysscan->heap_rel,
513  sysscan->slot,
514  freshsnap);
515 
516  return result;
517 }
Relation heap_rel
Definition: relscan.h:168
Snapshot GetCatalogSnapshot(Oid relid)
Definition: snapmgr.c:442
struct TupleTableSlot * slot
Definition: relscan.h:173
HeapTuple ExecFetchSlotHeapTuple(TupleTableSlot *slot, bool materialize, bool *shouldFree)
Definition: execTuples.c:1614
static bool table_tuple_satisfies_snapshot(Relation rel, TupleTableSlot *slot, Snapshot snapshot)
Definition: tableam.h:1059
#define Assert(condition)
Definition: c.h:733
#define RelationGetRelid(relation)
Definition: rel.h:423