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