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.

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)
bool	AutoVacuumRequestWork (AutoVacuumWorkItemType type, Oid relationId, BlockNumber blkno)
Size	AutoVacuumShmemSize (void)
void	AutoVacuumShmemInit (void)

Variables
PGDLLIMPORT bool	autovacuum_start_daemon
PGDLLIMPORT int	autovacuum_max_workers
PGDLLIMPORT int	autovacuum_work_mem
PGDLLIMPORT int	autovacuum_naptime
PGDLLIMPORT int	autovacuum_vac_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

Macro Definition Documentation

IsAnyAutoVacuumProcess

#define IsAnyAutoVacuumProcess

(

)

(IsAutoVacuumLauncherProcess() || IsAutoVacuumWorkerProcess())

Definition at line 55 of file autovacuum.h.

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 3377 of file autovacuum.c.

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

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

Referenced by PostmasterMain().

AutoVacuumingActive()

bool AutoVacuumingActive

(

void

)

Definition at line 3323 of file autovacuum.c.

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

References autovacuum_start_daemon, and pgstat_track_counts.

Referenced by AutoVacLauncherMain(), HandleAutoVacLauncherInterrupts(), process_pm_child_exit(), relation_needs_vacanalyze(), and ServerLoop().

AutoVacuumRequestWork()

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

Definition at line 3335 of file autovacuum.c.

{
    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;
}

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 3427 of file autovacuum.c.

{
    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);
            pg_atomic_init_flag(&worker[i].wi_dobalance);
        }
 
        pg_atomic_init_u32(&AutoVacuumShmem->av_nworkersForBalance, 0);
 
    }
    else
        Assert(found);
}

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

Referenced by CreateSharedMemoryAndSemaphores().

AutoVacuumShmemSize()

Size AutoVacuumShmemSize

(

void

)

Definition at line 3408 of file autovacuum.c.

{
    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;
}

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

Referenced by AutoVacuumShmemInit(), and CalculateShmemSize().

AutoVacWorkerFailed()

void AutoVacWorkerFailed

(

void

)

Definition at line 1417 of file autovacuum.c.

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

References AutoVacForkFailed, AutoVacuumShmem, and AutoVacuumShmemStruct::av_signal.

Referenced by StartAutovacuumWorker().

IsAutoVacuumLauncherProcess()

bool IsAutoVacuumLauncherProcess

(

void

)

Definition at line 3391 of file autovacuum.c.

{
    return am_autovacuum_launcher;
}

References am_autovacuum_launcher.

Referenced by InitPostgres(), InitProcess(), and ProcKill().

IsAutoVacuumWorkerProcess()

bool IsAutoVacuumWorkerProcess

(

void

)

Definition at line 3397 of file autovacuum.c.

{
    return am_autovacuum_worker;
}

References am_autovacuum_worker.

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

StartAutoVacLauncher()

int StartAutoVacLauncher

(

void

)

Referenced by process_pm_child_exit(), and ServerLoop().

StartAutoVacWorker()

int StartAutoVacWorker

(

void

)

Definition at line 1477 of file autovacuum.c.

{
    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;
}

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

Referenced by StartAutovacuumWorker().

Variable Documentation

autovacuum_anl_scale

PGDLLIMPORT double autovacuum_anl_scale

extern

Definition at line 125 of file autovacuum.c.

Referenced by relation_needs_vacanalyze().

autovacuum_anl_thresh

PGDLLIMPORT int autovacuum_anl_thresh

extern

Definition at line 124 of file autovacuum.c.

Referenced by relation_needs_vacanalyze().

autovacuum_freeze_max_age

PGDLLIMPORT int autovacuum_freeze_max_age

extern

Definition at line 126 of file autovacuum.c.

Referenced by do_start_worker(), relation_needs_vacanalyze(), SetTransactionIdLimit(), vacuum_get_cutoffs(), and vacuum_xid_failsafe_check().

autovacuum_max_workers

PGDLLIMPORT int autovacuum_max_workers

extern

Definition at line 117 of file autovacuum.c.

Referenced by AutoVacuumShmemInit(), AutoVacuumShmemSize(), check_max_connections(), check_max_wal_senders(), check_max_worker_processes(), InitializeMaxBackends(), InitProcGlobal(), and MaxLivePostmasterChildren().

autovacuum_multixact_freeze_max_age

PGDLLIMPORT int autovacuum_multixact_freeze_max_age

extern

Definition at line 127 of file autovacuum.c.

Referenced by MultiXactMemberFreezeThreshold(), SetMultiXactIdLimit(), and vacuum_xid_failsafe_check().

autovacuum_naptime

PGDLLIMPORT int autovacuum_naptime

extern

Definition at line 119 of file autovacuum.c.

Referenced by AutoVacLauncherMain(), do_start_worker(), launch_worker(), launcher_determine_sleep(), and rebuild_database_list().

autovacuum_start_daemon

PGDLLIMPORT bool autovacuum_start_daemon

extern

Definition at line 116 of file autovacuum.c.

Referenced by autovac_init(), and AutoVacuumingActive().

autovacuum_vac_cost_delay

PGDLLIMPORT double autovacuum_vac_cost_delay

extern

Definition at line 129 of file autovacuum.c.

Referenced by VacuumUpdateCosts().

autovacuum_vac_cost_limit

PGDLLIMPORT int autovacuum_vac_cost_limit

extern

Definition at line 130 of file autovacuum.c.

Referenced by AutoVacuumUpdateCostLimit().

autovacuum_vac_ins_scale

PGDLLIMPORT double autovacuum_vac_ins_scale

extern

Definition at line 123 of file autovacuum.c.

Referenced by relation_needs_vacanalyze().

autovacuum_vac_ins_thresh

PGDLLIMPORT int autovacuum_vac_ins_thresh

extern

Definition at line 122 of file autovacuum.c.

Referenced by relation_needs_vacanalyze().

autovacuum_vac_scale

PGDLLIMPORT double autovacuum_vac_scale

extern

Definition at line 121 of file autovacuum.c.

Referenced by relation_needs_vacanalyze().

autovacuum_vac_thresh

PGDLLIMPORT int autovacuum_vac_thresh

extern

Definition at line 120 of file autovacuum.c.

Referenced by relation_needs_vacanalyze().

autovacuum_work_mem

PGDLLIMPORT int autovacuum_work_mem

extern

Definition at line 118 of file autovacuum.c.

Referenced by dead_items_max_items(), and ginInsertCleanup().

AutovacuumLauncherPid

PGDLLIMPORT int AutovacuumLauncherPid

extern

Definition at line 316 of file autovacuum.c.

Referenced by FreeWorkerInfo(), and ProcKill().

Log_autovacuum_min_duration

PGDLLIMPORT int Log_autovacuum_min_duration

extern

Definition at line 132 of file autovacuum.c.

Referenced by table_recheck_autovac().