PostgreSQL Source Code  git master
bgworker.c File Reference
#include "postgres.h"
#include "access/parallel.h"
#include "libpq/pqsignal.h"
#include "miscadmin.h"
#include "pgstat.h"
#include "port/atomics.h"
#include "postmaster/bgworker_internals.h"
#include "postmaster/interrupt.h"
#include "postmaster/postmaster.h"
#include "replication/logicallauncher.h"
#include "replication/logicalworker.h"
#include "storage/dsm.h"
#include "storage/ipc.h"
#include "storage/latch.h"
#include "storage/lwlock.h"
#include "storage/pg_shmem.h"
#include "storage/pmsignal.h"
#include "storage/proc.h"
#include "storage/procsignal.h"
#include "storage/shmem.h"
#include "tcop/tcopprot.h"
#include "utils/ascii.h"
#include "utils/ps_status.h"
#include "utils/timeout.h"
Include dependency graph for bgworker.c:

Go to the source code of this file.

Data Structures

struct  BackgroundWorkerSlot
 
struct  BackgroundWorkerArray
 
struct  BackgroundWorkerHandle
 

Typedefs

typedef struct BackgroundWorkerSlot BackgroundWorkerSlot
 
typedef struct BackgroundWorkerArray BackgroundWorkerArray
 

Functions

static bgworker_main_type LookupBackgroundWorkerFunction (const char *libraryname, const char *funcname)
 
Size BackgroundWorkerShmemSize (void)
 
void BackgroundWorkerShmemInit (void)
 
static RegisteredBgWorkerFindRegisteredWorkerBySlotNumber (int slotno)
 
void BackgroundWorkerStateChange (void)
 
void ForgetBackgroundWorker (slist_mutable_iter *cur)
 
void ReportBackgroundWorkerPID (RegisteredBgWorker *rw)
 
void ReportBackgroundWorkerExit (slist_mutable_iter *cur)
 
void BackgroundWorkerStopNotifications (pid_t pid)
 
void ResetBackgroundWorkerCrashTimes (void)
 
static bool SanityCheckBackgroundWorker (BackgroundWorker *worker, int elevel)
 
static void bgworker_die (SIGNAL_ARGS)
 
static void bgworker_sigusr1_handler (SIGNAL_ARGS)
 
void StartBackgroundWorker (void)
 
void RegisterBackgroundWorker (BackgroundWorker *worker)
 
bool RegisterDynamicBackgroundWorker (BackgroundWorker *worker, BackgroundWorkerHandle **handle)
 
BgwHandleStatus GetBackgroundWorkerPid (BackgroundWorkerHandle *handle, pid_t *pidp)
 
BgwHandleStatus WaitForBackgroundWorkerStartup (BackgroundWorkerHandle *handle, pid_t *pidp)
 
BgwHandleStatus WaitForBackgroundWorkerShutdown (BackgroundWorkerHandle *handle)
 
void TerminateBackgroundWorker (BackgroundWorkerHandle *handle)
 
const char * GetBackgroundWorkerTypeByPid (pid_t pid)
 

Variables

slist_head BackgroundWorkerList = SLIST_STATIC_INIT(BackgroundWorkerList)
 
static BackgroundWorkerArrayBackgroundWorkerData
 
struct {
   const char *   fn_name
 
   bgworker_main_type   fn_addr
 
InternalBGWorkers []
 

Typedef Documentation

◆ BackgroundWorkerArray

◆ BackgroundWorkerSlot

Function Documentation

◆ BackgroundWorkerShmemInit()

void BackgroundWorkerShmemInit ( void  )

Definition at line 158 of file bgworker.c.

References Assert, BackgroundWorkerShmemSize(), BackgroundWorker::bgw_notify_pid, slist_iter::cur, BackgroundWorkerSlot::generation, BackgroundWorkerSlot::in_use, InvalidPid, IsUnderPostmaster, max_worker_processes, BackgroundWorkerArray::parallel_register_count, BackgroundWorkerArray::parallel_terminate_count, BackgroundWorkerSlot::pid, RegisteredBgWorker::rw_shmem_slot, RegisteredBgWorker::rw_worker, ShmemInitStruct(), slist_container, slist_foreach, BackgroundWorkerArray::slot, BackgroundWorkerSlot::terminate, BackgroundWorkerArray::total_slots, and BackgroundWorkerSlot::worker.

Referenced by CreateSharedMemoryAndSemaphores().

159 {
160  bool found;
161 
162  BackgroundWorkerData = ShmemInitStruct("Background Worker Data",
164  &found);
165  if (!IsUnderPostmaster)
166  {
167  slist_iter siter;
168  int slotno = 0;
169 
173 
174  /*
175  * Copy contents of worker list into shared memory. Record the shared
176  * memory slot assigned to each worker. This ensures a 1-to-1
177  * correspondence between the postmaster's private list and the array
178  * in shared memory.
179  */
181  {
183  RegisteredBgWorker *rw;
184 
185  rw = slist_container(RegisteredBgWorker, rw_lnode, siter.cur);
186  Assert(slotno < max_worker_processes);
187  slot->in_use = true;
188  slot->terminate = false;
189  slot->pid = InvalidPid;
190  slot->generation = 0;
191  rw->rw_shmem_slot = slotno;
192  rw->rw_worker.bgw_notify_pid = 0; /* might be reinit after crash */
193  memcpy(&slot->worker, &rw->rw_worker, sizeof(BackgroundWorker));
194  ++slotno;
195  }
196 
197  /*
198  * Mark any remaining slots as not in use.
199  */
200  while (slotno < max_worker_processes)
201  {
203 
204  slot->in_use = false;
205  ++slotno;
206  }
207  }
208  else
209  Assert(found);
210 }
slist_node * cur
Definition: ilist.h:226
static BackgroundWorkerArray * BackgroundWorkerData
Definition: bgworker.c:110
Size BackgroundWorkerShmemSize(void)
Definition: bgworker.c:142
void * ShmemInitStruct(const char *name, Size size, bool *foundPtr)
Definition: shmem.c:392
slist_head BackgroundWorkerList
Definition: bgworker.c:42
uint32 parallel_register_count
Definition: bgworker.c:99
bool IsUnderPostmaster
Definition: globals.c:109
#define slist_container(type, membername, ptr)
Definition: ilist.h:674
#define Assert(condition)
Definition: c.h:738
BackgroundWorker worker
Definition: bgworker.c:82
#define slist_foreach(iter, lhead)
Definition: ilist.h:700
uint32 parallel_terminate_count
Definition: bgworker.c:100
pid_t bgw_notify_pid
Definition: bgworker.h:99
int max_worker_processes
Definition: globals.c:133
BackgroundWorker rw_worker
BackgroundWorkerSlot slot[FLEXIBLE_ARRAY_MEMBER]
Definition: bgworker.c:101
#define InvalidPid
Definition: miscadmin.h:32

◆ BackgroundWorkerShmemSize()

Size BackgroundWorkerShmemSize ( void  )

Definition at line 142 of file bgworker.c.

References add_size(), max_worker_processes, mul_size(), and offsetof.

Referenced by BackgroundWorkerShmemInit(), and CreateSharedMemoryAndSemaphores().

143 {
144  Size size;
145 
146  /* Array of workers is variably sized. */
147  size = offsetof(BackgroundWorkerArray, slot);
149  sizeof(BackgroundWorkerSlot)));
150 
151  return size;
152 }
Size mul_size(Size s1, Size s2)
Definition: shmem.c:515
Size add_size(Size s1, Size s2)
Definition: shmem.c:498
size_t Size
Definition: c.h:466
int max_worker_processes
Definition: globals.c:133
#define offsetof(type, field)
Definition: c.h:661

◆ BackgroundWorkerStateChange()

void BackgroundWorkerStateChange ( void  )

Definition at line 240 of file bgworker.c.

References ascii_safe_strlcpy(), BackgroundWorker::bgw_extra, BGW_EXTRALEN, BackgroundWorker::bgw_flags, BackgroundWorker::bgw_function_name, BackgroundWorker::bgw_library_name, BackgroundWorker::bgw_main_arg, BGW_MAXLEN, BackgroundWorker::bgw_name, BackgroundWorker::bgw_notify_pid, BackgroundWorker::bgw_restart_time, BackgroundWorker::bgw_start_time, BackgroundWorker::bgw_type, BGWORKER_CLASS_PARALLEL, DEBUG1, elog, ereport, errcode(), errmsg(), FindRegisteredWorkerBySlotNumber(), BackgroundWorkerSlot::in_use, kill, LOG, malloc, max_worker_processes, BackgroundWorkerArray::parallel_terminate_count, pg_memory_barrier, pg_read_barrier, BackgroundWorkerSlot::pid, PostmasterMarkPIDForWorkerNotify(), ReportBackgroundWorkerPID(), RegisteredBgWorker::rw_backend, RegisteredBgWorker::rw_child_slot, RegisteredBgWorker::rw_crashed_at, RegisteredBgWorker::rw_lnode, RegisteredBgWorker::rw_pid, RegisteredBgWorker::rw_shmem_slot, RegisteredBgWorker::rw_terminate, RegisteredBgWorker::rw_worker, SIGUSR1, slist_push_head(), BackgroundWorkerArray::slot, BackgroundWorkerSlot::terminate, BackgroundWorkerArray::total_slots, and BackgroundWorkerSlot::worker.

Referenced by sigusr1_handler().

241 {
242  int slotno;
243 
244  /*
245  * The total number of slots stored in shared memory should match our
246  * notion of max_worker_processes. If it does not, something is very
247  * wrong. Further down, we always refer to this value as
248  * max_worker_processes, in case shared memory gets corrupted while we're
249  * looping.
250  */
252  {
253  elog(LOG,
254  "inconsistent background worker state (max_worker_processes=%d, total_slots=%d",
257  return;
258  }
259 
260  /*
261  * Iterate through slots, looking for newly-registered workers or workers
262  * who must die.
263  */
264  for (slotno = 0; slotno < max_worker_processes; ++slotno)
265  {
267  RegisteredBgWorker *rw;
268 
269  if (!slot->in_use)
270  continue;
271 
272  /*
273  * Make sure we don't see the in_use flag before the updated slot
274  * contents.
275  */
276  pg_read_barrier();
277 
278  /* See whether we already know about this worker. */
280  if (rw != NULL)
281  {
282  /*
283  * In general, the worker data can't change after it's initially
284  * registered. However, someone can set the terminate flag.
285  */
286  if (slot->terminate && !rw->rw_terminate)
287  {
288  rw->rw_terminate = true;
289  if (rw->rw_pid != 0)
290  kill(rw->rw_pid, SIGTERM);
291  else
292  {
293  /* Report never-started, now-terminated worker as dead. */
295  }
296  }
297  continue;
298  }
299 
300  /*
301  * If the worker is marked for termination, we don't need to add it to
302  * the registered workers list; we can just free the slot. However, if
303  * bgw_notify_pid is set, the process that registered the worker may
304  * need to know that we've processed the terminate request, so be sure
305  * to signal it.
306  */
307  if (slot->terminate)
308  {
309  int notify_pid;
310 
311  /*
312  * We need a memory barrier here to make sure that the load of
313  * bgw_notify_pid and the update of parallel_terminate_count
314  * complete before the store to in_use.
315  */
316  notify_pid = slot->worker.bgw_notify_pid;
317  if ((slot->worker.bgw_flags & BGWORKER_CLASS_PARALLEL) != 0)
320  slot->pid = 0;
321  slot->in_use = false;
322  if (notify_pid != 0)
323  kill(notify_pid, SIGUSR1);
324 
325  continue;
326  }
327 
328  /*
329  * Copy the registration data into the registered workers list.
330  */
331  rw = malloc(sizeof(RegisteredBgWorker));
332  if (rw == NULL)
333  {
334  ereport(LOG,
335  (errcode(ERRCODE_OUT_OF_MEMORY),
336  errmsg("out of memory")));
337  return;
338  }
339 
340  /*
341  * Copy strings in a paranoid way. If shared memory is corrupted, the
342  * source data might not even be NUL-terminated.
343  */
345  slot->worker.bgw_name, BGW_MAXLEN);
347  slot->worker.bgw_type, BGW_MAXLEN);
352 
353  /*
354  * Copy various fixed-size fields.
355  *
356  * flags, start_time, and restart_time are examined by the postmaster,
357  * but nothing too bad will happen if they are corrupted. The
358  * remaining fields will only be examined by the child process. It
359  * might crash, but we won't.
360  */
361  rw->rw_worker.bgw_flags = slot->worker.bgw_flags;
365  memcpy(rw->rw_worker.bgw_extra, slot->worker.bgw_extra, BGW_EXTRALEN);
366 
367  /*
368  * Copy the PID to be notified about state changes, but only if the
369  * postmaster knows about a backend with that PID. It isn't an error
370  * if the postmaster doesn't know about the PID, because the backend
371  * that requested the worker could have died (or been killed) just
372  * after doing so. Nonetheless, at least until we get some experience
373  * with how this plays out in the wild, log a message at a relative
374  * high debug level.
375  */
378  {
379  elog(DEBUG1, "worker notification PID %lu is not valid",
380  (long) rw->rw_worker.bgw_notify_pid);
381  rw->rw_worker.bgw_notify_pid = 0;
382  }
383 
384  /* Initialize postmaster bookkeeping. */
385  rw->rw_backend = NULL;
386  rw->rw_pid = 0;
387  rw->rw_child_slot = 0;
388  rw->rw_crashed_at = 0;
389  rw->rw_shmem_slot = slotno;
390  rw->rw_terminate = false;
391 
392  /* Log it! */
393  ereport(DEBUG1,
394  (errmsg("registering background worker \"%s\"",
395  rw->rw_worker.bgw_name)));
396 
398  }
399 }
char bgw_extra[BGW_EXTRALEN]
Definition: bgworker.h:98
struct bkend * rw_backend
#define DEBUG1
Definition: elog.h:25
#define SIGUSR1
Definition: win32_port.h:165
static BackgroundWorkerArray * BackgroundWorkerData
Definition: bgworker.c:110
static void slist_push_head(slist_head *head, slist_node *node)
Definition: ilist.h:574
int bgw_restart_time
Definition: bgworker.h:94
int errcode(int sqlerrcode)
Definition: elog.c:610
#define BGWORKER_CLASS_PARALLEL
Definition: bgworker.h:67
#define kill(pid, sig)
Definition: win32_port.h:426
void ascii_safe_strlcpy(char *dest, const char *src, size_t destsiz)
Definition: ascii.c:173
#define LOG
Definition: elog.h:26
char bgw_function_name[BGW_MAXLEN]
Definition: bgworker.h:96
#define malloc(a)
Definition: header.h:50
Datum bgw_main_arg
Definition: bgworker.h:97
void ReportBackgroundWorkerPID(RegisteredBgWorker *rw)
Definition: bgworker.c:439
bool PostmasterMarkPIDForWorkerNotify(int pid)
Definition: postmaster.c:6118
slist_head BackgroundWorkerList
Definition: bgworker.c:42
static RegisteredBgWorker * FindRegisteredWorkerBySlotNumber(int slotno)
Definition: bgworker.c:217
#define ereport(elevel,...)
Definition: elog.h:144
#define pg_memory_barrier()
Definition: atomics.h:145
char bgw_name[BGW_MAXLEN]
Definition: bgworker.h:90
BackgroundWorker worker
Definition: bgworker.c:82
#define pg_read_barrier()
Definition: atomics.h:158
#define BGW_MAXLEN
Definition: bgworker.h:85
BgWorkerStartTime bgw_start_time
Definition: bgworker.h:93
char bgw_type[BGW_MAXLEN]
Definition: bgworker.h:91
int errmsg(const char *fmt,...)
Definition: elog.c:824
uint32 parallel_terminate_count
Definition: bgworker.c:100
pid_t bgw_notify_pid
Definition: bgworker.h:99
#define elog(elevel,...)
Definition: elog.h:214
int max_worker_processes
Definition: globals.c:133
BackgroundWorker rw_worker
BackgroundWorkerSlot slot[FLEXIBLE_ARRAY_MEMBER]
Definition: bgworker.c:101
char bgw_library_name[BGW_MAXLEN]
Definition: bgworker.h:95
#define BGW_EXTRALEN
Definition: bgworker.h:86

◆ BackgroundWorkerStopNotifications()

void BackgroundWorkerStopNotifications ( pid_t  pid)

Definition at line 492 of file bgworker.c.

References BackgroundWorker::bgw_notify_pid, slist_iter::cur, RegisteredBgWorker::rw_worker, slist_container, and slist_foreach.

Referenced by CleanupBackend(), and CleanupBackgroundWorker().

493 {
494  slist_iter siter;
495 
497  {
498  RegisteredBgWorker *rw;
499 
500  rw = slist_container(RegisteredBgWorker, rw_lnode, siter.cur);
501  if (rw->rw_worker.bgw_notify_pid == pid)
502  rw->rw_worker.bgw_notify_pid = 0;
503  }
504 }
slist_node * cur
Definition: ilist.h:226
slist_head BackgroundWorkerList
Definition: bgworker.c:42
#define slist_container(type, membername, ptr)
Definition: ilist.h:674
#define slist_foreach(iter, lhead)
Definition: ilist.h:700
pid_t bgw_notify_pid
Definition: bgworker.h:99
BackgroundWorker rw_worker

◆ bgworker_die()

static void bgworker_die ( SIGNAL_ARGS  )
static

Definition at line 647 of file bgworker.c.

References BackgroundWorker::bgw_type, BlockSig, ereport, errcode(), errmsg(), FATAL, MyBgworkerEntry, and PG_SETMASK.

Referenced by StartBackgroundWorker().

648 {
650 
651  ereport(FATAL,
652  (errcode(ERRCODE_ADMIN_SHUTDOWN),
653  errmsg("terminating background worker \"%s\" due to administrator command",
655 }
int errcode(int sqlerrcode)
Definition: elog.c:610
BackgroundWorker * MyBgworkerEntry
Definition: postmaster.c:192
#define PG_SETMASK(mask)
Definition: pqsignal.h:19
#define FATAL
Definition: elog.h:52
sigset_t BlockSig
Definition: pqsignal.c:22
#define ereport(elevel,...)
Definition: elog.h:144
char bgw_type[BGW_MAXLEN]
Definition: bgworker.h:91
int errmsg(const char *fmt,...)
Definition: elog.c:824

◆ bgworker_sigusr1_handler()

static void bgworker_sigusr1_handler ( SIGNAL_ARGS  )
static

Definition at line 664 of file bgworker.c.

References latch_sigusr1_handler().

Referenced by StartBackgroundWorker().

665 {
666  int save_errno = errno;
667 
669 
670  errno = save_errno;
671 }
void latch_sigusr1_handler(void)
Definition: latch.c:1866

◆ FindRegisteredWorkerBySlotNumber()

static RegisteredBgWorker* FindRegisteredWorkerBySlotNumber ( int  slotno)
static

Definition at line 217 of file bgworker.c.

References slist_iter::cur, RegisteredBgWorker::rw_shmem_slot, slist_container, and slist_foreach.

Referenced by BackgroundWorkerStateChange().

218 {
219  slist_iter siter;
220 
222  {
223  RegisteredBgWorker *rw;
224 
225  rw = slist_container(RegisteredBgWorker, rw_lnode, siter.cur);
226  if (rw->rw_shmem_slot == slotno)
227  return rw;
228  }
229 
230  return NULL;
231 }
slist_node * cur
Definition: ilist.h:226
slist_head BackgroundWorkerList
Definition: bgworker.c:42
#define slist_container(type, membername, ptr)
Definition: ilist.h:674
#define slist_foreach(iter, lhead)
Definition: ilist.h:700

◆ ForgetBackgroundWorker()

void ForgetBackgroundWorker ( slist_mutable_iter cur)

Definition at line 411 of file bgworker.c.

References Assert, BackgroundWorker::bgw_flags, BackgroundWorker::bgw_name, BGWORKER_CLASS_PARALLEL, slist_mutable_iter::cur, DEBUG1, ereport, errmsg(), free, BackgroundWorkerSlot::in_use, max_worker_processes, BackgroundWorkerArray::parallel_terminate_count, RegisteredBgWorker::rw_shmem_slot, RegisteredBgWorker::rw_worker, slist_container, slist_delete_current(), and BackgroundWorkerArray::slot.

Referenced by DetermineSleepTime(), maybe_start_bgworkers(), ReportBackgroundWorkerExit(), and ResetBackgroundWorkerCrashTimes().

412 {
413  RegisteredBgWorker *rw;
414  BackgroundWorkerSlot *slot;
415 
416  rw = slist_container(RegisteredBgWorker, rw_lnode, cur->cur);
417 
422 
423  slot->in_use = false;
424 
425  ereport(DEBUG1,
426  (errmsg("unregistering background worker \"%s\"",
427  rw->rw_worker.bgw_name)));
428 
430  free(rw);
431 }
#define DEBUG1
Definition: elog.h:25
static BackgroundWorkerArray * BackgroundWorkerData
Definition: bgworker.c:110
slist_node * cur
Definition: ilist.h:241
#define BGWORKER_CLASS_PARALLEL
Definition: bgworker.h:67
#define slist_container(type, membername, ptr)
Definition: ilist.h:674
#define ereport(elevel,...)
Definition: elog.h:144
#define free(a)
Definition: header.h:65
char bgw_name[BGW_MAXLEN]
Definition: bgworker.h:90
#define Assert(condition)
Definition: c.h:738
int errmsg(const char *fmt,...)
Definition: elog.c:824
uint32 parallel_terminate_count
Definition: bgworker.c:100
int max_worker_processes
Definition: globals.c:133
static void slist_delete_current(slist_mutable_iter *iter)
Definition: ilist.h:652
BackgroundWorker rw_worker
BackgroundWorkerSlot slot[FLEXIBLE_ARRAY_MEMBER]
Definition: bgworker.c:101

◆ GetBackgroundWorkerPid()

BgwHandleStatus GetBackgroundWorkerPid ( BackgroundWorkerHandle handle,
pid_t *  pidp 
)

Definition at line 1023 of file bgworker.c.

References Assert, BGWH_NOT_YET_STARTED, BGWH_STARTED, BGWH_STOPPED, BackgroundWorkerSlot::generation, BackgroundWorkerHandle::generation, BackgroundWorkerSlot::in_use, InvalidPid, LW_SHARED, LWLockAcquire(), LWLockRelease(), max_worker_processes, BackgroundWorkerSlot::pid, BackgroundWorkerArray::slot, and BackgroundWorkerHandle::slot.

Referenced by check_worker_status(), shm_mq_counterparty_gone(), shm_mq_wait_internal(), WaitForBackgroundWorkerShutdown(), WaitForBackgroundWorkerStartup(), WaitForParallelWorkersToAttach(), WaitForParallelWorkersToFinish(), and WaitForReplicationWorkerAttach().

1024 {
1025  BackgroundWorkerSlot *slot;
1026  pid_t pid;
1027 
1028  Assert(handle->slot < max_worker_processes);
1029  slot = &BackgroundWorkerData->slot[handle->slot];
1030 
1031  /*
1032  * We could probably arrange to synchronize access to data using memory
1033  * barriers only, but for now, let's just keep it simple and grab the
1034  * lock. It seems unlikely that there will be enough traffic here to
1035  * result in meaningful contention.
1036  */
1037  LWLockAcquire(BackgroundWorkerLock, LW_SHARED);
1038 
1039  /*
1040  * The generation number can't be concurrently changed while we hold the
1041  * lock. The pid, which is updated by the postmaster, can change at any
1042  * time, but we assume such changes are atomic. So the value we read
1043  * won't be garbage, but it might be out of date by the time the caller
1044  * examines it (but that's unavoidable anyway).
1045  *
1046  * The in_use flag could be in the process of changing from true to false,
1047  * but if it is already false then it can't change further.
1048  */
1049  if (handle->generation != slot->generation || !slot->in_use)
1050  pid = 0;
1051  else
1052  pid = slot->pid;
1053 
1054  /* All done. */
1055  LWLockRelease(BackgroundWorkerLock);
1056 
1057  if (pid == 0)
1058  return BGWH_STOPPED;
1059  else if (pid == InvalidPid)
1060  return BGWH_NOT_YET_STARTED;
1061  *pidp = pid;
1062  return BGWH_STARTED;
1063 }
static BackgroundWorkerArray * BackgroundWorkerData
Definition: bgworker.c:110
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1812
#define Assert(condition)
Definition: c.h:738
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1208
int max_worker_processes
Definition: globals.c:133
BackgroundWorkerSlot slot[FLEXIBLE_ARRAY_MEMBER]
Definition: bgworker.c:101
#define InvalidPid
Definition: miscadmin.h:32

◆ GetBackgroundWorkerTypeByPid()

const char* GetBackgroundWorkerTypeByPid ( pid_t  pid)

Definition at line 1231 of file bgworker.c.

References BGW_MAXLEN, BackgroundWorker::bgw_type, LW_SHARED, LWLockAcquire(), LWLockRelease(), BackgroundWorkerSlot::pid, BackgroundWorkerArray::slot, BackgroundWorkerArray::total_slots, and BackgroundWorkerSlot::worker.

Referenced by pg_stat_get_activity().

1232 {
1233  int slotno;
1234  bool found = false;
1235  static char result[BGW_MAXLEN];
1236 
1237  LWLockAcquire(BackgroundWorkerLock, LW_SHARED);
1238 
1239  for (slotno = 0; slotno < BackgroundWorkerData->total_slots; slotno++)
1240  {
1242 
1243  if (slot->pid > 0 && slot->pid == pid)
1244  {
1245  strcpy(result, slot->worker.bgw_type);
1246  found = true;
1247  break;
1248  }
1249  }
1250 
1251  LWLockRelease(BackgroundWorkerLock);
1252 
1253  if (!found)
1254  return NULL;
1255 
1256  return result;
1257 }
static BackgroundWorkerArray * BackgroundWorkerData
Definition: bgworker.c:110
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1812
BackgroundWorker worker
Definition: bgworker.c:82
#define BGW_MAXLEN
Definition: bgworker.h:85
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1208
char bgw_type[BGW_MAXLEN]
Definition: bgworker.h:91
BackgroundWorkerSlot slot[FLEXIBLE_ARRAY_MEMBER]
Definition: bgworker.c:101

◆ LookupBackgroundWorkerFunction()

static bgworker_main_type LookupBackgroundWorkerFunction ( const char *  libraryname,
const char *  funcname 
)
static

Definition at line 1197 of file bgworker.c.

References elog, ERROR, fn_addr, fn_name, i, InternalBGWorkers, lengthof, and load_external_function().

Referenced by StartBackgroundWorker().

1198 {
1199  /*
1200  * If the function is to be loaded from postgres itself, search the
1201  * InternalBGWorkers array.
1202  */
1203  if (strcmp(libraryname, "postgres") == 0)
1204  {
1205  int i;
1206 
1207  for (i = 0; i < lengthof(InternalBGWorkers); i++)
1208  {
1209  if (strcmp(InternalBGWorkers[i].fn_name, funcname) == 0)
1210  return InternalBGWorkers[i].fn_addr;
1211  }
1212 
1213  /* We can only reach this by programming error. */
1214  elog(ERROR, "internal function \"%s\" not found", funcname);
1215  }
1216 
1217  /* Otherwise load from external library. */
1218  return (bgworker_main_type)
1219  load_external_function(libraryname, funcname, true, NULL);
1220 }
static const struct @21 InternalBGWorkers[]
#define lengthof(array)
Definition: c.h:668
const char * fn_name
Definition: bgworker.c:118
#define ERROR
Definition: elog.h:43
PGFunction load_external_function(const char *filename, const char *funcname, bool signalNotFound, void **filehandle)
Definition: dfmgr.c:107
bgworker_main_type fn_addr
Definition: bgworker.c:119
#define elog(elevel,...)
Definition: elog.h:214
int i
void(* bgworker_main_type)(Datum main_arg)
Definition: bgworker.h:71

◆ RegisterBackgroundWorker()

void RegisterBackgroundWorker ( BackgroundWorker worker)

Definition at line 827 of file bgworker.c.

References BackgroundWorker::bgw_library_name, BackgroundWorker::bgw_name, BackgroundWorker::bgw_notify_pid, DEBUG1, ereport, errcode(), errdetail_plural(), errhint(), errmsg(), IsUnderPostmaster, LOG, malloc, max_worker_processes, process_shared_preload_libraries_in_progress, RegisteredBgWorker::rw_backend, RegisteredBgWorker::rw_child_slot, RegisteredBgWorker::rw_crashed_at, RegisteredBgWorker::rw_lnode, RegisteredBgWorker::rw_pid, RegisteredBgWorker::rw_terminate, RegisteredBgWorker::rw_worker, SanityCheckBackgroundWorker(), slist_push_head(), and BackgroundWorkerSlot::worker.

Referenced by _PG_init(), ApplyLauncherRegister(), and apw_start_master_worker().

828 {
829  RegisteredBgWorker *rw;
830  static int numworkers = 0;
831 
832  if (!IsUnderPostmaster)
833  ereport(DEBUG1,
834  (errmsg("registering background worker \"%s\"", worker->bgw_name)));
835 
837  strcmp(worker->bgw_library_name, "postgres") != 0)
838  {
839  if (!IsUnderPostmaster)
840  ereport(LOG,
841  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
842  errmsg("background worker \"%s\": must be registered in shared_preload_libraries",
843  worker->bgw_name)));
844  return;
845  }
846 
847  if (!SanityCheckBackgroundWorker(worker, LOG))
848  return;
849 
850  if (worker->bgw_notify_pid != 0)
851  {
852  ereport(LOG,
853  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
854  errmsg("background worker \"%s\": only dynamic background workers can request notification",
855  worker->bgw_name)));
856  return;
857  }
858 
859  /*
860  * Enforce maximum number of workers. Note this is overly restrictive: we
861  * could allow more non-shmem-connected workers, because these don't count
862  * towards the MAX_BACKENDS limit elsewhere. For now, it doesn't seem
863  * important to relax this restriction.
864  */
865  if (++numworkers > max_worker_processes)
866  {
867  ereport(LOG,
868  (errcode(ERRCODE_CONFIGURATION_LIMIT_EXCEEDED),
869  errmsg("too many background workers"),
870  errdetail_plural("Up to %d background worker can be registered with the current settings.",
871  "Up to %d background workers can be registered with the current settings.",
874  errhint("Consider increasing the configuration parameter \"max_worker_processes\".")));
875  return;
876  }
877 
878  /*
879  * Copy the registration data into the registered workers list.
880  */
881  rw = malloc(sizeof(RegisteredBgWorker));
882  if (rw == NULL)
883  {
884  ereport(LOG,
885  (errcode(ERRCODE_OUT_OF_MEMORY),
886  errmsg("out of memory")));
887  return;
888  }
889 
890  rw->rw_worker = *worker;
891  rw->rw_backend = NULL;
892  rw->rw_pid = 0;
893  rw->rw_child_slot = 0;
894  rw->rw_crashed_at = 0;
895  rw->rw_terminate = false;
896 
898 }
struct bkend * rw_backend
#define DEBUG1
Definition: elog.h:25
int errhint(const char *fmt,...)
Definition: elog.c:1071
bool process_shared_preload_libraries_in_progress
Definition: miscinit.c:1568
static void slist_push_head(slist_head *head, slist_node *node)
Definition: ilist.h:574
int errcode(int sqlerrcode)
Definition: elog.c:610
#define LOG
Definition: elog.h:26
#define malloc(a)
Definition: header.h:50
slist_head BackgroundWorkerList
Definition: bgworker.c:42
bool IsUnderPostmaster
Definition: globals.c:109
static bool SanityCheckBackgroundWorker(BackgroundWorker *worker, int elevel)
Definition: bgworker.c:582
#define ereport(elevel,...)
Definition: elog.h:144
char bgw_name[BGW_MAXLEN]
Definition: bgworker.h:90
int errdetail_plural(const char *fmt_singular, const char *fmt_plural, unsigned long n,...)
Definition: elog.c:1049
int errmsg(const char *fmt,...)
Definition: elog.c:824
pid_t bgw_notify_pid
Definition: bgworker.h:99
int max_worker_processes
Definition: globals.c:133
BackgroundWorker rw_worker
char bgw_library_name[BGW_MAXLEN]
Definition: bgworker.h:95

◆ RegisterDynamicBackgroundWorker()

bool RegisterDynamicBackgroundWorker ( BackgroundWorker worker,
BackgroundWorkerHandle **  handle 
)

Definition at line 911 of file bgworker.c.

References Assert, BackgroundWorker::bgw_flags, BGWORKER_CLASS_PARALLEL, ERROR, BackgroundWorkerSlot::generation, BackgroundWorkerSlot::in_use, InvalidPid, IsUnderPostmaster, LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), MAX_PARALLEL_WORKER_LIMIT, max_parallel_workers, palloc(), BackgroundWorkerArray::parallel_register_count, BackgroundWorkerArray::parallel_terminate_count, pg_write_barrier, BackgroundWorkerSlot::pid, PMSIGNAL_BACKGROUND_WORKER_CHANGE, SanityCheckBackgroundWorker(), SendPostmasterSignal(), BackgroundWorkerArray::slot, success, BackgroundWorkerSlot::terminate, BackgroundWorkerArray::total_slots, and BackgroundWorkerSlot::worker.

Referenced by apw_start_database_worker(), apw_start_master_worker(), LaunchParallelWorkers(), logicalrep_worker_launch(), setup_background_workers(), and worker_spi_launch().

913 {
914  int slotno;
915  bool success = false;
916  bool parallel;
917  uint64 generation = 0;
918 
919  /*
920  * We can't register dynamic background workers from the postmaster. If
921  * this is a standalone backend, we're the only process and can't start
922  * any more. In a multi-process environment, it might be theoretically
923  * possible, but we don't currently support it due to locking
924  * considerations; see comments on the BackgroundWorkerSlot data
925  * structure.
926  */
927  if (!IsUnderPostmaster)
928  return false;
929 
930  if (!SanityCheckBackgroundWorker(worker, ERROR))
931  return false;
932 
933  parallel = (worker->bgw_flags & BGWORKER_CLASS_PARALLEL) != 0;
934 
935  LWLockAcquire(BackgroundWorkerLock, LW_EXCLUSIVE);
936 
937  /*
938  * If this is a parallel worker, check whether there are already too many
939  * parallel workers; if so, don't register another one. Our view of
940  * parallel_terminate_count may be slightly stale, but that doesn't really
941  * matter: we would have gotten the same result if we'd arrived here
942  * slightly earlier anyway. There's no help for it, either, since the
943  * postmaster must not take locks; a memory barrier wouldn't guarantee
944  * anything useful.
945  */
949  {
953  LWLockRelease(BackgroundWorkerLock);
954  return false;
955  }
956 
957  /*
958  * Look for an unused slot. If we find one, grab it.
959  */
960  for (slotno = 0; slotno < BackgroundWorkerData->total_slots; ++slotno)
961  {
963 
964  if (!slot->in_use)
965  {
966  memcpy(&slot->worker, worker, sizeof(BackgroundWorker));
967  slot->pid = InvalidPid; /* indicates not started yet */
968  slot->generation++;
969  slot->terminate = false;
970  generation = slot->generation;
971  if (parallel)
973 
974  /*
975  * Make sure postmaster doesn't see the slot as in use before it
976  * sees the new contents.
977  */
979 
980  slot->in_use = true;
981  success = true;
982  break;
983  }
984  }
985 
986  LWLockRelease(BackgroundWorkerLock);
987 
988  /* If we found a slot, tell the postmaster to notice the change. */
989  if (success)
991 
992  /*
993  * If we found a slot and the user has provided a handle, initialize it.
994  */
995  if (success && handle)
996  {
997  *handle = palloc(sizeof(BackgroundWorkerHandle));
998  (*handle)->slot = slotno;
999  (*handle)->generation = generation;
1000  }
1001 
1002  return success;
1003 }
int max_parallel_workers
Definition: globals.c:134
static BackgroundWorkerArray * BackgroundWorkerData
Definition: bgworker.c:110
#define BGWORKER_CLASS_PARALLEL
Definition: bgworker.h:67
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1812
#define ERROR
Definition: elog.h:43
uint32 parallel_register_count
Definition: bgworker.c:99
bool IsUnderPostmaster
Definition: globals.c:109
static bool SanityCheckBackgroundWorker(BackgroundWorker *worker, int elevel)
Definition: bgworker.c:582
#define Assert(condition)
Definition: c.h:738
BackgroundWorker worker
Definition: bgworker.c:82
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1208
void * palloc(Size size)
Definition: mcxt.c:949
uint32 parallel_terminate_count
Definition: bgworker.c:100
#define pg_write_barrier()
Definition: atomics.h:159
void SendPostmasterSignal(PMSignalReason reason)
Definition: pmsignal.c:146
#define MAX_PARALLEL_WORKER_LIMIT
BackgroundWorkerSlot slot[FLEXIBLE_ARRAY_MEMBER]
Definition: bgworker.c:101
static bool success
Definition: initdb.c:161
#define InvalidPid
Definition: miscadmin.h:32

◆ ReportBackgroundWorkerExit()

void ReportBackgroundWorkerExit ( slist_mutable_iter cur)

Definition at line 458 of file bgworker.c.

References Assert, BGW_NEVER_RESTART, BackgroundWorker::bgw_notify_pid, BackgroundWorker::bgw_restart_time, slist_mutable_iter::cur, ForgetBackgroundWorker(), kill, max_worker_processes, BackgroundWorkerSlot::pid, RegisteredBgWorker::rw_pid, RegisteredBgWorker::rw_shmem_slot, RegisteredBgWorker::rw_terminate, RegisteredBgWorker::rw_worker, SIGUSR1, slist_container, and BackgroundWorkerArray::slot.

Referenced by CleanupBackgroundWorker().

459 {
460  RegisteredBgWorker *rw;
461  BackgroundWorkerSlot *slot;
462  int notify_pid;
463 
464  rw = slist_container(RegisteredBgWorker, rw_lnode, cur->cur);
465 
468  slot->pid = rw->rw_pid;
469  notify_pid = rw->rw_worker.bgw_notify_pid;
470 
471  /*
472  * If this worker is slated for deregistration, do that before notifying
473  * the process which started it. Otherwise, if that process tries to
474  * reuse the slot immediately, it might not be available yet. In theory
475  * that could happen anyway if the process checks slot->pid at just the
476  * wrong moment, but this makes the window narrower.
477  */
478  if (rw->rw_terminate ||
481 
482  if (notify_pid != 0)
483  kill(notify_pid, SIGUSR1);
484 }
#define SIGUSR1
Definition: win32_port.h:165
static BackgroundWorkerArray * BackgroundWorkerData
Definition: bgworker.c:110
slist_node * cur
Definition: ilist.h:241
int bgw_restart_time
Definition: bgworker.h:94
#define kill(pid, sig)
Definition: win32_port.h:426
void ForgetBackgroundWorker(slist_mutable_iter *cur)
Definition: bgworker.c:411
#define BGW_NEVER_RESTART
Definition: bgworker.h:84
#define slist_container(type, membername, ptr)
Definition: ilist.h:674
#define Assert(condition)
Definition: c.h:738
pid_t bgw_notify_pid
Definition: bgworker.h:99
int max_worker_processes
Definition: globals.c:133
BackgroundWorker rw_worker
BackgroundWorkerSlot slot[FLEXIBLE_ARRAY_MEMBER]
Definition: bgworker.c:101

◆ ReportBackgroundWorkerPID()

void ReportBackgroundWorkerPID ( RegisteredBgWorker rw)

Definition at line 439 of file bgworker.c.

References Assert, BackgroundWorker::bgw_notify_pid, kill, max_worker_processes, BackgroundWorkerSlot::pid, RegisteredBgWorker::rw_pid, RegisteredBgWorker::rw_shmem_slot, RegisteredBgWorker::rw_worker, SIGUSR1, and BackgroundWorkerArray::slot.

Referenced by BackgroundWorkerStateChange(), and do_start_bgworker().

440 {
441  BackgroundWorkerSlot *slot;
442 
445  slot->pid = rw->rw_pid;
446 
447  if (rw->rw_worker.bgw_notify_pid != 0)
449 }
#define SIGUSR1
Definition: win32_port.h:165
static BackgroundWorkerArray * BackgroundWorkerData
Definition: bgworker.c:110
#define kill(pid, sig)
Definition: win32_port.h:426
#define Assert(condition)
Definition: c.h:738
pid_t bgw_notify_pid
Definition: bgworker.h:99
int max_worker_processes
Definition: globals.c:133
BackgroundWorker rw_worker
BackgroundWorkerSlot slot[FLEXIBLE_ARRAY_MEMBER]
Definition: bgworker.c:101

◆ ResetBackgroundWorkerCrashTimes()

void ResetBackgroundWorkerCrashTimes ( void  )

Definition at line 514 of file bgworker.c.

References Assert, BackgroundWorker::bgw_flags, BGW_NEVER_RESTART, BackgroundWorker::bgw_restart_time, BGWORKER_CLASS_PARALLEL, slist_mutable_iter::cur, ForgetBackgroundWorker(), BackgroundWorkerSlot::in_use, RegisteredBgWorker::rw_crashed_at, RegisteredBgWorker::rw_worker, slist_container, slist_foreach_modify, BackgroundWorkerArray::slot, and BackgroundWorkerSlot::worker.

Referenced by PostmasterStateMachine().

515 {
516  slist_mutable_iter iter;
517 
519  {
520  RegisteredBgWorker *rw;
521 
522  rw = slist_container(RegisteredBgWorker, rw_lnode, iter.cur);
523 
525  {
526  /*
527  * Workers marked BGW_NEVER_RESTART shouldn't get relaunched after
528  * the crash, so forget about them. (If we wait until after the
529  * crash to forget about them, and they are parallel workers,
530  * parallel_terminate_count will get incremented after we've
531  * already zeroed parallel_register_count, which would be bad.)
532  */
533  ForgetBackgroundWorker(&iter);
534  }
535  else
536  {
537  /*
538  * The accounting which we do via parallel_register_count and
539  * parallel_terminate_count would get messed up if a worker marked
540  * parallel could survive a crash and restart cycle. All such
541  * workers should be marked BGW_NEVER_RESTART, and thus control
542  * should never reach this branch.
543  */
545 
546  /*
547  * Allow this worker to be restarted immediately after we finish
548  * resetting.
549  */
550  rw->rw_crashed_at = 0;
551  }
552  }
553 }
slist_node * cur
Definition: ilist.h:241
int bgw_restart_time
Definition: bgworker.h:94
#define BGWORKER_CLASS_PARALLEL
Definition: bgworker.h:67
#define slist_foreach_modify(iter, lhead)
Definition: ilist.h:716
slist_head BackgroundWorkerList
Definition: bgworker.c:42
void ForgetBackgroundWorker(slist_mutable_iter *cur)
Definition: bgworker.c:411
#define BGW_NEVER_RESTART
Definition: bgworker.h:84
#define slist_container(type, membername, ptr)
Definition: ilist.h:674
#define Assert(condition)
Definition: c.h:738
BackgroundWorker rw_worker

◆ SanityCheckBackgroundWorker()

static bool SanityCheckBackgroundWorker ( BackgroundWorker worker,
int  elevel 
)
static

Definition at line 582 of file bgworker.c.

References BackgroundWorker::bgw_flags, BackgroundWorker::bgw_name, BGW_NEVER_RESTART, BackgroundWorker::bgw_restart_time, BackgroundWorker::bgw_start_time, BackgroundWorker::bgw_type, BGWORKER_BACKEND_DATABASE_CONNECTION, BGWORKER_CLASS_PARALLEL, BGWORKER_SHMEM_ACCESS, BgWorkerStart_PostmasterStart, ereport, errcode(), errmsg(), and USECS_PER_DAY.

Referenced by RegisterBackgroundWorker(), and RegisterDynamicBackgroundWorker().

583 {
584  /* sanity check for flags */
586  {
587  if (!(worker->bgw_flags & BGWORKER_SHMEM_ACCESS))
588  {
589  ereport(elevel,
590  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
591  errmsg("background worker \"%s\": must attach to shared memory in order to request a database connection",
592  worker->bgw_name)));
593  return false;
594  }
595 
597  {
598  ereport(elevel,
599  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
600  errmsg("background worker \"%s\": cannot request database access if starting at postmaster start",
601  worker->bgw_name)));
602  return false;
603  }
604 
605  /* XXX other checks? */
606  }
607 
608  if ((worker->bgw_restart_time < 0 &&
609  worker->bgw_restart_time != BGW_NEVER_RESTART) ||
610  (worker->bgw_restart_time > USECS_PER_DAY / 1000))
611  {
612  ereport(elevel,
613  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
614  errmsg("background worker \"%s\": invalid restart interval",
615  worker->bgw_name)));
616  return false;
617  }
618 
619  /*
620  * Parallel workers may not be configured for restart, because the
621  * parallel_register_count/parallel_terminate_count accounting can't
622  * handle parallel workers lasting through a crash-and-restart cycle.
623  */
624  if (worker->bgw_restart_time != BGW_NEVER_RESTART &&
625  (worker->bgw_flags & BGWORKER_CLASS_PARALLEL) != 0)
626  {
627  ereport(elevel,
628  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
629  errmsg("background worker \"%s\": parallel workers may not be configured for restart",
630  worker->bgw_name)));
631  return false;
632  }
633 
634  /*
635  * If bgw_type is not filled in, use bgw_name.
636  */
637  if (strcmp(worker->bgw_type, "") == 0)
638  strcpy(worker->bgw_type, worker->bgw_name);
639 
640  return true;
641 }
int bgw_restart_time
Definition: bgworker.h:94
int errcode(int sqlerrcode)
Definition: elog.c:610
#define BGWORKER_CLASS_PARALLEL
Definition: bgworker.h:67
#define BGWORKER_SHMEM_ACCESS
Definition: bgworker.h:52
#define BGW_NEVER_RESTART
Definition: bgworker.h:84
#define USECS_PER_DAY
Definition: timestamp.h:91
static int elevel
Definition: vacuumlazy.c:323
#define ereport(elevel,...)
Definition: elog.h:144
char bgw_name[BGW_MAXLEN]
Definition: bgworker.h:90
#define BGWORKER_BACKEND_DATABASE_CONNECTION
Definition: bgworker.h:59
BgWorkerStartTime bgw_start_time
Definition: bgworker.h:93
char bgw_type[BGW_MAXLEN]
Definition: bgworker.h:91
int errmsg(const char *fmt,...)
Definition: elog.c:824

◆ StartBackgroundWorker()

void StartBackgroundWorker ( void  )

Definition at line 680 of file bgworker.c.

References B_BG_WORKER, BaseInit(), BackgroundWorker::bgw_flags, BackgroundWorker::bgw_function_name, BackgroundWorker::bgw_library_name, BackgroundWorker::bgw_main_arg, BackgroundWorker::bgw_name, BGWORKER_BACKEND_DATABASE_CONNECTION, bgworker_die(), BGWORKER_SHMEM_ACCESS, bgworker_sigusr1_handler(), dsm_detach_all(), elog, EmitErrorReport(), error_context_stack, FATAL, FloatExceptionHandler(), HOLD_INTERRUPTS, init_ps_display(), InitializeTimeouts(), InitProcess(), InitProcessing, IsBackgroundWorker, LookupBackgroundWorkerFunction(), MyBackendType, MyBgworkerEntry, PG_exception_stack, pg_usleep(), PGSharedMemoryDetach(), PostAuthDelay, pqsignal(), proc_exit(), procsignal_sigusr1_handler(), SetProcessingMode, SIG_DFL, SIG_IGN, SIGCHLD, SIGHUP, SignalHandlerForCrashExit(), SIGPIPE, SIGQUIT, SIGUSR1, SIGUSR2, StatementCancelHandler(), and BackgroundWorkerSlot::worker.

Referenced by BackendRun(), and do_start_bgworker().

681 {
682  sigjmp_buf local_sigjmp_buf;
684  bgworker_main_type entrypt;
685 
686  if (worker == NULL)
687  elog(FATAL, "unable to find bgworker entry");
688 
689  IsBackgroundWorker = true;
690 
692  init_ps_display(worker->bgw_name);
693 
694  /*
695  * If we're not supposed to have shared memory access, then detach from
696  * shared memory. If we didn't request shared memory access, the
697  * postmaster won't force a cluster-wide restart if we exit unexpectedly,
698  * so we'd better make sure that we don't mess anything up that would
699  * require that sort of cleanup.
700  */
701  if ((worker->bgw_flags & BGWORKER_SHMEM_ACCESS) == 0)
702  {
703  dsm_detach_all();
705  }
706 
708 
709  /* Apply PostAuthDelay */
710  if (PostAuthDelay > 0)
711  pg_usleep(PostAuthDelay * 1000000L);
712 
713  /*
714  * Set up signal handlers.
715  */
717  {
718  /*
719  * SIGINT is used to signal canceling the current action
720  */
724 
725  /* XXX Any other handlers needed here? */
726  }
727  else
728  {
729  pqsignal(SIGINT, SIG_IGN);
731  pqsignal(SIGFPE, SIG_IGN);
732  }
733  pqsignal(SIGTERM, bgworker_die);
735 
737  InitializeTimeouts(); /* establishes SIGALRM handler */
738 
742 
743  /*
744  * If an exception is encountered, processing resumes here.
745  *
746  * See notes in postgres.c about the design of this coding.
747  */
748  if (sigsetjmp(local_sigjmp_buf, 1) != 0)
749  {
750  /* Since not using PG_TRY, must reset error stack by hand */
751  error_context_stack = NULL;
752 
753  /* Prevent interrupts while cleaning up */
754  HOLD_INTERRUPTS();
755 
756  /* Report the error to the server log */
757  EmitErrorReport();
758 
759  /*
760  * Do we need more cleanup here? For shmem-connected bgworkers, we
761  * will call InitProcess below, which will install ProcKill as exit
762  * callback. That will take care of releasing locks, etc.
763  */
764 
765  /* and go away */
766  proc_exit(1);
767  }
768 
769  /* We can now handle ereport(ERROR) */
770  PG_exception_stack = &local_sigjmp_buf;
771 
772  /*
773  * If the background worker request shared memory access, set that up now;
774  * else, detach all shared memory segments.
775  */
776  if (worker->bgw_flags & BGWORKER_SHMEM_ACCESS)
777  {
778  /*
779  * Early initialization. Some of this could be useful even for
780  * background workers that aren't using shared memory, but they can
781  * call the individual startup routines for those subsystems if
782  * needed.
783  */
784  BaseInit();
785 
786  /*
787  * Create a per-backend PGPROC struct in shared memory, except in the
788  * EXEC_BACKEND case where this was done in SubPostmasterMain. We must
789  * do this before we can use LWLocks (and in the EXEC_BACKEND case we
790  * already had to do some stuff with LWLocks).
791  */
792 #ifndef EXEC_BACKEND
793  InitProcess();
794 #endif
795  }
796 
797  /*
798  * Look up the entry point function, loading its library if necessary.
799  */
801  worker->bgw_function_name);
802 
803  /*
804  * Note that in normal processes, we would call InitPostgres here. For a
805  * worker, however, we don't know what database to connect to, yet; so we
806  * need to wait until the user code does it via
807  * BackgroundWorkerInitializeConnection().
808  */
809 
810  /*
811  * Now invoke the user-defined worker code
812  */
813  entrypt(worker->bgw_main_arg);
814 
815  /* ... and if it returns, we're done */
816  proc_exit(0);
817 }
void InitializeTimeouts(void)
Definition: timeout.c:346
static void bgworker_sigusr1_handler(SIGNAL_ARGS)
Definition: bgworker.c:664
#define SIGQUIT
Definition: win32_port.h:154
#define SIGUSR1
Definition: win32_port.h:165
BackendType MyBackendType
Definition: miscinit.c:60
#define SIGCHLD
Definition: win32_port.h:163
void proc_exit(int code)
Definition: ipc.c:104
#define SetProcessingMode(mode)
Definition: miscadmin.h:398
BackgroundWorker * MyBgworkerEntry
Definition: postmaster.c:192
void BaseInit(void)
Definition: postinit.c:548
#define SIGPIPE
Definition: win32_port.h:158
#define SIGUSR2
Definition: win32_port.h:166
#define BGWORKER_SHMEM_ACCESS
Definition: bgworker.h:52
char bgw_function_name[BGW_MAXLEN]
Definition: bgworker.h:96
void PGSharedMemoryDetach(void)
Definition: sysv_shmem.c:881
void StatementCancelHandler(SIGNAL_ARGS)
Definition: postgres.c:2857
bool IsBackgroundWorker
Definition: globals.c:111
ErrorContextCallback * error_context_stack
Definition: elog.c:92
void pg_usleep(long microsec)
Definition: signal.c:53
Datum bgw_main_arg
Definition: bgworker.h:97
void SignalHandlerForCrashExit(SIGNAL_ARGS)
Definition: interrupt.c:72
#define FATAL
Definition: elog.h:52
void InitProcess(void)
Definition: proc.c:304
#define SIGHUP
Definition: win32_port.h:153
static bgworker_main_type LookupBackgroundWorkerFunction(const char *libraryname, const char *funcname)
Definition: bgworker.c:1197
#define SIG_IGN
Definition: win32_port.h:150
int PostAuthDelay
Definition: postgres.c:102
void EmitErrorReport(void)
Definition: elog.c:1423
pqsigfunc pqsignal(int signum, pqsigfunc handler)
Definition: signal.c:170
#define SIG_DFL
Definition: win32_port.h:148
char bgw_name[BGW_MAXLEN]
Definition: bgworker.h:90
#define BGWORKER_BACKEND_DATABASE_CONNECTION
Definition: bgworker.h:59
void dsm_detach_all(void)
Definition: dsm.c:630
sigjmp_buf * PG_exception_stack
Definition: elog.c:94
#define HOLD_INTERRUPTS()
Definition: miscadmin.h:116
#define elog(elevel,...)
Definition: elog.h:214
void FloatExceptionHandler(SIGNAL_ARGS)
Definition: postgres.c:2878
static void bgworker_die(SIGNAL_ARGS)
Definition: bgworker.c:647
void init_ps_display(const char *fixed_part)
Definition: ps_status.c:258
void procsignal_sigusr1_handler(SIGNAL_ARGS)
Definition: procsignal.c:533
char bgw_library_name[BGW_MAXLEN]
Definition: bgworker.h:95
void(* bgworker_main_type)(Datum main_arg)
Definition: bgworker.h:71

◆ TerminateBackgroundWorker()

void TerminateBackgroundWorker ( BackgroundWorkerHandle handle)

Definition at line 1156 of file bgworker.c.

References Assert, BackgroundWorkerSlot::generation, BackgroundWorkerHandle::generation, LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), max_worker_processes, PMSIGNAL_BACKGROUND_WORKER_CHANGE, SendPostmasterSignal(), BackgroundWorkerArray::slot, BackgroundWorkerHandle::slot, and BackgroundWorkerSlot::terminate.

Referenced by cleanup_background_workers(), and DestroyParallelContext().

1157 {
1158  BackgroundWorkerSlot *slot;
1159  bool signal_postmaster = false;
1160 
1161  Assert(handle->slot < max_worker_processes);
1162  slot = &BackgroundWorkerData->slot[handle->slot];
1163 
1164  /* Set terminate flag in shared memory, unless slot has been reused. */
1165  LWLockAcquire(BackgroundWorkerLock, LW_EXCLUSIVE);
1166  if (handle->generation == slot->generation)
1167  {
1168  slot->terminate = true;
1169  signal_postmaster = true;
1170  }
1171  LWLockRelease(BackgroundWorkerLock);
1172 
1173  /* Make sure the postmaster notices the change to shared memory. */
1174  if (signal_postmaster)
1176 }
static BackgroundWorkerArray * BackgroundWorkerData
Definition: bgworker.c:110
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1812
#define Assert(condition)
Definition: c.h:738
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1208
int max_worker_processes
Definition: globals.c:133
void SendPostmasterSignal(PMSignalReason reason)
Definition: pmsignal.c:146
BackgroundWorkerSlot slot[FLEXIBLE_ARRAY_MEMBER]
Definition: bgworker.c:101

◆ WaitForBackgroundWorkerShutdown()

BgwHandleStatus WaitForBackgroundWorkerShutdown ( BackgroundWorkerHandle handle)

Definition at line 1117 of file bgworker.c.

References BGWH_POSTMASTER_DIED, BGWH_STOPPED, CHECK_FOR_INTERRUPTS, GetBackgroundWorkerPid(), MyLatch, BackgroundWorkerSlot::pid, ResetLatch(), status(), WAIT_EVENT_BGWORKER_SHUTDOWN, WaitLatch(), WL_LATCH_SET, and WL_POSTMASTER_DEATH.

Referenced by apw_start_database_worker(), and WaitForParallelWorkersToExit().

1118 {
1120  int rc;
1121 
1122  for (;;)
1123  {
1124  pid_t pid;
1125 
1127 
1128  status = GetBackgroundWorkerPid(handle, &pid);
1129  if (status == BGWH_STOPPED)
1130  break;
1131 
1132  rc = WaitLatch(MyLatch,
1135 
1136  if (rc & WL_POSTMASTER_DEATH)
1137  {
1138  status = BGWH_POSTMASTER_DIED;
1139  break;
1140  }
1141 
1143  }
1144 
1145  return status;
1146 }
void ResetLatch(Latch *latch)
Definition: latch.c:540
int WaitLatch(Latch *latch, int wakeEvents, long timeout, uint32 wait_event_info)
Definition: latch.c:365
BgwHandleStatus
Definition: bgworker.h:102
#define WL_POSTMASTER_DEATH
Definition: latch.h:128
struct Latch * MyLatch
Definition: globals.c:54
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:99
static void static void status(const char *fmt,...) pg_attribute_printf(1
Definition: pg_regress.c:225
#define WL_LATCH_SET
Definition: latch.h:124
BgwHandleStatus GetBackgroundWorkerPid(BackgroundWorkerHandle *handle, pid_t *pidp)
Definition: bgworker.c:1023

◆ WaitForBackgroundWorkerStartup()

BgwHandleStatus WaitForBackgroundWorkerStartup ( BackgroundWorkerHandle handle,
pid_t *  pidp 
)

Definition at line 1075 of file bgworker.c.

References BGWH_NOT_YET_STARTED, BGWH_POSTMASTER_DIED, BGWH_STARTED, CHECK_FOR_INTERRUPTS, GetBackgroundWorkerPid(), MyLatch, BackgroundWorkerSlot::pid, ResetLatch(), status(), WAIT_EVENT_BGWORKER_STARTUP, WaitLatch(), WL_LATCH_SET, and WL_POSTMASTER_DEATH.

Referenced by apw_start_master_worker(), and worker_spi_launch().

1076 {
1078  int rc;
1079 
1080  for (;;)
1081  {
1082  pid_t pid;
1083 
1085 
1086  status = GetBackgroundWorkerPid(handle, &pid);
1087  if (status == BGWH_STARTED)
1088  *pidp = pid;
1089  if (status != BGWH_NOT_YET_STARTED)
1090  break;
1091 
1092  rc = WaitLatch(MyLatch,
1095 
1096  if (rc & WL_POSTMASTER_DEATH)
1097  {
1098  status = BGWH_POSTMASTER_DIED;
1099  break;
1100  }
1101 
1103  }
1104 
1105  return status;
1106 }
void ResetLatch(Latch *latch)
Definition: latch.c:540
int WaitLatch(Latch *latch, int wakeEvents, long timeout, uint32 wait_event_info)
Definition: latch.c:365
BgwHandleStatus
Definition: bgworker.h:102
#define WL_POSTMASTER_DEATH
Definition: latch.h:128
struct Latch * MyLatch
Definition: globals.c:54
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:99
static void static void status(const char *fmt,...) pg_attribute_printf(1
Definition: pg_regress.c:225
#define WL_LATCH_SET
Definition: latch.h:124
BgwHandleStatus GetBackgroundWorkerPid(BackgroundWorkerHandle *handle, pid_t *pidp)
Definition: bgworker.c:1023

Variable Documentation

◆ BackgroundWorkerData

BackgroundWorkerArray* BackgroundWorkerData
static

Definition at line 110 of file bgworker.c.

◆ BackgroundWorkerList

slist_head BackgroundWorkerList = SLIST_STATIC_INIT(BackgroundWorkerList)

◆ fn_addr

Definition at line 119 of file bgworker.c.

Referenced by LookupBackgroundWorkerFunction().

◆ fn_name

const char* fn_name

Definition at line 118 of file bgworker.c.

Referenced by LookupBackgroundWorkerFunction().

◆ InternalBGWorkers

const { ... } InternalBGWorkers[]
Initial value:
=
{
{
"ParallelWorkerMain", ParallelWorkerMain
},
{
"ApplyLauncherMain", ApplyLauncherMain
},
{
"ApplyWorkerMain", ApplyWorkerMain
}
}
void ApplyLauncherMain(Datum main_arg)
Definition: launcher.c:946
void ParallelWorkerMain(Datum main_arg)
Definition: parallel.c:1239
void ApplyWorkerMain(Datum main_arg)
Definition: worker.c:1946

Referenced by LookupBackgroundWorkerFunction().