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)
 
Relation try_index_open (Oid relationId, LOCKMODE lockmode)
 
void index_close (Relation relation, LOCKMODE lockmode)
 
bool index_insert (Relation indexRelation, Datum *values, bool *isnull, ItemPointer heap_t_ctid, Relation heapRelation, IndexUniqueCheck checkUnique, bool indexUnchanged, struct IndexInfo *indexInfo)
 
void index_insert_cleanup (Relation indexRelation, 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 indexRelation, int nkeys, int norderbys, Snapshot snapshot)
 
void index_parallelscan_initialize (Relation heapRelation, Relation indexRelation, Snapshot snapshot, ParallelIndexScanDesc target)
 
void index_parallelrescan (IndexScanDesc scan)
 
IndexScanDesc index_beginscan_parallel (Relation heaprel, Relation indexrel, int nkeys, int norderbys, ParallelIndexScanDesc pscan)
 
ItemPointer index_getnext_tid (IndexScanDesc scan, ScanDirection direction)
 
bool index_fetch_heap (IndexScanDesc scan, 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 indrel, AttrNumber attnum, Datum attoptions, bool validate)
 
IndexScanDesc RelationGetIndexScan (Relation indexRelation, int nkeys, int norderbys)
 
void IndexScanEnd (IndexScanDesc scan)
 
char * BuildIndexValueDescription (Relation indexRelation, const Datum *values, const 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 139 of file genam.h.

Typedef Documentation

◆ IndexBuildResult

◆ IndexBulkDeleteCallback

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

Definition at line 87 of file genam.h.

◆ IndexBulkDeleteResult

◆ IndexOrderByDistance

◆ IndexScanDesc

Definition at line 90 of file genam.h.

◆ IndexUniqueCheck

◆ IndexVacuumInfo

◆ ParallelIndexScanDesc

Definition at line 93 of file genam.h.

◆ SysScanDesc

typedef struct SysScanDescData* SysScanDesc

Definition at line 91 of file genam.h.

Enumeration Type Documentation

◆ IndexUniqueCheck

Enumerator
UNIQUE_CHECK_NO 
UNIQUE_CHECK_YES 
UNIQUE_CHECK_PARTIAL 
UNIQUE_CHECK_EXISTING 

Definition at line 115 of file genam.h.

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

Function Documentation

◆ BuildIndexValueDescription()

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

Definition at line 174 of file genam.c.

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

References ACL_SELECT, ACLCHECK_OK, appendStringInfo(), appendStringInfoChar(), appendStringInfoString(), Assert, attnum, buf, check_enable_rls(), 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, val, and values.

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

◆ index_beginscan()

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

Definition at line 256 of file indexam.c.

260 {
261  IndexScanDesc scan;
262 
263  Assert(snapshot != InvalidSnapshot);
264 
265  scan = index_beginscan_internal(indexRelation, nkeys, norderbys, snapshot, NULL, false);
266 
267  /*
268  * Save additional parameters into the scandesc. Everything else was set
269  * up by RelationGetIndexScan.
270  */
271  scan->heapRelation = heapRelation;
272  scan->xs_snapshot = snapshot;
273 
274  /* prepare to fetch index matches from table */
275  scan->xs_heapfetch = table_index_fetch_begin(heapRelation);
276 
277  return scan;
278 }
static IndexScanDesc index_beginscan_internal(Relation indexRelation, int nkeys, int norderbys, Snapshot snapshot, ParallelIndexScanDesc pscan, bool temp_snap)
Definition: indexam.c:310
#define InvalidSnapshot
Definition: snapshot.h:123
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:150
struct SnapshotData * xs_snapshot
Definition: relscan.h:119
Relation heapRelation
Definition: relscan.h:117
static IndexFetchTableData * table_index_fetch_begin(Relation rel)
Definition: tableam.h:1192

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

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

◆ index_beginscan_bitmap()

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

Definition at line 287 of file indexam.c.

290 {
291  IndexScanDesc scan;
292 
293  Assert(snapshot != InvalidSnapshot);
294 
295  scan = index_beginscan_internal(indexRelation, nkeys, 0, snapshot, NULL, false);
296 
297  /*
298  * Save additional parameters into the scandesc. Everything else was set
299  * up by RelationGetIndexScan.
300  */
301  scan->xs_snapshot = snapshot;
302 
303  return scan;
304 }

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

Referenced by ExecInitBitmapIndexScan().

◆ index_beginscan_parallel()

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

Definition at line 541 of file indexam.c.

543 {
544  Snapshot snapshot;
545  IndexScanDesc scan;
546 
547  Assert(RelationGetRelid(heaprel) == pscan->ps_relid);
548  snapshot = RestoreSnapshot(pscan->ps_snapshot_data);
549  RegisterSnapshot(snapshot);
550  scan = index_beginscan_internal(indexrel, nkeys, norderbys, snapshot,
551  pscan, true);
552 
553  /*
554  * Save additional parameters into the scandesc. Everything else was set
555  * up by index_beginscan_internal.
556  */
557  scan->heapRelation = heaprel;
558  scan->xs_snapshot = snapshot;
559 
560  /* prepare to fetch index matches from table */
561  scan->xs_heapfetch = table_index_fetch_begin(heaprel);
562 
563  return scan;
564 }
Snapshot RestoreSnapshot(char *start_address)
Definition: snapmgr.c:1775
Snapshot RegisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:794
char ps_snapshot_data[FLEXIBLE_ARRAY_MEMBER]
Definition: relscan.h:175

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

◆ index_bulk_delete()

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

Definition at line 748 of file indexam.c.

752 {
753  Relation indexRelation = info->index;
754 
756  CHECK_REL_PROCEDURE(ambulkdelete);
757 
758  return indexRelation->rd_indam->ambulkdelete(info, istat,
759  callback, callback_state);
760 }
#define CHECK_REL_PROCEDURE(pname)
Definition: indexam.c:93
#define RELATION_CHECKS
Definition: indexam.c:75
ambulkdelete_function ambulkdelete
Definition: amapi.h:271
Relation index
Definition: genam.h:46
struct IndexAmRoutine * rd_indam
Definition: rel.h:206
static void callback(struct sockaddr *addr, struct sockaddr *mask, void *unused)
Definition: test_ifaddrs.c:46

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

Referenced by vac_bulkdel_one_index(), and validate_index().

◆ index_can_return()

bool index_can_return ( Relation  indexRelation,
int  attno 
)

Definition at line 788 of file indexam.c.

789 {
791 
792  /* amcanreturn is optional; assume false if not provided by AM */
793  if (indexRelation->rd_indam->amcanreturn == NULL)
794  return false;
795 
796  return indexRelation->rd_indam->amcanreturn(indexRelation, attno);
797 }
amcanreturn_function amcanreturn
Definition: amapi.h:273

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

Referenced by get_relation_info(), and indexam_property().

◆ index_close()

void index_close ( Relation  relation,
LOCKMODE  lockmode 
)

Definition at line 177 of file indexam.c.

178 {
179  LockRelId relid = relation->rd_lockInfo.lockRelId;
180 
181  Assert(lockmode >= NoLock && lockmode < MAX_LOCKMODES);
182 
183  /* The relcache does the real work... */
184  RelationClose(relation);
185 
186  if (lockmode != NoLock)
187  UnlockRelationId(&relid, lockmode);
188 }
void UnlockRelationId(LockRelId *relid, LOCKMODE lockmode)
Definition: lmgr.c:212
#define MAX_LOCKMODES
Definition: lock.h:82
#define NoLock
Definition: lockdefs.h:34
void RelationClose(Relation relation)
Definition: relcache.c:2194
LockRelId lockRelId
Definition: rel.h:46
Definition: rel.h:39
LockInfoData rd_lockInfo
Definition: rel.h:114

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

Referenced by _brin_parallel_build_main(), _bt_parallel_build_main(), ATExecAddIndex(), ATExecAddIndexConstraint(), ATExecReplicaIdentity(), AttachPartitionEnsureIndexes(), brin_page_items(), brincostestimate(), bt_index_check_internal(), build_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(), FindReplTupleInLocalRel(), FindUsableIndexForReplicaIdentityFull(), get_actual_variable_range(), get_relation_info(), gin_clean_pending_list(), gincostestimate(), gist_page_items(), hash_bitmap_info(), index_concurrently_build(), index_concurrently_create_copy(), index_concurrently_set_dead(), index_create(), index_drop(), indexam_property(), infer_arbiter_indexes(), InitCatCachePhase2(), lookup_ts_config_cache(), pg_nextoid(), pgstathashindex(), plan_create_index_workers(), refresh_by_match_merge(), reindex_index(), ReindexRelationConcurrently(), RelationFindReplTupleByIndex(), RelationGetIndexAttrBitmap(), RelationTruncateIndexes(), SetIndexStorageProperties(), systable_endscan(), toast_close_indexes(), TryReuseIndex(), vac_close_indexes(), vac_open_indexes(), and validate_index().

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

296 {
297  TM_IndexDeleteOp delstate;
298  TransactionId snapshotConflictHorizon = InvalidTransactionId;
299  Page ipage = BufferGetPage(ibuf);
300  IndexTuple itup;
301 
302  Assert(nitems > 0);
303 
304  delstate.irel = irel;
305  delstate.iblknum = BufferGetBlockNumber(ibuf);
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  OffsetNumber offnum = itemnos[i];
316  ItemId iitemid;
317 
318  iitemid = PageGetItemId(ipage, offnum);
319  itup = (IndexTuple) PageGetItem(ipage, iitemid);
320 
321  Assert(ItemIdIsDead(iitemid));
322 
323  ItemPointerCopy(&itup->t_tid, &delstate.deltids[i].tid);
324  delstate.deltids[i].id = delstate.ndeltids;
325  delstate.status[i].idxoffnum = offnum;
326  delstate.status[i].knowndeletable = true; /* LP_DEAD-marked */
327  delstate.status[i].promising = false; /* unused */
328  delstate.status[i].freespace = 0; /* unused */
329 
330  delstate.ndeltids++;
331  }
332 
333  /* determine the actual xid horizon */
334  snapshotConflictHorizon = table_index_delete_tuples(hrel, &delstate);
335 
336  /* assert tableam agrees that all items are deletable */
337  Assert(delstate.ndeltids == nitems);
338 
339  pfree(delstate.deltids);
340  pfree(delstate.status);
341 
342  return snapshotConflictHorizon;
343 }
BlockNumber BufferGetBlockNumber(Buffer buffer)
Definition: bufmgr.c:3713
static Page BufferGetPage(Buffer buffer)
Definition: bufmgr.h:404
Pointer Page
Definition: bufpage.h:78
static Item PageGetItem(Page page, ItemId itemId)
Definition: bufpage.h:351
static ItemId PageGetItemId(Page page, OffsetNumber offsetNumber)
Definition: bufpage.h:240
uint32 TransactionId
Definition: c.h:652
#define nitems(x)
Definition: indent.h:31
#define ItemIdIsDead(itemId)
Definition: itemid.h:113
static void ItemPointerCopy(const ItemPointerData *fromPointer, ItemPointerData *toPointer)
Definition: itemptr.h:172
IndexTupleData * IndexTuple
Definition: itup.h:53
void pfree(void *pointer)
Definition: mcxt.c:1520
void * palloc(Size size)
Definition: mcxt.c:1316
uint16 OffsetNumber
Definition: off.h:24
ItemPointerData t_tid
Definition: itup.h:37
TM_IndexStatus * status
Definition: tableam.h:255
int bottomupfreespace
Definition: tableam.h:250
Relation irel
Definition: tableam.h:247
TM_IndexDelete * deltids
Definition: tableam.h:254
BlockNumber iblknum
Definition: tableam.h:248
ItemPointerData tid
Definition: tableam.h:213
bool knowndeletable
Definition: tableam.h:220
bool promising
Definition: tableam.h:223
int16 freespace
Definition: tableam.h:224
OffsetNumber idxoffnum
Definition: tableam.h:219
static TransactionId table_index_delete_tuples(Relation rel, TM_IndexDeleteOp *delstate)
Definition: tableam.h:1356
#define InvalidTransactionId
Definition: transam.h:31

References Assert, TM_IndexDeleteOp::bottomup, TM_IndexDeleteOp::bottomupfreespace, BufferGetBlockNumber(), BufferGetPage(), TM_IndexDeleteOp::deltids, TM_IndexStatus::freespace, i, TM_IndexDeleteOp::iblknum, TM_IndexDelete::id, TM_IndexStatus::idxoffnum, InvalidTransactionId, TM_IndexDeleteOp::irel, ItemIdIsDead, ItemPointerCopy(), TM_IndexStatus::knowndeletable, TM_IndexDeleteOp::ndeltids, nitems, 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().

◆ index_endscan()

void index_endscan ( IndexScanDesc  scan)

Definition at line 378 of file indexam.c.

379 {
380  SCAN_CHECKS;
381  CHECK_SCAN_PROCEDURE(amendscan);
382 
383  /* Release resources (like buffer pins) from table accesses */
384  if (scan->xs_heapfetch)
385  {
387  scan->xs_heapfetch = NULL;
388  }
389 
390  /* End the AM's scan */
391  scan->indexRelation->rd_indam->amendscan(scan);
392 
393  /* Release index refcount acquired by index_beginscan */
395 
396  if (scan->xs_temp_snap)
398 
399  /* Release the scan data structure itself */
400  IndexScanEnd(scan);
401 }
void IndexScanEnd(IndexScanDesc scan)
Definition: genam.c:142
#define CHECK_SCAN_PROCEDURE(pname)
Definition: indexam.c:100
#define SCAN_CHECKS
Definition: indexam.c:86
void RelationDecrementReferenceCount(Relation rel)
Definition: relcache.c:2174
void UnregisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:836
amendscan_function amendscan
Definition: amapi.h:284
Relation indexRelation
Definition: relscan.h:118
static void table_index_fetch_end(struct IndexFetchTableData *scan)
Definition: tableam.h:1211

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

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

◆ index_fetch_heap()

bool index_fetch_heap ( IndexScanDesc  scan,
struct TupleTableSlot slot 
)

Definition at line 632 of file indexam.c.

633 {
634  bool all_dead = false;
635  bool found;
636 
637  found = table_index_fetch_tuple(scan->xs_heapfetch, &scan->xs_heaptid,
638  scan->xs_snapshot, slot,
639  &scan->xs_heap_continue, &all_dead);
640 
641  if (found)
643 
644  /*
645  * If we scanned a whole HOT chain and found only dead tuples, tell index
646  * AM to kill its entry for that TID (this will take effect in the next
647  * amgettuple call, in index_getnext_tid). We do not do this when in
648  * recovery because it may violate MVCC to do so. See comments in
649  * RelationGetIndexScan().
650  */
651  if (!scan->xactStartedInRecovery)
652  scan->kill_prior_tuple = all_dead;
653 
654  return found;
655 }
#define pgstat_count_heap_fetch(rel)
Definition: pgstat.h:620
bool xs_heap_continue
Definition: relscan.h:148
bool xactStartedInRecovery
Definition: relscan.h:130
bool kill_prior_tuple
Definition: relscan.h:128
ItemPointerData xs_heaptid
Definition: relscan.h:147
static bool table_index_fetch_tuple(struct IndexFetchTableData *scan, ItemPointer tid, Snapshot snapshot, TupleTableSlot *slot, bool *call_again, bool *all_dead)
Definition: tableam.h:1241

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

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

◆ index_getbitmap()

int64 index_getbitmap ( IndexScanDesc  scan,
TIDBitmap bitmap 
)

Definition at line 718 of file indexam.c.

719 {
720  int64 ntids;
721 
722  SCAN_CHECKS;
723  CHECK_SCAN_PROCEDURE(amgetbitmap);
724 
725  /* just make sure this is false... */
726  scan->kill_prior_tuple = false;
727 
728  /*
729  * have the am's getbitmap proc do all the work.
730  */
731  ntids = scan->indexRelation->rd_indam->amgetbitmap(scan, bitmap);
732 
734 
735  return ntids;
736 }
#define pgstat_count_index_tuples(rel, n)
Definition: pgstat.h:630
amgetbitmap_function amgetbitmap
Definition: amapi.h:283

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

Referenced by MultiExecBitmapIndexScan().

◆ index_getnext_slot()

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

Definition at line 673 of file indexam.c.

674 {
675  for (;;)
676  {
677  if (!scan->xs_heap_continue)
678  {
679  ItemPointer tid;
680 
681  /* Time to fetch the next TID from the index */
682  tid = index_getnext_tid(scan, direction);
683 
684  /* If we're out of index entries, we're done */
685  if (tid == NULL)
686  break;
687 
688  Assert(ItemPointerEquals(tid, &scan->xs_heaptid));
689  }
690 
691  /*
692  * Fetch the next (or only) visible heap tuple for this index entry.
693  * If we don't find anything, loop around and grab the next TID from
694  * the index.
695  */
697  if (index_fetch_heap(scan, slot))
698  return true;
699  }
700 
701  return false;
702 }
ItemPointer index_getnext_tid(IndexScanDesc scan, ScanDirection direction)
Definition: indexam.c:574
bool index_fetch_heap(IndexScanDesc scan, TupleTableSlot *slot)
Definition: indexam.c:632
bool ItemPointerEquals(ItemPointer pointer1, ItemPointer pointer2)
Definition: itemptr.c:35
static bool ItemPointerIsValid(const ItemPointerData *pointer)
Definition: itemptr.h:83

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

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

◆ index_getnext_tid()

ItemPointer index_getnext_tid ( IndexScanDesc  scan,
ScanDirection  direction 
)

Definition at line 574 of file indexam.c.

575 {
576  bool found;
577 
578  SCAN_CHECKS;
579  CHECK_SCAN_PROCEDURE(amgettuple);
580 
581  /* XXX: we should assert that a snapshot is pushed or registered */
583 
584  /*
585  * The AM's amgettuple proc finds the next index entry matching the scan
586  * keys, and puts the TID into scan->xs_heaptid. It should also set
587  * scan->xs_recheck and possibly scan->xs_itup/scan->xs_hitup, though we
588  * pay no attention to those fields here.
589  */
590  found = scan->indexRelation->rd_indam->amgettuple(scan, direction);
591 
592  /* Reset kill flag immediately for safety */
593  scan->kill_prior_tuple = false;
594  scan->xs_heap_continue = false;
595 
596  /* If we're out of index entries, we're done */
597  if (!found)
598  {
599  /* release resources (like buffer pins) from table accesses */
600  if (scan->xs_heapfetch)
602 
603  return NULL;
604  }
606 
608 
609  /* Return the TID of the tuple we found. */
610  return &scan->xs_heaptid;
611 }
TransactionId RecentXmin
Definition: snapmgr.c:99
amgettuple_function amgettuple
Definition: amapi.h:282
static void table_index_fetch_reset(struct IndexFetchTableData *scan)
Definition: tableam.h:1202
#define TransactionIdIsValid(xid)
Definition: transam.h:41

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

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

◆ index_getprocid()

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

Definition at line 826 of file indexam.c.

829 {
830  RegProcedure *loc;
831  int nproc;
832  int procindex;
833 
834  nproc = irel->rd_indam->amsupport;
835 
836  Assert(procnum > 0 && procnum <= (uint16) nproc);
837 
838  procindex = (nproc * (attnum - 1)) + (procnum - 1);
839 
840  loc = irel->rd_support;
841 
842  Assert(loc != NULL);
843 
844  return loc[procindex];
845 }
unsigned short uint16
Definition: c.h:505
regproc RegProcedure
Definition: c.h:650
uint16 amsupport
Definition: amapi.h:220
RegProcedure * rd_support
Definition: rel.h:209

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

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

◆ index_getprocinfo()

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

Definition at line 860 of file indexam.c.

863 {
864  FmgrInfo *locinfo;
865  int nproc;
866  int optsproc;
867  int procindex;
868 
869  nproc = irel->rd_indam->amsupport;
870  optsproc = irel->rd_indam->amoptsprocnum;
871 
872  Assert(procnum > 0 && procnum <= (uint16) nproc);
873 
874  procindex = (nproc * (attnum - 1)) + (procnum - 1);
875 
876  locinfo = irel->rd_supportinfo;
877 
878  Assert(locinfo != NULL);
879 
880  locinfo += procindex;
881 
882  /* Initialize the lookup info if first time through */
883  if (locinfo->fn_oid == InvalidOid)
884  {
885  RegProcedure *loc = irel->rd_support;
886  RegProcedure procId;
887 
888  Assert(loc != NULL);
889 
890  procId = loc[procindex];
891 
892  /*
893  * Complain if function was not found during IndexSupportInitialize.
894  * This should not happen unless the system tables contain bogus
895  * entries for the index opclass. (If an AM wants to allow a support
896  * function to be optional, it can use index_getprocid.)
897  */
898  if (!RegProcedureIsValid(procId))
899  elog(ERROR, "missing support function %d for attribute %d of index \"%s\"",
900  procnum, attnum, RelationGetRelationName(irel));
901 
902  fmgr_info_cxt(procId, locinfo, irel->rd_indexcxt);
903 
904  if (procnum != optsproc)
905  {
906  /* Initialize locinfo->fn_expr with opclass options Const */
907  bytea **attoptions = RelationGetIndexAttOptions(irel, false);
909 
910  set_fn_opclass_options(locinfo, attoptions[attnum - 1]);
911 
912  MemoryContextSwitchTo(oldcxt);
913  }
914  }
915 
916  return locinfo;
917 }
#define RegProcedureIsValid(p)
Definition: c.h:777
#define ERROR
Definition: elog.h:39
#define elog(elevel,...)
Definition: elog.h:224
void set_fn_opclass_options(FmgrInfo *flinfo, bytea *options)
Definition: fmgr.c:2070
void fmgr_info_cxt(Oid functionId, FmgrInfo *finfo, MemoryContext mcxt)
Definition: fmgr.c:137
MemoryContextSwitchTo(old_ctx)
#define RelationGetRelationName(relation)
Definition: rel.h:539
bytea ** RelationGetIndexAttOptions(Relation relation, bool copy)
Definition: relcache.c:5893
Definition: fmgr.h:57
Oid fn_oid
Definition: fmgr.h:59
uint16 amoptsprocnum
Definition: amapi.h:222
MemoryContext rd_indexcxt
Definition: rel.h:204
struct FmgrInfo * rd_supportinfo
Definition: rel.h:210
Definition: c.h:687

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

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

◆ index_insert()

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

Definition at line 213 of file indexam.c.

221 {
223  CHECK_REL_PROCEDURE(aminsert);
224 
225  if (!(indexRelation->rd_indam->ampredlocks))
226  CheckForSerializableConflictIn(indexRelation,
227  (ItemPointer) NULL,
229 
230  return indexRelation->rd_indam->aminsert(indexRelation, values, isnull,
231  heap_t_ctid, heapRelation,
232  checkUnique, indexUnchanged,
233  indexInfo);
234 }
#define InvalidBlockNumber
Definition: block.h:33
void CheckForSerializableConflictIn(Relation relation, ItemPointer tid, BlockNumber blkno)
Definition: predicate.c:4321
aminsert_function aminsert
Definition: amapi.h:269
bool ampredlocks
Definition: amapi.h:244

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

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

◆ index_insert_cleanup()

void index_insert_cleanup ( Relation  indexRelation,
struct IndexInfo indexInfo 
)

Definition at line 241 of file indexam.c.

243 {
245 
246  if (indexRelation->rd_indam->aminsertcleanup)
247  indexRelation->rd_indam->aminsertcleanup(indexRelation, indexInfo);
248 }
aminsertcleanup_function aminsertcleanup
Definition: amapi.h:270

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

Referenced by ExecCloseIndices(), and validate_index().

◆ index_markpos()

void index_markpos ( IndexScanDesc  scan)

Definition at line 408 of file indexam.c.

409 {
410  SCAN_CHECKS;
411  CHECK_SCAN_PROCEDURE(ammarkpos);
412 
413  scan->indexRelation->rd_indam->ammarkpos(scan);
414 }
ammarkpos_function ammarkpos
Definition: amapi.h:285

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

Referenced by ExecIndexMarkPos(), and ExecIndexOnlyMarkPos().

◆ index_opclass_options()

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

Definition at line 996 of file indexam.c.

998 {
999  int amoptsprocnum = indrel->rd_indam->amoptsprocnum;
1000  Oid procid = InvalidOid;
1001  FmgrInfo *procinfo;
1002  local_relopts relopts;
1003 
1004  /* fetch options support procedure if specified */
1005  if (amoptsprocnum != 0)
1006  procid = index_getprocid(indrel, attnum, amoptsprocnum);
1007 
1008  if (!OidIsValid(procid))
1009  {
1010  Oid opclass;
1011  Datum indclassDatum;
1012  oidvector *indclass;
1013 
1014  if (!DatumGetPointer(attoptions))
1015  return NULL; /* ok, no options, no procedure */
1016 
1017  /*
1018  * Report an error if the opclass's options-parsing procedure does not
1019  * exist but the opclass options are specified.
1020  */
1021  indclassDatum = SysCacheGetAttrNotNull(INDEXRELID, indrel->rd_indextuple,
1022  Anum_pg_index_indclass);
1023  indclass = (oidvector *) DatumGetPointer(indclassDatum);
1024  opclass = indclass->values[attnum - 1];
1025 
1026  ereport(ERROR,
1027  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1028  errmsg("operator class %s has no options",
1029  generate_opclass_name(opclass))));
1030  }
1031 
1032  init_local_reloptions(&relopts, 0);
1033 
1034  procinfo = index_getprocinfo(indrel, attnum, amoptsprocnum);
1035 
1036  (void) FunctionCall1(procinfo, PointerGetDatum(&relopts));
1037 
1038  return build_local_reloptions(&relopts, attoptions, validate);
1039 }
#define OidIsValid(objectId)
Definition: c.h:775
int errcode(int sqlerrcode)
Definition: elog.c:857
int errmsg(const char *fmt,...)
Definition: elog.c:1070
#define ereport(elevel,...)
Definition: elog.h:149
#define FunctionCall1(flinfo, arg1)
Definition: fmgr.h:660
FmgrInfo * index_getprocinfo(Relation irel, AttrNumber attnum, uint16 procnum)
Definition: indexam.c:860
RegProcedure index_getprocid(Relation irel, AttrNumber attnum, uint16 procnum)
Definition: indexam.c:826
static Datum PointerGetDatum(const void *X)
Definition: postgres.h:322
uintptr_t Datum
Definition: postgres.h:64
static Pointer DatumGetPointer(Datum X)
Definition: postgres.h:312
void init_local_reloptions(local_relopts *relopts, Size relopt_struct_size)
Definition: reloptions.c:734
void * build_local_reloptions(local_relopts *relopts, Datum options, bool validate)
Definition: reloptions.c:1945
char * generate_opclass_name(Oid opclass)
Definition: ruleutils.c:12466
struct HeapTupleData * rd_indextuple
Definition: rel.h:194
Definition: c.h:726
Oid values[FLEXIBLE_ARRAY_MEMBER]
Definition: c.h:733
Datum SysCacheGetAttrNotNull(int cacheId, HeapTuple tup, AttrNumber attributeNumber)
Definition: syscache.c:510

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

Referenced by index_create(), and RelationGetIndexAttOptions().

◆ index_open()

Relation index_open ( Oid  relationId,
LOCKMODE  lockmode 
)

Definition at line 133 of file indexam.c.

134 {
135  Relation r;
136 
137  r = relation_open(relationId, lockmode);
138 
140 
141  return r;
142 }
static void validate_relation_kind(Relation r)
Definition: indexam.c:197
Relation relation_open(Oid relationId, LOCKMODE lockmode)
Definition: relation.c:47

References relation_open(), and validate_relation_kind().

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

◆ index_parallelrescan()

void index_parallelrescan ( IndexScanDesc  scan)

Definition at line 523 of file indexam.c.

524 {
525  SCAN_CHECKS;
526 
527  if (scan->xs_heapfetch)
529 
530  /* amparallelrescan is optional; assume no-op if not provided by AM */
531  if (scan->indexRelation->rd_indam->amparallelrescan != NULL)
533 }
amparallelrescan_function amparallelrescan
Definition: amapi.h:291

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

Referenced by ExecIndexOnlyScanReInitializeDSM(), and ExecIndexScanReInitializeDSM().

◆ index_parallelscan_estimate()

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

Definition at line 453 of file indexam.c.

455 {
456  Size nbytes;
457 
458  Assert(snapshot != InvalidSnapshot);
459 
461 
462  nbytes = offsetof(ParallelIndexScanDescData, ps_snapshot_data);
463  nbytes = add_size(nbytes, EstimateSnapshotSpace(snapshot));
464  nbytes = MAXALIGN(nbytes);
465 
466  /*
467  * If amestimateparallelscan is not provided, assume there is no
468  * AM-specific data needed. (It's hard to believe that could work, but
469  * it's easy enough to cater to it here.)
470  */
471  if (indexRelation->rd_indam->amestimateparallelscan != NULL)
472  nbytes = add_size(nbytes,
473  indexRelation->rd_indam->amestimateparallelscan(nkeys,
474  norderbys));
475 
476  return nbytes;
477 }
#define MAXALIGN(LEN)
Definition: c.h:811
size_t Size
Definition: c.h:605
Size add_size(Size s1, Size s2)
Definition: shmem.c:493
Size EstimateSnapshotSpace(Snapshot snapshot)
Definition: snapmgr.c:1692
amestimateparallelscan_function amestimateparallelscan
Definition: amapi.h:289

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

Referenced by ExecIndexOnlyScanEstimate(), and ExecIndexScanEstimate().

◆ index_parallelscan_initialize()

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

Definition at line 490 of file indexam.c.

492 {
493  Size offset;
494 
495  Assert(snapshot != InvalidSnapshot);
496 
498 
499  offset = add_size(offsetof(ParallelIndexScanDescData, ps_snapshot_data),
500  EstimateSnapshotSpace(snapshot));
501  offset = MAXALIGN(offset);
502 
503  target->ps_relid = RelationGetRelid(heapRelation);
504  target->ps_indexid = RelationGetRelid(indexRelation);
505  target->ps_offset = offset;
506  SerializeSnapshot(snapshot, target->ps_snapshot_data);
507 
508  /* aminitparallelscan is optional; assume no-op if not provided by AM */
509  if (indexRelation->rd_indam->aminitparallelscan != NULL)
510  {
511  void *amtarget;
512 
513  amtarget = OffsetToPointer(target, offset);
514  indexRelation->rd_indam->aminitparallelscan(amtarget);
515  }
516 }
#define OffsetToPointer(base, offset)
Definition: c.h:772
void SerializeSnapshot(Snapshot snapshot, char *start_address)
Definition: snapmgr.c:1716
aminitparallelscan_function aminitparallelscan
Definition: amapi.h:290

References add_size(), IndexAmRoutine::aminitparallelscan, Assert, EstimateSnapshotSpace(), InvalidSnapshot, MAXALIGN, 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().

◆ index_rescan()

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

Definition at line 352 of file indexam.c.

355 {
356  SCAN_CHECKS;
357  CHECK_SCAN_PROCEDURE(amrescan);
358 
359  Assert(nkeys == scan->numberOfKeys);
360  Assert(norderbys == scan->numberOfOrderBys);
361 
362  /* Release resources (like buffer pins) from table accesses */
363  if (scan->xs_heapfetch)
365 
366  scan->kill_prior_tuple = false; /* for safety */
367  scan->xs_heap_continue = false;
368 
369  scan->indexRelation->rd_indam->amrescan(scan, keys, nkeys,
370  orderbys, norderbys);
371 }
amrescan_function amrescan
Definition: amapi.h:281
int numberOfOrderBys
Definition: relscan.h:121

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

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

◆ index_restrpos()

void index_restrpos ( IndexScanDesc  scan)

Definition at line 432 of file indexam.c.

433 {
435 
436  SCAN_CHECKS;
437  CHECK_SCAN_PROCEDURE(amrestrpos);
438 
439  /* release resources (like buffer pins) from table accesses */
440  if (scan->xs_heapfetch)
442 
443  scan->kill_prior_tuple = false; /* for safety */
444  scan->xs_heap_continue = false;
445 
446  scan->indexRelation->rd_indam->amrestrpos(scan);
447 }
#define IsMVCCSnapshot(snapshot)
Definition: snapmgr.h:62
amrestrpos_function amrestrpos
Definition: amapi.h:286

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

Referenced by ExecIndexOnlyRestrPos(), and ExecIndexRestrPos().

◆ index_store_float8_orderby_distances()

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

Definition at line 928 of file indexam.c.

931 {
932  int i;
933 
934  Assert(distances || !recheckOrderBy);
935 
936  scan->xs_recheckorderby = recheckOrderBy;
937 
938  for (i = 0; i < scan->numberOfOrderBys; i++)
939  {
940  if (orderByTypes[i] == FLOAT8OID)
941  {
942 #ifndef USE_FLOAT8_BYVAL
943  /* must free any old value to avoid memory leakage */
944  if (!scan->xs_orderbynulls[i])
946 #endif
947  if (distances && !distances[i].isnull)
948  {
949  scan->xs_orderbyvals[i] = Float8GetDatum(distances[i].value);
950  scan->xs_orderbynulls[i] = false;
951  }
952  else
953  {
954  scan->xs_orderbyvals[i] = (Datum) 0;
955  scan->xs_orderbynulls[i] = true;
956  }
957  }
958  else if (orderByTypes[i] == FLOAT4OID)
959  {
960  /* convert distance function's result to ORDER BY type */
961  if (distances && !distances[i].isnull)
962  {
963  scan->xs_orderbyvals[i] = Float4GetDatum((float4) distances[i].value);
964  scan->xs_orderbynulls[i] = false;
965  }
966  else
967  {
968  scan->xs_orderbyvals[i] = (Datum) 0;
969  scan->xs_orderbynulls[i] = true;
970  }
971  }
972  else
973  {
974  /*
975  * If the ordering operator's return value is anything else, we
976  * don't know how to convert the float8 bound calculated by the
977  * distance function to that. The executor won't actually need
978  * the order by values we return here, if there are no lossy
979  * results, so only insist on converting if the *recheck flag is
980  * set.
981  */
982  if (scan->xs_recheckorderby)
983  elog(ERROR, "ORDER BY operator must return float8 or float4 if the distance function is lossy");
984  scan->xs_orderbynulls[i] = true;
985  }
986  }
987 }
float float4
Definition: c.h:629
Datum Float8GetDatum(float8 X)
Definition: fmgr.c:1816
static struct @155 value
static Datum Float4GetDatum(float4 X)
Definition: postgres.h:475
bool * xs_orderbynulls
Definition: relscan.h:162
bool xs_recheckorderby
Definition: relscan.h:163
Datum * xs_orderbyvals
Definition: relscan.h:161

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

Referenced by getNextNearest(), and spggettuple().

◆ index_vacuum_cleanup()

IndexBulkDeleteResult* index_vacuum_cleanup ( IndexVacuumInfo info,
IndexBulkDeleteResult istat 
)

Definition at line 769 of file indexam.c.

771 {
772  Relation indexRelation = info->index;
773 
775  CHECK_REL_PROCEDURE(amvacuumcleanup);
776 
777  return indexRelation->rd_indam->amvacuumcleanup(info, istat);
778 }
amvacuumcleanup_function amvacuumcleanup
Definition: amapi.h:272

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

Referenced by do_analyze_rel(), and vac_cleanup_one_index().

◆ IndexScanEnd()

void IndexScanEnd ( IndexScanDesc  scan)

Definition at line 142 of file genam.c.

143 {
144  if (scan->keyData != NULL)
145  pfree(scan->keyData);
146  if (scan->orderByData != NULL)
147  pfree(scan->orderByData);
148 
149  pfree(scan);
150 }
struct ScanKeyData * keyData
Definition: relscan.h:122
struct ScanKeyData * orderByData
Definition: relscan.h:123

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

Referenced by index_endscan().

◆ RelationGetIndexScan()

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

Definition at line 78 of file genam.c.

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

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

◆ systable_beginscan()

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

Definition at line 384 of file genam.c.

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

References AccessShareLock, bsysscan, CheckXidAlive, elog, ERROR, GetCatalogSnapshot(), SysScanDescData::heap_rel, i, IgnoreSystemIndexes, index_beginscan(), index_open(), index_rescan(), IndexRelationGetNumberOfAttributes, SysScanDescData::irel, SysScanDescData::iscan, j, sort-test::key, palloc(), RelationData::rd_index, RegisterSnapshot(), ReindexIsProcessingIndex(), RelationGetRelid, SysScanDescData::scan, SysScanDescData::slot, SysScanDescData::snapshot, table_beginscan_strat(), table_slot_create(), and TransactionIdIsValid.

Referenced by AfterTriggerSetState(), AlterConstraintNamespaces(), AlterDatabase(), AlterDatabaseOwner(), AlterDatabaseRefreshColl(), AlterDomainDropConstraint(), AlterDomainValidateConstraint(), AlterExtensionNamespace(), AlterPolicy(), AlterSeqNamespaces(), AlterSetting(), AlterTypeRecurse(), ApplyExtensionUpdates(), ApplySetting(), ATExecAddOf(), ATExecAlterColumnType(), ATExecAlterConstraint(), ATExecAlterConstrRecurse(), 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(), CopyStatistics(), copyTemplateDependencies(), CountDBSubscriptions(), CreateComments(), CreateInheritance(), CreatePolicy(), CreateSharedComments(), CreateTriggerFiringOn(), DefineOpClass(), DefineTSConfiguration(), DeleteAttributeTuples(), DeleteComments(), deleteDependencyRecordsFor(), deleteDependencyRecordsForClass(), deleteDependencyRecordsForSpecific(), DeleteInheritsTuple(), DeleteInitPrivs(), deleteOneObject(), DeleteSecurityLabel(), DeleteSharedComments(), DeleteSharedSecurityLabel(), DeleteSystemAttributeTuples(), drop_parent_dependency(), DropClonedTriggersFromPartition(), DropConfigurationMapping(), dropDatabaseDependencies(), DropObjectById(), DropRole(), EnableDisableTrigger(), EnumValuesDelete(), EventTriggerOnLogin(), exec_object_restorecon(), ExecAlterExtensionStmt(), ExecGrant_Largeobject(), extension_config_remove(), fetch_statentries_for_relation(), find_composite_type_dependencies(), find_inheritance_children_extended(), findDependentObjects(), findDomainNotNullConstraint(), 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_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(), GetAttrDefaultColumnAddress(), GetAttrDefaultOid(), getAutoExtensionsOfObject(), GetComment(), GetDatabaseTuple(), GetDatabaseTupleByOid(), GetDefaultOpClass(), getExtensionOfObject(), GetForeignKeyActionTriggers(), GetForeignKeyCheckTriggers(), GetNewOidWithIndex(), getObjectDescription(), getObjectIdentityParts(), getOwnedSequences_internal(), GetParentedForeignKeyRefs(), GetPublicationRelations(), GetPublicationSchemas(), GetSecurityLabel(), GetSharedSecurityLabel(), GetSubscriptionRelations(), has_superclass(), HasSubscriptionRelations(), heap_truncate_find_FKs(), index_concurrently_swap(), IndexSetParentIndex(), is_schema_publication(), LargeObjectDrop(), LargeObjectExists(), load_domaintype_info(), load_enum_cache_data(), LookupOpclassInfo(), makeConfigurationDependencies(), MakeConfigurationMapping(), MarkInheritDetached(), MergeConstraintsIntoExisting(), MergeWithExistingConstraint(), movedb(), myLargeObjectExists(), object_ownercheck(), PartitionHasPendingDetach(), pg_extension_config_dump(), pg_get_constraintdef_worker(), pg_get_serial_sequence(), pg_get_triggerdef_worker(), pg_largeobject_aclmask_snapshot(), RangeDelete(), recordExtensionInitPrivWorker(), recordExtObjInitPriv(), relation_has_policies(), RelationBuildPartitionDesc(), RelationBuildRowSecurity(), RelationBuildRuleLock(), RelationBuildTriggers(), RelationBuildTupleDesc(), RelationGetExclusionInfo(), RelationGetFKeyList(), RelationGetIndexList(), RelationGetStatExtList(), RelationRemoveInheritance(), RelidByRelfilenumber(), RememberAllDependentForRebuilding(), RemoveAttrDefault(), RemoveAttrDefaultById(), RemoveExtensionById(), RemoveInheritance(), RemovePolicyById(), RemoveRewriteRuleById(), RemoveRoleFromInitPriv(), RemoveRoleFromObjectACL(), RemoveRoleFromObjectPolicy(), RemoveStatistics(), RemoveTriggerById(), RemoveTSConfigurationById(), rename_policy(), renametrig(), renametrig_internal(), renametrig_partition(), ReplaceRoleInInitPriv(), 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(), TriggerSetParentTrigger(), tryAttachPartitionForeignKey(), typeInheritsFrom(), vac_update_datfrozenxid(), and validatePartitionedIndex().

◆ systable_beginscan_ordered()

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

Definition at line 643 of file genam.c.

647 {
648  SysScanDesc sysscan;
649  int i;
650 
651  /* REINDEX can probably be a hard error here ... */
652  if (ReindexIsProcessingIndex(RelationGetRelid(indexRelation)))
653  ereport(ERROR,
654  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
655  errmsg("cannot access index \"%s\" while it is being reindexed",
656  RelationGetRelationName(indexRelation))));
657  /* ... but we only throw a warning about violating IgnoreSystemIndexes */
659  elog(WARNING, "using index \"%s\" despite IgnoreSystemIndexes",
660  RelationGetRelationName(indexRelation));
661 
662  sysscan = (SysScanDesc) palloc(sizeof(SysScanDescData));
663 
664  sysscan->heap_rel = heapRelation;
665  sysscan->irel = indexRelation;
666  sysscan->slot = table_slot_create(heapRelation, NULL);
667 
668  if (snapshot == NULL)
669  {
670  Oid relid = RelationGetRelid(heapRelation);
671 
672  snapshot = RegisterSnapshot(GetCatalogSnapshot(relid));
673  sysscan->snapshot = snapshot;
674  }
675  else
676  {
677  /* Caller is responsible for any snapshot. */
678  sysscan->snapshot = NULL;
679  }
680 
681  /* Change attribute numbers to be index column numbers. */
682  for (i = 0; i < nkeys; i++)
683  {
684  int j;
685 
686  for (j = 0; j < IndexRelationGetNumberOfAttributes(indexRelation); j++)
687  {
688  if (key[i].sk_attno == indexRelation->rd_index->indkey.values[j])
689  {
690  key[i].sk_attno = j + 1;
691  break;
692  }
693  }
694  if (j == IndexRelationGetNumberOfAttributes(indexRelation))
695  elog(ERROR, "column is not in index");
696  }
697 
698  sysscan->iscan = index_beginscan(heapRelation, indexRelation,
699  snapshot, nkeys, 0);
700  index_rescan(sysscan->iscan, key, nkeys, NULL, 0);
701  sysscan->scan = NULL;
702 
703  return sysscan;
704 }
#define WARNING
Definition: elog.h:36

References elog, ereport, errcode(), errmsg(), ERROR, GetCatalogSnapshot(), SysScanDescData::heap_rel, i, IgnoreSystemIndexes, index_beginscan(), index_rescan(), IndexRelationGetNumberOfAttributes, SysScanDescData::irel, SysScanDescData::iscan, j, sort-test::key, palloc(), RelationData::rd_index, RegisterSnapshot(), ReindexIsProcessingIndex(), RelationGetRelationName, RelationGetRelid, SysScanDescData::scan, 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().

◆ systable_endscan()

void systable_endscan ( SysScanDesc  sysscan)

Definition at line 596 of file genam.c.

597 {
598  if (sysscan->slot)
599  {
601  sysscan->slot = NULL;
602  }
603 
604  if (sysscan->irel)
605  {
606  index_endscan(sysscan->iscan);
607  index_close(sysscan->irel, AccessShareLock);
608  }
609  else
610  table_endscan(sysscan->scan);
611 
612  if (sysscan->snapshot)
613  UnregisterSnapshot(sysscan->snapshot);
614 
615  /*
616  * Reset the bsysscan flag at the end of the systable scan. See detailed
617  * comments in xact.c where these variables are declared.
618  */
620  bsysscan = false;
621 
622  pfree(sysscan);
623 }
void ExecDropSingleTupleTableSlot(TupleTableSlot *slot)
Definition: execTuples.c:1341
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:177
void index_endscan(IndexScanDesc scan)
Definition: indexam.c:378
static void table_endscan(TableScanDesc scan)
Definition: tableam.h:1019

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(), AlterDatabaseRefreshColl(), AlterDomainDropConstraint(), AlterDomainValidateConstraint(), AlterExtensionNamespace(), AlterPolicy(), AlterSeqNamespaces(), AlterSetting(), AlterTypeRecurse(), ApplyExtensionUpdates(), ApplySetting(), ATExecAddOf(), ATExecAlterColumnType(), ATExecAlterConstraint(), ATExecAlterConstrRecurse(), 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(), CopyStatistics(), copyTemplateDependencies(), CountDBSubscriptions(), CreateComments(), CreateInheritance(), CreatePolicy(), CreateSharedComments(), CreateTriggerFiringOn(), DefineOpClass(), DefineTSConfiguration(), DeleteAttributeTuples(), DeleteComments(), deleteDependencyRecordsFor(), deleteDependencyRecordsForClass(), deleteDependencyRecordsForSpecific(), DeleteInheritsTuple(), DeleteInitPrivs(), deleteOneObject(), DeleteSecurityLabel(), DeleteSharedComments(), DeleteSharedSecurityLabel(), DeleteSystemAttributeTuples(), drop_parent_dependency(), DropClonedTriggersFromPartition(), DropConfigurationMapping(), dropDatabaseDependencies(), DropObjectById(), DropRole(), EnableDisableTrigger(), EnumValuesDelete(), EventTriggerOnLogin(), exec_object_restorecon(), ExecAlterExtensionStmt(), ExecGrant_Largeobject(), extension_config_remove(), fetch_statentries_for_relation(), find_composite_type_dependencies(), find_inheritance_children_extended(), findDependentObjects(), findDomainNotNullConstraint(), 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_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(), GetAttrDefaultColumnAddress(), GetAttrDefaultOid(), getAutoExtensionsOfObject(), GetComment(), GetDatabaseTuple(), GetDatabaseTupleByOid(), GetDefaultOpClass(), getExtensionOfObject(), GetForeignKeyActionTriggers(), GetForeignKeyCheckTriggers(), GetNewOidWithIndex(), getObjectDescription(), getObjectIdentityParts(), getOwnedSequences_internal(), GetParentedForeignKeyRefs(), GetPublicationRelations(), GetPublicationSchemas(), GetSecurityLabel(), GetSharedSecurityLabel(), GetSubscriptionRelations(), has_superclass(), HasSubscriptionRelations(), heap_truncate_find_FKs(), index_concurrently_swap(), IndexSetParentIndex(), is_schema_publication(), LargeObjectDrop(), LargeObjectExists(), load_domaintype_info(), load_enum_cache_data(), LookupOpclassInfo(), makeConfigurationDependencies(), MakeConfigurationMapping(), MarkInheritDetached(), MergeConstraintsIntoExisting(), MergeWithExistingConstraint(), movedb(), myLargeObjectExists(), object_ownercheck(), PartitionHasPendingDetach(), pg_extension_config_dump(), pg_get_constraintdef_worker(), pg_get_serial_sequence(), pg_get_triggerdef_worker(), pg_largeobject_aclmask_snapshot(), RangeDelete(), recordExtensionInitPrivWorker(), recordExtObjInitPriv(), relation_has_policies(), RelationBuildPartitionDesc(), RelationBuildRowSecurity(), RelationBuildRuleLock(), RelationBuildTriggers(), RelationBuildTupleDesc(), RelationGetExclusionInfo(), RelationGetFKeyList(), RelationGetIndexList(), RelationGetStatExtList(), RelationRemoveInheritance(), RelidByRelfilenumber(), RememberAllDependentForRebuilding(), RemoveAttrDefault(), RemoveAttrDefaultById(), RemoveExtensionById(), RemoveInheritance(), RemovePolicyById(), RemoveRewriteRuleById(), RemoveRoleFromInitPriv(), RemoveRoleFromObjectACL(), RemoveRoleFromObjectPolicy(), RemoveStatistics(), RemoveTriggerById(), RemoveTSConfigurationById(), rename_policy(), renametrig(), renametrig_internal(), renametrig_partition(), ReplaceRoleInInitPriv(), 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(), TriggerSetParentTrigger(), tryAttachPartitionForeignKey(), typeInheritsFrom(), vac_update_datfrozenxid(), and validatePartitionedIndex().

◆ systable_endscan_ordered()

void systable_endscan_ordered ( SysScanDesc  sysscan)

◆ systable_getnext()

HeapTuple systable_getnext ( SysScanDesc  sysscan)

Definition at line 503 of file genam.c.

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

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(), AlterDatabaseRefreshColl(), AlterDomainDropConstraint(), AlterDomainValidateConstraint(), AlterExtensionNamespace(), AlterPolicy(), AlterSeqNamespaces(), AlterSetting(), AlterTypeRecurse(), ApplyExtensionUpdates(), ApplySetting(), ATExecAddOf(), ATExecAlterColumnType(), ATExecAlterConstraint(), ATExecAlterConstrRecurse(), 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(), CopyStatistics(), copyTemplateDependencies(), CountDBSubscriptions(), CreateComments(), CreateInheritance(), CreatePolicy(), CreateSharedComments(), CreateTriggerFiringOn(), DefineOpClass(), DefineTSConfiguration(), DeleteAttributeTuples(), DeleteComments(), deleteDependencyRecordsFor(), deleteDependencyRecordsForClass(), deleteDependencyRecordsForSpecific(), DeleteInheritsTuple(), DeleteInitPrivs(), deleteOneObject(), DeleteSecurityLabel(), DeleteSharedComments(), DeleteSharedSecurityLabel(), DeleteSystemAttributeTuples(), drop_parent_dependency(), DropClonedTriggersFromPartition(), DropConfigurationMapping(), dropDatabaseDependencies(), DropObjectById(), DropRole(), EnableDisableTrigger(), EnumValuesDelete(), EventTriggerOnLogin(), exec_object_restorecon(), ExecAlterExtensionStmt(), ExecGrant_Largeobject(), extension_config_remove(), fetch_statentries_for_relation(), find_composite_type_dependencies(), find_inheritance_children_extended(), findDependentObjects(), findDomainNotNullConstraint(), 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_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(), GetAttrDefaultColumnAddress(), GetAttrDefaultOid(), getAutoExtensionsOfObject(), GetComment(), GetDatabaseTuple(), GetDatabaseTupleByOid(), GetDefaultOpClass(), getExtensionOfObject(), GetForeignKeyActionTriggers(), GetForeignKeyCheckTriggers(), GetNewOidWithIndex(), getObjectDescription(), getObjectIdentityParts(), getOwnedSequences_internal(), GetParentedForeignKeyRefs(), GetPublicationRelations(), GetPublicationSchemas(), GetSecurityLabel(), GetSharedSecurityLabel(), GetSubscriptionRelations(), has_superclass(), HasSubscriptionRelations(), heap_truncate_find_FKs(), index_concurrently_swap(), IndexSetParentIndex(), is_schema_publication(), LargeObjectDrop(), LargeObjectExists(), load_domaintype_info(), load_enum_cache_data(), LookupOpclassInfo(), makeConfigurationDependencies(), MakeConfigurationMapping(), MarkInheritDetached(), MergeConstraintsIntoExisting(), MergeWithExistingConstraint(), movedb(), myLargeObjectExists(), object_ownercheck(), PartitionHasPendingDetach(), pg_extension_config_dump(), pg_get_constraintdef_worker(), pg_get_serial_sequence(), pg_get_triggerdef_worker(), pg_largeobject_aclmask_snapshot(), RangeDelete(), recordExtensionInitPrivWorker(), recordExtObjInitPriv(), relation_has_policies(), RelationBuildPartitionDesc(), RelationBuildRowSecurity(), RelationBuildRuleLock(), RelationBuildTriggers(), RelationBuildTupleDesc(), RelationGetExclusionInfo(), RelationGetFKeyList(), RelationGetIndexList(), RelationGetStatExtList(), RelationRemoveInheritance(), RelidByRelfilenumber(), RememberAllDependentForRebuilding(), RemoveAttrDefault(), RemoveAttrDefaultById(), RemoveExtensionById(), RemoveInheritance(), RemovePolicyById(), RemoveRewriteRuleById(), RemoveRoleFromInitPriv(), RemoveRoleFromObjectACL(), RemoveRoleFromObjectPolicy(), RemoveStatistics(), RemoveTriggerById(), RemoveTSConfigurationById(), rename_policy(), renametrig(), renametrig_internal(), renametrig_partition(), ReplaceRoleInInitPriv(), 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(), TriggerSetParentTrigger(), tryAttachPartitionForeignKey(), typeInheritsFrom(), vac_update_datfrozenxid(), and validatePartitionedIndex().

◆ systable_getnext_ordered()

HeapTuple systable_getnext_ordered ( SysScanDesc  sysscan,
ScanDirection  direction 
)

Definition at line 710 of file genam.c.

711 {
712  HeapTuple htup = NULL;
713 
714  Assert(sysscan->irel);
715  if (index_getnext_slot(sysscan->iscan, direction, sysscan->slot))
716  htup = ExecFetchSlotHeapTuple(sysscan->slot, false, NULL);
717 
718  /* See notes in systable_getnext */
719  if (htup && sysscan->iscan->xs_recheck)
720  elog(ERROR, "system catalog scans with lossy index conditions are not implemented");
721 
722  /*
723  * Handle the concurrent abort while fetching the catalog tuple during
724  * logical streaming of a transaction.
725  */
727 
728  return htup;
729 }

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

◆ systable_recheck_tuple()

bool systable_recheck_tuple ( SysScanDesc  sysscan,
HeapTuple  tup 
)

Definition at line 562 of file genam.c.

563 {
564  Snapshot freshsnap;
565  bool result;
566 
567  Assert(tup == ExecFetchSlotHeapTuple(sysscan->slot, false, NULL));
568 
569  /*
570  * Trust that table_tuple_satisfies_snapshot() and its subsidiaries
571  * (commonly LockBuffer() and HeapTupleSatisfiesMVCC()) do not themselves
572  * acquire snapshots, so we need not register the snapshot. Those
573  * facilities are too low-level to have any business scanning tables.
574  */
575  freshsnap = GetCatalogSnapshot(RelationGetRelid(sysscan->heap_rel));
576 
577  result = table_tuple_satisfies_snapshot(sysscan->heap_rel,
578  sysscan->slot,
579  freshsnap);
580 
581  /*
582  * Handle the concurrent abort while fetching the catalog tuple during
583  * logical streaming of a transaction.
584  */
586 
587  return result;
588 }
static bool table_tuple_satisfies_snapshot(Relation rel, TupleTableSlot *slot, Snapshot snapshot)
Definition: tableam.h:1335

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

Referenced by CatalogCacheCreateEntry(), findDependentObjects(), and shdepDropOwned().

◆ try_index_open()

Relation try_index_open ( Oid  relationId,
LOCKMODE  lockmode 
)

Definition at line 152 of file indexam.c.

153 {
154  Relation r;
155 
156  r = try_relation_open(relationId, lockmode);
157 
158  /* leave if index does not exist */
159  if (!r)
160  return NULL;
161 
163 
164  return r;
165 }
Relation try_relation_open(Oid relationId, LOCKMODE lockmode)
Definition: relation.c:88

References try_relation_open(), and validate_relation_kind().

Referenced by reindex_index().