#include "storage/block.h"

Include dependency graph for autovacuum.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	IsAnyAutoVacuumProcess() (IsAutoVacuumLauncherProcess() \|\| IsAutoVacuumWorkerProcess())

Enumerations
enum	AutoVacuumWorkItemType { AVW_BRINSummarizeRange }

Functions
bool	AutoVacuumingActive (void)

bool	IsAutoVacuumLauncherProcess (void)

bool	IsAutoVacuumWorkerProcess (void)

void	autovac_init (void)

int	StartAutoVacLauncher (void)

int	StartAutoVacWorker (void)

void	AutoVacWorkerFailed (void)

void	AutoVacuumUpdateDelay (void)

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

Size	AutoVacuumShmemSize (void)

void	AutoVacuumShmemInit (void)

Variables
bool	autovacuum_start_daemon

int	autovacuum_max_workers

int	autovacuum_work_mem

int	autovacuum_naptime

int	autovacuum_vac_thresh

double	autovacuum_vac_scale

int	autovacuum_anl_thresh

double	autovacuum_anl_scale

int	autovacuum_freeze_max_age

int	autovacuum_multixact_freeze_max_age

double	autovacuum_vac_cost_delay

int	autovacuum_vac_cost_limit

int	AutovacuumLauncherPid

int	Log_autovacuum_min_duration

Macro Definition Documentation

◆ IsAnyAutoVacuumProcess

#define IsAnyAutoVacuumProcess ( ) (IsAutoVacuumLauncherProcess() || IsAutoVacuumWorkerProcess())

Definition at line 53 of file autovacuum.h.

Referenced by InitProcess().

Enumeration Type Documentation

◆ AutoVacuumWorkItemType

enum AutoVacuumWorkItemType

Enumerator
AVW_BRINSummarizeRange

Definition at line 23 of file autovacuum.h.

 {
     AVW_BRINSummarizeRange
 } AutoVacuumWorkItemType;

Function Documentation

◆ autovac_init()

void autovac_init ( void )

Definition at line 3261 of file autovacuum.c.

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

Referenced by PostmasterMain().

 {
     if (autovacuum_start_daemon && !pgstat_track_counts)
         ereport(WARNING,
                 (errmsg("autovacuum not started because of misconfiguration"),
                  errhint("Enable the \"track_counts\" option.")));
 }

◆ AutoVacuumingActive()

bool AutoVacuumingActive ( void )

Definition at line 3207 of file autovacuum.c.

References autovacuum_start_daemon, and pgstat_track_counts.

Referenced by AutoVacLauncherMain(), reaper(), relation_needs_vacanalyze(), and ServerLoop().

 {
     if (!autovacuum_start_daemon || !pgstat_track_counts)
         return false;
     return true;
 }

◆ AutoVacuumRequestWork()

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

Definition at line 3219 of file autovacuum.c.

References 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 generate_unaccent_rules::type.

Referenced by brininsert().

 {
     int         i;
     bool        result = false;
 
     LWLockAcquire(AutovacuumLock, LW_EXCLUSIVE);
 
     /*
      * Locate an unused work item and fill it with the given data.
      */
     for (i = 0; i < NUM_WORKITEMS; i++)
     {
         AutoVacuumWorkItem *workitem = &AutoVacuumShmem->av_workItems[i];
 
         if (workitem->avw_used)
             continue;
 
         workitem->avw_used = true;
         workitem->avw_active = false;
         workitem->avw_type = type;
         workitem->avw_database = MyDatabaseId;
         workitem->avw_relation = relationId;
         workitem->avw_blockNumber = blkno;
         result = true;
 
         /* done */
         break;
     }
 
     LWLockRelease(AutovacuumLock);
 
     return result;
 }

◆ AutoVacuumShmemInit()

void AutoVacuumShmemInit ( void )

Definition at line 3311 of file autovacuum.c.

References Assert, autovacuum_max_workers, AutoVacuumShmemSize(), AutoVacuumShmemStruct::av_freeWorkers, AutoVacuumShmemStruct::av_launcherpid, AutoVacuumShmemStruct::av_runningWorkers, AutoVacuumShmemStruct::av_startingWorker, AutoVacuumShmemStruct::av_workItems, dlist_init(), dlist_push_head(), i, IsUnderPostmaster, MAXALIGN, NUM_WORKITEMS, ShmemInitStruct(), and WorkerInfoData::wi_links.

Referenced by CreateSharedMemoryAndSemaphores().

 {
     bool        found;
 
     AutoVacuumShmem = (AutoVacuumShmemStruct *)
         ShmemInitStruct("AutoVacuum Data",
                         AutoVacuumShmemSize(),
                         &found);
 
     if (!IsUnderPostmaster)
     {
         WorkerInfo  worker;
         int         i;
 
         Assert(!found);
 
         AutoVacuumShmem->av_launcherpid = 0;
         dlist_init(&AutoVacuumShmem->av_freeWorkers);
         dlist_init(&AutoVacuumShmem->av_runningWorkers);
         AutoVacuumShmem->av_startingWorker = NULL;
         memset(AutoVacuumShmem->av_workItems, 0,
                sizeof(AutoVacuumWorkItem) * NUM_WORKITEMS);
 
         worker = (WorkerInfo) ((char *) AutoVacuumShmem +
                                MAXALIGN(sizeof(AutoVacuumShmemStruct)));
 
         /* initialize the WorkerInfo free list */
         for (i = 0; i < autovacuum_max_workers; i++)
             dlist_push_head(&AutoVacuumShmem->av_freeWorkers,
                             &worker[i].wi_links);
     }
     else
         Assert(found);
 }

◆ AutoVacuumShmemSize()

Size AutoVacuumShmemSize ( void )

Definition at line 3292 of file autovacuum.c.

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

Referenced by AutoVacuumShmemInit(), and CreateSharedMemoryAndSemaphores().

 {
     Size        size;
 
     /*
      * Need the fixed struct and the array of WorkerInfoData.
      */
     size = sizeof(AutoVacuumShmemStruct);
     size = MAXALIGN(size);
     size = add_size(size, mul_size(autovacuum_max_workers,
                                    sizeof(WorkerInfoData)));
     return size;
 }

◆ AutoVacuumUpdateDelay()

void AutoVacuumUpdateDelay ( void )

Definition at line 1763 of file autovacuum.c.

References VacuumCostDelay, VacuumCostLimit, WorkerInfoData::wi_cost_delay, and WorkerInfoData::wi_cost_limit.

Referenced by do_autovacuum(), and vacuum_delay_point().

 {
     if (MyWorkerInfo)
     {
         VacuumCostDelay = MyWorkerInfo->wi_cost_delay;
         VacuumCostLimit = MyWorkerInfo->wi_cost_limit;
     }
 }

◆ AutoVacWorkerFailed()

void AutoVacWorkerFailed ( void )

Definition at line 1385 of file autovacuum.c.

References AutoVacForkFailed, and AutoVacuumShmemStruct::av_signal.

Referenced by StartAutovacuumWorker().

 {
     AutoVacuumShmem->av_signal[AutoVacForkFailed] = true;
 }

◆ IsAutoVacuumLauncherProcess()

bool IsAutoVacuumLauncherProcess ( void )

Definition at line 3275 of file autovacuum.c.

References am_autovacuum_launcher.

Referenced by autovac_refresh_stats(), backend_read_statsfile(), InitPostgres(), InitProcess(), pgstat_bestart(), and ProcKill().

 {
     return am_autovacuum_launcher;
 }

◆ IsAutoVacuumWorkerProcess()

bool IsAutoVacuumWorkerProcess ( void )

Definition at line 3281 of file autovacuum.c.

References am_autovacuum_worker.

Referenced by backend_read_statsfile(), BuildRelationExtStatistics(), CheckMyDatabase(), do_analyze_rel(), expand_vacuum_rel(), ginbulkdelete(), ginInsertCleanup(), ginvacuumcleanup(), heap_vacuum_rel(), InitializeSessionUserIdStandalone(), InitPostgres(), InitProcess(), lazy_space_alloc(), pgstat_bestart(), pgstat_report_analyze(), pgstat_report_vacuum(), proc_exit(), ProcessInterrupts(), vacuum(), and vacuum_open_relation().

 {
     return am_autovacuum_worker;
 }

◆ StartAutoVacLauncher()

int StartAutoVacLauncher ( void )

Definition at line 393 of file autovacuum.c.

References AutoVacLauncherMain(), AutoVacPID, ClosePostmasterPorts(), ereport, errmsg(), fork_process(), InitPostmasterChild(), LOG, and NON_EXEC_STATIC.

Referenced by reaper(), and ServerLoop().

 {
     pid_t       AutoVacPID;
 
 #ifdef EXEC_BACKEND
     switch ((AutoVacPID = avlauncher_forkexec()))
 #else
     switch ((AutoVacPID = fork_process()))
 #endif
     {
         case -1:
             ereport(LOG,
                     (errmsg("could not fork autovacuum launcher process: %m")));
             return 0;
 
 #ifndef EXEC_BACKEND
         case 0:
             /* in postmaster child ... */
             InitPostmasterChild();
 
             /* Close the postmaster's sockets */
             ClosePostmasterPorts(false);
 
             AutoVacLauncherMain(0, NULL);
             break;
 #endif
         default:
             return (int) AutoVacPID;
     }
 
     /* shouldn't get here */
     return 0;
 }

◆ StartAutoVacWorker()

int StartAutoVacWorker ( void )

Definition at line 1469 of file autovacuum.c.

References AutoVacWorkerMain(), ClosePostmasterPorts(), ereport, errmsg(), fork_process(), InitPostmasterChild(), LOG, and NON_EXEC_STATIC.

Referenced by StartAutovacuumWorker().

 {
     pid_t       worker_pid;
 
 #ifdef EXEC_BACKEND
     switch ((worker_pid = avworker_forkexec()))
 #else
     switch ((worker_pid = fork_process()))
 #endif
     {
         case -1:
             ereport(LOG,
                     (errmsg("could not fork autovacuum worker process: %m")));
             return 0;
 
 #ifndef EXEC_BACKEND
         case 0:
             /* in postmaster child ... */
             InitPostmasterChild();
 
             /* Close the postmaster's sockets */
             ClosePostmasterPorts(false);
 
             AutoVacWorkerMain(0, NULL);
             break;
 #endif
         default:
             return (int) worker_pid;
     }
 
     /* shouldn't get here */
     return 0;
 }