Age Owner Branch data TLA Line data Source code
1 : : /*-------------------------------------------------------------------------
2 : : *
3 : : * genam.c
4 : : * general index access method routines
5 : : *
6 : : * Portions Copyright (c) 1996-2026, PostgreSQL Global Development Group
7 : : * Portions Copyright (c) 1994, Regents of the University of California
8 : : *
9 : : *
10 : : * IDENTIFICATION
11 : : * src/backend/access/index/genam.c
12 : : *
13 : : * NOTES
14 : : * many of the old access method routines have been turned into
15 : : * macros and moved to genam.h -cim 4/30/91
16 : : *
17 : : *-------------------------------------------------------------------------
18 : : */
19 : :
20 : : #include "postgres.h"
21 : :
22 : : #include "access/genam.h"
23 : : #include "access/heapam.h"
24 : : #include "access/relscan.h"
25 : : #include "access/tableam.h"
26 : : #include "access/transam.h"
27 : : #include "catalog/index.h"
28 : : #include "lib/stringinfo.h"
29 : : #include "miscadmin.h"
30 : : #include "storage/bufmgr.h"
31 : : #include "storage/procarray.h"
32 : : #include "utils/acl.h"
33 : : #include "utils/injection_point.h"
34 : : #include "utils/lsyscache.h"
35 : : #include "utils/rel.h"
36 : : #include "utils/rls.h"
37 : : #include "utils/ruleutils.h"
38 : : #include "utils/snapmgr.h"
39 : :
40 : :
41 : : /* ----------------------------------------------------------------
42 : : * general access method routines
43 : : *
44 : : * All indexed access methods use an identical scan structure.
45 : : * We don't know how the various AMs do locking, however, so we don't
46 : : * do anything about that here.
47 : : *
48 : : * The intent is that an AM implementor will define a beginscan routine
49 : : * that calls RelationGetIndexScan, to fill in the scan, and then does
50 : : * whatever kind of locking he wants.
51 : : *
52 : : * At the end of a scan, the AM's endscan routine undoes the locking,
53 : : * but does *not* call IndexScanEnd --- the higher-level index_endscan
54 : : * routine does that. (We can't do it in the AM because index_endscan
55 : : * still needs to touch the IndexScanDesc after calling the AM.)
56 : : *
57 : : * Because of this, the AM does not have a choice whether to call
58 : : * RelationGetIndexScan or not; its beginscan routine must return an
59 : : * object made by RelationGetIndexScan. This is kinda ugly but not
60 : : * worth cleaning up now.
61 : : * ----------------------------------------------------------------
62 : : */
63 : :
64 : : /* ----------------
65 : : * RelationGetIndexScan -- Create and fill an IndexScanDesc.
66 : : *
67 : : * This routine creates an index scan structure and sets up initial
68 : : * contents for it.
69 : : *
70 : : * Parameters:
71 : : * indexRelation -- index relation for scan.
72 : : * nkeys -- count of scan keys (index qual conditions).
73 : : * norderbys -- count of index order-by operators.
74 : : *
75 : : * Returns:
76 : : * An initialized IndexScanDesc.
77 : : * ----------------
78 : : */
79 : : IndexScanDesc
5658 tgl@sss.pgh.pa.us 80 :CBC 9327906 : RelationGetIndexScan(Relation indexRelation, int nkeys, int norderbys)
81 : : {
82 : : IndexScanDesc scan;
83 : :
171 michael@paquier.xyz 84 :GNC 9327906 : scan = palloc_object(IndexScanDescData);
85 : :
8776 tgl@sss.pgh.pa.us 86 :CBC 9327906 : scan->heapRelation = NULL; /* may be set later */
2637 andres@anarazel.de 87 : 9327906 : scan->xs_heapfetch = NULL;
8776 tgl@sss.pgh.pa.us 88 : 9327906 : scan->indexRelation = indexRelation;
3265 89 : 9327906 : scan->xs_snapshot = InvalidSnapshot; /* caller must initialize this */
8776 90 : 9327906 : scan->numberOfKeys = nkeys;
5658 91 : 9327906 : scan->numberOfOrderBys = norderbys;
92 : :
93 : : /*
94 : : * We allocate key workspace here, but it won't get filled until amrescan.
95 : : */
8776 96 [ + + ]: 9327906 : if (nkeys > 0)
171 michael@paquier.xyz 97 :GNC 9320109 : scan->keyData = palloc_array(ScanKeyData, nkeys);
98 : : else
8776 tgl@sss.pgh.pa.us 99 :CBC 7797 : scan->keyData = NULL;
5658 100 [ + + ]: 9327906 : if (norderbys > 0)
171 michael@paquier.xyz 101 :GNC 119 : scan->orderByData = palloc_array(ScanKeyData, norderbys);
102 : : else
5658 tgl@sss.pgh.pa.us 103 :CBC 9327787 : scan->orderByData = NULL;
104 : :
5102 bruce@momjian.us 105 : 9327906 : 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 : : */
8772 tgl@sss.pgh.pa.us 117 : 9327906 : scan->kill_prior_tuple = false;
6006 simon@2ndQuadrant.co 118 : 9327906 : scan->xactStartedInRecovery = TransactionStartedDuringRecovery();
119 : 9327906 : scan->ignore_killed_tuples = !scan->xactStartedInRecovery;
120 : :
10492 bruce@momjian.us 121 : 9327906 : scan->opaque = NULL;
445 pg@bowt.ie 122 : 9327906 : scan->instrument = NULL;
123 : :
5349 tgl@sss.pgh.pa.us 124 : 9327906 : scan->xs_itup = NULL;
5340 125 : 9327906 : scan->xs_itupdesc = NULL;
3379 126 : 9327906 : scan->xs_hitup = NULL;
127 : 9327906 : scan->xs_hitupdesc = NULL;
128 : :
10133 bruce@momjian.us 129 : 9327906 : return scan;
130 : : }
131 : :
132 : : /* ----------------
133 : : * IndexScanEnd -- End an index scan.
134 : : *
135 : : * This routine just releases the storage acquired by
136 : : * RelationGetIndexScan(). Any AM-level resources are
137 : : * assumed to already have been released by the AM's
138 : : * endscan routine.
139 : : *
140 : : * Returns:
141 : : * None.
142 : : * ----------------
143 : : */
144 : : void
9648 tgl@sss.pgh.pa.us 145 : 9326562 : IndexScanEnd(IndexScanDesc scan)
146 : : {
147 [ + + ]: 9326562 : if (scan->keyData != NULL)
148 : 9318789 : pfree(scan->keyData);
5658 149 [ + + ]: 9326562 : if (scan->orderByData != NULL)
150 : 115 : pfree(scan->orderByData);
151 : :
9648 152 : 9326562 : pfree(scan);
153 : 9326562 : }
154 : :
155 : : /*
156 : : * BuildIndexValueDescription
157 : : *
158 : : * Construct a string describing the contents of an index entry, in the
159 : : * form "(key_name, ...)=(key_value, ...)". This is currently used
160 : : * for building unique-constraint, exclusion-constraint error messages, and
161 : : * logical replication conflict error messages so only key columns of the index
162 : : * are checked and printed.
163 : : *
164 : : * Note that if the user does not have permissions to view all of the
165 : : * columns involved then a NULL is returned. Returning a partial key seems
166 : : * unlikely to be useful and we have no way to know which of the columns the
167 : : * user provided (unlike in ExecBuildSlotValueDescription).
168 : : *
169 : : * The passed-in values/nulls arrays are the "raw" input to the index AM,
170 : : * e.g. results of FormIndexDatum --- this is not necessarily what is stored
171 : : * in the index, but it's what the user perceives to be stored.
172 : : *
173 : : * Note: if you change anything here, check whether
174 : : * ExecBuildSlotPartitionKeyDescription() in execMain.c needs a similar
175 : : * change.
176 : : */
177 : : char *
6146 178 : 712 : BuildIndexValueDescription(Relation indexRelation,
179 : : const Datum *values, const bool *isnull)
180 : : {
181 : : StringInfoData buf;
182 : : Form_pg_index idxrec;
183 : : int indnkeyatts;
184 : : int i;
185 : : int keyno;
4156 sfrost@snowman.net 186 : 712 : Oid indexrelid = RelationGetRelid(indexRelation);
187 : : Oid indrelid;
188 : : AclResult aclresult;
189 : :
2975 teodor@sigaev.ru 190 : 712 : indnkeyatts = IndexRelationGetNumberOfKeyAttributes(indexRelation);
191 : :
192 : : /*
193 : : * Check permissions- if the user does not have access to view all of the
194 : : * key columns then return NULL to avoid leaking data.
195 : : *
196 : : * First check if RLS is enabled for the relation. If so, return NULL to
197 : : * avoid leaking data.
198 : : *
199 : : * Next we need to check table-level SELECT access and then, if there is
200 : : * no access there, check column-level permissions.
201 : : */
2875 alvherre@alvh.no-ip. 202 : 712 : idxrec = indexRelation->rd_index;
4156 sfrost@snowman.net 203 : 712 : indrelid = idxrec->indrelid;
204 [ - + ]: 712 : Assert(indexrelid == idxrec->indexrelid);
205 : :
206 : : /* RLS check- if RLS is enabled then we don't return anything. */
3959 mail@joeconway.com 207 [ + + ]: 712 : if (check_enable_rls(indrelid, InvalidOid, true) == RLS_ENABLED)
4156 sfrost@snowman.net 208 : 8 : return NULL;
209 : :
210 : : /* Table-level SELECT is enough, if the user has it */
211 : 704 : aclresult = pg_class_aclcheck(indrelid, GetUserId(), ACL_SELECT);
212 [ + + ]: 704 : if (aclresult != ACLCHECK_OK)
213 : : {
214 : : /*
215 : : * No table-level access, so step through the columns in the index and
216 : : * make sure the user has SELECT rights on all of them.
217 : : */
2875 alvherre@alvh.no-ip. 218 [ + - ]: 16 : for (keyno = 0; keyno < indnkeyatts; keyno++)
219 : : {
4156 sfrost@snowman.net 220 : 16 : AttrNumber attnum = idxrec->indkey.values[keyno];
221 : :
222 : : /*
223 : : * Note that if attnum == InvalidAttrNumber, then this is an index
224 : : * based on an expression and we return no detail rather than try
225 : : * to figure out what column(s) the expression includes and if the
226 : : * user has SELECT rights on them.
227 : : */
4139 228 [ + - + + ]: 32 : if (attnum == InvalidAttrNumber ||
229 : 16 : pg_attribute_aclcheck(indrelid, attnum, GetUserId(),
230 : : ACL_SELECT) != ACLCHECK_OK)
231 : : {
232 : : /* No access, so clean up and return */
4156 233 : 8 : return NULL;
234 : : }
235 : : }
236 : : }
237 : :
6146 tgl@sss.pgh.pa.us 238 : 696 : initStringInfo(&buf);
239 : 696 : appendStringInfo(&buf, "(%s)=(",
240 : : pg_get_indexdef_columns(indexrelid, true));
241 : :
2975 teodor@sigaev.ru 242 [ + + ]: 1651 : for (i = 0; i < indnkeyatts; i++)
243 : : {
244 : : char *val;
245 : :
6146 tgl@sss.pgh.pa.us 246 [ + + ]: 955 : if (isnull[i])
247 : 12 : val = "null";
248 : : else
249 : : {
250 : : Oid foutoid;
251 : : bool typisvarlena;
252 : :
253 : : /*
254 : : * The provided data is not necessarily of the type stored in the
255 : : * index; rather it is of the index opclass's input type. So look
256 : : * at rd_opcintype not the index tupdesc.
257 : : *
258 : : * Note: this is a bit shaky for opclasses that have pseudotype
259 : : * input types such as ANYARRAY or RECORD. Currently, the
260 : : * typoutput functions associated with the pseudotypes will work
261 : : * okay, but we might have to try harder in future.
262 : : */
6018 263 : 943 : getTypeOutputInfo(indexRelation->rd_opcintype[i],
264 : : &foutoid, &typisvarlena);
6146 265 : 943 : val = OidOutputFunctionCall(foutoid, values[i]);
266 : : }
267 : :
268 [ + + ]: 955 : if (i > 0)
269 : 259 : appendStringInfoString(&buf, ", ");
270 : 955 : appendStringInfoString(&buf, val);
271 : : }
272 : :
273 : 696 : appendStringInfoChar(&buf, ')');
274 : :
275 : 696 : return buf.data;
276 : : }
277 : :
278 : : /*
279 : : * Get the snapshotConflictHorizon from the table entries pointed to by the
280 : : * index tuples being deleted using an AM-generic approach.
281 : : *
282 : : * This is a table_index_delete_tuples() shim used by index AMs that only need
283 : : * to consult the tableam to get a snapshotConflictHorizon value, and only
284 : : * expect to delete index tuples that are already known deletable (typically
285 : : * due to having LP_DEAD bits set). When a snapshotConflictHorizon value
286 : : * isn't needed in index AM's deletion WAL record, it is safe for it to skip
287 : : * calling here entirely.
288 : : *
289 : : * We assume that caller index AM uses the standard IndexTuple representation,
290 : : * with table TIDs stored in the t_tid field. We also expect (and assert)
291 : : * that the line pointers on page for 'itemnos' offsets are already marked
292 : : * LP_DEAD.
293 : : */
294 : : TransactionId
2622 andres@anarazel.de 295 :GBC 4 : index_compute_xid_horizon_for_tuples(Relation irel,
296 : : Relation hrel,
297 : : Buffer ibuf,
298 : : OffsetNumber *itemnos,
299 : : int nitems)
300 : : {
301 : : TM_IndexDeleteOp delstate;
1290 pg@bowt.ie 302 : 4 : TransactionId snapshotConflictHorizon = InvalidTransactionId;
2622 andres@anarazel.de 303 : 4 : Page ipage = BufferGetPage(ibuf);
304 : : IndexTuple itup;
305 : :
1950 pg@bowt.ie 306 [ - + ]: 4 : Assert(nitems > 0);
307 : :
1668 308 : 4 : delstate.irel = irel;
309 : 4 : delstate.iblknum = BufferGetBlockNumber(ibuf);
1963 310 : 4 : delstate.bottomup = false;
311 : 4 : delstate.bottomupfreespace = 0;
312 : 4 : delstate.ndeltids = 0;
171 michael@paquier.xyz 313 :GNC 4 : delstate.deltids = palloc_array(TM_IndexDelete, nitems);
314 : 4 : delstate.status = palloc_array(TM_IndexStatus, nitems);
315 : :
316 : : /* identify what the index tuples about to be deleted point to */
2622 andres@anarazel.de 317 [ + + ]:GBC 888 : for (int i = 0; i < nitems; i++)
318 : : {
1668 pg@bowt.ie 319 : 884 : OffsetNumber offnum = itemnos[i];
320 : : ItemId iitemid;
321 : :
322 : 884 : iitemid = PageGetItemId(ipage, offnum);
2622 andres@anarazel.de 323 : 884 : itup = (IndexTuple) PageGetItem(ipage, iitemid);
324 : :
1963 pg@bowt.ie 325 [ - + ]: 884 : Assert(ItemIdIsDead(iitemid));
326 : :
327 : 884 : ItemPointerCopy(&itup->t_tid, &delstate.deltids[i].tid);
328 : 884 : delstate.deltids[i].id = delstate.ndeltids;
1668 329 : 884 : delstate.status[i].idxoffnum = offnum;
1963 330 : 884 : delstate.status[i].knowndeletable = true; /* LP_DEAD-marked */
331 : 884 : delstate.status[i].promising = false; /* unused */
332 : 884 : delstate.status[i].freespace = 0; /* unused */
333 : :
334 : 884 : delstate.ndeltids++;
335 : : }
336 : :
337 : : /* determine the actual xid horizon */
1290 338 : 4 : snapshotConflictHorizon = table_index_delete_tuples(hrel, &delstate);
339 : :
340 : : /* assert tableam agrees that all items are deletable */
1963 341 [ - + ]: 4 : Assert(delstate.ndeltids == nitems);
342 : :
343 : 4 : pfree(delstate.deltids);
344 : 4 : pfree(delstate.status);
345 : :
1290 346 : 4 : return snapshotConflictHorizon;
347 : : }
348 : :
349 : :
350 : : /* ----------------------------------------------------------------
351 : : * heap-or-index-scan access to system catalogs
352 : : *
353 : : * These functions support system catalog accesses that normally use
354 : : * an index but need to be capable of being switched to heap scans
355 : : * if the system indexes are unavailable.
356 : : *
357 : : * The specified scan keys must be compatible with the named index.
358 : : * Generally this means that they must constrain either all columns
359 : : * of the index, or the first K columns of an N-column index.
360 : : *
361 : : * These routines could work with non-system tables, actually,
362 : : * but they're only useful when there is a known index to use with
363 : : * the given scan keys; so in practice they're only good for
364 : : * predetermined types of scans of system catalogs.
365 : : * ----------------------------------------------------------------
366 : : */
367 : :
368 : : /*
369 : : * systable_beginscan --- set up for heap-or-index scan
370 : : *
371 : : * rel: catalog to scan, already opened and suitably locked
372 : : * indexId: OID of index to conditionally use
373 : : * indexOK: if false, forces a heap scan (see notes below)
374 : : * snapshot: time qual to use (NULL for a recent catalog snapshot)
375 : : * nkeys, key: scan keys
376 : : *
377 : : * The attribute numbers in the scan key should be set for the heap case.
378 : : * If we choose to index, we convert them to 1..n to reference the index
379 : : * columns. Note this means there must be one scankey qualification per
380 : : * index column! This is checked by the Asserts in the normal, index-using
381 : : * case, but won't be checked if the heapscan path is taken.
382 : : *
383 : : * The routine checks the normal cases for whether an indexscan is safe,
384 : : * but caller can make additional checks and pass indexOK=false if needed.
385 : : * In standard case indexOK can simply be constant TRUE.
386 : : */
387 : : SysScanDesc
8776 tgl@sss.pgh.pa.us 388 :CBC 9239053 : systable_beginscan(Relation heapRelation,
389 : : Oid indexId,
390 : : bool indexOK,
391 : : Snapshot snapshot,
392 : : int nkeys, ScanKey key)
393 : : {
394 : : SysScanDesc sysscan;
395 : : Relation irel;
396 : :
7716 397 [ + + ]: 9239053 : if (indexOK &&
7450 peter_e@gmx.net 398 [ + + ]: 9093689 : !IgnoreSystemIndexes &&
7716 tgl@sss.pgh.pa.us 399 [ + + ]: 9018376 : !ReindexIsProcessingIndex(indexId))
7243 400 : 9009684 : irel = index_open(indexId, AccessShareLock);
401 : : else
8284 402 : 229369 : irel = NULL;
403 : :
171 michael@paquier.xyz 404 :GNC 9239047 : sysscan = palloc_object(SysScanDescData);
405 : :
8776 tgl@sss.pgh.pa.us 406 :CBC 9239047 : sysscan->heap_rel = heapRelation;
8284 407 : 9239047 : sysscan->irel = irel;
2637 andres@anarazel.de 408 : 9239047 : sysscan->slot = table_slot_create(heapRelation, NULL);
409 : :
4715 rhaas@postgresql.org 410 [ + + ]: 9239047 : if (snapshot == NULL)
411 : : {
4407 bruce@momjian.us 412 : 8503031 : Oid relid = RelationGetRelid(heapRelation);
413 : :
4715 rhaas@postgresql.org 414 : 8503031 : snapshot = RegisterSnapshot(GetCatalogSnapshot(relid));
415 : 8503031 : sysscan->snapshot = snapshot;
416 : : }
417 : : else
418 : : {
419 : : /* Caller is responsible for any snapshot. */
420 : 736016 : sysscan->snapshot = NULL;
421 : : }
422 : :
423 : : /*
424 : : * If CheckXidAlive is set then set a flag to indicate that system table
425 : : * scan is in-progress. See detailed comments in xact.c where these
426 : : * variables are declared.
427 : : */
121 andres@anarazel.de 428 [ + + ]:GNC 9239047 : if (TransactionIdIsValid(CheckXidAlive))
429 : 1044 : bsysscan = true;
430 : :
8284 tgl@sss.pgh.pa.us 431 [ + + ]:CBC 9239047 : if (irel)
432 : : {
433 : : int i;
434 : : ScanKey idxkey;
435 : :
660 peter@eisentraut.org 436 : 9009678 : idxkey = palloc_array(ScanKeyData, nkeys);
437 : :
438 : : /* Convert attribute numbers to be index column numbers. */
8866 tgl@sss.pgh.pa.us 439 [ + + ]: 23944589 : for (i = 0; i < nkeys; i++)
440 : : {
441 : : int j;
442 : :
660 peter@eisentraut.org 443 : 14934911 : memcpy(&idxkey[i], &key[i], sizeof(ScanKeyData));
444 : :
2975 teodor@sigaev.ru 445 [ + - ]: 21977575 : for (j = 0; j < IndexRelationGetNumberOfAttributes(irel); j++)
446 : : {
6414 heikki.linnakangas@i 447 [ + + ]: 21977575 : if (key[i].sk_attno == irel->rd_index->indkey.values[j])
448 : : {
660 peter@eisentraut.org 449 : 14934911 : idxkey[i].sk_attno = j + 1;
6414 heikki.linnakangas@i 450 : 14934911 : break;
451 : : }
452 : : }
2975 teodor@sigaev.ru 453 [ - + ]: 14934911 : if (j == IndexRelationGetNumberOfAttributes(irel))
6414 heikki.linnakangas@i 454 [ # # ]:UBC 0 : elog(ERROR, "column is not in index");
455 : : }
456 : :
7243 tgl@sss.pgh.pa.us 457 :CBC 9009678 : sysscan->iscan = index_beginscan(heapRelation, irel,
458 : : snapshot, NULL, nkeys, 0,
459 : : SO_NONE);
660 peter@eisentraut.org 460 : 9009678 : index_rescan(sysscan->iscan, idxkey, nkeys, NULL, 0);
8866 tgl@sss.pgh.pa.us 461 : 9009678 : sysscan->scan = NULL;
462 : :
543 peter@eisentraut.org 463 : 9009678 : pfree(idxkey);
464 : : }
465 : : else
466 : : {
467 : : /*
468 : : * We disallow synchronized scans when forced to use a heapscan on a
469 : : * catalog. In most cases the desired rows are near the front, so
470 : : * that the unpredictable start point of a syncscan is a serious
471 : : * disadvantage; and there are no compensating advantages, because
472 : : * it's unlikely that such scans will occur in parallel.
473 : : */
2637 andres@anarazel.de 474 : 229369 : sysscan->scan = table_beginscan_strat(heapRelation, snapshot,
475 : : nkeys, key,
476 : : true, false);
8866 tgl@sss.pgh.pa.us 477 : 229369 : sysscan->iscan = NULL;
478 : : }
479 : :
480 : 9239047 : return sysscan;
481 : : }
482 : :
483 : : /*
484 : : * HandleConcurrentAbort - Handle concurrent abort of the CheckXidAlive.
485 : : *
486 : : * Error out, if CheckXidAlive is aborted. We can't directly use
487 : : * TransactionIdDidAbort as after crash such transaction might not have been
488 : : * marked as aborted. See detailed comments in xact.c where the variable
489 : : * is declared.
490 : : */
491 : : static inline void
178 nathan@postgresql.or 492 :GNC 18937798 : HandleConcurrentAbort(void)
493 : : {
2121 akapila@postgresql.o 494 [ + + ]:CBC 18937798 : if (TransactionIdIsValid(CheckXidAlive) &&
495 [ + + ]: 1697 : !TransactionIdIsInProgress(CheckXidAlive) &&
496 [ + - ]: 8 : !TransactionIdDidCommit(CheckXidAlive))
497 [ + - ]: 8 : ereport(ERROR,
498 : : (errcode(ERRCODE_TRANSACTION_ROLLBACK),
499 : : errmsg("transaction aborted during system catalog scan")));
500 : 18937790 : }
501 : :
502 : : /*
503 : : * systable_getnext --- get next tuple in a heap-or-index scan
504 : : *
505 : : * Returns NULL if no more tuples available.
506 : : *
507 : : * Note that returned tuple is a reference to data in a disk buffer;
508 : : * it must not be modified, and should be presumed inaccessible after
509 : : * next getnext() or endscan() call.
510 : : *
511 : : * XXX: It'd probably make sense to offer a slot based interface, at least
512 : : * optionally.
513 : : */
514 : : HeapTuple
8866 tgl@sss.pgh.pa.us 515 : 18631093 : systable_getnext(SysScanDesc sysscan)
516 : : {
2637 andres@anarazel.de 517 : 18631093 : HeapTuple htup = NULL;
518 : :
8866 tgl@sss.pgh.pa.us 519 [ + + ]: 18631093 : if (sysscan->irel)
520 : : {
2637 andres@anarazel.de 521 [ + + ]: 16951602 : if (index_getnext_slot(sysscan->iscan, ForwardScanDirection, sysscan->slot))
522 : : {
523 : : bool shouldFree;
524 : :
525 : 12876571 : htup = ExecFetchSlotHeapTuple(sysscan->slot, false, &shouldFree);
526 [ - + ]: 12876571 : Assert(!shouldFree);
527 : :
528 : : /*
529 : : * We currently don't need to support lossy index operators for
530 : : * any system catalog scan. It could be done here, using the scan
531 : : * keys to drive the operator calls, if we arranged to save the
532 : : * heap attnums during systable_beginscan(); this is practical
533 : : * because we still wouldn't need to support indexes on
534 : : * expressions.
535 : : */
536 [ - + ]: 12876571 : if (sysscan->iscan->xs_recheck)
2637 andres@anarazel.de 537 [ # # ]:UBC 0 : elog(ERROR, "system catalog scans with lossy index conditions are not implemented");
538 : : }
539 : : }
540 : : else
541 : : {
2637 andres@anarazel.de 542 [ + + ]:CBC 1679491 : if (table_scan_getnextslot(sysscan->scan, ForwardScanDirection, sysscan->slot))
543 : : {
544 : : bool shouldFree;
545 : :
546 : 1624647 : htup = ExecFetchSlotHeapTuple(sysscan->slot, false, &shouldFree);
547 [ - + ]: 1624647 : Assert(!shouldFree);
548 : : }
549 : : }
550 : :
551 : : /*
552 : : * Handle the concurrent abort while fetching the catalog tuple during
553 : : * logical streaming of a transaction.
554 : : */
2121 akapila@postgresql.o 555 : 18631086 : HandleConcurrentAbort();
556 : :
8866 tgl@sss.pgh.pa.us 557 : 18631078 : return htup;
558 : : }
559 : :
560 : : /*
561 : : * systable_recheck_tuple --- recheck visibility of most-recently-fetched tuple
562 : : *
563 : : * In particular, determine if this tuple would be visible to a catalog scan
564 : : * that started now. We don't handle the case of a non-MVCC scan snapshot,
565 : : * because no caller needs that yet.
566 : : *
567 : : * This is useful to test whether an object was deleted while we waited to
568 : : * acquire lock on it.
569 : : *
570 : : * Note: we don't actually *need* the tuple to be passed in, but it's a
571 : : * good crosscheck that the caller is interested in the right tuple.
572 : : */
573 : : bool
6565 574 : 163770 : systable_recheck_tuple(SysScanDesc sysscan, HeapTuple tup)
575 : : {
576 : : Snapshot freshsnap;
577 : : bool result;
578 : :
2637 andres@anarazel.de 579 [ - + ]: 163770 : Assert(tup == ExecFetchSlotHeapTuple(sysscan->slot, false, NULL));
580 : :
4701 noah@leadboat.com 581 : 163770 : freshsnap = GetCatalogSnapshot(RelationGetRelid(sysscan->heap_rel));
445 heikki.linnakangas@i 582 : 163770 : freshsnap = RegisterSnapshot(freshsnap);
583 : :
2637 andres@anarazel.de 584 : 163770 : result = table_tuple_satisfies_snapshot(sysscan->heap_rel,
585 : 163770 : sysscan->slot,
586 : : freshsnap);
445 heikki.linnakangas@i 587 : 163770 : UnregisterSnapshot(freshsnap);
588 : :
589 : : /*
590 : : * Handle the concurrent abort while fetching the catalog tuple during
591 : : * logical streaming of a transaction.
592 : : */
2121 akapila@postgresql.o 593 : 163770 : HandleConcurrentAbort();
594 : :
6565 tgl@sss.pgh.pa.us 595 : 163770 : return result;
596 : : }
597 : :
598 : : /*
599 : : * systable_endscan --- close scan, release resources
600 : : *
601 : : * Note that it's still up to the caller to close the heap relation.
602 : : */
603 : : void
8866 604 : 9238483 : systable_endscan(SysScanDesc sysscan)
605 : : {
2637 andres@anarazel.de 606 [ + - ]: 9238483 : if (sysscan->slot)
607 : : {
608 : 9238483 : ExecDropSingleTupleTableSlot(sysscan->slot);
609 : 9238483 : sysscan->slot = NULL;
610 : : }
611 : :
8866 tgl@sss.pgh.pa.us 612 [ + + ]: 9238483 : if (sysscan->irel)
613 : : {
614 : 9009128 : index_endscan(sysscan->iscan);
7243 615 : 9009128 : index_close(sysscan->irel, AccessShareLock);
616 : : }
617 : : else
2637 andres@anarazel.de 618 : 229355 : table_endscan(sysscan->scan);
619 : :
4715 rhaas@postgresql.org 620 [ + + ]: 9238483 : if (sysscan->snapshot)
621 : 8502475 : UnregisterSnapshot(sysscan->snapshot);
622 : :
623 : : /*
624 : : * Reset the bsysscan flag at the end of the systable scan. See detailed
625 : : * comments in xact.c where these variables are declared.
626 : : */
2121 akapila@postgresql.o 627 [ + + ]: 9238483 : if (TransactionIdIsValid(CheckXidAlive))
628 : 1036 : bsysscan = false;
629 : :
8866 tgl@sss.pgh.pa.us 630 : 9238483 : pfree(sysscan);
631 : 9238483 : }
632 : :
633 : :
634 : : /*
635 : : * systable_beginscan_ordered --- set up for ordered catalog scan
636 : : *
637 : : * These routines have essentially the same API as systable_beginscan etc,
638 : : * except that they guarantee to return multiple matching tuples in
639 : : * index order. Also, for largely historical reasons, the index to use
640 : : * is opened and locked by the caller, not here.
641 : : *
642 : : * Currently we do not support non-index-based scans here. (In principle
643 : : * we could do a heapscan and sort, but the uses are in places that
644 : : * probably don't need to still work with corrupted catalog indexes.)
645 : : * For the moment, therefore, these functions are merely the thinest of
646 : : * wrappers around index_beginscan/index_getnext_slot. The main reason for
647 : : * their existence is to centralize possible future support of lossy operators
648 : : * in catalog scans.
649 : : */
650 : : SysScanDesc
6622 651 : 38377 : systable_beginscan_ordered(Relation heapRelation,
652 : : Relation indexRelation,
653 : : Snapshot snapshot,
654 : : int nkeys, ScanKey key)
655 : : {
656 : : SysScanDesc sysscan;
657 : : int i;
658 : : ScanKey idxkey;
659 : :
660 : : /* REINDEX can probably be a hard error here ... */
661 [ - + ]: 38377 : if (ReindexIsProcessingIndex(RelationGetRelid(indexRelation)))
825 tgl@sss.pgh.pa.us 662 [ # # ]:UBC 0 : ereport(ERROR,
663 : : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
664 : : errmsg("cannot access index \"%s\" while it is being reindexed",
665 : : RelationGetRelationName(indexRelation))));
666 : : /* ... but we only throw a warning about violating IgnoreSystemIndexes */
6622 tgl@sss.pgh.pa.us 667 [ - + ]:CBC 38377 : if (IgnoreSystemIndexes)
6622 tgl@sss.pgh.pa.us 668 [ # # ]:UBC 0 : elog(WARNING, "using index \"%s\" despite IgnoreSystemIndexes",
669 : : RelationGetRelationName(indexRelation));
670 : :
171 michael@paquier.xyz 671 :GNC 38377 : sysscan = palloc_object(SysScanDescData);
672 : :
6622 tgl@sss.pgh.pa.us 673 :CBC 38377 : sysscan->heap_rel = heapRelation;
674 : 38377 : sysscan->irel = indexRelation;
2637 andres@anarazel.de 675 : 38377 : sysscan->slot = table_slot_create(heapRelation, NULL);
676 : :
4715 rhaas@postgresql.org 677 [ + + ]: 38377 : if (snapshot == NULL)
678 : : {
4407 bruce@momjian.us 679 : 5286 : Oid relid = RelationGetRelid(heapRelation);
680 : :
4715 rhaas@postgresql.org 681 : 5286 : snapshot = RegisterSnapshot(GetCatalogSnapshot(relid));
682 : 5286 : sysscan->snapshot = snapshot;
683 : : }
684 : : else
685 : : {
686 : : /* Caller is responsible for any snapshot. */
687 : 33091 : sysscan->snapshot = NULL;
688 : : }
689 : :
660 peter@eisentraut.org 690 : 38377 : idxkey = palloc_array(ScanKeyData, nkeys);
691 : :
692 : : /* Convert attribute numbers to be index column numbers. */
6622 tgl@sss.pgh.pa.us 693 [ + + ]: 74785 : for (i = 0; i < nkeys; i++)
694 : : {
695 : : int j;
696 : :
660 peter@eisentraut.org 697 : 36408 : memcpy(&idxkey[i], &key[i], sizeof(ScanKeyData));
698 : :
2975 teodor@sigaev.ru 699 [ + - ]: 38455 : for (j = 0; j < IndexRelationGetNumberOfAttributes(indexRelation); j++)
700 : : {
6414 heikki.linnakangas@i 701 [ + + ]: 38455 : if (key[i].sk_attno == indexRelation->rd_index->indkey.values[j])
702 : : {
660 peter@eisentraut.org 703 : 36408 : idxkey[i].sk_attno = j + 1;
6414 heikki.linnakangas@i 704 : 36408 : break;
705 : : }
706 : : }
2975 teodor@sigaev.ru 707 [ - + ]: 36408 : if (j == IndexRelationGetNumberOfAttributes(indexRelation))
6414 heikki.linnakangas@i 708 [ # # ]:UBC 0 : elog(ERROR, "column is not in index");
709 : : }
710 : :
711 : : /*
712 : : * If CheckXidAlive is set then set a flag to indicate that system table
713 : : * scan is in-progress. See detailed comments in xact.c where these
714 : : * variables are declared.
715 : : */
600 akapila@postgresql.o 716 [ - + ]:CBC 38377 : if (TransactionIdIsValid(CheckXidAlive))
600 akapila@postgresql.o 717 :LBC (1) : bsysscan = true;
718 : :
121 andres@anarazel.de 719 :GNC 38377 : sysscan->iscan = index_beginscan(heapRelation, indexRelation,
720 : : snapshot, NULL, nkeys, 0,
721 : : SO_NONE);
722 : 38377 : index_rescan(sysscan->iscan, idxkey, nkeys, NULL, 0);
723 : 38377 : sysscan->scan = NULL;
724 : :
725 : 38377 : pfree(idxkey);
726 : :
6622 tgl@sss.pgh.pa.us 727 :CBC 38377 : return sysscan;
728 : : }
729 : :
730 : : /*
731 : : * systable_getnext_ordered --- get next tuple in an ordered catalog scan
732 : : */
733 : : HeapTuple
734 : 142945 : systable_getnext_ordered(SysScanDesc sysscan, ScanDirection direction)
735 : : {
2637 andres@anarazel.de 736 : 142945 : HeapTuple htup = NULL;
737 : :
6622 tgl@sss.pgh.pa.us 738 [ - + ]: 142945 : Assert(sysscan->irel);
2637 andres@anarazel.de 739 [ + + ]: 142945 : if (index_getnext_slot(sysscan->iscan, direction, sysscan->slot))
740 : 105420 : htup = ExecFetchSlotHeapTuple(sysscan->slot, false, NULL);
741 : :
742 : : /* See notes in systable_getnext */
6621 tgl@sss.pgh.pa.us 743 [ + + - + ]: 142942 : if (htup && sysscan->iscan->xs_recheck)
6621 tgl@sss.pgh.pa.us 744 [ # # ]:UBC 0 : elog(ERROR, "system catalog scans with lossy index conditions are not implemented");
745 : :
746 : : /*
747 : : * Handle the concurrent abort while fetching the catalog tuple during
748 : : * logical streaming of a transaction.
749 : : */
2121 akapila@postgresql.o 750 :CBC 142942 : HandleConcurrentAbort();
751 : :
6622 tgl@sss.pgh.pa.us 752 : 142942 : return htup;
753 : : }
754 : :
755 : : /*
756 : : * systable_endscan_ordered --- close scan, release resources
757 : : */
758 : : void
759 : 38366 : systable_endscan_ordered(SysScanDesc sysscan)
760 : : {
2637 andres@anarazel.de 761 [ + - ]: 38366 : if (sysscan->slot)
762 : : {
763 : 38366 : ExecDropSingleTupleTableSlot(sysscan->slot);
764 : 38366 : sysscan->slot = NULL;
765 : : }
766 : :
6622 tgl@sss.pgh.pa.us 767 [ - + ]: 38366 : Assert(sysscan->irel);
768 : 38366 : index_endscan(sysscan->iscan);
4715 rhaas@postgresql.org 769 [ + + ]: 38366 : if (sysscan->snapshot)
770 : 5278 : UnregisterSnapshot(sysscan->snapshot);
771 : :
772 : : /*
773 : : * Reset the bsysscan flag at the end of the systable scan. See detailed
774 : : * comments in xact.c where these variables are declared.
775 : : */
600 akapila@postgresql.o 776 [ - + ]: 38366 : if (TransactionIdIsValid(CheckXidAlive))
600 akapila@postgresql.o 777 :LBC (1) : bsysscan = false;
778 : :
6622 tgl@sss.pgh.pa.us 779 :CBC 38366 : pfree(sysscan);
780 : 38366 : }
781 : :
782 : : /*
783 : : * systable_inplace_update_begin --- update a row "in place" (overwrite it)
784 : : *
785 : : * Overwriting violates both MVCC and transactional safety, so the uses of
786 : : * this function in Postgres are extremely limited. This makes no effort to
787 : : * support updating cache key columns or other indexed columns. Nonetheless
788 : : * we find some places to use it. See README.tuplock section "Locking to
789 : : * write inplace-updated tables" and later sections for expectations of
790 : : * readers and writers of a table that gets inplace updates. Standard flow:
791 : : *
792 : : * ... [any slow preparation not requiring oldtup] ...
793 : : * systable_inplace_update_begin([...], &tup, &inplace_state);
794 : : * if (!HeapTupleIsValid(tup))
795 : : * elog(ERROR, [...]);
796 : : * ... [buffer is exclusive-locked; mutate "tup"] ...
797 : : * if (dirty)
798 : : * systable_inplace_update_finish(inplace_state, tup);
799 : : * else
800 : : * systable_inplace_update_cancel(inplace_state);
801 : : *
802 : : * The first several params duplicate the systable_beginscan() param list.
803 : : * "oldtupcopy" is an output parameter, assigned NULL if the key ceases to
804 : : * find a live tuple. (In PROC_IN_VACUUM, that is a low-probability transient
805 : : * condition.) If "oldtupcopy" gets non-NULL, you must pass output parameter
806 : : * "state" to systable_inplace_update_finish() or
807 : : * systable_inplace_update_cancel().
808 : : */
809 : : void
613 noah@leadboat.com 810 : 117264 : systable_inplace_update_begin(Relation relation,
811 : : Oid indexId,
812 : : bool indexOK,
813 : : Snapshot snapshot,
814 : : int nkeys, const ScanKeyData *key,
815 : : HeapTuple *oldtupcopy,
816 : : void **state)
817 : : {
818 : 117264 : int retries = 0;
819 : : SysScanDesc scan;
820 : : HeapTuple oldtup;
821 : : BufferHeapTupleTableSlot *bslot;
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 [ - + ]: 117264 : if (IsInParallelMode())
613 noah@leadboat.com 830 [ # # ]:UBC 0 : ereport(ERROR,
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 : : */
613 noah@leadboat.com 838 [ - + ]:CBC 117264 : Assert(snapshot == NULL);
839 : :
840 [ - + - - ]: 117264 : 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 : :
847 [ + + ]: 117325 : CHECK_FOR_INTERRUPTS();
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 [ - + ]: 117325 : if (retries++ > 10000)
613 noah@leadboat.com 855 [ # # ]:UBC 0 : elog(ERROR, "giving up after too many tries to overwrite row");
856 : :
385 michael@paquier.xyz 857 :CBC 117325 : INJECTION_POINT("inplace-before-pin", NULL);
613 noah@leadboat.com 858 : 117325 : scan = systable_beginscan(relation, indexId, indexOK, snapshot,
613 noah@leadboat.com 859 :ECB (91490) : nkeys, unconstify(ScanKeyData *, key));
613 noah@leadboat.com 860 :CBC 117325 : oldtup = systable_getnext(scan);
861 [ - + ]: 117325 : if (!HeapTupleIsValid(oldtup))
862 : : {
613 noah@leadboat.com 863 :UBC 0 : systable_endscan(scan);
864 : 0 : *oldtupcopy = NULL;
865 : 0 : return;
866 : : }
867 : :
613 noah@leadboat.com 868 :CBC 117325 : slot = scan->slot;
869 [ - + ]: 117325 : Assert(TTS_IS_BUFFERTUPLE(slot));
870 : 117325 : bslot = (BufferHeapTupleTableSlot *) slot;
578 871 [ + + ]: 117325 : } while (!heap_inplace_lock(scan->heap_rel,
872 : : bslot->base.tuple, bslot->buffer,
873 : : (void (*) (void *)) systable_endscan, scan));
874 : :
613 875 : 117264 : *oldtupcopy = heap_copytuple(oldtup);
876 : 117264 : *state = scan;
877 : : }
878 : :
879 : : /*
880 : : * systable_inplace_update_finish --- second phase of inplace update
881 : : *
882 : : * The tuple cannot change size, and therefore its header fields and null
883 : : * bitmap (if any) don't change either.
884 : : */
885 : : void
886 : 81471 : systable_inplace_update_finish(void *state, HeapTuple tuple)
887 : : {
888 : 81471 : SysScanDesc scan = (SysScanDesc) state;
889 : 81471 : Relation relation = scan->heap_rel;
890 : 81471 : TupleTableSlot *slot = scan->slot;
891 : 81471 : BufferHeapTupleTableSlot *bslot = (BufferHeapTupleTableSlot *) slot;
892 : 81471 : HeapTuple oldtup = bslot->base.tuple;
893 : 81471 : Buffer buffer = bslot->buffer;
894 : :
895 : 81471 : heap_inplace_update_and_unlock(relation, oldtup, tuple, buffer);
896 : 81471 : systable_endscan(scan);
897 : 81471 : }
898 : :
899 : : /*
900 : : * systable_inplace_update_cancel --- abandon inplace update
901 : : *
902 : : * This is an alternative to making a no-op update.
903 : : */
904 : : void
905 : 35793 : systable_inplace_update_cancel(void *state)
906 : : {
907 : 35793 : SysScanDesc scan = (SysScanDesc) state;
908 : 35793 : Relation relation = scan->heap_rel;
909 : 35793 : TupleTableSlot *slot = scan->slot;
910 : 35793 : BufferHeapTupleTableSlot *bslot = (BufferHeapTupleTableSlot *) slot;
911 : 35793 : HeapTuple oldtup = bslot->base.tuple;
912 : 35793 : Buffer buffer = bslot->buffer;
913 : :
914 : 35793 : heap_inplace_unlock(relation, oldtup, buffer);
915 : 35793 : systable_endscan(scan);
916 : 35793 : }
|
