Thanks to visit codestin.com
Credit goes to doxygen.postgresql.org

PostgreSQL Source Code git master
waiteventset.h File Reference
#include "utils/resowner.h"
Include dependency graph for waiteventset.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  WaitEvent
 

Macros

#define WL_LATCH_SET   (1 << 0)
 
#define WL_SOCKET_READABLE   (1 << 1)
 
#define WL_SOCKET_WRITEABLE   (1 << 2)
 
#define WL_TIMEOUT   (1 << 3) /* not for WaitEventSetWait() */
 
#define WL_POSTMASTER_DEATH   (1 << 4)
 
#define WL_EXIT_ON_PM_DEATH   (1 << 5)
 
#define WL_SOCKET_CONNECTED   WL_SOCKET_WRITEABLE
 
#define WL_SOCKET_CLOSED   (1 << 7)
 
#define WL_SOCKET_ACCEPT   WL_SOCKET_READABLE
 
#define WL_SOCKET_MASK
 

Typedefs

typedef struct WaitEvent WaitEvent
 
typedef struct WaitEventSet WaitEventSet
 

Functions

void InitializeWaitEventSupport (void)
 
WaitEventSetCreateWaitEventSet (ResourceOwner resowner, int nevents)
 
void FreeWaitEventSet (WaitEventSet *set)
 
void FreeWaitEventSetAfterFork (WaitEventSet *set)
 
int AddWaitEventToSet (WaitEventSet *set, uint32 events, pgsocket fd, struct Latch *latch, void *user_data)
 
void ModifyWaitEvent (WaitEventSet *set, int pos, uint32 events, struct Latch *latch)
 
int WaitEventSetWait (WaitEventSet *set, long timeout, WaitEvent *occurred_events, int nevents, uint32 wait_event_info)
 
int GetNumRegisteredWaitEvents (WaitEventSet *set)
 
bool WaitEventSetCanReportClosed (void)
 
void WakeupMyProc (void)
 
void WakeupOtherProc (int pid)
 

Macro Definition Documentation

◆ WL_EXIT_ON_PM_DEATH

#define WL_EXIT_ON_PM_DEATH   (1 << 5)

Definition at line 39 of file waiteventset.h.

◆ WL_LATCH_SET

#define WL_LATCH_SET   (1 << 0)

Definition at line 34 of file waiteventset.h.

◆ WL_POSTMASTER_DEATH

#define WL_POSTMASTER_DEATH   (1 << 4)

Definition at line 38 of file waiteventset.h.

◆ WL_SOCKET_ACCEPT

#define WL_SOCKET_ACCEPT   WL_SOCKET_READABLE

Definition at line 51 of file waiteventset.h.

◆ WL_SOCKET_CLOSED

#define WL_SOCKET_CLOSED   (1 << 7)

Definition at line 46 of file waiteventset.h.

◆ WL_SOCKET_CONNECTED

#define WL_SOCKET_CONNECTED   WL_SOCKET_WRITEABLE

Definition at line 44 of file waiteventset.h.

◆ WL_SOCKET_MASK

#define WL_SOCKET_MASK
Value:
WL_SOCKET_WRITEABLE | \
WL_SOCKET_CONNECTED | \
WL_SOCKET_ACCEPT | \
WL_SOCKET_CLOSED)
#define WL_SOCKET_READABLE
Definition: waiteventset.h:35

Definition at line 53 of file waiteventset.h.

◆ WL_SOCKET_READABLE

#define WL_SOCKET_READABLE   (1 << 1)

Definition at line 35 of file waiteventset.h.

◆ WL_SOCKET_WRITEABLE

#define WL_SOCKET_WRITEABLE   (1 << 2)

Definition at line 36 of file waiteventset.h.

◆ WL_TIMEOUT

#define WL_TIMEOUT   (1 << 3) /* not for WaitEventSetWait() */

Definition at line 37 of file waiteventset.h.

Typedef Documentation

◆ WaitEvent

typedef struct WaitEvent WaitEvent

◆ WaitEventSet

typedef struct WaitEventSet WaitEventSet

Definition at line 71 of file waiteventset.h.

Function Documentation

◆ AddWaitEventToSet()

int AddWaitEventToSet ( WaitEventSet set,
uint32  events,
pgsocket  fd,
struct Latch latch,
void *  user_data 
)

Definition at line 570 of file waiteventset.c.

572{
573 WaitEvent *event;
574
575 /* not enough space */
576 Assert(set->nevents < set->nevents_space);
577
578 if (events == WL_EXIT_ON_PM_DEATH)
579 {
580 events = WL_POSTMASTER_DEATH;
581 set->exit_on_postmaster_death = true;
582 }
583
584 if (latch)
585 {
586 if (latch->owner_pid != MyProcPid)
587 elog(ERROR, "cannot wait on a latch owned by another process");
588 if (set->latch)
589 elog(ERROR, "cannot wait on more than one latch");
590 if ((events & WL_LATCH_SET) != WL_LATCH_SET)
591 elog(ERROR, "latch events only support being set");
592 }
593 else
594 {
595 if (events & WL_LATCH_SET)
596 elog(ERROR, "cannot wait on latch without a specified latch");
597 }
598
599 /* waiting for socket readiness without a socket indicates a bug */
600 if (fd == PGINVALID_SOCKET && (events & WL_SOCKET_MASK))
601 elog(ERROR, "cannot wait on socket event without a socket");
602
603 event = &set->events[set->nevents];
604 event->pos = set->nevents++;
605 event->fd = fd;
606 event->events = events;
607 event->user_data = user_data;
608#ifdef WIN32
609 event->reset = false;
610#endif
611
612 if (events == WL_LATCH_SET)
613 {
614 set->latch = latch;
615 set->latch_pos = event->pos;
616#if defined(WAIT_USE_SELF_PIPE)
617 event->fd = selfpipe_readfd;
618#elif defined(WAIT_USE_SIGNALFD)
619 event->fd = signal_fd;
620#else
621 event->fd = PGINVALID_SOCKET;
622#ifdef WAIT_USE_EPOLL
623 return event->pos;
624#endif
625#endif
626 }
627 else if (events == WL_POSTMASTER_DEATH)
628 {
629#ifndef WIN32
631#endif
632 }
633
634 /* perform wait primitive specific initialization, if needed */
635#if defined(WAIT_USE_EPOLL)
636 WaitEventAdjustEpoll(set, event, EPOLL_CTL_ADD);
637#elif defined(WAIT_USE_KQUEUE)
638 WaitEventAdjustKqueue(set, event, 0);
639#elif defined(WAIT_USE_POLL)
640 WaitEventAdjustPoll(set, event);
641#elif defined(WAIT_USE_WIN32)
642 WaitEventAdjustWin32(set, event);
643#endif
644
645 return event->pos;
646}
#define ERROR
Definition: elog.h:39
#define elog(elevel,...)
Definition: elog.h:226
int MyProcPid
Definition: globals.c:47
Assert(PointerIsAligned(start, uint64))
#define PGINVALID_SOCKET
Definition: port.h:31
int postmaster_alive_fds[2]
Definition: postmaster.c:483
#define POSTMASTER_FD_WATCH
Definition: postmaster.h:83
static int fd(const char *x, int i)
Definition: preproc-init.c:105
int owner_pid
Definition: latch.h:118
Latch * latch
Definition: waiteventset.c:136
bool exit_on_postmaster_death
Definition: waiteventset.c:144
WaitEvent * events
Definition: waiteventset.c:128
static int selfpipe_readfd
Definition: waiteventset.c:181
static void WaitEventAdjustPoll(WaitEventSet *set, WaitEvent *event)
Definition: waiteventset.c:790
#define WL_EXIT_ON_PM_DEATH
Definition: waiteventset.h:39
#define WL_LATCH_SET
Definition: waiteventset.h:34
#define WL_POSTMASTER_DEATH
Definition: waiteventset.h:38
#define WL_SOCKET_MASK
Definition: waiteventset.h:53

References Assert(), elog, ERROR, WaitEventSet::events, WaitEventSet::exit_on_postmaster_death, fd(), WaitEventSet::latch, WaitEventSet::latch_pos, MyProcPid, WaitEventSet::nevents, WaitEventSet::nevents_space, Latch::owner_pid, PGINVALID_SOCKET, WaitEvent::pos, postmaster_alive_fds, POSTMASTER_FD_WATCH, selfpipe_readfd, WaitEventAdjustPoll(), WL_EXIT_ON_PM_DEATH, WL_LATCH_SET, WL_POSTMASTER_DEATH, and WL_SOCKET_MASK.

Referenced by ConfigurePostmasterWaitSet(), ExecAppendAsyncEventWait(), InitializeLatchWaitSet(), postgresForeignAsyncConfigureWait(), pq_init(), SysLoggerMain(), and WaitLatchOrSocket().

◆ CreateWaitEventSet()

WaitEventSet * CreateWaitEventSet ( ResourceOwner  resowner,
int  nevents 
)

Definition at line 364 of file waiteventset.c.

365{
366 WaitEventSet *set;
367 char *data;
368 Size sz = 0;
369
370 /*
371 * Use MAXALIGN size/alignment to guarantee that later uses of memory are
372 * aligned correctly. E.g. epoll_event might need 8 byte alignment on some
373 * platforms, but earlier allocations like WaitEventSet and WaitEvent
374 * might not be sized to guarantee that when purely using sizeof().
375 */
376 sz += MAXALIGN(sizeof(WaitEventSet));
377 sz += MAXALIGN(sizeof(WaitEvent) * nevents);
378
379#if defined(WAIT_USE_EPOLL)
380 sz += MAXALIGN(sizeof(struct epoll_event) * nevents);
381#elif defined(WAIT_USE_KQUEUE)
382 sz += MAXALIGN(sizeof(struct kevent) * nevents);
383#elif defined(WAIT_USE_POLL)
384 sz += MAXALIGN(sizeof(struct pollfd) * nevents);
385#elif defined(WAIT_USE_WIN32)
386 /* need space for the pgwin32_signal_event */
387 sz += MAXALIGN(sizeof(HANDLE) * (nevents + 1));
388#endif
389
390 if (resowner != NULL)
391 ResourceOwnerEnlarge(resowner);
392
394
395 set = (WaitEventSet *) data;
396 data += MAXALIGN(sizeof(WaitEventSet));
397
398 set->events = (WaitEvent *) data;
399 data += MAXALIGN(sizeof(WaitEvent) * nevents);
400
401#if defined(WAIT_USE_EPOLL)
402 set->epoll_ret_events = (struct epoll_event *) data;
403 data += MAXALIGN(sizeof(struct epoll_event) * nevents);
404#elif defined(WAIT_USE_KQUEUE)
405 set->kqueue_ret_events = (struct kevent *) data;
406 data += MAXALIGN(sizeof(struct kevent) * nevents);
407#elif defined(WAIT_USE_POLL)
408 set->pollfds = (struct pollfd *) data;
409 data += MAXALIGN(sizeof(struct pollfd) * nevents);
410#elif defined(WAIT_USE_WIN32)
411 set->handles = (HANDLE) data;
412 data += MAXALIGN(sizeof(HANDLE) * nevents);
413#endif
414
415 set->latch = NULL;
416 set->nevents_space = nevents;
417 set->exit_on_postmaster_death = false;
418
419 if (resowner != NULL)
420 {
422 set->owner = resowner;
423 }
424
425#if defined(WAIT_USE_EPOLL)
426 if (!AcquireExternalFD())
427 elog(ERROR, "AcquireExternalFD, for epoll_create1, failed: %m");
428 set->epoll_fd = epoll_create1(EPOLL_CLOEXEC);
429 if (set->epoll_fd < 0)
430 {
432 elog(ERROR, "epoll_create1 failed: %m");
433 }
434#elif defined(WAIT_USE_KQUEUE)
435 if (!AcquireExternalFD())
436 elog(ERROR, "AcquireExternalFD, for kqueue, failed: %m");
437 set->kqueue_fd = kqueue();
438 if (set->kqueue_fd < 0)
439 {
441 elog(ERROR, "kqueue failed: %m");
442 }
443 if (fcntl(set->kqueue_fd, F_SETFD, FD_CLOEXEC) == -1)
444 {
445 int save_errno = errno;
446
447 close(set->kqueue_fd);
449 errno = save_errno;
450 elog(ERROR, "fcntl(F_SETFD) failed on kqueue descriptor: %m");
451 }
452 set->report_postmaster_not_running = false;
453#elif defined(WAIT_USE_WIN32)
454
455 /*
456 * To handle signals while waiting, we need to add a win32 specific event.
457 * We accounted for the additional event at the top of this routine. See
458 * port/win32/signal.c for more details.
459 *
460 * Note: pgwin32_signal_event should be first to ensure that it will be
461 * reported when multiple events are set. We want to guarantee that
462 * pending signals are serviced.
463 */
464 set->handles[0] = pgwin32_signal_event;
465 StaticAssertStmt(WSA_INVALID_EVENT == NULL, "");
466#endif
467
468 return set;
469}
#define MAXALIGN(LEN)
Definition: c.h:810
#define StaticAssertStmt(condition, errmessage)
Definition: c.h:937
size_t Size
Definition: c.h:610
void ReleaseExternalFD(void)
Definition: fd.c:1238
bool AcquireExternalFD(void)
Definition: fd.c:1185
#define close(a)
Definition: win32.h:12
void * MemoryContextAllocZero(MemoryContext context, Size size)
Definition: mcxt.c:1263
MemoryContext TopMemoryContext
Definition: mcxt.c:166
const void * data
void ResourceOwnerEnlarge(ResourceOwner owner)
Definition: resowner.c:449
HANDLE pgwin32_signal_event
Definition: signal.c:27
ResourceOwner owner
Definition: waiteventset.c:119
struct pollfd * pollfds
Definition: waiteventset.c:157
static void ResourceOwnerRememberWaitEventSet(ResourceOwner owner, WaitEventSet *set)
Definition: waiteventset.c:223

References AcquireExternalFD(), close, data, elog, ERROR, WaitEventSet::events, WaitEventSet::exit_on_postmaster_death, WaitEventSet::latch, MAXALIGN, MemoryContextAllocZero(), WaitEventSet::nevents_space, WaitEventSet::owner, pgwin32_signal_event, WaitEventSet::pollfds, ReleaseExternalFD(), ResourceOwnerEnlarge(), ResourceOwnerRememberWaitEventSet(), StaticAssertStmt, and TopMemoryContext.

Referenced by ConfigurePostmasterWaitSet(), ExecAppendAsyncEventWait(), InitializeLatchWaitSet(), pq_init(), SysLoggerMain(), and WaitLatchOrSocket().

◆ FreeWaitEventSet()

void FreeWaitEventSet ( WaitEventSet set)

Definition at line 481 of file waiteventset.c.

482{
483 if (set->owner)
484 {
486 set->owner = NULL;
487 }
488
489#if defined(WAIT_USE_EPOLL)
490 close(set->epoll_fd);
492#elif defined(WAIT_USE_KQUEUE)
493 close(set->kqueue_fd);
495#elif defined(WAIT_USE_WIN32)
496 for (WaitEvent *cur_event = set->events;
497 cur_event < (set->events + set->nevents);
498 cur_event++)
499 {
500 if (cur_event->events & WL_LATCH_SET)
501 {
502 /* uses the latch's HANDLE */
503 }
504 else if (cur_event->events & WL_POSTMASTER_DEATH)
505 {
506 /* uses PostmasterHandle */
507 }
508 else
509 {
510 /* Clean up the event object we created for the socket */
511 WSAEventSelect(cur_event->fd, NULL, 0);
512 WSACloseEvent(set->handles[cur_event->pos + 1]);
513 }
514 }
515#endif
516
517 pfree(set);
518}
void pfree(void *pointer)
Definition: mcxt.c:1594
static void ResourceOwnerForgetWaitEventSet(ResourceOwner owner, WaitEventSet *set)
Definition: waiteventset.c:228

References close, WaitEventSet::events, WaitEventSet::nevents, WaitEventSet::owner, pfree(), ReleaseExternalFD(), ResourceOwnerForgetWaitEventSet(), WL_LATCH_SET, and WL_POSTMASTER_DEATH.

Referenced by ConfigurePostmasterWaitSet(), ExecAppendAsyncEventWait(), ResOwnerReleaseWaitEventSet(), and WaitLatchOrSocket().

◆ FreeWaitEventSetAfterFork()

void FreeWaitEventSetAfterFork ( WaitEventSet set)

Definition at line 524 of file waiteventset.c.

525{
526#if defined(WAIT_USE_EPOLL)
527 close(set->epoll_fd);
529#elif defined(WAIT_USE_KQUEUE)
530 /* kqueues are not normally inherited by child processes */
532#endif
533
534 pfree(set);
535}

References close, pfree(), and ReleaseExternalFD().

Referenced by ClosePostmasterPorts().

◆ GetNumRegisteredWaitEvents()

int GetNumRegisteredWaitEvents ( WaitEventSet set)

Definition at line 1883 of file waiteventset.c.

1884{
1885 return set->nevents;
1886}

References WaitEventSet::nevents.

Referenced by ExecAppendAsyncEventWait(), and postgresForeignAsyncConfigureWait().

◆ InitializeWaitEventSupport()

void InitializeWaitEventSupport ( void  )

Definition at line 241 of file waiteventset.c.

242{
243#if defined(WAIT_USE_SELF_PIPE)
244 int pipefd[2];
245
247 {
248 /*
249 * We might have inherited connections to a self-pipe created by the
250 * postmaster. It's critical that child processes create their own
251 * self-pipes, of course, and we really want them to close the
252 * inherited FDs for safety's sake.
253 */
254 if (selfpipe_owner_pid != 0)
255 {
256 /* Assert we go through here but once in a child process */
258 /* Release postmaster's pipe FDs; ignore any error */
259 (void) close(selfpipe_readfd);
260 (void) close(selfpipe_writefd);
261 /* Clean up, just for safety's sake; we'll set these below */
264 /* Keep fd.c's accounting straight */
267 }
268 else
269 {
270 /*
271 * Postmaster didn't create a self-pipe ... or else we're in an
272 * EXEC_BACKEND build, in which case it doesn't matter since the
273 * postmaster's pipe FDs were closed by the action of FD_CLOEXEC.
274 * fd.c won't have state to clean up, either.
275 */
276 Assert(selfpipe_readfd == -1);
277 }
278 }
279 else
280 {
281 /* In postmaster or standalone backend, assert we do this but once */
282 Assert(selfpipe_readfd == -1);
284 }
285
286 /*
287 * Set up the self-pipe that allows a signal handler to wake up the
288 * poll()/epoll_wait() in WaitLatch. Make the write-end non-blocking, so
289 * that SetLatch won't block if the event has already been set many times
290 * filling the kernel buffer. Make the read-end non-blocking too, so that
291 * we can easily clear the pipe by reading until EAGAIN or EWOULDBLOCK.
292 * Also, make both FDs close-on-exec, since we surely do not want any
293 * child processes messing with them.
294 */
295 if (pipe(pipefd) < 0)
296 elog(FATAL, "pipe() failed: %m");
297 if (fcntl(pipefd[0], F_SETFL, O_NONBLOCK) == -1)
298 elog(FATAL, "fcntl(F_SETFL) failed on read-end of self-pipe: %m");
299 if (fcntl(pipefd[1], F_SETFL, O_NONBLOCK) == -1)
300 elog(FATAL, "fcntl(F_SETFL) failed on write-end of self-pipe: %m");
301 if (fcntl(pipefd[0], F_SETFD, FD_CLOEXEC) == -1)
302 elog(FATAL, "fcntl(F_SETFD) failed on read-end of self-pipe: %m");
303 if (fcntl(pipefd[1], F_SETFD, FD_CLOEXEC) == -1)
304 elog(FATAL, "fcntl(F_SETFD) failed on write-end of self-pipe: %m");
305
306 selfpipe_readfd = pipefd[0];
307 selfpipe_writefd = pipefd[1];
309
310 /* Tell fd.c about these two long-lived FDs */
313
315#endif
316
317#ifdef WAIT_USE_SIGNALFD
318 sigset_t signalfd_mask;
319
321 {
322 /*
323 * It would probably be safe to re-use the inherited signalfd since
324 * signalfds only see the current process's pending signals, but it
325 * seems less surprising to close it and create our own.
326 */
327 if (signal_fd != -1)
328 {
329 /* Release postmaster's signal FD; ignore any error */
330 (void) close(signal_fd);
331 signal_fd = -1;
333 }
334 }
335
336 /* Block SIGURG, because we'll receive it through a signalfd. */
337 sigaddset(&UnBlockSig, SIGURG);
338
339 /* Set up the signalfd to receive SIGURG notifications. */
340 sigemptyset(&signalfd_mask);
341 sigaddset(&signalfd_mask, SIGURG);
342 signal_fd = signalfd(-1, &signalfd_mask, SFD_NONBLOCK | SFD_CLOEXEC);
343 if (signal_fd < 0)
344 elog(FATAL, "signalfd() failed");
346#endif
347
348#ifdef WAIT_USE_KQUEUE
349 /* Ignore SIGURG, because we'll receive it via kqueue. */
350 pqsignal(SIGURG, SIG_IGN);
351#endif
352}
sigset_t UnBlockSig
Definition: pqsignal.c:22
#define FATAL
Definition: elog.h:41
void ReserveExternalFD(void)
Definition: fd.c:1220
bool IsUnderPostmaster
Definition: globals.c:120
#define pqsignal
Definition: port.h:531
static void latch_sigurg_handler(SIGNAL_ARGS)
static int selfpipe_owner_pid
Definition: waiteventset.c:185
static int selfpipe_writefd
Definition: waiteventset.c:182

References Assert(), close, elog, FATAL, IsUnderPostmaster, latch_sigurg_handler(), MyProcPid, pqsignal, ReleaseExternalFD(), ReserveExternalFD(), selfpipe_owner_pid, selfpipe_readfd, selfpipe_writefd, and UnBlockSig.

Referenced by InitPostmasterChild(), InitStandaloneProcess(), and PostmasterMain().

◆ ModifyWaitEvent()

void ModifyWaitEvent ( WaitEventSet set,
int  pos,
uint32  events,
struct Latch latch 
)

Definition at line 656 of file waiteventset.c.

657{
658 WaitEvent *event;
659#if defined(WAIT_USE_KQUEUE)
660 int old_events;
661#endif
662
663 Assert(pos < set->nevents);
664
665 event = &set->events[pos];
666#if defined(WAIT_USE_KQUEUE)
667 old_events = event->events;
668#endif
669
670 /*
671 * Allow switching between WL_POSTMASTER_DEATH and WL_EXIT_ON_PM_DEATH.
672 *
673 * Note that because WL_EXIT_ON_PM_DEATH is mapped to WL_POSTMASTER_DEATH
674 * in AddWaitEventToSet(), this needs to be checked before the fast-path
675 * below that checks if 'events' has changed.
676 */
677 if (event->events == WL_POSTMASTER_DEATH)
678 {
679 if (events != WL_POSTMASTER_DEATH && events != WL_EXIT_ON_PM_DEATH)
680 elog(ERROR, "cannot remove postmaster death event");
681 set->exit_on_postmaster_death = ((events & WL_EXIT_ON_PM_DEATH) != 0);
682 return;
683 }
684
685 /*
686 * If neither the event mask nor the associated latch changes, return
687 * early. That's an important optimization for some sockets, where
688 * ModifyWaitEvent is frequently used to switch from waiting for reads to
689 * waiting on writes.
690 */
691 if (events == event->events &&
692 (!(event->events & WL_LATCH_SET) || set->latch == latch))
693 return;
694
695 if (event->events & WL_LATCH_SET && events != event->events)
696 elog(ERROR, "cannot modify latch event");
697
698 /* FIXME: validate event mask */
699 event->events = events;
700
701 if (events == WL_LATCH_SET)
702 {
703 if (latch && latch->owner_pid != MyProcPid)
704 elog(ERROR, "cannot wait on a latch owned by another process");
705 set->latch = latch;
706
707 /*
708 * On Unix, we don't need to modify the kernel object because the
709 * underlying pipe (if there is one) is the same for all latches so we
710 * can return immediately. On Windows, we need to update our array of
711 * handles, but we leave the old one in place and tolerate spurious
712 * wakeups if the latch is disabled.
713 */
714#if defined(WAIT_USE_WIN32)
715 if (!latch)
716 return;
717#else
718 return;
719#endif
720 }
721
722#if defined(WAIT_USE_EPOLL)
723 WaitEventAdjustEpoll(set, event, EPOLL_CTL_MOD);
724#elif defined(WAIT_USE_KQUEUE)
725 WaitEventAdjustKqueue(set, event, old_events);
726#elif defined(WAIT_USE_POLL)
727 WaitEventAdjustPoll(set, event);
728#elif defined(WAIT_USE_WIN32)
729 WaitEventAdjustWin32(set, event);
730#endif
731}
uint32 events
Definition: waiteventset.h:62

References Assert(), elog, ERROR, WaitEventSet::events, WaitEvent::events, WaitEventSet::exit_on_postmaster_death, WaitEventSet::latch, MyProcPid, Latch::owner_pid, WaitEventAdjustPoll(), WL_EXIT_ON_PM_DEATH, WL_LATCH_SET, and WL_POSTMASTER_DEATH.

Referenced by pq_check_connection(), secure_read(), secure_write(), SwitchBackToLocalLatch(), SwitchToSharedLatch(), WaitLatch(), and WalSndWait().

◆ WaitEventSetCanReportClosed()

bool WaitEventSetCanReportClosed ( void  )

Definition at line 1868 of file waiteventset.c.

1869{
1870#if (defined(WAIT_USE_POLL) && defined(POLLRDHUP)) || \
1871 defined(WAIT_USE_EPOLL) || \
1872 defined(WAIT_USE_KQUEUE)
1873 return true;
1874#else
1875 return false;
1876#endif
1877}

Referenced by check_client_connection_check_interval().

◆ WaitEventSetWait()

int WaitEventSetWait ( WaitEventSet set,
long  timeout,
WaitEvent occurred_events,
int  nevents,
uint32  wait_event_info 
)

Definition at line 1038 of file waiteventset.c.

1041{
1042 int returned_events = 0;
1044 instr_time cur_time;
1045 long cur_timeout = -1;
1046
1047 Assert(nevents > 0);
1048
1049 /*
1050 * Initialize timeout if requested. We must record the current time so
1051 * that we can determine the remaining timeout if interrupted.
1052 */
1053 if (timeout >= 0)
1054 {
1056 Assert(timeout >= 0 && timeout <= INT_MAX);
1057 cur_timeout = timeout;
1058 }
1059 else
1061
1062 pgstat_report_wait_start(wait_event_info);
1063
1064#ifndef WIN32
1065 waiting = true;
1066#else
1067 /* Ensure that signals are serviced even if latch is already set */
1069#endif
1070 while (returned_events == 0)
1071 {
1072 int rc;
1073
1074 /*
1075 * Check if the latch is set already first. If so, we either exit
1076 * immediately or ask the kernel for further events available right
1077 * now without waiting, depending on how many events the caller wants.
1078 *
1079 * If someone sets the latch between this and the
1080 * WaitEventSetWaitBlock() below, the setter will write a byte to the
1081 * pipe (or signal us and the signal handler will do that), and the
1082 * readiness routine will return immediately.
1083 *
1084 * On unix, If there's a pending byte in the self pipe, we'll notice
1085 * whenever blocking. Only clearing the pipe in that case avoids
1086 * having to drain it every time WaitLatchOrSocket() is used. Should
1087 * the pipe-buffer fill up we're still ok, because the pipe is in
1088 * nonblocking mode. It's unlikely for that to happen, because the
1089 * self pipe isn't filled unless we're blocking (waiting = true), or
1090 * from inside a signal handler in latch_sigurg_handler().
1091 *
1092 * On windows, we'll also notice if there's a pending event for the
1093 * latch when blocking, but there's no danger of anything filling up,
1094 * as "Setting an event that is already set has no effect.".
1095 *
1096 * Note: we assume that the kernel calls involved in latch management
1097 * will provide adequate synchronization on machines with weak memory
1098 * ordering, so that we cannot miss seeing is_set if a notification
1099 * has already been queued.
1100 */
1101 if (set->latch && !set->latch->is_set)
1102 {
1103 /* about to sleep on a latch */
1104 set->latch->maybe_sleeping = true;
1106 /* and recheck */
1107 }
1108
1109 if (set->latch && set->latch->is_set)
1110 {
1111 occurred_events->fd = PGINVALID_SOCKET;
1112 occurred_events->pos = set->latch_pos;
1113 occurred_events->user_data =
1114 set->events[set->latch_pos].user_data;
1115 occurred_events->events = WL_LATCH_SET;
1116 occurred_events++;
1117 returned_events++;
1118
1119 /* could have been set above */
1120 set->latch->maybe_sleeping = false;
1121
1122 if (returned_events == nevents)
1123 break; /* output buffer full already */
1124
1125 /*
1126 * Even though we already have an event, we'll poll just once with
1127 * zero timeout to see what non-latch events we can fit into the
1128 * output buffer at the same time.
1129 */
1130 cur_timeout = 0;
1131 timeout = 0;
1132 }
1133
1134 /*
1135 * Wait for events using the readiness primitive chosen at the top of
1136 * this file. If -1 is returned, a timeout has occurred, if 0 we have
1137 * to retry, everything >= 1 is the number of returned events.
1138 */
1139 rc = WaitEventSetWaitBlock(set, cur_timeout,
1140 occurred_events, nevents - returned_events);
1141
1142 if (set->latch &&
1143 set->latch->maybe_sleeping)
1144 set->latch->maybe_sleeping = false;
1145
1146 if (rc == -1)
1147 break; /* timeout occurred */
1148 else
1149 returned_events += rc;
1150
1151 /* If we're not done, update cur_timeout for next iteration */
1152 if (returned_events == 0 && timeout >= 0)
1153 {
1154 INSTR_TIME_SET_CURRENT(cur_time);
1156 cur_timeout = timeout - (long) INSTR_TIME_GET_MILLISEC(cur_time);
1157 if (cur_timeout <= 0)
1158 break;
1159 }
1160 }
1161#ifndef WIN32
1162 waiting = false;
1163#endif
1164
1166
1167 return returned_events;
1168}
#define pg_memory_barrier()
Definition: atomics.h:141
#define INSTR_TIME_SET_CURRENT(t)
Definition: instr_time.h:122
#define INSTR_TIME_SUBTRACT(x, y)
Definition: instr_time.h:181
#define INSTR_TIME_GET_MILLISEC(t)
Definition: instr_time.h:191
#define INSTR_TIME_SET_ZERO(t)
Definition: instr_time.h:172
static time_t start_time
Definition: pg_ctl.c:95
void pgwin32_dispatch_queued_signals(void)
Definition: signal.c:120
sig_atomic_t is_set
Definition: latch.h:115
sig_atomic_t maybe_sleeping
Definition: latch.h:116
pgsocket fd
Definition: waiteventset.h:63
void * user_data
Definition: waiteventset.h:64
static void pgstat_report_wait_start(uint32 wait_event_info)
Definition: wait_event.h:69
static void pgstat_report_wait_end(void)
Definition: wait_event.h:85
static int WaitEventSetWaitBlock(WaitEventSet *set, int cur_timeout, WaitEvent *occurred_events, int nevents)
static volatile sig_atomic_t waiting
Definition: waiteventset.c:171

References Assert(), WaitEventSet::events, WaitEvent::events, WaitEvent::fd, INSTR_TIME_GET_MILLISEC, INSTR_TIME_SET_CURRENT, INSTR_TIME_SET_ZERO, INSTR_TIME_SUBTRACT, Latch::is_set, WaitEventSet::latch, WaitEventSet::latch_pos, Latch::maybe_sleeping, pg_memory_barrier, PGINVALID_SOCKET, pgstat_report_wait_end(), pgstat_report_wait_start(), pgwin32_dispatch_queued_signals(), WaitEvent::pos, start_time, WaitEvent::user_data, WaitEventSetWaitBlock(), waiting, and WL_LATCH_SET.

Referenced by ExecAppendAsyncEventWait(), pq_check_connection(), secure_read(), secure_write(), ServerLoop(), SysLoggerMain(), WaitLatch(), WaitLatchOrSocket(), and WalSndWait().

◆ WakeupMyProc()

void WakeupMyProc ( void  )

Definition at line 2020 of file waiteventset.c.

2021{
2022#if defined(WAIT_USE_SELF_PIPE)
2023 if (waiting)
2025#else
2026 if (waiting)
2027 kill(MyProcPid, SIGURG);
2028#endif
2029}
static void sendSelfPipeByte(void)
#define kill(pid, sig)
Definition: win32_port.h:493

References kill, MyProcPid, sendSelfPipeByte(), and waiting.

Referenced by SetLatch().

◆ WakeupOtherProc()

void WakeupOtherProc ( int  pid)

Definition at line 2033 of file waiteventset.c.

2034{
2035 kill(pid, SIGURG);
2036}

References kill.

Referenced by SetLatch().