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, bool indexUnchanged, 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 *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 relation, AttrNumber attnum, Datum attoptions, bool validate)
 
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 138 of file genam.h.

Typedef Documentation

◆ IndexBuildResult

◆ IndexBulkDeleteCallback

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

Definition at line 86 of file genam.h.

◆ IndexBulkDeleteResult

◆ IndexOrderByDistance

◆ IndexScanDesc

Definition at line 89 of file genam.h.

◆ IndexUniqueCheck

◆ IndexVacuumInfo

◆ ParallelIndexScanDesc

Definition at line 92 of file genam.h.

◆ SysScanDesc

typedef struct SysScanDescData* SysScanDesc

Definition at line 90 of file genam.h.

Enumeration Type Documentation

◆ IndexUniqueCheck

Enumerator
UNIQUE_CHECK_NO 
UNIQUE_CHECK_YES 
UNIQUE_CHECK_PARTIAL 
UNIQUE_CHECK_EXISTING 

Definition at line 114 of file genam.h.

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

Function Documentation

◆ BuildIndexValueDescription()

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

Definition at line 177 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(), comparetup_index_btree(), and gist_page_items().

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

◆ 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_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:457

◆ 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:189
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:189
#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:44
void UnlockRelationId(LockRelId *relid, LOCKMODE lockmode)
Definition: lmgr.c:185
Definition: rel.h:36
#define NoLock
Definition: lockdefs.h:34
LockInfoData rd_lockInfo
Definition: rel.h:113
void RelationClose(Relation relation)
Definition: relcache.c:2096
#define MAX_LOCKMODES
Definition: lock.h:86
#define Assert(condition)
Definition: c.h:804

◆ 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 293 of file genam.c.

References Assert, TM_IndexDeleteOp::bottomup, TM_IndexDeleteOp::bottomupfreespace, BufferGetPage, TM_IndexDeleteOp::deltids, TM_IndexStatus::freespace, i, TM_IndexDelete::id, TM_IndexStatus::idxoffnum, InvalidOffsetNumber, InvalidTransactionId, ItemIdIsDead, ItemPointerCopy, TM_IndexStatus::knowndeletable, TM_IndexDeleteOp::ndeltids, PageGetItem, PageGetItemId, palloc(), pfree(), TM_IndexStatus::promising, TM_IndexDeleteOp::status, IndexTupleData::t_tid, table_index_delete_tuples(), and TM_IndexDelete::tid.

Referenced by _hash_vacuum_one_page(), and gistprunepage().

298 {
299  TM_IndexDeleteOp delstate;
300  TransactionId latestRemovedXid = InvalidTransactionId;
301  Page ipage = BufferGetPage(ibuf);
302  IndexTuple itup;
303 
304  Assert(nitems > 0);
305 
306  delstate.bottomup = false;
307  delstate.bottomupfreespace = 0;
308  delstate.ndeltids = 0;
309  delstate.deltids = palloc(nitems * sizeof(TM_IndexDelete));
310  delstate.status = palloc(nitems * sizeof(TM_IndexStatus));
311 
312  /* identify what the index tuples about to be deleted point to */
313  for (int i = 0; i < nitems; i++)
314  {
315  ItemId iitemid;
316 
317  iitemid = PageGetItemId(ipage, itemnos[i]);
318  itup = (IndexTuple) PageGetItem(ipage, iitemid);
319 
320  Assert(ItemIdIsDead(iitemid));
321 
322  ItemPointerCopy(&itup->t_tid, &delstate.deltids[i].tid);
323  delstate.deltids[i].id = delstate.ndeltids;
324  delstate.status[i].idxoffnum = InvalidOffsetNumber; /* unused */
325  delstate.status[i].knowndeletable = true; /* LP_DEAD-marked */
326  delstate.status[i].promising = false; /* unused */
327  delstate.status[i].freespace = 0; /* unused */
328 
329  delstate.ndeltids++;
330  }
331 
332  /* determine the actual xid horizon */
333  latestRemovedXid = table_index_delete_tuples(hrel, &delstate);
334 
335  /* assert tableam agrees that all items are deletable */
336  Assert(delstate.ndeltids == nitems);
337 
338  pfree(delstate.deltids);
339  pfree(delstate.status);
340 
341  return latestRemovedXid;
342 }
static TransactionId table_index_delete_tuples(Relation rel, TM_IndexDeleteOp *delstate)
Definition: tableam.h:1325
TM_IndexDelete * deltids
Definition: tableam.h:228
uint32 TransactionId
Definition: c.h:587
ItemPointerData t_tid
Definition: itup.h:37
bool knowndeletable
Definition: tableam.h:196
OffsetNumber idxoffnum
Definition: tableam.h:195
#define ItemIdIsDead(itemId)
Definition: itemid.h:113
void pfree(void *pointer)
Definition: mcxt.c:1169
IndexTupleData * IndexTuple
Definition: itup.h:53
#define InvalidTransactionId
Definition: transam.h:31
#define BufferGetPage(buffer)
Definition: bufmgr.h:169
bool promising
Definition: tableam.h:199
#define PageGetItemId(page, offsetNumber)
Definition: bufpage.h:235
TM_IndexStatus * status
Definition: tableam.h:229
ItemPointerData tid
Definition: tableam.h:189
#define InvalidOffsetNumber
Definition: off.h:26
#define Assert(condition)
Definition: c.h:804
void * palloc(Size size)
Definition: mcxt.c:1062
int16 freespace
Definition: tableam.h:200
int i
int bottomupfreespace
Definition: tableam.h:224
#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 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:189
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:2076
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,
struct 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:1057
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:189
#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:1067
bool kill_prior_tuple
Definition: relscan.h:128

◆ index_getnext_slot()

bool index_getnext_slot ( IndexScanDesc  scan,
ScanDirection  direction,
struct 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:189
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:1067
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:189
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:192
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:189
Definition: fmgr.h:56
uint16 amsupport
Definition: amapi.h:216
struct FmgrInfo * rd_supportinfo
Definition: rel.h:193
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:491
void fmgr_info_cxt(Oid functionId, FmgrInfo *finfo, MemoryContext mcxt)
Definition: fmgr.c:136
RegProcedure * rd_support
Definition: rel.h:192
#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:187
Definition: c.h:621
bytea ** RelationGetIndexAttOptions(Relation relation, bool copy)
Definition: relcache.c:5473

◆ index_insert()

bool index_insert ( Relation  indexRelation,
Datum values,
bool isnull,
ItemPointer  heap_t_ctid,
Relation  heapRelation,
IndexUniqueCheck  checkUnique,
bool  indexUnchanged,
struct 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:189
#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:166

◆ 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:189
#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  relation,
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
Definition: fmgr.h:56
void init_local_reloptions(local_relopts *opts, Size relopt_struct_size)
Definition: reloptions.c:710
FmgrInfo * index_getprocinfo(Relation irel, AttrNumber attnum, uint16 procnum)
Definition: indexam.c:803
#define PointerGetDatum(X)
Definition: postgres.h:600
void * build_local_reloptions(local_relopts *relopts, Datum options, bool validate)
Definition: reloptions.c:1924
int errcode(int sqlerrcode)
Definition: elog.c:698
unsigned int Oid
Definition: postgres_ext.h:31
#define OidIsValid(objectId)
Definition: c.h:710
#define ERROR
Definition: elog.h:46
Oid values[FLEXIBLE_ARRAY_MEMBER]
Definition: c.h:668
char * generate_opclass_name(Oid opclass)
Definition: ruleutils.c:11193
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
#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:110
#define ERROR
Definition: elog.h:46
Relation relation_open(Oid relationId, LOCKMODE lockmode)
Definition: relation.c:48
#define RelationGetRelationName(relation)
Definition: rel.h:491
#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:189
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  indexrel,
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 }
#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
#define offsetof(type, field)
Definition: c.h:727

◆ index_parallelscan_initialize()

void index_parallelscan_initialize ( Relation  heaprel,
Relation  indexrel,
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 }
#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:457
#define offsetof(type, field)
Definition: c.h:727

◆ 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:189
#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:189
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
static struct @142 value
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
#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:189
#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

◆ IndexScanEnd()

void IndexScanEnd ( IndexScanDesc  scan)

Definition at line 145 of file genam.c.

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

Referenced by index_endscan().

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

◆ RelationGetIndexScan()

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

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

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

◆ systable_beginscan()

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

Definition at line 383 of file genam.c.

References AccessShareLock, bsysscan, CheckXidAlive, 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(), table_slot_create(), and TransactionIdIsValid.

Referenced by AfterTriggerSetState(), AlterConstraintNamespaces(), AlterDatabase(), AlterDatabaseOwner(), AlterDomainDropConstraint(), AlterDomainValidateConstraint(), AlterExtensionNamespace(), AlterPolicy(), AlterSeqNamespaces(), AlterSetting(), AlterTypeRecurse(), ApplyExtensionUpdates(), ApplySetting(), ATExecAddOf(), ATExecAlterColumnType(), ATExecAlterConstraint(), ATExecAttachPartition(), ATExecDropConstraint(), ATExecDropExpression(), ATExecValidateConstraint(), ATPrepChangePersistence(), AttrDefaultFetch(), change_owner_fix_column_acls(), change_owner_recurse_to_sequences(), changeDependenciesOf(), changeDependenciesOn(), changeDependencyFor(), CheckConstraintFetch(), checkSharedDependencies(), ChooseConstraintName(), CloneFkReferenced(), CloneRowTriggersToPartition(), ConstraintNameExists(), ConstraintNameIsUsed(), CopyStatistics(), copyTemplateDependencies(), CountDBSubscriptions(), CreateComments(), CreateInheritance(), CreatePolicy(), CreateSharedComments(), CreateTrigger(), DefineOpClass(), DefineTSConfiguration(), DeleteAttributeTuples(), DeleteComments(), deleteDependencyRecordsFor(), deleteDependencyRecordsForClass(), deleteDependencyRecordsForSpecific(), DeleteInheritsTuple(), DeleteInitPrivs(), deleteOneObject(), DeleteSecurityLabel(), DeleteSharedComments(), DeleteSharedSecurityLabel(), DeleteSystemAttributeTuples(), drop_parent_dependency(), DropClonedTriggersFromPartition(), DropConfigurationMapping(), dropDatabaseDependencies(), DropObjectById(), DropRole(), EnableDisableTrigger(), EnumValuesDelete(), exec_object_restorecon(), ExecAlterExtensionStmt(), ExecGrant_Largeobject(), extension_config_remove(), fetch_statentries_for_relation(), find_composite_type_dependencies(), find_inheritance_children(), findDependentObjects(), get_catalog_object_by_oid(), 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(), getAutoExtensionsOfObject(), 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(), MarkInheritDetached(), MergeConstraintsIntoExisting(), MergeWithExistingConstraint(), movedb(), myLargeObjectExists(), PartitionHasPendingDetach(), 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(), RemoveAttrDefault(), RemoveAttrDefaultById(), 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(), validatePartitionedIndex(), and visitDependenciesOf().

388 {
389  SysScanDesc sysscan;
390  Relation irel;
391 
392  if (indexOK &&
394  !ReindexIsProcessingIndex(indexId))
395  irel = index_open(indexId, AccessShareLock);
396  else
397  irel = NULL;
398 
399  sysscan = (SysScanDesc) palloc(sizeof(SysScanDescData));
400 
401  sysscan->heap_rel = heapRelation;
402  sysscan->irel = irel;
403  sysscan->slot = table_slot_create(heapRelation, NULL);
404 
405  if (snapshot == NULL)
406  {
407  Oid relid = RelationGetRelid(heapRelation);
408 
409  snapshot = RegisterSnapshot(GetCatalogSnapshot(relid));
410  sysscan->snapshot = snapshot;
411  }
412  else
413  {
414  /* Caller is responsible for any snapshot. */
415  sysscan->snapshot = NULL;
416  }
417 
418  if (irel)
419  {
420  int i;
421 
422  /* Change attribute numbers to be index column numbers. */
423  for (i = 0; i < nkeys; i++)
424  {
425  int j;
426 
427  for (j = 0; j < IndexRelationGetNumberOfAttributes(irel); j++)
428  {
429  if (key[i].sk_attno == irel->rd_index->indkey.values[j])
430  {
431  key[i].sk_attno = j + 1;
432  break;
433  }
434  }
435  if (j == IndexRelationGetNumberOfAttributes(irel))
436  elog(ERROR, "column is not in index");
437  }
438 
439  sysscan->iscan = index_beginscan(heapRelation, irel,
440  snapshot, nkeys, 0);
441  index_rescan(sysscan->iscan, key, nkeys, NULL, 0);
442  sysscan->scan = NULL;
443  }
444  else
445  {
446  /*
447  * We disallow synchronized scans when forced to use a heapscan on a
448  * catalog. In most cases the desired rows are near the front, so
449  * that the unpredictable start point of a syncscan is a serious
450  * disadvantage; and there are no compensating advantages, because
451  * it's unlikely that such scans will occur in parallel.
452  */
453  sysscan->scan = table_beginscan_strat(heapRelation, snapshot,
454  nkeys, key,
455  true, false);
456  sysscan->iscan = NULL;
457  }
458 
459  /*
460  * If CheckXidAlive is set then set a flag to indicate that system table
461  * scan is in-progress. See detailed comments in xact.c where these
462  * variables are declared.
463  */
465  bsysscan = true;
466 
467  return sysscan;
468 }
TupleTableSlot * table_slot_create(Relation relation, List **reglist)
Definition: tableam.c:91
Relation irel
Definition: relscan.h:184
struct SysScanDescData * SysScanDesc
Definition: genam.h:90
Relation heap_rel
Definition: relscan.h:183
Snapshot RegisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:810
struct SnapshotData * snapshot
Definition: relscan.h:187
Snapshot GetCatalogSnapshot(Oid relid)
Definition: snapmgr.c:386
#define AccessShareLock
Definition: lockdefs.h:36
void index_rescan(IndexScanDesc scan, ScanKey keys, int nkeys, ScanKey orderbys, int norderbys)
Definition: indexam.c:297
bool IgnoreSystemIndexes
Definition: miscinit.c:79
unsigned int Oid
Definition: postgres_ext.h:31
struct IndexScanDescData * iscan
Definition: relscan.h:186
struct TupleTableSlot * slot
Definition: relscan.h:188
static TableScanDesc table_beginscan_strat(Relation rel, Snapshot snapshot, int nkeys, struct ScanKeyData *key, bool allow_strat, bool allow_sync)
Definition: tableam.h:907
Form_pg_index rd_index
Definition: rel.h:175
#define ERROR
Definition: elog.h:46
struct TableScanDescData * scan
Definition: relscan.h:185
bool bsysscan
Definition: xact.c:96
#define IndexRelationGetNumberOfAttributes(relation)
Definition: rel.h:469
TransactionId CheckXidAlive
Definition: xact.c:95
void * palloc(Size size)
Definition: mcxt.c:1062
#define elog(elevel,...)
Definition: elog.h:232
int i
#define TransactionIdIsValid(xid)
Definition: transam.h:41
bool ReindexIsProcessingIndex(Oid indexOid)
Definition: index.c:4139
#define RelationGetRelid(relation)
Definition: rel.h:457
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:132
AttrNumber sk_attno
Definition: skey.h:67
IndexScanDesc index_beginscan(Relation heapRelation, Relation indexRelation, Snapshot snapshot, int nkeys, int norderbys)
Definition: indexam.c:205

◆ systable_beginscan_ordered()

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

Definition at line 642 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(), check_toasted_attribute(), enum_endpoint(), enum_range_internal(), heap_fetch_toast_slice(), inv_getsize(), inv_read(), inv_truncate(), inv_write(), lookup_ts_config_cache(), and toast_delete_datum().

646 {
647  SysScanDesc sysscan;
648  int i;
649 
650  /* REINDEX can probably be a hard error here ... */
651  if (ReindexIsProcessingIndex(RelationGetRelid(indexRelation)))
652  elog(ERROR, "cannot do ordered scan on index \"%s\", because it is being reindexed",
653  RelationGetRelationName(indexRelation));
654  /* ... but we only throw a warning about violating IgnoreSystemIndexes */
656  elog(WARNING, "using index \"%s\" despite IgnoreSystemIndexes",
657  RelationGetRelationName(indexRelation));
658 
659  sysscan = (SysScanDesc) palloc(sizeof(SysScanDescData));
660 
661  sysscan->heap_rel = heapRelation;
662  sysscan->irel = indexRelation;
663  sysscan->slot = table_slot_create(heapRelation, NULL);
664 
665  if (snapshot == NULL)
666  {
667  Oid relid = RelationGetRelid(heapRelation);
668 
669  snapshot = RegisterSnapshot(GetCatalogSnapshot(relid));
670  sysscan->snapshot = snapshot;
671  }
672  else
673  {
674  /* Caller is responsible for any snapshot. */
675  sysscan->snapshot = NULL;
676  }
677 
678  /* Change attribute numbers to be index column numbers. */
679  for (i = 0; i < nkeys; i++)
680  {
681  int j;
682 
683  for (j = 0; j < IndexRelationGetNumberOfAttributes(indexRelation); j++)
684  {
685  if (key[i].sk_attno == indexRelation->rd_index->indkey.values[j])
686  {
687  key[i].sk_attno = j + 1;
688  break;
689  }
690  }
691  if (j == IndexRelationGetNumberOfAttributes(indexRelation))
692  elog(ERROR, "column is not in index");
693  }
694 
695  sysscan->iscan = index_beginscan(heapRelation, indexRelation,
696  snapshot, nkeys, 0);
697  index_rescan(sysscan->iscan, key, nkeys, NULL, 0);
698  sysscan->scan = NULL;
699 
700  return sysscan;
701 }
TupleTableSlot * table_slot_create(Relation relation, List **reglist)
Definition: tableam.c:91
Relation irel
Definition: relscan.h:184
struct SysScanDescData * SysScanDesc
Definition: genam.h:90
Relation heap_rel
Definition: relscan.h:183
Snapshot RegisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:810
struct SnapshotData * snapshot
Definition: relscan.h:187
Snapshot GetCatalogSnapshot(Oid relid)
Definition: snapmgr.c:386
void index_rescan(IndexScanDesc scan, ScanKey keys, int nkeys, ScanKey orderbys, int norderbys)
Definition: indexam.c:297
bool IgnoreSystemIndexes
Definition: miscinit.c:79
unsigned int Oid
Definition: postgres_ext.h:31
struct IndexScanDescData * iscan
Definition: relscan.h:186
struct TupleTableSlot * slot
Definition: relscan.h:188
Form_pg_index rd_index
Definition: rel.h:175
#define ERROR
Definition: elog.h:46
struct TableScanDescData * scan
Definition: relscan.h:185
#define IndexRelationGetNumberOfAttributes(relation)
Definition: rel.h:469
#define RelationGetRelationName(relation)
Definition: rel.h:491
#define WARNING
Definition: elog.h:40
void * palloc(Size size)
Definition: mcxt.c:1062
#define elog(elevel,...)
Definition: elog.h:232
int i
bool ReindexIsProcessingIndex(Oid indexOid)
Definition: index.c:4139
#define RelationGetRelid(relation)
Definition: rel.h:457
AttrNumber sk_attno
Definition: skey.h:67
IndexScanDesc index_beginscan(Relation heapRelation, Relation indexRelation, Snapshot snapshot, int nkeys, int norderbys)
Definition: indexam.c:205

◆ systable_endscan()

void systable_endscan ( SysScanDesc  sysscan)

Definition at line 595 of file genam.c.

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

Referenced by AfterTriggerSetState(), AlterConstraintNamespaces(), AlterDatabase(), AlterDatabaseOwner(), AlterDomainDropConstraint(), AlterDomainValidateConstraint(), AlterExtensionNamespace(), AlterPolicy(), AlterSeqNamespaces(), AlterSetting(), AlterTypeRecurse(), ApplyExtensionUpdates(), ApplySetting(), ATExecAddOf(), ATExecAlterColumnType(), ATExecAlterConstraint(), ATExecAttachPartition(), ATExecDropConstraint(), ATExecDropExpression(), ATExecValidateConstraint(), ATPrepChangePersistence(), AttrDefaultFetch(), change_owner_fix_column_acls(), change_owner_recurse_to_sequences(), changeDependenciesOf(), changeDependenciesOn(), changeDependencyFor(), CheckConstraintFetch(), checkSharedDependencies(), ChooseConstraintName(), CloneFkReferenced(), CloneRowTriggersToPartition(), ConstraintNameExists(), ConstraintNameIsUsed(), CopyStatistics(), copyTemplateDependencies(), CountDBSubscriptions(), CreateComments(), CreateInheritance(), CreatePolicy(), CreateSharedComments(), CreateTrigger(), DefineOpClass(), DefineTSConfiguration(), DeleteAttributeTuples(), DeleteComments(), deleteDependencyRecordsFor(), deleteDependencyRecordsForClass(), deleteDependencyRecordsForSpecific(), DeleteInheritsTuple(), DeleteInitPrivs(), deleteOneObject(), DeleteSecurityLabel(), DeleteSharedComments(), DeleteSharedSecurityLabel(), DeleteSystemAttributeTuples(), drop_parent_dependency(), DropClonedTriggersFromPartition(), DropConfigurationMapping(), dropDatabaseDependencies(), DropObjectById(), DropRole(), EnableDisableTrigger(), EnumValuesDelete(), exec_object_restorecon(), ExecAlterExtensionStmt(), ExecGrant_Largeobject(), extension_config_remove(), fetch_statentries_for_relation(), find_composite_type_dependencies(), find_inheritance_children(), findDependentObjects(), get_catalog_object_by_oid(), 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(), getAutoExtensionsOfObject(), 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(), MarkInheritDetached(), MergeConstraintsIntoExisting(), MergeWithExistingConstraint(), movedb(), myLargeObjectExists(), PartitionHasPendingDetach(), 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(), RemoveAttrDefault(), RemoveAttrDefaultById(), 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(), validatePartitionedIndex(), and visitDependenciesOf().

596 {
597  if (sysscan->slot)
598  {
600  sysscan->slot = NULL;
601  }
602 
603  if (sysscan->irel)
604  {
605  index_endscan(sysscan->iscan);
606  index_close(sysscan->irel, AccessShareLock);
607  }
608  else
609  table_endscan(sysscan->scan);
610 
611  if (sysscan->snapshot)
612  UnregisterSnapshot(sysscan->snapshot);
613 
614  /*
615  * Reset the bsysscan flag at the end of the systable scan. See
616  * detailed comments in xact.c where these variables are declared.
617  */
619  bsysscan = false;
620 
621  pfree(sysscan);
622 }
Relation irel
Definition: relscan.h:184
struct SnapshotData * snapshot
Definition: relscan.h:187
#define AccessShareLock
Definition: lockdefs.h:36
struct IndexScanDescData * iscan
Definition: relscan.h:186
struct TupleTableSlot * slot
Definition: relscan.h:188
void pfree(void *pointer)
Definition: mcxt.c:1169
struct TableScanDescData * scan
Definition: relscan.h:185
bool bsysscan
Definition: xact.c:96
void ExecDropSingleTupleTableSlot(TupleTableSlot *slot)
Definition: execTuples.c:1254
void index_endscan(IndexScanDesc scan)
Definition: indexam.c:323
void UnregisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:852
TransactionId CheckXidAlive
Definition: xact.c:95
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:158
static void table_endscan(TableScanDesc scan)
Definition: tableam.h:991
#define TransactionIdIsValid(xid)
Definition: transam.h:41

◆ systable_endscan_ordered()

void systable_endscan_ordered ( SysScanDesc  sysscan)

Definition at line 732 of file genam.c.

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

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

733 {
734  if (sysscan->slot)
735  {
737  sysscan->slot = NULL;
738  }
739 
740  Assert(sysscan->irel);
741  index_endscan(sysscan->iscan);
742  if (sysscan->snapshot)
743  UnregisterSnapshot(sysscan->snapshot);
744  pfree(sysscan);
745 }
Relation irel
Definition: relscan.h:184
struct SnapshotData * snapshot
Definition: relscan.h:187
struct IndexScanDescData * iscan
Definition: relscan.h:186
struct TupleTableSlot * slot
Definition: relscan.h:188
void pfree(void *pointer)
Definition: mcxt.c:1169
void ExecDropSingleTupleTableSlot(TupleTableSlot *slot)
Definition: execTuples.c:1254
void index_endscan(IndexScanDesc scan)
Definition: indexam.c:323
void UnregisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:852
#define Assert(condition)
Definition: c.h:804

◆ systable_getnext()

HeapTuple systable_getnext ( SysScanDesc  sysscan)

Definition at line 502 of file genam.c.

References Assert, elog, ERROR, ExecFetchSlotHeapTuple(), ForwardScanDirection, HandleConcurrentAbort(), 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(), AlterTypeRecurse(), ApplyExtensionUpdates(), ApplySetting(), ATExecAddOf(), ATExecAlterColumnType(), ATExecAlterConstraint(), ATExecAttachPartition(), ATExecDropConstraint(), ATExecDropExpression(), ATExecValidateConstraint(), ATPrepChangePersistence(), AttrDefaultFetch(), change_owner_fix_column_acls(), change_owner_recurse_to_sequences(), changeDependenciesOf(), changeDependenciesOn(), changeDependencyFor(), CheckConstraintFetch(), checkSharedDependencies(), ChooseConstraintName(), CloneFkReferenced(), CloneRowTriggersToPartition(), ConstraintNameExists(), ConstraintNameIsUsed(), CopyStatistics(), copyTemplateDependencies(), CountDBSubscriptions(), CreateComments(), CreateInheritance(), CreatePolicy(), CreateSharedComments(), CreateTrigger(), DefineOpClass(), DefineTSConfiguration(), DeleteAttributeTuples(), DeleteComments(), deleteDependencyRecordsFor(), deleteDependencyRecordsForClass(), deleteDependencyRecordsForSpecific(), DeleteInheritsTuple(), DeleteInitPrivs(), deleteOneObject(), DeleteSecurityLabel(), DeleteSharedComments(), DeleteSharedSecurityLabel(), DeleteSystemAttributeTuples(), drop_parent_dependency(), DropClonedTriggersFromPartition(), DropConfigurationMapping(), dropDatabaseDependencies(), DropObjectById(), DropRole(), EnableDisableTrigger(), EnumValuesDelete(), exec_object_restorecon(), ExecAlterExtensionStmt(), ExecGrant_Largeobject(), extension_config_remove(), fetch_statentries_for_relation(), find_composite_type_dependencies(), find_inheritance_children(), findDependentObjects(), get_catalog_object_by_oid(), 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(), getAutoExtensionsOfObject(), 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(), MarkInheritDetached(), MergeConstraintsIntoExisting(), MergeWithExistingConstraint(), movedb(), myLargeObjectExists(), PartitionHasPendingDetach(), 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(), RemoveAttrDefault(), RemoveAttrDefaultById(), 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(), validatePartitionedIndex(), and visitDependenciesOf().

503 {
504  HeapTuple htup = NULL;
505 
506  if (sysscan->irel)
507  {
508  if (index_getnext_slot(sysscan->iscan, ForwardScanDirection, sysscan->slot))
509  {
510  bool shouldFree;
511 
512  htup = ExecFetchSlotHeapTuple(sysscan->slot, false, &shouldFree);
513  Assert(!shouldFree);
514 
515  /*
516  * We currently don't need to support lossy index operators for
517  * any system catalog scan. It could be done here, using the scan
518  * keys to drive the operator calls, if we arranged to save the
519  * heap attnums during systable_beginscan(); this is practical
520  * because we still wouldn't need to support indexes on
521  * expressions.
522  */
523  if (sysscan->iscan->xs_recheck)
524  elog(ERROR, "system catalog scans with lossy index conditions are not implemented");
525  }
526  }
527  else
528  {
529  if (table_scan_getnextslot(sysscan->scan, ForwardScanDirection, sysscan->slot))
530  {
531  bool shouldFree;
532 
533  htup = ExecFetchSlotHeapTuple(sysscan->slot, false, &shouldFree);
534  Assert(!shouldFree);
535  }
536  }
537 
538  /*
539  * Handle the concurrent abort while fetching the catalog tuple during
540  * logical streaming of a transaction.
541  */
543 
544  return htup;
545 }
Relation irel
Definition: relscan.h:184
static bool table_scan_getnextslot(TableScanDesc sscan, ScanDirection direction, TupleTableSlot *slot)
Definition: tableam.h:1032
struct IndexScanDescData * iscan
Definition: relscan.h:186
struct TupleTableSlot * slot
Definition: relscan.h:188
#define ERROR
Definition: elog.h:46
struct TableScanDescData * scan
Definition: relscan.h:185
HeapTuple ExecFetchSlotHeapTuple(TupleTableSlot *slot, bool materialize, bool *shouldFree)
Definition: execTuples.c:1644
#define Assert(condition)
Definition: c.h:804
bool index_getnext_slot(IndexScanDesc scan, ScanDirection direction, TupleTableSlot *slot)
Definition: indexam.c:616
#define elog(elevel,...)
Definition: elog.h:232
static void HandleConcurrentAbort()
Definition: genam.c:479

◆ systable_getnext_ordered()

HeapTuple systable_getnext_ordered ( SysScanDesc  sysscan,
ScanDirection  direction 
)

Definition at line 707 of file genam.c.

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

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

708 {
709  HeapTuple htup = NULL;
710 
711  Assert(sysscan->irel);
712  if (index_getnext_slot(sysscan->iscan, direction, sysscan->slot))
713  htup = ExecFetchSlotHeapTuple(sysscan->slot, false, NULL);
714 
715  /* See notes in systable_getnext */
716  if (htup && sysscan->iscan->xs_recheck)
717  elog(ERROR, "system catalog scans with lossy index conditions are not implemented");
718 
719  /*
720  * Handle the concurrent abort while fetching the catalog tuple during
721  * logical streaming of a transaction.
722  */
724 
725  return htup;
726 }
Relation irel
Definition: relscan.h:184
struct IndexScanDescData * iscan
Definition: relscan.h:186
struct TupleTableSlot * slot
Definition: relscan.h:188
#define ERROR
Definition: elog.h:46
HeapTuple ExecFetchSlotHeapTuple(TupleTableSlot *slot, bool materialize, bool *shouldFree)
Definition: execTuples.c:1644
#define Assert(condition)
Definition: c.h:804
bool index_getnext_slot(IndexScanDesc scan, ScanDirection direction, TupleTableSlot *slot)
Definition: indexam.c:616
#define elog(elevel,...)
Definition: elog.h:232
static void HandleConcurrentAbort()
Definition: genam.c:479

◆ systable_recheck_tuple()

bool systable_recheck_tuple ( SysScanDesc  sysscan,
HeapTuple  tup 
)

Definition at line 561 of file genam.c.

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

Referenced by findDependentObjects(), and shdepDropOwned().

562 {
563  Snapshot freshsnap;
564  bool result;
565 
566  Assert(tup == ExecFetchSlotHeapTuple(sysscan->slot, false, NULL));
567 
568  /*
569  * Trust that table_tuple_satisfies_snapshot() and its subsidiaries
570  * (commonly LockBuffer() and HeapTupleSatisfiesMVCC()) do not themselves
571  * acquire snapshots, so we need not register the snapshot. Those
572  * facilities are too low-level to have any business scanning tables.
573  */
574  freshsnap = GetCatalogSnapshot(RelationGetRelid(sysscan->heap_rel));
575 
576  result = table_tuple_satisfies_snapshot(sysscan->heap_rel,
577  sysscan->slot,
578  freshsnap);
579 
580  /*
581  * Handle the concurrent abort while fetching the catalog tuple during
582  * logical streaming of a transaction.
583  */
585 
586  return result;
587 }
Relation heap_rel
Definition: relscan.h:183
Snapshot GetCatalogSnapshot(Oid relid)
Definition: snapmgr.c:386
struct TupleTableSlot * slot
Definition: relscan.h:188
HeapTuple ExecFetchSlotHeapTuple(TupleTableSlot *slot, bool materialize, bool *shouldFree)
Definition: execTuples.c:1644
static bool table_tuple_satisfies_snapshot(Relation rel, TupleTableSlot *slot, Snapshot snapshot)
Definition: tableam.h:1304
#define Assert(condition)
Definition: c.h:804
static void HandleConcurrentAbort()
Definition: genam.c:479
#define RelationGetRelid(relation)
Definition: rel.h:457