PostgreSQL Source Code git master
genam.h File Reference
#include "access/htup.h"
#include "access/sdir.h"
#include "access/skey.h"
#include "nodes/tidbitmap.h"
#include "storage/buf.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)
 
void systable_inplace_update_begin (Relation relation, Oid indexId, bool indexOK, Snapshot snapshot, int nkeys, const ScanKeyData *key, HeapTuple *oldtupcopy, void **state)
 
void systable_inplace_update_finish (void *state, HeapTuple tuple)
 
void systable_inplace_update_cancel (void *state)
 

Macro Definition Documentation

◆ IndexScanIsValid

#define IndexScanIsValid (   scan)    PointerIsValid(scan)

Definition at line 141 of file genam.h.

Typedef Documentation

◆ IndexBuildResult

◆ IndexBulkDeleteCallback

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

Definition at line 89 of file genam.h.

◆ IndexBulkDeleteResult

◆ IndexOrderByDistance

◆ IndexScanDesc

Definition at line 92 of file genam.h.

◆ IndexUniqueCheck

◆ IndexVacuumInfo

◆ ParallelIndexScanDesc

Definition at line 95 of file genam.h.

◆ SysScanDesc

typedef struct SysScanDescData* SysScanDesc

Definition at line 93 of file genam.h.

Enumeration Type Documentation

◆ IndexUniqueCheck

Enumerator
UNIQUE_CHECK_NO 
UNIQUE_CHECK_YES 
UNIQUE_CHECK_PARTIAL 
UNIQUE_CHECK_EXISTING 

Definition at line 117 of file genam.h.

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

Function Documentation

◆ BuildIndexValueDescription()

char * BuildIndexValueDescription ( Relation  indexRelation,
const Datum values,
const 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)
270 }
271
273
274 return buf.data;
275}
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:3836
AclResult pg_class_aclcheck(Oid table_oid, Oid roleid, AclMode mode)
Definition: aclchk.c:4007
int16 AttrNumber
Definition: attnum.h:21
#define InvalidAttrNumber
Definition: attnum.h:23
static Datum values[MAXATTR]
Definition: bootstrap.c:151
#define Assert(condition)
Definition: c.h:815
char * OidOutputFunctionCall(Oid functionId, Datum val)
Definition: fmgr.c:1763
long val
Definition: informix.c:689
int i
Definition: isn.c:72
void getTypeOutputInfo(Oid type, Oid *typOutput, bool *typIsVarlena)
Definition: lsyscache.c:2934
Oid GetUserId(void)
Definition: miscinit.c:517
#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:72
#define InvalidOid
Definition: postgres_ext.h:37
unsigned int Oid
Definition: postgres_ext.h:32
#define RelationGetRelid(relation)
Definition: rel.h:506
#define IndexRelationGetNumberOfKeyAttributes(relation)
Definition: rel.h:525
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:1232
void appendStringInfo(StringInfo str, const char *fmt,...)
Definition: stringinfo.c:145
void appendStringInfoString(StringInfo str, const char *s)
Definition: stringinfo.c:230
void appendStringInfoChar(StringInfo str, char ch)
Definition: stringinfo.c:242
void initStringInfo(StringInfo str)
Definition: stringinfo.c:97
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(), build_index_value_desc(), 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:119
IndexFetchTableData * xs_heapfetch
Definition: relscan.h:167
struct SnapshotData * xs_snapshot
Definition: relscan.h:136
Relation heapRelation
Definition: relscan.h:134
static IndexFetchTableData * table_index_fetch_begin(Relation rel)
Definition: tableam.h:1198

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
549
550 snapshot = RestoreSnapshot(pscan->ps_snapshot_data);
551 RegisterSnapshot(snapshot);
552 scan = index_beginscan_internal(indexrel, nkeys, norderbys, snapshot,
553 pscan, true);
554
555 /*
556 * Save additional parameters into the scandesc. Everything else was set
557 * up by index_beginscan_internal.
558 */
559 scan->heapRelation = heaprel;
560 scan->xs_snapshot = snapshot;
561
562 /* prepare to fetch index matches from table */
563 scan->xs_heapfetch = table_index_fetch_begin(heaprel);
564
565 return scan;
566}
#define RelFileLocatorEquals(locator1, locator2)
Snapshot RestoreSnapshot(char *start_address)
Definition: snapmgr.c:1721
Snapshot RegisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:752
RelFileLocator ps_indexlocator
Definition: relscan.h:190
RelFileLocator ps_locator
Definition: relscan.h:189
char ps_snapshot_data[FLEXIBLE_ARRAY_MEMBER]
Definition: relscan.h:192
RelFileLocator rd_locator
Definition: rel.h:57

References Assert, IndexScanDescData::heapRelation, index_beginscan_internal(), ParallelIndexScanDescData::ps_indexlocator, ParallelIndexScanDescData::ps_locator, ParallelIndexScanDescData::ps_snapshot_data, RelationData::rd_locator, RegisterSnapshot(), RelFileLocatorEquals, 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 750 of file indexam.c.

754{
755 Relation indexRelation = info->index;
756
758 CHECK_REL_PROCEDURE(ambulkdelete);
759
760 return indexRelation->rd_indam->ambulkdelete(info, istat,
761 callback, callback_state);
762}
#define CHECK_REL_PROCEDURE(pname)
Definition: indexam.c:93
#define RELATION_CHECKS
Definition: indexam.c:75
ambulkdelete_function ambulkdelete
Definition: amapi.h:290
Relation index
Definition: genam.h:48
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 790 of file indexam.c.

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

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:211
#define MAX_LOCKMODES
Definition: lock.h:82
#define NoLock
Definition: lockdefs.h:34
void RelationClose(Relation relation)
Definition: relcache.c:2171
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_index_value_desc(), build_indices(), BuildEventTriggerCache(), check_index_is_clusterable(), CheckIndexCompatible(), close_lo_relation(), DefineIndex(), DefineRelation(), DetachPartitionFinalize(), enum_endpoint(), enum_range_internal(), ExecCloseIndices(), ExecEndBitmapIndexScan(), ExecEndIndexOnlyScan(), ExecEndIndexScan(), 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(), rebuild_relation(), refresh_by_match_merge(), RefreshMatViewByOid(), 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:3724
static Page BufferGetPage(Buffer buffer)
Definition: bufmgr.h:396
static Item PageGetItem(const PageData *page, const ItemIdData *itemId)
Definition: bufpage.h:354
static ItemId PageGetItemId(Page page, OffsetNumber offsetNumber)
Definition: bufpage.h:244
PageData * Page
Definition: bufpage.h:82
uint32 TransactionId
Definition: c.h:609
#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:1521
void * palloc(Size size)
Definition: mcxt.c:1317
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:1362
#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{
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:144
#define CHECK_SCAN_PROCEDURE(pname)
Definition: indexam.c:100
#define SCAN_CHECKS
Definition: indexam.c:86
void RelationDecrementReferenceCount(Relation rel)
Definition: relcache.c:2151
void UnregisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:794
amendscan_function amendscan
Definition: amapi.h:304
Relation indexRelation
Definition: relscan.h:135
static void table_index_fetch_end(struct IndexFetchTableData *scan)
Definition: tableam.h:1217

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

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

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

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

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

676{
677 for (;;)
678 {
679 if (!scan->xs_heap_continue)
680 {
681 ItemPointer tid;
682
683 /* Time to fetch the next TID from the index */
684 tid = index_getnext_tid(scan, direction);
685
686 /* If we're out of index entries, we're done */
687 if (tid == NULL)
688 break;
689
690 Assert(ItemPointerEquals(tid, &scan->xs_heaptid));
691 }
692
693 /*
694 * Fetch the next (or only) visible heap tuple for this index entry.
695 * If we don't find anything, loop around and grab the next TID from
696 * the index.
697 */
699 if (index_fetch_heap(scan, slot))
700 return true;
701 }
702
703 return false;
704}
ItemPointer index_getnext_tid(IndexScanDesc scan, ScanDirection direction)
Definition: indexam.c:576
bool index_fetch_heap(IndexScanDesc scan, TupleTableSlot *slot)
Definition: indexam.c:634
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 576 of file indexam.c.

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

831{
832 RegProcedure *loc;
833 int nproc;
834 int procindex;
835
836 nproc = irel->rd_indam->amsupport;
837
838 Assert(procnum > 0 && procnum <= (uint16) nproc);
839
840 procindex = (nproc * (attnum - 1)) + (procnum - 1);
841
842 loc = irel->rd_support;
843
844 Assert(loc != NULL);
845
846 return loc[procindex];
847}
regproc RegProcedure
Definition: c.h:607
uint16_t uint16
Definition: c.h:487
uint16 amsupport
Definition: amapi.h:239
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 862 of file indexam.c.

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

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:4326
aminsert_function aminsert
Definition: amapi.h:288
bool ampredlocks
Definition: amapi.h:263

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:289

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{
411 CHECK_SCAN_PROCEDURE(ammarkpos);
412
413 scan->indexRelation->rd_indam->ammarkpos(scan);
414}
ammarkpos_function ammarkpos
Definition: amapi.h:305

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

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

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_index_value_desc(), build_indices(), BuildEventTriggerCache(), check_index_is_clusterable(), CheckIndexCompatible(), cluster_rel(), DefineIndex(), DefineRelation(), DetachPartitionFinalize(), enum_endpoint(), enum_range_internal(), ExecInitBitmapIndexScan(), ExecInitIndexOnlyScan(), ExecInitIndexScan(), ExecOpenIndices(), 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(), RefreshMatViewByOid(), 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{
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:311

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:768
size_t Size
Definition: c.h:562
Size add_size(Size s1, Size s2)
Definition: shmem.c:488
Size EstimateSnapshotSpace(Snapshot snapshot)
Definition: snapmgr.c:1640
amestimateparallelscan_function amestimateparallelscan
Definition: amapi.h:309

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_locator = heapRelation->rd_locator;
504 target->ps_indexlocator = indexRelation->rd_locator;
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:729
void SerializeSnapshot(Snapshot snapshot, char *start_address)
Definition: snapmgr.c:1664
aminitparallelscan_function aminitparallelscan
Definition: amapi.h:310

References add_size(), IndexAmRoutine::aminitparallelscan, Assert, EstimateSnapshotSpace(), InvalidSnapshot, MAXALIGN, OffsetToPointer, ParallelIndexScanDescData::ps_indexlocator, ParallelIndexScanDescData::ps_locator, ParallelIndexScanDescData::ps_offset, ParallelIndexScanDescData::ps_snapshot_data, RelationData::rd_indam, RelationData::rd_locator, RELATION_CHECKS, 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{
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:301
int numberOfOrderBys
Definition: relscan.h:138

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
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:55
amrestrpos_function amrestrpos
Definition: amapi.h:306

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

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

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

773{
774 Relation indexRelation = info->index;
775
777 CHECK_REL_PROCEDURE(amvacuumcleanup);
778
779 return indexRelation->rd_indam->amvacuumcleanup(info, istat);
780}
amvacuumcleanup_function amvacuumcleanup
Definition: amapi.h:291

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

145{
146 if (scan->keyData != NULL)
147 pfree(scan->keyData);
148 if (scan->orderByData != NULL)
149 pfree(scan->orderByData);
150
151 pfree(scan);
152}
struct ScanKeyData * keyData
Definition: relscan.h:139
struct ScanKeyData * orderByData
Definition: relscan.h:140

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

Referenced by index_endscan().

◆ RelationGetIndexScan()

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

Definition at line 80 of file genam.c.

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

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 ScanKey idxkey;
426
427 idxkey = palloc_array(ScanKeyData, nkeys);
428
429 /* Convert attribute numbers to be index column numbers. */
430 for (i = 0; i < nkeys; i++)
431 {
432 int j;
433
434 memcpy(&idxkey[i], &key[i], sizeof(ScanKeyData));
435
436 for (j = 0; j < IndexRelationGetNumberOfAttributes(irel); j++)
437 {
438 if (key[i].sk_attno == irel->rd_index->indkey.values[j])
439 {
440 idxkey[i].sk_attno = j + 1;
441 break;
442 }
443 }
445 elog(ERROR, "column is not in index");
446 }
447
448 sysscan->iscan = index_beginscan(heapRelation, irel,
449 snapshot, nkeys, 0);
450 index_rescan(sysscan->iscan, idxkey, nkeys, NULL, 0);
451 sysscan->scan = NULL;
452
453 pfree(idxkey);
454 }
455 else
456 {
457 /*
458 * We disallow synchronized scans when forced to use a heapscan on a
459 * catalog. In most cases the desired rows are near the front, so
460 * that the unpredictable start point of a syncscan is a serious
461 * disadvantage; and there are no compensating advantages, because
462 * it's unlikely that such scans will occur in parallel.
463 */
464 sysscan->scan = table_beginscan_strat(heapRelation, snapshot,
465 nkeys, key,
466 true, false);
467 sysscan->iscan = NULL;
468 }
469
470 /*
471 * If CheckXidAlive is set then set a flag to indicate that system table
472 * scan is in-progress. See detailed comments in xact.c where these
473 * variables are declared.
474 */
476 bsysscan = true;
477
478 return sysscan;
479}
#define palloc_array(type, count)
Definition: fe_memutils.h:76
struct SysScanDescData * SysScanDesc
Definition: genam.h:93
bool ReindexIsProcessingIndex(Oid indexOid)
Definition: index.c:4111
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:73
#define AccessShareLock
Definition: lockdefs.h:36
bool IgnoreSystemIndexes
Definition: miscinit.c:81
#define IndexRelationGetNumberOfAttributes(relation)
Definition: rel.h:518
Snapshot GetCatalogSnapshot(Oid relid)
Definition: snapmgr.c:314
AttrNumber sk_attno
Definition: skey.h:67
Relation irel
Definition: relscan.h:201
Relation heap_rel
Definition: relscan.h:200
struct SnapshotData * snapshot
Definition: relscan.h:204
struct IndexScanDescData * iscan
Definition: relscan.h:203
struct TupleTableSlot * slot
Definition: relscan.h:205
struct TableScanDescData * scan
Definition: relscan.h:202
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:937
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(), palloc_array, pfree(), RelationData::rd_index, RegisterSnapshot(), ReindexIsProcessingIndex(), RelationGetRelid, SysScanDescData::scan, ScanKeyData::sk_attno, SysScanDescData::slot, SysScanDescData::snapshot, table_beginscan_strat(), table_slot_create(), and TransactionIdIsValid.

Referenced by AfterTriggerSetState(), AlterConstraintNamespaces(), AlterConstrTriggerDeferrability(), AlterDatabase(), AlterDatabaseOwner(), AlterDatabaseRefreshColl(), AlterDomainDropConstraint(), AlterDomainValidateConstraint(), AlterExtensionNamespace(), AlterPolicy(), AlterSeqNamespaces(), AlterSetting(), AlterTypeRecurse(), ApplyExtensionUpdates(), ApplySetting(), ATExecAddOf(), ATExecAlterChildConstr(), ATExecAlterColumnType(), ATExecAlterConstraint(), ATExecAttachPartition(), ATExecDropConstraint(), ATExecValidateConstraint(), ATPrepChangePersistence(), AttrDefaultFetch(), change_owner_fix_column_acls(), change_owner_recurse_to_sequences(), changeDependenciesOf(), changeDependenciesOn(), changeDependencyFor(), CheckConstraintFetch(), checkSharedDependencies(), ChooseConstraintName(), CloneFkReferenced(), CloneRowTriggersToPartition(), ConstraintNameExists(), ConstraintNameIsUsed(), 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(), dropconstraint_internal(), 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(), findDomainNotNullConstraint(), findNotNullConstraintAttnum(), get_catalog_object_by_oid_extended(), get_database_oid(), get_db_info(), get_domain_constraint_oid(), 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(), LargeObjectExistsWithSnapshot(), load_domaintype_info(), load_enum_cache_data(), LookupOpclassInfo(), makeConfigurationDependencies(), MakeConfigurationMapping(), MarkInheritDetached(), MergeConstraintsIntoExisting(), MergeWithExistingConstraint(), movedb(), object_ownercheck(), PartitionHasPendingDetach(), pg_extension_config_dump(), pg_get_constraintdef_worker(), pg_get_serial_sequence(), pg_get_triggerdef_worker(), pg_largeobject_aclmask_snapshot(), QueueFKConstraintValidation(), RangeDelete(), recordExtensionInitPrivWorker(), recordExtObjInitPriv(), relation_has_policies(), RelationBuildPartitionDesc(), RelationBuildRowSecurity(), RelationBuildRuleLock(), RelationBuildTriggers(), RelationBuildTupleDesc(), RelationGetExclusionInfo(), RelationGetFKeyList(), RelationGetIndexList(), RelationGetNotNullConstraints(), 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(), systable_inplace_update_begin(), 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 653 of file genam.c.

657{
658 SysScanDesc sysscan;
659 int i;
660 ScanKey idxkey;
661
662 /* REINDEX can probably be a hard error here ... */
663 if (ReindexIsProcessingIndex(RelationGetRelid(indexRelation)))
665 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
666 errmsg("cannot access index \"%s\" while it is being reindexed",
667 RelationGetRelationName(indexRelation))));
668 /* ... but we only throw a warning about violating IgnoreSystemIndexes */
670 elog(WARNING, "using index \"%s\" despite IgnoreSystemIndexes",
671 RelationGetRelationName(indexRelation));
672
673 sysscan = (SysScanDesc) palloc(sizeof(SysScanDescData));
674
675 sysscan->heap_rel = heapRelation;
676 sysscan->irel = indexRelation;
677 sysscan->slot = table_slot_create(heapRelation, NULL);
678
679 if (snapshot == NULL)
680 {
681 Oid relid = RelationGetRelid(heapRelation);
682
683 snapshot = RegisterSnapshot(GetCatalogSnapshot(relid));
684 sysscan->snapshot = snapshot;
685 }
686 else
687 {
688 /* Caller is responsible for any snapshot. */
689 sysscan->snapshot = NULL;
690 }
691
692 idxkey = palloc_array(ScanKeyData, nkeys);
693
694 /* Convert attribute numbers to be index column numbers. */
695 for (i = 0; i < nkeys; i++)
696 {
697 int j;
698
699 memcpy(&idxkey[i], &key[i], sizeof(ScanKeyData));
700
701 for (j = 0; j < IndexRelationGetNumberOfAttributes(indexRelation); j++)
702 {
703 if (key[i].sk_attno == indexRelation->rd_index->indkey.values[j])
704 {
705 idxkey[i].sk_attno = j + 1;
706 break;
707 }
708 }
709 if (j == IndexRelationGetNumberOfAttributes(indexRelation))
710 elog(ERROR, "column is not in index");
711 }
712
713 sysscan->iscan = index_beginscan(heapRelation, indexRelation,
714 snapshot, nkeys, 0);
715 index_rescan(sysscan->iscan, idxkey, nkeys, NULL, 0);
716 sysscan->scan = NULL;
717
718 pfree(idxkey);
719
720 /*
721 * If CheckXidAlive is set then set a flag to indicate that system table
722 * scan is in-progress. See detailed comments in xact.c where these
723 * variables are declared.
724 */
726 bsysscan = true;
727
728 return sysscan;
729}
#define WARNING
Definition: elog.h:36

References bsysscan, CheckXidAlive, 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(), palloc_array, pfree(), RelationData::rd_index, RegisterSnapshot(), ReindexIsProcessingIndex(), RelationGetRelationName, RelationGetRelid, SysScanDescData::scan, ScanKeyData::sk_attno, SysScanDescData::slot, SysScanDescData::snapshot, table_slot_create(), TransactionIdIsValid, 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 606 of file genam.c.

607{
608 if (sysscan->slot)
609 {
611 sysscan->slot = NULL;
612 }
613
614 if (sysscan->irel)
615 {
616 index_endscan(sysscan->iscan);
618 }
619 else
620 table_endscan(sysscan->scan);
621
622 if (sysscan->snapshot)
624
625 /*
626 * Reset the bsysscan flag at the end of the systable scan. See detailed
627 * comments in xact.c where these variables are declared.
628 */
630 bsysscan = false;
631
632 pfree(sysscan);
633}
void ExecDropSingleTupleTableSlot(TupleTableSlot *slot)
Definition: execTuples.c:1441
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:1025

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(), AlterConstrTriggerDeferrability(), AlterDatabase(), AlterDatabaseOwner(), AlterDatabaseRefreshColl(), AlterDomainDropConstraint(), AlterDomainValidateConstraint(), AlterExtensionNamespace(), AlterPolicy(), AlterSeqNamespaces(), AlterSetting(), AlterTypeRecurse(), ApplyExtensionUpdates(), ApplySetting(), ATExecAddOf(), ATExecAlterChildConstr(), ATExecAlterColumnType(), ATExecAlterConstraint(), ATExecAttachPartition(), ATExecDropConstraint(), ATExecValidateConstraint(), ATPrepChangePersistence(), AttrDefaultFetch(), change_owner_fix_column_acls(), change_owner_recurse_to_sequences(), changeDependenciesOf(), changeDependenciesOn(), changeDependencyFor(), CheckConstraintFetch(), checkSharedDependencies(), ChooseConstraintName(), CloneFkReferenced(), CloneRowTriggersToPartition(), ConstraintNameExists(), ConstraintNameIsUsed(), 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(), dropconstraint_internal(), 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(), findDomainNotNullConstraint(), findNotNullConstraintAttnum(), get_catalog_object_by_oid_extended(), get_database_oid(), get_db_info(), get_domain_constraint_oid(), 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(), LargeObjectExistsWithSnapshot(), load_domaintype_info(), load_enum_cache_data(), LookupOpclassInfo(), makeConfigurationDependencies(), MakeConfigurationMapping(), MarkInheritDetached(), MergeConstraintsIntoExisting(), MergeWithExistingConstraint(), movedb(), object_ownercheck(), PartitionHasPendingDetach(), pg_extension_config_dump(), pg_get_constraintdef_worker(), pg_get_serial_sequence(), pg_get_triggerdef_worker(), pg_largeobject_aclmask_snapshot(), QueueFKConstraintValidation(), RangeDelete(), recordExtensionInitPrivWorker(), recordExtObjInitPriv(), relation_has_policies(), RelationBuildPartitionDesc(), RelationBuildRowSecurity(), RelationBuildRuleLock(), RelationBuildTriggers(), RelationBuildTupleDesc(), RelationGetExclusionInfo(), RelationGetFKeyList(), RelationGetIndexList(), RelationGetNotNullConstraints(), 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(), systable_inplace_update_begin(), systable_inplace_update_cancel(), systable_inplace_update_finish(), toastrel_valueid_exists(), TriggerSetParentTrigger(), tryAttachPartitionForeignKey(), typeInheritsFrom(), vac_update_datfrozenxid(), and validatePartitionedIndex().

◆ systable_endscan_ordered()

void systable_endscan_ordered ( SysScanDesc  sysscan)

Definition at line 760 of file genam.c.

761{
762 if (sysscan->slot)
763 {
765 sysscan->slot = NULL;
766 }
767
768 Assert(sysscan->irel);
769 index_endscan(sysscan->iscan);
770 if (sysscan->snapshot)
772
773 /*
774 * Reset the bsysscan flag at the end of the systable scan. See detailed
775 * comments in xact.c where these variables are declared.
776 */
778 bsysscan = false;
779
780 pfree(sysscan);
781}

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

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

◆ systable_getnext()

HeapTuple systable_getnext ( SysScanDesc  sysscan)

Definition at line 513 of file genam.c.

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

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(), AlterConstrTriggerDeferrability(), AlterDatabase(), AlterDatabaseOwner(), AlterDatabaseRefreshColl(), AlterDomainDropConstraint(), AlterDomainValidateConstraint(), AlterExtensionNamespace(), AlterPolicy(), AlterSeqNamespaces(), AlterSetting(), AlterTypeRecurse(), ApplyExtensionUpdates(), ApplySetting(), ATExecAddOf(), ATExecAlterChildConstr(), ATExecAlterColumnType(), ATExecAlterConstraint(), ATExecAttachPartition(), ATExecDropConstraint(), ATExecValidateConstraint(), ATPrepChangePersistence(), AttrDefaultFetch(), change_owner_fix_column_acls(), change_owner_recurse_to_sequences(), changeDependenciesOf(), changeDependenciesOn(), changeDependencyFor(), CheckConstraintFetch(), checkSharedDependencies(), ChooseConstraintName(), CloneFkReferenced(), CloneRowTriggersToPartition(), ConstraintNameExists(), ConstraintNameIsUsed(), 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(), dropconstraint_internal(), 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(), findDomainNotNullConstraint(), findNotNullConstraintAttnum(), get_catalog_object_by_oid_extended(), get_database_oid(), get_db_info(), get_domain_constraint_oid(), 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(), LargeObjectExistsWithSnapshot(), load_domaintype_info(), load_enum_cache_data(), LookupOpclassInfo(), makeConfigurationDependencies(), MakeConfigurationMapping(), MarkInheritDetached(), MergeConstraintsIntoExisting(), MergeWithExistingConstraint(), movedb(), object_ownercheck(), PartitionHasPendingDetach(), pg_extension_config_dump(), pg_get_constraintdef_worker(), pg_get_serial_sequence(), pg_get_triggerdef_worker(), pg_largeobject_aclmask_snapshot(), QueueFKConstraintValidation(), RangeDelete(), recordExtensionInitPrivWorker(), recordExtObjInitPriv(), relation_has_policies(), RelationBuildPartitionDesc(), RelationBuildRowSecurity(), RelationBuildRuleLock(), RelationBuildTriggers(), RelationBuildTupleDesc(), RelationGetExclusionInfo(), RelationGetFKeyList(), RelationGetIndexList(), RelationGetNotNullConstraints(), 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(), systable_inplace_update_begin(), 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 735 of file genam.c.

736{
737 HeapTuple htup = NULL;
738
739 Assert(sysscan->irel);
740 if (index_getnext_slot(sysscan->iscan, direction, sysscan->slot))
741 htup = ExecFetchSlotHeapTuple(sysscan->slot, false, NULL);
742
743 /* See notes in systable_getnext */
744 if (htup && sysscan->iscan->xs_recheck)
745 elog(ERROR, "system catalog scans with lossy index conditions are not implemented");
746
747 /*
748 * Handle the concurrent abort while fetching the catalog tuple during
749 * logical streaming of a transaction.
750 */
752
753 return htup;
754}

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

void systable_inplace_update_begin ( Relation  relation,
Oid  indexId,
bool  indexOK,
Snapshot  snapshot,
int  nkeys,
const ScanKeyData key,
HeapTuple oldtupcopy,
void **  state 
)

Definition at line 810 of file genam.c.

817{
818 int retries = 0;
819 SysScanDesc scan;
820 HeapTuple oldtup;
822
823 /*
824 * For now, we don't allow parallel updates. Unlike a regular update,
825 * this should never create a combo CID, so it might be possible to relax
826 * this restriction, but not without more thought and testing. It's not
827 * clear that it would be useful, anyway.
828 */
829 if (IsInParallelMode())
831 (errcode(ERRCODE_INVALID_TRANSACTION_STATE),
832 errmsg("cannot update tuples during a parallel operation")));
833
834 /*
835 * Accept a snapshot argument, for symmetry, but this function advances
836 * its snapshot as needed to reach the tail of the updated tuple chain.
837 */
838 Assert(snapshot == NULL);
839
840 Assert(IsInplaceUpdateRelation(relation) || !IsSystemRelation(relation));
841
842 /* Loop for an exclusive-locked buffer of a non-updated tuple. */
843 do
844 {
845 TupleTableSlot *slot;
846
848
849 /*
850 * Processes issuing heap_update (e.g. GRANT) at maximum speed could
851 * drive us to this error. A hostile table owner has stronger ways to
852 * damage their own table, so that's minor.
853 */
854 if (retries++ > 10000)
855 elog(ERROR, "giving up after too many tries to overwrite row");
856
857 INJECTION_POINT("inplace-before-pin");
858 scan = systable_beginscan(relation, indexId, indexOK, snapshot,
859 nkeys, unconstify(ScanKeyData *, key));
860 oldtup = systable_getnext(scan);
861 if (!HeapTupleIsValid(oldtup))
862 {
863 systable_endscan(scan);
864 *oldtupcopy = NULL;
865 return;
866 }
867
868 slot = scan->slot;
870 bslot = (BufferHeapTupleTableSlot *) slot;
871 } while (!heap_inplace_lock(scan->heap_rel,
872 bslot->base.tuple, bslot->buffer,
873 (void (*) (void *)) systable_endscan, scan));
874
875 *oldtupcopy = heap_copytuple(oldtup);
876 *state = scan;
877}
#define unconstify(underlying_type, expr)
Definition: c.h:1202
bool IsSystemRelation(Relation relation)
Definition: catalog.c:73
bool IsInplaceUpdateRelation(Relation relation)
Definition: catalog.c:152
void systable_endscan(SysScanDesc sysscan)
Definition: genam.c:606
HeapTuple systable_getnext(SysScanDesc sysscan)
Definition: genam.c:513
SysScanDesc systable_beginscan(Relation heapRelation, Oid indexId, bool indexOK, Snapshot snapshot, int nkeys, ScanKey key)
Definition: genam.c:387
bool heap_inplace_lock(Relation relation, HeapTuple oldtup_ptr, Buffer buffer, void(*release_callback)(void *), void *arg)
Definition: heapam.c:6270
HeapTuple heap_copytuple(HeapTuple tuple)
Definition: heaptuple.c:778
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define INJECTION_POINT(name)
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:122
Definition: regguts.h:323
#define TTS_IS_BUFFERTUPLE(slot)
Definition: tuptable.h:237
bool IsInParallelMode(void)
Definition: xact.c:1088

References Assert, BufferHeapTupleTableSlot::buffer, CHECK_FOR_INTERRUPTS, elog, ereport, errcode(), errmsg(), ERROR, heap_copytuple(), heap_inplace_lock(), SysScanDescData::heap_rel, HeapTupleIsValid, INJECTION_POINT, IsInParallelMode(), IsInplaceUpdateRelation(), IsSystemRelation(), sort-test::key, SysScanDescData::slot, systable_beginscan(), systable_endscan(), systable_getnext(), TTS_IS_BUFFERTUPLE, and unconstify.

Referenced by create_toast_table(), dropdb(), EventTriggerOnLogin(), index_update_stats(), relation_statistics_update(), vac_update_datfrozenxid(), and vac_update_relstats().

◆ systable_inplace_update_cancel()

void systable_inplace_update_cancel ( void *  state)

Definition at line 905 of file genam.c.

906{
908 Relation relation = scan->heap_rel;
909 TupleTableSlot *slot = scan->slot;
911 HeapTuple oldtup = bslot->base.tuple;
912 Buffer buffer = bslot->buffer;
913
914 heap_inplace_unlock(relation, oldtup, buffer);
915 systable_endscan(scan);
916}
int Buffer
Definition: buf.h:23
void heap_inplace_unlock(Relation relation, HeapTuple oldtup, Buffer buffer)
Definition: heapam.c:6551

References BufferHeapTupleTableSlot::buffer, heap_inplace_unlock(), SysScanDescData::heap_rel, SysScanDescData::slot, and systable_endscan().

Referenced by EventTriggerOnLogin(), index_update_stats(), relation_statistics_update(), vac_update_datfrozenxid(), and vac_update_relstats().

◆ systable_inplace_update_finish()

void systable_inplace_update_finish ( void *  state,
HeapTuple  tuple 
)

Definition at line 886 of file genam.c.

887{
889 Relation relation = scan->heap_rel;
890 TupleTableSlot *slot = scan->slot;
892 HeapTuple oldtup = bslot->base.tuple;
893 Buffer buffer = bslot->buffer;
894
895 heap_inplace_update_and_unlock(relation, oldtup, tuple, buffer);
896 systable_endscan(scan);
897}
void heap_inplace_update_and_unlock(Relation relation, HeapTuple oldtup, HeapTuple tuple, Buffer buffer)
Definition: heapam.c:6406

References BufferHeapTupleTableSlot::buffer, heap_inplace_update_and_unlock(), SysScanDescData::heap_rel, SysScanDescData::slot, and systable_endscan().

Referenced by create_toast_table(), dropdb(), EventTriggerOnLogin(), index_update_stats(), relation_statistics_update(), vac_update_datfrozenxid(), and vac_update_relstats().

◆ systable_recheck_tuple()

bool systable_recheck_tuple ( SysScanDesc  sysscan,
HeapTuple  tup 
)

Definition at line 572 of file genam.c.

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

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

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