PostgreSQL Source Code  git master
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)
 
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_vac_ins_thresh
 
double autovacuum_vac_ins_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 55 of file autovacuum.h.

Referenced by InitProcess().

Enumeration Type Documentation

◆ AutoVacuumWorkItemType

Enumerator
AVW_BRINSummarizeRange 

Definition at line 23 of file autovacuum.h.

Function Documentation

◆ autovac_init()

void autovac_init ( void  )

Definition at line 3386 of file autovacuum.c.

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

Referenced by PostmasterMain().

3387 {
3389  ereport(WARNING,
3390  (errmsg("autovacuum not started because of misconfiguration"),
3391  errhint("Enable the \"track_counts\" option.")));
3392 }
int errhint(const char *fmt,...)
Definition: elog.c:1156
bool autovacuum_start_daemon
Definition: autovacuum.c:114
bool pgstat_track_counts
Definition: pgstat.c:115
#define WARNING
Definition: elog.h:40
#define ereport(elevel,...)
Definition: elog.h:157
int errmsg(const char *fmt,...)
Definition: elog.c:909

◆ AutoVacuumingActive()

bool AutoVacuumingActive ( void  )

Definition at line 3332 of file autovacuum.c.

References autovacuum_start_daemon, and pgstat_track_counts.

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

3333 {
3335  return false;
3336  return true;
3337 }
bool autovacuum_start_daemon
Definition: autovacuum.c:114
bool pgstat_track_counts
Definition: pgstat.c:115

◆ AutoVacuumRequestWork()

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

Definition at line 3344 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().

3346 {
3347  int i;
3348  bool result = false;
3349 
3350  LWLockAcquire(AutovacuumLock, LW_EXCLUSIVE);
3351 
3352  /*
3353  * Locate an unused work item and fill it with the given data.
3354  */
3355  for (i = 0; i < NUM_WORKITEMS; i++)
3356  {
3358 
3359  if (workitem->avw_used)
3360  continue;
3361 
3362  workitem->avw_used = true;
3363  workitem->avw_active = false;
3364  workitem->avw_type = type;
3365  workitem->avw_database = MyDatabaseId;
3366  workitem->avw_relation = relationId;
3367  workitem->avw_blockNumber = blkno;
3368  result = true;
3369 
3370  /* done */
3371  break;
3372  }
3373 
3374  LWLockRelease(AutovacuumLock);
3375 
3376  return result;
3377 }
AutoVacuumWorkItemType avw_type
Definition: autovacuum.c:256
#define NUM_WORKITEMS
Definition: autovacuum.c:264
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1803
AutoVacuumWorkItem av_workItems[NUM_WORKITEMS]
Definition: autovacuum.c:289
Oid MyDatabaseId
Definition: globals.c:88
BlockNumber avw_blockNumber
Definition: autovacuum.c:261
static AutoVacuumShmemStruct * AutoVacuumShmem
Definition: autovacuum.c:292
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1199
int i

◆ AutoVacuumShmemInit()

void AutoVacuumShmemInit ( void  )

Definition at line 3436 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().

3437 {
3438  bool found;
3439 
3441  ShmemInitStruct("AutoVacuum Data",
3443  &found);
3444 
3445  if (!IsUnderPostmaster)
3446  {
3447  WorkerInfo worker;
3448  int i;
3449 
3450  Assert(!found);
3451 
3456  memset(AutoVacuumShmem->av_workItems, 0,
3457  sizeof(AutoVacuumWorkItem) * NUM_WORKITEMS);
3458 
3459  worker = (WorkerInfo) ((char *) AutoVacuumShmem +
3460  MAXALIGN(sizeof(AutoVacuumShmemStruct)));
3461 
3462  /* initialize the WorkerInfo free list */
3463  for (i = 0; i < autovacuum_max_workers; i++)
3465  &worker[i].wi_links);
3466  }
3467  else
3468  Assert(found);
3469 }
#define NUM_WORKITEMS
Definition: autovacuum.c:264
WorkerInfo av_startingWorker
Definition: autovacuum.c:288
dlist_head av_freeWorkers
Definition: autovacuum.c:286
static void dlist_push_head(dlist_head *head, dlist_node *node)
Definition: ilist.h:300
struct WorkerInfoData * WorkerInfo
Definition: autovacuum.c:234
dlist_node wi_links
Definition: autovacuum.c:222
void * ShmemInitStruct(const char *name, Size size, bool *foundPtr)
Definition: shmem.c:396
AutoVacuumWorkItem av_workItems[NUM_WORKITEMS]
Definition: autovacuum.c:289
bool IsUnderPostmaster
Definition: globals.c:112
Size AutoVacuumShmemSize(void)
Definition: autovacuum.c:3417
int autovacuum_max_workers
Definition: autovacuum.c:115
static void dlist_init(dlist_head *head)
Definition: ilist.h:278
#define Assert(condition)
Definition: c.h:804
static AutoVacuumShmemStruct * AutoVacuumShmem
Definition: autovacuum.c:292
#define MAXALIGN(LEN)
Definition: c.h:757
int i
dlist_head av_runningWorkers
Definition: autovacuum.c:287

◆ AutoVacuumShmemSize()

Size AutoVacuumShmemSize ( void  )

Definition at line 3417 of file autovacuum.c.

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

Referenced by AutoVacuumShmemInit(), and CalculateShmemSize().

3418 {
3419  Size size;
3420 
3421  /*
3422  * Need the fixed struct and the array of WorkerInfoData.
3423  */
3424  size = sizeof(AutoVacuumShmemStruct);
3425  size = MAXALIGN(size);
3427  sizeof(WorkerInfoData)));
3428  return size;
3429 }
Size mul_size(Size s1, Size s2)
Definition: shmem.c:519
Size add_size(Size s1, Size s2)
Definition: shmem.c:502
int autovacuum_max_workers
Definition: autovacuum.c:115
size_t Size
Definition: c.h:540
#define MAXALIGN(LEN)
Definition: c.h:757

◆ AutoVacuumUpdateDelay()

void AutoVacuumUpdateDelay ( void  )

Definition at line 1779 of file autovacuum.c.

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

Referenced by do_autovacuum(), and vacuum_delay_point().

1780 {
1781  if (MyWorkerInfo)
1782  {
1785  }
1786 }
double wi_cost_delay
Definition: autovacuum.c:229
int VacuumCostLimit
Definition: globals.c:144
static WorkerInfo MyWorkerInfo
Definition: autovacuum.c:302
double VacuumCostDelay
Definition: globals.c:145

◆ AutoVacWorkerFailed()

void AutoVacWorkerFailed ( void  )

Definition at line 1416 of file autovacuum.c.

References AutoVacForkFailed, and AutoVacuumShmemStruct::av_signal.

Referenced by StartAutovacuumWorker().

1417 {
1419 }
sig_atomic_t av_signal[AutoVacNumSignals]
Definition: autovacuum.c:284
static AutoVacuumShmemStruct * AutoVacuumShmem
Definition: autovacuum.c:292

◆ IsAutoVacuumLauncherProcess()

bool IsAutoVacuumLauncherProcess ( void  )

Definition at line 3400 of file autovacuum.c.

References am_autovacuum_launcher.

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

3401 {
3402  return am_autovacuum_launcher;
3403 }
static bool am_autovacuum_launcher
Definition: autovacuum.c:140

◆ IsAutoVacuumWorkerProcess()

◆ StartAutoVacLauncher()

int StartAutoVacLauncher ( void  )

Referenced by reaper(), and ServerLoop().

◆ StartAutoVacWorker()

int StartAutoVacWorker ( void  )

Definition at line 1476 of file autovacuum.c.

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

Referenced by StartAutovacuumWorker().

1477 {
1478  pid_t worker_pid;
1479 
1480 #ifdef EXEC_BACKEND
1481  switch ((worker_pid = avworker_forkexec()))
1482 #else
1483  switch ((worker_pid = fork_process()))
1484 #endif
1485  {
1486  case -1:
1487  ereport(LOG,
1488  (errmsg("could not fork autovacuum worker process: %m")));
1489  return 0;
1490 
1491 #ifndef EXEC_BACKEND
1492  case 0:
1493  /* in postmaster child ... */
1495 
1496  /* Close the postmaster's sockets */
1497  ClosePostmasterPorts(false);
1498 
1499  AutoVacWorkerMain(0, NULL);
1500  break;
1501 #endif
1502  default:
1503  return (int) worker_pid;
1504  }
1505 
1506  /* shouldn't get here */
1507  return 0;
1508 }
void InitPostmasterChild(void)
Definition: miscinit.c:94
pid_t fork_process(void)
Definition: fork_process.c:29
#define LOG
Definition: elog.h:26
NON_EXEC_STATIC void AutoVacWorkerMain(int argc, char *argv[]) pg_attribute_noreturn()
Definition: autovacuum.c:1514
void ClosePostmasterPorts(bool am_syslogger)
Definition: postmaster.c:2612
#define ereport(elevel,...)
Definition: elog.h:157
int errmsg(const char *fmt,...)
Definition: elog.c:909

Variable Documentation

◆ autovacuum_anl_scale

double autovacuum_anl_scale

Definition at line 123 of file autovacuum.c.

Referenced by relation_needs_vacanalyze().

◆ autovacuum_anl_thresh

int autovacuum_anl_thresh

Definition at line 122 of file autovacuum.c.

Referenced by relation_needs_vacanalyze().

◆ autovacuum_freeze_max_age

int autovacuum_freeze_max_age

◆ autovacuum_max_workers

◆ autovacuum_multixact_freeze_max_age

int autovacuum_multixact_freeze_max_age

◆ autovacuum_naptime

int autovacuum_naptime

◆ autovacuum_start_daemon

bool autovacuum_start_daemon

Definition at line 114 of file autovacuum.c.

Referenced by autovac_init(), and AutoVacuumingActive().

◆ autovacuum_vac_cost_delay

double autovacuum_vac_cost_delay

Definition at line 127 of file autovacuum.c.

Referenced by autovac_balance_cost(), and table_recheck_autovac().

◆ autovacuum_vac_cost_limit

int autovacuum_vac_cost_limit

Definition at line 128 of file autovacuum.c.

Referenced by autovac_balance_cost(), and table_recheck_autovac().

◆ autovacuum_vac_ins_scale

double autovacuum_vac_ins_scale

Definition at line 121 of file autovacuum.c.

Referenced by relation_needs_vacanalyze().

◆ autovacuum_vac_ins_thresh

int autovacuum_vac_ins_thresh

Definition at line 120 of file autovacuum.c.

Referenced by relation_needs_vacanalyze().

◆ autovacuum_vac_scale

double autovacuum_vac_scale

Definition at line 119 of file autovacuum.c.

Referenced by relation_needs_vacanalyze().

◆ autovacuum_vac_thresh

int autovacuum_vac_thresh

Definition at line 118 of file autovacuum.c.

Referenced by relation_needs_vacanalyze().

◆ autovacuum_work_mem

int autovacuum_work_mem

Definition at line 116 of file autovacuum.c.

Referenced by compute_max_dead_tuples(), and ginInsertCleanup().

◆ AutovacuumLauncherPid

int AutovacuumLauncherPid

Definition at line 305 of file autovacuum.c.

Referenced by FreeWorkerInfo(), and ProcKill().

◆ Log_autovacuum_min_duration

int Log_autovacuum_min_duration

Definition at line 130 of file autovacuum.c.

Referenced by table_recheck_autovac().