PostgreSQL Source Code  git master
backend_status.h File Reference
#include "datatype/timestamp.h"
#include "libpq/pqcomm.h"
#include "miscadmin.h"
#include "storage/backendid.h"
#include "utils/backend_progress.h"
Include dependency graph for backend_status.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  PgBackendSSLStatus
 
struct  PgBackendGSSStatus
 
struct  PgBackendStatus
 
struct  LocalPgBackendStatus
 

Macros

#define PGSTAT_BEGIN_WRITE_ACTIVITY(beentry)
 
#define PGSTAT_END_WRITE_ACTIVITY(beentry)
 
#define pgstat_begin_read_activity(beentry, before_changecount)
 
#define pgstat_end_read_activity(beentry, after_changecount)
 
#define pgstat_read_activity_complete(before_changecount, after_changecount)
 

Typedefs

typedef enum BackendState BackendState
 
typedef struct PgBackendSSLStatus PgBackendSSLStatus
 
typedef struct PgBackendGSSStatus PgBackendGSSStatus
 
typedef struct PgBackendStatus PgBackendStatus
 
typedef struct LocalPgBackendStatus LocalPgBackendStatus
 

Enumerations

enum  BackendState {
  STATE_UNDEFINED , STATE_IDLE , STATE_RUNNING , STATE_IDLEINTRANSACTION ,
  STATE_FASTPATH , STATE_IDLEINTRANSACTION_ABORTED , STATE_DISABLED
}
 

Functions

Size BackendStatusShmemSize (void)
 
void CreateSharedBackendStatus (void)
 
void pgstat_beinit (void)
 
void pgstat_bestart (void)
 
void pgstat_clear_backend_activity_snapshot (void)
 
void pgstat_report_activity (BackendState state, const char *cmd_str)
 
void pgstat_report_query_id (uint64 query_id, bool force)
 
void pgstat_report_tempfile (size_t filesize)
 
void pgstat_report_appname (const char *appname)
 
void pgstat_report_xact_timestamp (TimestampTz tstamp)
 
const char * pgstat_get_backend_current_activity (int pid, bool checkUser)
 
const char * pgstat_get_crashed_backend_activity (int pid, char *buffer, int buflen)
 
uint64 pgstat_get_my_query_id (void)
 
int pgstat_fetch_stat_numbackends (void)
 
PgBackendStatuspgstat_fetch_stat_beentry (BackendId beid)
 
LocalPgBackendStatuspgstat_fetch_stat_local_beentry (int beid)
 
char * pgstat_clip_activity (const char *raw_activity)
 

Variables

PGDLLIMPORT bool pgstat_track_activities
 
PGDLLIMPORT int pgstat_track_activity_query_size
 
PGDLLIMPORT PgBackendStatusMyBEEntry
 

Macro Definition Documentation

◆ pgstat_begin_read_activity

#define pgstat_begin_read_activity (   beentry,
  before_changecount 
)
Value:
do { \
(before_changecount) = (beentry)->st_changecount; \
pg_read_barrier(); \
} while (0)

Definition at line 219 of file backend_status.h.

◆ PGSTAT_BEGIN_WRITE_ACTIVITY

#define PGSTAT_BEGIN_WRITE_ACTIVITY (   beentry)
Value:
do { \
START_CRIT_SECTION(); \
(beentry)->st_changecount++; \
pg_write_barrier(); \
} while (0)

Definition at line 204 of file backend_status.h.

◆ pgstat_end_read_activity

#define pgstat_end_read_activity (   beentry,
  after_changecount 
)
Value:
do { \
pg_read_barrier(); \
(after_changecount) = (beentry)->st_changecount; \
} while (0)

Definition at line 225 of file backend_status.h.

◆ PGSTAT_END_WRITE_ACTIVITY

#define PGSTAT_END_WRITE_ACTIVITY (   beentry)
Value:
do { \
pg_write_barrier(); \
(beentry)->st_changecount++; \
Assert(((beentry)->st_changecount & 1) == 0); \
END_CRIT_SECTION(); \
} while (0)

Definition at line 211 of file backend_status.h.

◆ pgstat_read_activity_complete

#define pgstat_read_activity_complete (   before_changecount,
  after_changecount 
)
Value:
((before_changecount) == (after_changecount) && \
((before_changecount) & 1) == 0)

Definition at line 231 of file backend_status.h.

Typedef Documentation

◆ BackendState

typedef enum BackendState BackendState

◆ LocalPgBackendStatus

◆ PgBackendGSSStatus

◆ PgBackendSSLStatus

◆ PgBackendStatus

Enumeration Type Documentation

◆ BackendState

Enumerator
STATE_UNDEFINED 
STATE_IDLE 
STATE_RUNNING 
STATE_IDLEINTRANSACTION 
STATE_FASTPATH 
STATE_IDLEINTRANSACTION_ABORTED 
STATE_DISABLED 

Definition at line 24 of file backend_status.h.

25 {
27  STATE_IDLE,
33 } BackendState;
BackendState
@ STATE_UNDEFINED
@ STATE_IDLEINTRANSACTION_ABORTED
@ STATE_IDLE
@ STATE_IDLEINTRANSACTION
@ STATE_DISABLED
@ STATE_FASTPATH
@ STATE_RUNNING

Function Documentation

◆ BackendStatusShmemSize()

Size BackendStatusShmemSize ( void  )

Definition at line 84 of file backend_status.c.

85 {
86  Size size;
87 
88  /* BackendStatusArray: */
90  /* BackendAppnameBuffer: */
91  size = add_size(size,
93  /* BackendClientHostnameBuffer: */
94  size = add_size(size,
96  /* BackendActivityBuffer: */
97  size = add_size(size,
99 #ifdef USE_SSL
100  /* BackendSslStatusBuffer: */
101  size = add_size(size,
103 #endif
104 #ifdef ENABLE_GSS
105  /* BackendGssStatusBuffer: */
106  size = add_size(size,
108 #endif
109  return size;
110 }
#define NumBackendStatSlots
int pgstat_track_activity_query_size
size_t Size
Definition: c.h:541
#define NAMEDATALEN
Size add_size(Size s1, Size s2)
Definition: shmem.c:502
Size mul_size(Size s1, Size s2)
Definition: shmem.c:519

References add_size(), mul_size(), NAMEDATALEN, NumBackendStatSlots, and pgstat_track_activity_query_size.

Referenced by CalculateShmemSize().

◆ CreateSharedBackendStatus()

void CreateSharedBackendStatus ( void  )

Definition at line 117 of file backend_status.c.

118 {
119  Size size;
120  bool found;
121  int i;
122  char *buffer;
123 
124  /* Create or attach to the shared array */
127  ShmemInitStruct("Backend Status Array", size, &found);
128 
129  if (!found)
130  {
131  /*
132  * We're the first - initialize.
133  */
134  MemSet(BackendStatusArray, 0, size);
135  }
136 
137  /* Create or attach to the shared appname buffer */
139  BackendAppnameBuffer = (char *)
140  ShmemInitStruct("Backend Application Name Buffer", size, &found);
141 
142  if (!found)
143  {
144  MemSet(BackendAppnameBuffer, 0, size);
145 
146  /* Initialize st_appname pointers. */
147  buffer = BackendAppnameBuffer;
148  for (i = 0; i < NumBackendStatSlots; i++)
149  {
150  BackendStatusArray[i].st_appname = buffer;
151  buffer += NAMEDATALEN;
152  }
153  }
154 
155  /* Create or attach to the shared client hostname buffer */
157  BackendClientHostnameBuffer = (char *)
158  ShmemInitStruct("Backend Client Host Name Buffer", size, &found);
159 
160  if (!found)
161  {
163 
164  /* Initialize st_clienthostname pointers. */
166  for (i = 0; i < NumBackendStatSlots; i++)
167  {
169  buffer += NAMEDATALEN;
170  }
171  }
172 
173  /* Create or attach to the shared activity buffer */
176  BackendActivityBuffer = (char *)
177  ShmemInitStruct("Backend Activity Buffer",
179  &found);
180 
181  if (!found)
182  {
184 
185  /* Initialize st_activity pointers. */
186  buffer = BackendActivityBuffer;
187  for (i = 0; i < NumBackendStatSlots; i++)
188  {
191  }
192  }
193 
194 #ifdef USE_SSL
195  /* Create or attach to the shared SSL status buffer */
197  BackendSslStatusBuffer = (PgBackendSSLStatus *)
198  ShmemInitStruct("Backend SSL Status Buffer", size, &found);
199 
200  if (!found)
201  {
202  PgBackendSSLStatus *ptr;
203 
204  MemSet(BackendSslStatusBuffer, 0, size);
205 
206  /* Initialize st_sslstatus pointers. */
207  ptr = BackendSslStatusBuffer;
208  for (i = 0; i < NumBackendStatSlots; i++)
209  {
211  ptr++;
212  }
213  }
214 #endif
215 
216 #ifdef ENABLE_GSS
217  /* Create or attach to the shared GSSAPI status buffer */
219  BackendGssStatusBuffer = (PgBackendGSSStatus *)
220  ShmemInitStruct("Backend GSS Status Buffer", size, &found);
221 
222  if (!found)
223  {
224  PgBackendGSSStatus *ptr;
225 
226  MemSet(BackendGssStatusBuffer, 0, size);
227 
228  /* Initialize st_gssstatus pointers. */
229  ptr = BackendGssStatusBuffer;
230  for (i = 0; i < NumBackendStatSlots; i++)
231  {
233  ptr++;
234  }
235  }
236 #endif
237 }
static char * BackendClientHostnameBuffer
static char * BackendActivityBuffer
static char * BackendAppnameBuffer
static PgBackendStatus * BackendStatusArray
static Size BackendActivityBufferSize
#define MemSet(start, val, len)
Definition: c.h:953
int i
Definition: isn.c:73
void * ShmemInitStruct(const char *name, Size size, bool *foundPtr)
Definition: shmem.c:396
PgBackendGSSStatus * st_gssstatus
PgBackendSSLStatus * st_sslstatus
char * st_clienthostname

References BackendActivityBuffer, BackendActivityBufferSize, BackendAppnameBuffer, BackendClientHostnameBuffer, BackendStatusArray, i, MemSet, mul_size(), NAMEDATALEN, NumBackendStatSlots, pgstat_track_activity_query_size, ShmemInitStruct(), PgBackendStatus::st_activity_raw, PgBackendStatus::st_appname, PgBackendStatus::st_clienthostname, PgBackendStatus::st_gssstatus, and PgBackendStatus::st_sslstatus.

Referenced by CreateSharedMemoryAndSemaphores().

◆ pgstat_beinit()

void pgstat_beinit ( void  )

Definition at line 249 of file backend_status.c.

250 {
251  /* Initialize MyBEEntry */
253  {
256  }
257  else
258  {
259  /* Must be an auxiliary process */
261 
262  /*
263  * Assign the MyBEEntry for an auxiliary process. Since it doesn't
264  * have a BackendId, the slot is statically allocated based on the
265  * auxiliary process type (MyAuxProcType). Backends use slots indexed
266  * in the range from 1 to MaxBackends (inclusive), so we use
267  * MaxBackends + AuxBackendType + 1 as the index of the slot for an
268  * auxiliary process.
269  */
271  }
272 
273  /* Set up a process-exit hook to clean up */
275 }
AuxProcType MyAuxProcType
Definition: auxprocess.c:45
PgBackendStatus * MyBEEntry
static void pgstat_beshutdown_hook(int code, Datum arg)
#define InvalidBackendId
Definition: backendid.h:23
BackendId MyBackendId
Definition: globals.c:85
int MaxBackends
Definition: globals.c:140
void on_shmem_exit(pg_on_exit_callback function, Datum arg)
Definition: ipc.c:361
Assert(fmt[strlen(fmt) - 1] !='\n')
@ NotAnAuxProcess
Definition: miscadmin.h:427

References Assert(), BackendStatusArray, InvalidBackendId, MaxBackends, MyAuxProcType, MyBackendId, MyBEEntry, NotAnAuxProcess, on_shmem_exit(), and pgstat_beshutdown_hook().

Referenced by AuxiliaryProcessMain(), and InitPostgres().

◆ pgstat_bestart()

void pgstat_bestart ( void  )

Definition at line 292 of file backend_status.c.

293 {
294  volatile PgBackendStatus *vbeentry = MyBEEntry;
295  PgBackendStatus lbeentry;
296 #ifdef USE_SSL
297  PgBackendSSLStatus lsslstatus;
298 #endif
299 #ifdef ENABLE_GSS
300  PgBackendGSSStatus lgssstatus;
301 #endif
302 
303  /* pgstats state must be initialized from pgstat_beinit() */
304  Assert(vbeentry != NULL);
305 
306  /*
307  * To minimize the time spent modifying the PgBackendStatus entry, and
308  * avoid risk of errors inside the critical section, we first copy the
309  * shared-memory struct to a local variable, then modify the data in the
310  * local variable, then copy the local variable back to shared memory.
311  * Only the last step has to be inside the critical section.
312  *
313  * Most of the data we copy from shared memory is just going to be
314  * overwritten, but the struct's not so large that it's worth the
315  * maintenance hassle to copy only the needful fields.
316  */
317  memcpy(&lbeentry,
318  unvolatize(PgBackendStatus *, vbeentry),
319  sizeof(PgBackendStatus));
320 
321  /* These structs can just start from zeroes each time, though */
322 #ifdef USE_SSL
323  memset(&lsslstatus, 0, sizeof(lsslstatus));
324 #endif
325 #ifdef ENABLE_GSS
326  memset(&lgssstatus, 0, sizeof(lgssstatus));
327 #endif
328 
329  /*
330  * Now fill in all the fields of lbeentry, except for strings that are
331  * out-of-line data. Those have to be handled separately, below.
332  */
333  lbeentry.st_procpid = MyProcPid;
334  lbeentry.st_backendType = MyBackendType;
336  lbeentry.st_activity_start_timestamp = 0;
337  lbeentry.st_state_start_timestamp = 0;
338  lbeentry.st_xact_start_timestamp = 0;
339  lbeentry.st_databaseid = MyDatabaseId;
340 
341  /* We have userid for client-backends, wal-sender and bgworker processes */
342  if (lbeentry.st_backendType == B_BACKEND
343  || lbeentry.st_backendType == B_WAL_SENDER
344  || lbeentry.st_backendType == B_BG_WORKER)
345  lbeentry.st_userid = GetSessionUserId();
346  else
347  lbeentry.st_userid = InvalidOid;
348 
349  /*
350  * We may not have a MyProcPort (eg, if this is the autovacuum process).
351  * If so, use all-zeroes client address, which is dealt with specially in
352  * pg_stat_get_backend_client_addr and pg_stat_get_backend_client_port.
353  */
354  if (MyProcPort)
355  memcpy(&lbeentry.st_clientaddr, &MyProcPort->raddr,
356  sizeof(lbeentry.st_clientaddr));
357  else
358  MemSet(&lbeentry.st_clientaddr, 0, sizeof(lbeentry.st_clientaddr));
359 
360 #ifdef USE_SSL
362  {
363  lbeentry.st_ssl = true;
370  }
371  else
372  {
373  lbeentry.st_ssl = false;
374  }
375 #else
376  lbeentry.st_ssl = false;
377 #endif
378 
379 #ifdef ENABLE_GSS
380  if (MyProcPort && MyProcPort->gss != NULL)
381  {
382  const char *princ = be_gssapi_get_princ(MyProcPort);
383 
384  lbeentry.st_gss = true;
385  lgssstatus.gss_auth = be_gssapi_get_auth(MyProcPort);
386  lgssstatus.gss_enc = be_gssapi_get_enc(MyProcPort);
387  if (princ)
388  strlcpy(lgssstatus.gss_princ, princ, NAMEDATALEN);
389  }
390  else
391  {
392  lbeentry.st_gss = false;
393  }
394 #else
395  lbeentry.st_gss = false;
396 #endif
397 
398  lbeentry.st_state = STATE_UNDEFINED;
401  lbeentry.st_query_id = UINT64CONST(0);
402 
403  /*
404  * we don't zero st_progress_param here to save cycles; nobody should
405  * examine it until st_progress_command has been set to something other
406  * than PROGRESS_COMMAND_INVALID
407  */
408 
409  /*
410  * We're ready to enter the critical section that fills the shared-memory
411  * status entry. We follow the protocol of bumping st_changecount before
412  * and after; and make sure it's even afterwards. We use a volatile
413  * pointer here to ensure the compiler doesn't try to get cute.
414  */
415  PGSTAT_BEGIN_WRITE_ACTIVITY(vbeentry);
416 
417  /* make sure we'll memcpy the same st_changecount back */
418  lbeentry.st_changecount = vbeentry->st_changecount;
419 
420  memcpy(unvolatize(PgBackendStatus *, vbeentry),
421  &lbeentry,
422  sizeof(PgBackendStatus));
423 
424  /*
425  * We can write the out-of-line strings and structs using the pointers
426  * that are in lbeentry; this saves some de-volatilizing messiness.
427  */
428  lbeentry.st_appname[0] = '\0';
431  NAMEDATALEN);
432  else
433  lbeentry.st_clienthostname[0] = '\0';
434  lbeentry.st_activity_raw[0] = '\0';
435  /* Also make sure the last byte in each string area is always 0 */
436  lbeentry.st_appname[NAMEDATALEN - 1] = '\0';
437  lbeentry.st_clienthostname[NAMEDATALEN - 1] = '\0';
439 
440 #ifdef USE_SSL
441  memcpy(lbeentry.st_sslstatus, &lsslstatus, sizeof(PgBackendSSLStatus));
442 #endif
443 #ifdef ENABLE_GSS
444  memcpy(lbeentry.st_gssstatus, &lgssstatus, sizeof(PgBackendGSSStatus));
445 #endif
446 
447  PGSTAT_END_WRITE_ACTIVITY(vbeentry);
448 
449  /* Update app name to current GUC setting */
450  if (application_name)
452 }
@ PROGRESS_COMMAND_INVALID
void pgstat_report_appname(const char *appname)
#define PGSTAT_END_WRITE_ACTIVITY(beentry)
#define PGSTAT_BEGIN_WRITE_ACTIVITY(beentry)
bool be_gssapi_get_auth(Port *port)
bool be_gssapi_get_enc(Port *port)
const char * be_gssapi_get_princ(Port *port)
const char * be_tls_get_version(Port *port)
int be_tls_get_cipher_bits(Port *port)
void be_tls_get_peer_serial(Port *port, char *ptr, size_t len)
void be_tls_get_peer_issuer_name(Port *port, char *ptr, size_t len)
const char * be_tls_get_cipher(Port *port)
void be_tls_get_peer_subject_name(Port *port, char *ptr, size_t len)
#define unvolatize(underlying_type, expr)
Definition: c.h:1183
int MyProcPid
Definition: globals.c:44
TimestampTz MyStartTimestamp
Definition: globals.c:46
struct Port * MyProcPort
Definition: globals.c:47
Oid MyDatabaseId
Definition: globals.c:89
char * application_name
Definition: guc_tables.c:510
@ B_WAL_SENDER
Definition: miscadmin.h:330
@ B_BG_WORKER
Definition: miscadmin.h:323
@ B_BACKEND
Definition: miscadmin.h:322
Oid GetSessionUserId(void)
Definition: miscinit.c:531
BackendType MyBackendType
Definition: miscinit.c:63
size_t strlcpy(char *dst, const char *src, size_t siz)
Definition: strlcpy.c:45
#define InvalidOid
Definition: postgres_ext.h:36
char gss_princ[NAMEDATALEN]
char ssl_version[NAMEDATALEN]
char ssl_cipher[NAMEDATALEN]
char ssl_client_dn[NAMEDATALEN]
char ssl_client_serial[NAMEDATALEN]
char ssl_issuer_dn[NAMEDATALEN]
BackendType st_backendType
TimestampTz st_state_start_timestamp
TimestampTz st_proc_start_timestamp
BackendState st_state
TimestampTz st_activity_start_timestamp
ProgressCommandType st_progress_command
SockAddr st_clientaddr
TimestampTz st_xact_start_timestamp
Oid st_progress_command_target
bool ssl_in_use
Definition: libpq-be.h:216
char * remote_hostname
Definition: libpq-be.h:153
void * gss
Definition: libpq-be.h:210
SockAddr raddr
Definition: libpq-be.h:151

References application_name, Assert(), B_BACKEND, B_BG_WORKER, B_WAL_SENDER, be_gssapi_get_auth(), be_gssapi_get_enc(), be_gssapi_get_princ(), be_tls_get_cipher(), be_tls_get_cipher_bits(), be_tls_get_peer_issuer_name(), be_tls_get_peer_serial(), be_tls_get_peer_subject_name(), be_tls_get_version(), GetSessionUserId(), Port::gss, PgBackendGSSStatus::gss_auth, PgBackendGSSStatus::gss_enc, PgBackendGSSStatus::gss_princ, InvalidOid, MemSet, MyBackendType, MyBEEntry, MyDatabaseId, MyProcPid, MyProcPort, MyStartTimestamp, NAMEDATALEN, PGSTAT_BEGIN_WRITE_ACTIVITY, PGSTAT_END_WRITE_ACTIVITY, pgstat_report_appname(), pgstat_track_activity_query_size, PROGRESS_COMMAND_INVALID, Port::raddr, Port::remote_hostname, PgBackendSSLStatus::ssl_bits, PgBackendSSLStatus::ssl_cipher, PgBackendSSLStatus::ssl_client_dn, PgBackendSSLStatus::ssl_client_serial, Port::ssl_in_use, PgBackendSSLStatus::ssl_issuer_dn, PgBackendSSLStatus::ssl_version, PgBackendStatus::st_activity_raw, PgBackendStatus::st_activity_start_timestamp, PgBackendStatus::st_appname, PgBackendStatus::st_backendType, PgBackendStatus::st_changecount, PgBackendStatus::st_clientaddr, PgBackendStatus::st_clienthostname, PgBackendStatus::st_databaseid, PgBackendStatus::st_gss, PgBackendStatus::st_gssstatus, PgBackendStatus::st_proc_start_timestamp, PgBackendStatus::st_procpid, PgBackendStatus::st_progress_command, PgBackendStatus::st_progress_command_target, PgBackendStatus::st_query_id, PgBackendStatus::st_ssl, PgBackendStatus::st_sslstatus, PgBackendStatus::st_state, PgBackendStatus::st_state_start_timestamp, PgBackendStatus::st_userid, PgBackendStatus::st_xact_start_timestamp, STATE_UNDEFINED, strlcpy(), and unvolatize.

Referenced by AuxiliaryProcessMain(), and InitPostgres().

◆ pgstat_clear_backend_activity_snapshot()

void pgstat_clear_backend_activity_snapshot ( void  )

Definition at line 485 of file backend_status.c.

486 {
487  /* Release memory, if any was allocated */
489  {
492  }
493 
494  /* Reset variables */
496  localNumBackends = 0;
497 }
static LocalPgBackendStatus * localBackendStatusTable
static int localNumBackends
static MemoryContext backendStatusSnapContext
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:376

References backendStatusSnapContext, localBackendStatusTable, localNumBackends, and MemoryContextDelete().

Referenced by pgstat_clear_snapshot().

◆ pgstat_clip_activity()

char* pgstat_clip_activity ( const char *  raw_activity)

Definition at line 1160 of file backend_status.c.

1161 {
1162  char *activity;
1163  int rawlen;
1164  int cliplen;
1165 
1166  /*
1167  * Some callers, like pgstat_get_backend_current_activity(), do not
1168  * guarantee that the buffer isn't concurrently modified. We try to take
1169  * care that the buffer is always terminated by a NUL byte regardless, but
1170  * let's still be paranoid about the string's length. In those cases the
1171  * underlying buffer is guaranteed to be pgstat_track_activity_query_size
1172  * large.
1173  */
1174  activity = pnstrdup(raw_activity, pgstat_track_activity_query_size - 1);
1175 
1176  /* now double-guaranteed to be NUL terminated */
1177  rawlen = strlen(activity);
1178 
1179  /*
1180  * All supported server-encodings make it possible to determine the length
1181  * of a multi-byte character from its first byte (this is not the case for
1182  * client encodings, see GB18030). As st_activity is always stored using
1183  * server encoding, this allows us to perform multi-byte aware truncation,
1184  * even if the string earlier was truncated in the middle of a multi-byte
1185  * character.
1186  */
1187  cliplen = pg_mbcliplen(activity, rawlen,
1189 
1190  activity[cliplen] = '\0';
1191 
1192  return activity;
1193 }
int pg_mbcliplen(const char *mbstr, int len, int limit)
Definition: mbutils.c:1026
static int cliplen(const char *str, int len, int limit)
Definition: mbutils.c:1093
char * pnstrdup(const char *in, Size len)
Definition: mcxt.c:1494

References cliplen(), pg_mbcliplen(), pgstat_track_activity_query_size, and pnstrdup().

Referenced by pg_stat_get_activity(), pg_stat_get_backend_activity(), and pgstat_get_backend_current_activity().

◆ pgstat_fetch_stat_beentry()

PgBackendStatus* pgstat_fetch_stat_beentry ( BackendId  beid)

Definition at line 1086 of file backend_status.c.

1087 {
1089  LocalPgBackendStatus *ret;
1090 
1092 
1093  /*
1094  * Since the localBackendStatusTable is in order by backend_id, we can use
1095  * bsearch() to search it efficiently.
1096  */
1097  key.backend_id = beid;
1098  ret = (LocalPgBackendStatus *) bsearch(&key, localBackendStatusTable,
1100  sizeof(LocalPgBackendStatus),
1101  cmp_lbestatus);
1102  if (ret)
1103  return &ret->backendStatus;
1104 
1105  return NULL;
1106 }
static int cmp_lbestatus(const void *a, const void *b)
static void pgstat_read_current_status(void)
PgBackendStatus backendStatus

References LocalPgBackendStatus::backendStatus, cmp_lbestatus(), sort-test::key, localBackendStatusTable, localNumBackends, and pgstat_read_current_status().

Referenced by pg_stat_get_backend_activity(), pg_stat_get_backend_activity_start(), pg_stat_get_backend_client_addr(), pg_stat_get_backend_client_port(), pg_stat_get_backend_dbid(), pg_stat_get_backend_pid(), pg_stat_get_backend_start(), pg_stat_get_backend_userid(), pg_stat_get_backend_wait_event(), pg_stat_get_backend_wait_event_type(), and pg_stat_get_backend_xact_start().

◆ pgstat_fetch_stat_local_beentry()

LocalPgBackendStatus* pgstat_fetch_stat_local_beentry ( int  beid)

Definition at line 1124 of file backend_status.c.

1125 {
1127 
1128  if (beid < 1 || beid > localNumBackends)
1129  return NULL;
1130 
1131  return &localBackendStatusTable[beid - 1];
1132 }

References localBackendStatusTable, localNumBackends, and pgstat_read_current_status().

Referenced by pg_stat_get_activity(), pg_stat_get_backend_idset(), pg_stat_get_db_numbackends(), and pg_stat_get_progress_info().

◆ pgstat_fetch_stat_numbackends()

int pgstat_fetch_stat_numbackends ( void  )

◆ pgstat_get_backend_current_activity()

const char* pgstat_get_backend_current_activity ( int  pid,
bool  checkUser 
)

Definition at line 899 of file backend_status.c.

900 {
901  PgBackendStatus *beentry;
902  int i;
903 
904  beentry = BackendStatusArray;
905  for (i = 1; i <= MaxBackends; i++)
906  {
907  /*
908  * Although we expect the target backend's entry to be stable, that
909  * doesn't imply that anyone else's is. To avoid identifying the
910  * wrong backend, while we check for a match to the desired PID we
911  * must follow the protocol of retrying if st_changecount changes
912  * while we examine the entry, or if it's odd. (This might be
913  * unnecessary, since fetching or storing an int is almost certainly
914  * atomic, but let's play it safe.) We use a volatile pointer here to
915  * ensure the compiler doesn't try to get cute.
916  */
917  volatile PgBackendStatus *vbeentry = beentry;
918  bool found;
919 
920  for (;;)
921  {
922  int before_changecount;
923  int after_changecount;
924 
925  pgstat_begin_read_activity(vbeentry, before_changecount);
926 
927  found = (vbeentry->st_procpid == pid);
928 
929  pgstat_end_read_activity(vbeentry, after_changecount);
930 
931  if (pgstat_read_activity_complete(before_changecount,
932  after_changecount))
933  break;
934 
935  /* Make sure we can break out of loop if stuck... */
937  }
938 
939  if (found)
940  {
941  /* Now it is safe to use the non-volatile pointer */
942  if (checkUser && !superuser() && beentry->st_userid != GetUserId())
943  return "<insufficient privilege>";
944  else if (*(beentry->st_activity_raw) == '\0')
945  return "<command string not enabled>";
946  else
947  {
948  /* this'll leak a bit of memory, but that seems acceptable */
949  return pgstat_clip_activity(beentry->st_activity_raw);
950  }
951  }
952 
953  beentry++;
954  }
955 
956  /* If we get here, caller is in error ... */
957  return "<backend information not available>";
958 }
char * pgstat_clip_activity(const char *raw_activity)
#define pgstat_read_activity_complete(before_changecount, after_changecount)
#define pgstat_end_read_activity(beentry, after_changecount)
#define pgstat_begin_read_activity(beentry, before_changecount)
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:121
Oid GetUserId(void)
Definition: miscinit.c:497
bool superuser(void)
Definition: superuser.c:46

References BackendStatusArray, CHECK_FOR_INTERRUPTS, GetUserId(), i, MaxBackends, pgstat_begin_read_activity, pgstat_clip_activity(), pgstat_end_read_activity, pgstat_read_activity_complete, PgBackendStatus::st_activity_raw, PgBackendStatus::st_procpid, PgBackendStatus::st_userid, and superuser().

Referenced by DeadLockReport().

◆ pgstat_get_crashed_backend_activity()

const char* pgstat_get_crashed_backend_activity ( int  pid,
char *  buffer,
int  buflen 
)

Definition at line 977 of file backend_status.c.

978 {
979  volatile PgBackendStatus *beentry;
980  int i;
981 
982  beentry = BackendStatusArray;
983 
984  /*
985  * We probably shouldn't get here before shared memory has been set up,
986  * but be safe.
987  */
988  if (beentry == NULL || BackendActivityBuffer == NULL)
989  return NULL;
990 
991  for (i = 1; i <= MaxBackends; i++)
992  {
993  if (beentry->st_procpid == pid)
994  {
995  /* Read pointer just once, so it can't change after validation */
996  const char *activity = beentry->st_activity_raw;
997  const char *activity_last;
998 
999  /*
1000  * We mustn't access activity string before we verify that it
1001  * falls within the BackendActivityBuffer. To make sure that the
1002  * entire string including its ending is contained within the
1003  * buffer, subtract one activity length from the buffer size.
1004  */
1007 
1008  if (activity < BackendActivityBuffer ||
1009  activity > activity_last)
1010  return NULL;
1011 
1012  /* If no string available, no point in a report */
1013  if (activity[0] == '\0')
1014  return NULL;
1015 
1016  /*
1017  * Copy only ASCII-safe characters so we don't run into encoding
1018  * problems when reporting the message; and be sure not to run off
1019  * the end of memory. As only ASCII characters are reported, it
1020  * doesn't seem necessary to perform multibyte aware clipping.
1021  */
1022  ascii_safe_strlcpy(buffer, activity,
1024 
1025  return buffer;
1026  }
1027 
1028  beentry++;
1029  }
1030 
1031  /* PID not found */
1032  return NULL;
1033 }
void ascii_safe_strlcpy(char *dest, const char *src, size_t destsiz)
Definition: ascii.c:173
#define Min(x, y)
Definition: c.h:937

References ascii_safe_strlcpy(), BackendActivityBuffer, BackendActivityBufferSize, BackendStatusArray, i, MaxBackends, Min, pgstat_track_activity_query_size, PgBackendStatus::st_activity_raw, and PgBackendStatus::st_procpid.

Referenced by LogChildExit().

◆ pgstat_get_my_query_id()

uint64 pgstat_get_my_query_id ( void  )

Definition at line 1041 of file backend_status.c.

1042 {
1043  if (!MyBEEntry)
1044  return 0;
1045 
1046  /*
1047  * There's no need for a lock around pgstat_begin_read_activity /
1048  * pgstat_end_read_activity here as it's only called from
1049  * pg_stat_get_activity which is already protected, or from the same
1050  * backend which means that there won't be concurrent writes.
1051  */
1052  return MyBEEntry->st_query_id;
1053 }

References MyBEEntry, and PgBackendStatus::st_query_id.

Referenced by ExecSerializePlan(), log_status_format(), write_csvlog(), and write_jsonlog().

◆ pgstat_report_activity()

void pgstat_report_activity ( BackendState  state,
const char *  cmd_str 
)

Definition at line 521 of file backend_status.c.

522 {
523  volatile PgBackendStatus *beentry = MyBEEntry;
524  TimestampTz start_timestamp;
526  int len = 0;
527 
528  TRACE_POSTGRESQL_STATEMENT_STATUS(cmd_str);
529 
530  if (!beentry)
531  return;
532 
534  {
535  if (beentry->st_state != STATE_DISABLED)
536  {
537  volatile PGPROC *proc = MyProc;
538 
539  /*
540  * track_activities is disabled, but we last reported a
541  * non-disabled state. As our final update, change the state and
542  * clear fields we will not be updating anymore.
543  */
545  beentry->st_state = STATE_DISABLED;
546  beentry->st_state_start_timestamp = 0;
547  beentry->st_activity_raw[0] = '\0';
548  beentry->st_activity_start_timestamp = 0;
549  /* st_xact_start_timestamp and wait_event_info are also disabled */
550  beentry->st_xact_start_timestamp = 0;
551  beentry->st_query_id = UINT64CONST(0);
552  proc->wait_event_info = 0;
553  PGSTAT_END_WRITE_ACTIVITY(beentry);
554  }
555  return;
556  }
557 
558  /*
559  * To minimize the time spent modifying the entry, and avoid risk of
560  * errors inside the critical section, fetch all the needed data first.
561  */
562  start_timestamp = GetCurrentStatementStartTimestamp();
563  if (cmd_str != NULL)
564  {
565  /*
566  * Compute length of to-be-stored string unaware of multi-byte
567  * characters. For speed reasons that'll get corrected on read, rather
568  * than computed every write.
569  */
570  len = Min(strlen(cmd_str), pgstat_track_activity_query_size - 1);
571  }
573 
574  /*
575  * If the state has changed from "active" or "idle in transaction",
576  * calculate the duration.
577  */
578  if ((beentry->st_state == STATE_RUNNING ||
579  beentry->st_state == STATE_FASTPATH ||
580  beentry->st_state == STATE_IDLEINTRANSACTION ||
582  state != beentry->st_state)
583  {
584  long secs;
585  int usecs;
586 
589  &secs, &usecs);
590 
591  if (beentry->st_state == STATE_RUNNING ||
592  beentry->st_state == STATE_FASTPATH)
593  pgstat_count_conn_active_time((PgStat_Counter) secs * 1000000 + usecs);
594  else
595  pgstat_count_conn_txn_idle_time((PgStat_Counter) secs * 1000000 + usecs);
596  }
597 
598  /*
599  * Now update the status entry
600  */
602 
603  beentry->st_state = state;
605 
606  /*
607  * If a new query is started, we reset the query identifier as it'll only
608  * be known after parse analysis, to avoid reporting last query's
609  * identifier.
610  */
611  if (state == STATE_RUNNING)
612  beentry->st_query_id = UINT64CONST(0);
613 
614  if (cmd_str != NULL)
615  {
616  memcpy((char *) beentry->st_activity_raw, cmd_str, len);
617  beentry->st_activity_raw[len] = '\0';
618  beentry->st_activity_start_timestamp = start_timestamp;
619  }
620 
621  PGSTAT_END_WRITE_ACTIVITY(beentry);
622 }
void TimestampDifference(TimestampTz start_time, TimestampTz stop_time, long *secs, int *microsecs)
Definition: timestamp.c:1664
Datum current_timestamp(PG_FUNCTION_ARGS)
Definition: timestamp.c:1591
TimestampTz GetCurrentTimestamp(void)
Definition: timestamp.c:1573
bool pgstat_track_activities
int64 TimestampTz
Definition: timestamp.h:39
const void size_t len
#define pgstat_count_conn_txn_idle_time(n)
Definition: pgstat.h:474
#define pgstat_count_conn_active_time(n)
Definition: pgstat.h:472
int64 PgStat_Counter
Definition: pgstat.h:88
PGPROC * MyProc
Definition: proc.c:68
Definition: proc.h:162
uint32 wait_event_info
Definition: proc.h:270
Definition: regguts.h:318
TimestampTz GetCurrentStatementStartTimestamp(void)
Definition: xact.c:863

References current_timestamp(), GetCurrentStatementStartTimestamp(), GetCurrentTimestamp(), len, Min, MyBEEntry, MyProc, PGSTAT_BEGIN_WRITE_ACTIVITY, pgstat_count_conn_active_time, pgstat_count_conn_txn_idle_time, PGSTAT_END_WRITE_ACTIVITY, pgstat_track_activities, pgstat_track_activity_query_size, PgBackendStatus::st_activity_raw, PgBackendStatus::st_activity_start_timestamp, PgBackendStatus::st_query_id, PgBackendStatus::st_state, PgBackendStatus::st_state_start_timestamp, PgBackendStatus::st_xact_start_timestamp, STATE_DISABLED, STATE_FASTPATH, STATE_IDLEINTRANSACTION, STATE_IDLEINTRANSACTION_ABORTED, STATE_RUNNING, TimestampDifference(), and PGPROC::wait_event_info.

Referenced by _bt_parallel_build_main(), apply_handle_begin(), apply_handle_begin_prepare(), apply_handle_commit(), apply_handle_commit_prepared(), apply_handle_prepare(), apply_handle_rollback_prepared(), apply_handle_stream_commit(), apply_handle_stream_prepare(), apply_handle_stream_start(), apply_handle_stream_stop(), apply_spooled_messages(), autovac_report_activity(), autovac_report_workitem(), exec_bind_message(), exec_execute_message(), exec_parse_message(), exec_replication_command(), exec_simple_query(), initialize_worker_spi(), LogicalRepApplyLoop(), parallel_vacuum_main(), ParallelQueryMain(), and PostgresMain().

◆ pgstat_report_appname()

void pgstat_report_appname ( const char *  appname)

Definition at line 671 of file backend_status.c.

672 {
673  volatile PgBackendStatus *beentry = MyBEEntry;
674  int len;
675 
676  if (!beentry)
677  return;
678 
679  /* This should be unnecessary if GUC did its job, but be safe */
680  len = pg_mbcliplen(appname, strlen(appname), NAMEDATALEN - 1);
681 
682  /*
683  * Update my status entry, following the protocol of bumping
684  * st_changecount before and after. We use a volatile pointer here to
685  * ensure the compiler doesn't try to get cute.
686  */
688 
689  memcpy((char *) beentry->st_appname, appname, len);
690  beentry->st_appname[len] = '\0';
691 
692  PGSTAT_END_WRITE_ACTIVITY(beentry);
693 }

References len, MyBEEntry, NAMEDATALEN, pg_mbcliplen(), PGSTAT_BEGIN_WRITE_ACTIVITY, PGSTAT_END_WRITE_ACTIVITY, and PgBackendStatus::st_appname.

Referenced by assign_application_name(), and pgstat_bestart().

◆ pgstat_report_query_id()

void pgstat_report_query_id ( uint64  query_id,
bool  force 
)

Definition at line 631 of file backend_status.c.

632 {
633  volatile PgBackendStatus *beentry = MyBEEntry;
634 
635  /*
636  * if track_activities is disabled, st_query_id should already have been
637  * reset
638  */
639  if (!beentry || !pgstat_track_activities)
640  return;
641 
642  /*
643  * We only report the top-level query identifiers. The stored query_id is
644  * reset when a backend calls pgstat_report_activity(STATE_RUNNING), or
645  * with an explicit call to this function using the force flag. If the
646  * saved query identifier is not zero it means that it's not a top-level
647  * command, so ignore the one provided unless it's an explicit call to
648  * reset the identifier.
649  */
650  if (beentry->st_query_id != 0 && !force)
651  return;
652 
653  /*
654  * Update my status entry, following the protocol of bumping
655  * st_changecount before and after. We use a volatile pointer here to
656  * ensure the compiler doesn't try to get cute.
657  */
659  beentry->st_query_id = query_id;
660  PGSTAT_END_WRITE_ACTIVITY(beentry);
661 }

References MyBEEntry, PGSTAT_BEGIN_WRITE_ACTIVITY, PGSTAT_END_WRITE_ACTIVITY, pgstat_track_activities, and PgBackendStatus::st_query_id.

Referenced by exec_simple_query(), ExecutorStart(), parse_analyze_fixedparams(), parse_analyze_varparams(), and parse_analyze_withcb().

◆ pgstat_report_tempfile()

void pgstat_report_tempfile ( size_t  filesize)

Definition at line 172 of file pgstat_database.c.

173 {
174  PgStat_StatDBEntry *dbent;
175 
176  if (!pgstat_track_counts)
177  return;
178 
180  dbent->n_temp_bytes += filesize;
181  dbent->n_temp_files++;
182 }
bool pgstat_track_counts
Definition: pgstat.c:186
PgStat_StatDBEntry * pgstat_prep_database_pending(Oid dboid)
PgStat_Counter n_temp_bytes
Definition: pgstat.h:297
PgStat_Counter n_temp_files
Definition: pgstat.h:296

References MyDatabaseId, PgStat_StatDBEntry::n_temp_bytes, PgStat_StatDBEntry::n_temp_files, pgstat_prep_database_pending(), and pgstat_track_counts.

Referenced by ReportTemporaryFileUsage().

◆ pgstat_report_xact_timestamp()

void pgstat_report_xact_timestamp ( TimestampTz  tstamp)

Definition at line 700 of file backend_status.c.

701 {
702  volatile PgBackendStatus *beentry = MyBEEntry;
703 
704  if (!pgstat_track_activities || !beentry)
705  return;
706 
707  /*
708  * Update my status entry, following the protocol of bumping
709  * st_changecount before and after. We use a volatile pointer here to
710  * ensure the compiler doesn't try to get cute.
711  */
713 
714  beentry->st_xact_start_timestamp = tstamp;
715 
716  PGSTAT_END_WRITE_ACTIVITY(beentry);
717 }

References MyBEEntry, PGSTAT_BEGIN_WRITE_ACTIVITY, PGSTAT_END_WRITE_ACTIVITY, pgstat_track_activities, and PgBackendStatus::st_xact_start_timestamp.

Referenced by AbortTransaction(), CommitTransaction(), PrepareTransaction(), and StartTransaction().

Variable Documentation

◆ MyBEEntry

◆ pgstat_track_activities

◆ pgstat_track_activity_query_size