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)
 
void 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
 
int 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

Enumerator
AVW_BRINSummarizeRange 

Definition at line 23 of file autovacuum.h.

Function Documentation

◆ autovac_init()

void autovac_init ( void  )

Definition at line 3235 of file autovacuum.c.

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

Referenced by PostmasterMain().

3236 {
3238  ereport(WARNING,
3239  (errmsg("autovacuum not started because of misconfiguration"),
3240  errhint("Enable the \"track_counts\" option.")));
3241 }
int errhint(const char *fmt,...)
Definition: elog.c:987
bool autovacuum_start_daemon
Definition: autovacuum.c:113
bool pgstat_track_counts
Definition: pgstat.c:126
#define ereport(elevel, rest)
Definition: elog.h:122
#define WARNING
Definition: elog.h:40
int errmsg(const char *fmt,...)
Definition: elog.c:797

◆ AutoVacuumingActive()

bool AutoVacuumingActive ( void  )

Definition at line 3186 of file autovacuum.c.

References autovacuum_start_daemon, and pgstat_track_counts.

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

3187 {
3189  return false;
3190  return true;
3191 }
bool autovacuum_start_daemon
Definition: autovacuum.c:113
bool pgstat_track_counts
Definition: pgstat.c:126

◆ AutoVacuumRequestWork()

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

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

3199 {
3200  int i;
3201 
3202  LWLockAcquire(AutovacuumLock, LW_EXCLUSIVE);
3203 
3204  /*
3205  * Locate an unused work item and fill it with the given data.
3206  */
3207  for (i = 0; i < NUM_WORKITEMS; i++)
3208  {
3210 
3211  if (workitem->avw_used)
3212  continue;
3213 
3214  workitem->avw_used = true;
3215  workitem->avw_active = false;
3216  workitem->avw_type = type;
3217  workitem->avw_database = MyDatabaseId;
3218  workitem->avw_relation = relationId;
3219  workitem->avw_blockNumber = blkno;
3220 
3221  /* done */
3222  break;
3223  }
3224 
3225  LWLockRelease(AutovacuumLock);
3226 }
AutoVacuumWorkItemType avw_type
Definition: autovacuum.c:256
#define NUM_WORKITEMS
Definition: autovacuum.c:264
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1724
AutoVacuumWorkItem av_workItems[NUM_WORKITEMS]
Definition: autovacuum.c:289
Oid MyDatabaseId
Definition: globals.c:77
BlockNumber avw_blockNumber
Definition: autovacuum.c:261
static AutoVacuumShmemStruct * AutoVacuumShmem
Definition: autovacuum.c:292
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1120
int i

◆ AutoVacuumShmemInit()

void AutoVacuumShmemInit ( void  )

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

3286 {
3287  bool found;
3288 
3290  ShmemInitStruct("AutoVacuum Data",
3292  &found);
3293 
3294  if (!IsUnderPostmaster)
3295  {
3296  WorkerInfo worker;
3297  int i;
3298 
3299  Assert(!found);
3300 
3305  memset(AutoVacuumShmem->av_workItems, 0,
3306  sizeof(AutoVacuumWorkItem) * NUM_WORKITEMS);
3307 
3308  worker = (WorkerInfo) ((char *) AutoVacuumShmem +
3309  MAXALIGN(sizeof(AutoVacuumShmemStruct)));
3310 
3311  /* initialize the WorkerInfo free list */
3312  for (i = 0; i < autovacuum_max_workers; i++)
3314  &worker[i].wi_links);
3315  }
3316  else
3317  Assert(found);
3318 }
#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:372
AutoVacuumWorkItem av_workItems[NUM_WORKITEMS]
Definition: autovacuum.c:289
bool IsUnderPostmaster
Definition: globals.c:101
Size AutoVacuumShmemSize(void)
Definition: autovacuum.c:3266
int autovacuum_max_workers
Definition: autovacuum.c:114
static void dlist_init(dlist_head *head)
Definition: ilist.h:278
#define Assert(condition)
Definition: c.h:688
static AutoVacuumShmemStruct * AutoVacuumShmem
Definition: autovacuum.c:292
#define MAXALIGN(LEN)
Definition: c.h:641
int i
dlist_head av_runningWorkers
Definition: autovacuum.c:287

◆ AutoVacuumShmemSize()

Size AutoVacuumShmemSize ( void  )

Definition at line 3266 of file autovacuum.c.

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

Referenced by AutoVacuumShmemInit(), and CreateSharedMemoryAndSemaphores().

3267 {
3268  Size size;
3269 
3270  /*
3271  * Need the fixed struct and the array of WorkerInfoData.
3272  */
3273  size = sizeof(AutoVacuumShmemStruct);
3274  size = MAXALIGN(size);
3276  sizeof(WorkerInfoData)));
3277  return size;
3278 }
Size mul_size(Size s1, Size s2)
Definition: shmem.c:492
Size add_size(Size s1, Size s2)
Definition: shmem.c:475
int autovacuum_max_workers
Definition: autovacuum.c:114
size_t Size
Definition: c.h:422
#define MAXALIGN(LEN)
Definition: c.h:641

◆ AutoVacuumUpdateDelay()

void AutoVacuumUpdateDelay ( void  )

Definition at line 1759 of file autovacuum.c.

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

Referenced by do_autovacuum(), and vacuum_delay_point().

1760 {
1761  if (MyWorkerInfo)
1762  {
1765  }
1766 }
int VacuumCostLimit
Definition: globals.c:132
static WorkerInfo MyWorkerInfo
Definition: autovacuum.c:302
int VacuumCostDelay
Definition: globals.c:133

◆ AutoVacWorkerFailed()

void AutoVacWorkerFailed ( void  )

Definition at line 1392 of file autovacuum.c.

References AutoVacForkFailed, and AutoVacuumShmemStruct::av_signal.

Referenced by StartAutovacuumWorker().

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

◆ IsAutoVacuumLauncherProcess()

bool IsAutoVacuumLauncherProcess ( void  )

Definition at line 3249 of file autovacuum.c.

References am_autovacuum_launcher.

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

3250 {
3251  return am_autovacuum_launcher;
3252 }
static bool am_autovacuum_launcher
Definition: autovacuum.c:137

◆ IsAutoVacuumWorkerProcess()

◆ StartAutoVacLauncher()

int StartAutoVacLauncher ( void  )

Definition at line 394 of file autovacuum.c.

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

Referenced by reaper(), and ServerLoop().

395 {
396  pid_t AutoVacPID;
397 
398 #ifdef EXEC_BACKEND
399  switch ((AutoVacPID = avlauncher_forkexec()))
400 #else
401  switch ((AutoVacPID = fork_process()))
402 #endif
403  {
404  case -1:
405  ereport(LOG,
406  (errmsg("could not fork autovacuum launcher process: %m")));
407  return 0;
408 
409 #ifndef EXEC_BACKEND
410  case 0:
411  /* in postmaster child ... */
413 
414  /* Close the postmaster's sockets */
415  ClosePostmasterPorts(false);
416 
417  AutoVacLauncherMain(0, NULL);
418  break;
419 #endif
420  default:
421  return (int) AutoVacPID;
422  }
423 
424  /* shouldn't get here */
425  return 0;
426 }
void InitPostmasterChild(void)
Definition: miscinit.c:176
NON_EXEC_STATIC void AutoVacLauncherMain(int argc, char *argv[]) pg_attribute_noreturn()
Definition: autovacuum.c:432
pid_t fork_process(void)
Definition: fork_process.c:31
#define LOG
Definition: elog.h:26
void ClosePostmasterPorts(bool am_syslogger)
Definition: postmaster.c:2499
#define ereport(elevel, rest)
Definition: elog.h:122
static pid_t AutoVacPID
Definition: postmaster.c:253
int errmsg(const char *fmt,...)
Definition: elog.c:797

◆ 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:176
pid_t fork_process(void)
Definition: fork_process.c:31
#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:2499
#define ereport(elevel, rest)
Definition: elog.h:122
int errmsg(const char *fmt,...)
Definition: elog.c:797

Variable Documentation

◆ autovacuum_anl_scale

double autovacuum_anl_scale

Definition at line 120 of file autovacuum.c.

Referenced by relation_needs_vacanalyze().

◆ autovacuum_anl_thresh

int autovacuum_anl_thresh

Definition at line 119 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

Definition at line 122 of file autovacuum.c.

Referenced by MultiXactMemberFreezeThreshold(), and SetMultiXactIdLimit().

◆ autovacuum_naptime

int autovacuum_naptime

◆ autovacuum_start_daemon

bool autovacuum_start_daemon

Definition at line 113 of file autovacuum.c.

Referenced by autovac_init(), and AutoVacuumingActive().

◆ autovacuum_vac_cost_delay

int autovacuum_vac_cost_delay

Definition at line 124 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 125 of file autovacuum.c.

Referenced by autovac_balance_cost(), and table_recheck_autovac().

◆ autovacuum_vac_scale

double autovacuum_vac_scale

Definition at line 118 of file autovacuum.c.

Referenced by relation_needs_vacanalyze().

◆ autovacuum_vac_thresh

int autovacuum_vac_thresh

Definition at line 117 of file autovacuum.c.

Referenced by relation_needs_vacanalyze().

◆ autovacuum_work_mem

int autovacuum_work_mem

Definition at line 115 of file autovacuum.c.

Referenced by ginInsertCleanup(), and lazy_space_alloc().

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

Referenced by table_recheck_autovac().