PostgreSQL Source Code git master
Loading...
Searching...
No Matches
execParallel.c File Reference
Include dependency graph for execParallel.c:

Go to the source code of this file.

Data Structures

struct  FixedParallelExecutorState
 
struct  SharedExecutorInstrumentation
 
struct  ExecParallelEstimateContext
 
struct  ExecParallelInitializeDSMContext
 

Macros

#define PARALLEL_KEY_EXECUTOR_FIXED   UINT64CONST(0xE000000000000001)
 
#define PARALLEL_KEY_PLANNEDSTMT   UINT64CONST(0xE000000000000002)
 
#define PARALLEL_KEY_PARAMLISTINFO   UINT64CONST(0xE000000000000003)
 
#define PARALLEL_KEY_BUFFER_USAGE   UINT64CONST(0xE000000000000004)
 
#define PARALLEL_KEY_TUPLE_QUEUE   UINT64CONST(0xE000000000000005)
 
#define PARALLEL_KEY_INSTRUMENTATION   UINT64CONST(0xE000000000000006)
 
#define PARALLEL_KEY_DSA   UINT64CONST(0xE000000000000007)
 
#define PARALLEL_KEY_QUERY_TEXT   UINT64CONST(0xE000000000000008)
 
#define PARALLEL_KEY_JIT_INSTRUMENTATION   UINT64CONST(0xE000000000000009)
 
#define PARALLEL_KEY_WAL_USAGE   UINT64CONST(0xE00000000000000A)
 
#define PARALLEL_TUPLE_QUEUE_SIZE   65536
 
#define GetInstrumentationArray(sei)
 

Typedefs

typedef struct FixedParallelExecutorState FixedParallelExecutorState
 
typedef struct ExecParallelEstimateContext ExecParallelEstimateContext
 
typedef struct ExecParallelInitializeDSMContext ExecParallelInitializeDSMContext
 

Functions

static charExecSerializePlan (Plan *plan, EState *estate)
 
static bool ExecParallelEstimate (PlanState *planstate, ExecParallelEstimateContext *e)
 
static bool ExecParallelInitializeDSM (PlanState *planstate, ExecParallelInitializeDSMContext *d)
 
static shm_mq_handle ** ExecParallelSetupTupleQueues (ParallelContext *pcxt, bool reinitialize)
 
static bool ExecParallelReInitializeDSM (PlanState *planstate, ParallelContext *pcxt)
 
static bool ExecParallelRetrieveInstrumentation (PlanState *planstate, SharedExecutorInstrumentation *instrumentation)
 
static DestReceiverExecParallelGetReceiver (dsm_segment *seg, shm_toc *toc)
 
static Size EstimateParamExecSpace (EState *estate, Bitmapset *params)
 
static dsa_pointer SerializeParamExecParams (EState *estate, Bitmapset *params, dsa_area *area)
 
static void RestoreParamExecParams (char *start_address, EState *estate)
 
ParallelExecutorInfoExecInitParallelPlan (PlanState *planstate, EState *estate, Bitmapset *sendParams, int nworkers, int64 tuples_needed)
 
void ExecParallelCreateReaders (ParallelExecutorInfo *pei)
 
void ExecParallelReinitialize (PlanState *planstate, ParallelExecutorInfo *pei, Bitmapset *sendParams)
 
static void ExecParallelRetrieveJitInstrumentation (PlanState *planstate, SharedJitInstrumentation *shared_jit)
 
void ExecParallelFinish (ParallelExecutorInfo *pei)
 
void ExecParallelCleanup (ParallelExecutorInfo *pei)
 
static QueryDescExecParallelGetQueryDesc (shm_toc *toc, DestReceiver *receiver, int instrument_options)
 
static bool ExecParallelReportInstrumentation (PlanState *planstate, SharedExecutorInstrumentation *instrumentation)
 
static bool ExecParallelInitializeWorker (PlanState *planstate, ParallelWorkerContext *pwcxt)
 
void ParallelQueryMain (dsm_segment *seg, shm_toc *toc)
 

Macro Definition Documentation

◆ GetInstrumentationArray

#define GetInstrumentationArray (   sei)
Value:
(Instrumentation *) (((char *) sei) + sei->instrument_offset))
#define StaticAssertVariableIsOfTypeMacro(varname, typename)
Definition c.h:999
static int fb(int x)

Definition at line 109 of file execParallel.c.

114{
115 ParallelContext *pcxt;
116 int nnodes;
118
119/* Context object for ExecParallelInitializeDSM. */
121{
124 int nnodes;
126
127/* Helper functions that run in the parallel leader. */
128static char *ExecSerializePlan(Plan *plan, EState *estate);
129static bool ExecParallelEstimate(PlanState *planstate,
131static bool ExecParallelInitializeDSM(PlanState *planstate,
134 bool reinitialize);
135static bool ExecParallelReInitializeDSM(PlanState *planstate,
136 ParallelContext *pcxt);
138 SharedExecutorInstrumentation *instrumentation);
139
140/* Helper function that runs in the parallel worker. */
142
143/*
144 * Create a serialized representation of the plan to be sent to each worker.
145 */
146static char *
148{
149 PlannedStmt *pstmt;
150 ListCell *lc;
151
152 /* We can't scribble on the original plan, so make a copy. */
154
155 /*
156 * The worker will start its own copy of the executor, and that copy will
157 * insert a junk filter if the toplevel node has any resjunk entries. We
158 * don't want that to happen, because while resjunk columns shouldn't be
159 * sent back to the user, here the tuples are coming back to another
160 * backend which may very well need them. So mutate the target list
161 * accordingly. This is sort of a hack; there might be better ways to do
162 * this...
163 */
164 foreach(lc, plan->targetlist)
165 {
167
168 tle->resjunk = false;
169 }
170
171 /*
172 * Create a dummy PlannedStmt. Most of the fields don't need to be valid
173 * for our purposes, but the worker will need at least a minimal
174 * PlannedStmt to start the executor.
175 */
176 pstmt = makeNode(PlannedStmt);
177 pstmt->commandType = CMD_SELECT;
179 pstmt->planId = pgstat_get_my_plan_id();
180 pstmt->hasReturning = false;
181 pstmt->hasModifyingCTE = false;
182 pstmt->canSetTag = true;
183 pstmt->transientPlan = false;
184 pstmt->dependsOnRole = false;
185 pstmt->parallelModeNeeded = false;
186 pstmt->planTree = plan;
187 pstmt->partPruneInfos = estate->es_part_prune_infos;
188 pstmt->rtable = estate->es_range_table;
189 pstmt->unprunableRelids = estate->es_unpruned_relids;
190 pstmt->permInfos = estate->es_rteperminfos;
191 pstmt->resultRelations = NIL;
192 pstmt->appendRelations = NIL;
194
195 /*
196 * Transfer only parallel-safe subplans, leaving a NULL "hole" in the list
197 * for unsafe ones (so that the list indexes of the safe ones are
198 * preserved). This positively ensures that the worker won't try to run,
199 * or even do ExecInitNode on, an unsafe subplan. That's important to
200 * protect, eg, non-parallel-aware FDWs from getting into trouble.
201 */
202 pstmt->subplans = NIL;
203 foreach(lc, estate->es_plannedstmt->subplans)
204 {
205 Plan *subplan = (Plan *) lfirst(lc);
206
207 if (subplan && !subplan->parallel_safe)
208 subplan = NULL;
209 pstmt->subplans = lappend(pstmt->subplans, subplan);
210 }
211
212 pstmt->rewindPlanIDs = NULL;
213 pstmt->rowMarks = NIL;
214 pstmt->relationOids = NIL;
215 pstmt->invalItems = NIL; /* workers can't replan anyway... */
217 pstmt->utilityStmt = NULL;
218 pstmt->stmt_location = -1;
219 pstmt->stmt_len = -1;
220
221 /* Return serialized copy of our dummy PlannedStmt. */
222 return nodeToString(pstmt);
223}
224
225/*
226 * Parallel-aware plan nodes (and occasionally others) may need some state
227 * which is shared across all parallel workers. Before we size the DSM, give
228 * them a chance to call shm_toc_estimate_chunk or shm_toc_estimate_keys on
229 * &pcxt->estimator.
230 *
231 * While we're at it, count the number of PlanState nodes in the tree, so
232 * we know how many Instrumentation structures we need.
233 */
234static bool
236{
237 if (planstate == NULL)
238 return false;
239
240 /* Count this node. */
241 e->nnodes++;
242
243 switch (nodeTag(planstate))
244 {
245 case T_SeqScanState:
246 if (planstate->plan->parallel_aware)
247 ExecSeqScanEstimate((SeqScanState *) planstate,
248 e->pcxt);
249 break;
250 case T_IndexScanState:
251 /* even when not parallel-aware, for EXPLAIN ANALYZE */
253 e->pcxt);
254 break;
256 /* even when not parallel-aware, for EXPLAIN ANALYZE */
258 e->pcxt);
259 break;
261 /* even when not parallel-aware, for EXPLAIN ANALYZE */
263 e->pcxt);
264 break;
266 if (planstate->plan->parallel_aware)
268 e->pcxt);
269 break;
271 if (planstate->plan->parallel_aware)
273 e->pcxt);
274 break;
275 case T_AppendState:
276 if (planstate->plan->parallel_aware)
277 ExecAppendEstimate((AppendState *) planstate,
278 e->pcxt);
279 break;
281 if (planstate->plan->parallel_aware)
283 e->pcxt);
284 break;
286 if (planstate->plan->parallel_aware)
288 e->pcxt);
289 break;
290 case T_HashJoinState:
291 if (planstate->plan->parallel_aware)
293 e->pcxt);
294 break;
295 case T_HashState:
296 /* even when not parallel-aware, for EXPLAIN ANALYZE */
297 ExecHashEstimate((HashState *) planstate, e->pcxt);
298 break;
299 case T_SortState:
300 /* even when not parallel-aware, for EXPLAIN ANALYZE */
301 ExecSortEstimate((SortState *) planstate, e->pcxt);
302 break;
304 /* even when not parallel-aware, for EXPLAIN ANALYZE */
306 break;
307 case T_AggState:
308 /* even when not parallel-aware, for EXPLAIN ANALYZE */
309 ExecAggEstimate((AggState *) planstate, e->pcxt);
310 break;
311 case T_MemoizeState:
312 /* even when not parallel-aware, for EXPLAIN ANALYZE */
313 ExecMemoizeEstimate((MemoizeState *) planstate, e->pcxt);
314 break;
315 default:
316 break;
317 }
318
319 return planstate_tree_walker(planstate, ExecParallelEstimate, e);
320}
321
322/*
323 * Estimate the amount of space required to serialize the indicated parameters.
324 */
325static Size
327{
328 int paramid;
329 Size sz = sizeof(int);
330
331 paramid = -1;
332 while ((paramid = bms_next_member(params, paramid)) >= 0)
333 {
334 Oid typeOid;
335 int16 typLen;
336 bool typByVal;
338
339 prm = &(estate->es_param_exec_vals[paramid]);
340 typeOid = list_nth_oid(estate->es_plannedstmt->paramExecTypes,
341 paramid);
342
343 sz = add_size(sz, sizeof(int)); /* space for paramid */
344
345 /* space for datum/isnull */
346 if (OidIsValid(typeOid))
347 get_typlenbyval(typeOid, &typLen, &typByVal);
348 else
349 {
350 /* If no type OID, assume by-value, like copyParamList does. */
351 typLen = sizeof(Datum);
352 typByVal = true;
353 }
354 sz = add_size(sz,
355 datumEstimateSpace(prm->value, prm->isnull,
356 typByVal, typLen));
357 }
358 return sz;
359}
360
361/*
362 * Serialize specified PARAM_EXEC parameters.
363 *
364 * We write the number of parameters first, as a 4-byte integer, and then
365 * write details for each parameter in turn. The details for each parameter
366 * consist of a 4-byte paramid (location of param in execution time internal
367 * parameter array) and then the datum as serialized by datumSerialize().
368 */
369static dsa_pointer
370SerializeParamExecParams(EState *estate, Bitmapset *params, dsa_area *area)
371{
372 Size size;
373 int nparams;
374 int paramid;
376 dsa_pointer handle;
377 char *start_address;
378
379 /* Allocate enough space for the current parameter values. */
380 size = EstimateParamExecSpace(estate, params);
381 handle = dsa_allocate(area, size);
382 start_address = dsa_get_address(area, handle);
383
384 /* First write the number of parameters as a 4-byte integer. */
385 nparams = bms_num_members(params);
386 memcpy(start_address, &nparams, sizeof(int));
387 start_address += sizeof(int);
388
389 /* Write details for each parameter in turn. */
390 paramid = -1;
391 while ((paramid = bms_next_member(params, paramid)) >= 0)
392 {
393 Oid typeOid;
394 int16 typLen;
395 bool typByVal;
396
397 prm = &(estate->es_param_exec_vals[paramid]);
398 typeOid = list_nth_oid(estate->es_plannedstmt->paramExecTypes,
399 paramid);
400
401 /* Write paramid. */
402 memcpy(start_address, &paramid, sizeof(int));
403 start_address += sizeof(int);
404
405 /* Write datum/isnull */
406 if (OidIsValid(typeOid))
407 get_typlenbyval(typeOid, &typLen, &typByVal);
408 else
409 {
410 /* If no type OID, assume by-value, like copyParamList does. */
411 typLen = sizeof(Datum);
412 typByVal = true;
413 }
414 datumSerialize(prm->value, prm->isnull, typByVal, typLen,
416 }
417
418 return handle;
419}
420
421/*
422 * Restore specified PARAM_EXEC parameters.
423 */
424static void
426{
427 int nparams;
428 int i;
429 int paramid;
430
431 memcpy(&nparams, start_address, sizeof(int));
432 start_address += sizeof(int);
433
434 for (i = 0; i < nparams; i++)
435 {
437
438 /* Read paramid */
439 memcpy(&paramid, start_address, sizeof(int));
440 start_address += sizeof(int);
441 prm = &(estate->es_param_exec_vals[paramid]);
442
443 /* Read datum/isnull. */
444 prm->value = datumRestore(&start_address, &prm->isnull);
445 prm->execPlan = NULL;
446 }
447}
448
449/*
450 * Initialize the dynamic shared memory segment that will be used to control
451 * parallel execution.
452 */
453static bool
456{
457 if (planstate == NULL)
458 return false;
459
460 /* If instrumentation is enabled, initialize slot for this node. */
461 if (d->instrumentation != NULL)
463 planstate->plan->plan_node_id;
464
465 /* Count this node. */
466 d->nnodes++;
467
468 /*
469 * Call initializers for DSM-using plan nodes.
470 *
471 * Most plan nodes won't do anything here, but plan nodes that allocated
472 * DSM may need to initialize shared state in the DSM before parallel
473 * workers are launched. They can allocate the space they previously
474 * estimated using shm_toc_allocate, and add the keys they previously
475 * estimated using shm_toc_insert, in each case targeting pcxt->toc.
476 */
477 switch (nodeTag(planstate))
478 {
479 case T_SeqScanState:
480 if (planstate->plan->parallel_aware)
482 d->pcxt);
483 break;
484 case T_IndexScanState:
485 /* even when not parallel-aware, for EXPLAIN ANALYZE */
487 break;
489 /* even when not parallel-aware, for EXPLAIN ANALYZE */
491 d->pcxt);
492 break;
494 /* even when not parallel-aware, for EXPLAIN ANALYZE */
496 break;
498 if (planstate->plan->parallel_aware)
500 d->pcxt);
501 break;
503 if (planstate->plan->parallel_aware)
505 d->pcxt);
506 break;
507 case T_AppendState:
508 if (planstate->plan->parallel_aware)
510 d->pcxt);
511 break;
513 if (planstate->plan->parallel_aware)
515 d->pcxt);
516 break;
518 if (planstate->plan->parallel_aware)
520 d->pcxt);
521 break;
522 case T_HashJoinState:
523 if (planstate->plan->parallel_aware)
525 d->pcxt);
526 break;
527 case T_HashState:
528 /* even when not parallel-aware, for EXPLAIN ANALYZE */
529 ExecHashInitializeDSM((HashState *) planstate, d->pcxt);
530 break;
531 case T_SortState:
532 /* even when not parallel-aware, for EXPLAIN ANALYZE */
533 ExecSortInitializeDSM((SortState *) planstate, d->pcxt);
534 break;
536 /* even when not parallel-aware, for EXPLAIN ANALYZE */
538 break;
539 case T_AggState:
540 /* even when not parallel-aware, for EXPLAIN ANALYZE */
541 ExecAggInitializeDSM((AggState *) planstate, d->pcxt);
542 break;
543 case T_MemoizeState:
544 /* even when not parallel-aware, for EXPLAIN ANALYZE */
545 ExecMemoizeInitializeDSM((MemoizeState *) planstate, d->pcxt);
546 break;
547 default:
548 break;
549 }
550
552}
553
554/*
555 * It sets up the response queues for backend workers to return tuples
556 * to the main backend and start the workers.
557 */
558static shm_mq_handle **
560{
562 char *tqueuespace;
563 int i;
564
565 /* Skip this if no workers. */
566 if (pcxt->nworkers == 0)
567 return NULL;
568
569 /* Allocate memory for shared memory queue handles. */
571 palloc(pcxt->nworkers * sizeof(shm_mq_handle *));
572
573 /*
574 * If not reinitializing, allocate space from the DSM for the queues;
575 * otherwise, find the already allocated space.
576 */
577 if (!reinitialize)
579 shm_toc_allocate(pcxt->toc,
581 pcxt->nworkers));
582 else
584
585 /* Create the queues, and become the receiver for each. */
586 for (i = 0; i < pcxt->nworkers; ++i)
587 {
588 shm_mq *mq;
589
593
595 responseq[i] = shm_mq_attach(mq, pcxt->seg, NULL);
596 }
597
598 /* Add array of queues to shm_toc, so others can find it. */
599 if (!reinitialize)
601
602 /* Return array of handles. */
603 return responseq;
604}
605
606/*
607 * Sets up the required infrastructure for backend workers to perform
608 * execution and return results to the main backend.
609 */
611ExecInitParallelPlan(PlanState *planstate, EState *estate,
612 Bitmapset *sendParams, int nworkers,
613 int64 tuples_needed)
614{
616 ParallelContext *pcxt;
620 char *pstmt_data;
621 char *pstmt_space;
625 SharedExecutorInstrumentation *instrumentation = NULL;
626 SharedJitInstrumentation *jit_instrumentation = NULL;
627 int pstmt_len;
629 int instrumentation_len = 0;
631 int instrument_offset = 0;
633 char *query_string;
634 int query_len;
635
636 /*
637 * Force any initplan outputs that we're going to pass to workers to be
638 * evaluated, if they weren't already.
639 *
640 * For simplicity, we use the EState's per-output-tuple ExprContext here.
641 * That risks intra-query memory leakage, since we might pass through here
642 * many times before that ExprContext gets reset; but ExecSetParamPlan
643 * doesn't normally leak any memory in the context (see its comments), so
644 * it doesn't seem worth complicating this function's API to pass it a
645 * shorter-lived ExprContext. This might need to change someday.
646 */
648
649 /* Allocate object for return value. */
651 pei->finished = false;
652 pei->planstate = planstate;
653
654 /* Fix up and serialize plan to be sent to workers. */
655 pstmt_data = ExecSerializePlan(planstate->plan, estate);
656
657 /* Create a parallel context. */
658 pcxt = CreateParallelContext("postgres", "ParallelQueryMain", nworkers);
659 pei->pcxt = pcxt;
660
661 /*
662 * Before telling the parallel context to create a dynamic shared memory
663 * segment, we need to figure out how big it should be. Estimate space
664 * for the various things we need to store.
665 */
666
667 /* Estimate space for fixed-size state. */
671
672 /* Estimate space for query text. */
673 query_len = strlen(estate->es_sourceText);
674 shm_toc_estimate_chunk(&pcxt->estimator, query_len + 1);
676
677 /* Estimate space for serialized PlannedStmt. */
681
682 /* Estimate space for serialized ParamListInfo. */
686
687 /*
688 * Estimate space for BufferUsage.
689 *
690 * If EXPLAIN is not in use and there are no extensions loaded that care,
691 * we could skip this. But we have no way of knowing whether anyone's
692 * looking at pgBufferUsage, so do it unconditionally.
693 */
695 mul_size(sizeof(BufferUsage), pcxt->nworkers));
697
698 /*
699 * Same thing for WalUsage.
700 */
702 mul_size(sizeof(WalUsage), pcxt->nworkers));
704
705 /* Estimate space for tuple queues. */
709
710 /*
711 * Give parallel-aware nodes a chance to add to the estimates, and get a
712 * count of how many PlanState nodes there are.
713 */
714 e.pcxt = pcxt;
715 e.nnodes = 0;
716 ExecParallelEstimate(planstate, &e);
717
718 /* Estimate space for instrumentation, if required. */
719 if (estate->es_instrument)
720 {
723 sizeof(int) * e.nnodes;
725 instrument_offset = instrumentation_len;
728 mul_size(e.nnodes, nworkers));
731
732 /* Estimate space for JIT instrumentation, if required. */
733 if (estate->es_jit_flags != PGJIT_NONE)
734 {
737 sizeof(JitInstrumentation) * nworkers;
740 }
741 }
742
743 /* Estimate space for DSA area. */
746
747 /*
748 * InitializeParallelDSM() passes the active snapshot to the parallel
749 * worker, which uses it to set es_snapshot. Make sure we don't set
750 * es_snapshot differently in the child.
751 */
753
754 /* Everyone's had a chance to ask for space, so now create the DSM. */
756
757 /*
758 * OK, now we have a dynamic shared memory segment, and it should be big
759 * enough to store all of the data we estimated we would want to put into
760 * it, plus whatever general stuff (not specifically executor-related) the
761 * ParallelContext itself needs to store there. None of the space we
762 * asked for has been allocated or initialized yet, though, so do that.
763 */
764
765 /* Store fixed-size state. */
767 fpes->tuples_needed = tuples_needed;
768 fpes->param_exec = InvalidDsaPointer;
769 fpes->eflags = estate->es_top_eflags;
770 fpes->jit_flags = estate->es_jit_flags;
772
773 /* Store query string */
774 query_string = shm_toc_allocate(pcxt->toc, query_len + 1);
775 memcpy(query_string, estate->es_sourceText, query_len + 1);
776 shm_toc_insert(pcxt->toc, PARALLEL_KEY_QUERY_TEXT, query_string);
777
778 /* Store serialized PlannedStmt. */
782
783 /* Store serialized ParamListInfo. */
787
788 /* Allocate space for each worker's BufferUsage; no need to initialize. */
790 mul_size(sizeof(BufferUsage), pcxt->nworkers));
793
794 /* Same for WalUsage. */
796 mul_size(sizeof(WalUsage), pcxt->nworkers));
799
800 /* Set up the tuple queues that the workers will write into. */
801 pei->tqueue = ExecParallelSetupTupleQueues(pcxt, false);
802
803 /* We don't need the TupleQueueReaders yet, though. */
804 pei->reader = NULL;
805
806 /*
807 * If instrumentation options were supplied, allocate space for the data.
808 * It only gets partially initialized here; the rest happens during
809 * ExecParallelInitializeDSM.
810 */
811 if (estate->es_instrument)
812 {
813 Instrumentation *instrument;
814 int i;
815
816 instrumentation = shm_toc_allocate(pcxt->toc, instrumentation_len);
817 instrumentation->instrument_options = estate->es_instrument;
818 instrumentation->instrument_offset = instrument_offset;
819 instrumentation->num_workers = nworkers;
820 instrumentation->num_plan_nodes = e.nnodes;
821 instrument = GetInstrumentationArray(instrumentation);
822 for (i = 0; i < nworkers * e.nnodes; ++i)
823 InstrInit(&instrument[i], estate->es_instrument);
825 instrumentation);
826 pei->instrumentation = instrumentation;
827
828 if (estate->es_jit_flags != PGJIT_NONE)
829 {
830 jit_instrumentation = shm_toc_allocate(pcxt->toc,
832 jit_instrumentation->num_workers = nworkers;
833 memset(jit_instrumentation->jit_instr, 0,
834 sizeof(JitInstrumentation) * nworkers);
836 jit_instrumentation);
837 pei->jit_instrumentation = jit_instrumentation;
838 }
839 }
840
841 /*
842 * Create a DSA area that can be used by the leader and all workers.
843 * (However, if we failed to create a DSM and are using private memory
844 * instead, then skip this.)
845 */
846 if (pcxt->seg != NULL)
847 {
848 char *area_space;
849
854 pcxt->seg);
855
856 /*
857 * Serialize parameters, if any, using DSA storage. We don't dare use
858 * the main parallel query DSM for this because we might relaunch
859 * workers after the values have changed (and thus the amount of
860 * storage required has changed).
861 */
863 {
865 pei->area);
866 fpes->param_exec = pei->param_exec;
867 }
868 }
869
870 /*
871 * Give parallel-aware nodes a chance to initialize their shared data.
872 * This also initializes the elements of instrumentation->ps_instrument,
873 * if it exists.
874 */
875 d.pcxt = pcxt;
876 d.instrumentation = instrumentation;
877 d.nnodes = 0;
878
879 /* Install our DSA area while initializing the plan. */
880 estate->es_query_dsa = pei->area;
881 ExecParallelInitializeDSM(planstate, &d);
882 estate->es_query_dsa = NULL;
883
884 /*
885 * Make sure that the world hasn't shifted under our feet. This could
886 * probably just be an Assert(), but let's be conservative for now.
887 */
888 if (e.nnodes != d.nnodes)
889 elog(ERROR, "inconsistent count of PlanState nodes");
890
891 /* OK, we're ready to rock and roll. */
892 return pei;
893}
894
895/*
896 * Set up tuple queue readers to read the results of a parallel subplan.
897 *
898 * This is separate from ExecInitParallelPlan() because we can launch the
899 * worker processes and let them start doing something before we do this.
900 */
901void
903{
904 int nworkers = pei->pcxt->nworkers_launched;
905 int i;
906
907 Assert(pei->reader == NULL);
908
909 if (nworkers > 0)
910 {
911 pei->reader = (TupleQueueReader **)
912 palloc(nworkers * sizeof(TupleQueueReader *));
913
914 for (i = 0; i < nworkers; i++)
915 {
917 pei->pcxt->worker[i].bgwhandle);
918 pei->reader[i] = CreateTupleQueueReader(pei->tqueue[i]);
919 }
920 }
921}
922
923/*
924 * Re-initialize the parallel executor shared memory state before launching
925 * a fresh batch of workers.
926 */
927void
931{
932 EState *estate = planstate->state;
934
935 /* Old workers must already be shut down */
936 Assert(pei->finished);
937
938 /*
939 * Force any initplan outputs that we're going to pass to workers to be
940 * evaluated, if they weren't already (see comments in
941 * ExecInitParallelPlan).
942 */
944
946 pei->tqueue = ExecParallelSetupTupleQueues(pei->pcxt, true);
947 pei->reader = NULL;
948 pei->finished = false;
949
951
952 /* Free any serialized parameters from the last round. */
953 if (DsaPointerIsValid(fpes->param_exec))
954 {
955 dsa_free(pei->area, fpes->param_exec);
956 fpes->param_exec = InvalidDsaPointer;
957 }
958
959 /* Serialize current parameter values if required. */
961 {
963 pei->area);
964 fpes->param_exec = pei->param_exec;
965 }
966
967 /* Traverse plan tree and let each child node reset associated state. */
968 estate->es_query_dsa = pei->area;
969 ExecParallelReInitializeDSM(planstate, pei->pcxt);
970 estate->es_query_dsa = NULL;
971}
972
973/*
974 * Traverse plan tree to reinitialize per-node dynamic shared memory state
975 */
976static bool
978 ParallelContext *pcxt)
979{
980 if (planstate == NULL)
981 return false;
982
983 /*
984 * Call reinitializers for DSM-using plan nodes.
985 */
986 switch (nodeTag(planstate))
987 {
988 case T_SeqScanState:
989 if (planstate->plan->parallel_aware)
991 pcxt);
992 break;
993 case T_IndexScanState:
994 if (planstate->plan->parallel_aware)
996 pcxt);
997 break;
999 if (planstate->plan->parallel_aware)
1001 pcxt);
1002 break;
1003 case T_ForeignScanState:
1004 if (planstate->plan->parallel_aware)
1006 pcxt);
1007 break;
1009 if (planstate->plan->parallel_aware)
1011 pcxt);
1012 break;
1013 case T_AppendState:
1014 if (planstate->plan->parallel_aware)
1015 ExecAppendReInitializeDSM((AppendState *) planstate, pcxt);
1016 break;
1017 case T_CustomScanState:
1018 if (planstate->plan->parallel_aware)
1020 pcxt);
1021 break;
1023 if (planstate->plan->parallel_aware)
1025 pcxt);
1026 break;
1027 case T_HashJoinState:
1028 if (planstate->plan->parallel_aware)
1030 pcxt);
1031 break;
1033 case T_HashState:
1034 case T_SortState:
1036 case T_MemoizeState:
1037 /* these nodes have DSM state, but no reinitialization is required */
1038 break;
1039
1040 default:
1041 break;
1042 }
1043
1044 return planstate_tree_walker(planstate, ExecParallelReInitializeDSM, pcxt);
1045}
1046
1047/*
1048 * Copy instrumentation information about this node and its descendants from
1049 * dynamic shared memory.
1050 */
1051static bool
1053 SharedExecutorInstrumentation *instrumentation)
1054{
1055 Instrumentation *instrument;
1056 int i;
1057 int n;
1058 int ibytes;
1059 int plan_node_id = planstate->plan->plan_node_id;
1060 MemoryContext oldcontext;
1061
1062 /* Find the instrumentation for this node. */
1063 for (i = 0; i < instrumentation->num_plan_nodes; ++i)
1064 if (instrumentation->plan_node_id[i] == plan_node_id)
1065 break;
1066 if (i >= instrumentation->num_plan_nodes)
1067 elog(ERROR, "plan node %d not found", plan_node_id);
1068
1069 /* Accumulate the statistics from all workers. */
1070 instrument = GetInstrumentationArray(instrumentation);
1071 instrument += i * instrumentation->num_workers;
1072 for (n = 0; n < instrumentation->num_workers; ++n)
1073 InstrAggNode(planstate->instrument, &instrument[n]);
1074
1075 /*
1076 * Also store the per-worker detail.
1077 *
1078 * Worker instrumentation should be allocated in the same context as the
1079 * regular instrumentation information, which is the per-query context.
1080 * Switch into per-query memory context.
1081 */
1082 oldcontext = MemoryContextSwitchTo(planstate->state->es_query_cxt);
1083 ibytes = mul_size(instrumentation->num_workers, sizeof(Instrumentation));
1084 planstate->worker_instrument =
1086 MemoryContextSwitchTo(oldcontext);
1087
1088 planstate->worker_instrument->num_workers = instrumentation->num_workers;
1089 memcpy(&planstate->worker_instrument->instrument, instrument, ibytes);
1090
1091 /* Perform any node-type-specific work that needs to be done. */
1092 switch (nodeTag(planstate))
1093 {
1094 case T_IndexScanState:
1096 break;
1099 break;
1102 break;
1103 case T_SortState:
1105 break;
1108 break;
1109 case T_HashState:
1111 break;
1112 case T_AggState:
1114 break;
1115 case T_MemoizeState:
1117 break;
1120 break;
1121 default:
1122 break;
1123 }
1124
1126 instrumentation);
1127}
1128
1129/*
1130 * Add up the workers' JIT instrumentation from dynamic shared memory.
1131 */
1132static void
1135{
1137 int ibytes;
1138
1139 int n;
1140
1141 /*
1142 * Accumulate worker JIT instrumentation into the combined JIT
1143 * instrumentation, allocating it if required.
1144 */
1145 if (!planstate->state->es_jit_worker_instr)
1146 planstate->state->es_jit_worker_instr =
1148 combined = planstate->state->es_jit_worker_instr;
1149
1150 /* Accumulate all the workers' instrumentations. */
1151 for (n = 0; n < shared_jit->num_workers; ++n)
1152 InstrJitAgg(combined, &shared_jit->jit_instr[n]);
1153
1154 /*
1155 * Store the per-worker detail.
1156 *
1157 * Similar to ExecParallelRetrieveInstrumentation(), allocate the
1158 * instrumentation in per-query context.
1159 */
1161 + mul_size(shared_jit->num_workers, sizeof(JitInstrumentation));
1162 planstate->worker_jit_instrument =
1164
1166}
1167
1168/*
1169 * Finish parallel execution. We wait for parallel workers to finish, and
1170 * accumulate their buffer/WAL usage.
1171 */
1172void
1174{
1175 int nworkers = pei->pcxt->nworkers_launched;
1176 int i;
1177
1178 /* Make this be a no-op if called twice in a row. */
1179 if (pei->finished)
1180 return;
1181
1182 /*
1183 * Detach from tuple queues ASAP, so that any still-active workers will
1184 * notice that no further results are wanted.
1185 */
1186 if (pei->tqueue != NULL)
1187 {
1188 for (i = 0; i < nworkers; i++)
1189 shm_mq_detach(pei->tqueue[i]);
1190 pfree(pei->tqueue);
1191 pei->tqueue = NULL;
1192 }
1193
1194 /*
1195 * While we're waiting for the workers to finish, let's get rid of the
1196 * tuple queue readers. (Any other local cleanup could be done here too.)
1197 */
1198 if (pei->reader != NULL)
1199 {
1200 for (i = 0; i < nworkers; i++)
1202 pfree(pei->reader);
1203 pei->reader = NULL;
1204 }
1205
1206 /* Now wait for the workers to finish. */
1208
1209 /*
1210 * Next, accumulate buffer/WAL usage. (This must wait for the workers to
1211 * finish, or we might get incomplete data.)
1212 */
1213 for (i = 0; i < nworkers; i++)
1215
1216 pei->finished = true;
1217}
1218
1219/*
1220 * Accumulate instrumentation, and then clean up whatever ParallelExecutorInfo
1221 * resources still exist after ExecParallelFinish. We separate these
1222 * routines because someone might want to examine the contents of the DSM
1223 * after ExecParallelFinish and before calling this routine.
1224 */
1225void
1227{
1228 /* Accumulate instrumentation, if any. */
1229 if (pei->instrumentation)
1231 pei->instrumentation);
1232
1233 /* Accumulate JIT instrumentation, if any. */
1234 if (pei->jit_instrumentation)
1236 pei->jit_instrumentation);
1237
1238 /* Free any serialized parameters. */
1239 if (DsaPointerIsValid(pei->param_exec))
1240 {
1241 dsa_free(pei->area, pei->param_exec);
1243 }
1244 if (pei->area != NULL)
1245 {
1246 dsa_detach(pei->area);
1247 pei->area = NULL;
1248 }
1249 if (pei->pcxt != NULL)
1250 {
1252 pei->pcxt = NULL;
1253 }
1254 pfree(pei);
1255}
1256
1257/*
1258 * Create a DestReceiver to write tuples we produce to the shm_mq designated
1259 * for that purpose.
1260 */
1261static DestReceiver *
1263{
1264 char *mqspace;
1265 shm_mq *mq;
1266
1269 mq = (shm_mq *) mqspace;
1272}
1273
1274/*
1275 * Create a QueryDesc for the PlannedStmt we are to execute, and return it.
1276 */
1277static QueryDesc *
1279 int instrument_options)
1280{
1281 char *pstmtspace;
1282 char *paramspace;
1283 PlannedStmt *pstmt;
1284 ParamListInfo paramLI;
1285 char *queryString;
1286
1287 /* Get the query string from shared memory */
1288 queryString = shm_toc_lookup(toc, PARALLEL_KEY_QUERY_TEXT, false);
1289
1290 /* Reconstruct leader-supplied PlannedStmt. */
1292 pstmt = (PlannedStmt *) stringToNode(pstmtspace);
1293
1294 /* Reconstruct ParamListInfo. */
1296 paramLI = RestoreParamList(&paramspace);
1297
1298 /* Create a QueryDesc for the query. */
1299 return CreateQueryDesc(pstmt,
1300 queryString,
1302 receiver, paramLI, NULL, instrument_options);
1303}
1304
1305/*
1306 * Copy instrumentation information from this node and its descendants into
1307 * dynamic shared memory, so that the parallel leader can retrieve it.
1308 */
1309static bool
1311 SharedExecutorInstrumentation *instrumentation)
1312{
1313 int i;
1314 int plan_node_id = planstate->plan->plan_node_id;
1315 Instrumentation *instrument;
1316
1317 InstrEndLoop(planstate->instrument);
1318
1319 /*
1320 * If we shuffled the plan_node_id values in ps_instrument into sorted
1321 * order, we could use binary search here. This might matter someday if
1322 * we're pushing down sufficiently large plan trees. For now, do it the
1323 * slow, dumb way.
1324 */
1325 for (i = 0; i < instrumentation->num_plan_nodes; ++i)
1326 if (instrumentation->plan_node_id[i] == plan_node_id)
1327 break;
1328 if (i >= instrumentation->num_plan_nodes)
1329 elog(ERROR, "plan node %d not found", plan_node_id);
1330
1331 /*
1332 * Add our statistics to the per-node, per-worker totals. It's possible
1333 * that this could happen more than once if we relaunched workers.
1334 */
1335 instrument = GetInstrumentationArray(instrumentation);
1336 instrument += i * instrumentation->num_workers;
1339 InstrAggNode(&instrument[ParallelWorkerNumber], planstate->instrument);
1340
1342 instrumentation);
1343}
1344
1345/*
1346 * Initialize the PlanState and its descendants with the information
1347 * retrieved from shared memory. This has to be done once the PlanState
1348 * is allocated and initialized by executor; that is, after ExecutorStart().
1349 */
1350static bool
1352{
1353 if (planstate == NULL)
1354 return false;
1355
1356 switch (nodeTag(planstate))
1357 {
1358 case T_SeqScanState:
1359 if (planstate->plan->parallel_aware)
1361 break;
1362 case T_IndexScanState:
1363 /* even when not parallel-aware, for EXPLAIN ANALYZE */
1365 break;
1367 /* even when not parallel-aware, for EXPLAIN ANALYZE */
1369 pwcxt);
1370 break;
1372 /* even when not parallel-aware, for EXPLAIN ANALYZE */
1374 pwcxt);
1375 break;
1376 case T_ForeignScanState:
1377 if (planstate->plan->parallel_aware)
1379 pwcxt);
1380 break;
1382 if (planstate->plan->parallel_aware)
1384 pwcxt);
1385 break;
1386 case T_AppendState:
1387 if (planstate->plan->parallel_aware)
1389 break;
1390 case T_CustomScanState:
1391 if (planstate->plan->parallel_aware)
1393 pwcxt);
1394 break;
1396 if (planstate->plan->parallel_aware)
1398 pwcxt);
1399 break;
1400 case T_HashJoinState:
1401 if (planstate->plan->parallel_aware)
1403 pwcxt);
1404 break;
1405 case T_HashState:
1406 /* even when not parallel-aware, for EXPLAIN ANALYZE */
1408 break;
1409 case T_SortState:
1410 /* even when not parallel-aware, for EXPLAIN ANALYZE */
1412 break;
1414 /* even when not parallel-aware, for EXPLAIN ANALYZE */
1416 pwcxt);
1417 break;
1418 case T_AggState:
1419 /* even when not parallel-aware, for EXPLAIN ANALYZE */
1420 ExecAggInitializeWorker((AggState *) planstate, pwcxt);
1421 break;
1422 case T_MemoizeState:
1423 /* even when not parallel-aware, for EXPLAIN ANALYZE */
1425 break;
1426 default:
1427 break;
1428 }
1429
1431 pwcxt);
1432}
1433
1434/*
1435 * Main entrypoint for parallel query worker processes.
1436 *
1437 * We reach this function from ParallelWorkerMain, so the setup necessary to
1438 * create a sensible parallel environment has already been done;
1439 * ParallelWorkerMain worries about stuff like the transaction state, combo
1440 * CID mappings, and GUC values, so we don't need to deal with any of that
1441 * here.
1442 *
1443 * Our job is to deal with concerns specific to the executor. The parallel
1444 * group leader will have stored a serialized PlannedStmt, and it's our job
1445 * to execute that plan and write the resulting tuples to the appropriate
1446 * tuple queue. Various bits of supporting information that we need in order
1447 * to do this are also stored in the dsm_segment and can be accessed through
1448 * the shm_toc.
1449 */
1450void
1452{
1454 BufferUsage *buffer_usage;
1455 WalUsage *wal_usage;
1457 QueryDesc *queryDesc;
1458 SharedExecutorInstrumentation *instrumentation;
1459 SharedJitInstrumentation *jit_instrumentation;
1460 int instrument_options = 0;
1461 void *area_space;
1462 dsa_area *area;
1464
1465 /* Get fixed-size state. */
1467
1468 /* Set up DestReceiver, SharedExecutorInstrumentation, and QueryDesc. */
1470 instrumentation = shm_toc_lookup(toc, PARALLEL_KEY_INSTRUMENTATION, true);
1471 if (instrumentation != NULL)
1472 instrument_options = instrumentation->instrument_options;
1473 jit_instrumentation = shm_toc_lookup(toc, PARALLEL_KEY_JIT_INSTRUMENTATION,
1474 true);
1475 queryDesc = ExecParallelGetQueryDesc(toc, receiver, instrument_options);
1476
1477 /* Setting debug_query_string for individual workers */
1478 debug_query_string = queryDesc->sourceText;
1479
1480 /* Report workers' query for monitoring purposes */
1482
1483 /* Attach to the dynamic shared memory area. */
1485 area = dsa_attach_in_place(area_space, seg);
1486
1487 /* Start up the executor */
1488 queryDesc->plannedstmt->jitFlags = fpes->jit_flags;
1489 ExecutorStart(queryDesc, fpes->eflags);
1490
1491 /* Special executor initialization steps for parallel workers */
1492 queryDesc->planstate->state->es_query_dsa = area;
1493 if (DsaPointerIsValid(fpes->param_exec))
1494 {
1495 char *paramexec_space;
1496
1497 paramexec_space = dsa_get_address(area, fpes->param_exec);
1499 }
1500 pwcxt.toc = toc;
1501 pwcxt.seg = seg;
1503
1504 /* Pass down any tuple bound */
1505 ExecSetTupleBound(fpes->tuples_needed, queryDesc->planstate);
1506
1507 /*
1508 * Prepare to track buffer/WAL usage during query execution.
1509 *
1510 * We do this after starting up the executor to match what happens in the
1511 * leader, which also doesn't count buffer accesses and WAL activity that
1512 * occur during executor startup.
1513 */
1515
1516 /*
1517 * Run the plan. If we specified a tuple bound, be careful not to demand
1518 * more tuples than that.
1519 */
1520 ExecutorRun(queryDesc,
1522 fpes->tuples_needed < 0 ? (int64) 0 : fpes->tuples_needed);
1523
1524 /* Shut down the executor */
1525 ExecutorFinish(queryDesc);
1526
1527 /* Report buffer/WAL usage during parallel execution. */
1528 buffer_usage = shm_toc_lookup(toc, PARALLEL_KEY_BUFFER_USAGE, false);
1529 wal_usage = shm_toc_lookup(toc, PARALLEL_KEY_WAL_USAGE, false);
1531 &wal_usage[ParallelWorkerNumber]);
1532
1533 /* Report instrumentation data if any instrumentation options are set. */
1534 if (instrumentation != NULL)
1536 instrumentation);
1537
1538 /* Report JIT instrumentation data if any */
1539 if (queryDesc->estate->es_jit && jit_instrumentation != NULL)
1540 {
1542 jit_instrumentation->jit_instr[ParallelWorkerNumber] =
1543 queryDesc->estate->es_jit->instr;
1544 }
1545
1546 /* Must do this after capturing instrumentation. */
1547 ExecutorEnd(queryDesc);
1548
1549 /* Cleanup. */
1550 dsa_detach(area);
1551 FreeQueryDesc(queryDesc);
1552 receiver->rDestroy(receiver);
1553}
int ParallelWorkerNumber
Definition parallel.c:116
void InitializeParallelDSM(ParallelContext *pcxt)
Definition parallel.c:212
void WaitForParallelWorkersToFinish(ParallelContext *pcxt)
Definition parallel.c:804
void ReinitializeParallelDSM(ParallelContext *pcxt)
Definition parallel.c:510
void DestroyParallelContext(ParallelContext *pcxt)
Definition parallel.c:958
ParallelContext * CreateParallelContext(const char *library_name, const char *function_name, int nworkers)
Definition parallel.c:174
int64 pgstat_get_my_query_id(void)
void pgstat_report_activity(BackendState state, const char *cmd_str)
int64 pgstat_get_my_plan_id(void)
@ STATE_RUNNING
int bms_next_member(const Bitmapset *a, int prevbit)
Definition bitmapset.c:1290
int bms_num_members(const Bitmapset *a)
Definition bitmapset.c:744
#define bms_is_empty(a)
Definition bitmapset.h:118
#define MAXALIGN(LEN)
Definition c.h:838
#define Assert(condition)
Definition c.h:885
int64_t int64
Definition c.h:555
int16_t int16
Definition c.h:553
#define OidIsValid(objectId)
Definition c.h:800
size_t Size
Definition c.h:631
Datum datumRestore(char **start_address, bool *isnull)
Definition datum.c:523
void datumSerialize(Datum value, bool isnull, bool typByVal, int typLen, char **start_address)
Definition datum.c:461
Size datumEstimateSpace(Datum value, bool isnull, bool typByVal, int typLen)
Definition datum.c:414
dsa_area * dsa_attach_in_place(void *place, dsm_segment *segment)
Definition dsa.c:560
void * dsa_get_address(dsa_area *area, dsa_pointer dp)
Definition dsa.c:957
void dsa_detach(dsa_area *area)
Definition dsa.c:2002
void dsa_free(dsa_area *area, dsa_pointer dp)
Definition dsa.c:841
size_t dsa_minimum_size(void)
Definition dsa.c:1246
uint64 dsa_pointer
Definition dsa.h:62
#define dsa_allocate(area, size)
Definition dsa.h:109
#define dsa_create_in_place(place, size, tranche_id, segment)
Definition dsa.h:122
#define InvalidDsaPointer
Definition dsa.h:78
#define DsaPointerIsValid(x)
Definition dsa.h:106
#define ERROR
Definition elog.h:39
#define elog(elevel,...)
Definition elog.h:226
void ExecutorEnd(QueryDesc *queryDesc)
Definition execMain.c:466
void ExecutorFinish(QueryDesc *queryDesc)
Definition execMain.c:406
void ExecutorStart(QueryDesc *queryDesc, int eflags)
Definition execMain.c:122
void ExecutorRun(QueryDesc *queryDesc, ScanDirection direction, uint64 count)
Definition execMain.c:297
#define PARALLEL_KEY_BUFFER_USAGE
static bool ExecParallelReInitializeDSM(PlanState *planstate, ParallelContext *pcxt)
#define PARALLEL_KEY_JIT_INSTRUMENTATION
#define PARALLEL_KEY_PARAMLISTINFO
#define PARALLEL_TUPLE_QUEUE_SIZE
static QueryDesc * ExecParallelGetQueryDesc(shm_toc *toc, DestReceiver *receiver, int instrument_options)
static bool ExecParallelRetrieveInstrumentation(PlanState *planstate, SharedExecutorInstrumentation *instrumentation)
static dsa_pointer SerializeParamExecParams(EState *estate, Bitmapset *params, dsa_area *area)
void ExecParallelCleanup(ParallelExecutorInfo *pei)
#define PARALLEL_KEY_INSTRUMENTATION
static DestReceiver * ExecParallelGetReceiver(dsm_segment *seg, shm_toc *toc)
void ParallelQueryMain(dsm_segment *seg, shm_toc *toc)
static shm_mq_handle ** ExecParallelSetupTupleQueues(ParallelContext *pcxt, bool reinitialize)
#define PARALLEL_KEY_PLANNEDSTMT
static bool ExecParallelEstimate(PlanState *planstate, ExecParallelEstimateContext *e)
#define GetInstrumentationArray(sei)
void ExecParallelReinitialize(PlanState *planstate, ParallelExecutorInfo *pei, Bitmapset *sendParams)
#define PARALLEL_KEY_DSA
static bool ExecParallelInitializeWorker(PlanState *planstate, ParallelWorkerContext *pwcxt)
void ExecParallelCreateReaders(ParallelExecutorInfo *pei)
#define PARALLEL_KEY_TUPLE_QUEUE
#define PARALLEL_KEY_EXECUTOR_FIXED
static char * ExecSerializePlan(Plan *plan, EState *estate)
ParallelExecutorInfo * ExecInitParallelPlan(PlanState *planstate, EState *estate, Bitmapset *sendParams, int nworkers, int64 tuples_needed)
#define PARALLEL_KEY_QUERY_TEXT
static Size EstimateParamExecSpace(EState *estate, Bitmapset *params)
void ExecParallelFinish(ParallelExecutorInfo *pei)
static bool ExecParallelReportInstrumentation(PlanState *planstate, SharedExecutorInstrumentation *instrumentation)
#define PARALLEL_KEY_WAL_USAGE
static void ExecParallelRetrieveJitInstrumentation(PlanState *planstate, SharedJitInstrumentation *shared_jit)
static bool ExecParallelInitializeDSM(PlanState *planstate, ExecParallelInitializeDSMContext *d)
static void RestoreParamExecParams(char *start_address, EState *estate)
void ExecSetTupleBound(int64 tuples_needed, PlanState *child_node)
#define GetPerTupleExprContext(estate)
Definition executor.h:656
#define palloc0_object(type)
Definition fe_memutils.h:75
#define IsParallelWorker()
Definition parallel.h:62
void InstrAccumParallelQuery(BufferUsage *bufusage, WalUsage *walusage)
Definition instrument.c:219
void InstrEndLoop(Instrumentation *instr)
Definition instrument.c:144
void InstrAggNode(Instrumentation *dst, Instrumentation *add)
Definition instrument.c:169
void InstrEndParallelQuery(BufferUsage *bufusage, WalUsage *walusage)
Definition instrument.c:209
void InstrStartParallelQuery(void)
Definition instrument.c:201
void InstrInit(Instrumentation *instr, int instrument_options)
Definition instrument.c:58
int i
Definition isn.c:77
void InstrJitAgg(JitInstrumentation *dst, JitInstrumentation *add)
Definition jit.c:182
#define PGJIT_NONE
Definition jit.h:19
List * lappend(List *list, void *datum)
Definition list.c:339
void get_typlenbyval(Oid typid, int16 *typlen, bool *typbyval)
Definition lsyscache.c:2401
void * MemoryContextAlloc(MemoryContext context, Size size)
Definition mcxt.c:1232
void * MemoryContextAllocZero(MemoryContext context, Size size)
Definition mcxt.c:1266
void pfree(void *pointer)
Definition mcxt.c:1616
void * palloc(Size size)
Definition mcxt.c:1387
void ExecAggEstimate(AggState *node, ParallelContext *pcxt)
Definition nodeAgg.c:4779
void ExecAggInitializeWorker(AggState *node, ParallelWorkerContext *pwcxt)
Definition nodeAgg.c:4825
void ExecAggRetrieveInstrumentation(AggState *node)
Definition nodeAgg.c:4838
void ExecAggInitializeDSM(AggState *node, ParallelContext *pcxt)
Definition nodeAgg.c:4800
void ExecAppendReInitializeDSM(AppendState *node, ParallelContext *pcxt)
Definition nodeAppend.c:540
void ExecAppendInitializeWorker(AppendState *node, ParallelWorkerContext *pwcxt)
Definition nodeAppend.c:556
void ExecAppendInitializeDSM(AppendState *node, ParallelContext *pcxt)
Definition nodeAppend.c:519
void ExecAppendEstimate(AppendState *node, ParallelContext *pcxt)
Definition nodeAppend.c:500
void ExecBitmapHeapInitializeWorker(BitmapHeapScanState *node, ParallelWorkerContext *pwcxt)
void ExecBitmapHeapEstimate(BitmapHeapScanState *node, ParallelContext *pcxt)
void ExecBitmapHeapRetrieveInstrumentation(BitmapHeapScanState *node)
void ExecBitmapHeapInitializeDSM(BitmapHeapScanState *node, ParallelContext *pcxt)
void ExecBitmapHeapReInitializeDSM(BitmapHeapScanState *node, ParallelContext *pcxt)
void ExecBitmapIndexScanEstimate(BitmapIndexScanState *node, ParallelContext *pcxt)
void ExecBitmapIndexScanInitializeDSM(BitmapIndexScanState *node, ParallelContext *pcxt)
void ExecBitmapIndexScanRetrieveInstrumentation(BitmapIndexScanState *node)
void ExecBitmapIndexScanInitializeWorker(BitmapIndexScanState *node, ParallelWorkerContext *pwcxt)
void ExecCustomScanInitializeDSM(CustomScanState *node, ParallelContext *pcxt)
Definition nodeCustom.c:174
void ExecCustomScanEstimate(CustomScanState *node, ParallelContext *pcxt)
Definition nodeCustom.c:161
void ExecCustomScanReInitializeDSM(CustomScanState *node, ParallelContext *pcxt)
Definition nodeCustom.c:190
void ExecCustomScanInitializeWorker(CustomScanState *node, ParallelWorkerContext *pwcxt)
Definition nodeCustom.c:205
void ExecForeignScanInitializeDSM(ForeignScanState *node, ParallelContext *pcxt)
void ExecForeignScanReInitializeDSM(ForeignScanState *node, ParallelContext *pcxt)
void ExecForeignScanEstimate(ForeignScanState *node, ParallelContext *pcxt)
void ExecForeignScanInitializeWorker(ForeignScanState *node, ParallelWorkerContext *pwcxt)
#define planstate_tree_walker(ps, w, c)
Definition nodeFuncs.h:179
void ExecHashInitializeDSM(HashState *node, ParallelContext *pcxt)
Definition nodeHash.c:2779
void ExecHashInitializeWorker(HashState *node, ParallelWorkerContext *pwcxt)
Definition nodeHash.c:2804
void ExecHashEstimate(HashState *node, ParallelContext *pcxt)
Definition nodeHash.c:2760
void ExecHashRetrieveInstrumentation(HashState *node)
Definition nodeHash.c:2845
void ExecHashJoinInitializeDSM(HashJoinState *state, ParallelContext *pcxt)
void ExecHashJoinEstimate(HashJoinState *state, ParallelContext *pcxt)
void ExecHashJoinReInitializeDSM(HashJoinState *state, ParallelContext *pcxt)
void ExecHashJoinInitializeWorker(HashJoinState *state, ParallelWorkerContext *pwcxt)
void ExecIncrementalSortEstimate(IncrementalSortState *node, ParallelContext *pcxt)
void ExecIncrementalSortInitializeDSM(IncrementalSortState *node, ParallelContext *pcxt)
void ExecIncrementalSortRetrieveInstrumentation(IncrementalSortState *node)
void ExecIncrementalSortInitializeWorker(IncrementalSortState *node, ParallelWorkerContext *pwcxt)
void ExecIndexOnlyScanEstimate(IndexOnlyScanState *node, ParallelContext *pcxt)
void ExecIndexOnlyScanRetrieveInstrumentation(IndexOnlyScanState *node)
void ExecIndexOnlyScanInitializeWorker(IndexOnlyScanState *node, ParallelWorkerContext *pwcxt)
void ExecIndexOnlyScanReInitializeDSM(IndexOnlyScanState *node, ParallelContext *pcxt)
void ExecIndexOnlyScanInitializeDSM(IndexOnlyScanState *node, ParallelContext *pcxt)
void ExecIndexScanRetrieveInstrumentation(IndexScanState *node)
void ExecIndexScanEstimate(IndexScanState *node, ParallelContext *pcxt)
void ExecIndexScanReInitializeDSM(IndexScanState *node, ParallelContext *pcxt)
void ExecIndexScanInitializeDSM(IndexScanState *node, ParallelContext *pcxt)
void ExecIndexScanInitializeWorker(IndexScanState *node, ParallelWorkerContext *pwcxt)
void ExecMemoizeInitializeDSM(MemoizeState *node, ParallelContext *pcxt)
void ExecMemoizeEstimate(MemoizeState *node, ParallelContext *pcxt)
void ExecMemoizeRetrieveInstrumentation(MemoizeState *node)
void ExecMemoizeInitializeWorker(MemoizeState *node, ParallelWorkerContext *pwcxt)
void ExecSeqScanReInitializeDSM(SeqScanState *node, ParallelContext *pcxt)
void ExecSeqScanInitializeWorker(SeqScanState *node, ParallelWorkerContext *pwcxt)
void ExecSeqScanInitializeDSM(SeqScanState *node, ParallelContext *pcxt)
void ExecSeqScanEstimate(SeqScanState *node, ParallelContext *pcxt)
void ExecSortInitializeWorker(SortState *node, ParallelWorkerContext *pwcxt)
Definition nodeSort.c:462
void ExecSortEstimate(SortState *node, ParallelContext *pcxt)
Definition nodeSort.c:416
void ExecSortInitializeDSM(SortState *node, ParallelContext *pcxt)
Definition nodeSort.c:437
void ExecSortRetrieveInstrumentation(SortState *node)
Definition nodeSort.c:476
void ExecSetParamPlanMulti(const Bitmapset *params, ExprContext *econtext)
void ExecTidRangeScanEstimate(TidRangeScanState *node, ParallelContext *pcxt)
void ExecTidRangeScanInitializeWorker(TidRangeScanState *node, ParallelWorkerContext *pwcxt)
void ExecTidRangeScanInitializeDSM(TidRangeScanState *node, ParallelContext *pcxt)
void ExecTidRangeScanReInitializeDSM(TidRangeScanState *node, ParallelContext *pcxt)
#define copyObject(obj)
Definition nodes.h:232
#define nodeTag(nodeptr)
Definition nodes.h:139
@ CMD_SELECT
Definition nodes.h:275
#define makeNode(_type_)
Definition nodes.h:161
char * nodeToString(const void *obj)
Definition outfuncs.c:802
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition palloc.h:124
Size EstimateParamListSpace(ParamListInfo paramLI)
Definition params.c:167
void SerializeParamList(ParamListInfo paramLI, char **start_address)
Definition params.c:228
ParamListInfo RestoreParamList(char **start_address)
Definition params.c:290
#define lfirst(lc)
Definition pg_list.h:172
#define lfirst_node(type, lc)
Definition pg_list.h:176
#define NIL
Definition pg_list.h:68
static Oid list_nth_oid(const List *list, int n)
Definition pg_list.h:321
#define plan(x)
Definition pg_regress.c:161
@ PLAN_STMT_INTERNAL
Definition plannodes.h:40
const char * debug_query_string
Definition postgres.c:90
uint64_t Datum
Definition postgres.h:70
unsigned int Oid
void FreeQueryDesc(QueryDesc *qdesc)
Definition pquery.c:106
QueryDesc * CreateQueryDesc(PlannedStmt *plannedstmt, const char *sourceText, Snapshot snapshot, Snapshot crosscheck_snapshot, DestReceiver *dest, ParamListInfo params, QueryEnvironment *queryEnv, int instrument_options)
Definition pquery.c:68
e
void * stringToNode(const char *str)
Definition read.c:90
@ ForwardScanDirection
Definition sdir.h:28
void shm_mq_set_sender(shm_mq *mq, PGPROC *proc)
Definition shm_mq.c:225
shm_mq * shm_mq_create(void *address, Size size)
Definition shm_mq.c:178
void shm_mq_set_handle(shm_mq_handle *mqh, BackgroundWorkerHandle *handle)
Definition shm_mq.c:320
void shm_mq_detach(shm_mq_handle *mqh)
Definition shm_mq.c:844
void shm_mq_set_receiver(shm_mq *mq, PGPROC *proc)
Definition shm_mq.c:207
shm_mq_handle * shm_mq_attach(shm_mq *mq, dsm_segment *seg, BackgroundWorkerHandle *handle)
Definition shm_mq.c:291
void * shm_toc_allocate(shm_toc *toc, Size nbytes)
Definition shm_toc.c:88
void shm_toc_insert(shm_toc *toc, uint64 key, void *address)
Definition shm_toc.c:171
void * shm_toc_lookup(shm_toc *toc, uint64 key, bool noError)
Definition shm_toc.c:232
#define shm_toc_estimate_chunk(e, sz)
Definition shm_toc.h:51
#define shm_toc_estimate_keys(e, cnt)
Definition shm_toc.h:53
Size add_size(Size s1, Size s2)
Definition shmem.c:482
Size mul_size(Size s1, Size s2)
Definition shmem.c:497
Snapshot GetActiveSnapshot(void)
Definition snapmgr.c:800
#define InvalidSnapshot
Definition snapshot.h:119
PGPROC * MyProc
Definition proc.c:67
List * es_part_prune_infos
Definition execnodes.h:673
struct dsa_area * es_query_dsa
Definition execnodes.h:755
int es_top_eflags
Definition execnodes.h:722
struct JitContext * es_jit
Definition execnodes.h:767
int es_instrument
Definition execnodes.h:723
PlannedStmt * es_plannedstmt
Definition execnodes.h:672
struct JitInstrumentation * es_jit_worker_instr
Definition execnodes.h:768
ParamExecData * es_param_exec_vals
Definition execnodes.h:708
List * es_range_table
Definition execnodes.h:665
List * es_rteperminfos
Definition execnodes.h:671
Bitmapset * es_unpruned_relids
Definition execnodes.h:676
ParamListInfo es_param_list_info
Definition execnodes.h:707
MemoryContext es_query_cxt
Definition execnodes.h:713
int es_jit_flags
Definition execnodes.h:766
const char * es_sourceText
Definition execnodes.h:680
Snapshot es_snapshot
Definition execnodes.h:663
SharedExecutorInstrumentation * instrumentation
JitInstrumentation instr
Definition jit.h:62
dsm_segment * seg
Definition parallel.h:44
shm_toc_estimator estimator
Definition parallel.h:43
ParallelWorkerInfo * worker
Definition parallel.h:47
shm_toc * toc
Definition parallel.h:46
int nworkers_launched
Definition parallel.h:39
PlanState * planstate
struct SharedJitInstrumentation * jit_instrumentation
BufferUsage * buffer_usage
dsa_pointer param_exec
ParallelContext * pcxt
shm_mq_handle ** tqueue
SharedExecutorInstrumentation * instrumentation
struct TupleQueueReader ** reader
BackgroundWorkerHandle * bgwhandle
Definition parallel.h:29
struct SharedJitInstrumentation * worker_jit_instrument
Definition execnodes.h:1182
Instrumentation * instrument
Definition execnodes.h:1178
Plan * plan
Definition execnodes.h:1168
EState * state
Definition execnodes.h:1170
WorkerInstrumentation * worker_instrument
Definition execnodes.h:1179
bool parallel_aware
Definition plannodes.h:219
bool parallel_safe
Definition plannodes.h:221
int plan_node_id
Definition plannodes.h:233
struct Plan * planTree
Definition plannodes.h:101
bool hasModifyingCTE
Definition plannodes.h:83
List * appendRelations
Definition plannodes.h:127
List * permInfos
Definition plannodes.h:120
bool canSetTag
Definition plannodes.h:86
List * rowMarks
Definition plannodes.h:141
int64 planId
Definition plannodes.h:74
Bitmapset * rewindPlanIDs
Definition plannodes.h:138
int64 queryId
Definition plannodes.h:71
ParseLoc stmt_len
Definition plannodes.h:171
PlannedStmtOrigin planOrigin
Definition plannodes.h:77
bool hasReturning
Definition plannodes.h:80
ParseLoc stmt_location
Definition plannodes.h:169
List * invalItems
Definition plannodes.h:147
bool transientPlan
Definition plannodes.h:89
List * resultRelations
Definition plannodes.h:124
List * subplans
Definition plannodes.h:132
List * relationOids
Definition plannodes.h:144
bool dependsOnRole
Definition plannodes.h:92
Bitmapset * unprunableRelids
Definition plannodes.h:115
CmdType commandType
Definition plannodes.h:68
Node * utilityStmt
Definition plannodes.h:153
List * rtable
Definition plannodes.h:109
List * partPruneInfos
Definition plannodes.h:106
List * paramExecTypes
Definition plannodes.h:150
bool parallelModeNeeded
Definition plannodes.h:95
const char * sourceText
Definition execdesc.h:38
EState * estate
Definition execdesc.h:48
PlannedStmt * plannedstmt
Definition execdesc.h:37
PlanState * planstate
Definition execdesc.h:49
int plan_node_id[FLEXIBLE_ARRAY_MEMBER]
JitInstrumentation jit_instr[FLEXIBLE_ARRAY_MEMBER]
Definition jit.h:54
Instrumentation instrument[FLEXIBLE_ARRAY_MEMBER]
Definition instrument.h:100
DestReceiver * CreateTupleQueueDestReceiver(shm_mq_handle *handle)
Definition tqueue.c:119
TupleQueueReader * CreateTupleQueueReader(shm_mq_handle *handle)
Definition tqueue.c:139
void DestroyTupleQueueReader(TupleQueueReader *reader)
Definition tqueue.c:155

◆ PARALLEL_KEY_BUFFER_USAGE

#define PARALLEL_KEY_BUFFER_USAGE   UINT64CONST(0xE000000000000004)

Definition at line 63 of file execParallel.c.

◆ PARALLEL_KEY_DSA

#define PARALLEL_KEY_DSA   UINT64CONST(0xE000000000000007)

Definition at line 66 of file execParallel.c.

◆ PARALLEL_KEY_EXECUTOR_FIXED

#define PARALLEL_KEY_EXECUTOR_FIXED   UINT64CONST(0xE000000000000001)

Definition at line 60 of file execParallel.c.

◆ PARALLEL_KEY_INSTRUMENTATION

#define PARALLEL_KEY_INSTRUMENTATION   UINT64CONST(0xE000000000000006)

Definition at line 65 of file execParallel.c.

◆ PARALLEL_KEY_JIT_INSTRUMENTATION

#define PARALLEL_KEY_JIT_INSTRUMENTATION   UINT64CONST(0xE000000000000009)

Definition at line 68 of file execParallel.c.

◆ PARALLEL_KEY_PARAMLISTINFO

#define PARALLEL_KEY_PARAMLISTINFO   UINT64CONST(0xE000000000000003)

Definition at line 62 of file execParallel.c.

◆ PARALLEL_KEY_PLANNEDSTMT

#define PARALLEL_KEY_PLANNEDSTMT   UINT64CONST(0xE000000000000002)

Definition at line 61 of file execParallel.c.

◆ PARALLEL_KEY_QUERY_TEXT

#define PARALLEL_KEY_QUERY_TEXT   UINT64CONST(0xE000000000000008)

Definition at line 67 of file execParallel.c.

◆ PARALLEL_KEY_TUPLE_QUEUE

#define PARALLEL_KEY_TUPLE_QUEUE   UINT64CONST(0xE000000000000005)

Definition at line 64 of file execParallel.c.

◆ PARALLEL_KEY_WAL_USAGE

#define PARALLEL_KEY_WAL_USAGE   UINT64CONST(0xE00000000000000A)

Definition at line 69 of file execParallel.c.

◆ PARALLEL_TUPLE_QUEUE_SIZE

#define PARALLEL_TUPLE_QUEUE_SIZE   65536

Definition at line 71 of file execParallel.c.

Typedef Documentation

◆ ExecParallelEstimateContext

◆ ExecParallelInitializeDSMContext

◆ FixedParallelExecutorState

Function Documentation

◆ EstimateParamExecSpace()

static Size EstimateParamExecSpace ( EState estate,
Bitmapset params 
)
static

Definition at line 327 of file execParallel.c.

328{
329 int paramid;
330 Size sz = sizeof(int);
331
332 paramid = -1;
333 while ((paramid = bms_next_member(params, paramid)) >= 0)
334 {
335 Oid typeOid;
336 int16 typLen;
337 bool typByVal;
339
340 prm = &(estate->es_param_exec_vals[paramid]);
341 typeOid = list_nth_oid(estate->es_plannedstmt->paramExecTypes,
342 paramid);
343
344 sz = add_size(sz, sizeof(int)); /* space for paramid */
345
346 /* space for datum/isnull */
347 if (OidIsValid(typeOid))
348 get_typlenbyval(typeOid, &typLen, &typByVal);
349 else
350 {
351 /* If no type OID, assume by-value, like copyParamList does. */
352 typLen = sizeof(Datum);
353 typByVal = true;
354 }
355 sz = add_size(sz,
356 datumEstimateSpace(prm->value, prm->isnull,
357 typByVal, typLen));
358 }
359 return sz;
360}

References add_size(), bms_next_member(), datumEstimateSpace(), EState::es_param_exec_vals, EState::es_plannedstmt, fb(), get_typlenbyval(), list_nth_oid(), OidIsValid, and PlannedStmt::paramExecTypes.

Referenced by SerializeParamExecParams().

◆ ExecInitParallelPlan()

ParallelExecutorInfo * ExecInitParallelPlan ( PlanState planstate,
EState estate,
Bitmapset sendParams,
int  nworkers,
int64  tuples_needed 
)

Definition at line 612 of file execParallel.c.

615{
617 ParallelContext *pcxt;
621 char *pstmt_data;
622 char *pstmt_space;
626 SharedExecutorInstrumentation *instrumentation = NULL;
627 SharedJitInstrumentation *jit_instrumentation = NULL;
628 int pstmt_len;
630 int instrumentation_len = 0;
632 int instrument_offset = 0;
634 char *query_string;
635 int query_len;
636
637 /*
638 * Force any initplan outputs that we're going to pass to workers to be
639 * evaluated, if they weren't already.
640 *
641 * For simplicity, we use the EState's per-output-tuple ExprContext here.
642 * That risks intra-query memory leakage, since we might pass through here
643 * many times before that ExprContext gets reset; but ExecSetParamPlan
644 * doesn't normally leak any memory in the context (see its comments), so
645 * it doesn't seem worth complicating this function's API to pass it a
646 * shorter-lived ExprContext. This might need to change someday.
647 */
649
650 /* Allocate object for return value. */
652 pei->finished = false;
653 pei->planstate = planstate;
654
655 /* Fix up and serialize plan to be sent to workers. */
656 pstmt_data = ExecSerializePlan(planstate->plan, estate);
657
658 /* Create a parallel context. */
659 pcxt = CreateParallelContext("postgres", "ParallelQueryMain", nworkers);
660 pei->pcxt = pcxt;
661
662 /*
663 * Before telling the parallel context to create a dynamic shared memory
664 * segment, we need to figure out how big it should be. Estimate space
665 * for the various things we need to store.
666 */
667
668 /* Estimate space for fixed-size state. */
672
673 /* Estimate space for query text. */
674 query_len = strlen(estate->es_sourceText);
675 shm_toc_estimate_chunk(&pcxt->estimator, query_len + 1);
677
678 /* Estimate space for serialized PlannedStmt. */
682
683 /* Estimate space for serialized ParamListInfo. */
687
688 /*
689 * Estimate space for BufferUsage.
690 *
691 * If EXPLAIN is not in use and there are no extensions loaded that care,
692 * we could skip this. But we have no way of knowing whether anyone's
693 * looking at pgBufferUsage, so do it unconditionally.
694 */
696 mul_size(sizeof(BufferUsage), pcxt->nworkers));
698
699 /*
700 * Same thing for WalUsage.
701 */
703 mul_size(sizeof(WalUsage), pcxt->nworkers));
705
706 /* Estimate space for tuple queues. */
710
711 /*
712 * Give parallel-aware nodes a chance to add to the estimates, and get a
713 * count of how many PlanState nodes there are.
714 */
715 e.pcxt = pcxt;
716 e.nnodes = 0;
717 ExecParallelEstimate(planstate, &e);
718
719 /* Estimate space for instrumentation, if required. */
720 if (estate->es_instrument)
721 {
724 sizeof(int) * e.nnodes;
726 instrument_offset = instrumentation_len;
729 mul_size(e.nnodes, nworkers));
732
733 /* Estimate space for JIT instrumentation, if required. */
734 if (estate->es_jit_flags != PGJIT_NONE)
735 {
738 sizeof(JitInstrumentation) * nworkers;
741 }
742 }
743
744 /* Estimate space for DSA area. */
747
748 /*
749 * InitializeParallelDSM() passes the active snapshot to the parallel
750 * worker, which uses it to set es_snapshot. Make sure we don't set
751 * es_snapshot differently in the child.
752 */
754
755 /* Everyone's had a chance to ask for space, so now create the DSM. */
757
758 /*
759 * OK, now we have a dynamic shared memory segment, and it should be big
760 * enough to store all of the data we estimated we would want to put into
761 * it, plus whatever general stuff (not specifically executor-related) the
762 * ParallelContext itself needs to store there. None of the space we
763 * asked for has been allocated or initialized yet, though, so do that.
764 */
765
766 /* Store fixed-size state. */
768 fpes->tuples_needed = tuples_needed;
769 fpes->param_exec = InvalidDsaPointer;
770 fpes->eflags = estate->es_top_eflags;
771 fpes->jit_flags = estate->es_jit_flags;
773
774 /* Store query string */
775 query_string = shm_toc_allocate(pcxt->toc, query_len + 1);
776 memcpy(query_string, estate->es_sourceText, query_len + 1);
777 shm_toc_insert(pcxt->toc, PARALLEL_KEY_QUERY_TEXT, query_string);
778
779 /* Store serialized PlannedStmt. */
783
784 /* Store serialized ParamListInfo. */
788
789 /* Allocate space for each worker's BufferUsage; no need to initialize. */
791 mul_size(sizeof(BufferUsage), pcxt->nworkers));
794
795 /* Same for WalUsage. */
797 mul_size(sizeof(WalUsage), pcxt->nworkers));
800
801 /* Set up the tuple queues that the workers will write into. */
802 pei->tqueue = ExecParallelSetupTupleQueues(pcxt, false);
803
804 /* We don't need the TupleQueueReaders yet, though. */
805 pei->reader = NULL;
806
807 /*
808 * If instrumentation options were supplied, allocate space for the data.
809 * It only gets partially initialized here; the rest happens during
810 * ExecParallelInitializeDSM.
811 */
812 if (estate->es_instrument)
813 {
814 Instrumentation *instrument;
815 int i;
816
817 instrumentation = shm_toc_allocate(pcxt->toc, instrumentation_len);
818 instrumentation->instrument_options = estate->es_instrument;
819 instrumentation->instrument_offset = instrument_offset;
820 instrumentation->num_workers = nworkers;
821 instrumentation->num_plan_nodes = e.nnodes;
822 instrument = GetInstrumentationArray(instrumentation);
823 for (i = 0; i < nworkers * e.nnodes; ++i)
824 InstrInit(&instrument[i], estate->es_instrument);
826 instrumentation);
827 pei->instrumentation = instrumentation;
828
829 if (estate->es_jit_flags != PGJIT_NONE)
830 {
831 jit_instrumentation = shm_toc_allocate(pcxt->toc,
833 jit_instrumentation->num_workers = nworkers;
834 memset(jit_instrumentation->jit_instr, 0,
835 sizeof(JitInstrumentation) * nworkers);
837 jit_instrumentation);
838 pei->jit_instrumentation = jit_instrumentation;
839 }
840 }
841
842 /*
843 * Create a DSA area that can be used by the leader and all workers.
844 * (However, if we failed to create a DSM and are using private memory
845 * instead, then skip this.)
846 */
847 if (pcxt->seg != NULL)
848 {
849 char *area_space;
850
855 pcxt->seg);
856
857 /*
858 * Serialize parameters, if any, using DSA storage. We don't dare use
859 * the main parallel query DSM for this because we might relaunch
860 * workers after the values have changed (and thus the amount of
861 * storage required has changed).
862 */
864 {
866 pei->area);
867 fpes->param_exec = pei->param_exec;
868 }
869 }
870
871 /*
872 * Give parallel-aware nodes a chance to initialize their shared data.
873 * This also initializes the elements of instrumentation->ps_instrument,
874 * if it exists.
875 */
876 d.pcxt = pcxt;
877 d.instrumentation = instrumentation;
878 d.nnodes = 0;
879
880 /* Install our DSA area while initializing the plan. */
881 estate->es_query_dsa = pei->area;
882 ExecParallelInitializeDSM(planstate, &d);
883 estate->es_query_dsa = NULL;
884
885 /*
886 * Make sure that the world hasn't shifted under our feet. This could
887 * probably just be an Assert(), but let's be conservative for now.
888 */
889 if (e.nnodes != d.nnodes)
890 elog(ERROR, "inconsistent count of PlanState nodes");
891
892 /* OK, we're ready to rock and roll. */
893 return pei;
894}

References ParallelExecutorInfo::area, Assert, bms_is_empty, ParallelExecutorInfo::buffer_usage, CreateParallelContext(), dsa_create_in_place, dsa_minimum_size(), elog, ERROR, EState::es_instrument, EState::es_jit_flags, EState::es_param_list_info, EState::es_query_dsa, EState::es_snapshot, EState::es_sourceText, EState::es_top_eflags, EstimateParamListSpace(), ParallelContext::estimator, ExecParallelEstimate(), ExecParallelInitializeDSM(), ExecParallelSetupTupleQueues(), ExecSerializePlan(), ExecSetParamPlanMulti(), fb(), ParallelExecutorInfo::finished, GetActiveSnapshot(), GetInstrumentationArray, GetPerTupleExprContext, i, InitializeParallelDSM(), InstrInit(), SharedExecutorInstrumentation::instrument_offset, SharedExecutorInstrumentation::instrument_options, ExecParallelInitializeDSMContext::instrumentation, ParallelExecutorInfo::instrumentation, InvalidDsaPointer, SharedJitInstrumentation::jit_instr, ParallelExecutorInfo::jit_instrumentation, MAXALIGN, mul_size(), ExecParallelInitializeDSMContext::nnodes, SharedExecutorInstrumentation::num_plan_nodes, SharedExecutorInstrumentation::num_workers, SharedJitInstrumentation::num_workers, ParallelContext::nworkers, palloc0_object, PARALLEL_KEY_BUFFER_USAGE, PARALLEL_KEY_DSA, PARALLEL_KEY_EXECUTOR_FIXED, PARALLEL_KEY_INSTRUMENTATION, PARALLEL_KEY_JIT_INSTRUMENTATION, PARALLEL_KEY_PARAMLISTINFO, PARALLEL_KEY_PLANNEDSTMT, PARALLEL_KEY_QUERY_TEXT, PARALLEL_KEY_WAL_USAGE, PARALLEL_TUPLE_QUEUE_SIZE, ParallelExecutorInfo::param_exec, ExecParallelInitializeDSMContext::pcxt, ParallelExecutorInfo::pcxt, PGJIT_NONE, PlanState::plan, ParallelExecutorInfo::planstate, ParallelExecutorInfo::reader, ParallelContext::seg, SerializeParamExecParams(), SerializeParamList(), shm_toc_allocate(), shm_toc_estimate_chunk, shm_toc_estimate_keys, shm_toc_insert(), ParallelContext::toc, ParallelExecutorInfo::tqueue, and ParallelExecutorInfo::wal_usage.

Referenced by ExecGather(), and ExecGatherMerge().

◆ ExecParallelCleanup()

void ExecParallelCleanup ( ParallelExecutorInfo pei)

Definition at line 1227 of file execParallel.c.

1228{
1229 /* Accumulate instrumentation, if any. */
1230 if (pei->instrumentation)
1232 pei->instrumentation);
1233
1234 /* Accumulate JIT instrumentation, if any. */
1235 if (pei->jit_instrumentation)
1237 pei->jit_instrumentation);
1238
1239 /* Free any serialized parameters. */
1240 if (DsaPointerIsValid(pei->param_exec))
1241 {
1242 dsa_free(pei->area, pei->param_exec);
1244 }
1245 if (pei->area != NULL)
1246 {
1247 dsa_detach(pei->area);
1248 pei->area = NULL;
1249 }
1250 if (pei->pcxt != NULL)
1251 {
1253 pei->pcxt = NULL;
1254 }
1255 pfree(pei);
1256}

References ParallelExecutorInfo::area, DestroyParallelContext(), dsa_detach(), dsa_free(), DsaPointerIsValid, ExecParallelRetrieveInstrumentation(), ExecParallelRetrieveJitInstrumentation(), fb(), ParallelExecutorInfo::instrumentation, InvalidDsaPointer, ParallelExecutorInfo::jit_instrumentation, ParallelExecutorInfo::param_exec, ParallelExecutorInfo::pcxt, pfree(), and ParallelExecutorInfo::planstate.

Referenced by ExecShutdownGather(), and ExecShutdownGatherMerge().

◆ ExecParallelCreateReaders()

void ExecParallelCreateReaders ( ParallelExecutorInfo pei)

Definition at line 903 of file execParallel.c.

904{
905 int nworkers = pei->pcxt->nworkers_launched;
906 int i;
907
908 Assert(pei->reader == NULL);
909
910 if (nworkers > 0)
911 {
912 pei->reader = (TupleQueueReader **)
913 palloc(nworkers * sizeof(TupleQueueReader *));
914
915 for (i = 0; i < nworkers; i++)
916 {
918 pei->pcxt->worker[i].bgwhandle);
919 pei->reader[i] = CreateTupleQueueReader(pei->tqueue[i]);
920 }
921 }
922}

References Assert, ParallelWorkerInfo::bgwhandle, CreateTupleQueueReader(), fb(), i, ParallelContext::nworkers_launched, palloc(), ParallelExecutorInfo::pcxt, ParallelExecutorInfo::reader, shm_mq_set_handle(), ParallelExecutorInfo::tqueue, and ParallelContext::worker.

Referenced by ExecGather(), and ExecGatherMerge().

◆ ExecParallelEstimate()

static bool ExecParallelEstimate ( PlanState planstate,
ExecParallelEstimateContext e 
)
static

Definition at line 236 of file execParallel.c.

237{
238 if (planstate == NULL)
239 return false;
240
241 /* Count this node. */
242 e->nnodes++;
243
244 switch (nodeTag(planstate))
245 {
246 case T_SeqScanState:
247 if (planstate->plan->parallel_aware)
248 ExecSeqScanEstimate((SeqScanState *) planstate,
249 e->pcxt);
250 break;
251 case T_IndexScanState:
252 /* even when not parallel-aware, for EXPLAIN ANALYZE */
254 e->pcxt);
255 break;
257 /* even when not parallel-aware, for EXPLAIN ANALYZE */
259 e->pcxt);
260 break;
262 /* even when not parallel-aware, for EXPLAIN ANALYZE */
264 e->pcxt);
265 break;
267 if (planstate->plan->parallel_aware)
269 e->pcxt);
270 break;
272 if (planstate->plan->parallel_aware)
274 e->pcxt);
275 break;
276 case T_AppendState:
277 if (planstate->plan->parallel_aware)
278 ExecAppendEstimate((AppendState *) planstate,
279 e->pcxt);
280 break;
282 if (planstate->plan->parallel_aware)
284 e->pcxt);
285 break;
287 if (planstate->plan->parallel_aware)
289 e->pcxt);
290 break;
291 case T_HashJoinState:
292 if (planstate->plan->parallel_aware)
294 e->pcxt);
295 break;
296 case T_HashState:
297 /* even when not parallel-aware, for EXPLAIN ANALYZE */
298 ExecHashEstimate((HashState *) planstate, e->pcxt);
299 break;
300 case T_SortState:
301 /* even when not parallel-aware, for EXPLAIN ANALYZE */
302 ExecSortEstimate((SortState *) planstate, e->pcxt);
303 break;
305 /* even when not parallel-aware, for EXPLAIN ANALYZE */
307 break;
308 case T_AggState:
309 /* even when not parallel-aware, for EXPLAIN ANALYZE */
310 ExecAggEstimate((AggState *) planstate, e->pcxt);
311 break;
312 case T_MemoizeState:
313 /* even when not parallel-aware, for EXPLAIN ANALYZE */
314 ExecMemoizeEstimate((MemoizeState *) planstate, e->pcxt);
315 break;
316 default:
317 break;
318 }
319
320 return planstate_tree_walker(planstate, ExecParallelEstimate, e);
321}

References ExecAggEstimate(), ExecAppendEstimate(), ExecBitmapHeapEstimate(), ExecBitmapIndexScanEstimate(), ExecCustomScanEstimate(), ExecForeignScanEstimate(), ExecHashEstimate(), ExecHashJoinEstimate(), ExecIncrementalSortEstimate(), ExecIndexOnlyScanEstimate(), ExecIndexScanEstimate(), ExecMemoizeEstimate(), ExecParallelEstimate(), ExecSeqScanEstimate(), ExecSortEstimate(), ExecTidRangeScanEstimate(), fb(), nodeTag, Plan::parallel_aware, PlanState::plan, and planstate_tree_walker.

Referenced by ExecInitParallelPlan(), and ExecParallelEstimate().

◆ ExecParallelFinish()

void ExecParallelFinish ( ParallelExecutorInfo pei)

Definition at line 1174 of file execParallel.c.

1175{
1176 int nworkers = pei->pcxt->nworkers_launched;
1177 int i;
1178
1179 /* Make this be a no-op if called twice in a row. */
1180 if (pei->finished)
1181 return;
1182
1183 /*
1184 * Detach from tuple queues ASAP, so that any still-active workers will
1185 * notice that no further results are wanted.
1186 */
1187 if (pei->tqueue != NULL)
1188 {
1189 for (i = 0; i < nworkers; i++)
1190 shm_mq_detach(pei->tqueue[i]);
1191 pfree(pei->tqueue);
1192 pei->tqueue = NULL;
1193 }
1194
1195 /*
1196 * While we're waiting for the workers to finish, let's get rid of the
1197 * tuple queue readers. (Any other local cleanup could be done here too.)
1198 */
1199 if (pei->reader != NULL)
1200 {
1201 for (i = 0; i < nworkers; i++)
1203 pfree(pei->reader);
1204 pei->reader = NULL;
1205 }
1206
1207 /* Now wait for the workers to finish. */
1209
1210 /*
1211 * Next, accumulate buffer/WAL usage. (This must wait for the workers to
1212 * finish, or we might get incomplete data.)
1213 */
1214 for (i = 0; i < nworkers; i++)
1216
1217 pei->finished = true;
1218}

References ParallelExecutorInfo::buffer_usage, DestroyTupleQueueReader(), fb(), ParallelExecutorInfo::finished, i, InstrAccumParallelQuery(), ParallelContext::nworkers_launched, ParallelExecutorInfo::pcxt, pfree(), ParallelExecutorInfo::reader, shm_mq_detach(), ParallelExecutorInfo::tqueue, WaitForParallelWorkersToFinish(), and ParallelExecutorInfo::wal_usage.

Referenced by ExecShutdownGatherMergeWorkers(), and ExecShutdownGatherWorkers().

◆ ExecParallelGetQueryDesc()

static QueryDesc * ExecParallelGetQueryDesc ( shm_toc toc,
DestReceiver receiver,
int  instrument_options 
)
static

Definition at line 1279 of file execParallel.c.

1281{
1282 char *pstmtspace;
1283 char *paramspace;
1284 PlannedStmt *pstmt;
1285 ParamListInfo paramLI;
1286 char *queryString;
1287
1288 /* Get the query string from shared memory */
1289 queryString = shm_toc_lookup(toc, PARALLEL_KEY_QUERY_TEXT, false);
1290
1291 /* Reconstruct leader-supplied PlannedStmt. */
1293 pstmt = (PlannedStmt *) stringToNode(pstmtspace);
1294
1295 /* Reconstruct ParamListInfo. */
1297 paramLI = RestoreParamList(&paramspace);
1298
1299 /* Create a QueryDesc for the query. */
1300 return CreateQueryDesc(pstmt,
1301 queryString,
1303 receiver, paramLI, NULL, instrument_options);
1304}

References CreateQueryDesc(), fb(), GetActiveSnapshot(), InvalidSnapshot, PARALLEL_KEY_PARAMLISTINFO, PARALLEL_KEY_PLANNEDSTMT, PARALLEL_KEY_QUERY_TEXT, RestoreParamList(), shm_toc_lookup(), and stringToNode().

Referenced by ParallelQueryMain().

◆ ExecParallelGetReceiver()

◆ ExecParallelInitializeDSM()

static bool ExecParallelInitializeDSM ( PlanState planstate,
ExecParallelInitializeDSMContext d 
)
static

Definition at line 455 of file execParallel.c.

457{
458 if (planstate == NULL)
459 return false;
460
461 /* If instrumentation is enabled, initialize slot for this node. */
462 if (d->instrumentation != NULL)
464 planstate->plan->plan_node_id;
465
466 /* Count this node. */
467 d->nnodes++;
468
469 /*
470 * Call initializers for DSM-using plan nodes.
471 *
472 * Most plan nodes won't do anything here, but plan nodes that allocated
473 * DSM may need to initialize shared state in the DSM before parallel
474 * workers are launched. They can allocate the space they previously
475 * estimated using shm_toc_allocate, and add the keys they previously
476 * estimated using shm_toc_insert, in each case targeting pcxt->toc.
477 */
478 switch (nodeTag(planstate))
479 {
480 case T_SeqScanState:
481 if (planstate->plan->parallel_aware)
483 d->pcxt);
484 break;
485 case T_IndexScanState:
486 /* even when not parallel-aware, for EXPLAIN ANALYZE */
488 break;
490 /* even when not parallel-aware, for EXPLAIN ANALYZE */
492 d->pcxt);
493 break;
495 /* even when not parallel-aware, for EXPLAIN ANALYZE */
497 break;
499 if (planstate->plan->parallel_aware)
501 d->pcxt);
502 break;
504 if (planstate->plan->parallel_aware)
506 d->pcxt);
507 break;
508 case T_AppendState:
509 if (planstate->plan->parallel_aware)
511 d->pcxt);
512 break;
514 if (planstate->plan->parallel_aware)
516 d->pcxt);
517 break;
519 if (planstate->plan->parallel_aware)
521 d->pcxt);
522 break;
523 case T_HashJoinState:
524 if (planstate->plan->parallel_aware)
526 d->pcxt);
527 break;
528 case T_HashState:
529 /* even when not parallel-aware, for EXPLAIN ANALYZE */
530 ExecHashInitializeDSM((HashState *) planstate, d->pcxt);
531 break;
532 case T_SortState:
533 /* even when not parallel-aware, for EXPLAIN ANALYZE */
534 ExecSortInitializeDSM((SortState *) planstate, d->pcxt);
535 break;
537 /* even when not parallel-aware, for EXPLAIN ANALYZE */
539 break;
540 case T_AggState:
541 /* even when not parallel-aware, for EXPLAIN ANALYZE */
542 ExecAggInitializeDSM((AggState *) planstate, d->pcxt);
543 break;
544 case T_MemoizeState:
545 /* even when not parallel-aware, for EXPLAIN ANALYZE */
546 ExecMemoizeInitializeDSM((MemoizeState *) planstate, d->pcxt);
547 break;
548 default:
549 break;
550 }
551
553}

References ExecAggInitializeDSM(), ExecAppendInitializeDSM(), ExecBitmapHeapInitializeDSM(), ExecBitmapIndexScanInitializeDSM(), ExecCustomScanInitializeDSM(), ExecForeignScanInitializeDSM(), ExecHashInitializeDSM(), ExecHashJoinInitializeDSM(), ExecIncrementalSortInitializeDSM(), ExecIndexOnlyScanInitializeDSM(), ExecIndexScanInitializeDSM(), ExecMemoizeInitializeDSM(), ExecParallelInitializeDSM(), ExecSeqScanInitializeDSM(), ExecSortInitializeDSM(), ExecTidRangeScanInitializeDSM(), fb(), ExecParallelInitializeDSMContext::instrumentation, ExecParallelInitializeDSMContext::nnodes, nodeTag, Plan::parallel_aware, ExecParallelInitializeDSMContext::pcxt, PlanState::plan, SharedExecutorInstrumentation::plan_node_id, Plan::plan_node_id, and planstate_tree_walker.

Referenced by ExecInitParallelPlan(), and ExecParallelInitializeDSM().

◆ ExecParallelInitializeWorker()

static bool ExecParallelInitializeWorker ( PlanState planstate,
ParallelWorkerContext pwcxt 
)
static

Definition at line 1352 of file execParallel.c.

1353{
1354 if (planstate == NULL)
1355 return false;
1356
1357 switch (nodeTag(planstate))
1358 {
1359 case T_SeqScanState:
1360 if (planstate->plan->parallel_aware)
1362 break;
1363 case T_IndexScanState:
1364 /* even when not parallel-aware, for EXPLAIN ANALYZE */
1366 break;
1368 /* even when not parallel-aware, for EXPLAIN ANALYZE */
1370 pwcxt);
1371 break;
1373 /* even when not parallel-aware, for EXPLAIN ANALYZE */
1375 pwcxt);
1376 break;
1377 case T_ForeignScanState:
1378 if (planstate->plan->parallel_aware)
1380 pwcxt);
1381 break;
1383 if (planstate->plan->parallel_aware)
1385 pwcxt);
1386 break;
1387 case T_AppendState:
1388 if (planstate->plan->parallel_aware)
1390 break;
1391 case T_CustomScanState:
1392 if (planstate->plan->parallel_aware)
1394 pwcxt);
1395 break;
1397 if (planstate->plan->parallel_aware)
1399 pwcxt);
1400 break;
1401 case T_HashJoinState:
1402 if (planstate->plan->parallel_aware)
1404 pwcxt);
1405 break;
1406 case T_HashState:
1407 /* even when not parallel-aware, for EXPLAIN ANALYZE */
1409 break;
1410 case T_SortState:
1411 /* even when not parallel-aware, for EXPLAIN ANALYZE */
1413 break;
1415 /* even when not parallel-aware, for EXPLAIN ANALYZE */
1417 pwcxt);
1418 break;
1419 case T_AggState:
1420 /* even when not parallel-aware, for EXPLAIN ANALYZE */
1421 ExecAggInitializeWorker((AggState *) planstate, pwcxt);
1422 break;
1423 case T_MemoizeState:
1424 /* even when not parallel-aware, for EXPLAIN ANALYZE */
1426 break;
1427 default:
1428 break;
1429 }
1430
1432 pwcxt);
1433}

References ExecAggInitializeWorker(), ExecAppendInitializeWorker(), ExecBitmapHeapInitializeWorker(), ExecBitmapIndexScanInitializeWorker(), ExecCustomScanInitializeWorker(), ExecForeignScanInitializeWorker(), ExecHashInitializeWorker(), ExecHashJoinInitializeWorker(), ExecIncrementalSortInitializeWorker(), ExecIndexOnlyScanInitializeWorker(), ExecIndexScanInitializeWorker(), ExecMemoizeInitializeWorker(), ExecParallelInitializeWorker(), ExecSeqScanInitializeWorker(), ExecSortInitializeWorker(), ExecTidRangeScanInitializeWorker(), fb(), nodeTag, Plan::parallel_aware, PlanState::plan, and planstate_tree_walker.

Referenced by ExecParallelInitializeWorker(), and ParallelQueryMain().

◆ ExecParallelReinitialize()

void ExecParallelReinitialize ( PlanState planstate,
ParallelExecutorInfo pei,
Bitmapset sendParams 
)

Definition at line 929 of file execParallel.c.

932{
933 EState *estate = planstate->state;
935
936 /* Old workers must already be shut down */
937 Assert(pei->finished);
938
939 /*
940 * Force any initplan outputs that we're going to pass to workers to be
941 * evaluated, if they weren't already (see comments in
942 * ExecInitParallelPlan).
943 */
945
947 pei->tqueue = ExecParallelSetupTupleQueues(pei->pcxt, true);
948 pei->reader = NULL;
949 pei->finished = false;
950
952
953 /* Free any serialized parameters from the last round. */
954 if (DsaPointerIsValid(fpes->param_exec))
955 {
956 dsa_free(pei->area, fpes->param_exec);
957 fpes->param_exec = InvalidDsaPointer;
958 }
959
960 /* Serialize current parameter values if required. */
962 {
964 pei->area);
965 fpes->param_exec = pei->param_exec;
966 }
967
968 /* Traverse plan tree and let each child node reset associated state. */
969 estate->es_query_dsa = pei->area;
970 ExecParallelReInitializeDSM(planstate, pei->pcxt);
971 estate->es_query_dsa = NULL;
972}

References ParallelExecutorInfo::area, Assert, bms_is_empty, dsa_free(), DsaPointerIsValid, EState::es_query_dsa, ExecParallelReInitializeDSM(), ExecParallelSetupTupleQueues(), ExecSetParamPlanMulti(), fb(), ParallelExecutorInfo::finished, GetPerTupleExprContext, InvalidDsaPointer, PARALLEL_KEY_EXECUTOR_FIXED, ParallelExecutorInfo::param_exec, ParallelExecutorInfo::pcxt, ParallelExecutorInfo::reader, ReinitializeParallelDSM(), SerializeParamExecParams(), shm_toc_lookup(), PlanState::state, ParallelContext::toc, and ParallelExecutorInfo::tqueue.

Referenced by ExecGather(), and ExecGatherMerge().

◆ ExecParallelReInitializeDSM()

static bool ExecParallelReInitializeDSM ( PlanState planstate,
ParallelContext pcxt 
)
static

Definition at line 978 of file execParallel.c.

980{
981 if (planstate == NULL)
982 return false;
983
984 /*
985 * Call reinitializers for DSM-using plan nodes.
986 */
987 switch (nodeTag(planstate))
988 {
989 case T_SeqScanState:
990 if (planstate->plan->parallel_aware)
992 pcxt);
993 break;
994 case T_IndexScanState:
995 if (planstate->plan->parallel_aware)
997 pcxt);
998 break;
1000 if (planstate->plan->parallel_aware)
1002 pcxt);
1003 break;
1004 case T_ForeignScanState:
1005 if (planstate->plan->parallel_aware)
1007 pcxt);
1008 break;
1010 if (planstate->plan->parallel_aware)
1012 pcxt);
1013 break;
1014 case T_AppendState:
1015 if (planstate->plan->parallel_aware)
1016 ExecAppendReInitializeDSM((AppendState *) planstate, pcxt);
1017 break;
1018 case T_CustomScanState:
1019 if (planstate->plan->parallel_aware)
1021 pcxt);
1022 break;
1024 if (planstate->plan->parallel_aware)
1026 pcxt);
1027 break;
1028 case T_HashJoinState:
1029 if (planstate->plan->parallel_aware)
1031 pcxt);
1032 break;
1034 case T_HashState:
1035 case T_SortState:
1037 case T_MemoizeState:
1038 /* these nodes have DSM state, but no reinitialization is required */
1039 break;
1040
1041 default:
1042 break;
1043 }
1044
1045 return planstate_tree_walker(planstate, ExecParallelReInitializeDSM, pcxt);
1046}

References ExecAppendReInitializeDSM(), ExecBitmapHeapReInitializeDSM(), ExecCustomScanReInitializeDSM(), ExecForeignScanReInitializeDSM(), ExecHashJoinReInitializeDSM(), ExecIndexOnlyScanReInitializeDSM(), ExecIndexScanReInitializeDSM(), ExecParallelReInitializeDSM(), ExecSeqScanReInitializeDSM(), ExecTidRangeScanReInitializeDSM(), fb(), nodeTag, Plan::parallel_aware, PlanState::plan, and planstate_tree_walker.

Referenced by ExecParallelReinitialize(), and ExecParallelReInitializeDSM().

◆ ExecParallelReportInstrumentation()

static bool ExecParallelReportInstrumentation ( PlanState planstate,
SharedExecutorInstrumentation instrumentation 
)
static

Definition at line 1311 of file execParallel.c.

1313{
1314 int i;
1315 int plan_node_id = planstate->plan->plan_node_id;
1316 Instrumentation *instrument;
1317
1318 InstrEndLoop(planstate->instrument);
1319
1320 /*
1321 * If we shuffled the plan_node_id values in ps_instrument into sorted
1322 * order, we could use binary search here. This might matter someday if
1323 * we're pushing down sufficiently large plan trees. For now, do it the
1324 * slow, dumb way.
1325 */
1326 for (i = 0; i < instrumentation->num_plan_nodes; ++i)
1327 if (instrumentation->plan_node_id[i] == plan_node_id)
1328 break;
1329 if (i >= instrumentation->num_plan_nodes)
1330 elog(ERROR, "plan node %d not found", plan_node_id);
1331
1332 /*
1333 * Add our statistics to the per-node, per-worker totals. It's possible
1334 * that this could happen more than once if we relaunched workers.
1335 */
1336 instrument = GetInstrumentationArray(instrumentation);
1337 instrument += i * instrumentation->num_workers;
1340 InstrAggNode(&instrument[ParallelWorkerNumber], planstate->instrument);
1341
1343 instrumentation);
1344}

References Assert, elog, ERROR, ExecParallelReportInstrumentation(), fb(), GetInstrumentationArray, i, InstrAggNode(), InstrEndLoop(), PlanState::instrument, IsParallelWorker, SharedExecutorInstrumentation::num_plan_nodes, SharedExecutorInstrumentation::num_workers, ParallelWorkerNumber, PlanState::plan, SharedExecutorInstrumentation::plan_node_id, Plan::plan_node_id, and planstate_tree_walker.

Referenced by ExecParallelReportInstrumentation(), and ParallelQueryMain().

◆ ExecParallelRetrieveInstrumentation()

static bool ExecParallelRetrieveInstrumentation ( PlanState planstate,
SharedExecutorInstrumentation instrumentation 
)
static

Definition at line 1053 of file execParallel.c.

1055{
1056 Instrumentation *instrument;
1057 int i;
1058 int n;
1059 int ibytes;
1060 int plan_node_id = planstate->plan->plan_node_id;
1061 MemoryContext oldcontext;
1062
1063 /* Find the instrumentation for this node. */
1064 for (i = 0; i < instrumentation->num_plan_nodes; ++i)
1065 if (instrumentation->plan_node_id[i] == plan_node_id)
1066 break;
1067 if (i >= instrumentation->num_plan_nodes)
1068 elog(ERROR, "plan node %d not found", plan_node_id);
1069
1070 /* Accumulate the statistics from all workers. */
1071 instrument = GetInstrumentationArray(instrumentation);
1072 instrument += i * instrumentation->num_workers;
1073 for (n = 0; n < instrumentation->num_workers; ++n)
1074 InstrAggNode(planstate->instrument, &instrument[n]);
1075
1076 /*
1077 * Also store the per-worker detail.
1078 *
1079 * Worker instrumentation should be allocated in the same context as the
1080 * regular instrumentation information, which is the per-query context.
1081 * Switch into per-query memory context.
1082 */
1083 oldcontext = MemoryContextSwitchTo(planstate->state->es_query_cxt);
1084 ibytes = mul_size(instrumentation->num_workers, sizeof(Instrumentation));
1085 planstate->worker_instrument =
1087 MemoryContextSwitchTo(oldcontext);
1088
1089 planstate->worker_instrument->num_workers = instrumentation->num_workers;
1090 memcpy(&planstate->worker_instrument->instrument, instrument, ibytes);
1091
1092 /* Perform any node-type-specific work that needs to be done. */
1093 switch (nodeTag(planstate))
1094 {
1095 case T_IndexScanState:
1097 break;
1100 break;
1103 break;
1104 case T_SortState:
1106 break;
1109 break;
1110 case T_HashState:
1112 break;
1113 case T_AggState:
1115 break;
1116 case T_MemoizeState:
1118 break;
1121 break;
1122 default:
1123 break;
1124 }
1125
1127 instrumentation);
1128}

References elog, ERROR, EState::es_query_cxt, ExecAggRetrieveInstrumentation(), ExecBitmapHeapRetrieveInstrumentation(), ExecBitmapIndexScanRetrieveInstrumentation(), ExecHashRetrieveInstrumentation(), ExecIncrementalSortRetrieveInstrumentation(), ExecIndexOnlyScanRetrieveInstrumentation(), ExecIndexScanRetrieveInstrumentation(), ExecMemoizeRetrieveInstrumentation(), ExecParallelRetrieveInstrumentation(), ExecSortRetrieveInstrumentation(), fb(), GetInstrumentationArray, i, InstrAggNode(), WorkerInstrumentation::instrument, PlanState::instrument, MemoryContextSwitchTo(), mul_size(), nodeTag, SharedExecutorInstrumentation::num_plan_nodes, SharedExecutorInstrumentation::num_workers, WorkerInstrumentation::num_workers, palloc(), PlanState::plan, SharedExecutorInstrumentation::plan_node_id, Plan::plan_node_id, planstate_tree_walker, PlanState::state, and PlanState::worker_instrument.

Referenced by ExecParallelCleanup(), and ExecParallelRetrieveInstrumentation().

◆ ExecParallelRetrieveJitInstrumentation()

static void ExecParallelRetrieveJitInstrumentation ( PlanState planstate,
SharedJitInstrumentation shared_jit 
)
static

Definition at line 1134 of file execParallel.c.

1136{
1138 int ibytes;
1139
1140 int n;
1141
1142 /*
1143 * Accumulate worker JIT instrumentation into the combined JIT
1144 * instrumentation, allocating it if required.
1145 */
1146 if (!planstate->state->es_jit_worker_instr)
1147 planstate->state->es_jit_worker_instr =
1149 combined = planstate->state->es_jit_worker_instr;
1150
1151 /* Accumulate all the workers' instrumentations. */
1152 for (n = 0; n < shared_jit->num_workers; ++n)
1153 InstrJitAgg(combined, &shared_jit->jit_instr[n]);
1154
1155 /*
1156 * Store the per-worker detail.
1157 *
1158 * Similar to ExecParallelRetrieveInstrumentation(), allocate the
1159 * instrumentation in per-query context.
1160 */
1162 + mul_size(shared_jit->num_workers, sizeof(JitInstrumentation));
1163 planstate->worker_jit_instrument =
1165
1167}

References EState::es_jit_worker_instr, EState::es_query_cxt, fb(), InstrJitAgg(), MemoryContextAlloc(), MemoryContextAllocZero(), mul_size(), PlanState::state, and PlanState::worker_jit_instrument.

Referenced by ExecParallelCleanup().

◆ ExecParallelSetupTupleQueues()

static shm_mq_handle ** ExecParallelSetupTupleQueues ( ParallelContext pcxt,
bool  reinitialize 
)
static

Definition at line 560 of file execParallel.c.

561{
563 char *tqueuespace;
564 int i;
565
566 /* Skip this if no workers. */
567 if (pcxt->nworkers == 0)
568 return NULL;
569
570 /* Allocate memory for shared memory queue handles. */
572 palloc(pcxt->nworkers * sizeof(shm_mq_handle *));
573
574 /*
575 * If not reinitializing, allocate space from the DSM for the queues;
576 * otherwise, find the already allocated space.
577 */
578 if (!reinitialize)
580 shm_toc_allocate(pcxt->toc,
582 pcxt->nworkers));
583 else
585
586 /* Create the queues, and become the receiver for each. */
587 for (i = 0; i < pcxt->nworkers; ++i)
588 {
589 shm_mq *mq;
590
594
596 responseq[i] = shm_mq_attach(mq, pcxt->seg, NULL);
597 }
598
599 /* Add array of queues to shm_toc, so others can find it. */
600 if (!reinitialize)
602
603 /* Return array of handles. */
604 return responseq;
605}

References fb(), i, mul_size(), MyProc, ParallelContext::nworkers, palloc(), PARALLEL_KEY_TUPLE_QUEUE, PARALLEL_TUPLE_QUEUE_SIZE, ParallelContext::seg, shm_mq_attach(), shm_mq_create(), shm_mq_set_receiver(), shm_toc_allocate(), shm_toc_insert(), shm_toc_lookup(), and ParallelContext::toc.

Referenced by ExecInitParallelPlan(), and ExecParallelReinitialize().

◆ ExecSerializePlan()

static char * ExecSerializePlan ( Plan plan,
EState estate 
)
static

Definition at line 148 of file execParallel.c.

149{
150 PlannedStmt *pstmt;
151 ListCell *lc;
152
153 /* We can't scribble on the original plan, so make a copy. */
155
156 /*
157 * The worker will start its own copy of the executor, and that copy will
158 * insert a junk filter if the toplevel node has any resjunk entries. We
159 * don't want that to happen, because while resjunk columns shouldn't be
160 * sent back to the user, here the tuples are coming back to another
161 * backend which may very well need them. So mutate the target list
162 * accordingly. This is sort of a hack; there might be better ways to do
163 * this...
164 */
165 foreach(lc, plan->targetlist)
166 {
168
169 tle->resjunk = false;
170 }
171
172 /*
173 * Create a dummy PlannedStmt. Most of the fields don't need to be valid
174 * for our purposes, but the worker will need at least a minimal
175 * PlannedStmt to start the executor.
176 */
177 pstmt = makeNode(PlannedStmt);
178 pstmt->commandType = CMD_SELECT;
180 pstmt->planId = pgstat_get_my_plan_id();
181 pstmt->hasReturning = false;
182 pstmt->hasModifyingCTE = false;
183 pstmt->canSetTag = true;
184 pstmt->transientPlan = false;
185 pstmt->dependsOnRole = false;
186 pstmt->parallelModeNeeded = false;
187 pstmt->planTree = plan;
188 pstmt->partPruneInfos = estate->es_part_prune_infos;
189 pstmt->rtable = estate->es_range_table;
190 pstmt->unprunableRelids = estate->es_unpruned_relids;
191 pstmt->permInfos = estate->es_rteperminfos;
192 pstmt->resultRelations = NIL;
193 pstmt->appendRelations = NIL;
195
196 /*
197 * Transfer only parallel-safe subplans, leaving a NULL "hole" in the list
198 * for unsafe ones (so that the list indexes of the safe ones are
199 * preserved). This positively ensures that the worker won't try to run,
200 * or even do ExecInitNode on, an unsafe subplan. That's important to
201 * protect, eg, non-parallel-aware FDWs from getting into trouble.
202 */
203 pstmt->subplans = NIL;
204 foreach(lc, estate->es_plannedstmt->subplans)
205 {
206 Plan *subplan = (Plan *) lfirst(lc);
207
208 if (subplan && !subplan->parallel_safe)
209 subplan = NULL;
210 pstmt->subplans = lappend(pstmt->subplans, subplan);
211 }
212
213 pstmt->rewindPlanIDs = NULL;
214 pstmt->rowMarks = NIL;
215 pstmt->relationOids = NIL;
216 pstmt->invalItems = NIL; /* workers can't replan anyway... */
218 pstmt->utilityStmt = NULL;
219 pstmt->stmt_location = -1;
220 pstmt->stmt_len = -1;
221
222 /* Return serialized copy of our dummy PlannedStmt. */
223 return nodeToString(pstmt);
224}

References PlannedStmt::appendRelations, PlannedStmt::canSetTag, CMD_SELECT, PlannedStmt::commandType, copyObject, PlannedStmt::dependsOnRole, EState::es_part_prune_infos, EState::es_plannedstmt, EState::es_range_table, EState::es_rteperminfos, EState::es_unpruned_relids, fb(), PlannedStmt::hasModifyingCTE, PlannedStmt::hasReturning, PlannedStmt::invalItems, lappend(), lfirst, lfirst_node, makeNode, NIL, nodeToString(), Plan::parallel_safe, PlannedStmt::parallelModeNeeded, PlannedStmt::paramExecTypes, PlannedStmt::partPruneInfos, PlannedStmt::permInfos, pgstat_get_my_plan_id(), pgstat_get_my_query_id(), plan, PLAN_STMT_INTERNAL, PlannedStmt::planId, PlannedStmt::planOrigin, PlannedStmt::planTree, PlannedStmt::queryId, PlannedStmt::relationOids, PlannedStmt::resultRelations, PlannedStmt::rewindPlanIDs, PlannedStmt::rowMarks, PlannedStmt::rtable, PlannedStmt::stmt_len, PlannedStmt::stmt_location, PlannedStmt::subplans, PlannedStmt::transientPlan, PlannedStmt::unprunableRelids, and PlannedStmt::utilityStmt.

Referenced by ExecInitParallelPlan().

◆ ParallelQueryMain()

void ParallelQueryMain ( dsm_segment seg,
shm_toc toc 
)

Definition at line 1452 of file execParallel.c.

1453{
1455 BufferUsage *buffer_usage;
1456 WalUsage *wal_usage;
1458 QueryDesc *queryDesc;
1459 SharedExecutorInstrumentation *instrumentation;
1460 SharedJitInstrumentation *jit_instrumentation;
1461 int instrument_options = 0;
1462 void *area_space;
1463 dsa_area *area;
1465
1466 /* Get fixed-size state. */
1468
1469 /* Set up DestReceiver, SharedExecutorInstrumentation, and QueryDesc. */
1471 instrumentation = shm_toc_lookup(toc, PARALLEL_KEY_INSTRUMENTATION, true);
1472 if (instrumentation != NULL)
1473 instrument_options = instrumentation->instrument_options;
1474 jit_instrumentation = shm_toc_lookup(toc, PARALLEL_KEY_JIT_INSTRUMENTATION,
1475 true);
1476 queryDesc = ExecParallelGetQueryDesc(toc, receiver, instrument_options);
1477
1478 /* Setting debug_query_string for individual workers */
1479 debug_query_string = queryDesc->sourceText;
1480
1481 /* Report workers' query for monitoring purposes */
1483
1484 /* Attach to the dynamic shared memory area. */
1486 area = dsa_attach_in_place(area_space, seg);
1487
1488 /* Start up the executor */
1489 queryDesc->plannedstmt->jitFlags = fpes->jit_flags;
1490 ExecutorStart(queryDesc, fpes->eflags);
1491
1492 /* Special executor initialization steps for parallel workers */
1493 queryDesc->planstate->state->es_query_dsa = area;
1494 if (DsaPointerIsValid(fpes->param_exec))
1495 {
1496 char *paramexec_space;
1497
1498 paramexec_space = dsa_get_address(area, fpes->param_exec);
1500 }
1501 pwcxt.toc = toc;
1502 pwcxt.seg = seg;
1504
1505 /* Pass down any tuple bound */
1506 ExecSetTupleBound(fpes->tuples_needed, queryDesc->planstate);
1507
1508 /*
1509 * Prepare to track buffer/WAL usage during query execution.
1510 *
1511 * We do this after starting up the executor to match what happens in the
1512 * leader, which also doesn't count buffer accesses and WAL activity that
1513 * occur during executor startup.
1514 */
1516
1517 /*
1518 * Run the plan. If we specified a tuple bound, be careful not to demand
1519 * more tuples than that.
1520 */
1521 ExecutorRun(queryDesc,
1523 fpes->tuples_needed < 0 ? (int64) 0 : fpes->tuples_needed);
1524
1525 /* Shut down the executor */
1526 ExecutorFinish(queryDesc);
1527
1528 /* Report buffer/WAL usage during parallel execution. */
1529 buffer_usage = shm_toc_lookup(toc, PARALLEL_KEY_BUFFER_USAGE, false);
1530 wal_usage = shm_toc_lookup(toc, PARALLEL_KEY_WAL_USAGE, false);
1532 &wal_usage[ParallelWorkerNumber]);
1533
1534 /* Report instrumentation data if any instrumentation options are set. */
1535 if (instrumentation != NULL)
1537 instrumentation);
1538
1539 /* Report JIT instrumentation data if any */
1540 if (queryDesc->estate->es_jit && jit_instrumentation != NULL)
1541 {
1543 jit_instrumentation->jit_instr[ParallelWorkerNumber] =
1544 queryDesc->estate->es_jit->instr;
1545 }
1546
1547 /* Must do this after capturing instrumentation. */
1548 ExecutorEnd(queryDesc);
1549
1550 /* Cleanup. */
1551 dsa_detach(area);
1552 FreeQueryDesc(queryDesc);
1553 receiver->rDestroy(receiver);
1554}

References Assert, debug_query_string, dsa_attach_in_place(), dsa_detach(), dsa_get_address(), DsaPointerIsValid, EState::es_jit, EState::es_query_dsa, QueryDesc::estate, ExecParallelGetQueryDesc(), ExecParallelGetReceiver(), ExecParallelInitializeWorker(), ExecParallelReportInstrumentation(), ExecSetTupleBound(), ExecutorEnd(), ExecutorFinish(), ExecutorRun(), ExecutorStart(), fb(), ForwardScanDirection, FreeQueryDesc(), JitContext::instr, InstrEndParallelQuery(), InstrStartParallelQuery(), SharedExecutorInstrumentation::instrument_options, SharedJitInstrumentation::jit_instr, PlannedStmt::jitFlags, PARALLEL_KEY_BUFFER_USAGE, PARALLEL_KEY_DSA, PARALLEL_KEY_EXECUTOR_FIXED, PARALLEL_KEY_INSTRUMENTATION, PARALLEL_KEY_JIT_INSTRUMENTATION, PARALLEL_KEY_WAL_USAGE, ParallelWorkerNumber, pgstat_report_activity(), QueryDesc::plannedstmt, QueryDesc::planstate, RestoreParamExecParams(), shm_toc_lookup(), QueryDesc::sourceText, PlanState::state, and STATE_RUNNING.

◆ RestoreParamExecParams()

static void RestoreParamExecParams ( char start_address,
EState estate 
)
static

Definition at line 426 of file execParallel.c.

427{
428 int nparams;
429 int i;
430 int paramid;
431
432 memcpy(&nparams, start_address, sizeof(int));
433 start_address += sizeof(int);
434
435 for (i = 0; i < nparams; i++)
436 {
438
439 /* Read paramid */
440 memcpy(&paramid, start_address, sizeof(int));
441 start_address += sizeof(int);
442 prm = &(estate->es_param_exec_vals[paramid]);
443
444 /* Read datum/isnull. */
445 prm->value = datumRestore(&start_address, &prm->isnull);
446 prm->execPlan = NULL;
447 }
448}

References datumRestore(), EState::es_param_exec_vals, fb(), and i.

Referenced by ParallelQueryMain().

◆ SerializeParamExecParams()

static dsa_pointer SerializeParamExecParams ( EState estate,
Bitmapset params,
dsa_area area 
)
static

Definition at line 371 of file execParallel.c.

372{
373 Size size;
374 int nparams;
375 int paramid;
377 dsa_pointer handle;
378 char *start_address;
379
380 /* Allocate enough space for the current parameter values. */
381 size = EstimateParamExecSpace(estate, params);
382 handle = dsa_allocate(area, size);
383 start_address = dsa_get_address(area, handle);
384
385 /* First write the number of parameters as a 4-byte integer. */
386 nparams = bms_num_members(params);
387 memcpy(start_address, &nparams, sizeof(int));
388 start_address += sizeof(int);
389
390 /* Write details for each parameter in turn. */
391 paramid = -1;
392 while ((paramid = bms_next_member(params, paramid)) >= 0)
393 {
394 Oid typeOid;
395 int16 typLen;
396 bool typByVal;
397
398 prm = &(estate->es_param_exec_vals[paramid]);
399 typeOid = list_nth_oid(estate->es_plannedstmt->paramExecTypes,
400 paramid);
401
402 /* Write paramid. */
403 memcpy(start_address, &paramid, sizeof(int));
404 start_address += sizeof(int);
405
406 /* Write datum/isnull */
407 if (OidIsValid(typeOid))
408 get_typlenbyval(typeOid, &typLen, &typByVal);
409 else
410 {
411 /* If no type OID, assume by-value, like copyParamList does. */
412 typLen = sizeof(Datum);
413 typByVal = true;
414 }
415 datumSerialize(prm->value, prm->isnull, typByVal, typLen,
417 }
418
419 return handle;
420}

References bms_next_member(), bms_num_members(), datumSerialize(), dsa_allocate, dsa_get_address(), EState::es_param_exec_vals, EState::es_plannedstmt, EstimateParamExecSpace(), fb(), get_typlenbyval(), list_nth_oid(), OidIsValid, and PlannedStmt::paramExecTypes.

Referenced by ExecInitParallelPlan(), and ExecParallelReinitialize().