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   96
 
#define BGW_EXTRALEN   128
 
#define BGWORKER_BYPASS_ALLOWCONN   0x0001
 
#define BGWORKER_BYPASS_ROLELOGINCHECK   0x0002
 

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 *pidp)
 
BgwHandleStatus WaitForBackgroundWorkerShutdown (BackgroundWorkerHandle *)
 
const char * GetBackgroundWorkerTypeByPid (pid_t pid)
 
void TerminateBackgroundWorker (BackgroundWorkerHandle *handle)
 
void BackgroundWorkerInitializeConnection (const char *dbname, const char *username, uint32 flags)
 
void BackgroundWorkerInitializeConnectionByOid (Oid dboid, Oid useroid, uint32 flags)
 
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 84 of file bgworker.h.

◆ BGW_EXTRALEN

#define BGW_EXTRALEN   128

Definition at line 87 of file bgworker.h.

◆ BGW_MAXLEN

#define BGW_MAXLEN   96

Definition at line 86 of file bgworker.h.

◆ BGW_NEVER_RESTART

#define BGW_NEVER_RESTART   -1

Definition at line 85 of file bgworker.h.

◆ BGWORKER_BACKEND_DATABASE_CONNECTION

#define BGWORKER_BACKEND_DATABASE_CONNECTION   0x0002

Definition at line 60 of file bgworker.h.

◆ BGWORKER_BYPASS_ALLOWCONN

#define BGWORKER_BYPASS_ALLOWCONN   0x0001

Definition at line 156 of file bgworker.h.

◆ BGWORKER_BYPASS_ROLELOGINCHECK

#define BGWORKER_BYPASS_ROLELOGINCHECK   0x0002

Definition at line 157 of file bgworker.h.

◆ BGWORKER_CLASS_PARALLEL

#define BGWORKER_CLASS_PARALLEL   0x0010

Definition at line 68 of file bgworker.h.

◆ BGWORKER_SHMEM_ACCESS

#define BGWORKER_SHMEM_ACCESS   0x0001

Definition at line 53 of file bgworker.h.

Typedef Documentation

◆ BackgroundWorker

◆ BackgroundWorkerHandle

Definition at line 72 of file bgworker.h.

◆ BgwHandleStatus

◆ bgworker_main_type

typedef void(* bgworker_main_type) (Datum main_arg)

Definition at line 72 of file bgworker.h.

Enumeration Type Documentation

◆ BgwHandleStatus

Enumerator
BGWH_STARTED 
BGWH_NOT_YET_STARTED 
BGWH_STOPPED 
BGWH_POSTMASTER_DIED 

Definition at line 103 of file bgworker.h.

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

◆ BgWorkerStartTime

Enumerator
BgWorkerStart_PostmasterStart 
BgWorkerStart_ConsistentState 
BgWorkerStart_RecoveryFinished 

Definition at line 77 of file bgworker.h.

78 {
BgWorkerStartTime
Definition: bgworker.h:78
@ BgWorkerStart_RecoveryFinished
Definition: bgworker.h:81
@ BgWorkerStart_ConsistentState
Definition: bgworker.h:80
@ BgWorkerStart_PostmasterStart
Definition: bgworker.h:79

Function Documentation

◆ BackgroundWorkerBlockSignals()

void BackgroundWorkerBlockSignals ( void  )

Definition at line 926 of file bgworker.c.

927 {
928  sigprocmask(SIG_SETMASK, &BlockSig, NULL);
929 }
sigset_t BlockSig
Definition: pqsignal.c:23

References BlockSig.

◆ BackgroundWorkerInitializeConnection()

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

Definition at line 858 of file bgworker.c.

859 {
861  bits32 init_flags = 0; /* never honor session_preload_libraries */
862 
863  /* ignore datallowconn? */
864  if (flags & BGWORKER_BYPASS_ALLOWCONN)
865  init_flags |= INIT_PG_OVERRIDE_ALLOW_CONNS;
866  /* ignore rolcanlogin? */
867  if (flags & BGWORKER_BYPASS_ROLELOGINCHECK)
868  init_flags |= INIT_PG_OVERRIDE_ROLE_LOGIN;
869 
870  /* XXX is this the right errcode? */
872  ereport(FATAL,
873  (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
874  errmsg("database connection requirement not indicated during registration")));
875 
876  InitPostgres(dbname, InvalidOid, /* database to connect to */
877  username, InvalidOid, /* role to connect as */
878  init_flags,
879  NULL); /* no out_dbname */
880 
881  /* it had better not gotten out of "init" mode yet */
882  if (!IsInitProcessingMode())
883  ereport(ERROR,
884  (errmsg("invalid processing mode in background worker")));
886 }
#define BGWORKER_BYPASS_ROLELOGINCHECK
Definition: bgworker.h:157
#define BGWORKER_BACKEND_DATABASE_CONNECTION
Definition: bgworker.h:60
#define BGWORKER_BYPASS_ALLOWCONN
Definition: bgworker.h:156
uint32 bits32
Definition: c.h:515
int errcode(int sqlerrcode)
Definition: elog.c:853
int errmsg(const char *fmt,...)
Definition: elog.c:1070
#define FATAL
Definition: elog.h:41
#define ERROR
Definition: elog.h:39
#define ereport(elevel,...)
Definition: elog.h:149
static char * username
Definition: initdb.c:153
@ NormalProcessing
Definition: miscadmin.h:449
#define IsInitProcessingMode()
Definition: miscadmin.h:455
#define SetProcessingMode(mode)
Definition: miscadmin.h:460
#define INIT_PG_OVERRIDE_ROLE_LOGIN
Definition: miscadmin.h:478
#define INIT_PG_OVERRIDE_ALLOW_CONNS
Definition: miscadmin.h:477
#define InvalidOid
Definition: postgres_ext.h:36
void InitPostgres(const char *in_dbname, Oid dboid, const char *username, Oid useroid, bits32 flags, char *out_dbname)
Definition: postinit.c:693
BackgroundWorker * MyBgworkerEntry
Definition: postmaster.c:185
char * dbname
Definition: streamutil.c:52

References BackgroundWorker::bgw_flags, BGWORKER_BACKEND_DATABASE_CONNECTION, BGWORKER_BYPASS_ALLOWCONN, BGWORKER_BYPASS_ROLELOGINCHECK, dbname, ereport, errcode(), errmsg(), ERROR, FATAL, INIT_PG_OVERRIDE_ALLOW_CONNS, INIT_PG_OVERRIDE_ROLE_LOGIN, InitPostgres(), InvalidOid, IsInitProcessingMode, MyBgworkerEntry, NormalProcessing, SetProcessingMode, and username.

Referenced by ApplyLauncherMain(), and worker_spi_main().

◆ BackgroundWorkerInitializeConnectionByOid()

void BackgroundWorkerInitializeConnectionByOid ( Oid  dboid,
Oid  useroid,
uint32  flags 
)

Definition at line 892 of file bgworker.c.

893 {
895  bits32 init_flags = 0; /* never honor session_preload_libraries */
896 
897  /* ignore datallowconn? */
898  if (flags & BGWORKER_BYPASS_ALLOWCONN)
899  init_flags |= INIT_PG_OVERRIDE_ALLOW_CONNS;
900  /* ignore rolcanlogin? */
901  if (flags & BGWORKER_BYPASS_ROLELOGINCHECK)
902  init_flags |= INIT_PG_OVERRIDE_ROLE_LOGIN;
903 
904  /* XXX is this the right errcode? */
906  ereport(FATAL,
907  (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
908  errmsg("database connection requirement not indicated during registration")));
909 
910  InitPostgres(NULL, dboid, /* database to connect to */
911  NULL, useroid, /* role to connect as */
912  init_flags,
913  NULL); /* no out_dbname */
914 
915  /* it had better not gotten out of "init" mode yet */
916  if (!IsInitProcessingMode())
917  ereport(ERROR,
918  (errmsg("invalid processing mode in background worker")));
920 }

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

Referenced by autoprewarm_database_main(), InitializeLogRepWorker(), ParallelWorkerMain(), and worker_spi_main().

◆ BackgroundWorkerUnblockSignals()

void BackgroundWorkerUnblockSignals ( void  )

Definition at line 932 of file bgworker.c.

933 {
934  sigprocmask(SIG_SETMASK, &UnBlockSig, NULL);
935 }
sigset_t UnBlockSig
Definition: pqsignal.c:22

References UnBlockSig.

Referenced by ApplyLauncherMain(), autoprewarm_database_main(), autoprewarm_main(), BackgroundWorkerMain(), ParallelApplyWorkerMain(), ParallelWorkerMain(), SetupApplyOrSyncWorker(), test_shm_mq_main(), and worker_spi_main().

◆ GetBackgroundWorkerPid()

BgwHandleStatus GetBackgroundWorkerPid ( BackgroundWorkerHandle handle,
pid_t *  pidp 
)

Definition at line 1165 of file bgworker.c.

1166 {
1167  BackgroundWorkerSlot *slot;
1168  pid_t pid;
1169 
1170  Assert(handle->slot < max_worker_processes);
1171  slot = &BackgroundWorkerData->slot[handle->slot];
1172 
1173  /*
1174  * We could probably arrange to synchronize access to data using memory
1175  * barriers only, but for now, let's just keep it simple and grab the
1176  * lock. It seems unlikely that there will be enough traffic here to
1177  * result in meaningful contention.
1178  */
1179  LWLockAcquire(BackgroundWorkerLock, LW_SHARED);
1180 
1181  /*
1182  * The generation number can't be concurrently changed while we hold the
1183  * lock. The pid, which is updated by the postmaster, can change at any
1184  * time, but we assume such changes are atomic. So the value we read
1185  * won't be garbage, but it might be out of date by the time the caller
1186  * examines it (but that's unavoidable anyway).
1187  *
1188  * The in_use flag could be in the process of changing from true to false,
1189  * but if it is already false then it can't change further.
1190  */
1191  if (handle->generation != slot->generation || !slot->in_use)
1192  pid = 0;
1193  else
1194  pid = slot->pid;
1195 
1196  /* All done. */
1197  LWLockRelease(BackgroundWorkerLock);
1198 
1199  if (pid == 0)
1200  return BGWH_STOPPED;
1201  else if (pid == InvalidPid)
1202  return BGWH_NOT_YET_STARTED;
1203  *pidp = pid;
1204  return BGWH_STARTED;
1205 }
static BackgroundWorkerArray * BackgroundWorkerData
Definition: bgworker.c:108
#define Assert(condition)
Definition: c.h:858
int max_worker_processes
Definition: globals.c:142
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1168
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1781
@ LW_SHARED
Definition: lwlock.h:115
#define InvalidPid
Definition: miscadmin.h:32
BackgroundWorkerSlot slot[FLEXIBLE_ARRAY_MEMBER]
Definition: bgworker.c:99

References Assert, BackgroundWorkerData, 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().

◆ GetBackgroundWorkerTypeByPid()

const char* GetBackgroundWorkerTypeByPid ( pid_t  pid)

Definition at line 1379 of file bgworker.c.

1380 {
1381  int slotno;
1382  bool found = false;
1383  static char result[BGW_MAXLEN];
1384 
1385  LWLockAcquire(BackgroundWorkerLock, LW_SHARED);
1386 
1387  for (slotno = 0; slotno < BackgroundWorkerData->total_slots; slotno++)
1388  {
1390 
1391  if (slot->pid > 0 && slot->pid == pid)
1392  {
1393  strcpy(result, slot->worker.bgw_type);
1394  found = true;
1395  break;
1396  }
1397  }
1398 
1399  LWLockRelease(BackgroundWorkerLock);
1400 
1401  if (!found)
1402  return NULL;
1403 
1404  return result;
1405 }
#define BGW_MAXLEN
Definition: bgworker.h:86
BackgroundWorker worker
Definition: bgworker.c:80
char bgw_type[BGW_MAXLEN]
Definition: bgworker.h:92

References BackgroundWorkerData, 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().

◆ RegisterBackgroundWorker()

void RegisterBackgroundWorker ( BackgroundWorker worker)

Definition at line 945 of file bgworker.c.

946 {
947  RegisteredBgWorker *rw;
948  static int numworkers = 0;
949 
950  /*
951  * Static background workers can only be registered in the postmaster
952  * process.
953  */
955  {
956  /*
957  * In EXEC_BACKEND or single-user mode, we process
958  * shared_preload_libraries in backend processes too. We cannot
959  * register static background workers at that stage, but many
960  * libraries' _PG_init() functions don't distinguish whether they're
961  * being loaded in the postmaster or in a backend, they just check
962  * process_shared_preload_libraries_in_progress. It's a bit sloppy,
963  * but for historical reasons we tolerate it. In EXEC_BACKEND mode,
964  * the background workers should already have been registered when the
965  * library was loaded in postmaster.
966  */
968  return;
969  ereport(LOG,
970  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
971  errmsg("background worker \"%s\": must be registered in \"shared_preload_libraries\"",
972  worker->bgw_name)));
973  return;
974  }
975 
976  /*
977  * Cannot register static background workers after calling
978  * BackgroundWorkerShmemInit().
979  */
980  if (BackgroundWorkerData != NULL)
981  elog(ERROR, "cannot register background worker \"%s\" after shmem init",
982  worker->bgw_name);
983 
984  ereport(DEBUG1,
985  (errmsg_internal("registering background worker \"%s\"", worker->bgw_name)));
986 
987  if (!SanityCheckBackgroundWorker(worker, LOG))
988  return;
989 
990  if (worker->bgw_notify_pid != 0)
991  {
992  ereport(LOG,
993  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
994  errmsg("background worker \"%s\": only dynamic background workers can request notification",
995  worker->bgw_name)));
996  return;
997  }
998 
999  /*
1000  * Enforce maximum number of workers. Note this is overly restrictive: we
1001  * could allow more non-shmem-connected workers, because these don't count
1002  * towards the MAX_BACKENDS limit elsewhere. For now, it doesn't seem
1003  * important to relax this restriction.
1004  */
1005  if (++numworkers > max_worker_processes)
1006  {
1007  ereport(LOG,
1008  (errcode(ERRCODE_CONFIGURATION_LIMIT_EXCEEDED),
1009  errmsg("too many background workers"),
1010  errdetail_plural("Up to %d background worker can be registered with the current settings.",
1011  "Up to %d background workers can be registered with the current settings.",
1014  errhint("Consider increasing the configuration parameter \"%s\".", "max_worker_processes")));
1015  return;
1016  }
1017 
1018  /*
1019  * Copy the registration data into the registered workers list.
1020  */
1022  sizeof(RegisteredBgWorker),
1024  if (rw == NULL)
1025  {
1026  ereport(LOG,
1027  (errcode(ERRCODE_OUT_OF_MEMORY),
1028  errmsg("out of memory")));
1029  return;
1030  }
1031 
1032  rw->rw_worker = *worker;
1033  rw->rw_backend = NULL;
1034  rw->rw_pid = 0;
1035  rw->rw_child_slot = 0;
1036  rw->rw_crashed_at = 0;
1037  rw->rw_terminate = false;
1038 
1040 }
static bool SanityCheckBackgroundWorker(BackgroundWorker *worker, int elevel)
Definition: bgworker.c:637
slist_head BackgroundWorkerList
Definition: bgworker.c:40
int errmsg_internal(const char *fmt,...)
Definition: elog.c:1157
int errdetail_plural(const char *fmt_singular, const char *fmt_plural, unsigned long n,...)
Definition: elog.c:1295
int errhint(const char *fmt,...)
Definition: elog.c:1317
#define LOG
Definition: elog.h:31
#define DEBUG1
Definition: elog.h:30
#define elog(elevel,...)
Definition: elog.h:224
#define MCXT_ALLOC_NO_OOM
Definition: fe_memutils.h:17
bool IsUnderPostmaster
Definition: globals.c:118
bool IsPostmasterEnvironment
Definition: globals.c:117
static void slist_push_head(slist_head *head, slist_node *node)
Definition: ilist.h:1006
void * MemoryContextAllocExtended(MemoryContext context, Size size, int flags)
Definition: mcxt.c:1238
MemoryContext PostmasterContext
Definition: mcxt.c:151
bool process_shared_preload_libraries_in_progress
Definition: miscinit.c:1778
char bgw_name[BGW_MAXLEN]
Definition: bgworker.h:91
pid_t bgw_notify_pid
Definition: bgworker.h:100
struct bkend * rw_backend
BackgroundWorker rw_worker

References BackgroundWorkerData, BackgroundWorkerList, BackgroundWorker::bgw_name, BackgroundWorker::bgw_notify_pid, DEBUG1, elog, ereport, errcode(), errdetail_plural(), errhint(), errmsg(), errmsg_internal(), ERROR, IsPostmasterEnvironment, IsUnderPostmaster, LOG, max_worker_processes, MCXT_ALLOC_NO_OOM, MemoryContextAllocExtended(), PostmasterContext, 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(), and slist_push_head().

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

◆ RegisterDynamicBackgroundWorker()

bool RegisterDynamicBackgroundWorker ( BackgroundWorker worker,
BackgroundWorkerHandle **  handle 
)

Definition at line 1053 of file bgworker.c.

1055 {
1056  int slotno;
1057  bool success = false;
1058  bool parallel;
1059  uint64 generation = 0;
1060 
1061  /*
1062  * We can't register dynamic background workers from the postmaster. If
1063  * this is a standalone backend, we're the only process and can't start
1064  * any more. In a multi-process environment, it might be theoretically
1065  * possible, but we don't currently support it due to locking
1066  * considerations; see comments on the BackgroundWorkerSlot data
1067  * structure.
1068  */
1069  if (!IsUnderPostmaster)
1070  return false;
1071 
1072  if (!SanityCheckBackgroundWorker(worker, ERROR))
1073  return false;
1074 
1075  parallel = (worker->bgw_flags & BGWORKER_CLASS_PARALLEL) != 0;
1076 
1077  LWLockAcquire(BackgroundWorkerLock, LW_EXCLUSIVE);
1078 
1079  /*
1080  * If this is a parallel worker, check whether there are already too many
1081  * parallel workers; if so, don't register another one. Our view of
1082  * parallel_terminate_count may be slightly stale, but that doesn't really
1083  * matter: we would have gotten the same result if we'd arrived here
1084  * slightly earlier anyway. There's no help for it, either, since the
1085  * postmaster must not take locks; a memory barrier wouldn't guarantee
1086  * anything useful.
1087  */
1088  if (parallel && (BackgroundWorkerData->parallel_register_count -
1091  {
1095  LWLockRelease(BackgroundWorkerLock);
1096  return false;
1097  }
1098 
1099  /*
1100  * Look for an unused slot. If we find one, grab it.
1101  */
1102  for (slotno = 0; slotno < BackgroundWorkerData->total_slots; ++slotno)
1103  {
1105 
1106  if (!slot->in_use)
1107  {
1108  memcpy(&slot->worker, worker, sizeof(BackgroundWorker));
1109  slot->pid = InvalidPid; /* indicates not started yet */
1110  slot->generation++;
1111  slot->terminate = false;
1112  generation = slot->generation;
1113  if (parallel)
1115 
1116  /*
1117  * Make sure postmaster doesn't see the slot as in use before it
1118  * sees the new contents.
1119  */
1120  pg_write_barrier();
1121 
1122  slot->in_use = true;
1123  success = true;
1124  break;
1125  }
1126  }
1127 
1128  LWLockRelease(BackgroundWorkerLock);
1129 
1130  /* If we found a slot, tell the postmaster to notice the change. */
1131  if (success)
1133 
1134  /*
1135  * If we found a slot and the user has provided a handle, initialize it.
1136  */
1137  if (success && handle)
1138  {
1139  *handle = palloc(sizeof(BackgroundWorkerHandle));
1140  (*handle)->slot = slotno;
1141  (*handle)->generation = generation;
1142  }
1143 
1144  return success;
1145 }
#define pg_write_barrier()
Definition: atomics.h:150
#define BGWORKER_CLASS_PARALLEL
Definition: bgworker.h:68
#define MAX_PARALLEL_WORKER_LIMIT
int max_parallel_workers
Definition: globals.c:143
static bool success
Definition: initdb.c:186
@ LW_EXCLUSIVE
Definition: lwlock.h:114
void * palloc(Size size)
Definition: mcxt.c:1317
void SendPostmasterSignal(PMSignalReason reason)
Definition: pmsignal.c:181
@ PMSIGNAL_BACKGROUND_WORKER_CHANGE
Definition: pmsignal.h:40
uint32 parallel_terminate_count
Definition: bgworker.c:98
uint32 parallel_register_count
Definition: bgworker.c:97

References Assert, BackgroundWorkerData, 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_leader_worker(), LaunchParallelWorkers(), logicalrep_worker_launch(), setup_background_workers(), and worker_spi_launch().

◆ TerminateBackgroundWorker()

void TerminateBackgroundWorker ( BackgroundWorkerHandle handle)

Definition at line 1304 of file bgworker.c.

1305 {
1306  BackgroundWorkerSlot *slot;
1307  bool signal_postmaster = false;
1308 
1309  Assert(handle->slot < max_worker_processes);
1310  slot = &BackgroundWorkerData->slot[handle->slot];
1311 
1312  /* Set terminate flag in shared memory, unless slot has been reused. */
1313  LWLockAcquire(BackgroundWorkerLock, LW_EXCLUSIVE);
1314  if (handle->generation == slot->generation)
1315  {
1316  slot->terminate = true;
1317  signal_postmaster = true;
1318  }
1319  LWLockRelease(BackgroundWorkerLock);
1320 
1321  /* Make sure the postmaster notices the change to shared memory. */
1322  if (signal_postmaster)
1324 }

References Assert, BackgroundWorkerData, 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().

◆ WaitForBackgroundWorkerShutdown()

BgwHandleStatus WaitForBackgroundWorkerShutdown ( BackgroundWorkerHandle handle)

Definition at line 1265 of file bgworker.c.

1266 {
1267  BgwHandleStatus status;
1268  int rc;
1269 
1270  for (;;)
1271  {
1272  pid_t pid;
1273 
1275 
1276  status = GetBackgroundWorkerPid(handle, &pid);
1277  if (status == BGWH_STOPPED)
1278  break;
1279 
1280  rc = WaitLatch(MyLatch,
1282  WAIT_EVENT_BGWORKER_SHUTDOWN);
1283 
1284  if (rc & WL_POSTMASTER_DEATH)
1285  {
1286  status = BGWH_POSTMASTER_DIED;
1287  break;
1288  }
1289 
1291  }
1292 
1293  return status;
1294 }
BgwHandleStatus GetBackgroundWorkerPid(BackgroundWorkerHandle *handle, pid_t *pidp)
Definition: bgworker.c:1165
struct Latch * MyLatch
Definition: globals.c:61
void ResetLatch(Latch *latch)
Definition: latch.c:724
int WaitLatch(Latch *latch, int wakeEvents, long timeout, uint32 wait_event_info)
Definition: latch.c:517
#define WL_LATCH_SET
Definition: latch.h:127
#define WL_POSTMASTER_DEATH
Definition: latch.h:131
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:122

References BGWH_POSTMASTER_DIED, BGWH_STOPPED, CHECK_FOR_INTERRUPTS, GetBackgroundWorkerPid(), MyLatch, ResetLatch(), WaitLatch(), WL_LATCH_SET, and WL_POSTMASTER_DEATH.

Referenced by apw_start_database_worker(), and WaitForParallelWorkersToExit().

◆ WaitForBackgroundWorkerStartup()

BgwHandleStatus WaitForBackgroundWorkerStartup ( BackgroundWorkerHandle handle,
pid_t *  pidp 
)

Definition at line 1220 of file bgworker.c.

1221 {
1222  BgwHandleStatus status;
1223  int rc;
1224 
1225  for (;;)
1226  {
1227  pid_t pid;
1228 
1230 
1231  status = GetBackgroundWorkerPid(handle, &pid);
1232  if (status == BGWH_STARTED)
1233  *pidp = pid;
1234  if (status != BGWH_NOT_YET_STARTED)
1235  break;
1236 
1237  rc = WaitLatch(MyLatch,
1239  WAIT_EVENT_BGWORKER_STARTUP);
1240 
1241  if (rc & WL_POSTMASTER_DEATH)
1242  {
1243  status = BGWH_POSTMASTER_DIED;
1244  break;
1245  }
1246 
1248  }
1249 
1250  return status;
1251 }

References BGWH_NOT_YET_STARTED, BGWH_POSTMASTER_DIED, BGWH_STARTED, CHECK_FOR_INTERRUPTS, GetBackgroundWorkerPid(), MyLatch, ResetLatch(), WaitLatch(), WL_LATCH_SET, and WL_POSTMASTER_DEATH.

Referenced by apw_start_leader_worker(), and worker_spi_launch().

Variable Documentation

◆ MyBgworkerEntry