PostgreSQL Source Code git master
Loading...
Searching...
No Matches
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_INTERRUPTIBLE   0x0004
 
#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 charGetBackgroundWorkerTypeByPid (pid_t pid)
 
void TerminateBackgroundWorker (BackgroundWorkerHandle *handle)
 
void TerminateBackgroundWorkersForDatabase (Oid databaseId)
 
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 91 of file bgworker.h.

◆ BGW_EXTRALEN

#define BGW_EXTRALEN   128

Definition at line 94 of file bgworker.h.

◆ BGW_MAXLEN

#define BGW_MAXLEN   96

Definition at line 93 of file bgworker.h.

◆ BGW_NEVER_RESTART

#define BGW_NEVER_RESTART   -1

Definition at line 92 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 166 of file bgworker.h.

◆ BGWORKER_BYPASS_ROLELOGINCHECK

#define BGWORKER_BYPASS_ROLELOGINCHECK   0x0002

Definition at line 167 of file bgworker.h.

◆ BGWORKER_CLASS_PARALLEL

#define BGWORKER_CLASS_PARALLEL   0x0010

Definition at line 75 of file bgworker.h.

◆ BGWORKER_INTERRUPTIBLE

#define BGWORKER_INTERRUPTIBLE   0x0004

Definition at line 67 of file bgworker.h.

◆ BGWORKER_SHMEM_ACCESS

#define BGWORKER_SHMEM_ACCESS   0x0001

Definition at line 53 of file bgworker.h.

Typedef Documentation

◆ BackgroundWorker

◆ BackgroundWorkerHandle

◆ BgwHandleStatus

◆ bgworker_main_type

typedef void(* bgworker_main_type) (Datum main_arg)

Definition at line 79 of file bgworker.h.

Enumeration Type Documentation

◆ BgwHandleStatus

Enumerator
BGWH_STARTED 
BGWH_NOT_YET_STARTED 
BGWH_STOPPED 
BGWH_POSTMASTER_DIED 

Definition at line 110 of file bgworker.h.

111{
112 BGWH_STARTED, /* worker is running */
113 BGWH_NOT_YET_STARTED, /* worker hasn't been started yet */
114 BGWH_STOPPED, /* worker has exited */
115 BGWH_POSTMASTER_DIED, /* postmaster died; worker status unclear */
BgwHandleStatus
Definition bgworker.h:111
@ BGWH_POSTMASTER_DIED
Definition bgworker.h:115
@ BGWH_STARTED
Definition bgworker.h:112
@ BGWH_NOT_YET_STARTED
Definition bgworker.h:113
@ BGWH_STOPPED
Definition bgworker.h:114

◆ BgWorkerStartTime

Enumerator
BgWorkerStart_PostmasterStart 
BgWorkerStart_ConsistentState 
BgWorkerStart_RecoveryFinished 

Definition at line 84 of file bgworker.h.

85{
BgWorkerStartTime
Definition bgworker.h:85
@ BgWorkerStart_RecoveryFinished
Definition bgworker.h:88
@ BgWorkerStart_ConsistentState
Definition bgworker.h:87
@ BgWorkerStart_PostmasterStart
Definition bgworker.h:86

Function Documentation

◆ BackgroundWorkerBlockSignals()

void BackgroundWorkerBlockSignals ( void  )
extern

Definition at line 941 of file bgworker.c.

942{
944}
sigset_t BlockSig
Definition pqsignal.c:23
static int fb(int x)

References BlockSig, and fb().

◆ BackgroundWorkerInitializeConnection()

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

Definition at line 873 of file bgworker.c.

874{
876 bits32 init_flags = 0; /* never honor session_preload_libraries */
877
878 /* ignore datallowconn and ACL_CONNECT? */
879 if (flags & BGWORKER_BYPASS_ALLOWCONN)
881 /* ignore rolcanlogin? */
884
885 /* XXX is this the right errcode? */
889 errmsg("database connection requirement not indicated during registration")));
890
891 InitPostgres(dbname, InvalidOid, /* database to connect to */
892 username, InvalidOid, /* role to connect as */
894 NULL); /* no out_dbname */
895
896 /* it had better not gotten out of "init" mode yet */
899 (errmsg("invalid processing mode in background worker")));
901}
#define BGWORKER_BYPASS_ROLELOGINCHECK
Definition bgworker.h:167
#define BGWORKER_BACKEND_DATABASE_CONNECTION
Definition bgworker.h:60
#define BGWORKER_BYPASS_ALLOWCONN
Definition bgworker.h:166
uint32 bits32
Definition c.h:555
int errcode(int sqlerrcode)
Definition elog.c:863
int errmsg(const char *fmt,...)
Definition elog.c:1080
#define FATAL
Definition elog.h:41
#define ERROR
Definition elog.h:39
#define ereport(elevel,...)
Definition elog.h:150
static char * username
Definition initdb.c:153
@ NormalProcessing
Definition miscadmin.h:472
#define IsInitProcessingMode()
Definition miscadmin.h:478
#define SetProcessingMode(mode)
Definition miscadmin.h:483
#define INIT_PG_OVERRIDE_ROLE_LOGIN
Definition miscadmin.h:501
#define INIT_PG_OVERRIDE_ALLOW_CONNS
Definition miscadmin.h:500
#define InvalidOid
void InitPostgres(const char *in_dbname, Oid dboid, const char *username, Oid useroid, bits32 flags, char *out_dbname)
Definition postinit.c:710
BackgroundWorker * MyBgworkerEntry
Definition postmaster.c:200
char * dbname
Definition streamutil.c:49

References BackgroundWorker::bgw_flags, BGWORKER_BACKEND_DATABASE_CONNECTION, BGWORKER_BYPASS_ALLOWCONN, BGWORKER_BYPASS_ROLELOGINCHECK, dbname, ereport, errcode(), errmsg(), ERROR, FATAL, fb(), 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 
)
extern

Definition at line 907 of file bgworker.c.

908{
910 bits32 init_flags = 0; /* never honor session_preload_libraries */
911
912 /* ignore datallowconn and ACL_CONNECT? */
913 if (flags & BGWORKER_BYPASS_ALLOWCONN)
915 /* ignore rolcanlogin? */
918
919 /* XXX is this the right errcode? */
923 errmsg("database connection requirement not indicated during registration")));
924
925 InitPostgres(NULL, dboid, /* database to connect to */
926 NULL, useroid, /* role to connect as */
928 NULL); /* no out_dbname */
929
930 /* it had better not gotten out of "init" mode yet */
933 (errmsg("invalid processing mode in background worker")));
935}

References BackgroundWorker::bgw_flags, BGWORKER_BACKEND_DATABASE_CONNECTION, BGWORKER_BYPASS_ALLOWCONN, BGWORKER_BYPASS_ROLELOGINCHECK, ereport, errcode(), errmsg(), ERROR, FATAL, fb(), 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()

◆ GetBackgroundWorkerPid()

BgwHandleStatus GetBackgroundWorkerPid ( BackgroundWorkerHandle handle,
pid_t pidp 
)
extern

Definition at line 1178 of file bgworker.c.

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

References Assert, BackgroundWorkerData, BGWH_NOT_YET_STARTED, BGWH_STARTED, BGWH_STOPPED, fb(), 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)
extern

Definition at line 1392 of file bgworker.c.

1393{
1394 int slotno;
1395 bool found = false;
1396 static char result[BGW_MAXLEN];
1397
1399
1401 {
1403
1404 if (slot->pid > 0 && slot->pid == pid)
1405 {
1406 strcpy(result, slot->worker.bgw_type);
1407 found = true;
1408 break;
1409 }
1410 }
1411
1413
1414 if (!found)
1415 return NULL;
1416
1417 return result;
1418}
#define BGW_MAXLEN
Definition bgworker.h:93
BackgroundWorker worker
Definition bgworker.c:81
char bgw_type[BGW_MAXLEN]
Definition bgworker.h:99

References BackgroundWorkerData, BGW_MAXLEN, BackgroundWorker::bgw_type, fb(), 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)
extern

Definition at line 960 of file bgworker.c.

961{
963 static int numworkers = 0;
964
965 /*
966 * Static background workers can only be registered in the postmaster
967 * process.
968 */
970 {
971 /*
972 * In EXEC_BACKEND or single-user mode, we process
973 * shared_preload_libraries in backend processes too. We cannot
974 * register static background workers at that stage, but many
975 * libraries' _PG_init() functions don't distinguish whether they're
976 * being loaded in the postmaster or in a backend, they just check
977 * process_shared_preload_libraries_in_progress. It's a bit sloppy,
978 * but for historical reasons we tolerate it. In EXEC_BACKEND mode,
979 * the background workers should already have been registered when the
980 * library was loaded in postmaster.
981 */
983 return;
984 ereport(LOG,
986 errmsg("background worker \"%s\": must be registered in \"shared_preload_libraries\"",
987 worker->bgw_name)));
988 return;
989 }
990
991 /*
992 * Cannot register static background workers after calling
993 * BackgroundWorkerShmemInit().
994 */
996 elog(ERROR, "cannot register background worker \"%s\" after shmem init",
997 worker->bgw_name);
998
1000 (errmsg_internal("registering background worker \"%s\"", worker->bgw_name)));
1001
1002 if (!SanityCheckBackgroundWorker(worker, LOG))
1003 return;
1004
1005 if (worker->bgw_notify_pid != 0)
1006 {
1007 ereport(LOG,
1009 errmsg("background worker \"%s\": only dynamic background workers can request notification",
1010 worker->bgw_name)));
1011 return;
1012 }
1013
1014 /*
1015 * Enforce maximum number of workers. Note this is overly restrictive: we
1016 * could allow more non-shmem-connected workers, because these don't count
1017 * towards the MAX_BACKENDS limit elsewhere. For now, it doesn't seem
1018 * important to relax this restriction.
1019 */
1021 {
1022 ereport(LOG,
1024 errmsg("too many background workers"),
1025 errdetail_plural("Up to %d background worker can be registered with the current settings.",
1026 "Up to %d background workers can be registered with the current settings.",
1029 errhint("Consider increasing the configuration parameter \"%s\".", "max_worker_processes")));
1030 return;
1031 }
1032
1033 /*
1034 * Copy the registration data into the registered workers list.
1035 */
1037 sizeof(RegisteredBgWorker),
1039 if (rw == NULL)
1040 {
1041 ereport(LOG,
1043 errmsg("out of memory")));
1044 return;
1045 }
1046
1047 rw->rw_worker = *worker;
1048 rw->rw_pid = 0;
1049 rw->rw_crashed_at = 0;
1050 rw->rw_terminate = false;
1051
1053}
static bool SanityCheckBackgroundWorker(BackgroundWorker *worker, int elevel)
Definition bgworker.c:642
dlist_head BackgroundWorkerList
Definition bgworker.c:41
int errmsg_internal(const char *fmt,...)
Definition elog.c:1170
int errdetail_plural(const char *fmt_singular, const char *fmt_plural, unsigned long n,...)
Definition elog.c:1308
int errhint(const char *fmt,...)
Definition elog.c:1330
#define LOG
Definition elog.h:31
#define DEBUG1
Definition elog.h:30
#define elog(elevel,...)
Definition elog.h:226
#define MCXT_ALLOC_NO_OOM
Definition fe_memutils.h:29
bool IsUnderPostmaster
Definition globals.c:120
bool IsPostmasterEnvironment
Definition globals.c:119
static void dlist_push_head(dlist_head *head, dlist_node *node)
Definition ilist.h:347
void * MemoryContextAllocExtended(MemoryContext context, Size size, int flags)
Definition mcxt.c:1289
MemoryContext PostmasterContext
Definition mcxt.c:168
bool process_shared_preload_libraries_in_progress
Definition miscinit.c:1786
char bgw_name[BGW_MAXLEN]
Definition bgworker.h:98
pid_t bgw_notify_pid
Definition bgworker.h:107
BackgroundWorker rw_worker

References BackgroundWorkerData, BackgroundWorkerList, BackgroundWorker::bgw_name, BackgroundWorker::bgw_notify_pid, DEBUG1, dlist_push_head(), elog, ereport, errcode(), errdetail_plural(), errhint(), errmsg(), errmsg_internal(), ERROR, fb(), IsPostmasterEnvironment, IsUnderPostmaster, LOG, max_worker_processes, MCXT_ALLOC_NO_OOM, MemoryContextAllocExtended(), PostmasterContext, process_shared_preload_libraries_in_progress, RegisteredBgWorker::rw_crashed_at, RegisteredBgWorker::rw_lnode, RegisteredBgWorker::rw_pid, RegisteredBgWorker::rw_terminate, RegisteredBgWorker::rw_worker, and SanityCheckBackgroundWorker().

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

◆ RegisterDynamicBackgroundWorker()

bool RegisterDynamicBackgroundWorker ( BackgroundWorker worker,
BackgroundWorkerHandle **  handle 
)
extern

Definition at line 1066 of file bgworker.c.

1068{
1069 int slotno;
1070 bool success = false;
1071 bool parallel;
1072 uint64 generation = 0;
1073
1074 /*
1075 * We can't register dynamic background workers from the postmaster. If
1076 * this is a standalone backend, we're the only process and can't start
1077 * any more. In a multi-process environment, it might be theoretically
1078 * possible, but we don't currently support it due to locking
1079 * considerations; see comments on the BackgroundWorkerSlot data
1080 * structure.
1081 */
1082 if (!IsUnderPostmaster)
1083 return false;
1084
1085 if (!SanityCheckBackgroundWorker(worker, ERROR))
1086 return false;
1087
1088 parallel = (worker->bgw_flags & BGWORKER_CLASS_PARALLEL) != 0;
1089
1091
1092 /*
1093 * If this is a parallel worker, check whether there are already too many
1094 * parallel workers; if so, don't register another one. Our view of
1095 * parallel_terminate_count may be slightly stale, but that doesn't really
1096 * matter: we would have gotten the same result if we'd arrived here
1097 * slightly earlier anyway. There's no help for it, either, since the
1098 * postmaster must not take locks; a memory barrier wouldn't guarantee
1099 * anything useful.
1100 */
1104 {
1109 return false;
1110 }
1111
1112 /*
1113 * Look for an unused slot. If we find one, grab it.
1114 */
1116 {
1118
1119 if (!slot->in_use)
1120 {
1121 memcpy(&slot->worker, worker, sizeof(BackgroundWorker));
1122 slot->pid = InvalidPid; /* indicates not started yet */
1123 slot->generation++;
1124 slot->terminate = false;
1125 generation = slot->generation;
1126 if (parallel)
1128
1129 /*
1130 * Make sure postmaster doesn't see the slot as in use before it
1131 * sees the new contents.
1132 */
1134
1135 slot->in_use = true;
1136 success = true;
1137 break;
1138 }
1139 }
1140
1142
1143 /* If we found a slot, tell the postmaster to notice the change. */
1144 if (success)
1146
1147 /*
1148 * If we found a slot and the user has provided a handle, initialize it.
1149 */
1150 if (success && handle)
1151 {
1153 (*handle)->slot = slotno;
1154 (*handle)->generation = generation;
1155 }
1156
1157 return success;
1158}
#define pg_write_barrier()
Definition atomics.h:155
#define BGWORKER_CLASS_PARALLEL
Definition bgworker.h:75
#define MAX_PARALLEL_WORKER_LIMIT
uint64_t uint64
Definition c.h:547
#define palloc_object(type)
Definition fe_memutils.h:74
int max_parallel_workers
Definition globals.c:145
static bool success
Definition initdb.c:187
@ LW_EXCLUSIVE
Definition lwlock.h:112
void SendPostmasterSignal(PMSignalReason reason)
Definition pmsignal.c:165
@ PMSIGNAL_BACKGROUND_WORKER_CHANGE
Definition pmsignal.h:41
uint32 parallel_terminate_count
Definition bgworker.c:99
uint32 parallel_register_count
Definition bgworker.c:98

References Assert, BackgroundWorkerData, BackgroundWorker::bgw_flags, BGWORKER_CLASS_PARALLEL, ERROR, fb(), BackgroundWorkerSlot::generation, BackgroundWorkerSlot::in_use, InvalidPid, IsUnderPostmaster, LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), MAX_PARALLEL_WORKER_LIMIT, max_parallel_workers, palloc_object, 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)
extern

Definition at line 1317 of file bgworker.c.

1318{
1320 bool signal_postmaster = false;
1321
1322 Assert(handle->slot < max_worker_processes);
1323 slot = &BackgroundWorkerData->slot[handle->slot];
1324
1325 /* Set terminate flag in shared memory, unless slot has been reused. */
1327 if (handle->generation == slot->generation)
1328 {
1329 slot->terminate = true;
1330 signal_postmaster = true;
1331 }
1333
1334 /* Make sure the postmaster notices the change to shared memory. */
1337}

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

◆ TerminateBackgroundWorkersForDatabase()

void TerminateBackgroundWorkersForDatabase ( Oid  databaseId)
extern

Definition at line 1425 of file bgworker.c.

1426{
1427 bool signal_postmaster = false;
1428
1430
1431 /*
1432 * Iterate through slots, looking for workers connected to the given
1433 * database.
1434 */
1436 {
1438
1439 if (slot->in_use &&
1441 {
1442 PGPROC *proc = BackendPidGetProc(slot->pid);
1443
1444 if (proc && proc->databaseId == databaseId)
1445 {
1446 slot->terminate = true;
1447 signal_postmaster = true;
1448 }
1449 }
1450 }
1451
1453
1454 /* Make sure the postmaster notices the change to shared memory. */
1457}
#define BGWORKER_INTERRUPTIBLE
Definition bgworker.h:67
PGPROC * BackendPidGetProc(int pid)
Definition procarray.c:3154
Definition proc.h:180
Oid databaseId
Definition proc.h:225

References BackendPidGetProc(), BackgroundWorkerData, BackgroundWorker::bgw_flags, BGWORKER_INTERRUPTIBLE, PGPROC::databaseId, fb(), BackgroundWorkerSlot::in_use, LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), BackgroundWorkerSlot::pid, PMSIGNAL_BACKGROUND_WORKER_CHANGE, SendPostmasterSignal(), BackgroundWorkerArray::slot, BackgroundWorkerSlot::terminate, BackgroundWorkerArray::total_slots, and BackgroundWorkerSlot::worker.

Referenced by CountOtherDBBackends().

◆ WaitForBackgroundWorkerShutdown()

BgwHandleStatus WaitForBackgroundWorkerShutdown ( BackgroundWorkerHandle handle)
extern

Definition at line 1278 of file bgworker.c.

1279{
1280 BgwHandleStatus status;
1281 int rc;
1282
1283 for (;;)
1284 {
1285 pid_t pid;
1286
1288
1289 status = GetBackgroundWorkerPid(handle, &pid);
1290 if (status == BGWH_STOPPED)
1291 break;
1292
1293 rc = WaitLatch(MyLatch,
1296
1297 if (rc & WL_POSTMASTER_DEATH)
1298 {
1299 status = BGWH_POSTMASTER_DIED;
1300 break;
1301 }
1302
1304 }
1305
1306 return status;
1307}
BgwHandleStatus GetBackgroundWorkerPid(BackgroundWorkerHandle *handle, pid_t *pidp)
Definition bgworker.c:1178
struct Latch * MyLatch
Definition globals.c:63
void ResetLatch(Latch *latch)
Definition latch.c:374
int WaitLatch(Latch *latch, int wakeEvents, long timeout, uint32 wait_event_info)
Definition latch.c:172
#define CHECK_FOR_INTERRUPTS()
Definition miscadmin.h:123
#define WL_LATCH_SET
#define WL_POSTMASTER_DEATH

References BGWH_POSTMASTER_DIED, BGWH_STOPPED, CHECK_FOR_INTERRUPTS, fb(), 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 
)
extern

Definition at line 1233 of file bgworker.c.

1234{
1235 BgwHandleStatus status;
1236 int rc;
1237
1238 for (;;)
1239 {
1240 pid_t pid;
1241
1243
1244 status = GetBackgroundWorkerPid(handle, &pid);
1245 if (status == BGWH_STARTED)
1246 *pidp = pid;
1247 if (status != BGWH_NOT_YET_STARTED)
1248 break;
1249
1250 rc = WaitLatch(MyLatch,
1253
1254 if (rc & WL_POSTMASTER_DEATH)
1255 {
1256 status = BGWH_POSTMASTER_DIED;
1257 break;
1258 }
1259
1261 }
1262
1263 return status;
1264}

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

Referenced by apw_start_leader_worker(), and worker_spi_launch().

Variable Documentation

◆ MyBgworkerEntry