PostgreSQL Source Code git master
Loading...
Searching...
No Matches
procsignal.c File Reference
#include "postgres.h"
#include <signal.h>
#include <unistd.h>
#include "access/parallel.h"
#include "commands/async.h"
#include "miscadmin.h"
#include "pgstat.h"
#include "port/pg_bitutils.h"
#include "replication/logicalctl.h"
#include "replication/logicalworker.h"
#include "replication/walsender.h"
#include "storage/condition_variable.h"
#include "storage/ipc.h"
#include "storage/latch.h"
#include "storage/proc.h"
#include "storage/shmem.h"
#include "storage/sinval.h"
#include "storage/smgr.h"
#include "tcop/tcopprot.h"
#include "utils/memutils.h"
#include "utils/wait_event.h"
Include dependency graph for procsignal.c:

Go to the source code of this file.

Data Structures

struct  ProcSignalSlot
 
struct  ProcSignalHeader
 

Macros

#define NumProcSignalSlots   (MaxBackends + NUM_AUXILIARY_PROCS)
 
#define BARRIER_SHOULD_CHECK(flags, type)    (((flags) & (((uint32) 1) << (uint32) (type))) != 0)
 
#define BARRIER_CLEAR_BIT(flags, type)    ((flags) &= ~(((uint32) 1) << (uint32) (type)))
 

Functions

static bool CheckProcSignal (ProcSignalReason reason)
 
static void CleanupProcSignalState (int status, Datum arg)
 
static void ResetProcSignalBarrierBits (uint32 flags)
 
Size ProcSignalShmemSize (void)
 
void ProcSignalShmemInit (void)
 
void ProcSignalInit (const uint8 *cancel_key, int cancel_key_len)
 
int SendProcSignal (pid_t pid, ProcSignalReason reason, ProcNumber procNumber)
 
uint64 EmitProcSignalBarrier (ProcSignalBarrierType type)
 
void WaitForProcSignalBarrier (uint64 generation)
 
static void HandleProcSignalBarrierInterrupt (void)
 
void ProcessProcSignalBarrier (void)
 
void procsignal_sigusr1_handler (SIGNAL_ARGS)
 
void SendCancelRequest (int backendPID, const uint8 *cancel_key, int cancel_key_len)
 

Variables

NON_EXEC_STATIC ProcSignalHeaderProcSignal = NULL
 
static ProcSignalSlotMyProcSignalSlot = NULL
 

Macro Definition Documentation

◆ BARRIER_CLEAR_BIT

#define BARRIER_CLEAR_BIT (   flags,
  type 
)     ((flags) &= ~(((uint32) 1) << (uint32) (type)))

Definition at line 105 of file procsignal.c.

120{
121 Size size;
122
124 size = add_size(size, offsetof(ProcSignalHeader, psh_slot));
125 return size;
126}
127
128/*
129 * ProcSignalShmemInit
130 * Allocate and initialize ProcSignal's shared memory
131 */
132void
134{
135 Size size = ProcSignalShmemSize();
136 bool found;
137
139 ShmemInitStruct("ProcSignal", size, &found);
140
141 /* If we're first, initialize. */
142 if (!found)
143 {
144 int i;
145
147
148 for (i = 0; i < NumProcSignalSlots; ++i)
149 {
151
152 SpinLockInit(&slot->pss_mutex);
153 pg_atomic_init_u32(&slot->pss_pid, 0);
154 slot->pss_cancel_key_len = 0;
155 MemSet(slot->pss_signalFlags, 0, sizeof(slot->pss_signalFlags));
159 }
160 }
161}
162
163/*
164 * ProcSignalInit
165 * Register the current process in the ProcSignal array
166 */
167void
169{
170 ProcSignalSlot *slot;
173
175 if (MyProcNumber < 0)
176 elog(ERROR, "MyProcNumber not set");
178 elog(ERROR, "unexpected MyProcNumber %d in ProcSignalInit (max %d)", MyProcNumber, NumProcSignalSlots);
180
182
183 /* Value used for sanity check below */
185
186 /* Clear out any leftover signal reasons */
188
189 /*
190 * Initialize barrier state. Since we're a brand-new process, there
191 * shouldn't be any leftover backend-private state that needs to be
192 * updated. Therefore, we can broadcast the latest barrier generation and
193 * disregard any previously-set check bits.
194 *
195 * NB: This only works if this initialization happens early enough in the
196 * startup sequence that we haven't yet cached any state that might need
197 * to be invalidated. That's also why we have a memory barrier here, to be
198 * sure that any later reads of memory happen strictly after this.
199 */
204
205 if (cancel_key_len > 0)
209
211
212 /* Spinlock is released, do the check */
213 if (old_pss_pid != 0)
214 elog(LOG, "process %d taking over ProcSignal slot %d, but it's not empty",
216
217 /* Remember slot location for CheckProcSignal */
218 MyProcSignalSlot = slot;
219
220 /* Set up to release the slot on process exit */
222}
223
224/*
225 * CleanupProcSignalState
226 * Remove current process from ProcSignal mechanism
227 *
228 * This function is called via on_shmem_exit() during backend shutdown.
229 */
230static void
232{
235
236 /*
237 * Clear MyProcSignalSlot, so that a SIGUSR1 received after this point
238 * won't try to access it after it's no longer ours (and perhaps even
239 * after we've unmapped the shared memory segment).
240 */
243
244 /* sanity check */
247 if (old_pid != MyProcPid)
248 {
249 /*
250 * don't ERROR here. We're exiting anyway, and don't want to get into
251 * infinite loop trying to exit
252 */
254 elog(LOG, "process %d releasing ProcSignal slot %d, but it contains %d",
255 MyProcPid, (int) (slot - ProcSignal->psh_slot), (int) old_pid);
256 return; /* XXX better to zero the slot anyway? */
257 }
258
259 /* Mark the slot as unused */
260 pg_atomic_write_u32(&slot->pss_pid, 0);
261 slot->pss_cancel_key_len = 0;
262
263 /*
264 * Make this slot look like it's absorbed all possible barriers, so that
265 * no barrier waits block on it.
266 */
268
270
272}
273
274/*
275 * SendProcSignal
276 * Send a signal to a Postgres process
277 *
278 * Providing procNumber is optional, but it will speed up the operation.
279 *
280 * On success (a signal was sent), zero is returned.
281 * On error, -1 is returned, and errno is set (typically to ESRCH or EPERM).
282 *
283 * Not to be confused with ProcSendSignal
284 */
285int
286SendProcSignal(pid_t pid, ProcSignalReason reason, ProcNumber procNumber)
287{
288 volatile ProcSignalSlot *slot;
289
290 if (procNumber != INVALID_PROC_NUMBER)
291 {
292 Assert(procNumber < NumProcSignalSlots);
293 slot = &ProcSignal->psh_slot[procNumber];
294
296 if (pg_atomic_read_u32(&slot->pss_pid) == pid)
297 {
298 /* Atomically set the proper flag */
299 slot->pss_signalFlags[reason] = true;
301 /* Send signal */
302 return kill(pid, SIGUSR1);
303 }
305 }
306 else
307 {
308 /*
309 * procNumber not provided, so search the array using pid. We search
310 * the array back to front so as to reduce search overhead. Passing
311 * INVALID_PROC_NUMBER means that the target is most likely an
312 * auxiliary process, which will have a slot near the end of the
313 * array.
314 */
315 int i;
316
317 for (i = NumProcSignalSlots - 1; i >= 0; i--)
318 {
319 slot = &ProcSignal->psh_slot[i];
320
321 if (pg_atomic_read_u32(&slot->pss_pid) == pid)
322 {
324 if (pg_atomic_read_u32(&slot->pss_pid) == pid)
325 {
326 /* Atomically set the proper flag */
327 slot->pss_signalFlags[reason] = true;
329 /* Send signal */
330 return kill(pid, SIGUSR1);
331 }
333 }
334 }
335 }
336
337 errno = ESRCH;
338 return -1;
339}
340
341/*
342 * EmitProcSignalBarrier
343 * Send a signal to every Postgres process
344 *
345 * The return value of this function is the barrier "generation" created
346 * by this operation. This value can be passed to WaitForProcSignalBarrier
347 * to wait until it is known that every participant in the ProcSignal
348 * mechanism has absorbed the signal (or started afterwards).
349 *
350 * Note that it would be a bad idea to use this for anything that happens
351 * frequently, as interrupting every backend could cause a noticeable
352 * performance hit.
353 *
354 * Callers are entitled to assume that this function will not throw ERROR
355 * or FATAL.
356 */
357uint64
359{
360 uint32 flagbit = 1 << (uint32) type;
361 uint64 generation;
362
363 /*
364 * Set all the flags.
365 *
366 * Note that pg_atomic_fetch_or_u32 has full barrier semantics, so this is
367 * totally ordered with respect to anything the caller did before, and
368 * anything that we do afterwards. (This is also true of the later call to
369 * pg_atomic_add_fetch_u64.)
370 */
371 for (int i = 0; i < NumProcSignalSlots; i++)
372 {
373 volatile ProcSignalSlot *slot = &ProcSignal->psh_slot[i];
374
376 }
377
378 /*
379 * Increment the generation counter.
380 */
381 generation =
383
384 /*
385 * Signal all the processes, so that they update their advertised barrier
386 * generation.
387 *
388 * Concurrency is not a problem here. Backends that have exited don't
389 * matter, and new backends that have joined since we entered this
390 * function must already have current state, since the caller is
391 * responsible for making sure that the relevant state is entirely visible
392 * before calling this function in the first place. We still have to wake
393 * them up - because we can't distinguish between such backends and older
394 * backends that need to update state - but they won't actually need to
395 * change any state.
396 */
397 for (int i = NumProcSignalSlots - 1; i >= 0; i--)
398 {
399 volatile ProcSignalSlot *slot = &ProcSignal->psh_slot[i];
400 pid_t pid = pg_atomic_read_u32(&slot->pss_pid);
401
402 if (pid != 0)
403 {
405 pid = pg_atomic_read_u32(&slot->pss_pid);
406 if (pid != 0)
407 {
408 /* see SendProcSignal for details */
409 slot->pss_signalFlags[PROCSIG_BARRIER] = true;
411 kill(pid, SIGUSR1);
412 }
413 else
415 }
416 }
417
418 return generation;
419}
420
421/*
422 * WaitForProcSignalBarrier - wait until it is guaranteed that all changes
423 * requested by a specific call to EmitProcSignalBarrier() have taken effect.
424 */
425void
427{
429
430 elog(DEBUG1,
431 "waiting for all backends to process ProcSignalBarrier generation "
433 generation);
434
435 for (int i = NumProcSignalSlots - 1; i >= 0; i--)
436 {
439
440 /*
441 * It's important that we check only pss_barrierGeneration here and
442 * not pss_barrierCheckMask. Bits in pss_barrierCheckMask get cleared
443 * before the barrier is actually absorbed, but pss_barrierGeneration
444 * is updated only afterward.
445 */
447 while (oldval < generation)
448 {
450 5000,
452 ereport(LOG,
453 (errmsg("still waiting for backend with PID %d to accept ProcSignalBarrier",
454 (int) pg_atomic_read_u32(&slot->pss_pid))));
456 }
458 }
459
460 elog(DEBUG1,
461 "finished waiting for all backends to process ProcSignalBarrier generation "
463 generation);
464
465 /*
466 * The caller is probably calling this function because it wants to read
467 * the shared state or perform further writes to shared state once all
468 * backends are known to have absorbed the barrier. However, the read of
469 * pss_barrierGeneration was performed unlocked; insert a memory barrier
470 * to separate it from whatever follows.
471 */
473}
474
475/*
476 * Handle receipt of an interrupt indicating a global barrier event.
477 *
478 * All the actual work is deferred to ProcessProcSignalBarrier(), because we
479 * cannot safely access the barrier generation inside the signal handler as
480 * 64bit atomics might use spinlock based emulation, even for reads. As this
481 * routine only gets called when PROCSIG_BARRIER is sent that won't cause a
482 * lot of unnecessary work.
483 */
484static void
486{
487 InterruptPending = true;
489 /* latch will be set by procsignal_sigusr1_handler */
490}
491
492/*
493 * Perform global barrier related interrupt checking.
494 *
495 * Any backend that participates in ProcSignal signaling must arrange to
496 * call this function periodically. It is called from CHECK_FOR_INTERRUPTS(),
497 * which is enough for normal backends, but not necessarily for all types of
498 * background processes.
499 */
500void
502{
505 volatile uint32 flags;
506
508
509 /* Exit quickly if there's no work to do. */
511 return;
513
514 /*
515 * It's not unlikely to process multiple barriers at once, before the
516 * signals for all the barriers have arrived. To avoid unnecessary work in
517 * response to subsequent signals, exit early if we already have processed
518 * all of them.
519 */
522
524
525 if (local_gen == shared_gen)
526 return;
527
528 /*
529 * Get and clear the flags that are set for this backend. Note that
530 * pg_atomic_exchange_u32 is a full barrier, so we're guaranteed that the
531 * read of the barrier generation above happens before we atomically
532 * extract the flags, and that any subsequent state changes happen
533 * afterward.
534 *
535 * NB: In order to avoid race conditions, we must zero
536 * pss_barrierCheckMask first and only afterwards try to do barrier
537 * processing. If we did it in the other order, someone could send us
538 * another barrier of some type right after we called the
539 * barrier-processing function but before we cleared the bit. We would
540 * have no way of knowing that the bit needs to stay set in that case, so
541 * the need to call the barrier-processing function again would just get
542 * forgotten. So instead, we tentatively clear all the bits and then put
543 * back any for which we don't manage to successfully absorb the barrier.
544 */
546
547 /*
548 * If there are no flags set, then we can skip doing any real work.
549 * Otherwise, establish a PG_TRY block, so that we don't lose track of
550 * which types of barrier processing are needed if an ERROR occurs.
551 */
552 if (flags != 0)
553 {
554 bool success = true;
555
556 PG_TRY();
557 {
558 /*
559 * Process each type of barrier. The barrier-processing functions
560 * should normally return true, but may return false if the
561 * barrier can't be absorbed at the current time. This should be
562 * rare, because it's pretty expensive. Every single
563 * CHECK_FOR_INTERRUPTS() will return here until we manage to
564 * absorb the barrier, and that cost will add up in a hurry.
565 *
566 * NB: It ought to be OK to call the barrier-processing functions
567 * unconditionally, but it's more efficient to call only the ones
568 * that might need us to do something based on the flags.
569 */
570 while (flags != 0)
571 {
573 bool processed = true;
574
576 switch (type)
577 {
579 processed = ProcessBarrierSmgrRelease();
580 break;
583 break;
584 }
585
586 /*
587 * To avoid an infinite loop, we must always unset the bit in
588 * flags.
589 */
590 BARRIER_CLEAR_BIT(flags, type);
591
592 /*
593 * If we failed to process the barrier, reset the shared bit
594 * so we try again later, and set a flag so that we don't bump
595 * our generation.
596 */
597 if (!processed)
598 {
600 success = false;
601 }
602 }
603 }
604 PG_CATCH();
605 {
606 /*
607 * If an ERROR occurred, we'll need to try again later to handle
608 * that barrier type and any others that haven't been handled yet
609 * or weren't successfully absorbed.
610 */
612 PG_RE_THROW();
613 }
614 PG_END_TRY();
615
616 /*
617 * If some barrier types were not successfully absorbed, we will have
618 * to try again later.
619 */
620 if (!success)
621 return;
622 }
623
624 /*
625 * State changes related to all types of barriers that might have been
626 * emitted have now been handled, so we can update our notion of the
627 * generation to the one we observed before beginning the updates. If
628 * things have changed further, it'll get fixed up when this function is
629 * next called.
630 */
633}
634
635/*
636 * If it turns out that we couldn't absorb one or more barrier types, either
637 * because the barrier-processing functions returned false or due to an error,
638 * arrange for processing to be retried later.
639 */
640static void
642{
645 InterruptPending = true;
646}
647
648/*
649 * CheckProcSignal - check to see if a particular reason has been
650 * signaled, and clear the signal flag. Should be called after receiving
651 * SIGUSR1.
652 */
653static bool
655{
656 volatile ProcSignalSlot *slot = MyProcSignalSlot;
657
658 if (slot != NULL)
659 {
660 /*
661 * Careful here --- don't clear flag if we haven't seen it set.
662 * pss_signalFlags is of type "volatile sig_atomic_t" to allow us to
663 * read it here safely, without holding the spinlock.
664 */
665 if (slot->pss_signalFlags[reason])
666 {
667 slot->pss_signalFlags[reason] = false;
668 return true;
669 }
670 }
671
672 return false;
673}
674
675/*
676 * procsignal_sigusr1_handler - handle SIGUSR1 signal.
677 */
678void
680{
683
686
689
692
695
698
701
704
706}
707
708/*
709 * Send a query cancellation signal to backend.
710 *
711 * Note: This is called from a backend process before authentication. We
712 * cannot take LWLocks yet, but that's OK; we rely on atomic reads of the
713 * fields in the ProcSignal slots.
714 */
715void
716SendCancelRequest(int backendPID, const uint8 *cancel_key, int cancel_key_len)
717{
718 if (backendPID == 0)
719 {
720 ereport(LOG, (errmsg("invalid cancel request with PID 0")));
721 return;
722 }
723
724 /*
725 * See if we have a matching backend. Reading the pss_pid and
726 * pss_cancel_key fields is racy, a backend might die and remove itself
727 * from the array at any time. The probability of the cancellation key
728 * matching wrong process is miniscule, however, so we can live with that.
729 * PIDs are reused too, so sending the signal based on PID is inherently
730 * racy anyway, although OS's avoid reusing PIDs too soon.
731 */
732 for (int i = 0; i < NumProcSignalSlots; i++)
733 {
735 bool match;
736
737 if (pg_atomic_read_u32(&slot->pss_pid) != backendPID)
738 continue;
739
740 /* Acquire the spinlock and re-check */
742 if (pg_atomic_read_u32(&slot->pss_pid) != backendPID)
743 {
745 continue;
746 }
747 else
748 {
749 match = slot->pss_cancel_key_len == cancel_key_len &&
751
753
754 if (match)
755 {
756 /* Found a match; signal that backend to cancel current op */
758 (errmsg_internal("processing cancel request: sending SIGINT to process %d",
759 backendPID)));
760
761 /*
762 * If we have setsid(), signal the backend's whole process
763 * group
764 */
765#ifdef HAVE_SETSID
766 kill(-backendPID, SIGINT);
767#else
768 kill(backendPID, SIGINT);
769#endif
770 }
771 else
772 {
773 /* Right PID, wrong key: no way, Jose */
774 ereport(LOG,
775 (errmsg("wrong key in cancel request for process %d",
776 backendPID)));
777 }
778 return;
779 }
780 }
781
782 /* No matching backend */
783 ereport(LOG,
784 (errmsg("PID %d in cancel request did not match any process",
785 backendPID)));
786}
void HandleParallelApplyMessageInterrupt(void)
void HandleNotifyInterrupt(void)
Definition async.c:2543
static void pg_atomic_write_u64(volatile pg_atomic_uint64 *ptr, uint64 val)
Definition atomics.h:485
static uint32 pg_atomic_fetch_or_u32(volatile pg_atomic_uint32 *ptr, uint32 or_)
Definition atomics.h:410
#define pg_memory_barrier()
Definition atomics.h:141
static void pg_atomic_init_u32(volatile pg_atomic_uint32 *ptr, uint32 val)
Definition atomics.h:219
static void pg_atomic_write_u32(volatile pg_atomic_uint32 *ptr, uint32 val)
Definition atomics.h:274
static uint32 pg_atomic_read_u32(volatile pg_atomic_uint32 *ptr)
Definition atomics.h:237
static uint64 pg_atomic_add_fetch_u64(volatile pg_atomic_uint64 *ptr, int64 add_)
Definition atomics.h:569
static uint32 pg_atomic_exchange_u32(volatile pg_atomic_uint32 *ptr, uint32 newval)
Definition atomics.h:330
static void pg_atomic_init_u64(volatile pg_atomic_uint64 *ptr, uint64 val)
Definition atomics.h:453
static uint64 pg_atomic_read_u64(volatile pg_atomic_uint64 *ptr)
Definition atomics.h:467
void HandleParallelMessageInterrupt(void)
Definition parallel.c:1046
uint8_t uint8
Definition c.h:586
#define SIGNAL_ARGS
Definition c.h:1422
#define Assert(condition)
Definition c.h:915
#define UINT64_FORMAT
Definition c.h:607
uint64_t uint64
Definition c.h:589
uint32_t uint32
Definition c.h:588
#define PG_UINT64_MAX
Definition c.h:649
#define MemSet(start, val, len)
Definition c.h:1079
size_t Size
Definition c.h:661
bool ConditionVariableCancelSleep(void)
bool ConditionVariableTimedSleep(ConditionVariable *cv, long timeout, uint32 wait_event_info)
void ConditionVariableBroadcast(ConditionVariable *cv)
void ConditionVariableInit(ConditionVariable *cv)
Datum arg
Definition elog.c:1322
#define LOG
Definition elog.h:31
#define PG_RE_THROW()
Definition elog.h:405
int int errmsg_internal(const char *fmt,...) pg_attribute_printf(1
#define PG_TRY(...)
Definition elog.h:372
#define DEBUG2
Definition elog.h:29
#define PG_END_TRY(...)
Definition elog.h:397
#define DEBUG1
Definition elog.h:30
#define ERROR
Definition elog.h:39
#define PG_CATCH(...)
Definition elog.h:382
#define elog(elevel,...)
Definition elog.h:226
#define ereport(elevel,...)
Definition elog.h:150
volatile sig_atomic_t ProcSignalBarrierPending
Definition globals.c:40
volatile sig_atomic_t InterruptPending
Definition globals.c:32
int MyProcPid
Definition globals.c:47
ProcNumber MyProcNumber
Definition globals.c:90
struct Latch * MyLatch
Definition globals.c:63
static bool success
Definition initdb.c:187
void on_shmem_exit(pg_on_exit_callback function, Datum arg)
Definition ipc.c:372
int i
Definition isn.c:77
void SetLatch(Latch *latch)
Definition latch.c:290
bool ProcessBarrierUpdateXLogLogicalInfo(void)
Definition logicalctl.c:187
void HandleLogMemoryContextInterrupt(void)
Definition mcxt.c:1323
static char * errmsg
static int pg_rightmost_one_pos32(uint32 word)
int timingsafe_bcmp(const void *b1, const void *b2, size_t n)
void HandleRecoveryConflictInterrupt(void)
Definition postgres.c:3074
uint64_t Datum
Definition postgres.h:70
static int fb(int x)
#define INVALID_PROC_NUMBER
Definition procnumber.h:26
int ProcNumber
Definition procnumber.h:24
static void CleanupProcSignalState(int status, Datum arg)
Definition procsignal.c:232
int SendProcSignal(pid_t pid, ProcSignalReason reason, ProcNumber procNumber)
Definition procsignal.c:287
void ProcSignalInit(const uint8 *cancel_key, int cancel_key_len)
Definition procsignal.c:169
void ProcSignalShmemInit(void)
Definition procsignal.c:134
#define NumProcSignalSlots
Definition procsignal.c:98
static bool CheckProcSignal(ProcSignalReason reason)
Definition procsignal.c:655
void ProcessProcSignalBarrier(void)
Definition procsignal.c:502
void WaitForProcSignalBarrier(uint64 generation)
Definition procsignal.c:427
NON_EXEC_STATIC ProcSignalHeader * ProcSignal
Definition procsignal.c:108
static void ResetProcSignalBarrierBits(uint32 flags)
Definition procsignal.c:642
void SendCancelRequest(int backendPID, const uint8 *cancel_key, int cancel_key_len)
Definition procsignal.c:717
uint64 EmitProcSignalBarrier(ProcSignalBarrierType type)
Definition procsignal.c:359
Size ProcSignalShmemSize(void)
Definition procsignal.c:120
static void HandleProcSignalBarrierInterrupt(void)
Definition procsignal.c:486
static ProcSignalSlot * MyProcSignalSlot
Definition procsignal.c:109
#define BARRIER_CLEAR_BIT(flags, type)
Definition procsignal.c:105
void procsignal_sigusr1_handler(SIGNAL_ARGS)
Definition procsignal.c:680
#define NUM_PROCSIGNALS
Definition procsignal.h:44
ProcSignalReason
Definition procsignal.h:31
@ PROCSIG_RECOVERY_CONFLICT
Definition procsignal.h:39
@ PROCSIG_PARALLEL_MESSAGE
Definition procsignal.h:34
@ PROCSIG_CATCHUP_INTERRUPT
Definition procsignal.h:32
@ PROCSIG_LOG_MEMORY_CONTEXT
Definition procsignal.h:37
@ PROCSIG_BARRIER
Definition procsignal.h:36
@ PROCSIG_WALSND_INIT_STOPPING
Definition procsignal.h:35
@ PROCSIG_PARALLEL_APPLY_MESSAGE
Definition procsignal.h:38
@ PROCSIG_NOTIFY_INTERRUPT
Definition procsignal.h:33
ProcSignalBarrierType
Definition procsignal.h:47
@ PROCSIGNAL_BARRIER_SMGRRELEASE
Definition procsignal.h:48
@ PROCSIGNAL_BARRIER_UPDATE_XLOG_LOGICAL_INFO
Definition procsignal.h:49
#define MAX_CANCEL_KEY_LENGTH
Definition procsignal.h:61
Size add_size(Size s1, Size s2)
Definition shmem.c:482
Size mul_size(Size s1, Size s2)
Definition shmem.c:497
void * ShmemInitStruct(const char *name, Size size, bool *foundPtr)
Definition shmem.c:378
void HandleCatchupInterrupt(void)
Definition sinval.c:154
bool ProcessBarrierSmgrRelease(void)
Definition smgr.c:1027
static void SpinLockRelease(volatile slock_t *lock)
Definition spin.h:62
static void SpinLockAcquire(volatile slock_t *lock)
Definition spin.h:56
static void SpinLockInit(volatile slock_t *lock)
Definition spin.h:50
ProcSignalSlot psh_slot[FLEXIBLE_ARRAY_MEMBER]
Definition procsignal.c:89
pg_atomic_uint64 psh_barrierGeneration
Definition procsignal.c:88
uint8 pss_cancel_key[MAX_CANCEL_KEY_LENGTH]
Definition procsignal.c:70
ConditionVariable pss_barrierCV
Definition procsignal.c:77
pg_atomic_uint64 pss_barrierGeneration
Definition procsignal.c:75
volatile sig_atomic_t pss_signalFlags[NUM_PROCSIGNALS]
Definition procsignal.c:71
slock_t pss_mutex
Definition procsignal.c:72
pg_atomic_uint32 pss_pid
Definition procsignal.c:68
int pss_cancel_key_len
Definition procsignal.c:69
pg_atomic_uint32 pss_barrierCheckMask
Definition procsignal.c:76
const char * type
void HandleWalSndInitStopping(void)
Definition walsender.c:3705
#define kill(pid, sig)
Definition win32_port.h:490
#define SIGUSR1
Definition win32_port.h:170

◆ BARRIER_SHOULD_CHECK

#define BARRIER_SHOULD_CHECK (   flags,
  type 
)     (((flags) & (((uint32) 1) << (uint32) (type))) != 0)

Definition at line 101 of file procsignal.c.

◆ NumProcSignalSlots

#define NumProcSignalSlots   (MaxBackends + NUM_AUXILIARY_PROCS)

Definition at line 98 of file procsignal.c.

Function Documentation

◆ CheckProcSignal()

static bool CheckProcSignal ( ProcSignalReason  reason)
static

Definition at line 655 of file procsignal.c.

656{
657 volatile ProcSignalSlot *slot = MyProcSignalSlot;
658
659 if (slot != NULL)
660 {
661 /*
662 * Careful here --- don't clear flag if we haven't seen it set.
663 * pss_signalFlags is of type "volatile sig_atomic_t" to allow us to
664 * read it here safely, without holding the spinlock.
665 */
666 if (slot->pss_signalFlags[reason])
667 {
668 slot->pss_signalFlags[reason] = false;
669 return true;
670 }
671 }
672
673 return false;
674}

References fb(), MyProcSignalSlot, and ProcSignalSlot::pss_signalFlags.

Referenced by procsignal_sigusr1_handler().

◆ CleanupProcSignalState()

static void CleanupProcSignalState ( int  status,
Datum  arg 
)
static

Definition at line 232 of file procsignal.c.

233{
236
237 /*
238 * Clear MyProcSignalSlot, so that a SIGUSR1 received after this point
239 * won't try to access it after it's no longer ours (and perhaps even
240 * after we've unmapped the shared memory segment).
241 */
244
245 /* sanity check */
248 if (old_pid != MyProcPid)
249 {
250 /*
251 * don't ERROR here. We're exiting anyway, and don't want to get into
252 * infinite loop trying to exit
253 */
255 elog(LOG, "process %d releasing ProcSignal slot %d, but it contains %d",
256 MyProcPid, (int) (slot - ProcSignal->psh_slot), (int) old_pid);
257 return; /* XXX better to zero the slot anyway? */
258 }
259
260 /* Mark the slot as unused */
261 pg_atomic_write_u32(&slot->pss_pid, 0);
262 slot->pss_cancel_key_len = 0;
263
264 /*
265 * Make this slot look like it's absorbed all possible barriers, so that
266 * no barrier waits block on it.
267 */
269
271
273}

References Assert, ConditionVariableBroadcast(), elog, fb(), LOG, MyProcPid, MyProcSignalSlot, pg_atomic_read_u32(), pg_atomic_write_u32(), pg_atomic_write_u64(), PG_UINT64_MAX, ProcSignal, ProcSignalHeader::psh_slot, ProcSignalSlot::pss_barrierCV, ProcSignalSlot::pss_barrierGeneration, ProcSignalSlot::pss_cancel_key_len, ProcSignalSlot::pss_mutex, ProcSignalSlot::pss_pid, SpinLockAcquire(), and SpinLockRelease().

Referenced by ProcSignalInit().

◆ EmitProcSignalBarrier()

uint64 EmitProcSignalBarrier ( ProcSignalBarrierType  type)

Definition at line 359 of file procsignal.c.

360{
361 uint32 flagbit = 1 << (uint32) type;
362 uint64 generation;
363
364 /*
365 * Set all the flags.
366 *
367 * Note that pg_atomic_fetch_or_u32 has full barrier semantics, so this is
368 * totally ordered with respect to anything the caller did before, and
369 * anything that we do afterwards. (This is also true of the later call to
370 * pg_atomic_add_fetch_u64.)
371 */
372 for (int i = 0; i < NumProcSignalSlots; i++)
373 {
374 volatile ProcSignalSlot *slot = &ProcSignal->psh_slot[i];
375
377 }
378
379 /*
380 * Increment the generation counter.
381 */
382 generation =
384
385 /*
386 * Signal all the processes, so that they update their advertised barrier
387 * generation.
388 *
389 * Concurrency is not a problem here. Backends that have exited don't
390 * matter, and new backends that have joined since we entered this
391 * function must already have current state, since the caller is
392 * responsible for making sure that the relevant state is entirely visible
393 * before calling this function in the first place. We still have to wake
394 * them up - because we can't distinguish between such backends and older
395 * backends that need to update state - but they won't actually need to
396 * change any state.
397 */
398 for (int i = NumProcSignalSlots - 1; i >= 0; i--)
399 {
400 volatile ProcSignalSlot *slot = &ProcSignal->psh_slot[i];
401 pid_t pid = pg_atomic_read_u32(&slot->pss_pid);
402
403 if (pid != 0)
404 {
406 pid = pg_atomic_read_u32(&slot->pss_pid);
407 if (pid != 0)
408 {
409 /* see SendProcSignal for details */
410 slot->pss_signalFlags[PROCSIG_BARRIER] = true;
412 kill(pid, SIGUSR1);
413 }
414 else
416 }
417 }
418
419 return generation;
420}

References fb(), i, kill, NumProcSignalSlots, pg_atomic_add_fetch_u64(), pg_atomic_fetch_or_u32(), pg_atomic_read_u32(), PROCSIG_BARRIER, ProcSignal, ProcSignalHeader::psh_barrierGeneration, ProcSignalHeader::psh_slot, ProcSignalSlot::pss_barrierCheckMask, ProcSignalSlot::pss_mutex, ProcSignalSlot::pss_pid, ProcSignalSlot::pss_signalFlags, SIGUSR1, SpinLockAcquire(), SpinLockRelease(), and type.

Referenced by abort_logical_decoding_activation(), dbase_redo(), DisableLogicalDecoding(), dropdb(), DropTableSpace(), EnableLogicalDecoding(), movedb(), tblspc_redo(), and UpdateLogicalDecodingStatusEndOfRecovery().

◆ HandleProcSignalBarrierInterrupt()

static void HandleProcSignalBarrierInterrupt ( void  )
static

Definition at line 486 of file procsignal.c.

487{
488 InterruptPending = true;
490 /* latch will be set by procsignal_sigusr1_handler */
491}

References InterruptPending, and ProcSignalBarrierPending.

Referenced by procsignal_sigusr1_handler().

◆ ProcessProcSignalBarrier()

void ProcessProcSignalBarrier ( void  )

Definition at line 502 of file procsignal.c.

503{
506 volatile uint32 flags;
507
509
510 /* Exit quickly if there's no work to do. */
512 return;
514
515 /*
516 * It's not unlikely to process multiple barriers at once, before the
517 * signals for all the barriers have arrived. To avoid unnecessary work in
518 * response to subsequent signals, exit early if we already have processed
519 * all of them.
520 */
523
525
526 if (local_gen == shared_gen)
527 return;
528
529 /*
530 * Get and clear the flags that are set for this backend. Note that
531 * pg_atomic_exchange_u32 is a full barrier, so we're guaranteed that the
532 * read of the barrier generation above happens before we atomically
533 * extract the flags, and that any subsequent state changes happen
534 * afterward.
535 *
536 * NB: In order to avoid race conditions, we must zero
537 * pss_barrierCheckMask first and only afterwards try to do barrier
538 * processing. If we did it in the other order, someone could send us
539 * another barrier of some type right after we called the
540 * barrier-processing function but before we cleared the bit. We would
541 * have no way of knowing that the bit needs to stay set in that case, so
542 * the need to call the barrier-processing function again would just get
543 * forgotten. So instead, we tentatively clear all the bits and then put
544 * back any for which we don't manage to successfully absorb the barrier.
545 */
547
548 /*
549 * If there are no flags set, then we can skip doing any real work.
550 * Otherwise, establish a PG_TRY block, so that we don't lose track of
551 * which types of barrier processing are needed if an ERROR occurs.
552 */
553 if (flags != 0)
554 {
555 bool success = true;
556
557 PG_TRY();
558 {
559 /*
560 * Process each type of barrier. The barrier-processing functions
561 * should normally return true, but may return false if the
562 * barrier can't be absorbed at the current time. This should be
563 * rare, because it's pretty expensive. Every single
564 * CHECK_FOR_INTERRUPTS() will return here until we manage to
565 * absorb the barrier, and that cost will add up in a hurry.
566 *
567 * NB: It ought to be OK to call the barrier-processing functions
568 * unconditionally, but it's more efficient to call only the ones
569 * that might need us to do something based on the flags.
570 */
571 while (flags != 0)
572 {
574 bool processed = true;
575
577 switch (type)
578 {
580 processed = ProcessBarrierSmgrRelease();
581 break;
584 break;
585 }
586
587 /*
588 * To avoid an infinite loop, we must always unset the bit in
589 * flags.
590 */
591 BARRIER_CLEAR_BIT(flags, type);
592
593 /*
594 * If we failed to process the barrier, reset the shared bit
595 * so we try again later, and set a flag so that we don't bump
596 * our generation.
597 */
598 if (!processed)
599 {
601 success = false;
602 }
603 }
604 }
605 PG_CATCH();
606 {
607 /*
608 * If an ERROR occurred, we'll need to try again later to handle
609 * that barrier type and any others that haven't been handled yet
610 * or weren't successfully absorbed.
611 */
613 PG_RE_THROW();
614 }
615 PG_END_TRY();
616
617 /*
618 * If some barrier types were not successfully absorbed, we will have
619 * to try again later.
620 */
621 if (!success)
622 return;
623 }
624
625 /*
626 * State changes related to all types of barriers that might have been
627 * emitted have now been handled, so we can update our notion of the
628 * generation to the one we observed before beginning the updates. If
629 * things have changed further, it'll get fixed up when this function is
630 * next called.
631 */
634}

References Assert, BARRIER_CLEAR_BIT, ConditionVariableBroadcast(), fb(), MyProcSignalSlot, pg_atomic_exchange_u32(), pg_atomic_read_u64(), pg_atomic_write_u64(), PG_CATCH, PG_END_TRY, PG_RE_THROW, pg_rightmost_one_pos32(), PG_TRY, ProcessBarrierSmgrRelease(), ProcessBarrierUpdateXLogLogicalInfo(), ProcSignal, PROCSIGNAL_BARRIER_SMGRRELEASE, PROCSIGNAL_BARRIER_UPDATE_XLOG_LOGICAL_INFO, ProcSignalBarrierPending, ProcSignalHeader::psh_barrierGeneration, ProcSignalSlot::pss_barrierCheckMask, ProcSignalSlot::pss_barrierCV, ProcSignalSlot::pss_barrierGeneration, ResetProcSignalBarrierBits(), success, and type.

Referenced by BufferSync(), CheckpointWriteDelay(), ProcessAutoVacLauncherInterrupts(), ProcessCheckpointerInterrupts(), ProcessInterrupts(), ProcessMainLoopInterrupts(), ProcessPgArchInterrupts(), ProcessStartupProcInterrupts(), and ProcessWalSummarizerInterrupts().

◆ procsignal_sigusr1_handler()

void procsignal_sigusr1_handler ( SIGNAL_ARGS  )

Definition at line 680 of file procsignal.c.

References CheckProcSignal(), HandleCatchupInterrupt(), HandleLogMemoryContextInterrupt(), HandleNotifyInterrupt(), HandleParallelApplyMessageInterrupt(), HandleParallelMessageInterrupt(), HandleProcSignalBarrierInterrupt(), HandleRecoveryConflictInterrupt(), HandleWalSndInitStopping(), MyLatch, PROCSIG_BARRIER, PROCSIG_CATCHUP_INTERRUPT, PROCSIG_LOG_MEMORY_CONTEXT, PROCSIG_NOTIFY_INTERRUPT, PROCSIG_PARALLEL_APPLY_MESSAGE, PROCSIG_PARALLEL_MESSAGE, PROCSIG_RECOVERY_CONFLICT, PROCSIG_WALSND_INIT_STOPPING, and SetLatch().

Referenced by autoprewarm_main(), AutoVacLauncherMain(), AutoVacWorkerMain(), BackgroundWorkerMain(), BackgroundWriterMain(), CheckpointerMain(), IoWorkerMain(), PgArchiverMain(), PostgresMain(), ReplSlotSyncWorkerMain(), StartupProcessMain(), WalReceiverMain(), WalSndSignals(), WalSummarizerMain(), and WalWriterMain().

◆ ProcSignalInit()

void ProcSignalInit ( const uint8 cancel_key,
int  cancel_key_len 
)

Definition at line 169 of file procsignal.c.

170{
171 ProcSignalSlot *slot;
174
176 if (MyProcNumber < 0)
177 elog(ERROR, "MyProcNumber not set");
179 elog(ERROR, "unexpected MyProcNumber %d in ProcSignalInit (max %d)", MyProcNumber, NumProcSignalSlots);
181
183
184 /* Value used for sanity check below */
186
187 /* Clear out any leftover signal reasons */
189
190 /*
191 * Initialize barrier state. Since we're a brand-new process, there
192 * shouldn't be any leftover backend-private state that needs to be
193 * updated. Therefore, we can broadcast the latest barrier generation and
194 * disregard any previously-set check bits.
195 *
196 * NB: This only works if this initialization happens early enough in the
197 * startup sequence that we haven't yet cached any state that might need
198 * to be invalidated. That's also why we have a memory barrier here, to be
199 * sure that any later reads of memory happen strictly after this.
200 */
205
206 if (cancel_key_len > 0)
210
212
213 /* Spinlock is released, do the check */
214 if (old_pss_pid != 0)
215 elog(LOG, "process %d taking over ProcSignal slot %d, but it's not empty",
217
218 /* Remember slot location for CheckProcSignal */
219 MyProcSignalSlot = slot;
220
221 /* Set up to release the slot on process exit */
223}

References Assert, CleanupProcSignalState(), elog, ERROR, fb(), LOG, MAX_CANCEL_KEY_LENGTH, MemSet, MyProcNumber, MyProcPid, MyProcSignalSlot, NUM_PROCSIGNALS, NumProcSignalSlots, on_shmem_exit(), pg_atomic_read_u32(), pg_atomic_read_u64(), pg_atomic_write_u32(), pg_atomic_write_u64(), ProcSignal, ProcSignalHeader::psh_barrierGeneration, ProcSignalHeader::psh_slot, ProcSignalSlot::pss_barrierCheckMask, ProcSignalSlot::pss_barrierGeneration, ProcSignalSlot::pss_cancel_key, ProcSignalSlot::pss_cancel_key_len, ProcSignalSlot::pss_mutex, ProcSignalSlot::pss_pid, ProcSignalSlot::pss_signalFlags, SpinLockAcquire(), and SpinLockRelease().

Referenced by AuxiliaryProcessMainCommon(), and InitPostgres().

◆ ProcSignalShmemInit()

◆ ProcSignalShmemSize()

Size ProcSignalShmemSize ( void  )

Definition at line 120 of file procsignal.c.

121{
122 Size size;
123
125 size = add_size(size, offsetof(ProcSignalHeader, psh_slot));
126 return size;
127}

References add_size(), fb(), mul_size(), and NumProcSignalSlots.

Referenced by CalculateShmemSize(), and ProcSignalShmemInit().

◆ ResetProcSignalBarrierBits()

◆ SendCancelRequest()

void SendCancelRequest ( int  backendPID,
const uint8 cancel_key,
int  cancel_key_len 
)

Definition at line 717 of file procsignal.c.

718{
719 if (backendPID == 0)
720 {
721 ereport(LOG, (errmsg("invalid cancel request with PID 0")));
722 return;
723 }
724
725 /*
726 * See if we have a matching backend. Reading the pss_pid and
727 * pss_cancel_key fields is racy, a backend might die and remove itself
728 * from the array at any time. The probability of the cancellation key
729 * matching wrong process is miniscule, however, so we can live with that.
730 * PIDs are reused too, so sending the signal based on PID is inherently
731 * racy anyway, although OS's avoid reusing PIDs too soon.
732 */
733 for (int i = 0; i < NumProcSignalSlots; i++)
734 {
736 bool match;
737
738 if (pg_atomic_read_u32(&slot->pss_pid) != backendPID)
739 continue;
740
741 /* Acquire the spinlock and re-check */
743 if (pg_atomic_read_u32(&slot->pss_pid) != backendPID)
744 {
746 continue;
747 }
748 else
749 {
750 match = slot->pss_cancel_key_len == cancel_key_len &&
752
754
755 if (match)
756 {
757 /* Found a match; signal that backend to cancel current op */
759 (errmsg_internal("processing cancel request: sending SIGINT to process %d",
760 backendPID)));
761
762 /*
763 * If we have setsid(), signal the backend's whole process
764 * group
765 */
766#ifdef HAVE_SETSID
767 kill(-backendPID, SIGINT);
768#else
769 kill(backendPID, SIGINT);
770#endif
771 }
772 else
773 {
774 /* Right PID, wrong key: no way, Jose */
775 ereport(LOG,
776 (errmsg("wrong key in cancel request for process %d",
777 backendPID)));
778 }
779 return;
780 }
781 }
782
783 /* No matching backend */
784 ereport(LOG,
785 (errmsg("PID %d in cancel request did not match any process",
786 backendPID)));
787}

References DEBUG2, ereport, errmsg, errmsg_internal(), fb(), i, kill, LOG, NumProcSignalSlots, pg_atomic_read_u32(), ProcSignal, ProcSignalHeader::psh_slot, ProcSignalSlot::pss_cancel_key, ProcSignalSlot::pss_cancel_key_len, ProcSignalSlot::pss_mutex, ProcSignalSlot::pss_pid, SpinLockAcquire(), SpinLockRelease(), and timingsafe_bcmp().

Referenced by ProcessCancelRequestPacket().

◆ SendProcSignal()

int SendProcSignal ( pid_t  pid,
ProcSignalReason  reason,
ProcNumber  procNumber 
)

Definition at line 287 of file procsignal.c.

288{
289 volatile ProcSignalSlot *slot;
290
291 if (procNumber != INVALID_PROC_NUMBER)
292 {
293 Assert(procNumber < NumProcSignalSlots);
294 slot = &ProcSignal->psh_slot[procNumber];
295
297 if (pg_atomic_read_u32(&slot->pss_pid) == pid)
298 {
299 /* Atomically set the proper flag */
300 slot->pss_signalFlags[reason] = true;
302 /* Send signal */
303 return kill(pid, SIGUSR1);
304 }
306 }
307 else
308 {
309 /*
310 * procNumber not provided, so search the array using pid. We search
311 * the array back to front so as to reduce search overhead. Passing
312 * INVALID_PROC_NUMBER means that the target is most likely an
313 * auxiliary process, which will have a slot near the end of the
314 * array.
315 */
316 int i;
317
318 for (i = NumProcSignalSlots - 1; i >= 0; i--)
319 {
320 slot = &ProcSignal->psh_slot[i];
321
322 if (pg_atomic_read_u32(&slot->pss_pid) == pid)
323 {
325 if (pg_atomic_read_u32(&slot->pss_pid) == pid)
326 {
327 /* Atomically set the proper flag */
328 slot->pss_signalFlags[reason] = true;
330 /* Send signal */
331 return kill(pid, SIGUSR1);
332 }
334 }
335 }
336 }
337
338 errno = ESRCH;
339 return -1;
340}

References Assert, fb(), i, INVALID_PROC_NUMBER, kill, NumProcSignalSlots, pg_atomic_read_u32(), ProcSignal, ProcSignalHeader::psh_slot, ProcSignalSlot::pss_mutex, ProcSignalSlot::pss_pid, ProcSignalSlot::pss_signalFlags, SIGUSR1, SpinLockAcquire(), and SpinLockRelease().

Referenced by mq_putmessage(), pa_shutdown(), ParallelWorkerShutdown(), pg_log_backend_memory_contexts(), SICleanupQueue(), SignalBackends(), SignalRecoveryConflict(), SignalRecoveryConflictWithDatabase(), SignalRecoveryConflictWithVirtualXID(), and WalSndInitStopping().

◆ WaitForProcSignalBarrier()

void WaitForProcSignalBarrier ( uint64  generation)

Definition at line 427 of file procsignal.c.

428{
430
431 elog(DEBUG1,
432 "waiting for all backends to process ProcSignalBarrier generation "
434 generation);
435
436 for (int i = NumProcSignalSlots - 1; i >= 0; i--)
437 {
440
441 /*
442 * It's important that we check only pss_barrierGeneration here and
443 * not pss_barrierCheckMask. Bits in pss_barrierCheckMask get cleared
444 * before the barrier is actually absorbed, but pss_barrierGeneration
445 * is updated only afterward.
446 */
448 while (oldval < generation)
449 {
451 5000,
453 ereport(LOG,
454 (errmsg("still waiting for backend with PID %d to accept ProcSignalBarrier",
455 (int) pg_atomic_read_u32(&slot->pss_pid))));
457 }
459 }
460
461 elog(DEBUG1,
462 "finished waiting for all backends to process ProcSignalBarrier generation "
464 generation);
465
466 /*
467 * The caller is probably calling this function because it wants to read
468 * the shared state or perform further writes to shared state once all
469 * backends are known to have absorbed the barrier. However, the read of
470 * pss_barrierGeneration was performed unlocked; insert a memory barrier
471 * to separate it from whatever follows.
472 */
474}

References Assert, ConditionVariableCancelSleep(), ConditionVariableTimedSleep(), DEBUG1, elog, ereport, errmsg, fb(), i, LOG, NumProcSignalSlots, pg_atomic_read_u32(), pg_atomic_read_u64(), pg_memory_barrier, ProcSignal, ProcSignalHeader::psh_barrierGeneration, ProcSignalHeader::psh_slot, ProcSignalSlot::pss_barrierCV, ProcSignalSlot::pss_barrierGeneration, ProcSignalSlot::pss_pid, and UINT64_FORMAT.

Referenced by dbase_redo(), dropdb(), DropTableSpace(), EnableLogicalDecoding(), movedb(), tblspc_redo(), and UpdateLogicalDecodingStatusEndOfRecovery().

Variable Documentation

◆ MyProcSignalSlot

◆ ProcSignal