PostgreSQL Source Code  git master
bgworker.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  BackgroundWorker
 

Macros

#define BGWORKER_SHMEM_ACCESS   0x0001
 
#define BGWORKER_BACKEND_DATABASE_CONNECTION   0x0002
 
#define BGWORKER_CLASS_PARALLEL   0x0010
 
#define BGW_DEFAULT_RESTART_INTERVAL   60
 
#define BGW_NEVER_RESTART   -1
 
#define BGW_MAXLEN   64
 
#define BGW_EXTRALEN   128
 

Typedefs

typedef void(* bgworker_main_type) (Datum main_arg)
 
typedef struct BackgroundWorker BackgroundWorker
 
typedef enum BgwHandleStatus BgwHandleStatus
 
typedef struct BackgroundWorkerHandle BackgroundWorkerHandle
 

Enumerations

enum  BgWorkerStartTime { BgWorkerStart_PostmasterStart, BgWorkerStart_ConsistentState, BgWorkerStart_RecoveryFinished }
 
enum  BgwHandleStatus { BGWH_STARTED, BGWH_NOT_YET_STARTED, BGWH_STOPPED, BGWH_POSTMASTER_DIED }
 

Functions

void RegisterBackgroundWorker (BackgroundWorker *worker)
 
bool RegisterDynamicBackgroundWorker (BackgroundWorker *worker, BackgroundWorkerHandle **handle)
 
BgwHandleStatus GetBackgroundWorkerPid (BackgroundWorkerHandle *handle, pid_t *pidp)
 
BgwHandleStatus WaitForBackgroundWorkerStartup (BackgroundWorkerHandle *handle, pid_t *pid)
 
BgwHandleStatus WaitForBackgroundWorkerShutdown (BackgroundWorkerHandle *)
 
const char * GetBackgroundWorkerTypeByPid (pid_t pid)
 
void TerminateBackgroundWorker (BackgroundWorkerHandle *handle)
 
void BackgroundWorkerInitializeConnection (const char *dbname, const char *username)
 
void BackgroundWorkerInitializeConnectionByOid (Oid dboid, Oid useroid)
 
void BackgroundWorkerBlockSignals (void)
 
void BackgroundWorkerUnblockSignals (void)
 

Variables

PGDLLIMPORT BackgroundWorkerMyBgworkerEntry
 

Macro Definition Documentation

◆ BGW_DEFAULT_RESTART_INTERVAL

#define BGW_DEFAULT_RESTART_INTERVAL   60

Definition at line 83 of file bgworker.h.

◆ BGW_EXTRALEN

#define BGW_EXTRALEN   128

Definition at line 86 of file bgworker.h.

Referenced by BackgroundWorkerStateChange().

◆ BGW_MAXLEN

◆ BGW_NEVER_RESTART

◆ BGWORKER_BACKEND_DATABASE_CONNECTION

◆ BGWORKER_CLASS_PARALLEL

◆ BGWORKER_SHMEM_ACCESS

Typedef Documentation

◆ BackgroundWorker

◆ BackgroundWorkerHandle

◆ BgwHandleStatus

◆ bgworker_main_type

typedef void(* bgworker_main_type) (Datum main_arg)

Definition at line 71 of file bgworker.h.

Enumeration Type Documentation

◆ BgwHandleStatus

Enumerator
BGWH_STARTED 
BGWH_NOT_YET_STARTED 
BGWH_STOPPED 
BGWH_POSTMASTER_DIED 

Definition at line 102 of file bgworker.h.

103 {
104  BGWH_STARTED, /* worker is running */
105  BGWH_NOT_YET_STARTED, /* worker hasn't been started yet */
106  BGWH_STOPPED, /* worker has exited */
107  BGWH_POSTMASTER_DIED /* postmaster died; worker status unclear */
BgwHandleStatus
Definition: bgworker.h:102

◆ BgWorkerStartTime

Enumerator
BgWorkerStart_PostmasterStart 
BgWorkerStart_ConsistentState 
BgWorkerStart_RecoveryFinished 

Definition at line 76 of file bgworker.h.

Function Documentation

◆ BackgroundWorkerBlockSignals()

void BackgroundWorkerBlockSignals ( void  )

Definition at line 5634 of file postmaster.c.

References BlockSig, and PG_SETMASK.

5635 {
5636  PG_SETMASK(&BlockSig);
5637 }
#define PG_SETMASK(mask)
Definition: pqsignal.h:19
sigset_t BlockSig
Definition: pqsignal.c:22

◆ BackgroundWorkerInitializeConnection()

void BackgroundWorkerInitializeConnection ( const char *  dbname,
const char *  username 
)

Definition at line 5588 of file postmaster.c.

References BackgroundWorker::bgw_flags, BGWORKER_BACKEND_DATABASE_CONNECTION, ereport, errcode(), errmsg(), ERROR, FATAL, InitPostgres(), InvalidOid, IsInitProcessingMode, MyBgworkerEntry, NormalProcessing, and SetProcessingMode.

Referenced by ApplyLauncherMain(), and initialize_worker_spi().

5589 {
5591 
5592  /* XXX is this the right errcode? */
5594  ereport(FATAL,
5595  (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
5596  errmsg("database connection requirement not indicated during registration")));
5597 
5599 
5600  /* it had better not gotten out of "init" mode yet */
5601  if (!IsInitProcessingMode())
5602  ereport(ERROR,
5603  (errmsg("invalid processing mode in background worker")));
5605 }
int errcode(int sqlerrcode)
Definition: elog.c:575
#define SetProcessingMode(mode)
Definition: miscadmin.h:373
BackgroundWorker * MyBgworkerEntry
Definition: postmaster.c:190
#define ERROR
Definition: elog.h:43
#define FATAL
Definition: elog.h:52
#define ereport(elevel, rest)
Definition: elog.h:122
static char * username
Definition: initdb.c:132
#define InvalidOid
Definition: postgres_ext.h:36
#define BGWORKER_BACKEND_DATABASE_CONNECTION
Definition: bgworker.h:59
char * dbname
Definition: streamutil.c:42
void InitPostgres(const char *in_dbname, Oid dboid, const char *username, Oid useroid, char *out_dbname)
Definition: postinit.c:559
int errmsg(const char *fmt,...)
Definition: elog.c:797
#define IsInitProcessingMode()
Definition: miscadmin.h:368

◆ BackgroundWorkerInitializeConnectionByOid()

void BackgroundWorkerInitializeConnectionByOid ( Oid  dboid,
Oid  useroid 
)

Definition at line 5611 of file postmaster.c.

References BackgroundWorker::bgw_flags, BGWORKER_BACKEND_DATABASE_CONNECTION, ereport, errcode(), errmsg(), ERROR, FATAL, InitPostgres(), IsInitProcessingMode, MyBgworkerEntry, NormalProcessing, and SetProcessingMode.

Referenced by ApplyWorkerMain(), autoprewarm_database_main(), and ParallelWorkerMain().

5612 {
5614 
5615  /* XXX is this the right errcode? */
5617  ereport(FATAL,
5618  (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
5619  errmsg("database connection requirement not indicated during registration")));
5620 
5621  InitPostgres(NULL, dboid, NULL, useroid, NULL);
5622 
5623  /* it had better not gotten out of "init" mode yet */
5624  if (!IsInitProcessingMode())
5625  ereport(ERROR,
5626  (errmsg("invalid processing mode in background worker")));
5628 }
int errcode(int sqlerrcode)
Definition: elog.c:575
#define SetProcessingMode(mode)
Definition: miscadmin.h:373
BackgroundWorker * MyBgworkerEntry
Definition: postmaster.c:190
#define ERROR
Definition: elog.h:43
#define FATAL
Definition: elog.h:52
#define ereport(elevel, rest)
Definition: elog.h:122
#define BGWORKER_BACKEND_DATABASE_CONNECTION
Definition: bgworker.h:59
void InitPostgres(const char *in_dbname, Oid dboid, const char *username, Oid useroid, char *out_dbname)
Definition: postinit.c:559
int errmsg(const char *fmt,...)
Definition: elog.c:797
#define IsInitProcessingMode()
Definition: miscadmin.h:368

◆ BackgroundWorkerUnblockSignals()

void BackgroundWorkerUnblockSignals ( void  )

Definition at line 5640 of file postmaster.c.

References Assert, av, lengthof, MAXPGPATH, PG_SETMASK, snprintf(), and UnBlockSig.

Referenced by ApplyLauncherMain(), ApplyWorkerMain(), autoprewarm_database_main(), autoprewarm_main(), initialize_worker_spi(), ParallelWorkerMain(), and test_shm_mq_main().

5641 {
5643 }
#define PG_SETMASK(mask)
Definition: pqsignal.h:19
sigset_t UnBlockSig
Definition: pqsignal.c:22

◆ GetBackgroundWorkerPid()

BgwHandleStatus GetBackgroundWorkerPid ( BackgroundWorkerHandle handle,
pid_t *  pidp 
)

Definition at line 1047 of file bgworker.c.

References Assert, BGWH_NOT_YET_STARTED, BGWH_STARTED, BGWH_STOPPED, BackgroundWorkerSlot::generation, BackgroundWorkerHandle::generation, 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(), and WaitForReplicationWorkerAttach().

1048 {
1049  BackgroundWorkerSlot *slot;
1050  pid_t pid;
1051 
1052  Assert(handle->slot < max_worker_processes);
1053  slot = &BackgroundWorkerData->slot[handle->slot];
1054 
1055  /*
1056  * We could probably arrange to synchronize access to data using memory
1057  * barriers only, but for now, let's just keep it simple and grab the
1058  * lock. It seems unlikely that there will be enough traffic here to
1059  * result in meaningful contention.
1060  */
1061  LWLockAcquire(BackgroundWorkerLock, LW_SHARED);
1062 
1063  /*
1064  * The generation number can't be concurrently changed while we hold the
1065  * lock. The pid, which is updated by the postmaster, can change at any
1066  * time, but we assume such changes are atomic. So the value we read
1067  * won't be garbage, but it might be out of date by the time the caller
1068  * examines it (but that's unavoidable anyway).
1069  */
1070  if (handle->generation != slot->generation)
1071  pid = 0;
1072  else
1073  pid = slot->pid;
1074 
1075  /* All done. */
1076  LWLockRelease(BackgroundWorkerLock);
1077 
1078  if (pid == 0)
1079  return BGWH_STOPPED;
1080  else if (pid == InvalidPid)
1081  return BGWH_NOT_YET_STARTED;
1082  *pidp = pid;
1083  return BGWH_STARTED;
1084 }
static BackgroundWorkerArray * BackgroundWorkerData
Definition: bgworker.c:111
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1721
#define Assert(condition)
Definition: c.h:670
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1117
int max_worker_processes
Definition: globals.c:124
BackgroundWorkerSlot slot[FLEXIBLE_ARRAY_MEMBER]
Definition: bgworker.c:102
#define InvalidPid
Definition: miscadmin.h:31

◆ GetBackgroundWorkerTypeByPid()

const char* GetBackgroundWorkerTypeByPid ( pid_t  pid)

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

1253 {
1254  int slotno;
1255  bool found = false;
1256  static char result[BGW_MAXLEN];
1257 
1258  LWLockAcquire(BackgroundWorkerLock, LW_SHARED);
1259 
1260  for (slotno = 0; slotno < BackgroundWorkerData->total_slots; slotno++)
1261  {
1263 
1264  if (slot->pid > 0 && slot->pid == pid)
1265  {
1266  strcpy(result, slot->worker.bgw_type);
1267  found = true;
1268  break;
1269  }
1270  }
1271 
1272  LWLockRelease(BackgroundWorkerLock);
1273 
1274  if (!found)
1275  return NULL;
1276 
1277  return result;
1278 }
static BackgroundWorkerArray * BackgroundWorkerData
Definition: bgworker.c:111
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1721
BackgroundWorker worker
Definition: bgworker.c:83
#define BGW_MAXLEN
Definition: bgworker.h:85
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1117
char bgw_type[BGW_MAXLEN]
Definition: bgworker.h:91
BackgroundWorkerSlot slot[FLEXIBLE_ARRAY_MEMBER]
Definition: bgworker.c:102

◆ RegisterBackgroundWorker()

void RegisterBackgroundWorker ( BackgroundWorker worker)

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

856 {
857  RegisteredBgWorker *rw;
858  static int numworkers = 0;
859 
860  if (!IsUnderPostmaster)
861  ereport(DEBUG1,
862  (errmsg("registering background worker \"%s\"", worker->bgw_name)));
863 
865  strcmp(worker->bgw_library_name, "postgres") != 0)
866  {
867  if (!IsUnderPostmaster)
868  ereport(LOG,
869  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
870  errmsg("background worker \"%s\": must be registered in shared_preload_libraries",
871  worker->bgw_name)));
872  return;
873  }
874 
875  if (!SanityCheckBackgroundWorker(worker, LOG))
876  return;
877 
878  if (worker->bgw_notify_pid != 0)
879  {
880  ereport(LOG,
881  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
882  errmsg("background worker \"%s\": only dynamic background workers can request notification",
883  worker->bgw_name)));
884  return;
885  }
886 
887  /*
888  * Enforce maximum number of workers. Note this is overly restrictive: we
889  * could allow more non-shmem-connected workers, because these don't count
890  * towards the MAX_BACKENDS limit elsewhere. For now, it doesn't seem
891  * important to relax this restriction.
892  */
893  if (++numworkers > max_worker_processes)
894  {
895  ereport(LOG,
896  (errcode(ERRCODE_CONFIGURATION_LIMIT_EXCEEDED),
897  errmsg("too many background workers"),
898  errdetail_plural("Up to %d background worker can be registered with the current settings.",
899  "Up to %d background workers can be registered with the current settings.",
902  errhint("Consider increasing the configuration parameter \"max_worker_processes\".")));
903  return;
904  }
905 
906  /*
907  * Copy the registration data into the registered workers list.
908  */
909  rw = malloc(sizeof(RegisteredBgWorker));
910  if (rw == NULL)
911  {
912  ereport(LOG,
913  (errcode(ERRCODE_OUT_OF_MEMORY),
914  errmsg("out of memory")));
915  return;
916  }
917 
918  rw->rw_worker = *worker;
919  rw->rw_backend = NULL;
920  rw->rw_pid = 0;
921  rw->rw_child_slot = 0;
922  rw->rw_crashed_at = 0;
923  rw->rw_terminate = false;
924 
926 }
struct bkend * rw_backend
#define DEBUG1
Definition: elog.h:25
int errhint(const char *fmt,...)
Definition: elog.c:987
bool process_shared_preload_libraries_in_progress
Definition: miscinit.c:1426
static void slist_push_head(slist_head *head, slist_node *node)
Definition: ilist.h:574
int errcode(int sqlerrcode)
Definition: elog.c:575
#define LOG
Definition: elog.h:26
#define malloc(a)
Definition: header.h:50
slist_head BackgroundWorkerList
Definition: bgworker.c:43
bool IsUnderPostmaster
Definition: globals.c:101
#define ereport(elevel, rest)
Definition: elog.h:122
static bool SanityCheckBackgroundWorker(BackgroundWorker *worker, int elevel)
Definition: bgworker.c:583
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:965
int errmsg(const char *fmt,...)
Definition: elog.c:797
pid_t bgw_notify_pid
Definition: bgworker.h:99
int max_worker_processes
Definition: globals.c:124
BackgroundWorker rw_worker
char bgw_library_name[BGW_MAXLEN]
Definition: bgworker.h:95

◆ RegisterDynamicBackgroundWorker()

bool RegisterDynamicBackgroundWorker ( BackgroundWorker worker,
BackgroundWorkerHandle **  handle 
)

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

941 {
942  int slotno;
943  bool success = false;
944  bool parallel;
945  uint64 generation = 0;
946 
947  /*
948  * We can't register dynamic background workers from the postmaster. If
949  * this is a standalone backend, we're the only process and can't start
950  * any more. In a multi-process environment, it might be theoretically
951  * possible, but we don't currently support it due to locking
952  * considerations; see comments on the BackgroundWorkerSlot data
953  * structure.
954  */
955  if (!IsUnderPostmaster)
956  return false;
957 
958  if (!SanityCheckBackgroundWorker(worker, ERROR))
959  return false;
960 
961  parallel = (worker->bgw_flags & BGWORKER_CLASS_PARALLEL) != 0;
962 
963  LWLockAcquire(BackgroundWorkerLock, LW_EXCLUSIVE);
964 
965  /*
966  * If this is a parallel worker, check whether there are already too many
967  * parallel workers; if so, don't register another one. Our view of
968  * parallel_terminate_count may be slightly stale, but that doesn't really
969  * matter: we would have gotten the same result if we'd arrived here
970  * slightly earlier anyway. There's no help for it, either, since the
971  * postmaster must not take locks; a memory barrier wouldn't guarantee
972  * anything useful.
973  */
977  {
981  LWLockRelease(BackgroundWorkerLock);
982  return false;
983  }
984 
985  /*
986  * Look for an unused slot. If we find one, grab it.
987  */
988  for (slotno = 0; slotno < BackgroundWorkerData->total_slots; ++slotno)
989  {
991 
992  if (!slot->in_use)
993  {
994  memcpy(&slot->worker, worker, sizeof(BackgroundWorker));
995  slot->pid = InvalidPid; /* indicates not started yet */
996  slot->generation++;
997  slot->terminate = false;
998  generation = slot->generation;
999  if (parallel)
1001 
1002  /*
1003  * Make sure postmaster doesn't see the slot as in use before it
1004  * sees the new contents.
1005  */
1006  pg_write_barrier();
1007 
1008  slot->in_use = true;
1009  success = true;
1010  break;
1011  }
1012  }
1013 
1014  LWLockRelease(BackgroundWorkerLock);
1015 
1016  /* If we found a slot, tell the postmaster to notice the change. */
1017  if (success)
1019 
1020  /*
1021  * If we found a slot and the user has provided a handle, initialize it.
1022  */
1023  if (success && handle)
1024  {
1025  *handle = palloc(sizeof(BackgroundWorkerHandle));
1026  (*handle)->slot = slotno;
1027  (*handle)->generation = generation;
1028  }
1029 
1030  return success;
1031 }
int max_parallel_workers
Definition: globals.c:125
static BackgroundWorkerArray * BackgroundWorkerData
Definition: bgworker.c:111
#define BGWORKER_CLASS_PARALLEL
Definition: bgworker.h:67
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1721
#define ERROR
Definition: elog.h:43
static bool success
Definition: pg_basebackup.c:99
uint32 parallel_register_count
Definition: bgworker.c:100
bool IsUnderPostmaster
Definition: globals.c:101
static bool SanityCheckBackgroundWorker(BackgroundWorker *worker, int elevel)
Definition: bgworker.c:583
#define Assert(condition)
Definition: c.h:670
BackgroundWorker worker
Definition: bgworker.c:83
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1117
void * palloc(Size size)
Definition: mcxt.c:848
uint32 parallel_terminate_count
Definition: bgworker.c:101
#define pg_write_barrier()
Definition: atomics.h:162
void SendPostmasterSignal(PMSignalReason reason)
Definition: pmsignal.c:113
#define MAX_PARALLEL_WORKER_LIMIT
BackgroundWorkerSlot slot[FLEXIBLE_ARRAY_MEMBER]
Definition: bgworker.c:102
#define InvalidPid
Definition: miscadmin.h:31

◆ TerminateBackgroundWorker()

void TerminateBackgroundWorker ( BackgroundWorkerHandle handle)

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

1178 {
1179  BackgroundWorkerSlot *slot;
1180  bool signal_postmaster = false;
1181 
1182  Assert(handle->slot < max_worker_processes);
1183  slot = &BackgroundWorkerData->slot[handle->slot];
1184 
1185  /* Set terminate flag in shared memory, unless slot has been reused. */
1186  LWLockAcquire(BackgroundWorkerLock, LW_EXCLUSIVE);
1187  if (handle->generation == slot->generation)
1188  {
1189  slot->terminate = true;
1190  signal_postmaster = true;
1191  }
1192  LWLockRelease(BackgroundWorkerLock);
1193 
1194  /* Make sure the postmaster notices the change to shared memory. */
1195  if (signal_postmaster)
1197 }
static BackgroundWorkerArray * BackgroundWorkerData
Definition: bgworker.c:111
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1721
#define Assert(condition)
Definition: c.h:670
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1117
int max_worker_processes
Definition: globals.c:124
void SendPostmasterSignal(PMSignalReason reason)
Definition: pmsignal.c:113
BackgroundWorkerSlot slot[FLEXIBLE_ARRAY_MEMBER]
Definition: bgworker.c:102

◆ WaitForBackgroundWorkerShutdown()

BgwHandleStatus WaitForBackgroundWorkerShutdown ( BackgroundWorkerHandle )

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

1139 {
1141  int rc;
1142 
1143  for (;;)
1144  {
1145  pid_t pid;
1146 
1148 
1149  status = GetBackgroundWorkerPid(handle, &pid);
1150  if (status == BGWH_STOPPED)
1151  break;
1152 
1153  rc = WaitLatch(MyLatch,
1156 
1157  if (rc & WL_POSTMASTER_DEATH)
1158  {
1159  status = BGWH_POSTMASTER_DIED;
1160  break;
1161  }
1162 
1164  }
1165 
1166  return status;
1167 }
void ResetLatch(volatile Latch *latch)
Definition: latch.c:497
int WaitLatch(volatile Latch *latch, int wakeEvents, long timeout, uint32 wait_event_info)
Definition: latch.c:336
BgwHandleStatus
Definition: bgworker.h:102
#define WL_POSTMASTER_DEATH
Definition: latch.h:128
struct Latch * MyLatch
Definition: globals.c:52
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:98
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:1047

◆ WaitForBackgroundWorkerStartup()

BgwHandleStatus WaitForBackgroundWorkerStartup ( BackgroundWorkerHandle handle,
pid_t *  pid 
)

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

1097 {
1099  int rc;
1100 
1101  for (;;)
1102  {
1103  pid_t pid;
1104 
1106 
1107  status = GetBackgroundWorkerPid(handle, &pid);
1108  if (status == BGWH_STARTED)
1109  *pidp = pid;
1110  if (status != BGWH_NOT_YET_STARTED)
1111  break;
1112 
1113  rc = WaitLatch(MyLatch,
1116 
1117  if (rc & WL_POSTMASTER_DEATH)
1118  {
1119  status = BGWH_POSTMASTER_DIED;
1120  break;
1121  }
1122 
1124  }
1125 
1126  return status;
1127 }
void ResetLatch(volatile Latch *latch)
Definition: latch.c:497
int WaitLatch(volatile Latch *latch, int wakeEvents, long timeout, uint32 wait_event_info)
Definition: latch.c:336
BgwHandleStatus
Definition: bgworker.h:102
#define WL_POSTMASTER_DEATH
Definition: latch.h:128
struct Latch * MyLatch
Definition: globals.c:52
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:98
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:1047

Variable Documentation

◆ MyBgworkerEntry