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 indexRelation, Snapshot snapshot)
 
void index_parallelscan_initialize (Relation heapRelation, Relation indexRelation, Snapshot snapshot, ParallelIndexScanDesc target)
 
void index_parallelrescan (IndexScanDesc scan)
 
IndexScanDesc index_beginscan_parallel (Relation heaprel, Relation indexrel, int nkeys, int norderbys, ParallelIndexScanDesc pscan)
 
ItemPointer index_getnext_tid (IndexScanDesc scan, ScanDirection direction)
 
bool index_fetch_heap (IndexScanDesc scan, 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, 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:115
@ UNIQUE_CHECK_NO
Definition: genam.h:116
@ UNIQUE_CHECK_EXISTING
Definition: genam.h:119
@ UNIQUE_CHECK_PARTIAL
Definition: genam.h:118
@ UNIQUE_CHECK_YES
Definition: genam.h:117

Function Documentation

◆ BuildIndexValueDescription()

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

Definition at line 177 of file genam.c.

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 ||
230  {
231  /* No access, so clean up and return */
232  return NULL;
233  }
234  }
235  }
236 
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, ", ");
270  }
271 
272  appendStringInfoChar(&buf, ')');
273 
274  return buf.data;
275 }
AclResult
Definition: acl.h:183
@ ACLCHECK_OK
Definition: acl.h:184
AclResult pg_attribute_aclcheck(Oid table_oid, AttrNumber attnum, Oid roleid, AclMode mode)
Definition: aclchk.c:4617
AclResult pg_class_aclcheck(Oid table_oid, Oid roleid, AclMode mode)
Definition: aclchk.c:4746
int16 AttrNumber
Definition: attnum.h:21
#define InvalidAttrNumber
Definition: attnum.h:23
static Datum values[MAXATTR]
Definition: bootstrap.c:156
char * OidOutputFunctionCall(Oid functionId, Datum val)
Definition: fmgr.c:1705
long val
Definition: informix.c:664
int i
Definition: isn.c:73
Assert(fmt[strlen(fmt) - 1] !='\n')
void getTypeOutputInfo(Oid type, Oid *typOutput, bool *typIsVarlena)
Definition: lsyscache.c:2865
Oid GetUserId(void)
Definition: miscinit.c:497
#define ACL_SELECT
Definition: parsenodes.h:84
int16 attnum
Definition: pg_attribute.h:83
FormData_pg_index * Form_pg_index
Definition: pg_index.h:70
static char * buf
Definition: pg_test_fsync.c:67
#define InvalidOid
Definition: postgres_ext.h:36
unsigned int Oid
Definition: postgres_ext.h:31
#define RelationGetRelid(relation)
Definition: rel.h:501
#define IndexRelationGetNumberOfKeyAttributes(relation)
Definition: rel.h:520
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:1187
void appendStringInfo(StringInfo str, const char *fmt,...)
Definition: stringinfo.c:91
void appendStringInfoString(StringInfo str, const char *s)
Definition: stringinfo.c:176
void appendStringInfoChar(StringInfo str, char ch)
Definition: stringinfo.c:188
void initStringInfo(StringInfo str)
Definition: stringinfo.c:59
Oid * rd_opcintype
Definition: rel.h:204
Form_pg_index rd_index
Definition: rel.h:188

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(), comparetup_index_btree(), and gist_page_items().

◆ index_beginscan()

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

Definition at line 205 of file indexam.c.

209 {
210  IndexScanDesc scan;
211 
212  Assert(snapshot != InvalidSnapshot);
213 
214  scan = index_beginscan_internal(indexRelation, nkeys, norderbys, snapshot, NULL, false);
215 
216  /*
217  * Save additional parameters into the scandesc. Everything else was set
218  * up by RelationGetIndexScan.
219  */
220  scan->heapRelation = heapRelation;
221  scan->xs_snapshot = snapshot;
222 
223  /* prepare to fetch index matches from table */
224  scan->xs_heapfetch = table_index_fetch_begin(heapRelation);
225 
226  return scan;
227 }
static IndexScanDesc index_beginscan_internal(Relation indexRelation, int nkeys, int norderbys, Snapshot snapshot, ParallelIndexScanDesc pscan, bool temp_snap)
Definition: indexam.c:259
#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:1163

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

239 {
240  IndexScanDesc scan;
241 
242  Assert(snapshot != InvalidSnapshot);
243 
244  scan = index_beginscan_internal(indexRelation, nkeys, 0, snapshot, NULL, false);
245 
246  /*
247  * Save additional parameters into the scandesc. Everything else was set
248  * up by RelationGetIndexScan.
249  */
250  scan->xs_snapshot = snapshot;
251 
252  return scan;
253 }

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

494 {
495  Snapshot snapshot;
496  IndexScanDesc scan;
497 
498  Assert(RelationGetRelid(heaprel) == pscan->ps_relid);
499  snapshot = RestoreSnapshot(pscan->ps_snapshot_data);
500  RegisterSnapshot(snapshot);
501  scan = index_beginscan_internal(indexrel, nkeys, norderbys, snapshot,
502  pscan, true);
503 
504  /*
505  * Save additional parameters into the scandesc. Everything else was set
506  * up by index_beginscan_internal.
507  */
508  scan->heapRelation = heaprel;
509  scan->xs_snapshot = snapshot;
510 
511  /* prepare to fetch index matches from table */
512  scan->xs_heapfetch = table_index_fetch_begin(heaprel);
513 
514  return scan;
515 }
Snapshot RestoreSnapshot(char *start_address)
Definition: snapmgr.c:2206
Snapshot RegisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:829
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 699 of file indexam.c.

703 {
704  Relation indexRelation = info->index;
705 
707  CHECK_REL_PROCEDURE(ambulkdelete);
708 
709  return indexRelation->rd_indam->ambulkdelete(info, istat,
710  callback, callback_state);
711 }
#define CHECK_REL_PROCEDURE(pname)
Definition: indexam.c:93
#define RELATION_CHECKS
Definition: indexam.c:79
ambulkdelete_function ambulkdelete
Definition: amapi.h:262
Relation index
Definition: genam.h:46
struct IndexAmRoutine * rd_indam
Definition: rel.h:202
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 739 of file indexam.c.

740 {
742 
743  /* amcanreturn is optional; assume false if not provided by AM */
744  if (indexRelation->rd_indam->amcanreturn == NULL)
745  return false;
746 
747  return indexRelation->rd_indam->amcanreturn(indexRelation, attno);
748 }
amcanreturn_function amcanreturn
Definition: amapi.h:264

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

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 }
void UnlockRelationId(LockRelId *relid, LOCKMODE lockmode)
Definition: lmgr.c:213
#define MAX_LOCKMODES
Definition: lock.h:87
#define NoLock
Definition: lockdefs.h:34
void RelationClose(Relation relation)
Definition: relcache.c:2160
LockRelId lockRelId
Definition: rel.h:45
Definition: rel.h:38
LockInfoData rd_lockInfo
Definition: rel.h:113

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(), 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 294 of file genam.c.

299 {
300  TM_IndexDeleteOp delstate;
301  TransactionId snapshotConflictHorizon = InvalidTransactionId;
302  Page ipage = BufferGetPage(ibuf);
303  IndexTuple itup;
304 
305  Assert(nitems > 0);
306 
307  delstate.irel = irel;
308  delstate.iblknum = BufferGetBlockNumber(ibuf);
309  delstate.bottomup = false;
310  delstate.bottomupfreespace = 0;
311  delstate.ndeltids = 0;
312  delstate.deltids = palloc(nitems * sizeof(TM_IndexDelete));
313  delstate.status = palloc(nitems * sizeof(TM_IndexStatus));
314 
315  /* identify what the index tuples about to be deleted point to */
316  for (int i = 0; i < nitems; i++)
317  {
318  OffsetNumber offnum = itemnos[i];
319  ItemId iitemid;
320 
321  iitemid = PageGetItemId(ipage, offnum);
322  itup = (IndexTuple) PageGetItem(ipage, iitemid);
323 
324  Assert(ItemIdIsDead(iitemid));
325 
326  ItemPointerCopy(&itup->t_tid, &delstate.deltids[i].tid);
327  delstate.deltids[i].id = delstate.ndeltids;
328  delstate.status[i].idxoffnum = offnum;
329  delstate.status[i].knowndeletable = true; /* LP_DEAD-marked */
330  delstate.status[i].promising = false; /* unused */
331  delstate.status[i].freespace = 0; /* unused */
332 
333  delstate.ndeltids++;
334  }
335 
336  /* determine the actual xid horizon */
337  snapshotConflictHorizon = table_index_delete_tuples(hrel, &delstate);
338 
339  /* assert tableam agrees that all items are deletable */
340  Assert(delstate.ndeltids == nitems);
341 
342  pfree(delstate.deltids);
343  pfree(delstate.status);
344 
345  return snapshotConflictHorizon;
346 }
BlockNumber BufferGetBlockNumber(Buffer buffer)
Definition: bufmgr.c:2763
static Page BufferGetPage(Buffer buffer)
Definition: bufmgr.h:280
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:588
#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:1306
void * palloc(Size size)
Definition: mcxt.c:1199
uint16 OffsetNumber
Definition: off.h:24
ItemPointerData t_tid
Definition: itup.h:37
TM_IndexStatus * status
Definition: tableam.h:231
int bottomupfreespace
Definition: tableam.h:226
Relation irel
Definition: tableam.h:223
TM_IndexDelete * deltids
Definition: tableam.h:230
BlockNumber iblknum
Definition: tableam.h:224
ItemPointerData tid
Definition: tableam.h:189
bool knowndeletable
Definition: tableam.h:196
bool promising
Definition: tableam.h:199
int16 freespace
Definition: tableam.h:200
OffsetNumber idxoffnum
Definition: tableam.h:195
static TransactionId table_index_delete_tuples(Relation rel, TM_IndexDeleteOp *delstate)
Definition: tableam.h:1327
#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, 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 327 of file indexam.c.

328 {
329  SCAN_CHECKS;
330  CHECK_SCAN_PROCEDURE(amendscan);
331 
332  /* Release resources (like buffer pins) from table accesses */
333  if (scan->xs_heapfetch)
334  {
336  scan->xs_heapfetch = NULL;
337  }
338 
339  /* End the AM's scan */
340  scan->indexRelation->rd_indam->amendscan(scan);
341 
342  /* Release index refcount acquired by index_beginscan */
344 
345  if (scan->xs_temp_snap)
347 
348  /* Release the scan data structure itself */
349  IndexScanEnd(scan);
350 }
void IndexScanEnd(IndexScanDesc scan)
Definition: genam.c:145
#define CHECK_SCAN_PROCEDURE(pname)
Definition: indexam.c:100
#define SCAN_CHECKS
Definition: indexam.c:86
void RelationDecrementReferenceCount(Relation rel)
Definition: relcache.c:2140
void UnregisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:871
amendscan_function amendscan
Definition: amapi.h:275
Relation indexRelation
Definition: relscan.h:118
static void table_index_fetch_end(struct IndexFetchTableData *scan)
Definition: tableam.h:1182

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

584 {
585  bool all_dead = false;
586  bool found;
587 
588  found = table_index_fetch_tuple(scan->xs_heapfetch, &scan->xs_heaptid,
589  scan->xs_snapshot, slot,
590  &scan->xs_heap_continue, &all_dead);
591 
592  if (found)
594 
595  /*
596  * If we scanned a whole HOT chain and found only dead tuples, tell index
597  * AM to kill its entry for that TID (this will take effect in the next
598  * amgettuple call, in index_getnext_tid). We do not do this when in
599  * recovery because it may violate MVCC to do so. See comments in
600  * RelationGetIndexScan().
601  */
602  if (!scan->xactStartedInRecovery)
603  scan->kill_prior_tuple = all_dead;
604 
605  return found;
606 }
#define pgstat_count_heap_fetch(rel)
Definition: pgstat.h:535
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:1212

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

670 {
671  int64 ntids;
672 
673  SCAN_CHECKS;
674  CHECK_SCAN_PROCEDURE(amgetbitmap);
675 
676  /* just make sure this is false... */
677  scan->kill_prior_tuple = false;
678 
679  /*
680  * have the am's getbitmap proc do all the work.
681  */
682  ntids = scan->indexRelation->rd_indam->amgetbitmap(scan, bitmap);
683 
685 
686  return ntids;
687 }
#define pgstat_count_index_tuples(rel, n)
Definition: pgstat.h:545
amgetbitmap_function amgetbitmap
Definition: amapi.h:274

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

625 {
626  for (;;)
627  {
628  if (!scan->xs_heap_continue)
629  {
630  ItemPointer tid;
631 
632  /* Time to fetch the next TID from the index */
633  tid = index_getnext_tid(scan, direction);
634 
635  /* If we're out of index entries, we're done */
636  if (tid == NULL)
637  break;
638 
639  Assert(ItemPointerEquals(tid, &scan->xs_heaptid));
640  }
641 
642  /*
643  * Fetch the next (or only) visible heap tuple for this index entry.
644  * If we don't find anything, loop around and grab the next TID from
645  * the index.
646  */
648  if (index_fetch_heap(scan, slot))
649  return true;
650  }
651 
652  return false;
653 }
ItemPointer index_getnext_tid(IndexScanDesc scan, ScanDirection direction)
Definition: indexam.c:525
bool index_fetch_heap(IndexScanDesc scan, TupleTableSlot *slot)
Definition: indexam.c:583
bool ItemPointerEquals(ItemPointer pointer1, ItemPointer pointer2)
Definition: itemptr.c:29
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 525 of file indexam.c.

526 {
527  bool found;
528 
529  SCAN_CHECKS;
530  CHECK_SCAN_PROCEDURE(amgettuple);
531 
532  /* XXX: we should assert that a snapshot is pushed or registered */
534 
535  /*
536  * The AM's amgettuple proc finds the next index entry matching the scan
537  * keys, and puts the TID into scan->xs_heaptid. It should also set
538  * scan->xs_recheck and possibly scan->xs_itup/scan->xs_hitup, though we
539  * pay no attention to those fields here.
540  */
541  found = scan->indexRelation->rd_indam->amgettuple(scan, direction);
542 
543  /* Reset kill flag immediately for safety */
544  scan->kill_prior_tuple = false;
545  scan->xs_heap_continue = false;
546 
547  /* If we're out of index entries, we're done */
548  if (!found)
549  {
550  /* release resources (like buffer pins) from table accesses */
551  if (scan->xs_heapfetch)
553 
554  return NULL;
555  }
557 
559 
560  /* Return the TID of the tuple we found. */
561  return &scan->xs_heaptid;
562 }
TransactionId RecentXmin
Definition: snapmgr.c:114
amgettuple_function amgettuple
Definition: amapi.h:273
static void table_index_fetch_reset(struct IndexFetchTableData *scan)
Definition: tableam.h:1173
#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 777 of file indexam.c.

780 {
781  RegProcedure *loc;
782  int nproc;
783  int procindex;
784 
785  nproc = irel->rd_indam->amsupport;
786 
787  Assert(procnum > 0 && procnum <= (uint16) nproc);
788 
789  procindex = (nproc * (attnum - 1)) + (procnum - 1);
790 
791  loc = irel->rd_support;
792 
793  Assert(loc != NULL);
794 
795  return loc[procindex];
796 }
unsigned short uint16
Definition: c.h:441
regproc RegProcedure
Definition: c.h:586
uint16 amsupport
Definition: amapi.h:216
RegProcedure * rd_support
Definition: rel.h:205

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(), RelationGetIndexRawAttOptions(), spgdoinsert(), and spgGetCache().

◆ index_getprocinfo()

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

Definition at line 811 of file indexam.c.

814 {
815  FmgrInfo *locinfo;
816  int nproc;
817  int optsproc;
818  int procindex;
819 
820  nproc = irel->rd_indam->amsupport;
821  optsproc = irel->rd_indam->amoptsprocnum;
822 
823  Assert(procnum > 0 && procnum <= (uint16) nproc);
824 
825  procindex = (nproc * (attnum - 1)) + (procnum - 1);
826 
827  locinfo = irel->rd_supportinfo;
828 
829  Assert(locinfo != NULL);
830 
831  locinfo += procindex;
832 
833  /* Initialize the lookup info if first time through */
834  if (locinfo->fn_oid == InvalidOid)
835  {
836  RegProcedure *loc = irel->rd_support;
837  RegProcedure procId;
838 
839  Assert(loc != NULL);
840 
841  procId = loc[procindex];
842 
843  /*
844  * Complain if function was not found during IndexSupportInitialize.
845  * This should not happen unless the system tables contain bogus
846  * entries for the index opclass. (If an AM wants to allow a support
847  * function to be optional, it can use index_getprocid.)
848  */
849  if (!RegProcedureIsValid(procId))
850  elog(ERROR, "missing support function %d for attribute %d of index \"%s\"",
851  procnum, attnum, RelationGetRelationName(irel));
852 
853  fmgr_info_cxt(procId, locinfo, irel->rd_indexcxt);
854 
855  if (procnum != optsproc)
856  {
857  /* Initialize locinfo->fn_expr with opclass options Const */
858  bytea **attoptions = RelationGetIndexAttOptions(irel, false);
860 
861  set_fn_opclass_options(locinfo, attoptions[attnum - 1]);
862 
863  MemoryContextSwitchTo(oldcxt);
864  }
865  }
866 
867  return locinfo;
868 }
#define RegProcedureIsValid(p)
Definition: c.h:713
#define ERROR
Definition: elog.h:39
void set_fn_opclass_options(FmgrInfo *flinfo, bytea *options)
Definition: fmgr.c:2012
void fmgr_info_cxt(Oid functionId, FmgrInfo *finfo, MemoryContext mcxt)
Definition: fmgr.c:137
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:135
#define RelationGetRelationName(relation)
Definition: rel.h:535
bytea ** RelationGetIndexAttOptions(Relation relation, bool copy)
Definition: relcache.c:5815
Definition: fmgr.h:57
Oid fn_oid
Definition: fmgr.h:59
uint16 amoptsprocnum
Definition: amapi.h:218
MemoryContext rd_indexcxt
Definition: rel.h:200
struct FmgrInfo * rd_supportinfo
Definition: rel.h:206
Definition: c.h:623

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(), _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 176 of file indexam.c.

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 }
#define InvalidBlockNumber
Definition: block.h:33
void CheckForSerializableConflictIn(Relation relation, ItemPointer tid, BlockNumber blkno)
Definition: predicate.c:4441
aminsert_function aminsert
Definition: amapi.h:261
bool ampredlocks
Definition: amapi.h:240

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

void index_markpos ( IndexScanDesc  scan)

Definition at line 357 of file indexam.c.

358 {
359  SCAN_CHECKS;
360  CHECK_SCAN_PROCEDURE(ammarkpos);
361 
362  scan->indexRelation->rd_indam->ammarkpos(scan);
363 }
ammarkpos_function ammarkpos
Definition: amapi.h:276

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

949 {
950  int amoptsprocnum = indrel->rd_indam->amoptsprocnum;
951  Oid procid = InvalidOid;
952  FmgrInfo *procinfo;
953  local_relopts relopts;
954 
955  /* fetch options support procedure if specified */
956  if (amoptsprocnum != 0)
957  procid = index_getprocid(indrel, attnum, amoptsprocnum);
958 
959  if (!OidIsValid(procid))
960  {
961  Oid opclass;
962  Datum indclassDatum;
963  oidvector *indclass;
964  bool isnull;
965 
966  if (!DatumGetPointer(attoptions))
967  return NULL; /* ok, no options, no procedure */
968 
969  /*
970  * Report an error if the opclass's options-parsing procedure does not
971  * exist but the opclass options are specified.
972  */
973  indclassDatum = SysCacheGetAttr(INDEXRELID, indrel->rd_indextuple,
974  Anum_pg_index_indclass, &isnull);
975  Assert(!isnull);
976  indclass = (oidvector *) DatumGetPointer(indclassDatum);
977  opclass = indclass->values[attnum - 1];
978 
979  ereport(ERROR,
980  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
981  errmsg("operator class %s has no options",
982  generate_opclass_name(opclass))));
983  }
984 
985  init_local_reloptions(&relopts, 0);
986 
987  procinfo = index_getprocinfo(indrel, attnum, amoptsprocnum);
988 
989  (void) FunctionCall1(procinfo, PointerGetDatum(&relopts));
990 
991  return build_local_reloptions(&relopts, attoptions, validate);
992 }
#define OidIsValid(objectId)
Definition: c.h:711
int errcode(int sqlerrcode)
Definition: elog.c:858
int errmsg(const char *fmt,...)
Definition: elog.c:1069
#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:811
RegProcedure index_getprocid(Relation irel, AttrNumber attnum, uint16 procnum)
Definition: indexam.c:777
static Datum PointerGetDatum(const void *X)
Definition: postgres.h:670
uintptr_t Datum
Definition: postgres.h:412
static Pointer DatumGetPointer(Datum X)
Definition: postgres.h:660
void init_local_reloptions(local_relopts *relopts, Size relopt_struct_size)
Definition: reloptions.c:736
void * build_local_reloptions(local_relopts *relopts, Datum options, bool validate)
Definition: reloptions.c:1947
char * generate_opclass_name(Oid opclass)
Definition: ruleutils.c:11399
struct HeapTupleData * rd_indextuple
Definition: rel.h:190
Definition: c.h:662
Oid values[FLEXIBLE_ARRAY_MEMBER]
Definition: c.h:669
Datum SysCacheGetAttr(int cacheId, HeapTuple tup, AttrNumber attributeNumber, bool *isNull)
Definition: syscache.c:1434
@ INDEXRELID
Definition: syscache.h:66

References IndexAmRoutine::amoptsprocnum, Assert(), attnum, 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().

◆ index_open()

Relation index_open ( Oid  relationId,
LOCKMODE  lockmode 
)

Definition at line 132 of file indexam.c.

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 }
Relation relation_open(Oid relationId, LOCKMODE lockmode)
Definition: relation.c:48
Form_pg_class rd_rel
Definition: rel.h:110

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(), vac_open_indexes(), and validate_index().

◆ index_parallelrescan()

void index_parallelrescan ( IndexScanDesc  scan)

Definition at line 474 of file indexam.c.

475 {
476  SCAN_CHECKS;
477 
478  if (scan->xs_heapfetch)
480 
481  /* amparallelrescan is optional; assume no-op if not provided by AM */
482  if (scan->indexRelation->rd_indam->amparallelrescan != NULL)
484 }
amparallelrescan_function amparallelrescan
Definition: amapi.h:282

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,
Snapshot  snapshot 
)

Definition at line 406 of file indexam.c.

407 {
408  Size nbytes;
409 
410  Assert(snapshot != InvalidSnapshot);
411 
413 
414  nbytes = offsetof(ParallelIndexScanDescData, ps_snapshot_data);
415  nbytes = add_size(nbytes, EstimateSnapshotSpace(snapshot));
416  nbytes = MAXALIGN(nbytes);
417 
418  /*
419  * If amestimateparallelscan is not provided, assume there is no
420  * AM-specific data needed. (It's hard to believe that could work, but
421  * it's easy enough to cater to it here.)
422  */
423  if (indexRelation->rd_indam->amestimateparallelscan != NULL)
424  nbytes = add_size(nbytes,
425  indexRelation->rd_indam->amestimateparallelscan());
426 
427  return nbytes;
428 }
#define MAXALIGN(LEN)
Definition: c.h:747
size_t Size
Definition: c.h:541
Size add_size(Size s1, Size s2)
Definition: shmem.c:502
Size EstimateSnapshotSpace(Snapshot snapshot)
Definition: snapmgr.c:2123
amestimateparallelscan_function amestimateparallelscan
Definition: amapi.h:280

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

443 {
444  Size offset;
445 
446  Assert(snapshot != InvalidSnapshot);
447 
449 
450  offset = add_size(offsetof(ParallelIndexScanDescData, ps_snapshot_data),
451  EstimateSnapshotSpace(snapshot));
452  offset = MAXALIGN(offset);
453 
454  target->ps_relid = RelationGetRelid(heapRelation);
455  target->ps_indexid = RelationGetRelid(indexRelation);
456  target->ps_offset = offset;
457  SerializeSnapshot(snapshot, target->ps_snapshot_data);
458 
459  /* aminitparallelscan is optional; assume no-op if not provided by AM */
460  if (indexRelation->rd_indam->aminitparallelscan != NULL)
461  {
462  void *amtarget;
463 
464  amtarget = OffsetToPointer(target, offset);
465  indexRelation->rd_indam->aminitparallelscan(amtarget);
466  }
467 }
#define OffsetToPointer(base, offset)
Definition: c.h:708
void SerializeSnapshot(Snapshot snapshot, char *start_address)
Definition: snapmgr.c:2147
aminitparallelscan_function aminitparallelscan
Definition: amapi.h:281

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

304 {
305  SCAN_CHECKS;
306  CHECK_SCAN_PROCEDURE(amrescan);
307 
308  Assert(nkeys == scan->numberOfKeys);
309  Assert(norderbys == scan->numberOfOrderBys);
310 
311  /* Release resources (like buffer pins) from table accesses */
312  if (scan->xs_heapfetch)
314 
315  scan->kill_prior_tuple = false; /* for safety */
316  scan->xs_heap_continue = false;
317 
318  scan->indexRelation->rd_indam->amrescan(scan, keys, nkeys,
319  orderbys, norderbys);
320 }
amrescan_function amrescan
Definition: amapi.h:272
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 381 of file indexam.c.

382 {
384 
385  SCAN_CHECKS;
386  CHECK_SCAN_PROCEDURE(amrestrpos);
387 
388  /* release resources (like buffer pins) from table accesses */
389  if (scan->xs_heapfetch)
391 
392  scan->kill_prior_tuple = false; /* for safety */
393  scan->xs_heap_continue = false;
394 
395  scan->indexRelation->rd_indam->amrestrpos(scan);
396 }
#define IsMVCCSnapshot(snapshot)
Definition: snapmgr.h:96
amrestrpos_function amrestrpos
Definition: amapi.h:277

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

882 {
883  int i;
884 
885  Assert(distances || !recheckOrderBy);
886 
887  scan->xs_recheckorderby = recheckOrderBy;
888 
889  for (i = 0; i < scan->numberOfOrderBys; i++)
890  {
891  if (orderByTypes[i] == FLOAT8OID)
892  {
893 #ifndef USE_FLOAT8_BYVAL
894  /* must free any old value to avoid memory leakage */
895  if (!scan->xs_orderbynulls[i])
897 #endif
898  if (distances && !distances[i].isnull)
899  {
900  scan->xs_orderbyvals[i] = Float8GetDatum(distances[i].value);
901  scan->xs_orderbynulls[i] = false;
902  }
903  else
904  {
905  scan->xs_orderbyvals[i] = (Datum) 0;
906  scan->xs_orderbynulls[i] = true;
907  }
908  }
909  else if (orderByTypes[i] == FLOAT4OID)
910  {
911  /* convert distance function's result to ORDER BY type */
912  if (distances && !distances[i].isnull)
913  {
914  scan->xs_orderbyvals[i] = Float4GetDatum((float4) distances[i].value);
915  scan->xs_orderbynulls[i] = false;
916  }
917  else
918  {
919  scan->xs_orderbyvals[i] = (Datum) 0;
920  scan->xs_orderbynulls[i] = true;
921  }
922  }
923  else
924  {
925  /*
926  * If the ordering operator's return value is anything else, we
927  * don't know how to convert the float8 bound calculated by the
928  * distance function to that. The executor won't actually need
929  * the order by values we return here, if there are no lossy
930  * results, so only insist on converting if the *recheck flag is
931  * set.
932  */
933  if (scan->xs_recheckorderby)
934  elog(ERROR, "ORDER BY operator must return float8 or float4 if the distance function is lossy");
935  scan->xs_orderbynulls[i] = true;
936  }
937  }
938 }
float float4
Definition: c.h:565
Datum Float8GetDatum(float8 X)
Definition: fmgr.c:1758
static struct @143 value
static Datum Float4GetDatum(float4 X)
Definition: postgres.h:823
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 720 of file indexam.c.

722 {
723  Relation indexRelation = info->index;
724 
726  CHECK_REL_PROCEDURE(amvacuumcleanup);
727 
728  return indexRelation->rd_indam->amvacuumcleanup(info, istat);
729 }
amvacuumcleanup_function amvacuumcleanup
Definition: amapi.h:263

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

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 * 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 81 of file genam.c.

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 }
struct IndexScanDescData * IndexScanDesc
Definition: genam.h:89
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:1026

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

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

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(), exec_object_restorecon(), ExecAlterExtensionStmt(), ExecGrant_Largeobject(), extension_config_remove(), fetch_statentries_for_relation(), find_composite_type_dependencies(), find_inheritance_children_extended(), 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_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(), RemoveAttrDefault(), RemoveAttrDefaultById(), RemoveExtensionById(), RemoveInheritance(), RemovePolicyById(), RemoveRewriteRuleById(), RemoveRoleFromObjectACL(), RemoveRoleFromObjectPolicy(), RemoveStatistics(), RemoveTriggerById(), RemoveTSConfigurationById(), rename_policy(), renametrig(), renametrig_internal(), renametrig_partition(), 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 646 of file genam.c.

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

References elog(), 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 599 of file genam.c.

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

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(), exec_object_restorecon(), ExecAlterExtensionStmt(), ExecGrant_Largeobject(), extension_config_remove(), fetch_statentries_for_relation(), find_composite_type_dependencies(), find_inheritance_children_extended(), 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_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(), RemoveAttrDefault(), RemoveAttrDefaultById(), RemoveExtensionById(), RemoveInheritance(), RemovePolicyById(), RemoveRewriteRuleById(), RemoveRoleFromObjectACL(), RemoveRoleFromObjectPolicy(), RemoveStatistics(), RemoveTriggerById(), RemoveTSConfigurationById(), rename_policy(), renametrig(), renametrig_internal(), renametrig_partition(), 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 506 of file genam.c.

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

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(), exec_object_restorecon(), ExecAlterExtensionStmt(), ExecGrant_Largeobject(), extension_config_remove(), fetch_statentries_for_relation(), find_composite_type_dependencies(), find_inheritance_children_extended(), 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_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(), RemoveAttrDefault(), RemoveAttrDefaultById(), RemoveExtensionById(), RemoveInheritance(), RemovePolicyById(), RemoveRewriteRuleById(), RemoveRoleFromObjectACL(), RemoveRoleFromObjectPolicy(), RemoveStatistics(), RemoveTriggerById(), RemoveTSConfigurationById(), rename_policy(), renametrig(), renametrig_internal(), renametrig_partition(), 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 711 of file genam.c.

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

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

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

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

Referenced by findDependentObjects(), and shdepDropOwned().