Age Owner Branch data TLA Line data Source code
1 : : /* ----------
2 : : * backend_progress.c
3 : : *
4 : : * Command progress reporting infrastructure.
5 : : *
6 : : * Copyright (c) 2001-2026, PostgreSQL Global Development Group
7 : : *
8 : : * src/backend/utils/activity/backend_progress.c
9 : : * ----------
10 : : */
11 : : #include "postgres.h"
12 : :
13 : : #include "access/parallel.h"
14 : : #include "libpq/pqformat.h"
15 : : #include "storage/proc.h"
16 : : #include "utils/backend_progress.h"
17 : : #include "utils/backend_status.h"
18 : :
19 : :
20 : : /*-----------
21 : : * pgstat_progress_start_command() -
22 : : *
23 : : * Set st_progress_command (and st_progress_command_target) in own backend
24 : : * entry. Also, zero-initialize st_progress_param array.
25 : : *-----------
26 : : */
27 : : void
1807 andres@anarazel.de 28 :CBC 45248 : pgstat_progress_start_command(ProgressCommandType cmdtype, Oid relid)
29 : : {
30 : 45248 : volatile PgBackendStatus *beentry = MyBEEntry;
31 : :
32 [ + - - + ]: 45248 : if (!beentry || !pgstat_track_activities)
1807 andres@anarazel.de 33 :UBC 0 : return;
34 : :
1807 andres@anarazel.de 35 :CBC 45248 : PGSTAT_BEGIN_WRITE_ACTIVITY(beentry);
36 : 45248 : beentry->st_progress_command = cmdtype;
37 : 45248 : beentry->st_progress_command_target = relid;
38 [ + - + - : 950208 : MemSet(&beentry->st_progress_param, 0, sizeof(beentry->st_progress_param));
+ - + - +
+ ]
39 [ - + - + ]: 45248 : PGSTAT_END_WRITE_ACTIVITY(beentry);
40 : : }
41 : :
42 : : /*-----------
43 : : * pgstat_progress_update_param() -
44 : : *
45 : : * Update index'th member in st_progress_param[] of own backend entry.
46 : : *-----------
47 : : */
48 : : void
49 : 11853399 : pgstat_progress_update_param(int index, int64 val)
50 : : {
51 : 11853399 : volatile PgBackendStatus *beentry = MyBEEntry;
52 : :
53 [ + - - + ]: 11853399 : Assert(index >= 0 && index < PGSTAT_NUM_PROGRESS_PARAM);
54 : :
55 [ + - - + ]: 11853399 : if (!beentry || !pgstat_track_activities)
1807 andres@anarazel.de 56 :UBC 0 : return;
57 : :
1807 andres@anarazel.de 58 :CBC 11853399 : PGSTAT_BEGIN_WRITE_ACTIVITY(beentry);
59 : 11853399 : beentry->st_progress_param[index] = val;
60 [ - + - + ]: 11853399 : PGSTAT_END_WRITE_ACTIVITY(beentry);
61 : : }
62 : :
63 : : /*-----------
64 : : * pgstat_progress_incr_param() -
65 : : *
66 : : * Increment index'th member in st_progress_param[] of own backend entry.
67 : : *-----------
68 : : */
69 : : void
1086 tgl@sss.pgh.pa.us 70 : 1695 : pgstat_progress_incr_param(int index, int64 incr)
71 : : {
72 : 1695 : volatile PgBackendStatus *beentry = MyBEEntry;
73 : :
74 [ + - - + ]: 1695 : Assert(index >= 0 && index < PGSTAT_NUM_PROGRESS_PARAM);
75 : :
76 [ + - - + ]: 1695 : if (!beentry || !pgstat_track_activities)
1086 tgl@sss.pgh.pa.us 77 :UBC 0 : return;
78 : :
1086 tgl@sss.pgh.pa.us 79 :CBC 1695 : PGSTAT_BEGIN_WRITE_ACTIVITY(beentry);
80 : 1695 : beentry->st_progress_param[index] += incr;
81 [ - + - + ]: 1695 : PGSTAT_END_WRITE_ACTIVITY(beentry);
82 : : }
83 : :
84 : : /*-----------
85 : : * pgstat_progress_parallel_incr_param() -
86 : : *
87 : : * A variant of pgstat_progress_incr_param to allow a worker to poke at
88 : : * a leader to do an incremental progress update.
89 : : *-----------
90 : : */
91 : : void
978 msawada@postgresql.o 92 : 89 : pgstat_progress_parallel_incr_param(int index, int64 incr)
93 : : {
94 : : /*
95 : : * Parallel workers notify a leader through a PqMsg_Progress message to
96 : : * update progress, passing the progress index and incremented value.
97 : : * Leaders can just call pgstat_progress_incr_param directly.
98 : : */
99 [ - + ]: 89 : if (IsParallelWorker())
100 : : {
101 : : static StringInfoData progress_message;
102 : :
978 msawada@postgresql.o 103 :UBC 0 : initStringInfo(&progress_message);
104 : :
606 nathan@postgresql.or 105 : 0 : pq_beginmessage(&progress_message, PqMsg_Progress);
978 msawada@postgresql.o 106 : 0 : pq_sendint32(&progress_message, index);
107 : 0 : pq_sendint64(&progress_message, incr);
108 : 0 : pq_endmessage(&progress_message);
109 : : }
110 : : else
978 msawada@postgresql.o 111 :CBC 89 : pgstat_progress_incr_param(index, incr);
112 : 89 : }
113 : :
114 : : /*-----------
115 : : * pgstat_progress_update_multi_param() -
116 : : *
117 : : * Update multiple members in st_progress_param[] of own backend entry.
118 : : * This is atomic; readers won't see intermediate states.
119 : : *-----------
120 : : */
121 : : void
1807 andres@anarazel.de 122 : 614590 : pgstat_progress_update_multi_param(int nparam, const int *index,
123 : : const int64 *val)
124 : : {
125 : 614590 : volatile PgBackendStatus *beentry = MyBEEntry;
126 : : int i;
127 : :
128 [ + - + - : 614590 : if (!beentry || !pgstat_track_activities || nparam == 0)
- + ]
1807 andres@anarazel.de 129 :UBC 0 : return;
130 : :
1807 andres@anarazel.de 131 :CBC 614590 : PGSTAT_BEGIN_WRITE_ACTIVITY(beentry);
132 : :
133 [ + + ]: 1609203 : for (i = 0; i < nparam; ++i)
134 : : {
135 [ + - - + ]: 994613 : Assert(index[i] >= 0 && index[i] < PGSTAT_NUM_PROGRESS_PARAM);
136 : :
137 : 994613 : beentry->st_progress_param[index[i]] = val[i];
138 : : }
139 : :
140 [ - + - + ]: 614590 : PGSTAT_END_WRITE_ACTIVITY(beentry);
141 : : }
142 : :
143 : : /*-----------
144 : : * pgstat_progress_end_command() -
145 : : *
146 : : * Reset st_progress_command (and st_progress_command_target) in own backend
147 : : * entry. This signals the end of the command.
148 : : *-----------
149 : : */
150 : : void
151 : 75345 : pgstat_progress_end_command(void)
152 : : {
153 : 75345 : volatile PgBackendStatus *beentry = MyBEEntry;
154 : :
155 [ + - - + ]: 75345 : if (!beentry || !pgstat_track_activities)
1807 andres@anarazel.de 156 :UBC 0 : return;
157 : :
1807 andres@anarazel.de 158 [ + + ]:CBC 75345 : if (beentry->st_progress_command == PROGRESS_COMMAND_INVALID)
159 : 30909 : return;
160 : :
161 : 44436 : PGSTAT_BEGIN_WRITE_ACTIVITY(beentry);
162 : 44436 : beentry->st_progress_command = PROGRESS_COMMAND_INVALID;
163 : 44436 : beentry->st_progress_command_target = InvalidOid;
164 [ - + - + ]: 44436 : PGSTAT_END_WRITE_ACTIVITY(beentry);
165 : : }
|
