PostgreSQL Source Code  git master
test_shm_mq.h File Reference
#include "storage/dsm.h"
#include "storage/shm_mq.h"
#include "storage/spin.h"
Include dependency graph for test_shm_mq.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  test_shm_mq_header
 

Macros

#define PG_TEST_SHM_MQ_MAGIC   0x79fb2447
 

Functions

void test_shm_mq_setup (int64 queue_size, int32 nworkers, dsm_segment **seg, shm_mq_handle **output, shm_mq_handle **input)
 
void test_shm_mq_main (Datum) pg_attribute_noreturn()
 

Macro Definition Documentation

◆ PG_TEST_SHM_MQ_MAGIC

#define PG_TEST_SHM_MQ_MAGIC   0x79fb2447

Definition at line 22 of file test_shm_mq.h.

Referenced by setup_dynamic_shared_memory(), and test_shm_mq_main().

Function Documentation

◆ test_shm_mq_main()

void test_shm_mq_main ( Datum  )

Definition at line 47 of file worker.c.

References attach_to_queues(), BackendPidGetProc(), BackgroundWorkerUnblockSignals(), BackgroundWorker::bgw_notify_pid, copy_messages(), DatumGetInt32, DEBUG1, dsm_attach(), dsm_detach(), dsm_segment_address(), elog, ereport, errcode(), errmsg(), ERROR, handle_sigterm(), test_shm_mq_header::mutex, MyBgworkerEntry, PG_TEST_SHM_MQ_MAGIC, pqsignal(), proc_exit(), PGPROC::procLatch, SetLatch(), shm_toc_attach(), shm_toc_lookup(), SpinLockAcquire, SpinLockRelease, test_shm_mq_header::workers_attached, test_shm_mq_header::workers_ready, and test_shm_mq_header::workers_total.

48 {
49  dsm_segment *seg;
50  shm_toc *toc;
51  shm_mq_handle *inqh;
52  shm_mq_handle *outqh;
53  volatile test_shm_mq_header *hdr;
54  int myworkernumber;
55  PGPROC *registrant;
56 
57  /*
58  * Establish signal handlers.
59  *
60  * We want CHECK_FOR_INTERRUPTS() to kill off this worker process just as
61  * it would a normal user backend. To make that happen, we establish a
62  * signal handler that is a stripped-down version of die().
63  */
64  pqsignal(SIGTERM, handle_sigterm);
66 
67  /*
68  * Connect to the dynamic shared memory segment.
69  *
70  * The backend that registered this worker passed us the ID of a shared
71  * memory segment to which we must attach for further instructions. Once
72  * we've mapped the segment in our address space, attach to the table of
73  * contents so we can locate the various data structures we'll need to
74  * find within the segment.
75  *
76  * Note: at this point, we have not created any ResourceOwner in this
77  * process. This will result in our DSM mapping surviving until process
78  * exit, which is fine. If there were a ResourceOwner, it would acquire
79  * ownership of the mapping, but we have no need for that.
80  */
81  seg = dsm_attach(DatumGetInt32(main_arg));
82  if (seg == NULL)
83  ereport(ERROR,
84  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
85  errmsg("unable to map dynamic shared memory segment")));
87  if (toc == NULL)
88  ereport(ERROR,
89  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
90  errmsg("bad magic number in dynamic shared memory segment")));
91 
92  /*
93  * Acquire a worker number.
94  *
95  * By convention, the process registering this background worker should
96  * have stored the control structure at key 0. We look up that key to
97  * find it. Our worker number gives our identity: there may be just one
98  * worker involved in this parallel operation, or there may be many.
99  */
100  hdr = shm_toc_lookup(toc, 0, false);
101  SpinLockAcquire(&hdr->mutex);
102  myworkernumber = ++hdr->workers_attached;
103  SpinLockRelease(&hdr->mutex);
104  if (myworkernumber > hdr->workers_total)
105  ereport(ERROR,
106  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
107  errmsg("too many message queue testing workers already")));
108 
109  /*
110  * Attach to the appropriate message queues.
111  */
112  attach_to_queues(seg, toc, myworkernumber, &inqh, &outqh);
113 
114  /*
115  * Indicate that we're fully initialized and ready to begin the main part
116  * of the parallel operation.
117  *
118  * Once we signal that we're ready, the user backend is entitled to assume
119  * that our on_dsm_detach callbacks will fire before we disconnect from
120  * the shared memory segment and exit. Generally, that means we must have
121  * attached to all relevant dynamic shared memory data structures by now.
122  */
123  SpinLockAcquire(&hdr->mutex);
124  ++hdr->workers_ready;
125  SpinLockRelease(&hdr->mutex);
127  if (registrant == NULL)
128  {
129  elog(DEBUG1, "registrant backend has exited prematurely");
130  proc_exit(1);
131  }
132  SetLatch(&registrant->procLatch);
133 
134  /* Do the work. */
135  copy_messages(inqh, outqh);
136 
137  /*
138  * We're done. For cleanliness, explicitly detach from the shared memory
139  * segment (that would happen anyway during process exit, though).
140  */
141  dsm_detach(seg);
142  proc_exit(1);
143 }
#define DEBUG1
Definition: elog.h:25
#define DatumGetInt32(X)
Definition: postgres.h:472
PGPROC * BackendPidGetProc(int pid)
Definition: procarray.c:2363
dsm_segment * dsm_attach(dsm_handle h)
Definition: dsm.c:533
void proc_exit(int code)
Definition: ipc.c:104
int errcode(int sqlerrcode)
Definition: elog.c:570
BackgroundWorker * MyBgworkerEntry
Definition: postmaster.c:192
void SetLatch(Latch *latch)
Definition: latch.c:436
Latch procLatch
Definition: proc.h:104
#define SpinLockAcquire(lock)
Definition: spin.h:62
#define ERROR
Definition: elog.h:43
static void copy_messages(shm_mq_handle *inqh, shm_mq_handle *outqh)
Definition: worker.c:177
#define ereport(elevel, rest)
Definition: elog.h:141
#define SpinLockRelease(lock)
Definition: spin.h:64
shm_toc * shm_toc_attach(uint64 magic, void *address)
Definition: shm_toc.c:64
pqsigfunc pqsignal(int signum, pqsigfunc handler)
Definition: signal.c:170
void * dsm_segment_address(dsm_segment *seg)
Definition: dsm.c:938
static void handle_sigterm(SIGNAL_ARGS)
Definition: worker.c:206
void dsm_detach(dsm_segment *seg)
Definition: dsm.c:664
int errmsg(const char *fmt,...)
Definition: elog.c:784
pid_t bgw_notify_pid
Definition: bgworker.h:99
#define elog(elevel,...)
Definition: elog.h:226
Definition: proc.h:95
static void attach_to_queues(dsm_segment *seg, shm_toc *toc, int myworkernumber, shm_mq_handle **inqhp, shm_mq_handle **outqhp)
Definition: worker.c:155
void * shm_toc_lookup(shm_toc *toc, uint64 key, bool noError)
Definition: shm_toc.c:232
#define PG_TEST_SHM_MQ_MAGIC
Definition: test_shm_mq.h:22
void BackgroundWorkerUnblockSignals(void)
Definition: postmaster.c:5737

◆ test_shm_mq_setup()

void test_shm_mq_setup ( int64  queue_size,
int32  nworkers,
dsm_segment **  seg,
shm_mq_handle **  output,
shm_mq_handle **  input 
)

Definition at line 49 of file setup.c.

References cancel_on_dsm_detach(), cleanup_background_workers(), worker_state::handle, pfree(), PointerGetDatum, setup_background_workers(), setup_dynamic_shared_memory(), shm_mq_attach(), and wait_for_workers_to_become_ready().

Referenced by test_shm_mq(), and test_shm_mq_pipelined().

51 {
52  dsm_segment *seg;
53  test_shm_mq_header *hdr;
54  shm_mq *outq = NULL; /* placate compiler */
55  shm_mq *inq = NULL; /* placate compiler */
56  worker_state *wstate;
57 
58  /* Set up a dynamic shared memory segment. */
59  setup_dynamic_shared_memory(queue_size, nworkers, &seg, &hdr, &outq, &inq);
60  *segp = seg;
61 
62  /* Register background workers. */
63  wstate = setup_background_workers(nworkers, seg);
64 
65  /* Attach the queues. */
66  *output = shm_mq_attach(outq, seg, wstate->handle[0]);
67  *input = shm_mq_attach(inq, seg, wstate->handle[nworkers - 1]);
68 
69  /* Wait for workers to become ready. */
71 
72  /*
73  * Once we reach this point, all workers are ready. We no longer need to
74  * kill them if we die; they'll die on their own as the message queues
75  * shut down.
76  */
78  PointerGetDatum(wstate));
79  pfree(wstate);
80 }
#define PointerGetDatum(X)
Definition: postgres.h:556
static void setup_dynamic_shared_memory(int64 queue_size, int nworkers, dsm_segment **segp, test_shm_mq_header **hdrp, shm_mq **outp, shm_mq **inp)
Definition: setup.c:90
static void wait_for_workers_to_become_ready(worker_state *wstate, volatile test_shm_mq_header *hdr)
Definition: setup.c:256
void pfree(void *pointer)
Definition: mcxt.c:1056
static worker_state * setup_background_workers(int nworkers, dsm_segment *seg)
Definition: setup.c:173
BackgroundWorkerHandle * handle[FLEXIBLE_ARRAY_MEMBER]
Definition: setup.c:30
static void cleanup_background_workers(dsm_segment *seg, Datum arg)
Definition: setup.c:244
shm_mq_handle * shm_mq_attach(shm_mq *mq, dsm_segment *seg, BackgroundWorkerHandle *handle)
Definition: shm_mq.c:282
Definition: shm_mq.c:70
void cancel_on_dsm_detach(dsm_segment *seg, on_dsm_detach_callback function, Datum arg)
Definition: dsm.c:990