PostgreSQL Source Code git master
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
tableam.c File Reference
#include "postgres.h"
#include <math.h>
#include "access/syncscan.h"
#include "access/tableam.h"
#include "access/xact.h"
#include "optimizer/optimizer.h"
#include "optimizer/plancat.h"
#include "port/pg_bitutils.h"
#include "storage/bufmgr.h"
#include "storage/shmem.h"
#include "storage/smgr.h"
Include dependency graph for tableam.c:

Go to the source code of this file.

Macros

#define PARALLEL_SEQSCAN_NCHUNKS   2048
 
#define PARALLEL_SEQSCAN_RAMPDOWN_CHUNKS   64
 
#define PARALLEL_SEQSCAN_MAX_CHUNK_SIZE   8192
 

Functions

const TupleTableSlotOpstable_slot_callbacks (Relation relation)
 
TupleTableSlottable_slot_create (Relation relation, List **reglist)
 
TableScanDesc table_beginscan_catalog (Relation relation, int nkeys, struct ScanKeyData *key)
 
Size table_parallelscan_estimate (Relation rel, Snapshot snapshot)
 
void table_parallelscan_initialize (Relation rel, ParallelTableScanDesc pscan, Snapshot snapshot)
 
TableScanDesc table_beginscan_parallel (Relation relation, ParallelTableScanDesc pscan)
 
bool table_index_fetch_tuple_check (Relation rel, ItemPointer tid, Snapshot snapshot, bool *all_dead)
 
void table_tuple_get_latest_tid (TableScanDesc scan, ItemPointer tid)
 
void simple_table_tuple_insert (Relation rel, TupleTableSlot *slot)
 
void simple_table_tuple_delete (Relation rel, ItemPointer tid, Snapshot snapshot)
 
void simple_table_tuple_update (Relation rel, ItemPointer otid, TupleTableSlot *slot, Snapshot snapshot, TU_UpdateIndexes *update_indexes)
 
Size table_block_parallelscan_estimate (Relation rel)
 
Size table_block_parallelscan_initialize (Relation rel, ParallelTableScanDesc pscan)
 
void table_block_parallelscan_reinitialize (Relation rel, ParallelTableScanDesc pscan)
 
void table_block_parallelscan_startblock_init (Relation rel, ParallelBlockTableScanWorker pbscanwork, ParallelBlockTableScanDesc pbscan)
 
BlockNumber table_block_parallelscan_nextpage (Relation rel, ParallelBlockTableScanWorker pbscanwork, ParallelBlockTableScanDesc pbscan)
 
uint64 table_block_relation_size (Relation rel, ForkNumber forkNumber)
 
void table_block_relation_estimate_size (Relation rel, int32 *attr_widths, BlockNumber *pages, double *tuples, double *allvisfrac, Size overhead_bytes_per_tuple, Size usable_bytes_per_page)
 

Variables

char * default_table_access_method = DEFAULT_TABLE_ACCESS_METHOD
 
bool synchronize_seqscans = true
 

Macro Definition Documentation

◆ PARALLEL_SEQSCAN_MAX_CHUNK_SIZE

#define PARALLEL_SEQSCAN_MAX_CHUNK_SIZE   8192

Definition at line 46 of file tableam.c.

◆ PARALLEL_SEQSCAN_NCHUNKS

#define PARALLEL_SEQSCAN_NCHUNKS   2048

Definition at line 42 of file tableam.c.

◆ PARALLEL_SEQSCAN_RAMPDOWN_CHUNKS

#define PARALLEL_SEQSCAN_RAMPDOWN_CHUNKS   64

Definition at line 44 of file tableam.c.

Function Documentation

◆ simple_table_tuple_delete()

void simple_table_tuple_delete ( Relation  rel,
ItemPointer  tid,
Snapshot  snapshot 
)

Definition at line 291 of file tableam.c.

292{
293 TM_Result result;
294 TM_FailureData tmfd;
295
296 result = table_tuple_delete(rel, tid,
298 snapshot, InvalidSnapshot,
299 true /* wait for commit */ ,
300 &tmfd, false /* changingPart */ );
301
302 switch (result)
303 {
304 case TM_SelfModified:
305 /* Tuple was already updated in current command? */
306 elog(ERROR, "tuple already updated by self");
307 break;
308
309 case TM_Ok:
310 /* done successfully */
311 break;
312
313 case TM_Updated:
314 elog(ERROR, "tuple concurrently updated");
315 break;
316
317 case TM_Deleted:
318 elog(ERROR, "tuple concurrently deleted");
319 break;
320
321 default:
322 elog(ERROR, "unrecognized table_tuple_delete status: %u", result);
323 break;
324 }
325}
#define ERROR
Definition: elog.h:39
#define elog(elevel,...)
Definition: elog.h:226
#define InvalidSnapshot
Definition: snapshot.h:119
TM_Result
Definition: tableam.h:72
@ TM_Ok
Definition: tableam.h:77
@ TM_Deleted
Definition: tableam.h:92
@ TM_Updated
Definition: tableam.h:89
@ TM_SelfModified
Definition: tableam.h:83
static TM_Result table_tuple_delete(Relation rel, ItemPointer tid, CommandId cid, Snapshot snapshot, Snapshot crosscheck, bool wait, TM_FailureData *tmfd, bool changingPart)
Definition: tableam.h:1451
CommandId GetCurrentCommandId(bool used)
Definition: xact.c:829

References elog, ERROR, GetCurrentCommandId(), InvalidSnapshot, table_tuple_delete(), TM_Deleted, TM_Ok, TM_SelfModified, and TM_Updated.

Referenced by ExecSimpleRelationDelete().

◆ simple_table_tuple_insert()

void simple_table_tuple_insert ( Relation  rel,
TupleTableSlot slot 
)

Definition at line 277 of file tableam.c.

278{
279 table_tuple_insert(rel, slot, GetCurrentCommandId(true), 0, NULL);
280}
static void table_tuple_insert(Relation rel, TupleTableSlot *slot, CommandId cid, int options, struct BulkInsertStateData *bistate)
Definition: tableam.h:1362

References GetCurrentCommandId(), and table_tuple_insert().

Referenced by ExecSimpleRelationInsert().

◆ simple_table_tuple_update()

void simple_table_tuple_update ( Relation  rel,
ItemPointer  otid,
TupleTableSlot slot,
Snapshot  snapshot,
TU_UpdateIndexes update_indexes 
)

Definition at line 336 of file tableam.c.

340{
341 TM_Result result;
342 TM_FailureData tmfd;
343 LockTupleMode lockmode;
344
345 result = table_tuple_update(rel, otid, slot,
347 snapshot, InvalidSnapshot,
348 true /* wait for commit */ ,
349 &tmfd, &lockmode, update_indexes);
350
351 switch (result)
352 {
353 case TM_SelfModified:
354 /* Tuple was already updated in current command? */
355 elog(ERROR, "tuple already updated by self");
356 break;
357
358 case TM_Ok:
359 /* done successfully */
360 break;
361
362 case TM_Updated:
363 elog(ERROR, "tuple concurrently updated");
364 break;
365
366 case TM_Deleted:
367 elog(ERROR, "tuple concurrently deleted");
368 break;
369
370 default:
371 elog(ERROR, "unrecognized table_tuple_update status: %u", result);
372 break;
373 }
374}
LockTupleMode
Definition: lockoptions.h:50
static TM_Result table_tuple_update(Relation rel, ItemPointer otid, TupleTableSlot *slot, CommandId cid, Snapshot snapshot, Snapshot crosscheck, bool wait, TM_FailureData *tmfd, LockTupleMode *lockmode, TU_UpdateIndexes *update_indexes)
Definition: tableam.h:1495

References elog, ERROR, GetCurrentCommandId(), InvalidSnapshot, table_tuple_update(), TM_Deleted, TM_Ok, TM_SelfModified, and TM_Updated.

Referenced by ExecSimpleRelationUpdate().

◆ table_beginscan_catalog()

TableScanDesc table_beginscan_catalog ( Relation  relation,
int  nkeys,
struct ScanKeyData key 
)

Definition at line 113 of file tableam.c.

114{
115 uint32 flags = SO_TYPE_SEQSCAN |
117 Oid relid = RelationGetRelid(relation);
119
120 return relation->rd_tableam->scan_begin(relation, snapshot, nkeys, key,
121 NULL, flags);
122}
uint32_t uint32
Definition: c.h:502
unsigned int Oid
Definition: postgres_ext.h:30
#define RelationGetRelid(relation)
Definition: rel.h:516
Snapshot GetCatalogSnapshot(Oid relid)
Definition: snapmgr.c:373
Snapshot RegisterSnapshot(Snapshot snapshot)
Definition: snapmgr.c:811
const struct TableAmRoutine * rd_tableam
Definition: rel.h:189
TableScanDesc(* scan_begin)(Relation rel, Snapshot snapshot, int nkeys, struct ScanKeyData *key, ParallelTableScanDesc pscan, uint32 flags)
Definition: tableam.h:321
@ SO_ALLOW_STRAT
Definition: tableam.h:57
@ SO_TEMP_SNAPSHOT
Definition: tableam.h:64
@ SO_ALLOW_PAGEMODE
Definition: tableam.h:61
@ SO_ALLOW_SYNC
Definition: tableam.h:59
@ SO_TYPE_SEQSCAN
Definition: tableam.h:48

References GetCatalogSnapshot(), sort-test::key, RelationData::rd_tableam, RegisterSnapshot(), RelationGetRelid, TableAmRoutine::scan_begin, SO_ALLOW_PAGEMODE, SO_ALLOW_STRAT, SO_ALLOW_SYNC, SO_TEMP_SNAPSHOT, and SO_TYPE_SEQSCAN.

Referenced by AlterTableMoveAll(), AlterTableSpaceOptions(), check_db_file_conflict(), CreateDatabaseUsingFileCopy(), do_autovacuum(), DropSetting(), DropTableSpace(), find_typed_table_dependencies(), get_all_vacuum_rels(), get_database_list(), get_subscription_list(), get_tables_to_cluster(), get_tablespace_name(), get_tablespace_oid(), GetAllTablesPublicationRelations(), getRelationsInNamespace(), GetSchemaPublicationRelations(), objectsInSchemaToOids(), populate_typ_list(), ReindexMultipleTables(), remove_dbtablespaces(), RemoveSubscriptionRel(), RenameTableSpace(), ThereIsAtLeastOneRole(), and vac_truncate_clog().

◆ table_beginscan_parallel()

TableScanDesc table_beginscan_parallel ( Relation  relation,
ParallelTableScanDesc  pscan 
)

Definition at line 166 of file tableam.c.

167{
168 Snapshot snapshot;
169 uint32 flags = SO_TYPE_SEQSCAN |
171
173
174 if (!pscan->phs_snapshot_any)
175 {
176 /* Snapshot was serialized -- restore it */
177 snapshot = RestoreSnapshot((char *) pscan + pscan->phs_snapshot_off);
178 RegisterSnapshot(snapshot);
179 flags |= SO_TEMP_SNAPSHOT;
180 }
181 else
182 {
183 /* SnapshotAny passed by caller (not serialized) */
184 snapshot = SnapshotAny;
185 }
186
187 return relation->rd_tableam->scan_begin(relation, snapshot, 0, NULL,
188 pscan, flags);
189}
Assert(PointerIsAligned(start, uint64))
#define RelFileLocatorEquals(locator1, locator2)
Snapshot RestoreSnapshot(char *start_address)
Definition: snapmgr.c:1780
#define SnapshotAny
Definition: snapmgr.h:33
RelFileLocator phs_locator
Definition: relscan.h:82
RelFileLocator rd_locator
Definition: rel.h:57

References Assert(), ParallelTableScanDescData::phs_locator, ParallelTableScanDescData::phs_snapshot_any, ParallelTableScanDescData::phs_snapshot_off, RelationData::rd_locator, RelationData::rd_tableam, RegisterSnapshot(), RelFileLocatorEquals, RestoreSnapshot(), TableAmRoutine::scan_begin, SnapshotAny, SO_ALLOW_PAGEMODE, SO_ALLOW_STRAT, SO_ALLOW_SYNC, SO_TEMP_SNAPSHOT, and SO_TYPE_SEQSCAN.

Referenced by _brin_parallel_scan_and_build(), _bt_parallel_scan_and_sort(), _gin_parallel_scan_and_build(), ExecSeqScanInitializeDSM(), and ExecSeqScanInitializeWorker().

◆ table_block_parallelscan_estimate()

Size table_block_parallelscan_estimate ( Relation  rel)

Definition at line 383 of file tableam.c.

384{
385 return sizeof(ParallelBlockTableScanDescData);
386}
struct ParallelBlockTableScanDescData ParallelBlockTableScanDescData

◆ table_block_parallelscan_initialize()

Size table_block_parallelscan_initialize ( Relation  rel,
ParallelTableScanDesc  pscan 
)

Definition at line 389 of file tableam.c.

390{
392
393 bpscan->base.phs_locator = rel->rd_locator;
395 /* compare phs_syncscan initialization to similar logic in initscan */
398 bpscan->phs_nblocks > NBuffers / 4;
399 SpinLockInit(&bpscan->phs_mutex);
402
403 return sizeof(ParallelBlockTableScanDescData);
404}
static void pg_atomic_init_u64(volatile pg_atomic_uint64 *ptr, uint64 val)
Definition: atomics.h:453
#define InvalidBlockNumber
Definition: block.h:33
#define RelationGetNumberOfBlocks(reln)
Definition: bufmgr.h:283
int NBuffers
Definition: globals.c:143
#define RelationUsesLocalBuffers(relation)
Definition: rel.h:648
struct ParallelBlockTableScanDescData * ParallelBlockTableScanDesc
Definition: relscan.h:102
#define SpinLockInit(lock)
Definition: spin.h:57
pg_atomic_uint64 phs_nallocated
Definition: relscan.h:99
ParallelTableScanDescData base
Definition: relscan.h:94
bool synchronize_seqscans
Definition: tableam.c:50

References ParallelBlockTableScanDescData::base, InvalidBlockNumber, NBuffers, pg_atomic_init_u64(), ParallelTableScanDescData::phs_locator, ParallelBlockTableScanDescData::phs_mutex, ParallelBlockTableScanDescData::phs_nallocated, ParallelBlockTableScanDescData::phs_nblocks, ParallelBlockTableScanDescData::phs_startblock, ParallelTableScanDescData::phs_syncscan, RelationData::rd_locator, RelationGetNumberOfBlocks, RelationUsesLocalBuffers, SpinLockInit, and synchronize_seqscans.

◆ table_block_parallelscan_nextpage()

BlockNumber table_block_parallelscan_nextpage ( Relation  rel,
ParallelBlockTableScanWorker  pbscanwork,
ParallelBlockTableScanDesc  pbscan 
)

Definition at line 492 of file tableam.c.

495{
496 BlockNumber page;
497 uint64 nallocated;
498
499 /*
500 * The logic below allocates block numbers out to parallel workers in a
501 * way that each worker will receive a set of consecutive block numbers to
502 * scan. Earlier versions of this would allocate the next highest block
503 * number to the next worker to call this function. This would generally
504 * result in workers never receiving consecutive block numbers. Some
505 * operating systems would not detect the sequential I/O pattern due to
506 * each backend being a different process which could result in poor
507 * performance due to inefficient or no readahead. To work around this
508 * issue, we now allocate a range of block numbers for each worker and
509 * when they come back for another block, we give them the next one in
510 * that range until the range is complete. When the worker completes the
511 * range of blocks we then allocate another range for it and return the
512 * first block number from that range.
513 *
514 * Here we name these ranges of blocks "chunks". The initial size of
515 * these chunks is determined in table_block_parallelscan_startblock_init
516 * based on the size of the relation. Towards the end of the scan, we
517 * start making reductions in the size of the chunks in order to attempt
518 * to divide the remaining work over all the workers as evenly as
519 * possible.
520 *
521 * Here pbscanwork is local worker memory. phsw_chunk_remaining tracks
522 * the number of blocks remaining in the chunk. When that reaches 0 then
523 * we must allocate a new chunk for the worker.
524 *
525 * phs_nallocated tracks how many blocks have been allocated to workers
526 * already. When phs_nallocated >= rs_nblocks, all blocks have been
527 * allocated.
528 *
529 * Because we use an atomic fetch-and-add to fetch the current value, the
530 * phs_nallocated counter will exceed rs_nblocks, because workers will
531 * still increment the value, when they try to allocate the next block but
532 * all blocks have been allocated already. The counter must be 64 bits
533 * wide because of that, to avoid wrapping around when rs_nblocks is close
534 * to 2^32.
535 *
536 * The actual block to return is calculated by adding the counter to the
537 * starting block number, modulo nblocks.
538 */
539
540 /*
541 * First check if we have any remaining blocks in a previous chunk for
542 * this worker. We must consume all of the blocks from that before we
543 * allocate a new chunk to the worker.
544 */
545 if (pbscanwork->phsw_chunk_remaining > 0)
546 {
547 /*
548 * Give them the next block in the range and update the remaining
549 * number of blocks.
550 */
551 nallocated = ++pbscanwork->phsw_nallocated;
552 pbscanwork->phsw_chunk_remaining--;
553 }
554 else
555 {
556 /*
557 * When we've only got PARALLEL_SEQSCAN_RAMPDOWN_CHUNKS chunks
558 * remaining in the scan, we half the chunk size. Since we reduce the
559 * chunk size here, we'll hit this again after doing
560 * PARALLEL_SEQSCAN_RAMPDOWN_CHUNKS at the new size. After a few
561 * iterations of this, we'll end up doing the last few blocks with the
562 * chunk size set to 1.
563 */
564 if (pbscanwork->phsw_chunk_size > 1 &&
565 pbscanwork->phsw_nallocated > pbscan->phs_nblocks -
567 pbscanwork->phsw_chunk_size >>= 1;
568
569 nallocated = pbscanwork->phsw_nallocated =
571 pbscanwork->phsw_chunk_size);
572
573 /*
574 * Set the remaining number of blocks in this chunk so that subsequent
575 * calls from this worker continue on with this chunk until it's done.
576 */
577 pbscanwork->phsw_chunk_remaining = pbscanwork->phsw_chunk_size - 1;
578 }
579
580 if (nallocated >= pbscan->phs_nblocks)
581 page = InvalidBlockNumber; /* all blocks have been allocated */
582 else
583 page = (nallocated + pbscan->phs_startblock) % pbscan->phs_nblocks;
584
585 /*
586 * Report scan location. Normally, we report the current page number.
587 * When we reach the end of the scan, though, we report the starting page,
588 * not the ending page, just so the starting positions for later scans
589 * doesn't slew backwards. We only report the position at the end of the
590 * scan once, though: subsequent callers will report nothing.
591 */
592 if (pbscan->base.phs_syncscan)
593 {
594 if (page != InvalidBlockNumber)
595 ss_report_location(rel, page);
596 else if (nallocated == pbscan->phs_nblocks)
598 }
599
600 return page;
601}
static uint64 pg_atomic_fetch_add_u64(volatile pg_atomic_uint64 *ptr, int64 add_)
Definition: atomics.h:522
uint32 BlockNumber
Definition: block.h:31
uint64_t uint64
Definition: c.h:503
if(TABLE==NULL||TABLE_index==NULL)
Definition: isn.c:81
void ss_report_location(Relation rel, BlockNumber location)
Definition: syncscan.c:289
#define PARALLEL_SEQSCAN_RAMPDOWN_CHUNKS
Definition: tableam.c:44

References ParallelBlockTableScanDescData::base, if(), InvalidBlockNumber, PARALLEL_SEQSCAN_RAMPDOWN_CHUNKS, pg_atomic_fetch_add_u64(), ParallelBlockTableScanDescData::phs_nallocated, ParallelBlockTableScanDescData::phs_nblocks, ParallelBlockTableScanDescData::phs_startblock, ParallelTableScanDescData::phs_syncscan, ParallelBlockTableScanWorkerData::phsw_chunk_remaining, ParallelBlockTableScanWorkerData::phsw_chunk_size, ParallelBlockTableScanWorkerData::phsw_nallocated, and ss_report_location().

Referenced by heap_scan_stream_read_next_parallel().

◆ table_block_parallelscan_reinitialize()

void table_block_parallelscan_reinitialize ( Relation  rel,
ParallelTableScanDesc  pscan 
)

Definition at line 407 of file tableam.c.

408{
410
412}
static void pg_atomic_write_u64(volatile pg_atomic_uint64 *ptr, uint64 val)
Definition: atomics.h:485

References pg_atomic_write_u64(), and ParallelBlockTableScanDescData::phs_nallocated.

◆ table_block_parallelscan_startblock_init()

void table_block_parallelscan_startblock_init ( Relation  rel,
ParallelBlockTableScanWorker  pbscanwork,
ParallelBlockTableScanDesc  pbscan 
)

Definition at line 422 of file tableam.c.

425{
426 BlockNumber sync_startpage = InvalidBlockNumber;
427
428 /* Reset the state we use for controlling allocation size. */
429 memset(pbscanwork, 0, sizeof(*pbscanwork));
430
431 StaticAssertStmt(MaxBlockNumber <= 0xFFFFFFFE,
432 "pg_nextpower2_32 may be too small for non-standard BlockNumber width");
433
434 /*
435 * We determine the chunk size based on the size of the relation. First we
436 * split the relation into PARALLEL_SEQSCAN_NCHUNKS chunks but we then
437 * take the next highest power of 2 number of the chunk size. This means
438 * we split the relation into somewhere between PARALLEL_SEQSCAN_NCHUNKS
439 * and PARALLEL_SEQSCAN_NCHUNKS / 2 chunks.
440 */
441 pbscanwork->phsw_chunk_size = pg_nextpower2_32(Max(pbscan->phs_nblocks /
443
444 /*
445 * Ensure we don't go over the maximum chunk size with larger tables. This
446 * means we may get much more than PARALLEL_SEQSCAN_NCHUNKS for larger
447 * tables. Too large a chunk size has been shown to be detrimental to
448 * synchronous scan performance.
449 */
450 pbscanwork->phsw_chunk_size = Min(pbscanwork->phsw_chunk_size,
452
453retry:
454 /* Grab the spinlock. */
455 SpinLockAcquire(&pbscan->phs_mutex);
456
457 /*
458 * If the scan's startblock has not yet been initialized, we must do so
459 * now. If this is not a synchronized scan, we just start at block 0, but
460 * if it is a synchronized scan, we must get the starting position from
461 * the synchronized scan machinery. We can't hold the spinlock while
462 * doing that, though, so release the spinlock, get the information we
463 * need, and retry. If nobody else has initialized the scan in the
464 * meantime, we'll fill in the value we fetched on the second time
465 * through.
466 */
467 if (pbscan->phs_startblock == InvalidBlockNumber)
468 {
469 if (!pbscan->base.phs_syncscan)
470 pbscan->phs_startblock = 0;
471 else if (sync_startpage != InvalidBlockNumber)
472 pbscan->phs_startblock = sync_startpage;
473 else
474 {
475 SpinLockRelease(&pbscan->phs_mutex);
476 sync_startpage = ss_get_location(rel, pbscan->phs_nblocks);
477 goto retry;
478 }
479 }
480 SpinLockRelease(&pbscan->phs_mutex);
481}
#define MaxBlockNumber
Definition: block.h:35
#define Min(x, y)
Definition: c.h:975
#define Max(x, y)
Definition: c.h:969
#define StaticAssertStmt(condition, errmessage)
Definition: c.h:909
static uint32 pg_nextpower2_32(uint32 num)
Definition: pg_bitutils.h:189
#define SpinLockRelease(lock)
Definition: spin.h:61
#define SpinLockAcquire(lock)
Definition: spin.h:59
BlockNumber ss_get_location(Relation rel, BlockNumber relnblocks)
Definition: syncscan.c:254
#define PARALLEL_SEQSCAN_MAX_CHUNK_SIZE
Definition: tableam.c:46
#define PARALLEL_SEQSCAN_NCHUNKS
Definition: tableam.c:42

References ParallelBlockTableScanDescData::base, InvalidBlockNumber, Max, MaxBlockNumber, Min, PARALLEL_SEQSCAN_MAX_CHUNK_SIZE, PARALLEL_SEQSCAN_NCHUNKS, pg_nextpower2_32(), ParallelBlockTableScanDescData::phs_mutex, ParallelBlockTableScanDescData::phs_nblocks, ParallelBlockTableScanDescData::phs_startblock, ParallelTableScanDescData::phs_syncscan, ParallelBlockTableScanWorkerData::phsw_chunk_size, SpinLockAcquire, SpinLockRelease, ss_get_location(), and StaticAssertStmt.

Referenced by heap_scan_stream_read_next_parallel().

◆ table_block_relation_estimate_size()

void table_block_relation_estimate_size ( Relation  rel,
int32 attr_widths,
BlockNumber pages,
double *  tuples,
double *  allvisfrac,
Size  overhead_bytes_per_tuple,
Size  usable_bytes_per_page 
)

Definition at line 654 of file tableam.c.

659{
660 BlockNumber curpages;
661 BlockNumber relpages;
662 double reltuples;
663 BlockNumber relallvisible;
664 double density;
665
666 /* it should have storage, so we can call the smgr */
667 curpages = RelationGetNumberOfBlocks(rel);
668
669 /* coerce values in pg_class to more desirable types */
670 relpages = (BlockNumber) rel->rd_rel->relpages;
671 reltuples = (double) rel->rd_rel->reltuples;
672 relallvisible = (BlockNumber) rel->rd_rel->relallvisible;
673
674 /*
675 * HACK: if the relation has never yet been vacuumed, use a minimum size
676 * estimate of 10 pages. The idea here is to avoid assuming a
677 * newly-created table is really small, even if it currently is, because
678 * that may not be true once some data gets loaded into it. Once a vacuum
679 * or analyze cycle has been done on it, it's more reasonable to believe
680 * the size is somewhat stable.
681 *
682 * (Note that this is only an issue if the plan gets cached and used again
683 * after the table has been filled. What we're trying to avoid is using a
684 * nestloop-type plan on a table that has grown substantially since the
685 * plan was made. Normally, autovacuum/autoanalyze will occur once enough
686 * inserts have happened and cause cached-plan invalidation; but that
687 * doesn't happen instantaneously, and it won't happen at all for cases
688 * such as temporary tables.)
689 *
690 * We test "never vacuumed" by seeing whether reltuples < 0.
691 *
692 * If the table has inheritance children, we don't apply this heuristic.
693 * Totally empty parent tables are quite common, so we should be willing
694 * to believe that they are empty.
695 */
696 if (curpages < 10 &&
697 reltuples < 0 &&
698 !rel->rd_rel->relhassubclass)
699 curpages = 10;
700
701 /* report estimated # pages */
702 *pages = curpages;
703 /* quick exit if rel is clearly empty */
704 if (curpages == 0)
705 {
706 *tuples = 0;
707 *allvisfrac = 0;
708 return;
709 }
710
711 /* estimate number of tuples from previous tuple density */
712 if (reltuples >= 0 && relpages > 0)
713 density = reltuples / (double) relpages;
714 else
715 {
716 /*
717 * When we have no data because the relation was never yet vacuumed,
718 * estimate tuple width from attribute datatypes. We assume here that
719 * the pages are completely full, which is OK for tables but is
720 * probably an overestimate for indexes. Fortunately
721 * get_relation_info() can clamp the overestimate to the parent
722 * table's size.
723 *
724 * Note: this code intentionally disregards alignment considerations,
725 * because (a) that would be gilding the lily considering how crude
726 * the estimate is, (b) it creates platform dependencies in the
727 * default plans which are kind of a headache for regression testing,
728 * and (c) different table AMs might use different padding schemes.
729 */
730 int32 tuple_width;
731 int fillfactor;
732
733 /*
734 * Without reltuples/relpages, we also need to consider fillfactor.
735 * The other branch considers it implicitly by calculating density
736 * from actual relpages/reltuples statistics.
737 */
739
740 tuple_width = get_rel_data_width(rel, attr_widths);
741 tuple_width += overhead_bytes_per_tuple;
742 /* note: integer division is intentional here */
743 density = (usable_bytes_per_page * fillfactor / 100) / tuple_width;
744 /* There's at least one row on the page, even with low fillfactor. */
745 density = clamp_row_est(density);
746 }
747 *tuples = rint(density * (double) curpages);
748
749 /*
750 * We use relallvisible as-is, rather than scaling it up like we do for
751 * the pages and tuples counts, on the theory that any pages added since
752 * the last VACUUM are most likely not marked all-visible. But costsize.c
753 * wants it converted to a fraction.
754 */
755 if (relallvisible == 0 || curpages <= 0)
756 *allvisfrac = 0;
757 else if ((double) relallvisible >= curpages)
758 *allvisfrac = 1;
759 else
760 *allvisfrac = (double) relallvisible / curpages;
761}
int32_t int32
Definition: c.h:498
double clamp_row_est(double nrows)
Definition: costsize.c:213
static int fillfactor
Definition: pgbench.c:188
int32 get_rel_data_width(Relation rel, int32 *attr_widths)
Definition: plancat.c:1194
#define RelationGetFillFactor(relation, defaultff)
Definition: rel.h:374
#define HEAP_DEFAULT_FILLFACTOR
Definition: rel.h:360
Form_pg_class rd_rel
Definition: rel.h:111

References clamp_row_est(), fillfactor, get_rel_data_width(), HEAP_DEFAULT_FILLFACTOR, if(), RelationData::rd_rel, RelationGetFillFactor, and RelationGetNumberOfBlocks.

Referenced by heapam_estimate_rel_size().

◆ table_block_relation_size()

uint64 table_block_relation_size ( Relation  rel,
ForkNumber  forkNumber 
)

Definition at line 617 of file tableam.c.

618{
619 uint64 nblocks = 0;
620
621 /* InvalidForkNumber indicates returning the size for all forks */
622 if (forkNumber == InvalidForkNumber)
623 {
624 for (int i = 0; i < MAX_FORKNUM; i++)
625 nblocks += smgrnblocks(RelationGetSmgr(rel), i);
626 }
627 else
628 nblocks = smgrnblocks(RelationGetSmgr(rel), forkNumber);
629
630 return nblocks * BLCKSZ;
631}
int i
Definition: isn.c:77
static SMgrRelation RelationGetSmgr(Relation rel)
Definition: rel.h:578
@ InvalidForkNumber
Definition: relpath.h:57
#define MAX_FORKNUM
Definition: relpath.h:70
BlockNumber smgrnblocks(SMgrRelation reln, ForkNumber forknum)
Definition: smgr.c:819

References i, InvalidForkNumber, MAX_FORKNUM, RelationGetSmgr(), and smgrnblocks().

◆ table_index_fetch_tuple_check()

bool table_index_fetch_tuple_check ( Relation  rel,
ItemPointer  tid,
Snapshot  snapshot,
bool *  all_dead 
)

Definition at line 209 of file tableam.c.

213{
215 TupleTableSlot *slot;
216 bool call_again = false;
217 bool found;
218
219 slot = table_slot_create(rel, NULL);
220 scan = table_index_fetch_begin(rel);
221 found = table_index_fetch_tuple(scan, tid, snapshot, slot, &call_again,
222 all_dead);
225
226 return found;
227}
void ExecDropSingleTupleTableSlot(TupleTableSlot *slot)
Definition: execTuples.c:1443
TupleTableSlot * table_slot_create(Relation relation, List **reglist)
Definition: tableam.c:92
static IndexFetchTableData * table_index_fetch_begin(Relation rel)
Definition: tableam.h:1152
static void table_index_fetch_end(struct IndexFetchTableData *scan)
Definition: tableam.h:1171
static bool table_index_fetch_tuple(struct IndexFetchTableData *scan, ItemPointer tid, Snapshot snapshot, TupleTableSlot *slot, bool *call_again, bool *all_dead)
Definition: tableam.h:1201

References ExecDropSingleTupleTableSlot(), table_index_fetch_begin(), table_index_fetch_end(), table_index_fetch_tuple(), and table_slot_create().

Referenced by _bt_check_unique().

◆ table_parallelscan_estimate()

Size table_parallelscan_estimate ( Relation  rel,
Snapshot  snapshot 
)

Definition at line 131 of file tableam.c.

132{
133 Size sz = 0;
134
135 if (IsMVCCSnapshot(snapshot))
136 sz = add_size(sz, EstimateSnapshotSpace(snapshot));
137 else
138 Assert(snapshot == SnapshotAny);
139
140 sz = add_size(sz, rel->rd_tableam->parallelscan_estimate(rel));
141
142 return sz;
143}
size_t Size
Definition: c.h:576
Size add_size(Size s1, Size s2)
Definition: shmem.c:493
Size EstimateSnapshotSpace(Snapshot snapshot)
Definition: snapmgr.c:1699
#define IsMVCCSnapshot(snapshot)
Definition: snapmgr.h:55
Size(* parallelscan_estimate)(Relation rel)
Definition: tableam.h:386

References add_size(), Assert(), EstimateSnapshotSpace(), IsMVCCSnapshot, TableAmRoutine::parallelscan_estimate, RelationData::rd_tableam, and SnapshotAny.

Referenced by _brin_parallel_estimate_shared(), _bt_parallel_estimate_shared(), _gin_parallel_estimate_shared(), and ExecSeqScanEstimate().

◆ table_parallelscan_initialize()

void table_parallelscan_initialize ( Relation  rel,
ParallelTableScanDesc  pscan,
Snapshot  snapshot 
)

Definition at line 146 of file tableam.c.

148{
149 Size snapshot_off = rel->rd_tableam->parallelscan_initialize(rel, pscan);
150
151 pscan->phs_snapshot_off = snapshot_off;
152
153 if (IsMVCCSnapshot(snapshot))
154 {
155 SerializeSnapshot(snapshot, (char *) pscan + pscan->phs_snapshot_off);
156 pscan->phs_snapshot_any = false;
157 }
158 else
159 {
160 Assert(snapshot == SnapshotAny);
161 pscan->phs_snapshot_any = true;
162 }
163}
void SerializeSnapshot(Snapshot snapshot, char *start_address)
Definition: snapmgr.c:1723
Size(* parallelscan_initialize)(Relation rel, ParallelTableScanDesc pscan)
Definition: tableam.h:393

References Assert(), IsMVCCSnapshot, TableAmRoutine::parallelscan_initialize, ParallelTableScanDescData::phs_snapshot_any, ParallelTableScanDescData::phs_snapshot_off, RelationData::rd_tableam, SerializeSnapshot(), and SnapshotAny.

Referenced by _brin_begin_parallel(), _bt_begin_parallel(), _gin_begin_parallel(), and ExecSeqScanInitializeDSM().

◆ table_slot_callbacks()

const TupleTableSlotOps * table_slot_callbacks ( Relation  relation)

Definition at line 59 of file tableam.c.

60{
61 const TupleTableSlotOps *tts_cb;
62
63 if (relation->rd_tableam)
64 tts_cb = relation->rd_tableam->slot_callbacks(relation);
65 else if (relation->rd_rel->relkind == RELKIND_FOREIGN_TABLE)
66 {
67 /*
68 * Historically FDWs expect to store heap tuples in slots. Continue
69 * handing them one, to make it less painful to adapt FDWs to new
70 * versions. The cost of a heap slot over a virtual slot is pretty
71 * small.
72 */
73 tts_cb = &TTSOpsHeapTuple;
74 }
75 else
76 {
77 /*
78 * These need to be supported, as some parts of the code (like COPY)
79 * need to create slots for such relations too. It seems better to
80 * centralize the knowledge that a heap slot is the right thing in
81 * that case here.
82 */
83 Assert(relation->rd_rel->relkind == RELKIND_VIEW ||
84 relation->rd_rel->relkind == RELKIND_PARTITIONED_TABLE);
85 tts_cb = &TTSOpsVirtual;
86 }
87
88 return tts_cb;
89}
const TupleTableSlotOps TTSOpsVirtual
Definition: execTuples.c:84
const TupleTableSlotOps TTSOpsHeapTuple
Definition: execTuples.c:85
const TupleTableSlotOps *(* slot_callbacks)(Relation rel)
Definition: tableam.h:297

References Assert(), RelationData::rd_rel, RelationData::rd_tableam, TableAmRoutine::slot_callbacks, TTSOpsHeapTuple, and TTSOpsVirtual.

Referenced by ATRewriteTable(), ExecGetAllNullSlot(), ExecGetReturningSlot(), ExecGetTriggerNewSlot(), ExecGetTriggerOldSlot(), ExecInitBitmapHeapScan(), ExecInitIndexOnlyScan(), ExecInitIndexScan(), ExecInitSampleScan(), ExecInitSeqScan(), ExecInitTidRangeScan(), ExecInitTidScan(), and table_slot_create().

◆ table_slot_create()

TupleTableSlot * table_slot_create ( Relation  relation,
List **  reglist 
)

Definition at line 92 of file tableam.c.

93{
94 const TupleTableSlotOps *tts_cb;
95 TupleTableSlot *slot;
96
97 tts_cb = table_slot_callbacks(relation);
98 slot = MakeSingleTupleTableSlot(RelationGetDescr(relation), tts_cb);
99
100 if (reglist)
101 *reglist = lappend(*reglist, slot);
102
103 return slot;
104}
TupleTableSlot * MakeSingleTupleTableSlot(TupleDesc tupdesc, const TupleTableSlotOps *tts_ops)
Definition: execTuples.c:1427
List * lappend(List *list, void *datum)
Definition: list.c:339
#define RelationGetDescr(relation)
Definition: rel.h:542
const TupleTableSlotOps * table_slot_callbacks(Relation relation)
Definition: tableam.c:59

References lappend(), MakeSingleTupleTableSlot(), RelationGetDescr, and table_slot_callbacks().

Referenced by acquire_sample_rows(), apply_handle_tuple_routing(), apply_handle_update_internal(), build_index_value_desc(), check_default_partition_contents(), check_exclusion_or_unique_constraint(), CopyFrom(), CopyMultiInsertInfoNextFreeSlot(), DoCopyTo(), EvalPlanQualSlot(), ExecCrossPartitionUpdate(), ExecInitInsertProjection(), ExecInitMerge(), ExecInitMergeTupleSlots(), ExecInitModifyTable(), ExecInitPartitionInfo(), ExecInitRoutingInfo(), ExecInitUpdateProjection(), FindConflictTuple(), FindReplTupleInLocalRel(), get_actual_variable_range(), heap_entry_is_visible(), heapam_index_build_range_scan(), heapam_relation_copy_for_cluster(), IndexCheckExclusion(), RelationFindReplTupleSeq(), systable_beginscan(), systable_beginscan_ordered(), table_index_fetch_tuple_check(), validateDomainCheckConstraint(), validateDomainNotNullConstraint(), and validateForeignKeyConstraint().

◆ table_tuple_get_latest_tid()

void table_tuple_get_latest_tid ( TableScanDesc  scan,
ItemPointer  tid 
)

Definition at line 236 of file tableam.c.

237{
238 Relation rel = scan->rs_rd;
239 const TableAmRoutine *tableam = rel->rd_tableam;
240
241 /*
242 * We don't expect direct calls to table_tuple_get_latest_tid with valid
243 * CheckXidAlive for catalog or regular tables. See detailed comments in
244 * xact.c where these variables are declared.
245 */
247 elog(ERROR, "unexpected table_tuple_get_latest_tid call during logical decoding");
248
249 /*
250 * Since this can be called with user-supplied TID, don't trust the input
251 * too much.
252 */
253 if (!tableam->tuple_tid_valid(scan, tid))
255 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
256 errmsg("tid (%u, %u) is not valid for relation \"%s\"",
260
261 tableam->tuple_get_latest_tid(scan, tid);
262}
#define unlikely(x)
Definition: c.h:347
int errcode(int sqlerrcode)
Definition: elog.c:854
int errmsg(const char *fmt,...)
Definition: elog.c:1071
#define ereport(elevel,...)
Definition: elog.h:149
static OffsetNumber ItemPointerGetOffsetNumberNoCheck(const ItemPointerData *pointer)
Definition: itemptr.h:114
static BlockNumber ItemPointerGetBlockNumberNoCheck(const ItemPointerData *pointer)
Definition: itemptr.h:93
#define RelationGetRelationName(relation)
Definition: rel.h:550
void(* tuple_get_latest_tid)(TableScanDesc scan, ItemPointer tid)
Definition: tableam.h:482
bool(* tuple_tid_valid)(TableScanDesc scan, ItemPointer tid)
Definition: tableam.h:475
Relation rs_rd
Definition: relscan.h:36
#define TransactionIdIsValid(xid)
Definition: transam.h:41
bool bsysscan
Definition: xact.c:100
TransactionId CheckXidAlive
Definition: xact.c:99

References bsysscan, CheckXidAlive, elog, ereport, errcode(), errmsg(), ERROR, ItemPointerGetBlockNumberNoCheck(), ItemPointerGetOffsetNumberNoCheck(), RelationData::rd_tableam, RelationGetRelationName, TableScanDescData::rs_rd, TransactionIdIsValid, TableAmRoutine::tuple_get_latest_tid, TableAmRoutine::tuple_tid_valid, and unlikely.

Referenced by currtid_internal(), and TidNext().

Variable Documentation

◆ default_table_access_method

char* default_table_access_method = DEFAULT_TABLE_ACCESS_METHOD

Definition at line 49 of file tableam.c.

Referenced by ATPrepSetAccessMethod(), and DefineRelation().

◆ synchronize_seqscans

bool synchronize_seqscans = true

Definition at line 50 of file tableam.c.

Referenced by initscan(), and table_block_parallelscan_initialize().