PostgreSQL Source Code git master
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
autovacuum.h File Reference
#include "storage/block.h"
Include dependency graph for autovacuum.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations

enum  AutoVacuumWorkItemType { AVW_BRINSummarizeRange }
 

Functions

bool AutoVacuumingActive (void)
 
void autovac_init (void)
 
void AutoVacWorkerFailed (void)
 
pg_noreturn void AutoVacLauncherMain (const void *startup_data, size_t startup_data_len)
 
pg_noreturn void AutoVacWorkerMain (const void *startup_data, size_t startup_data_len)
 
bool AutoVacuumRequestWork (AutoVacuumWorkItemType type, Oid relationId, BlockNumber blkno)
 
Size AutoVacuumShmemSize (void)
 
void AutoVacuumShmemInit (void)
 

Variables

PGDLLIMPORT bool autovacuum_start_daemon
 
PGDLLIMPORT int autovacuum_worker_slots
 
PGDLLIMPORT int autovacuum_max_workers
 
PGDLLIMPORT int autovacuum_work_mem
 
PGDLLIMPORT int autovacuum_naptime
 
PGDLLIMPORT int autovacuum_vac_thresh
 
PGDLLIMPORT int autovacuum_vac_max_thresh
 
PGDLLIMPORT double autovacuum_vac_scale
 
PGDLLIMPORT int autovacuum_vac_ins_thresh
 
PGDLLIMPORT double autovacuum_vac_ins_scale
 
PGDLLIMPORT int autovacuum_anl_thresh
 
PGDLLIMPORT double autovacuum_anl_scale
 
PGDLLIMPORT int autovacuum_freeze_max_age
 
PGDLLIMPORT int autovacuum_multixact_freeze_max_age
 
PGDLLIMPORT double autovacuum_vac_cost_delay
 
PGDLLIMPORT int autovacuum_vac_cost_limit
 
PGDLLIMPORT int AutovacuumLauncherPid
 
PGDLLIMPORT int Log_autovacuum_min_duration
 
PGDLLIMPORT int Log_autoanalyze_min_duration
 

Enumeration Type Documentation

◆ AutoVacuumWorkItemType

Enumerator
AVW_BRINSummarizeRange 

Definition at line 23 of file autovacuum.h.

24{
AutoVacuumWorkItemType
Definition: autovacuum.h:24
@ AVW_BRINSummarizeRange
Definition: autovacuum.h:25

Function Documentation

◆ autovac_init()

void autovac_init ( void  )

Definition at line 3368 of file autovacuum.c.

3369{
3371 return;
3372 else if (!pgstat_track_counts)
3374 (errmsg("autovacuum not started because of misconfiguration"),
3375 errhint("Enable the \"track_counts\" option.")));
3376 else
3378}
static void check_av_worker_gucs(void)
Definition: autovacuum.c:3492
bool autovacuum_start_daemon
Definition: autovacuum.c:117
int errhint(const char *fmt,...)
Definition: elog.c:1330
int errmsg(const char *fmt,...)
Definition: elog.c:1080
#define WARNING
Definition: elog.h:36
#define ereport(elevel,...)
Definition: elog.h:150
bool pgstat_track_counts
Definition: pgstat.c:203

References autovacuum_start_daemon, check_av_worker_gucs(), ereport, errhint(), errmsg(), pgstat_track_counts, and WARNING.

Referenced by PostmasterMain().

◆ AutoVacLauncherMain()

pg_noreturn void AutoVacLauncherMain ( const void *  startup_data,
size_t  startup_data_len 
)

Definition at line 378 of file autovacuum.c.

379{
380 sigjmp_buf local_sigjmp_buf;
381
382 Assert(startup_data_len == 0);
383
384 /* Release postmaster's working memory context */
386 {
388 PostmasterContext = NULL;
389 }
390
392 init_ps_display(NULL);
393
395 (errmsg_internal("autovacuum launcher started")));
396
397 if (PostAuthDelay)
398 pg_usleep(PostAuthDelay * 1000000L);
399
401
402 /*
403 * Set up signal handlers. We operate on databases much like a regular
404 * backend, so we use the same signal handling. See equivalent code in
405 * tcop/postgres.c.
406 */
410 /* SIGQUIT handler was already set up by InitPostmasterChild */
411
412 InitializeTimeouts(); /* establishes SIGALRM handler */
413
414 pqsignal(SIGPIPE, SIG_IGN);
418 pqsignal(SIGCHLD, SIG_DFL);
419
420 /*
421 * Create a per-backend PGPROC struct in shared memory. We must do this
422 * before we can use LWLocks or access any shared memory.
423 */
424 InitProcess();
425
426 /* Early initialization */
427 BaseInit();
428
429 InitPostgres(NULL, InvalidOid, NULL, InvalidOid, 0, NULL);
430
432
433 /*
434 * Create a memory context that we will do all our work in. We do this so
435 * that we can reset the context during error recovery and thereby avoid
436 * possible memory leaks.
437 */
439 "Autovacuum Launcher",
442
443 /*
444 * If an exception is encountered, processing resumes here.
445 *
446 * This code is a stripped down version of PostgresMain error recovery.
447 *
448 * Note that we use sigsetjmp(..., 1), so that the prevailing signal mask
449 * (to wit, BlockSig) will be restored when longjmp'ing to here. Thus,
450 * signals other than SIGQUIT will be blocked until we complete error
451 * recovery. It might seem that this policy makes the HOLD_INTERRUPTS()
452 * call redundant, but it is not since InterruptPending might be set
453 * already.
454 */
455 if (sigsetjmp(local_sigjmp_buf, 1) != 0)
456 {
457 /* since not using PG_TRY, must reset error stack by hand */
458 error_context_stack = NULL;
459
460 /* Prevents interrupts while cleaning up */
462
463 /* Forget any pending QueryCancel or timeout request */
465 QueryCancelPending = false; /* second to avoid race condition */
466
467 /* Report the error to the server log */
469
470 /* Abort the current transaction in order to recover */
472
473 /*
474 * Release any other resources, for the case where we were not in a
475 * transaction.
476 */
481 /* this is probably dead code, but let's be safe: */
484 AtEOXact_Buffers(false);
486 AtEOXact_Files(false);
487 AtEOXact_HashTables(false);
488
489 /*
490 * Now return to normal top-level context and clear ErrorContext for
491 * next time.
492 */
495
496 /* Flush any leaked data in the top-level context */
498
499 /* don't leave dangling pointers to freed memory */
500 DatabaseListCxt = NULL;
502
503 /* Now we can allow interrupts again */
505
506 /* if in shutdown mode, no need for anything further; just go away */
509
510 /*
511 * Sleep at least 1 second after any error. We don't want to be
512 * filling the error logs as fast as we can.
513 */
514 pg_usleep(1000000L);
515 }
516
517 /* We can now handle ereport(ERROR) */
518 PG_exception_stack = &local_sigjmp_buf;
519
520 /* must unblock signals before calling rebuild_database_list */
521 sigprocmask(SIG_SETMASK, &UnBlockSig, NULL);
522
523 /*
524 * Set always-secure search path. Launcher doesn't connect to a database,
525 * so this has no effect.
526 */
527 SetConfigOption("search_path", "", PGC_SUSET, PGC_S_OVERRIDE);
528
529 /*
530 * Force zero_damaged_pages OFF in the autovac process, even if it is set
531 * in postgresql.conf. We don't really want such a dangerous option being
532 * applied non-interactively.
533 */
534 SetConfigOption("zero_damaged_pages", "false", PGC_SUSET, PGC_S_OVERRIDE);
535
536 /*
537 * Force settable timeouts off to avoid letting these settings prevent
538 * regular maintenance from being executed.
539 */
540 SetConfigOption("statement_timeout", "0", PGC_SUSET, PGC_S_OVERRIDE);
541 SetConfigOption("transaction_timeout", "0", PGC_SUSET, PGC_S_OVERRIDE);
542 SetConfigOption("lock_timeout", "0", PGC_SUSET, PGC_S_OVERRIDE);
543 SetConfigOption("idle_in_transaction_session_timeout", "0",
545
546 /*
547 * Force default_transaction_isolation to READ COMMITTED. We don't want
548 * to pay the overhead of serializable mode, nor add any risk of causing
549 * deadlocks or delaying other transactions.
550 */
551 SetConfigOption("default_transaction_isolation", "read committed",
553
554 /*
555 * Even when system is configured to use a different fetch consistency,
556 * for autovac we always want fresh stats.
557 */
558 SetConfigOption("stats_fetch_consistency", "none", PGC_SUSET, PGC_S_OVERRIDE);
559
560 /*
561 * In emergency mode, just start a worker (unless shutdown was requested)
562 * and go away.
563 */
564 if (!AutoVacuumingActive())
565 {
568 proc_exit(0); /* done */
569 }
570
572
573 /*
574 * Create the initial database list. The invariant we want this list to
575 * keep is that it's ordered by decreasing next_worker. As soon as an
576 * entry is updated to a higher time, it will be moved to the front (which
577 * is correct because the only operation is to add autovacuum_naptime to
578 * the entry, and time always increases).
579 */
581
582 /* loop until shutdown request */
584 {
585 struct timeval nap;
586 TimestampTz current_time = 0;
587 bool can_launch;
588
589 /*
590 * This loop is a bit different from the normal use of WaitLatch,
591 * because we'd like to sleep before the first launch of a child
592 * process. So it's WaitLatch, then ResetLatch, then check for
593 * wakening conditions.
594 */
595
597
598 /*
599 * Wait until naptime expires or we get some type of signal (all the
600 * signal handlers will wake us by calling SetLatch).
601 */
602 (void) WaitLatch(MyLatch,
604 (nap.tv_sec * 1000L) + (nap.tv_usec / 1000L),
605 WAIT_EVENT_AUTOVACUUM_MAIN);
606
608
610
611 /*
612 * a worker finished, or postmaster signaled failure to start a worker
613 */
614 if (got_SIGUSR2)
615 {
616 got_SIGUSR2 = false;
617
618 /* rebalance cost limits, if needed */
620 {
621 LWLockAcquire(AutovacuumLock, LW_EXCLUSIVE);
624 LWLockRelease(AutovacuumLock);
625 }
626
628 {
629 /*
630 * If the postmaster failed to start a new worker, we sleep
631 * for a little while and resend the signal. The new worker's
632 * state is still in memory, so this is sufficient. After
633 * that, we restart the main loop.
634 *
635 * XXX should we put a limit to the number of times we retry?
636 * I don't think it makes much sense, because a future start
637 * of a worker will continue to fail in the same way.
638 */
640 pg_usleep(1000000L); /* 1s */
642 continue;
643 }
644 }
645
646 /*
647 * There are some conditions that we need to check before trying to
648 * start a worker. First, we need to make sure that there is a worker
649 * slot available. Second, we need to make sure that no other worker
650 * failed while starting up.
651 */
652
653 current_time = GetCurrentTimestamp();
654 LWLockAcquire(AutovacuumLock, LW_SHARED);
655
656 can_launch = av_worker_available();
657
659 {
660 int waittime;
662
663 /*
664 * We can't launch another worker when another one is still
665 * starting up (or failed while doing so), so just sleep for a bit
666 * more; that worker will wake us up again as soon as it's ready.
667 * We will only wait autovacuum_naptime seconds (up to a maximum
668 * of 60 seconds) for this to happen however. Note that failure
669 * to connect to a particular database is not a problem here,
670 * because the worker removes itself from the startingWorker
671 * pointer before trying to connect. Problems detected by the
672 * postmaster (like fork() failure) are also reported and handled
673 * differently. The only problems that may cause this code to
674 * fire are errors in the earlier sections of AutoVacWorkerMain,
675 * before the worker removes the WorkerInfo from the
676 * startingWorker pointer.
677 */
678 waittime = Min(autovacuum_naptime, 60) * 1000;
679 if (TimestampDifferenceExceeds(worker->wi_launchtime, current_time,
680 waittime))
681 {
682 LWLockRelease(AutovacuumLock);
683 LWLockAcquire(AutovacuumLock, LW_EXCLUSIVE);
684
685 /*
686 * No other process can put a worker in starting mode, so if
687 * startingWorker is still INVALID after exchanging our lock,
688 * we assume it's the same one we saw above (so we don't
689 * recheck the launch time).
690 */
692 {
694 worker->wi_dboid = InvalidOid;
695 worker->wi_tableoid = InvalidOid;
696 worker->wi_sharedrel = false;
697 worker->wi_proc = NULL;
698 worker->wi_launchtime = 0;
700 &worker->wi_links);
703 errmsg("autovacuum worker took too long to start; canceled"));
704 }
705 }
706 else
707 can_launch = false;
708 }
709 LWLockRelease(AutovacuumLock); /* either shared or exclusive */
710
711 /* if we can't do anything, just go back to sleep */
712 if (!can_launch)
713 continue;
714
715 /* We're OK to start a new worker */
716
718 {
719 /*
720 * Special case when the list is empty: start a worker right away.
721 * This covers the initial case, when no database is in pgstats
722 * (thus the list is empty). Note that the constraints in
723 * launcher_determine_sleep keep us from starting workers too
724 * quickly (at most once every autovacuum_naptime when the list is
725 * empty).
726 */
727 launch_worker(current_time);
728 }
729 else
730 {
731 /*
732 * because rebuild_database_list constructs a list with most
733 * distant adl_next_worker first, we obtain our database from the
734 * tail of the list.
735 */
736 avl_dbase *avdb;
737
738 avdb = dlist_tail_element(avl_dbase, adl_node, &DatabaseList);
739
740 /*
741 * launch a worker if next_worker is right now or it is in the
742 * past
743 */
745 current_time, 0))
746 launch_worker(current_time);
747 }
748 }
749
751}
void pgaio_error_cleanup(void)
Definition: aio.c:1165
static Oid do_start_worker(void)
Definition: autovacuum.c:1104
static void launcher_determine_sleep(bool canlaunch, bool recursing, struct timeval *nap)
Definition: autovacuum.c:819
static volatile sig_atomic_t got_SIGUSR2
Definition: autovacuum.c:155
static void avl_sigusr2_handler(SIGNAL_ARGS)
Definition: autovacuum.c:1375
static bool av_worker_available(void)
Definition: autovacuum.c:3475
int autovacuum_naptime
Definition: autovacuum.c:121
bool AutoVacuumingActive(void)
Definition: autovacuum.c:3314
static pg_noreturn void AutoVacLauncherShutdown(void)
Definition: autovacuum.c:802
@ AutoVacRebalance
Definition: autovacuum.c:252
@ AutoVacForkFailed
Definition: autovacuum.c:251
static void launch_worker(TimestampTz now)
Definition: autovacuum.c:1316
static dlist_head DatabaseList
Definition: autovacuum.c:310
static void rebuild_database_list(Oid newdb)
Definition: autovacuum.c:903
static AutoVacuumShmemStruct * AutoVacuumShmem
Definition: autovacuum.c:304
static MemoryContext DatabaseListCxt
Definition: autovacuum.c:311
static void autovac_recalculate_workers_for_balance(void)
Definition: autovacuum.c:1783
static MemoryContext AutovacMemCxt
Definition: autovacuum.c:168
static void ProcessAutoVacLauncherInterrupts(void)
Definition: autovacuum.c:757
sigset_t UnBlockSig
Definition: pqsignal.c:22
bool TimestampDifferenceExceeds(TimestampTz start_time, TimestampTz stop_time, int msec)
Definition: timestamp.c:1781
TimestampTz GetCurrentTimestamp(void)
Definition: timestamp.c:1645
void AtEOXact_Buffers(bool isCommit)
Definition: bufmgr.c:3990
void UnlockBuffers(void)
Definition: bufmgr.c:5573
#define Min(x, y)
Definition: c.h:1007
int64 TimestampTz
Definition: timestamp.h:39
void AtEOXact_HashTables(bool isCommit)
Definition: dynahash.c:1931
int errmsg_internal(const char *fmt,...)
Definition: elog.c:1170
void EmitErrorReport(void)
Definition: elog.c:1704
ErrorContextCallback * error_context_stack
Definition: elog.c:95
void FlushErrorState(void)
Definition: elog.c:1884
sigjmp_buf * PG_exception_stack
Definition: elog.c:97
#define DEBUG1
Definition: elog.h:30
void AtEOXact_Files(bool isCommit)
Definition: fd.c:3226
int MyProcPid
Definition: globals.c:47
volatile sig_atomic_t QueryCancelPending
Definition: globals.c:33
struct Latch * MyLatch
Definition: globals.c:63
void SetConfigOption(const char *name, const char *value, GucContext context, GucSource source)
Definition: guc.c:4185
@ PGC_S_OVERRIDE
Definition: guc.h:123
@ PGC_SUSET
Definition: guc.h:78
Assert(PointerIsAligned(start, uint64))
static void dlist_init(dlist_head *head)
Definition: ilist.h:314
#define dlist_tail_element(type, membername, lhead)
Definition: ilist.h:612
static bool dlist_is_empty(const dlist_head *head)
Definition: ilist.h:336
static void dclist_push_head(dclist_head *head, dlist_node *node)
Definition: ilist.h:693
void SignalHandlerForShutdownRequest(SIGNAL_ARGS)
Definition: interrupt.c:104
volatile sig_atomic_t ShutdownRequestPending
Definition: interrupt.c:28
void SignalHandlerForConfigReload(SIGNAL_ARGS)
Definition: interrupt.c:61
void proc_exit(int code)
Definition: ipc.c:104
void ResetLatch(Latch *latch)
Definition: latch.c:374
int WaitLatch(Latch *latch, int wakeEvents, long timeout, uint32 wait_event_info)
Definition: latch.c:172
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1174
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1894
void LWLockReleaseAll(void)
Definition: lwlock.c:1945
@ LW_SHARED
Definition: lwlock.h:113
@ LW_EXCLUSIVE
Definition: lwlock.h:112
void MemoryContextReset(MemoryContext context)
Definition: mcxt.c:400
MemoryContext TopMemoryContext
Definition: mcxt.c:166
MemoryContext PostmasterContext
Definition: mcxt.c:168
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:469
#define AllocSetContextCreate
Definition: memutils.h:129
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:160
#define RESUME_INTERRUPTS()
Definition: miscadmin.h:136
@ NormalProcessing
Definition: miscadmin.h:472
@ InitProcessing
Definition: miscadmin.h:471
#define GetProcessingMode()
Definition: miscadmin.h:481
#define HOLD_INTERRUPTS()
Definition: miscadmin.h:134
#define SetProcessingMode(mode)
Definition: miscadmin.h:483
@ B_AUTOVAC_LAUNCHER
Definition: miscadmin.h:344
BackendType MyBackendType
Definition: miscinit.c:64
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:124
void SendPostmasterSignal(PMSignalReason reason)
Definition: pmsignal.c:165
@ PMSIGNAL_START_AUTOVAC_WORKER
Definition: pmsignal.h:40
#define pqsignal
Definition: port.h:531
int PostAuthDelay
Definition: postgres.c:100
void FloatExceptionHandler(SIGNAL_ARGS)
Definition: postgres.c:3079
void StatementCancelHandler(SIGNAL_ARGS)
Definition: postgres.c:3062
#define InvalidOid
Definition: postgres_ext.h:37
void BaseInit(void)
Definition: postinit.c:607
void InitPostgres(const char *in_dbname, Oid dboid, const char *username, Oid useroid, bits32 flags, char *out_dbname)
Definition: postinit.c:707
void procsignal_sigusr1_handler(SIGNAL_ARGS)
Definition: procsignal.c:674
void init_ps_display(const char *fixed_part)
Definition: ps_status.c:285
void ReleaseAuxProcessResources(bool isCommit)
Definition: resowner.c:1016
ResourceOwner AuxProcessResourceOwner
Definition: resowner.c:176
void pg_usleep(long microsec)
Definition: signal.c:53
void AtEOXact_SMgr(void)
Definition: smgr.c:1008
void InitProcess(void)
Definition: proc.c:395
dclist_head av_freeWorkers
Definition: autovacuum.c:297
WorkerInfo av_startingWorker
Definition: autovacuum.c:299
sig_atomic_t av_signal[AutoVacNumSignals]
Definition: autovacuum.c:295
TimestampTz wi_launchtime
Definition: autovacuum.c:237
dlist_node wi_links
Definition: autovacuum.c:233
PGPROC * wi_proc
Definition: autovacuum.c:236
TimestampTz adl_next_worker
Definition: autovacuum.c:174
void disable_all_timeouts(bool keep_indicators)
Definition: timeout.c:751
void InitializeTimeouts(void)
Definition: timeout.c:470
static void pgstat_report_wait_end(void)
Definition: wait_event.h:85
#define WL_TIMEOUT
Definition: waiteventset.h:37
#define WL_EXIT_ON_PM_DEATH
Definition: waiteventset.h:39
#define WL_LATCH_SET
Definition: waiteventset.h:34
#define SIGCHLD
Definition: win32_port.h:168
#define SIGHUP
Definition: win32_port.h:158
#define SIGPIPE
Definition: win32_port.h:163
#define SIGUSR1
Definition: win32_port.h:170
#define SIGUSR2
Definition: win32_port.h:171
void AbortCurrentTransaction(void)
Definition: xact.c:3469

References AbortCurrentTransaction(), avl_dbase::adl_next_worker, ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, Assert(), AtEOXact_Buffers(), AtEOXact_Files(), AtEOXact_HashTables(), AtEOXact_SMgr(), autovac_recalculate_workers_for_balance(), AutoVacForkFailed, AutoVacLauncherShutdown(), AutovacMemCxt, AutoVacRebalance, autovacuum_naptime, AutoVacuumingActive(), AutoVacuumShmem, AuxProcessResourceOwner, AutoVacuumShmemStruct::av_freeWorkers, AutoVacuumShmemStruct::av_launcherpid, AutoVacuumShmemStruct::av_signal, AutoVacuumShmemStruct::av_startingWorker, av_worker_available(), avl_sigusr2_handler(), B_AUTOVAC_LAUNCHER, BaseInit(), DatabaseList, DatabaseListCxt, dclist_push_head(), DEBUG1, disable_all_timeouts(), dlist_init(), dlist_is_empty(), dlist_tail_element, do_start_worker(), EmitErrorReport(), ereport, errmsg(), errmsg_internal(), error_context_stack, FloatExceptionHandler(), FlushErrorState(), GetCurrentTimestamp(), GetProcessingMode, got_SIGUSR2, HOLD_INTERRUPTS, init_ps_display(), InitializeTimeouts(), InitPostgres(), InitProcess(), InitProcessing, InvalidOid, launch_worker(), launcher_determine_sleep(), LW_EXCLUSIVE, LW_SHARED, LWLockAcquire(), LWLockRelease(), LWLockReleaseAll(), MemoryContextDelete(), MemoryContextReset(), MemoryContextSwitchTo(), Min, MyBackendType, MyLatch, MyProcPid, NormalProcessing, PG_exception_stack, pg_usleep(), pgaio_error_cleanup(), PGC_S_OVERRIDE, PGC_SUSET, pgstat_report_wait_end(), PMSIGNAL_START_AUTOVAC_WORKER, PostAuthDelay, PostmasterContext, pqsignal, proc_exit(), ProcessAutoVacLauncherInterrupts(), procsignal_sigusr1_handler(), QueryCancelPending, rebuild_database_list(), ReleaseAuxProcessResources(), ResetLatch(), RESUME_INTERRUPTS, SendPostmasterSignal(), SetConfigOption(), SetProcessingMode, ShutdownRequestPending, SIGCHLD, SIGHUP, SignalHandlerForConfigReload(), SignalHandlerForShutdownRequest(), SIGPIPE, SIGUSR1, SIGUSR2, StatementCancelHandler(), TimestampDifferenceExceeds(), TopMemoryContext, UnBlockSig, UnlockBuffers(), WaitLatch(), WARNING, WorkerInfoData::wi_dboid, WorkerInfoData::wi_launchtime, WorkerInfoData::wi_links, WorkerInfoData::wi_proc, WorkerInfoData::wi_sharedrel, WorkerInfoData::wi_tableoid, WL_EXIT_ON_PM_DEATH, WL_LATCH_SET, and WL_TIMEOUT.

◆ AutoVacuumingActive()

bool AutoVacuumingActive ( void  )

◆ AutoVacuumRequestWork()

bool AutoVacuumRequestWork ( AutoVacuumWorkItemType  type,
Oid  relationId,
BlockNumber  blkno 
)

Definition at line 3326 of file autovacuum.c.

3328{
3329 int i;
3330 bool result = false;
3331
3332 LWLockAcquire(AutovacuumLock, LW_EXCLUSIVE);
3333
3334 /*
3335 * Locate an unused work item and fill it with the given data.
3336 */
3337 for (i = 0; i < NUM_WORKITEMS; i++)
3338 {
3340
3341 if (workitem->avw_used)
3342 continue;
3343
3344 workitem->avw_used = true;
3345 workitem->avw_active = false;
3346 workitem->avw_type = type;
3347 workitem->avw_database = MyDatabaseId;
3348 workitem->avw_relation = relationId;
3349 workitem->avw_blockNumber = blkno;
3350 result = true;
3351
3352 /* done */
3353 break;
3354 }
3355
3356 LWLockRelease(AutovacuumLock);
3357
3358 return result;
3359}
#define NUM_WORKITEMS
Definition: autovacuum.c:273
Oid MyDatabaseId
Definition: globals.c:94
int i
Definition: isn.c:77
AutoVacuumWorkItem av_workItems[NUM_WORKITEMS]
Definition: autovacuum.c:300
BlockNumber avw_blockNumber
Definition: autovacuum.c:270
AutoVacuumWorkItemType avw_type
Definition: autovacuum.c:265
const char * type

References AutoVacuumShmem, AutoVacuumShmemStruct::av_workItems, AutoVacuumWorkItem::avw_active, AutoVacuumWorkItem::avw_blockNumber, AutoVacuumWorkItem::avw_database, AutoVacuumWorkItem::avw_relation, AutoVacuumWorkItem::avw_type, AutoVacuumWorkItem::avw_used, i, LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), MyDatabaseId, NUM_WORKITEMS, and type.

Referenced by brininsert().

◆ AutoVacuumShmemInit()

void AutoVacuumShmemInit ( void  )

Definition at line 3404 of file autovacuum.c.

3405{
3406 bool found;
3407
3409 ShmemInitStruct("AutoVacuum Data",
3411 &found);
3412
3413 if (!IsUnderPostmaster)
3414 {
3415 WorkerInfo worker;
3416 int i;
3417
3418 Assert(!found);
3419
3424 memset(AutoVacuumShmem->av_workItems, 0,
3426
3427 worker = (WorkerInfo) ((char *) AutoVacuumShmem +
3429
3430 /* initialize the WorkerInfo free list */
3431 for (i = 0; i < autovacuum_worker_slots; i++)
3432 {
3434 &worker[i].wi_links);
3435 pg_atomic_init_flag(&worker[i].wi_dobalance);
3436 }
3437
3439
3440 }
3441 else
3442 Assert(found);
3443}
static void pg_atomic_init_u32(volatile pg_atomic_uint32 *ptr, uint32 val)
Definition: atomics.h:219
static void pg_atomic_init_flag(volatile pg_atomic_flag *ptr)
Definition: atomics.h:168
int autovacuum_worker_slots
Definition: autovacuum.c:118
Size AutoVacuumShmemSize(void)
Definition: autovacuum.c:3385
struct WorkerInfoData * WorkerInfo
Definition: autovacuum.c:242
#define MAXALIGN(LEN)
Definition: c.h:814
bool IsUnderPostmaster
Definition: globals.c:120
static void dclist_init(dclist_head *head)
Definition: ilist.h:671
void * ShmemInitStruct(const char *name, Size size, bool *foundPtr)
Definition: shmem.c:388
pg_atomic_uint32 av_nworkersForBalance
Definition: autovacuum.c:301
dlist_head av_runningWorkers
Definition: autovacuum.c:298

References Assert(), autovacuum_worker_slots, AutoVacuumShmem, AutoVacuumShmemSize(), AutoVacuumShmemStruct::av_freeWorkers, AutoVacuumShmemStruct::av_launcherpid, AutoVacuumShmemStruct::av_nworkersForBalance, AutoVacuumShmemStruct::av_runningWorkers, AutoVacuumShmemStruct::av_startingWorker, AutoVacuumShmemStruct::av_workItems, dclist_init(), dclist_push_head(), dlist_init(), i, IsUnderPostmaster, MAXALIGN, NUM_WORKITEMS, pg_atomic_init_flag(), pg_atomic_init_u32(), ShmemInitStruct(), and WorkerInfoData::wi_links.

Referenced by CreateOrAttachShmemStructs().

◆ AutoVacuumShmemSize()

Size AutoVacuumShmemSize ( void  )

Definition at line 3385 of file autovacuum.c.

3386{
3387 Size size;
3388
3389 /*
3390 * Need the fixed struct and the array of WorkerInfoData.
3391 */
3392 size = sizeof(AutoVacuumShmemStruct);
3393 size = MAXALIGN(size);
3395 sizeof(WorkerInfoData)));
3396 return size;
3397}
size_t Size
Definition: c.h:614
Size add_size(Size s1, Size s2)
Definition: shmem.c:494
Size mul_size(Size s1, Size s2)
Definition: shmem.c:511

References add_size(), autovacuum_worker_slots, MAXALIGN, and mul_size().

Referenced by AutoVacuumShmemInit(), and CalculateShmemSize().

◆ AutoVacWorkerFailed()

void AutoVacWorkerFailed ( void  )

Definition at line 1368 of file autovacuum.c.

1369{
1371}

References AutoVacForkFailed, AutoVacuumShmem, and AutoVacuumShmemStruct::av_signal.

Referenced by StartAutovacuumWorker().

◆ AutoVacWorkerMain()

pg_noreturn void AutoVacWorkerMain ( const void *  startup_data,
size_t  startup_data_len 
)

Definition at line 1390 of file autovacuum.c.

1391{
1392 sigjmp_buf local_sigjmp_buf;
1393 Oid dbid;
1394
1395 Assert(startup_data_len == 0);
1396
1397 /* Release postmaster's working memory context */
1399 {
1401 PostmasterContext = NULL;
1402 }
1403
1405 init_ps_display(NULL);
1406
1408
1409 /*
1410 * Set up signal handlers. We operate on databases much like a regular
1411 * backend, so we use the same signal handling. See equivalent code in
1412 * tcop/postgres.c.
1413 */
1415
1416 /*
1417 * SIGINT is used to signal canceling the current table's vacuum; SIGTERM
1418 * means abort and exit cleanly, and SIGQUIT means abandon ship.
1419 */
1421 pqsignal(SIGTERM, die);
1422 /* SIGQUIT handler was already set up by InitPostmasterChild */
1423
1424 InitializeTimeouts(); /* establishes SIGALRM handler */
1425
1426 pqsignal(SIGPIPE, SIG_IGN);
1428 pqsignal(SIGUSR2, SIG_IGN);
1430 pqsignal(SIGCHLD, SIG_DFL);
1431
1432 /*
1433 * Create a per-backend PGPROC struct in shared memory. We must do this
1434 * before we can use LWLocks or access any shared memory.
1435 */
1436 InitProcess();
1437
1438 /* Early initialization */
1439 BaseInit();
1440
1441 /*
1442 * If an exception is encountered, processing resumes here.
1443 *
1444 * Unlike most auxiliary processes, we don't attempt to continue
1445 * processing after an error; we just clean up and exit. The autovac
1446 * launcher is responsible for spawning another worker later.
1447 *
1448 * Note that we use sigsetjmp(..., 1), so that the prevailing signal mask
1449 * (to wit, BlockSig) will be restored when longjmp'ing to here. Thus,
1450 * signals other than SIGQUIT will be blocked until we exit. It might
1451 * seem that this policy makes the HOLD_INTERRUPTS() call redundant, but
1452 * it is not since InterruptPending might be set already.
1453 */
1454 if (sigsetjmp(local_sigjmp_buf, 1) != 0)
1455 {
1456 /* since not using PG_TRY, must reset error stack by hand */
1457 error_context_stack = NULL;
1458
1459 /* Prevents interrupts while cleaning up */
1461
1462 /* Report the error to the server log */
1464
1465 /*
1466 * We can now go away. Note that because we called InitProcess, a
1467 * callback was registered to do ProcKill, which will clean up
1468 * necessary state.
1469 */
1470 proc_exit(0);
1471 }
1472
1473 /* We can now handle ereport(ERROR) */
1474 PG_exception_stack = &local_sigjmp_buf;
1475
1476 sigprocmask(SIG_SETMASK, &UnBlockSig, NULL);
1477
1478 /*
1479 * Set always-secure search path, so malicious users can't redirect user
1480 * code (e.g. pg_index.indexprs). (That code runs in a
1481 * SECURITY_RESTRICTED_OPERATION sandbox, so malicious users could not
1482 * take control of the entire autovacuum worker in any case.)
1483 */
1484 SetConfigOption("search_path", "", PGC_SUSET, PGC_S_OVERRIDE);
1485
1486 /*
1487 * Force zero_damaged_pages OFF in the autovac process, even if it is set
1488 * in postgresql.conf. We don't really want such a dangerous option being
1489 * applied non-interactively.
1490 */
1491 SetConfigOption("zero_damaged_pages", "false", PGC_SUSET, PGC_S_OVERRIDE);
1492
1493 /*
1494 * Force settable timeouts off to avoid letting these settings prevent
1495 * regular maintenance from being executed.
1496 */
1497 SetConfigOption("statement_timeout", "0", PGC_SUSET, PGC_S_OVERRIDE);
1498 SetConfigOption("transaction_timeout", "0", PGC_SUSET, PGC_S_OVERRIDE);
1499 SetConfigOption("lock_timeout", "0", PGC_SUSET, PGC_S_OVERRIDE);
1500 SetConfigOption("idle_in_transaction_session_timeout", "0",
1502
1503 /*
1504 * Force default_transaction_isolation to READ COMMITTED. We don't want
1505 * to pay the overhead of serializable mode, nor add any risk of causing
1506 * deadlocks or delaying other transactions.
1507 */
1508 SetConfigOption("default_transaction_isolation", "read committed",
1510
1511 /*
1512 * Force synchronous replication off to allow regular maintenance even if
1513 * we are waiting for standbys to connect. This is important to ensure we
1514 * aren't blocked from performing anti-wraparound tasks.
1515 */
1517 SetConfigOption("synchronous_commit", "local",
1519
1520 /*
1521 * Even when system is configured to use a different fetch consistency,
1522 * for autovac we always want fresh stats.
1523 */
1524 SetConfigOption("stats_fetch_consistency", "none", PGC_SUSET, PGC_S_OVERRIDE);
1525
1526 /*
1527 * Get the info about the database we're going to work on.
1528 */
1529 LWLockAcquire(AutovacuumLock, LW_EXCLUSIVE);
1530
1531 /*
1532 * beware of startingWorker being INVALID; this should normally not
1533 * happen, but if a worker fails after forking and before this, the
1534 * launcher might have decided to remove it from the queue and start
1535 * again.
1536 */
1538 {
1540 dbid = MyWorkerInfo->wi_dboid;
1542
1543 /* insert into the running list */
1546
1547 /*
1548 * remove from the "starting" pointer, so that the launcher can start
1549 * a new worker if required
1550 */
1552 LWLockRelease(AutovacuumLock);
1553
1555
1556 /* wake up the launcher */
1559 }
1560 else
1561 {
1562 /* no worker entry for me, go away */
1563 elog(WARNING, "autovacuum worker started without a worker entry");
1564 dbid = InvalidOid;
1565 LWLockRelease(AutovacuumLock);
1566 }
1567
1568 if (OidIsValid(dbid))
1569 {
1570 char dbname[NAMEDATALEN];
1571
1572 /*
1573 * Report autovac startup to the cumulative stats system. We
1574 * deliberately do this before InitPostgres, so that the
1575 * last_autovac_time will get updated even if the connection attempt
1576 * fails. This is to prevent autovac from getting "stuck" repeatedly
1577 * selecting an unopenable database, rather than making any progress
1578 * on stuff it can connect to.
1579 */
1581
1582 /*
1583 * Connect to the selected database, specifying no particular user,
1584 * and ignoring datallowconn. Collect the database's name for
1585 * display.
1586 *
1587 * Note: if we have selected a just-deleted database (due to using
1588 * stale stats info), we'll fail and exit here.
1589 */
1590 InitPostgres(NULL, dbid, NULL, InvalidOid,
1592 dbname);
1596 (errmsg_internal("autovacuum: processing database \"%s\"", dbname)));
1597
1598 if (PostAuthDelay)
1599 pg_usleep(PostAuthDelay * 1000000L);
1600
1601 /* And do an appropriate amount of work */
1604 do_autovacuum();
1605 }
1606
1607 /*
1608 * The launcher will be notified of my death in ProcKill, *if* we managed
1609 * to get a worker slot at all
1610 */
1611
1612 /* All done, go away */
1613 proc_exit(0);
1614}
static void FreeWorkerInfo(int code, Datum arg)
Definition: autovacuum.c:1620
static TransactionId recentXid
Definition: autovacuum.c:158
static void do_autovacuum(void)
Definition: autovacuum.c:1899
static MultiXactId recentMulti
Definition: autovacuum.c:159
static WorkerInfo MyWorkerInfo
Definition: autovacuum.c:324
#define OidIsValid(objectId)
Definition: c.h:778
#define elog(elevel,...)
Definition: elog.h:226
static void dlist_push_head(dlist_head *head, dlist_node *node)
Definition: ilist.h:347
void on_shmem_exit(pg_on_exit_callback function, Datum arg)
Definition: ipc.c:365
@ B_AUTOVAC_WORKER
Definition: miscadmin.h:345
#define INIT_PG_OVERRIDE_ALLOW_CONNS
Definition: miscadmin.h:500
MultiXactId ReadNextMultiXactId(void)
Definition: multixact.c:762
#define NAMEDATALEN
#define die(msg)
void pgstat_report_autovac(Oid dboid)
unsigned int Oid
Definition: postgres_ext.h:32
static void set_ps_display(const char *activity)
Definition: ps_status.h:40
PGPROC * MyProc
Definition: proc.c:67
char * dbname
Definition: streamutil.c:49
static TransactionId ReadNextTransactionId(void)
Definition: transam.h:377
#define kill(pid, sig)
Definition: win32_port.h:493
int synchronous_commit
Definition: xact.c:88
@ SYNCHRONOUS_COMMIT_LOCAL_FLUSH
Definition: xact.h:72

References Assert(), AutoVacuumShmem, AutoVacuumShmemStruct::av_launcherpid, AutoVacuumShmemStruct::av_runningWorkers, AutoVacuumShmemStruct::av_startingWorker, B_AUTOVAC_WORKER, BaseInit(), dbname, DEBUG1, die, dlist_push_head(), do_autovacuum(), elog, EmitErrorReport(), ereport, errmsg_internal(), error_context_stack, FloatExceptionHandler(), FreeWorkerInfo(), GetProcessingMode, HOLD_INTERRUPTS, INIT_PG_OVERRIDE_ALLOW_CONNS, init_ps_display(), InitializeTimeouts(), InitPostgres(), InitProcess(), InitProcessing, InvalidOid, kill, LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), MemoryContextDelete(), MyBackendType, MyProc, MyWorkerInfo, NAMEDATALEN, NormalProcessing, OidIsValid, on_shmem_exit(), PG_exception_stack, pg_usleep(), PGC_S_OVERRIDE, PGC_SUSET, pgstat_report_autovac(), PostAuthDelay, PostmasterContext, pqsignal, proc_exit(), procsignal_sigusr1_handler(), ReadNextMultiXactId(), ReadNextTransactionId(), recentMulti, recentXid, set_ps_display(), SetConfigOption(), SetProcessingMode, SIGCHLD, SIGHUP, SignalHandlerForConfigReload(), SIGPIPE, SIGUSR1, SIGUSR2, StatementCancelHandler(), synchronous_commit, SYNCHRONOUS_COMMIT_LOCAL_FLUSH, UnBlockSig, WARNING, WorkerInfoData::wi_dboid, WorkerInfoData::wi_links, and WorkerInfoData::wi_proc.

Variable Documentation

◆ autovacuum_anl_scale

PGDLLIMPORT double autovacuum_anl_scale
extern

Definition at line 128 of file autovacuum.c.

Referenced by relation_needs_vacanalyze().

◆ autovacuum_anl_thresh

PGDLLIMPORT int autovacuum_anl_thresh
extern

Definition at line 127 of file autovacuum.c.

Referenced by relation_needs_vacanalyze().

◆ autovacuum_freeze_max_age

PGDLLIMPORT int autovacuum_freeze_max_age
extern

◆ autovacuum_max_workers

PGDLLIMPORT int autovacuum_max_workers
extern

◆ autovacuum_multixact_freeze_max_age

PGDLLIMPORT int autovacuum_multixact_freeze_max_age
extern

◆ autovacuum_naptime

PGDLLIMPORT int autovacuum_naptime
extern

◆ autovacuum_start_daemon

PGDLLIMPORT bool autovacuum_start_daemon
extern

Definition at line 117 of file autovacuum.c.

Referenced by autovac_init(), AutoVacuumingActive(), and removable_cutoff().

◆ autovacuum_vac_cost_delay

PGDLLIMPORT double autovacuum_vac_cost_delay
extern

Definition at line 132 of file autovacuum.c.

Referenced by VacuumUpdateCosts().

◆ autovacuum_vac_cost_limit

PGDLLIMPORT int autovacuum_vac_cost_limit
extern

Definition at line 133 of file autovacuum.c.

Referenced by AutoVacuumUpdateCostLimit().

◆ autovacuum_vac_ins_scale

PGDLLIMPORT double autovacuum_vac_ins_scale
extern

Definition at line 126 of file autovacuum.c.

Referenced by relation_needs_vacanalyze().

◆ autovacuum_vac_ins_thresh

PGDLLIMPORT int autovacuum_vac_ins_thresh
extern

Definition at line 125 of file autovacuum.c.

Referenced by relation_needs_vacanalyze().

◆ autovacuum_vac_max_thresh

PGDLLIMPORT int autovacuum_vac_max_thresh
extern

Definition at line 123 of file autovacuum.c.

Referenced by relation_needs_vacanalyze().

◆ autovacuum_vac_scale

PGDLLIMPORT double autovacuum_vac_scale
extern

Definition at line 124 of file autovacuum.c.

Referenced by relation_needs_vacanalyze().

◆ autovacuum_vac_thresh

PGDLLIMPORT int autovacuum_vac_thresh
extern

Definition at line 122 of file autovacuum.c.

Referenced by relation_needs_vacanalyze().

◆ autovacuum_work_mem

PGDLLIMPORT int autovacuum_work_mem
extern

Definition at line 120 of file autovacuum.c.

Referenced by dead_items_alloc(), and ginInsertCleanup().

◆ autovacuum_worker_slots

◆ AutovacuumLauncherPid

PGDLLIMPORT int AutovacuumLauncherPid
extern

Definition at line 327 of file autovacuum.c.

Referenced by FreeWorkerInfo(), and ProcKill().

◆ Log_autoanalyze_min_duration

PGDLLIMPORT int Log_autoanalyze_min_duration
extern

Definition at line 136 of file autovacuum.c.

Referenced by table_recheck_autovac().

◆ Log_autovacuum_min_duration

PGDLLIMPORT int Log_autovacuum_min_duration
extern

Definition at line 135 of file autovacuum.c.

Referenced by table_recheck_autovac().