PostgreSQL Source Code  git master
vacuum.c File Reference
#include "postgres.h"
#include <math.h>
#include "access/clog.h"
#include "access/commit_ts.h"
#include "access/genam.h"
#include "access/heapam.h"
#include "access/htup_details.h"
#include "access/multixact.h"
#include "access/tableam.h"
#include "access/transam.h"
#include "access/xact.h"
#include "catalog/namespace.h"
#include "catalog/pg_database.h"
#include "catalog/pg_inherits.h"
#include "catalog/pg_namespace.h"
#include "commands/cluster.h"
#include "commands/defrem.h"
#include "commands/vacuum.h"
#include "miscadmin.h"
#include "nodes/makefuncs.h"
#include "pgstat.h"
#include "postmaster/autovacuum.h"
#include "postmaster/bgworker_internals.h"
#include "storage/bufmgr.h"
#include "storage/lmgr.h"
#include "storage/proc.h"
#include "storage/procarray.h"
#include "utils/acl.h"
#include "utils/fmgroids.h"
#include "utils/guc.h"
#include "utils/memutils.h"
#include "utils/snapmgr.h"
#include "utils/syscache.h"
Include dependency graph for vacuum.c:

Go to the source code of this file.

Functions

static Listexpand_vacuum_rel (VacuumRelation *vrel, int options)
 
static Listget_all_vacuum_rels (int options)
 
static void vac_truncate_clog (TransactionId frozenXID, MultiXactId minMulti, TransactionId lastSaneFrozenXid, MultiXactId lastSaneMinMulti)
 
static bool vacuum_rel (Oid relid, RangeVar *relation, VacuumParams *params)
 
static double compute_parallel_delay (void)
 
static VacOptTernaryValue get_vacopt_ternary_value (DefElem *def)
 
void ExecVacuum (ParseState *pstate, VacuumStmt *vacstmt, bool isTopLevel)
 
void vacuum (List *relations, VacuumParams *params, BufferAccessStrategy bstrategy, bool isTopLevel)
 
bool vacuum_is_relation_owner (Oid relid, Form_pg_class reltuple, int options)
 
Relation vacuum_open_relation (Oid relid, RangeVar *relation, int options, bool verbose, LOCKMODE lmode)
 
void vacuum_set_xid_limits (Relation rel, int freeze_min_age, int freeze_table_age, int multixact_freeze_min_age, int multixact_freeze_table_age, TransactionId *oldestXmin, TransactionId *freezeLimit, TransactionId *xidFullScanLimit, MultiXactId *multiXactCutoff, MultiXactId *mxactFullScanLimit)
 
double vac_estimate_reltuples (Relation relation, BlockNumber total_pages, BlockNumber scanned_pages, double scanned_tuples)
 
void vac_update_relstats (Relation relation, BlockNumber num_pages, double num_tuples, BlockNumber num_all_visible_pages, bool hasindex, TransactionId frozenxid, MultiXactId minmulti, bool in_outer_xact)
 
void vac_update_datfrozenxid (void)
 
void vac_open_indexes (Relation relation, LOCKMODE lockmode, int *nindexes, Relation **Irel)
 
void vac_close_indexes (int nindexes, Relation *Irel, LOCKMODE lockmode)
 
void vacuum_delay_point (void)
 

Variables

int vacuum_freeze_min_age
 
int vacuum_freeze_table_age
 
int vacuum_multixact_freeze_min_age
 
int vacuum_multixact_freeze_table_age
 
static MemoryContext vac_context = NULL
 
static BufferAccessStrategy vac_strategy
 
pg_atomic_uint32VacuumSharedCostBalance = NULL
 
pg_atomic_uint32VacuumActiveNWorkers = NULL
 
int VacuumCostBalanceLocal = 0
 

Function Documentation

◆ compute_parallel_delay()

static double compute_parallel_delay ( void  )
static

Definition at line 2091 of file vacuum.c.

References Assert, pg_atomic_add_fetch_u32(), pg_atomic_read_u32(), pg_atomic_sub_fetch_u32(), VacuumCostBalance, VacuumCostBalanceLocal, VacuumCostDelay, and VacuumCostLimit.

Referenced by vacuum_delay_point().

2092 {
2093  double msec = 0;
2094  uint32 shared_balance;
2095  int nworkers;
2096 
2097  /* Parallel vacuum must be active */
2099 
2101 
2102  /* At least count itself */
2103  Assert(nworkers >= 1);
2104 
2105  /* Update the shared cost balance value atomically */
2107 
2108  /* Compute the total local balance for the current worker */
2110 
2111  if ((shared_balance >= VacuumCostLimit) &&
2112  (VacuumCostBalanceLocal > 0.5 * ((double) VacuumCostLimit / nworkers)))
2113  {
2114  /* Compute sleep time based on the local cost balance */
2118  }
2119 
2120  /*
2121  * Reset the local balance as we accumulated it into the shared value.
2122  */
2123  VacuumCostBalance = 0;
2124 
2125  return msec;
2126 }
pg_atomic_uint32 * VacuumActiveNWorkers
Definition: vacuum.c:77
int VacuumCostBalance
Definition: globals.c:148
static uint32 pg_atomic_sub_fetch_u32(volatile pg_atomic_uint32 *ptr, int32 sub_)
Definition: atomics.h:401
static uint32 pg_atomic_add_fetch_u32(volatile pg_atomic_uint32 *ptr, int32 add_)
Definition: atomics.h:386
int VacuumCostLimit
Definition: globals.c:141
unsigned int uint32
Definition: c.h:429
int VacuumCostBalanceLocal
Definition: vacuum.c:78
pg_atomic_uint32 * VacuumSharedCostBalance
Definition: vacuum.c:76
#define Assert(condition)
Definition: c.h:800
double VacuumCostDelay
Definition: globals.c:142
static uint32 pg_atomic_read_u32(volatile pg_atomic_uint32 *ptr)
Definition: atomics.h:241

◆ ExecVacuum()

void ExecVacuum ( ParseState pstate,
VacuumStmt vacstmt,
bool  isTopLevel 
)

Definition at line 98 of file vacuum.c.

References analyze(), DefElem::arg, Assert, defGetBoolean(), defGetInt32(), DefElem::defname, ereport, errcode(), errmsg(), ERROR, VacuumParams::freeze_min_age, VacuumParams::freeze_table_age, get_vacopt_ternary_value(), VacuumParams::index_cleanup, VacuumStmt::is_vacuumcmd, VacuumParams::is_wraparound, lfirst, lfirst_node, DefElem::location, VacuumParams::log_min_duration, MAX_PARALLEL_WORKER_LIMIT, VacuumParams::multixact_freeze_min_age, VacuumParams::multixact_freeze_table_age, NIL, VacuumParams::nworkers, VacuumParams::options, VacuumStmt::options, parser_errposition(), VacuumStmt::rels, VacuumParams::truncate, VacuumRelation::va_cols, VACOPT_ANALYZE, VACOPT_DISABLE_PAGE_SKIPPING, VACOPT_FREEZE, VACOPT_FULL, VACOPT_SKIP_LOCKED, VACOPT_SKIPTOAST, VACOPT_TERNARY_DEFAULT, VACOPT_VACUUM, VACOPT_VERBOSE, vacuum(), and verbose.

Referenced by standard_ProcessUtility().

99 {
100  VacuumParams params;
101  bool verbose = false;
102  bool skip_locked = false;
103  bool analyze = false;
104  bool freeze = false;
105  bool full = false;
106  bool disable_page_skipping = false;
107  ListCell *lc;
108 
109  /* Set default value */
112 
113  /* By default parallel vacuum is enabled */
114  params.nworkers = 0;
115 
116  /* Parse options list */
117  foreach(lc, vacstmt->options)
118  {
119  DefElem *opt = (DefElem *) lfirst(lc);
120 
121  /* Parse common options for VACUUM and ANALYZE */
122  if (strcmp(opt->defname, "verbose") == 0)
123  verbose = defGetBoolean(opt);
124  else if (strcmp(opt->defname, "skip_locked") == 0)
125  skip_locked = defGetBoolean(opt);
126  else if (!vacstmt->is_vacuumcmd)
127  ereport(ERROR,
128  (errcode(ERRCODE_SYNTAX_ERROR),
129  errmsg("unrecognized ANALYZE option \"%s\"", opt->defname),
130  parser_errposition(pstate, opt->location)));
131 
132  /* Parse options available on VACUUM */
133  else if (strcmp(opt->defname, "analyze") == 0)
134  analyze = defGetBoolean(opt);
135  else if (strcmp(opt->defname, "freeze") == 0)
136  freeze = defGetBoolean(opt);
137  else if (strcmp(opt->defname, "full") == 0)
138  full = defGetBoolean(opt);
139  else if (strcmp(opt->defname, "disable_page_skipping") == 0)
140  disable_page_skipping = defGetBoolean(opt);
141  else if (strcmp(opt->defname, "index_cleanup") == 0)
143  else if (strcmp(opt->defname, "truncate") == 0)
144  params.truncate = get_vacopt_ternary_value(opt);
145  else if (strcmp(opt->defname, "parallel") == 0)
146  {
147  if (opt->arg == NULL)
148  {
149  ereport(ERROR,
150  (errcode(ERRCODE_SYNTAX_ERROR),
151  errmsg("parallel option requires a value between 0 and %d",
153  parser_errposition(pstate, opt->location)));
154  }
155  else
156  {
157  int nworkers;
158 
159  nworkers = defGetInt32(opt);
160  if (nworkers < 0 || nworkers > MAX_PARALLEL_WORKER_LIMIT)
161  ereport(ERROR,
162  (errcode(ERRCODE_SYNTAX_ERROR),
163  errmsg("parallel vacuum degree must be between 0 and %d",
164  MAX_PARALLEL_WORKER_LIMIT),
165  parser_errposition(pstate, opt->location)));
166 
167  /*
168  * Disable parallel vacuum, if user has specified parallel
169  * degree as zero.
170  */
171  if (nworkers == 0)
172  params.nworkers = -1;
173  else
174  params.nworkers = nworkers;
175  }
176  }
177  else
178  ereport(ERROR,
179  (errcode(ERRCODE_SYNTAX_ERROR),
180  errmsg("unrecognized VACUUM option \"%s\"", opt->defname),
181  parser_errposition(pstate, opt->location)));
182  }
183 
184  /* Set vacuum options */
185  params.options =
186  (vacstmt->is_vacuumcmd ? VACOPT_VACUUM : VACOPT_ANALYZE) |
187  (verbose ? VACOPT_VERBOSE : 0) |
188  (skip_locked ? VACOPT_SKIP_LOCKED : 0) |
189  (analyze ? VACOPT_ANALYZE : 0) |
190  (freeze ? VACOPT_FREEZE : 0) |
191  (full ? VACOPT_FULL : 0) |
192  (disable_page_skipping ? VACOPT_DISABLE_PAGE_SKIPPING : 0);
193 
194  /* sanity checks on options */
195  Assert(params.options & (VACOPT_VACUUM | VACOPT_ANALYZE));
196  Assert((params.options & VACOPT_VACUUM) ||
197  !(params.options & (VACOPT_FULL | VACOPT_FREEZE)));
198  Assert(!(params.options & VACOPT_SKIPTOAST));
199 
200  if ((params.options & VACOPT_FULL) && params.nworkers > 0)
201  ereport(ERROR,
202  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
203  errmsg("VACUUM FULL cannot be performed in parallel")));
204 
205  /*
206  * Make sure VACOPT_ANALYZE is specified if any column lists are present.
207  */
208  if (!(params.options & VACOPT_ANALYZE))
209  {
210  ListCell *lc;
211 
212  foreach(lc, vacstmt->rels)
213  {
215 
216  if (vrel->va_cols != NIL)
217  ereport(ERROR,
218  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
219  errmsg("ANALYZE option must be specified when a column list is provided")));
220  }
221  }
222 
223  /*
224  * All freeze ages are zero if the FREEZE option is given; otherwise pass
225  * them as -1 which means to use the default values.
226  */
227  if (params.options & VACOPT_FREEZE)
228  {
229  params.freeze_min_age = 0;
230  params.freeze_table_age = 0;
231  params.multixact_freeze_min_age = 0;
232  params.multixact_freeze_table_age = 0;
233  }
234  else
235  {
236  params.freeze_min_age = -1;
237  params.freeze_table_age = -1;
238  params.multixact_freeze_min_age = -1;
239  params.multixact_freeze_table_age = -1;
240  }
241 
242  /* user-invoked vacuum is never "for wraparound" */
243  params.is_wraparound = false;
244 
245  /* user-invoked vacuum never uses this parameter */
246  params.log_min_duration = -1;
247 
248  /* Now go through the common routine */
249  vacuum(vacstmt->rels, &params, NULL, isTopLevel);
250 }
#define NIL
Definition: pg_list.h:65
int multixact_freeze_table_age
Definition: vacuum.h:215
void vacuum(List *relations, VacuumParams *params, BufferAccessStrategy bstrategy, bool isTopLevel)
Definition: vacuum.c:272
bool is_vacuumcmd
Definition: parsenodes.h:3225
int32 defGetInt32(DefElem *def)
Definition: define.c:166
int errcode(int sqlerrcode)
Definition: elog.c:691
int freeze_table_age
Definition: vacuum.h:212
bool defGetBoolean(DefElem *def)
Definition: define.c:111
#define ERROR
Definition: elog.h:43
int freeze_min_age
Definition: vacuum.h:211
bool is_wraparound
Definition: vacuum.h:217
#define lfirst_node(type, lc)
Definition: pg_list.h:172
int location
Definition: parsenodes.h:736
VacOptTernaryValue index_cleanup
Definition: vacuum.h:221
Node * arg
Definition: parsenodes.h:734
static int verbose
VacOptTernaryValue truncate
Definition: vacuum.h:223
#define ereport(elevel,...)
Definition: elog.h:155
#define Assert(condition)
Definition: c.h:800
#define lfirst(lc)
Definition: pg_list.h:169
int nworkers
Definition: vacuum.h:231
int parser_errposition(ParseState *pstate, int location)
Definition: parse_node.c:110
int log_min_duration
Definition: vacuum.h:218
int errmsg(const char *fmt,...)
Definition: elog.c:902
List * options
Definition: parsenodes.h:3223
int options
Definition: vacuum.h:210
char * defname
Definition: parsenodes.h:733
#define MAX_PARALLEL_WORKER_LIMIT
int multixact_freeze_min_age
Definition: vacuum.h:213
static long analyze(struct nfa *nfa)
Definition: regc_nfa.c:2816
List * rels
Definition: parsenodes.h:3224
static VacOptTernaryValue get_vacopt_ternary_value(DefElem *def)
Definition: vacuum.c:2135

◆ expand_vacuum_rel()

static List * expand_vacuum_rel ( VacuumRelation vrel,
int  options 
)
static

Definition at line 719 of file vacuum.c.

References AccessShareLock, Assert, elog, ereport, errcode(), errmsg(), ERROR, find_all_inheritors(), GETSTRUCT, HeapTupleIsValid, IsAutoVacuumWorkerProcess(), lappend(), lfirst_oid, makeVacuumRelation(), MemoryContextSwitchTo(), NIL, NoLock, ObjectIdGetDatum, VacuumRelation::oid, OidIsValid, RangeVarGetRelidExtended(), VacuumRelation::relation, ReleaseSysCache(), RangeVar::relname, RELOID, RVR_SKIP_LOCKED, SearchSysCache1(), UnlockRelationOid(), VacuumRelation::va_cols, VACOPT_SKIP_LOCKED, VACOPT_VACUUM, vacuum_is_relation_owner(), and WARNING.

Referenced by vacuum().

720 {
721  List *vacrels = NIL;
722  MemoryContext oldcontext;
723 
724  /* If caller supplied OID, there's nothing we need do here. */
725  if (OidIsValid(vrel->oid))
726  {
727  oldcontext = MemoryContextSwitchTo(vac_context);
728  vacrels = lappend(vacrels, vrel);
729  MemoryContextSwitchTo(oldcontext);
730  }
731  else
732  {
733  /* Process a specific relation, and possibly partitions thereof */
734  Oid relid;
735  HeapTuple tuple;
736  Form_pg_class classForm;
737  bool include_parts;
738  int rvr_opts;
739 
740  /*
741  * Since autovacuum workers supply OIDs when calling vacuum(), no
742  * autovacuum worker should reach this code.
743  */
745 
746  /*
747  * We transiently take AccessShareLock to protect the syscache lookup
748  * below, as well as find_all_inheritors's expectation that the caller
749  * holds some lock on the starting relation.
750  */
751  rvr_opts = (options & VACOPT_SKIP_LOCKED) ? RVR_SKIP_LOCKED : 0;
752  relid = RangeVarGetRelidExtended(vrel->relation,
754  rvr_opts,
755  NULL, NULL);
756 
757  /*
758  * If the lock is unavailable, emit the same log statement that
759  * vacuum_rel() and analyze_rel() would.
760  */
761  if (!OidIsValid(relid))
762  {
763  if (options & VACOPT_VACUUM)
765  (errcode(ERRCODE_LOCK_NOT_AVAILABLE),
766  errmsg("skipping vacuum of \"%s\" --- lock not available",
767  vrel->relation->relname)));
768  else
770  (errcode(ERRCODE_LOCK_NOT_AVAILABLE),
771  errmsg("skipping analyze of \"%s\" --- lock not available",
772  vrel->relation->relname)));
773  return vacrels;
774  }
775 
776  /*
777  * To check whether the relation is a partitioned table and its
778  * ownership, fetch its syscache entry.
779  */
780  tuple = SearchSysCache1(RELOID, ObjectIdGetDatum(relid));
781  if (!HeapTupleIsValid(tuple))
782  elog(ERROR, "cache lookup failed for relation %u", relid);
783  classForm = (Form_pg_class) GETSTRUCT(tuple);
784 
785  /*
786  * Make a returnable VacuumRelation for this rel if user is a proper
787  * owner.
788  */
789  if (vacuum_is_relation_owner(relid, classForm, options))
790  {
791  oldcontext = MemoryContextSwitchTo(vac_context);
792  vacrels = lappend(vacrels, makeVacuumRelation(vrel->relation,
793  relid,
794  vrel->va_cols));
795  MemoryContextSwitchTo(oldcontext);
796  }
797 
798 
799  include_parts = (classForm->relkind == RELKIND_PARTITIONED_TABLE);
800  ReleaseSysCache(tuple);
801 
802  /*
803  * If it is, make relation list entries for its partitions. Note that
804  * the list returned by find_all_inheritors() includes the passed-in
805  * OID, so we have to skip that. There's no point in taking locks on
806  * the individual partitions yet, and doing so would just add
807  * unnecessary deadlock risk. For this last reason we do not check
808  * yet the ownership of the partitions, which get added to the list to
809  * process. Ownership will be checked later on anyway.
810  */
811  if (include_parts)
812  {
813  List *part_oids = find_all_inheritors(relid, NoLock, NULL);
814  ListCell *part_lc;
815 
816  foreach(part_lc, part_oids)
817  {
818  Oid part_oid = lfirst_oid(part_lc);
819 
820  if (part_oid == relid)
821  continue; /* ignore original table */
822 
823  /*
824  * We omit a RangeVar since it wouldn't be appropriate to
825  * complain about failure to open one of these relations
826  * later.
827  */
828  oldcontext = MemoryContextSwitchTo(vac_context);
829  vacrels = lappend(vacrels, makeVacuumRelation(NULL,
830  part_oid,
831  vrel->va_cols));
832  MemoryContextSwitchTo(oldcontext);
833  }
834  }
835 
836  /*
837  * Release lock again. This means that by the time we actually try to
838  * process the table, it might be gone or renamed. In the former case
839  * we'll silently ignore it; in the latter case we'll process it
840  * anyway, but we must beware that the RangeVar doesn't necessarily
841  * identify it anymore. This isn't ideal, perhaps, but there's little
842  * practical alternative, since we're typically going to commit this
843  * transaction and begin a new one between now and then. Moreover,
844  * holding locks on multiple relations would create significant risk
845  * of deadlock.
846  */
848  }
849 
850  return vacrels;
851 }
#define NIL
Definition: pg_list.h:65
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
RangeVar * relation
Definition: parsenodes.h:3238
void UnlockRelationOid(Oid relid, LOCKMODE lockmode)
Definition: lmgr.c:199
VacuumRelation * makeVacuumRelation(RangeVar *relation, Oid oid, List *va_cols)
Definition: makefuncs.c:809
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
#define AccessShareLock
Definition: lockdefs.h:36
int errcode(int sqlerrcode)
Definition: elog.c:691
unsigned int Oid
Definition: postgres_ext.h:31
#define OidIsValid(objectId)
Definition: c.h:706
char * relname
Definition: primnodes.h:68
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
bool vacuum_is_relation_owner(Oid relid, Form_pg_class reltuple, int options)
Definition: vacuum.c:533
#define NoLock
Definition: lockdefs.h:34
static MemoryContext vac_context
Definition: vacuum.c:68
Oid RangeVarGetRelidExtended(const RangeVar *relation, LOCKMODE lockmode, uint32 flags, RangeVarGetRelidCallback callback, void *callback_arg)
Definition: namespace.c:236
bool IsAutoVacuumWorkerProcess(void)
Definition: autovacuum.c:3325
List * lappend(List *list, void *datum)
Definition: list.c:321
#define WARNING
Definition: elog.h:40
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:1115
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1163
#define ereport(elevel,...)
Definition: elog.h:155
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define Assert(condition)
Definition: c.h:800
FormData_pg_class * Form_pg_class
Definition: pg_class.h:153
List * find_all_inheritors(Oid parentrelId, LOCKMODE lockmode, List **numparents)
Definition: pg_inherits.c:165
int errmsg(const char *fmt,...)
Definition: elog.c:902
#define elog(elevel,...)
Definition: elog.h:228
Definition: pg_list.h:50
#define lfirst_oid(lc)
Definition: pg_list.h:171

◆ get_all_vacuum_rels()

static List * get_all_vacuum_rels ( int  options)
static

Definition at line 858 of file vacuum.c.

References AccessShareLock, ForwardScanDirection, GETSTRUCT, heap_getnext(), lappend(), makeVacuumRelation(), MemoryContextSwitchTo(), NIL, table_beginscan_catalog(), table_close(), table_endscan(), table_open(), and vacuum_is_relation_owner().

Referenced by vacuum().

859 {
860  List *vacrels = NIL;
861  Relation pgclass;
862  TableScanDesc scan;
863  HeapTuple tuple;
864 
865  pgclass = table_open(RelationRelationId, AccessShareLock);
866 
867  scan = table_beginscan_catalog(pgclass, 0, NULL);
868 
869  while ((tuple = heap_getnext(scan, ForwardScanDirection)) != NULL)
870  {
871  Form_pg_class classForm = (Form_pg_class) GETSTRUCT(tuple);
872  MemoryContext oldcontext;
873  Oid relid = classForm->oid;
874 
875  /* check permissions of relation */
876  if (!vacuum_is_relation_owner(relid, classForm, options))
877  continue;
878 
879  /*
880  * We include partitioned tables here; depending on which operation is
881  * to be performed, caller will decide whether to process or ignore
882  * them.
883  */
884  if (classForm->relkind != RELKIND_RELATION &&
885  classForm->relkind != RELKIND_MATVIEW &&
886  classForm->relkind != RELKIND_PARTITIONED_TABLE)
887  continue;
888 
889  /*
890  * Build VacuumRelation(s) specifying the table OIDs to be processed.
891  * We omit a RangeVar since it wouldn't be appropriate to complain
892  * about failure to open one of these relations later.
893  */
894  oldcontext = MemoryContextSwitchTo(vac_context);
895  vacrels = lappend(vacrels, makeVacuumRelation(NULL,
896  relid,
897  NIL));
898  MemoryContextSwitchTo(oldcontext);
899  }
900 
901  table_endscan(scan);
902  table_close(pgclass, AccessShareLock);
903 
904  return vacrels;
905 }
#define NIL
Definition: pg_list.h:65
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:167
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
TableScanDesc table_beginscan_catalog(Relation relation, int nkeys, struct ScanKeyData *key)
Definition: tableam.c:112
VacuumRelation * makeVacuumRelation(RangeVar *relation, Oid oid, List *va_cols)
Definition: makefuncs.c:809
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
#define AccessShareLock
Definition: lockdefs.h:36
unsigned int Oid
Definition: postgres_ext.h:31
bool vacuum_is_relation_owner(Oid relid, Form_pg_class reltuple, int options)
Definition: vacuum.c:533
HeapTuple heap_getnext(TableScanDesc sscan, ScanDirection direction)
Definition: heapam.c:1286
static MemoryContext vac_context
Definition: vacuum.c:68
List * lappend(List *list, void *datum)
Definition: list.c:321
static void table_endscan(TableScanDesc scan)
Definition: tableam.h:863
FormData_pg_class * Form_pg_class
Definition: pg_class.h:153
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
Definition: pg_list.h:50

◆ get_vacopt_ternary_value()

static VacOptTernaryValue get_vacopt_ternary_value ( DefElem def)
static

Definition at line 2135 of file vacuum.c.

References defGetBoolean(), VACOPT_TERNARY_DISABLED, and VACOPT_TERNARY_ENABLED.

Referenced by ExecVacuum().

2136 {
2138 }
bool defGetBoolean(DefElem *def)
Definition: define.c:111

◆ vac_close_indexes()

void vac_close_indexes ( int  nindexes,
Relation Irel,
LOCKMODE  lockmode 
)

Definition at line 2008 of file vacuum.c.

References index_close(), and pfree().

Referenced by do_analyze_rel(), heap_vacuum_rel(), and parallel_vacuum_main().

2009 {
2010  if (Irel == NULL)
2011  return;
2012 
2013  while (nindexes--)
2014  {
2015  Relation ind = Irel[nindexes];
2016 
2017  index_close(ind, lockmode);
2018  }
2019  pfree(Irel);
2020 }
void pfree(void *pointer)
Definition: mcxt.c:1057
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:158

◆ vac_estimate_reltuples()

double vac_estimate_reltuples ( Relation  relation,
BlockNumber  total_pages,
BlockNumber  scanned_pages,
double  scanned_tuples 
)

Definition at line 1141 of file vacuum.c.

References RelationData::rd_rel.

Referenced by lazy_scan_heap(), and statapprox_heap().

1145 {
1146  BlockNumber old_rel_pages = relation->rd_rel->relpages;
1147  double old_rel_tuples = relation->rd_rel->reltuples;
1148  double old_density;
1149  double unscanned_pages;
1150  double total_tuples;
1151 
1152  /* If we did scan the whole table, just use the count as-is */
1153  if (scanned_pages >= total_pages)
1154  return scanned_tuples;
1155 
1156  /*
1157  * If scanned_pages is zero but total_pages isn't, keep the existing value
1158  * of reltuples. (Note: we might be returning -1 in this case.)
1159  */
1160  if (scanned_pages == 0)
1161  return old_rel_tuples;
1162 
1163  /*
1164  * If old density is unknown, we can't do much except scale up
1165  * scanned_tuples to match total_pages.
1166  */
1167  if (old_rel_tuples < 0 || old_rel_pages == 0)
1168  return floor((scanned_tuples / scanned_pages) * total_pages + 0.5);
1169 
1170  /*
1171  * Okay, we've covered the corner cases. The normal calculation is to
1172  * convert the old measurement to a density (tuples per page), then
1173  * estimate the number of tuples in the unscanned pages using that figure,
1174  * and finally add on the number of tuples in the scanned pages.
1175  */
1176  old_density = old_rel_tuples / old_rel_pages;
1177  unscanned_pages = (double) total_pages - (double) scanned_pages;
1178  total_tuples = old_density * unscanned_pages + scanned_tuples;
1179  return floor(total_tuples + 0.5);
1180 }
uint32 BlockNumber
Definition: block.h:31
Form_pg_class rd_rel
Definition: rel.h:110

◆ vac_open_indexes()

void vac_open_indexes ( Relation  relation,
LOCKMODE  lockmode,
int *  nindexes,
Relation **  Irel 
)

Definition at line 1965 of file vacuum.c.

References Assert, i, index_close(), index_open(), lfirst_oid, list_free(), list_length(), NoLock, palloc(), RelationData::rd_index, and RelationGetIndexList().

Referenced by do_analyze_rel(), heap_vacuum_rel(), and parallel_vacuum_main().

1967 {
1968  List *indexoidlist;
1969  ListCell *indexoidscan;
1970  int i;
1971 
1972  Assert(lockmode != NoLock);
1973 
1974  indexoidlist = RelationGetIndexList(relation);
1975 
1976  /* allocate enough memory for all indexes */
1977  i = list_length(indexoidlist);
1978 
1979  if (i > 0)
1980  *Irel = (Relation *) palloc(i * sizeof(Relation));
1981  else
1982  *Irel = NULL;
1983 
1984  /* collect just the ready indexes */
1985  i = 0;
1986  foreach(indexoidscan, indexoidlist)
1987  {
1988  Oid indexoid = lfirst_oid(indexoidscan);
1989  Relation indrel;
1990 
1991  indrel = index_open(indexoid, lockmode);
1992  if (indrel->rd_index->indisready)
1993  (*Irel)[i++] = indrel;
1994  else
1995  index_close(indrel, lockmode);
1996  }
1997 
1998  *nindexes = i;
1999 
2000  list_free(indexoidlist);
2001 }
unsigned int Oid
Definition: postgres_ext.h:31
Form_pg_index rd_index
Definition: rel.h:175
#define NoLock
Definition: lockdefs.h:34
#define Assert(condition)
Definition: c.h:800
static int list_length(const List *l)
Definition: pg_list.h:149
List * RelationGetIndexList(Relation relation)
Definition: relcache.c:4515
void index_close(Relation relation, LOCKMODE lockmode)
Definition: indexam.c:158
void * palloc(Size size)
Definition: mcxt.c:950
void list_free(List *list)
Definition: list.c:1376
int i
Definition: pg_list.h:50
Relation index_open(Oid relationId, LOCKMODE lockmode)
Definition: indexam.c:132
#define lfirst_oid(lc)
Definition: pg_list.h:171

◆ vac_truncate_clog()

static void vac_truncate_clog ( TransactionId  frozenXID,
MultiXactId  minMulti,
TransactionId  lastSaneFrozenXid,
MultiXactId  lastSaneMinMulti 
)
static

Definition at line 1549 of file vacuum.c.

References AccessShareLock, AdvanceOldestCommitTsXid(), Assert, datfrozenxid, datminmxid, ereport, errdetail(), errmsg(), FormData_pg_database, ForwardScanDirection, GETSTRUCT, heap_getnext(), LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), MultiXactIdIsValid, MultiXactIdPrecedes(), MyDatabaseId, ReadNewTransactionId(), SetMultiXactIdLimit(), SetTransactionIdLimit(), table_beginscan_catalog(), table_close(), table_endscan(), table_open(), TransactionIdIsNormal, TransactionIdPrecedes(), TruncateCLOG(), TruncateCommitTs(), TruncateMultiXact(), and WARNING.

Referenced by vac_update_datfrozenxid().

1553 {
1554  TransactionId nextXID = ReadNewTransactionId();
1555  Relation relation;
1556  TableScanDesc scan;
1557  HeapTuple tuple;
1558  Oid oldestxid_datoid;
1559  Oid minmulti_datoid;
1560  bool bogus = false;
1561  bool frozenAlreadyWrapped = false;
1562 
1563  /* Restrict task to one backend per cluster; see SimpleLruTruncate(). */
1564  LWLockAcquire(WrapLimitsVacuumLock, LW_EXCLUSIVE);
1565 
1566  /* init oldest datoids to sync with my frozenXID/minMulti values */
1567  oldestxid_datoid = MyDatabaseId;
1568  minmulti_datoid = MyDatabaseId;
1569 
1570  /*
1571  * Scan pg_database to compute the minimum datfrozenxid/datminmxid
1572  *
1573  * Since vac_update_datfrozenxid updates datfrozenxid/datminmxid in-place,
1574  * the values could change while we look at them. Fetch each one just
1575  * once to ensure sane behavior of the comparison logic. (Here, as in
1576  * many other places, we assume that fetching or updating an XID in shared
1577  * storage is atomic.)
1578  *
1579  * Note: we need not worry about a race condition with new entries being
1580  * inserted by CREATE DATABASE. Any such entry will have a copy of some
1581  * existing DB's datfrozenxid, and that source DB cannot be ours because
1582  * of the interlock against copying a DB containing an active backend.
1583  * Hence the new entry will not reduce the minimum. Also, if two VACUUMs
1584  * concurrently modify the datfrozenxid's of different databases, the
1585  * worst possible outcome is that pg_xact is not truncated as aggressively
1586  * as it could be.
1587  */
1588  relation = table_open(DatabaseRelationId, AccessShareLock);
1589 
1590  scan = table_beginscan_catalog(relation, 0, NULL);
1591 
1592  while ((tuple = heap_getnext(scan, ForwardScanDirection)) != NULL)
1593  {
1594  volatile FormData_pg_database *dbform = (Form_pg_database) GETSTRUCT(tuple);
1595  TransactionId datfrozenxid = dbform->datfrozenxid;
1596  TransactionId datminmxid = dbform->datminmxid;
1597 
1598  Assert(TransactionIdIsNormal(datfrozenxid));
1599  Assert(MultiXactIdIsValid(datminmxid));
1600 
1601  /*
1602  * If things are working properly, no database should have a
1603  * datfrozenxid or datminmxid that is "in the future". However, such
1604  * cases have been known to arise due to bugs in pg_upgrade. If we
1605  * see any entries that are "in the future", chicken out and don't do
1606  * anything. This ensures we won't truncate clog before those
1607  * databases have been scanned and cleaned up. (We will issue the
1608  * "already wrapped" warning if appropriate, though.)
1609  */
1610  if (TransactionIdPrecedes(lastSaneFrozenXid, datfrozenxid) ||
1611  MultiXactIdPrecedes(lastSaneMinMulti, datminmxid))
1612  bogus = true;
1613 
1614  if (TransactionIdPrecedes(nextXID, datfrozenxid))
1615  frozenAlreadyWrapped = true;
1616  else if (TransactionIdPrecedes(datfrozenxid, frozenXID))
1617  {
1618  frozenXID = datfrozenxid;
1619  oldestxid_datoid = dbform->oid;
1620  }
1621 
1622  if (MultiXactIdPrecedes(datminmxid, minMulti))
1623  {
1624  minMulti = datminmxid;
1625  minmulti_datoid = dbform->oid;
1626  }
1627  }
1628 
1629  table_endscan(scan);
1630 
1631  table_close(relation, AccessShareLock);
1632 
1633  /*
1634  * Do not truncate CLOG if we seem to have suffered wraparound already;
1635  * the computed minimum XID might be bogus. This case should now be
1636  * impossible due to the defenses in GetNewTransactionId, but we keep the
1637  * test anyway.
1638  */
1639  if (frozenAlreadyWrapped)
1640  {
1641  ereport(WARNING,
1642  (errmsg("some databases have not been vacuumed in over 2 billion transactions"),
1643  errdetail("You might have already suffered transaction-wraparound data loss.")));
1644  return;
1645  }
1646 
1647  /* chicken out if data is bogus in any other way */
1648  if (bogus)
1649  return;
1650 
1651  /*
1652  * Advance the oldest value for commit timestamps before truncating, so
1653  * that if a user requests a timestamp for a transaction we're truncating
1654  * away right after this point, they get NULL instead of an ugly "file not
1655  * found" error from slru.c. This doesn't matter for xact/multixact
1656  * because they are not subject to arbitrary lookups from users.
1657  */
1658  AdvanceOldestCommitTsXid(frozenXID);
1659 
1660  /*
1661  * Truncate CLOG, multixact and CommitTs to the oldest computed value.
1662  */
1663  TruncateCLOG(frozenXID, oldestxid_datoid);
1664  TruncateCommitTs(frozenXID);
1665  TruncateMultiXact(minMulti, minmulti_datoid);
1666 
1667  /*
1668  * Update the wrap limit for GetNewTransactionId and creation of new
1669  * MultiXactIds. Note: these functions will also signal the postmaster
1670  * for an(other) autovac cycle if needed. XXX should we avoid possibly
1671  * signaling twice?
1672  */
1673  SetTransactionIdLimit(frozenXID, oldestxid_datoid);
1674  SetMultiXactIdLimit(minMulti, minmulti_datoid, false);
1675 
1676  LWLockRelease(WrapLimitsVacuumLock);
1677 }
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:167
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
void TruncateCLOG(TransactionId oldestXact, Oid oldestxid_datoid)
Definition: clog.c:878
uint32 TransactionId
Definition: c.h:575
TableScanDesc table_beginscan_catalog(Relation relation, int nkeys, struct ScanKeyData *key)
Definition: tableam.c:112
FormData_pg_database * Form_pg_database
Definition: pg_database.h:81
#define AccessShareLock
Definition: lockdefs.h:36
unsigned int Oid
Definition: postgres_ext.h:31
void AdvanceOldestCommitTsXid(TransactionId oldestXact)
Definition: commit_ts.c:919
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1811
HeapTuple heap_getnext(TableScanDesc sscan, ScanDirection direction)
Definition: heapam.c:1286
int errdetail(const char *fmt,...)
Definition: elog.c:1035
#define MultiXactIdIsValid(multi)
Definition: multixact.h:28
bool TransactionIdPrecedes(TransactionId id1, TransactionId id2)
Definition: transam.c:300
void TruncateCommitTs(TransactionId oldestXact)
Definition: commit_ts.c:866
#define WARNING
Definition: elog.h:40
Oid MyDatabaseId
Definition: globals.c:85
void SetMultiXactIdLimit(MultiXactId oldest_datminmxid, Oid oldest_datoid, bool is_startup)
Definition: multixact.c:2208
TransactionId datfrozenxid
Definition: pg_database.h:62
#define ereport(elevel,...)
Definition: elog.h:155
#define Assert(condition)
Definition: c.h:800
void SetTransactionIdLimit(TransactionId oldest_datfrozenxid, Oid oldest_datoid)
Definition: varsup.c:345
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1207
TransactionId datminmxid
Definition: pg_database.h:65
bool MultiXactIdPrecedes(MultiXactId multi1, MultiXactId multi2)
Definition: multixact.c:3146
static TransactionId ReadNewTransactionId(void)
Definition: transam.h:308
static void table_endscan(TableScanDesc scan)
Definition: tableam.h:863
int errmsg(const char *fmt,...)
Definition: elog.c:902
FormData_pg_database
Definition: pg_database.h:74
#define TransactionIdIsNormal(xid)
Definition: transam.h:42
void TruncateMultiXact(MultiXactId newOldestMulti, Oid newOldestMultiDB)
Definition: multixact.c:2939
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39

◆ vac_update_datfrozenxid()

void vac_update_datfrozenxid ( void  )

Definition at line 1351 of file vacuum.c.

References AccessShareLock, Assert, DATABASEOID, elog, ERROR, ExclusiveLock, ForceTransactionIdLimitUpdate(), GetOldestMultiXactId(), GetOldestNonRemovableTransactionId(), GETSTRUCT, heap_freetuple(), heap_inplace_update(), HeapTupleIsValid, InvalidOid, LockDatabaseFrozenIds(), MultiXactIdIsValid, MultiXactIdPrecedes(), MyDatabaseId, ObjectIdGetDatum, ReadNewTransactionId(), ReadNextMultiXactId(), RowExclusiveLock, SearchSysCacheCopy1, systable_beginscan(), systable_endscan(), systable_getnext(), table_close(), table_open(), TransactionIdIsNormal, TransactionIdIsValid, TransactionIdPrecedes(), and vac_truncate_clog().

Referenced by do_autovacuum(), and vacuum().

1352 {
1353  HeapTuple tuple;
1354  Form_pg_database dbform;
1355  Relation relation;
1356  SysScanDesc scan;
1357  HeapTuple classTup;
1358  TransactionId newFrozenXid;
1359  MultiXactId newMinMulti;
1360  TransactionId lastSaneFrozenXid;
1361  MultiXactId lastSaneMinMulti;
1362  bool bogus = false;
1363  bool dirty = false;
1364 
1365  /*
1366  * Restrict this task to one backend per database. This avoids race
1367  * conditions that would move datfrozenxid or datminmxid backward. It
1368  * avoids calling vac_truncate_clog() with a datfrozenxid preceding a
1369  * datfrozenxid passed to an earlier vac_truncate_clog() call.
1370  */
1372 
1373  /*
1374  * Initialize the "min" calculation with
1375  * GetOldestNonRemovableTransactionId(), which is a reasonable
1376  * approximation to the minimum relfrozenxid for not-yet-committed
1377  * pg_class entries for new tables; see AddNewRelationTuple(). So we
1378  * cannot produce a wrong minimum by starting with this.
1379  */
1380  newFrozenXid = GetOldestNonRemovableTransactionId(NULL);
1381 
1382  /*
1383  * Similarly, initialize the MultiXact "min" with the value that would be
1384  * used on pg_class for new tables. See AddNewRelationTuple().
1385  */
1386  newMinMulti = GetOldestMultiXactId();
1387 
1388  /*
1389  * Identify the latest relfrozenxid and relminmxid values that we could
1390  * validly see during the scan. These are conservative values, but it's
1391  * not really worth trying to be more exact.
1392  */
1393  lastSaneFrozenXid = ReadNewTransactionId();
1394  lastSaneMinMulti = ReadNextMultiXactId();
1395 
1396  /*
1397  * We must seqscan pg_class to find the minimum Xid, because there is no
1398  * index that can help us here.
1399  */
1400  relation = table_open(RelationRelationId, AccessShareLock);
1401 
1402  scan = systable_beginscan(relation, InvalidOid, false,
1403  NULL, 0, NULL);
1404 
1405  while ((classTup = systable_getnext(scan)) != NULL)
1406  {
1407  Form_pg_class classForm = (Form_pg_class) GETSTRUCT(classTup);
1408 
1409  /*
1410  * Only consider relations able to hold unfrozen XIDs (anything else
1411  * should have InvalidTransactionId in relfrozenxid anyway).
1412  */
1413  if (classForm->relkind != RELKIND_RELATION &&
1414  classForm->relkind != RELKIND_MATVIEW &&
1415  classForm->relkind != RELKIND_TOASTVALUE)
1416  {
1417  Assert(!TransactionIdIsValid(classForm->relfrozenxid));
1418  Assert(!MultiXactIdIsValid(classForm->relminmxid));
1419  continue;
1420  }
1421 
1422  /*
1423  * Some table AMs might not need per-relation xid / multixid horizons.
1424  * It therefore seems reasonable to allow relfrozenxid and relminmxid
1425  * to not be set (i.e. set to their respective Invalid*Id)
1426  * independently. Thus validate and compute horizon for each only if
1427  * set.
1428  *
1429  * If things are working properly, no relation should have a
1430  * relfrozenxid or relminmxid that is "in the future". However, such
1431  * cases have been known to arise due to bugs in pg_upgrade. If we
1432  * see any entries that are "in the future", chicken out and don't do
1433  * anything. This ensures we won't truncate clog & multixact SLRUs
1434  * before those relations have been scanned and cleaned up.
1435  */
1436 
1437  if (TransactionIdIsValid(classForm->relfrozenxid))
1438  {
1439  Assert(TransactionIdIsNormal(classForm->relfrozenxid));
1440 
1441  /* check for values in the future */
1442  if (TransactionIdPrecedes(lastSaneFrozenXid, classForm->relfrozenxid))
1443  {
1444  bogus = true;
1445  break;
1446  }
1447 
1448  /* determine new horizon */
1449  if (TransactionIdPrecedes(classForm->relfrozenxid, newFrozenXid))
1450  newFrozenXid = classForm->relfrozenxid;
1451  }
1452 
1453  if (MultiXactIdIsValid(classForm->relminmxid))
1454  {
1455  /* check for values in the future */
1456  if (MultiXactIdPrecedes(lastSaneMinMulti, classForm->relminmxid))
1457  {
1458  bogus = true;
1459  break;
1460  }
1461 
1462  /* determine new horizon */
1463  if (MultiXactIdPrecedes(classForm->relminmxid, newMinMulti))
1464  newMinMulti = classForm->relminmxid;
1465  }
1466  }
1467 
1468  /* we're done with pg_class */
1469  systable_endscan(scan);
1470  table_close(relation, AccessShareLock);
1471 
1472  /* chicken out if bogus data found */
1473  if (bogus)
1474  return;
1475 
1476  Assert(TransactionIdIsNormal(newFrozenXid));
1477  Assert(MultiXactIdIsValid(newMinMulti));
1478 
1479  /* Now fetch the pg_database tuple we need to update. */
1480  relation = table_open(DatabaseRelationId, RowExclusiveLock);
1481 
1482  /* Fetch a copy of the tuple to scribble on */
1484  if (!HeapTupleIsValid(tuple))
1485  elog(ERROR, "could not find tuple for database %u", MyDatabaseId);
1486  dbform = (Form_pg_database) GETSTRUCT(tuple);
1487 
1488  /*
1489  * As in vac_update_relstats(), we ordinarily don't want to let
1490  * datfrozenxid go backward; but if it's "in the future" then it must be
1491  * corrupt and it seems best to overwrite it.
1492  */
1493  if (dbform->datfrozenxid != newFrozenXid &&
1494  (TransactionIdPrecedes(dbform->datfrozenxid, newFrozenXid) ||
1495  TransactionIdPrecedes(lastSaneFrozenXid, dbform->datfrozenxid)))
1496  {
1497  dbform->datfrozenxid = newFrozenXid;
1498  dirty = true;
1499  }
1500  else
1501  newFrozenXid = dbform->datfrozenxid;
1502 
1503  /* Ditto for datminmxid */
1504  if (dbform->datminmxid != newMinMulti &&
1505  (MultiXactIdPrecedes(dbform->datminmxid, newMinMulti) ||
1506  MultiXactIdPrecedes(lastSaneMinMulti, dbform->datminmxid)))
1507  {
1508  dbform->datminmxid = newMinMulti;
1509  dirty = true;
1510  }
1511  else
1512  newMinMulti = dbform->datminmxid;
1513 
1514  if (dirty)
1515  heap_inplace_update(relation, tuple);
1516 
1517  heap_freetuple(tuple);
1518  table_close(relation, RowExclusiveLock);
1519 
1520  /*
1521  * If we were able to advance datfrozenxid or datminmxid, see if we can
1522  * truncate pg_xact and/or pg_multixact. Also do it if the shared
1523  * XID-wrap-limit info is stale, since this action will update that too.
1524  */
1525  if (dirty || ForceTransactionIdLimitUpdate())
1526  vac_truncate_clog(newFrozenXid, newMinMulti,
1527  lastSaneFrozenXid, lastSaneMinMulti);
1528 }
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:167
void systable_endscan(SysScanDesc sysscan)
Definition: genam.c:569
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
uint32 TransactionId
Definition: c.h:575
FormData_pg_database * Form_pg_database
Definition: pg_database.h:81
#define ExclusiveLock
Definition: lockdefs.h:44
void LockDatabaseFrozenIds(LOCKMODE lockmode)
Definition: lmgr.c:469
#define AccessShareLock
Definition: lockdefs.h:36
void heap_freetuple(HeapTuple htup)
Definition: heaptuple.c:1338
SysScanDesc systable_beginscan(Relation heapRelation, Oid indexId, bool indexOK, Snapshot snapshot, int nkeys, ScanKey key)
Definition: genam.c:357
bool ForceTransactionIdLimitUpdate(void)
Definition: varsup.c:490
HeapTuple systable_getnext(SysScanDesc sysscan)
Definition: genam.c:476
TransactionId GetOldestNonRemovableTransactionId(Relation rel)
Definition: procarray.c:1915
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
#define RowExclusiveLock
Definition: lockdefs.h:38
#define MultiXactIdIsValid(multi)
Definition: multixact.h:28
bool TransactionIdPrecedes(TransactionId id1, TransactionId id2)
Definition: transam.c:300
MultiXactId GetOldestMultiXactId(void)
Definition: multixact.c:2501
Oid MyDatabaseId
Definition: globals.c:85
#define InvalidOid
Definition: postgres_ext.h:36
TransactionId MultiXactId
Definition: c.h:585
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define Assert(condition)
Definition: c.h:800
bool MultiXactIdPrecedes(MultiXactId multi1, MultiXactId multi2)
Definition: multixact.c:3146
static void vac_truncate_clog(TransactionId frozenXID, MultiXactId minMulti, TransactionId lastSaneFrozenXid, MultiXactId lastSaneMinMulti)
Definition: vacuum.c:1549
static TransactionId ReadNewTransactionId(void)
Definition: transam.h:308
FormData_pg_class * Form_pg_class
Definition: pg_class.h:153
#define SearchSysCacheCopy1(cacheId, key1)
Definition: syscache.h:174
void heap_inplace_update(Relation relation, HeapTuple tuple)
Definition: heapam.c:5715
#define elog(elevel,...)
Definition: elog.h:228
#define TransactionIdIsValid(xid)
Definition: transam.h:41
#define TransactionIdIsNormal(xid)
Definition: transam.h:42
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
MultiXactId ReadNextMultiXactId(void)
Definition: multixact.c:723

◆ vac_update_relstats()

void vac_update_relstats ( Relation  relation,
BlockNumber  num_pages,
double  num_tuples,
BlockNumber  num_all_visible_pages,
bool  hasindex,
TransactionId  frozenxid,
MultiXactId  minmulti,
bool  in_outer_xact 
)

Definition at line 1224 of file vacuum.c.

References elog, ERROR, GETSTRUCT, heap_inplace_update(), HeapTupleIsValid, MultiXactIdIsValid, MultiXactIdPrecedes(), ObjectIdGetDatum, RelationData::rd_rules, ReadNewTransactionId(), ReadNextMultiXactId(), RelationGetRelid, RELOID, RowExclusiveLock, SearchSysCacheCopy1, table_close(), table_open(), TransactionIdIsNormal, TransactionIdPrecedes(), and RelationData::trigdesc.

Referenced by do_analyze_rel(), heap_vacuum_rel(), and update_index_statistics().

1230 {
1231  Oid relid = RelationGetRelid(relation);
1232  Relation rd;
1233  HeapTuple ctup;
1234  Form_pg_class pgcform;
1235  bool dirty;
1236 
1237  rd = table_open(RelationRelationId, RowExclusiveLock);
1238 
1239  /* Fetch a copy of the tuple to scribble on */
1241  if (!HeapTupleIsValid(ctup))
1242  elog(ERROR, "pg_class entry for relid %u vanished during vacuuming",
1243  relid);
1244  pgcform = (Form_pg_class) GETSTRUCT(ctup);
1245 
1246  /* Apply statistical updates, if any, to copied tuple */
1247 
1248  dirty = false;
1249  if (pgcform->relpages != (int32) num_pages)
1250  {
1251  pgcform->relpages = (int32) num_pages;
1252  dirty = true;
1253  }
1254  if (pgcform->reltuples != (float4) num_tuples)
1255  {
1256  pgcform->reltuples = (float4) num_tuples;
1257  dirty = true;
1258  }
1259  if (pgcform->relallvisible != (int32) num_all_visible_pages)
1260  {
1261  pgcform->relallvisible = (int32) num_all_visible_pages;
1262  dirty = true;
1263  }
1264 
1265  /* Apply DDL updates, but not inside an outer transaction (see above) */
1266 
1267  if (!in_outer_xact)
1268  {
1269  /*
1270  * If we didn't find any indexes, reset relhasindex.
1271  */
1272  if (pgcform->relhasindex && !hasindex)
1273  {
1274  pgcform->relhasindex = false;
1275  dirty = true;
1276  }
1277 
1278  /* We also clear relhasrules and relhastriggers if needed */
1279  if (pgcform->relhasrules && relation->rd_rules == NULL)
1280  {
1281  pgcform->relhasrules = false;
1282  dirty = true;
1283  }
1284  if (pgcform->relhastriggers && relation->trigdesc == NULL)
1285  {
1286  pgcform->relhastriggers = false;
1287  dirty = true;
1288  }
1289  }
1290 
1291  /*
1292  * Update relfrozenxid, unless caller passed InvalidTransactionId
1293  * indicating it has no new data.
1294  *
1295  * Ordinarily, we don't let relfrozenxid go backwards: if things are
1296  * working correctly, the only way the new frozenxid could be older would
1297  * be if a previous VACUUM was done with a tighter freeze_min_age, in
1298  * which case we don't want to forget the work it already did. However,
1299  * if the stored relfrozenxid is "in the future", then it must be corrupt
1300  * and it seems best to overwrite it with the cutoff we used this time.
1301  * This should match vac_update_datfrozenxid() concerning what we consider
1302  * to be "in the future".
1303  */
1304  if (TransactionIdIsNormal(frozenxid) &&
1305  pgcform->relfrozenxid != frozenxid &&
1306  (TransactionIdPrecedes(pgcform->relfrozenxid, frozenxid) ||
1308  pgcform->relfrozenxid)))
1309  {
1310  pgcform->relfrozenxid = frozenxid;
1311  dirty = true;
1312  }
1313 
1314  /* Similarly for relminmxid */
1315  if (MultiXactIdIsValid(minmulti) &&
1316  pgcform->relminmxid != minmulti &&
1317  (MultiXactIdPrecedes(pgcform->relminmxid, minmulti) ||
1318  MultiXactIdPrecedes(ReadNextMultiXactId(), pgcform->relminmxid)))
1319  {
1320  pgcform->relminmxid = minmulti;
1321  dirty = true;
1322  }
1323 
1324  /* If anything changed, write out the tuple. */
1325  if (dirty)
1326  heap_inplace_update(rd, ctup);
1327 
1329 }
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:167
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
unsigned int Oid
Definition: postgres_ext.h:31
signed int int32
Definition: c.h:417
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
TriggerDesc * trigdesc
Definition: rel.h:116
#define RowExclusiveLock
Definition: lockdefs.h:38
#define MultiXactIdIsValid(multi)
Definition: multixact.h:28
bool TransactionIdPrecedes(TransactionId id1, TransactionId id2)
Definition: transam.c:300
float float4
Definition: c.h:552
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
RuleLock * rd_rules
Definition: rel.h:114
bool MultiXactIdPrecedes(MultiXactId multi1, MultiXactId multi2)
Definition: multixact.c:3146
static TransactionId ReadNewTransactionId(void)
Definition: transam.h:308
FormData_pg_class * Form_pg_class
Definition: pg_class.h:153
#define SearchSysCacheCopy1(cacheId, key1)
Definition: syscache.h:174
void heap_inplace_update(Relation relation, HeapTuple tuple)
Definition: heapam.c:5715
#define elog(elevel,...)
Definition: elog.h:228
#define TransactionIdIsNormal(xid)
Definition: transam.h:42
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
#define RelationGetRelid(relation)
Definition: rel.h:457
MultiXactId ReadNextMultiXactId(void)
Definition: multixact.c:723

◆ vacuum()

void vacuum ( List relations,
VacuumParams params,
BufferAccessStrategy  bstrategy,
bool  isTopLevel 
)

Definition at line 272 of file vacuum.c.

References ActiveSnapshotSet(), ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, analyze_rel(), Assert, BAS_VACUUM, CommandCounterIncrement(), CommitTransactionCommand(), cur, ereport, errcode(), errmsg(), ERROR, expand_vacuum_rel(), get_all_vacuum_rels(), GetAccessStrategy(), GetTransactionSnapshot(), IsAutoVacuumWorkerProcess(), IsInTransactionBlock(), lfirst_node, list_concat(), list_length(), MemoryContextDelete(), MemoryContextSwitchTo(), NIL, VacuumRelation::oid, VacuumParams::options, PG_END_TRY, PG_FINALLY, PG_TRY, pgstat_vacuum_stat(), PopActiveSnapshot(), PortalContext, PreventInTransactionBlock(), PushActiveSnapshot(), VacuumRelation::relation, StartTransactionCommand(), VacuumRelation::va_cols, vac_update_datfrozenxid(), VACOPT_ANALYZE, VACOPT_DISABLE_PAGE_SKIPPING, VACOPT_FULL, VACOPT_VACUUM, vacuum_rel(), VacuumCostActive, VacuumCostBalance, VacuumCostBalanceLocal, VacuumCostDelay, VacuumPageDirty, VacuumPageHit, and VacuumPageMiss.

Referenced by autovacuum_do_vac_analyze(), and ExecVacuum().

274 {
275  static bool in_vacuum = false;
276 
277  const char *stmttype;
278  volatile bool in_outer_xact,
279  use_own_xacts;
280 
281  Assert(params != NULL);
282 
283  stmttype = (params->options & VACOPT_VACUUM) ? "VACUUM" : "ANALYZE";
284 
285  /*
286  * We cannot run VACUUM inside a user transaction block; if we were inside
287  * a transaction, then our commit- and start-transaction-command calls
288  * would not have the intended effect! There are numerous other subtle
289  * dependencies on this, too.
290  *
291  * ANALYZE (without VACUUM) can run either way.
292  */
293  if (params->options & VACOPT_VACUUM)
294  {
295  PreventInTransactionBlock(isTopLevel, stmttype);
296  in_outer_xact = false;
297  }
298  else
299  in_outer_xact = IsInTransactionBlock(isTopLevel);
300 
301  /*
302  * Due to static variables vac_context, anl_context and vac_strategy,
303  * vacuum() is not reentrant. This matters when VACUUM FULL or ANALYZE
304  * calls a hostile index expression that itself calls ANALYZE.
305  */
306  if (in_vacuum)
307  ereport(ERROR,
308  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
309  errmsg("%s cannot be executed from VACUUM or ANALYZE",
310  stmttype)));
311 
312  /*
313  * Sanity check DISABLE_PAGE_SKIPPING option.
314  */
315  if ((params->options & VACOPT_FULL) != 0 &&
316  (params->options & VACOPT_DISABLE_PAGE_SKIPPING) != 0)
317  ereport(ERROR,
318  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
319  errmsg("VACUUM option DISABLE_PAGE_SKIPPING cannot be used with FULL")));
320 
321  /*
322  * Send info about dead objects to the statistics collector, unless we are
323  * in autovacuum --- autovacuum.c does this for itself.
324  */
325  if ((params->options & VACOPT_VACUUM) && !IsAutoVacuumWorkerProcess())
327 
328  /*
329  * Create special memory context for cross-transaction storage.
330  *
331  * Since it is a child of PortalContext, it will go away eventually even
332  * if we suffer an error; there's no need for special abort cleanup logic.
333  */
335  "Vacuum",
337 
338  /*
339  * If caller didn't give us a buffer strategy object, make one in the
340  * cross-transaction memory context.
341  */
342  if (bstrategy == NULL)
343  {
345 
346  bstrategy = GetAccessStrategy(BAS_VACUUM);
347  MemoryContextSwitchTo(old_context);
348  }
349  vac_strategy = bstrategy;
350 
351  /*
352  * Build list of relation(s) to process, putting any new data in
353  * vac_context for safekeeping.
354  */
355  if (relations != NIL)
356  {
357  List *newrels = NIL;
358  ListCell *lc;
359 
360  foreach(lc, relations)
361  {
363  List *sublist;
364  MemoryContext old_context;
365 
366  sublist = expand_vacuum_rel(vrel, params->options);
367  old_context = MemoryContextSwitchTo(vac_context);
368  newrels = list_concat(newrels, sublist);
369  MemoryContextSwitchTo(old_context);
370  }
371  relations = newrels;
372  }
373  else
374  relations = get_all_vacuum_rels(params->options);
375 
376  /*
377  * Decide whether we need to start/commit our own transactions.
378  *
379  * For VACUUM (with or without ANALYZE): always do so, so that we can
380  * release locks as soon as possible. (We could possibly use the outer
381  * transaction for a one-table VACUUM, but handling TOAST tables would be
382  * problematic.)
383  *
384  * For ANALYZE (no VACUUM): if inside a transaction block, we cannot
385  * start/commit our own transactions. Also, there's no need to do so if
386  * only processing one relation. For multiple relations when not within a
387  * transaction block, and also in an autovacuum worker, use own
388  * transactions so we can release locks sooner.
389  */
390  if (params->options & VACOPT_VACUUM)
391  use_own_xacts = true;
392  else
393  {
394  Assert(params->options & VACOPT_ANALYZE);
396  use_own_xacts = true;
397  else if (in_outer_xact)
398  use_own_xacts = false;
399  else if (list_length(relations) > 1)
400  use_own_xacts = true;
401  else
402  use_own_xacts = false;
403  }
404 
405  /*
406  * vacuum_rel expects to be entered with no transaction active; it will
407  * start and commit its own transaction. But we are called by an SQL
408  * command, and so we are executing inside a transaction already. We
409  * commit the transaction started in PostgresMain() here, and start
410  * another one before exiting to match the commit waiting for us back in
411  * PostgresMain().
412  */
413  if (use_own_xacts)
414  {
415  Assert(!in_outer_xact);
416 
417  /* ActiveSnapshot is not set by autovacuum */
418  if (ActiveSnapshotSet())
420 
421  /* matches the StartTransaction in PostgresMain() */
423  }
424 
425  /* Turn vacuum cost accounting on or off, and set/clear in_vacuum */
426  PG_TRY();
427  {
428  ListCell *cur;
429 
430  in_vacuum = true;
432  VacuumCostBalance = 0;
433  VacuumPageHit = 0;
434  VacuumPageMiss = 0;
435  VacuumPageDirty = 0;
438  VacuumActiveNWorkers = NULL;
439 
440  /*
441  * Loop to process each selected relation.
442  */
443  foreach(cur, relations)
444  {
446 
447  if (params->options & VACOPT_VACUUM)
448  {
449  if (!vacuum_rel(vrel->oid, vrel->relation, params))
450  continue;
451  }
452 
453  if (params->options & VACOPT_ANALYZE)
454  {
455  /*
456  * If using separate xacts, start one for analyze. Otherwise,
457  * we can use the outer transaction.
458  */
459  if (use_own_xacts)
460  {
462  /* functions in indexes may want a snapshot set */
464  }
465 
466  analyze_rel(vrel->oid, vrel->relation, params,
467  vrel->va_cols, in_outer_xact, vac_strategy);
468 
469  if (use_own_xacts)
470  {
473  }
474  else
475  {
476  /*
477  * If we're not using separate xacts, better separate the
478  * ANALYZE actions with CCIs. This avoids trouble if user
479  * says "ANALYZE t, t".
480  */
482  }
483  }
484  }
485  }
486  PG_FINALLY();
487  {
488  in_vacuum = false;
489  VacuumCostActive = false;
490  }
491  PG_END_TRY();
492 
493  /*
494  * Finish up processing.
495  */
496  if (use_own_xacts)
497  {
498  /* here, we are not in a transaction */
499 
500  /*
501  * This matches the CommitTransaction waiting for us in
502  * PostgresMain().
503  */
505  }
506 
507  if ((params->options & VACOPT_VACUUM) && !IsAutoVacuumWorkerProcess())
508  {
509  /*
510  * Update pg_database.datfrozenxid, and truncate pg_xact if possible.
511  * (autovacuum.c does this for itself.)
512  */
514  }
515 
516  /*
517  * Clean up working storage --- note we must do this after
518  * StartTransactionCommand, else we might be trying to delete the active
519  * context!
520  */
522  vac_context = NULL;
523 }
BufferAccessStrategy GetAccessStrategy(BufferAccessStrategyType btype)
Definition: freelist.c:542
#define NIL
Definition: pg_list.h:65
void analyze_rel(Oid relid, RangeVar *relation, VacuumParams *params, List *va_cols, bool in_outer_xact, BufferAccessStrategy bstrategy)
Definition: analyze.c:119
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:212
#define AllocSetContextCreate
Definition: memutils.h:170
int64 VacuumPageMiss
Definition: globals.c:145
pg_atomic_uint32 * VacuumActiveNWorkers
Definition: vacuum.c:77
int VacuumCostBalance
Definition: globals.c:148
static bool vacuum_rel(Oid relid, RangeVar *relation, VacuumParams *params)
Definition: vacuum.c:1700
RangeVar * relation
Definition: parsenodes.h:3238
void vac_update_datfrozenxid(void)
Definition: vacuum.c:1351
void CommitTransactionCommand(void)
Definition: xact.c:2948
int64 VacuumPageHit
Definition: globals.c:144
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
static BufferAccessStrategy vac_strategy
Definition: vacuum.c:69
struct cursor * cur
Definition: ecpg.c:28
List * list_concat(List *list1, const List *list2)
Definition: list.c:515
int errcode(int sqlerrcode)
Definition: elog.c:691
int64 VacuumPageDirty
Definition: globals.c:146
void PopActiveSnapshot(void)
Definition: snapmgr.c:759
Snapshot GetTransactionSnapshot(void)
Definition: snapmgr.c:250
static List * expand_vacuum_rel(VacuumRelation *vrel, int options)
Definition: vacuum.c:719
MemoryContext PortalContext
Definition: mcxt.c:53
#define ERROR
Definition: elog.h:43
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:192
#define lfirst_node(type, lc)
Definition: pg_list.h:172
void PushActiveSnapshot(Snapshot snap)
Definition: snapmgr.c:680
static MemoryContext vac_context
Definition: vacuum.c:68
void PreventInTransactionBlock(bool isTopLevel, const char *stmtType)
Definition: xact.c:3381
bool ActiveSnapshotSet(void)
Definition: snapmgr.c:798
bool IsAutoVacuumWorkerProcess(void)
Definition: autovacuum.c:3325
void pgstat_vacuum_stat(void)
Definition: pgstat.c:1066
bool IsInTransactionBlock(bool isTopLevel)
Definition: xact.c:3494
int VacuumCostBalanceLocal
Definition: vacuum.c:78
pg_atomic_uint32 * VacuumSharedCostBalance
Definition: vacuum.c:76
#define PG_FINALLY()
Definition: elog.h:326
void CommandCounterIncrement(void)
Definition: xact.c:1021
#define ereport(elevel,...)
Definition: elog.h:155
#define Assert(condition)
Definition: c.h:800
void StartTransactionCommand(void)
Definition: xact.c:2847
static int list_length(const List *l)
Definition: pg_list.h:149
int errmsg(const char *fmt,...)
Definition: elog.c:902
double VacuumCostDelay
Definition: globals.c:142
int options
Definition: vacuum.h:210
#define PG_TRY()
Definition: elog.h:309
Definition: pg_list.h:50
#define PG_END_TRY()
Definition: elog.h:334
bool VacuumCostActive
Definition: globals.c:149
static List * get_all_vacuum_rels(int options)
Definition: vacuum.c:858

◆ vacuum_delay_point()

void vacuum_delay_point ( void  )

Definition at line 2029 of file vacuum.c.

References AutoVacuumUpdateDelay(), CHECK_FOR_INTERRUPTS, compute_parallel_delay(), InterruptPending, pg_usleep(), pgstat_report_wait_end(), pgstat_report_wait_start(), VacuumCostActive, VacuumCostBalance, VacuumCostDelay, VacuumCostLimit, and WAIT_EVENT_VACUUM_DELAY.

Referenced by acquire_sample_rows(), blbulkdelete(), blvacuumcleanup(), btvacuumpage(), compute_array_stats(), compute_distinct_stats(), compute_index_stats(), compute_range_stats(), compute_scalar_stats(), compute_trivial_stats(), compute_tsvector_stats(), file_acquire_sample_rows(), ginbulkdelete(), ginInsertCleanup(), ginvacuumcleanup(), gistvacuumpage(), hashbucketcleanup(), lazy_scan_heap(), lazy_vacuum_heap(), spgprocesspending(), and spgvacuumpage().

2030 {
2031  double msec = 0;
2032 
2033  /* Always check for interrupts */
2035 
2037  return;
2038 
2039  /*
2040  * For parallel vacuum, the delay is computed based on the shared cost
2041  * balance. See compute_parallel_delay.
2042  */
2043  if (VacuumSharedCostBalance != NULL)
2044  msec = compute_parallel_delay();
2045  else if (VacuumCostBalance >= VacuumCostLimit)
2047 
2048  /* Nap if appropriate */
2049  if (msec > 0)
2050  {
2051  if (msec > VacuumCostDelay * 4)
2052  msec = VacuumCostDelay * 4;
2053 
2055  pg_usleep((long) (msec * 1000));
2057 
2058  VacuumCostBalance = 0;
2059 
2060  /* update balance values for workers */
2062 
2063  /* Might have gotten an interrupt while sleeping */
2065  }
2066 }
static double compute_parallel_delay(void)
Definition: vacuum.c:2091
int VacuumCostBalance
Definition: globals.c:148
void pg_usleep(long microsec)
Definition: signal.c:53
int VacuumCostLimit
Definition: globals.c:141
static void pgstat_report_wait_end(void)
Definition: pgstat.h:1466
pg_atomic_uint32 * VacuumSharedCostBalance
Definition: vacuum.c:76
static void pgstat_report_wait_start(uint32 wait_event_info)
Definition: pgstat.h:1442
volatile sig_atomic_t InterruptPending
Definition: globals.c:30
double VacuumCostDelay
Definition: globals.c:142
void AutoVacuumUpdateDelay(void)
Definition: autovacuum.c:1775
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:99
bool VacuumCostActive
Definition: globals.c:149

◆ vacuum_is_relation_owner()

bool vacuum_is_relation_owner ( Oid  relid,
Form_pg_class  reltuple,
int  options 
)

Definition at line 533 of file vacuum.c.

References Assert, ereport, errmsg(), GetUserId(), MyDatabaseId, NameStr, pg_class_ownercheck(), pg_database_ownercheck(), relname, VACOPT_ANALYZE, VACOPT_VACUUM, and WARNING.

Referenced by analyze_rel(), expand_vacuum_rel(), get_all_vacuum_rels(), and vacuum_rel().

534 {
535  char *relname;
536 
538 
539  /*
540  * Check permissions.
541  *
542  * We allow the user to vacuum or analyze a table if he is superuser, the
543  * table owner, or the database owner (but in the latter case, only if
544  * it's not a shared relation). pg_class_ownercheck includes the
545  * superuser case.
546  *
547  * Note we choose to treat permissions failure as a WARNING and keep
548  * trying to vacuum or analyze the rest of the DB --- is this appropriate?
549  */
550  if (pg_class_ownercheck(relid, GetUserId()) ||
551  (pg_database_ownercheck(MyDatabaseId, GetUserId()) && !reltuple->relisshared))
552  return true;
553 
554  relname = NameStr(reltuple->relname);
555 
556  if ((options & VACOPT_VACUUM) != 0)
557  {
558  if (reltuple->relisshared)
560  (errmsg("skipping \"%s\" --- only superuser can vacuum it",
561  relname)));
562  else if (reltuple->relnamespace == PG_CATALOG_NAMESPACE)
564  (errmsg("skipping \"%s\" --- only superuser or database owner can vacuum it",
565  relname)));
566  else
568  (errmsg("skipping \"%s\" --- only table or database owner can vacuum it",
569  relname)));
570 
571  /*
572  * For VACUUM ANALYZE, both logs could show up, but just generate
573  * information for VACUUM as that would be the first one to be
574  * processed.
575  */
576  return false;
577  }
578 
579  if ((options & VACOPT_ANALYZE) != 0)
580  {
581  if (reltuple->relisshared)
583  (errmsg("skipping \"%s\" --- only superuser can analyze it",
584  relname)));
585  else if (reltuple->relnamespace == PG_CATALOG_NAMESPACE)
587  (errmsg("skipping \"%s\" --- only superuser or database owner can analyze it",
588  relname)));
589  else
591  (errmsg("skipping \"%s\" --- only table or database owner can analyze it",
592  relname)));
593  }
594 
595  return false;
596 }
Oid GetUserId(void)
Definition: miscinit.c:476
NameData relname
Definition: pg_class.h:38
bool pg_database_ownercheck(Oid db_oid, Oid roleid)
Definition: aclchk.c:5105
#define WARNING
Definition: elog.h:40
Oid MyDatabaseId
Definition: globals.c:85
#define ereport(elevel,...)
Definition: elog.h:155
#define Assert(condition)
Definition: c.h:800
bool pg_class_ownercheck(Oid class_oid, Oid roleid)
Definition: aclchk.c:4687
int errmsg(const char *fmt,...)
Definition: elog.c:902
#define NameStr(name)
Definition: c.h:677

◆ vacuum_open_relation()

Relation vacuum_open_relation ( Oid  relid,
RangeVar relation,
int  options,
bool  verbose,
LOCKMODE  lmode 
)

Definition at line 607 of file vacuum.c.

References Assert, ConditionalLockRelationOid(), elevel, ereport, errcode(), ERRCODE_UNDEFINED_TABLE, errmsg(), IsAutoVacuumWorkerProcess(), LOG, NoLock, RangeVar::relname, try_relation_open(), VACOPT_ANALYZE, VACOPT_SKIP_LOCKED, VACOPT_VACUUM, and WARNING.

Referenced by analyze_rel(), and vacuum_rel().

609 {
610  Relation onerel;
611  bool rel_lock = true;
612  int elevel;
613 
615 
616  /*
617  * Open the relation and get the appropriate lock on it.
618  *
619  * There's a race condition here: the relation may have gone away since
620  * the last time we saw it. If so, we don't need to vacuum or analyze it.
621  *
622  * If we've been asked not to wait for the relation lock, acquire it first
623  * in non-blocking mode, before calling try_relation_open().
624  */
625  if (!(options & VACOPT_SKIP_LOCKED))
626  onerel = try_relation_open(relid, lmode);
627  else if (ConditionalLockRelationOid(relid, lmode))
628  onerel = try_relation_open(relid, NoLock);
629  else
630  {
631  onerel = NULL;
632  rel_lock = false;
633  }
634 
635  /* if relation is opened, leave */
636  if (onerel)
637  return onerel;
638 
639  /*
640  * Relation could not be opened, hence generate if possible a log
641  * informing on the situation.
642  *
643  * If the RangeVar is not defined, we do not have enough information to
644  * provide a meaningful log statement. Chances are that the caller has
645  * intentionally not provided this information so that this logging is
646  * skipped, anyway.
647  */
648  if (relation == NULL)
649  return NULL;
650 
651  /*
652  * Determine the log level.
653  *
654  * For manual VACUUM or ANALYZE, we emit a WARNING to match the log
655  * statements in the permission checks; otherwise, only log if the caller
656  * so requested.
657  */
659  elevel = WARNING;
660  else if (verbose)
661  elevel = LOG;
662  else
663  return NULL;
664 
665  if ((options & VACOPT_VACUUM) != 0)
666  {
667  if (!rel_lock)
668  ereport(elevel,
669  (errcode(ERRCODE_LOCK_NOT_AVAILABLE),
670  errmsg("skipping vacuum of \"%s\" --- lock not available",
671  relation->relname)));
672  else
673  ereport(elevel,
675  errmsg("skipping vacuum of \"%s\" --- relation no longer exists",
676  relation->relname)));
677 
678  /*
679  * For VACUUM ANALYZE, both logs could show up, but just generate
680  * information for VACUUM as that would be the first one to be
681  * processed.
682  */
683  return NULL;
684  }
685 
686  if ((options & VACOPT_ANALYZE) != 0)
687  {
688  if (!rel_lock)
689  ereport(elevel,
690  (errcode(ERRCODE_LOCK_NOT_AVAILABLE),
691  errmsg("skipping analyze of \"%s\" --- lock not available",
692  relation->relname)));
693  else
694  ereport(elevel,
696  errmsg("skipping analyze of \"%s\" --- relation no longer exists",
697  relation->relname)));
698  }
699 
700  return NULL;
701 }
bool ConditionalLockRelationOid(Oid relid, LOCKMODE lockmode)
Definition: lmgr.c:151
#define ERRCODE_UNDEFINED_TABLE
Definition: pgbench.c:74
int errcode(int sqlerrcode)
Definition: elog.c:691
#define LOG
Definition: elog.h:26
Relation try_relation_open(Oid relationId, LOCKMODE lockmode)
Definition: relation.c:89
char * relname
Definition: primnodes.h:68
#define NoLock
Definition: lockdefs.h:34
bool IsAutoVacuumWorkerProcess(void)
Definition: autovacuum.c:3325
static int verbose
#define WARNING
Definition: elog.h:40
static int elevel
Definition: vacuumlazy.c:333
#define ereport(elevel,...)
Definition: elog.h:155
#define Assert(condition)
Definition: c.h:800
int errmsg(const char *fmt,...)
Definition: elog.c:902

◆ vacuum_rel()

static bool vacuum_rel ( Oid  relid,
RangeVar relation,
VacuumParams params 
)
static

Definition at line 1700 of file vacuum.c.

References AccessExclusiveLock, Assert, AtEOXact_GUC(), CHECK_FOR_INTERRUPTS, CLUOPT_VERBOSE, cluster_rel(), CommitTransactionCommand(), ereport, errmsg(), GetTransactionSnapshot(), GetUserIdAndSecContext(), VacuumParams::index_cleanup, InvalidOid, VacuumParams::is_wraparound, LockRelationIdForSession(), LockInfoData::lockRelId, VacuumParams::log_min_duration, LW_SHARED, LWLockAcquire(), LWLockRelease(), MyProc, NewGUCNestLevel(), NoLock, VacuumParams::options, PGPROC::pgxactoff, PopActiveSnapshot(), PROC_IN_VACUUM, PROC_VACUUM_FOR_WRAPAROUND, ProcGlobal, PushActiveSnapshot(), RelationData::rd_lockInfo, RelationData::rd_options, RelationData::rd_rel, relation_close(), RELATION_IS_OTHER_TEMP, RelationGetRelationName, RelationGetRelid, SECURITY_RESTRICTED_OPERATION, SetUserIdAndSecContext(), ShareUpdateExclusiveLock, StartTransactionCommand(), PGPROC::statusFlags, PROC_HDR::statusFlags, table_relation_vacuum(), VacuumParams::truncate, UnlockRelationIdForSession(), VACOPT_FULL, VACOPT_SKIPTOAST, VACOPT_TERNARY_DEFAULT, VACOPT_TERNARY_DISABLED, VACOPT_TERNARY_ENABLED, VACOPT_VACUUM, VACOPT_VERBOSE, vacuum_is_relation_owner(), vacuum_open_relation(), and WARNING.

Referenced by vacuum().

1701 {
1702  LOCKMODE lmode;
1703  Relation onerel;
1704  LockRelId onerelid;
1705  Oid toast_relid;
1706  Oid save_userid;
1707  int save_sec_context;
1708  int save_nestlevel;
1709 
1710  Assert(params != NULL);
1711 
1712  /* Begin a transaction for vacuuming this relation */
1714 
1715  /*
1716  * Need to acquire a snapshot to prevent pg_subtrans from being truncated,
1717  * cutoff xids in local memory wrapping around, and to have updated xmin
1718  * horizons.
1719  */
1721 
1722  if (!(params->options & VACOPT_FULL))
1723  {
1724  /*
1725  * In lazy vacuum, we can set the PROC_IN_VACUUM flag, which lets
1726  * other concurrent VACUUMs know that they can ignore this one while
1727  * determining their OldestXmin. (The reason we don't set it during a
1728  * full VACUUM is exactly that we may have to run user-defined
1729  * functions for functional indexes, and we want to make sure that if
1730  * they use the snapshot set above, any tuples it requires can't get
1731  * removed from other tables. An index function that depends on the
1732  * contents of other tables is arguably broken, but we won't break it
1733  * here by violating transaction semantics.)
1734  *
1735  * We also set the VACUUM_FOR_WRAPAROUND flag, which is passed down by
1736  * autovacuum; it's used to avoid canceling a vacuum that was invoked
1737  * in an emergency.
1738  *
1739  * Note: these flags remain set until CommitTransaction or
1740  * AbortTransaction. We don't want to clear them until we reset
1741  * MyProc->xid/xmin, otherwise GetOldestNonRemovableTransactionId()
1742  * might appear to go backwards, which is probably Not Good.
1743  */
1744  LWLockAcquire(ProcArrayLock, LW_SHARED);
1746  if (params->is_wraparound)
1749  LWLockRelease(ProcArrayLock);
1750  }
1751 
1752  /*
1753  * Check for user-requested abort. Note we want this to be inside a
1754  * transaction, so xact.c doesn't issue useless WARNING.
1755  */
1757 
1758  /*
1759  * Determine the type of lock we want --- hard exclusive lock for a FULL
1760  * vacuum, but just ShareUpdateExclusiveLock for concurrent vacuum. Either
1761  * way, we can be sure that no other backend is vacuuming the same table.
1762  */
1763  lmode = (params->options & VACOPT_FULL) ?
1765 
1766  /* open the relation and get the appropriate lock on it */
1767  onerel = vacuum_open_relation(relid, relation, params->options,
1768  params->log_min_duration >= 0, lmode);
1769 
1770  /* leave if relation could not be opened or locked */
1771  if (!onerel)
1772  {
1775  return false;
1776  }
1777 
1778  /*
1779  * Check if relation needs to be skipped based on ownership. This check
1780  * happens also when building the relation list to vacuum for a manual
1781  * operation, and needs to be done additionally here as VACUUM could
1782  * happen across multiple transactions where relation ownership could have
1783  * changed in-between. Make sure to only generate logs for VACUUM in this
1784  * case.
1785  */
1787  onerel->rd_rel,
1788  params->options & VACOPT_VACUUM))
1789  {
1790  relation_close(onerel, lmode);
1793  return false;
1794  }
1795 
1796  /*
1797  * Check that it's of a vacuumable relkind.
1798  */
1799  if (onerel->rd_rel->relkind != RELKIND_RELATION &&
1800  onerel->rd_rel->relkind != RELKIND_MATVIEW &&
1801  onerel->rd_rel->relkind != RELKIND_TOASTVALUE &&
1802  onerel->rd_rel->relkind != RELKIND_PARTITIONED_TABLE)
1803  {
1804  ereport(WARNING,
1805  (errmsg("skipping \"%s\" --- cannot vacuum non-tables or special system tables",
1806  RelationGetRelationName(onerel))));
1807  relation_close(onerel, lmode);
1810  return false;
1811  }
1812 
1813  /*
1814  * Silently ignore tables that are temp tables of other backends ---
1815  * trying to vacuum these will lead to great unhappiness, since their
1816  * contents are probably not up-to-date on disk. (We don't throw a
1817  * warning here; it would just lead to chatter during a database-wide
1818  * VACUUM.)
1819  */
1820  if (RELATION_IS_OTHER_TEMP(onerel))
1821  {
1822  relation_close(onerel, lmode);
1825  return false;
1826  }
1827 
1828  /*
1829  * Silently ignore partitioned tables as there is no work to be done. The
1830  * useful work is on their child partitions, which have been queued up for
1831  * us separately.
1832  */
1833  if (onerel->rd_rel->relkind == RELKIND_PARTITIONED_TABLE)
1834  {
1835  relation_close(onerel, lmode);
1838  /* It's OK to proceed with ANALYZE on this table */
1839  return true;
1840  }
1841 
1842  /*
1843  * Get a session-level lock too. This will protect our access to the
1844  * relation across multiple transactions, so that we can vacuum the
1845  * relation's TOAST table (if any) secure in the knowledge that no one is
1846  * deleting the parent relation.
1847  *
1848  * NOTE: this cannot block, even if someone else is waiting for access,
1849  * because the lock manager knows that both lock requests are from the
1850  * same process.
1851  */
1852  onerelid = onerel->rd_lockInfo.lockRelId;
1853  LockRelationIdForSession(&onerelid, lmode);
1854 
1855  /* Set index cleanup option based on reloptions if not yet */
1856  if (params->index_cleanup == VACOPT_TERNARY_DEFAULT)
1857  {
1858  if (onerel->rd_options == NULL ||
1859  ((StdRdOptions *) onerel->rd_options)->vacuum_index_cleanup)
1861  else
1863  }
1864 
1865  /* Set truncate option based on reloptions if not yet */
1866  if (params->truncate == VACOPT_TERNARY_DEFAULT)
1867  {
1868  if (onerel->rd_options == NULL ||
1869  ((StdRdOptions *) onerel->rd_options)->vacuum_truncate)
1870  params->truncate = VACOPT_TERNARY_ENABLED;
1871  else
1873  }
1874 
1875  /*
1876  * Remember the relation's TOAST relation for later, if the caller asked
1877  * us to process it. In VACUUM FULL, though, the toast table is
1878  * automatically rebuilt by cluster_rel so we shouldn't recurse to it.
1879  */
1880  if (!(params->options & VACOPT_SKIPTOAST) && !(params->options & VACOPT_FULL))
1881  toast_relid = onerel->rd_rel->reltoastrelid;
1882  else
1883  toast_relid = InvalidOid;
1884 
1885  /*
1886  * Switch to the table owner's userid, so that any index functions are run
1887  * as that user. Also lock down security-restricted operations and
1888  * arrange to make GUC variable changes local to this command. (This is
1889  * unnecessary, but harmless, for lazy VACUUM.)
1890  */
1891  GetUserIdAndSecContext(&save_userid, &save_sec_context);
1892  SetUserIdAndSecContext(onerel->rd_rel->relowner,
1893  save_sec_context | SECURITY_RESTRICTED_OPERATION);
1894  save_nestlevel = NewGUCNestLevel();
1895 
1896  /*
1897  * Do the actual work --- either FULL or "lazy" vacuum
1898  */
1899  if (params->options & VACOPT_FULL)
1900  {
1901  int cluster_options = 0;
1902 
1903  /* close relation before vacuuming, but hold lock until commit */
1904  relation_close(onerel, NoLock);
1905  onerel = NULL;
1906 
1907  if ((params->options & VACOPT_VERBOSE) != 0)
1908  cluster_options |= CLUOPT_VERBOSE;
1909 
1910  /* VACUUM FULL is now a variant of CLUSTER; see cluster.c */
1911  cluster_rel(relid, InvalidOid, cluster_options);
1912  }
1913  else
1914  table_relation_vacuum(onerel, params, vac_strategy);
1915 
1916  /* Roll back any GUC changes executed by index functions */
1917  AtEOXact_GUC(false, save_nestlevel);
1918 
1919  /* Restore userid and security context */
1920  SetUserIdAndSecContext(save_userid, save_sec_context);
1921 
1922  /* all done with this class, but hold lock until commit */
1923  if (onerel)
1924  relation_close(onerel, NoLock);
1925 
1926  /*
1927  * Complete the transaction and free all temporary memory used.
1928  */
1931 
1932  /*
1933  * If the relation has a secondary toast rel, vacuum that too while we
1934  * still hold the session lock on the main table. Note however that
1935  * "analyze" will not get done on the toast table. This is good, because
1936  * the toaster always uses hardcoded index access and statistics are
1937  * totally unimportant for toast relations.
1938  */
1939  if (toast_relid != InvalidOid)
1940  vacuum_rel(toast_relid, NULL, params);
1941 
1942  /*
1943  * Now release the session-level lock on the main table.
1944  */
1945  UnlockRelationIdForSession(&onerelid, lmode);
1946 
1947  /* Report that we really did it. */
1948  return true;
1949 }
LockRelId lockRelId
Definition: rel.h:44
static bool vacuum_rel(Oid relid, RangeVar *relation, VacuumParams *params)
Definition: vacuum.c:1700
#define SECURITY_RESTRICTED_OPERATION
Definition: miscadmin.h:299
void SetUserIdAndSecContext(Oid userid, int sec_context)
Definition: miscinit.c:588
int LOCKMODE
Definition: lockdefs.h:26
PGPROC * MyProc
Definition: proc.c:67
void CommitTransactionCommand(void)
Definition: xact.c:2948
#define PROC_VACUUM_FOR_WRAPAROUND
Definition: proc.h:56
static void table_relation_vacuum(Relation rel, struct VacuumParams *params, BufferAccessStrategy bstrategy)
Definition: tableam.h:1482
static BufferAccessStrategy vac_strategy
Definition: vacuum.c:69
PROC_HDR * ProcGlobal
Definition: proc.c:79
uint8 statusFlags
Definition: proc.h:183
void PopActiveSnapshot(void)
Definition: snapmgr.c:759
Form_pg_class rd_rel
Definition: rel.h:110
unsigned int Oid
Definition: postgres_ext.h:31
Snapshot GetTransactionSnapshot(void)
Definition: snapmgr.c:250
void cluster_rel(Oid tableOid, Oid indexOid, int options)
Definition: cluster.c:253
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1811
#define PROC_IN_VACUUM
Definition: proc.h:55
void UnlockRelationIdForSession(LockRelId *relid, LOCKMODE lockmode)
Definition: lmgr.c:382
Definition: rel.h:36
void LockRelationIdForSession(LockRelId *relid, LOCKMODE lockmode)
Definition: lmgr.c:369
bool is_wraparound
Definition: vacuum.h:217
bool vacuum_is_relation_owner(Oid relid, Form_pg_class reltuple, int options)
Definition: vacuum.c:533
#define NoLock
Definition: lockdefs.h:34
LockInfoData rd_lockInfo
Definition: rel.h:113
void PushActiveSnapshot(Snapshot snap)
Definition: snapmgr.c:680
Relation vacuum_open_relation(Oid relid, RangeVar *relation, int options, bool verbose, LOCKMODE lmode)
Definition: vacuum.c:607
void GetUserIdAndSecContext(Oid *userid, int *sec_context)
Definition: miscinit.c:581
void AtEOXact_GUC(bool isCommit, int nestLevel)
Definition: guc.c:5956
#define RelationGetRelationName(relation)
Definition: rel.h:491
VacOptTernaryValue index_cleanup
Definition: vacuum.h:221
#define WARNING
Definition: elog.h:40
#define InvalidOid
Definition: postgres_ext.h:36
VacOptTernaryValue truncate
Definition: vacuum.h:223
#define ereport(elevel,...)
Definition: elog.h:155
#define ShareUpdateExclusiveLock
Definition: lockdefs.h:39
void relation_close(Relation relation, LOCKMODE lockmode)
Definition: relation.c:206
#define Assert(condition)
Definition: c.h:800
#define RELATION_IS_OTHER_TEMP(relation)
Definition: rel.h:594
void StartTransactionCommand(void)
Definition: xact.c:2847
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1207
int log_min_duration
Definition: vacuum.h:218
#define AccessExclusiveLock
Definition: lockdefs.h:45
int NewGUCNestLevel(void)
Definition: guc.c:5942
int errmsg(const char *fmt,...)
Definition: elog.c:902
int options
Definition: vacuum.h:210
int pgxactoff
Definition: proc.h:144
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:99
uint8 * statusFlags
Definition: proc.h:327
#define RelationGetRelid(relation)
Definition: rel.h:457
bytea * rd_options
Definition: rel.h:158

◆ vacuum_set_xid_limits()

void vacuum_set_xid_limits ( Relation  rel,
int  freeze_min_age,
int  freeze_table_age,
int  multixact_freeze_min_age,
int  multixact_freeze_table_age,
TransactionId oldestXmin,
TransactionId freezeLimit,
TransactionId xidFullScanLimit,
MultiXactId multiXactCutoff,
MultiXactId mxactFullScanLimit 
)

Definition at line 931 of file vacuum.c.

References Assert, autovacuum_freeze_max_age, ereport, errhint(), errmsg(), FirstMultiXactId, FirstNormalTransactionId, GetOldestMultiXactId(), GetOldestNonRemovableTransactionId(), Min, MultiXactIdPrecedes(), MultiXactMemberFreezeThreshold(), OldSnapshotThresholdActive(), ReadNewTransactionId(), ReadNextMultiXactId(), SetOldSnapshotThresholdTimestamp(), TransactionIdIsNormal, TransactionIdLimitedForOldSnapshots(), TransactionIdPrecedes(), vacuum_freeze_min_age, vacuum_freeze_table_age, vacuum_multixact_freeze_min_age, vacuum_multixact_freeze_table_age, and WARNING.

Referenced by copy_table_data(), and heap_vacuum_rel().

941 {
942  int freezemin;
943  int mxid_freezemin;
944  int effective_multixact_freeze_max_age;
945  TransactionId limit;
946  TransactionId safeLimit;
947  MultiXactId oldestMxact;
948  MultiXactId mxactLimit;
949  MultiXactId safeMxactLimit;
950 
951  /*
952  * We can always ignore processes running lazy vacuum. This is because we
953  * use these values only for deciding which tuples we must keep in the
954  * tables. Since lazy vacuum doesn't write its XID anywhere (usually no
955  * XID assigned), it's safe to ignore it. In theory it could be
956  * problematic to ignore lazy vacuums in a full vacuum, but keep in mind
957  * that only one vacuum process can be working on a particular table at
958  * any time, and that each vacuum is always an independent transaction.
959  */
960  *oldestXmin = GetOldestNonRemovableTransactionId(rel);
961 
963  {
964  TransactionId limit_xmin;
965  TimestampTz limit_ts;
966 
967  if (TransactionIdLimitedForOldSnapshots(*oldestXmin, rel,
968  &limit_xmin, &limit_ts))
969  {
970  /*
971  * TODO: We should only set the threshold if we are pruning on the
972  * basis of the increased limits. Not as crucial here as it is
973  * for opportunistic pruning (which often happens at a much higher
974  * frequency), but would still be a significant improvement.
975  */
976  SetOldSnapshotThresholdTimestamp(limit_ts, limit_xmin);
977  *oldestXmin = limit_xmin;
978  }
979  }
980 
981  Assert(TransactionIdIsNormal(*oldestXmin));
982 
983  /*
984  * Determine the minimum freeze age to use: as specified by the caller, or
985  * vacuum_freeze_min_age, but in any case not more than half
986  * autovacuum_freeze_max_age, so that autovacuums to prevent XID
987  * wraparound won't occur too frequently.
988  */
989  freezemin = freeze_min_age;
990  if (freezemin < 0)
991  freezemin = vacuum_freeze_min_age;
992  freezemin = Min(freezemin, autovacuum_freeze_max_age / 2);
993  Assert(freezemin >= 0);
994 
995  /*
996  * Compute the cutoff XID, being careful not to generate a "permanent" XID
997  */
998  limit = *oldestXmin - freezemin;
999  if (!TransactionIdIsNormal(limit))
1000  limit = FirstNormalTransactionId;
1001 
1002  /*
1003  * If oldestXmin is very far back (in practice, more than
1004  * autovacuum_freeze_max_age / 2 XIDs old), complain and force a minimum
1005  * freeze age of zero.
1006  */
1008  if (!TransactionIdIsNormal(safeLimit))
1009  safeLimit = FirstNormalTransactionId;
1010 
1011  if (TransactionIdPrecedes(limit, safeLimit))
1012  {
1013  ereport(WARNING,
1014  (errmsg("oldest xmin is far in the past"),
1015  errhint("Close open transactions soon to avoid wraparound problems.\n"
1016  "You might also need to commit or roll back old prepared transactions, or drop stale replication slots.")));
1017  limit = *oldestXmin;
1018  }
1019 
1020  *freezeLimit = limit;
1021 
1022  /*
1023  * Compute the multixact age for which freezing is urgent. This is
1024  * normally autovacuum_multixact_freeze_max_age, but may be less if we are
1025  * short of multixact member space.
1026  */
1027  effective_multixact_freeze_max_age = MultiXactMemberFreezeThreshold();
1028 
1029  /*
1030  * Determine the minimum multixact freeze age to use: as specified by
1031  * caller, or vacuum_multixact_freeze_min_age, but in any case not more
1032  * than half effective_multixact_freeze_max_age, so that autovacuums to
1033  * prevent MultiXact wraparound won't occur too frequently.
1034  */
1035  mxid_freezemin = multixact_freeze_min_age;
1036  if (mxid_freezemin < 0)
1037  mxid_freezemin = vacuum_multixact_freeze_min_age;
1038  mxid_freezemin = Min(mxid_freezemin,
1039  effective_multixact_freeze_max_age / 2);
1040  Assert(mxid_freezemin >= 0);
1041 
1042  /* compute the cutoff multi, being careful to generate a valid value */
1043  oldestMxact = GetOldestMultiXactId();
1044  mxactLimit = oldestMxact - mxid_freezemin;
1045  if (mxactLimit < FirstMultiXactId)
1046  mxactLimit = FirstMultiXactId;
1047 
1048  safeMxactLimit =
1049  ReadNextMultiXactId() - effective_multixact_freeze_max_age;
1050  if (safeMxactLimit < FirstMultiXactId)
1051  safeMxactLimit = FirstMultiXactId;
1052 
1053  if (MultiXactIdPrecedes(mxactLimit, safeMxactLimit))
1054  {
1055  ereport(WARNING,
1056  (errmsg("oldest multixact is far in the past"),
1057  errhint("Close open transactions with multixacts soon to avoid wraparound problems.")));
1058  /* Use the safe limit, unless an older mxact is still running */
1059  if (MultiXactIdPrecedes(oldestMxact, safeMxactLimit))
1060  mxactLimit = oldestMxact;
1061  else
1062  mxactLimit = safeMxactLimit;
1063  }
1064 
1065  *multiXactCutoff = mxactLimit;
1066 
1067  if (xidFullScanLimit != NULL)
1068  {
1069  int freezetable;
1070 
1071  Assert(mxactFullScanLimit != NULL);
1072 
1073  /*
1074  * Determine the table freeze age to use: as specified by the caller,
1075  * or vacuum_freeze_table_age, but in any case not more than
1076  * autovacuum_freeze_max_age * 0.95, so that if you have e.g nightly
1077  * VACUUM schedule, the nightly VACUUM gets a chance to freeze tuples
1078  * before anti-wraparound autovacuum is launched.
1079  */
1080  freezetable = freeze_table_age;
1081  if (freezetable < 0)
1082  freezetable = vacuum_freeze_table_age;
1083  freezetable = Min(freezetable, autovacuum_freeze_max_age * 0.95);
1084  Assert(freezetable >= 0);
1085 
1086  /*
1087  * Compute XID limit causing a full-table vacuum, being careful not to
1088  * generate a "permanent" XID.
1089  */
1090  limit = ReadNewTransactionId() - freezetable;
1091  if (!TransactionIdIsNormal(limit))
1092  limit = FirstNormalTransactionId;
1093 
1094  *xidFullScanLimit = limit;
1095 
1096  /*
1097  * Similar to the above, determine the table freeze age to use for
1098  * multixacts: as specified by the caller, or
1099  * vacuum_multixact_freeze_table_age, but in any case not more than
1100  * autovacuum_multixact_freeze_table_age * 0.95, so that if you have
1101  * e.g. nightly VACUUM schedule, the nightly VACUUM gets a chance to
1102  * freeze multixacts before anti-wraparound autovacuum is launched.
1103  */
1104  freezetable = multixact_freeze_table_age;
1105  if (freezetable < 0)
1106  freezetable = vacuum_multixact_freeze_table_age;
1107  freezetable = Min(freezetable,
1108  effective_multixact_freeze_max_age * 0.95);
1109  Assert(freezetable >= 0);
1110 
1111  /*
1112  * Compute MultiXact limit causing a full-table vacuum, being careful
1113  * to generate a valid MultiXact value.
1114  */
1115  mxactLimit = ReadNextMultiXactId() - freezetable;
1116  if (mxactLimit < FirstMultiXactId)
1117  mxactLimit = FirstMultiXactId;
1118 
1119  *mxactFullScanLimit = mxactLimit;
1120  }
1121  else
1122  {
1123  Assert(mxactFullScanLimit == NULL);
1124  }
1125 }
int errhint(const char *fmt,...)
Definition: elog.c:1149
int vacuum_multixact_freeze_table_age
Definition: vacuum.c:64
uint32 TransactionId
Definition: c.h:575
int64 TimestampTz
Definition: timestamp.h:39
static bool OldSnapshotThresholdActive(void)
Definition: snapmgr.h:102
#define Min(x, y)
Definition: c.h:982
bool TransactionIdLimitedForOldSnapshots(TransactionId recentXmin, Relation relation, TransactionId *limit_xid, TimestampTz *limit_ts)
Definition: snapmgr.c:1751
void SetOldSnapshotThresholdTimestamp(TimestampTz ts, TransactionId xlimit)
Definition: snapmgr.c:1672
TransactionId GetOldestNonRemovableTransactionId(Relation rel)
Definition: procarray.c:1915
#define FirstNormalTransactionId
Definition: transam.h:34
int autovacuum_freeze_max_age
Definition: autovacuum.c:124
int vacuum_multixact_freeze_min_age
Definition: vacuum.c:63
#define FirstMultiXactId
Definition: multixact.h:25
int MultiXactMemberFreezeThreshold(void)
Definition: multixact.c:2823
bool TransactionIdPrecedes(TransactionId id1, TransactionId id2)
Definition: transam.c:300
#define WARNING
Definition: elog.h:40
MultiXactId GetOldestMultiXactId(void)
Definition: multixact.c:2501
#define ereport(elevel,...)
Definition: elog.h:155
TransactionId MultiXactId
Definition: c.h:585
#define Assert(condition)
Definition: c.h:800
int vacuum_freeze_min_age
Definition: vacuum.c:61
bool MultiXactIdPrecedes(MultiXactId multi1, MultiXactId multi2)
Definition: multixact.c:3146
int vacuum_freeze_table_age
Definition: vacuum.c:62
static TransactionId ReadNewTransactionId(void)
Definition: transam.h:308
int errmsg(const char *fmt,...)
Definition: elog.c:902
#define TransactionIdIsNormal(xid)
Definition: transam.h:42
MultiXactId ReadNextMultiXactId(void)
Definition: multixact.c:723

Variable Documentation

◆ vac_context

MemoryContext vac_context = NULL
static

Definition at line 68 of file vacuum.c.

◆ vac_strategy

BufferAccessStrategy vac_strategy
static

Definition at line 69 of file vacuum.c.

◆ vacuum_freeze_min_age

int vacuum_freeze_min_age

Definition at line 61 of file vacuum.c.

Referenced by do_autovacuum(), and vacuum_set_xid_limits().

◆ vacuum_freeze_table_age

int vacuum_freeze_table_age

Definition at line 62 of file vacuum.c.

Referenced by do_autovacuum(), and vacuum_set_xid_limits().

◆ vacuum_multixact_freeze_min_age

int vacuum_multixact_freeze_min_age

Definition at line 63 of file vacuum.c.

Referenced by do_autovacuum(), and vacuum_set_xid_limits().

◆ vacuum_multixact_freeze_table_age

int vacuum_multixact_freeze_table_age

Definition at line 64 of file vacuum.c.

Referenced by do_autovacuum(), and vacuum_set_xid_limits().

◆ VacuumActiveNWorkers

pg_atomic_uint32* VacuumActiveNWorkers = NULL

◆ VacuumCostBalanceLocal

int VacuumCostBalanceLocal = 0

◆ VacuumSharedCostBalance

pg_atomic_uint32* VacuumSharedCostBalance = NULL

Definition at line 76 of file vacuum.c.

Referenced by lazy_parallel_vacuum_indexes(), and parallel_vacuum_main().