]> granicus.if.org Git - postgresql/blob - src/backend/postmaster/pgstat.c
Publish checkpoint timing information to pg_stat_bgwriter.
[postgresql] / src / backend / postmaster / pgstat.c
1 /* ----------
2  * pgstat.c
3  *
4  *      All the statistics collector stuff hacked up in one big, ugly file.
5  *
6  *      TODO:   - Separate collector, postmaster and backend stuff
7  *                        into different files.
8  *
9  *                      - Add some automatic call for pgstat vacuuming.
10  *
11  *                      - Add a pgstat config column to pg_database, so this
12  *                        entire thing can be enabled/disabled on a per db basis.
13  *
14  *      Copyright (c) 2001-2012, PostgreSQL Global Development Group
15  *
16  *      src/backend/postmaster/pgstat.c
17  * ----------
18  */
19 #include "postgres.h"
20
21 #include <unistd.h>
22 #include <fcntl.h>
23 #include <sys/param.h>
24 #include <sys/time.h>
25 #include <sys/socket.h>
26 #include <netdb.h>
27 #include <netinet/in.h>
28 #include <arpa/inet.h>
29 #include <signal.h>
30 #include <time.h>
31 #ifdef HAVE_POLL_H
32 #include <poll.h>
33 #endif
34 #ifdef HAVE_SYS_POLL_H
35 #include <sys/poll.h>
36 #endif
37
38 #include "pgstat.h"
39
40 #include "access/heapam.h"
41 #include "access/transam.h"
42 #include "access/twophase_rmgr.h"
43 #include "access/xact.h"
44 #include "catalog/pg_database.h"
45 #include "catalog/pg_proc.h"
46 #include "libpq/ip.h"
47 #include "libpq/libpq.h"
48 #include "libpq/pqsignal.h"
49 #include "mb/pg_wchar.h"
50 #include "miscadmin.h"
51 #include "pg_trace.h"
52 #include "postmaster/autovacuum.h"
53 #include "postmaster/fork_process.h"
54 #include "postmaster/postmaster.h"
55 #include "storage/backendid.h"
56 #include "storage/fd.h"
57 #include "storage/ipc.h"
58 #include "storage/pg_shmem.h"
59 #include "storage/pmsignal.h"
60 #include "storage/procsignal.h"
61 #include "utils/ascii.h"
62 #include "utils/guc.h"
63 #include "utils/memutils.h"
64 #include "utils/ps_status.h"
65 #include "utils/rel.h"
66 #include "utils/timestamp.h"
67 #include "utils/tqual.h"
68
69
70 /* ----------
71  * Paths for the statistics files (relative to installation's $PGDATA).
72  * ----------
73  */
74 #define PGSTAT_STAT_PERMANENT_FILENAME          "global/pgstat.stat"
75 #define PGSTAT_STAT_PERMANENT_TMPFILE           "global/pgstat.tmp"
76
77 /* ----------
78  * Timer definitions.
79  * ----------
80  */
81 #define PGSTAT_STAT_INTERVAL    500             /* Minimum time between stats file
82                                                                                  * updates; in milliseconds. */
83
84 #define PGSTAT_RETRY_DELAY              10              /* How long to wait between checks for
85                                                                                  * a new file; in milliseconds. */
86
87 #define PGSTAT_MAX_WAIT_TIME    10000   /* Maximum time to wait for a stats
88                                                                                  * file update; in milliseconds. */
89
90 #define PGSTAT_INQ_INTERVAL             640             /* How often to ping the collector for
91                                                                                  * a new file; in milliseconds. */
92
93 #define PGSTAT_RESTART_INTERVAL 60              /* How often to attempt to restart a
94                                                                                  * failed statistics collector; in
95                                                                                  * seconds. */
96
97 #define PGSTAT_SELECT_TIMEOUT   2               /* How often to check for postmaster
98                                                                                  * death; in seconds. */
99
100 #define PGSTAT_POLL_LOOP_COUNT  (PGSTAT_MAX_WAIT_TIME / PGSTAT_RETRY_DELAY)
101 #define PGSTAT_INQ_LOOP_COUNT   (PGSTAT_INQ_INTERVAL / PGSTAT_RETRY_DELAY)
102
103
104 /* ----------
105  * The initial size hints for the hash tables used in the collector.
106  * ----------
107  */
108 #define PGSTAT_DB_HASH_SIZE             16
109 #define PGSTAT_TAB_HASH_SIZE    512
110 #define PGSTAT_FUNCTION_HASH_SIZE       512
111
112
113 /* ----------
114  * GUC parameters
115  * ----------
116  */
117 bool            pgstat_track_activities = false;
118 bool            pgstat_track_counts = false;
119 int                     pgstat_track_functions = TRACK_FUNC_OFF;
120 int                     pgstat_track_activity_query_size = 1024;
121
122 /* ----------
123  * Built from GUC parameter
124  * ----------
125  */
126 char       *pgstat_stat_filename = NULL;
127 char       *pgstat_stat_tmpname = NULL;
128
129 /*
130  * BgWriter global statistics counters (unused in other processes).
131  * Stored directly in a stats message structure so it can be sent
132  * without needing to copy things around.  We assume this inits to zeroes.
133  */
134 PgStat_MsgBgWriter BgWriterStats;
135
136 /* ----------
137  * Local data
138  * ----------
139  */
140 NON_EXEC_STATIC pgsocket pgStatSock = PGINVALID_SOCKET;
141
142 static struct sockaddr_storage pgStatAddr;
143
144 static time_t last_pgstat_start_time;
145
146 static bool pgStatRunningInCollector = false;
147
148 /*
149  * Structures in which backends store per-table info that's waiting to be
150  * sent to the collector.
151  *
152  * NOTE: once allocated, TabStatusArray structures are never moved or deleted
153  * for the life of the backend.  Also, we zero out the t_id fields of the
154  * contained PgStat_TableStatus structs whenever they are not actively in use.
155  * This allows relcache pgstat_info pointers to be treated as long-lived data,
156  * avoiding repeated searches in pgstat_initstats() when a relation is
157  * repeatedly opened during a transaction.
158  */
159 #define TABSTAT_QUANTUM         100 /* we alloc this many at a time */
160
161 typedef struct TabStatusArray
162 {
163         struct TabStatusArray *tsa_next;        /* link to next array, if any */
164         int                     tsa_used;               /* # entries currently used */
165         PgStat_TableStatus tsa_entries[TABSTAT_QUANTUM];        /* per-table data */
166 } TabStatusArray;
167
168 static TabStatusArray *pgStatTabList = NULL;
169
170 /*
171  * Backends store per-function info that's waiting to be sent to the collector
172  * in this hash table (indexed by function OID).
173  */
174 static HTAB *pgStatFunctions = NULL;
175
176 /*
177  * Indicates if backend has some function stats that it hasn't yet
178  * sent to the collector.
179  */
180 static bool have_function_stats = false;
181
182 /*
183  * Tuple insertion/deletion counts for an open transaction can't be propagated
184  * into PgStat_TableStatus counters until we know if it is going to commit
185  * or abort.  Hence, we keep these counts in per-subxact structs that live
186  * in TopTransactionContext.  This data structure is designed on the assumption
187  * that subxacts won't usually modify very many tables.
188  */
189 typedef struct PgStat_SubXactStatus
190 {
191         int                     nest_level;             /* subtransaction nest level */
192         struct PgStat_SubXactStatus *prev;      /* higher-level subxact if any */
193         PgStat_TableXactStatus *first;          /* head of list for this subxact */
194 } PgStat_SubXactStatus;
195
196 static PgStat_SubXactStatus *pgStatXactStack = NULL;
197
198 static int      pgStatXactCommit = 0;
199 static int      pgStatXactRollback = 0;
200 PgStat_Counter pgStatBlockTimeRead = 0;
201 PgStat_Counter pgStatBlockTimeWrite = 0;
202
203 /* Record that's written to 2PC state file when pgstat state is persisted */
204 typedef struct TwoPhasePgStatRecord
205 {
206         PgStat_Counter tuples_inserted;         /* tuples inserted in xact */
207         PgStat_Counter tuples_updated;          /* tuples updated in xact */
208         PgStat_Counter tuples_deleted;          /* tuples deleted in xact */
209         Oid                     t_id;                   /* table's OID */
210         bool            t_shared;               /* is it a shared catalog? */
211 } TwoPhasePgStatRecord;
212
213 /*
214  * Info about current "snapshot" of stats file
215  */
216 static MemoryContext pgStatLocalContext = NULL;
217 static HTAB *pgStatDBHash = NULL;
218 static PgBackendStatus *localBackendStatusTable = NULL;
219 static int      localNumBackends = 0;
220
221 /*
222  * Cluster wide statistics, kept in the stats collector.
223  * Contains statistics that are not collected per database
224  * or per table.
225  */
226 static PgStat_GlobalStats globalStats;
227
228 /* Last time the collector successfully wrote the stats file */
229 static TimestampTz last_statwrite;
230
231 /* Latest statistics request time from backends */
232 static TimestampTz last_statrequest;
233
234 static volatile bool need_exit = false;
235 static volatile bool got_SIGHUP = false;
236
237 /*
238  * Total time charged to functions so far in the current backend.
239  * We use this to help separate "self" and "other" time charges.
240  * (We assume this initializes to zero.)
241  */
242 static instr_time total_func_time;
243
244
245 /* ----------
246  * Local function forward declarations
247  * ----------
248  */
249 #ifdef EXEC_BACKEND
250 static pid_t pgstat_forkexec(void);
251 #endif
252
253 NON_EXEC_STATIC void PgstatCollectorMain(int argc, char *argv[]);
254 static void pgstat_exit(SIGNAL_ARGS);
255 static void pgstat_beshutdown_hook(int code, Datum arg);
256 static void pgstat_sighup_handler(SIGNAL_ARGS);
257
258 static PgStat_StatDBEntry *pgstat_get_db_entry(Oid databaseid, bool create);
259 static PgStat_StatTabEntry *pgstat_get_tab_entry(PgStat_StatDBEntry *dbentry,
260                                          Oid tableoid, bool create);
261 static void pgstat_write_statsfile(bool permanent);
262 static HTAB *pgstat_read_statsfile(Oid onlydb, bool permanent);
263 static void backend_read_statsfile(void);
264 static void pgstat_read_current_status(void);
265
266 static void pgstat_send_tabstat(PgStat_MsgTabstat *tsmsg);
267 static void pgstat_send_funcstats(void);
268 static HTAB *pgstat_collect_oids(Oid catalogid);
269
270 static PgStat_TableStatus *get_tabstat_entry(Oid rel_id, bool isshared);
271
272 static void pgstat_setup_memcxt(void);
273
274 static void pgstat_setheader(PgStat_MsgHdr *hdr, StatMsgType mtype);
275 static void pgstat_send(void *msg, int len);
276
277 static void pgstat_recv_inquiry(PgStat_MsgInquiry *msg, int len);
278 static void pgstat_recv_tabstat(PgStat_MsgTabstat *msg, int len);
279 static void pgstat_recv_tabpurge(PgStat_MsgTabpurge *msg, int len);
280 static void pgstat_recv_dropdb(PgStat_MsgDropdb *msg, int len);
281 static void pgstat_recv_resetcounter(PgStat_MsgResetcounter *msg, int len);
282 static void pgstat_recv_resetsharedcounter(PgStat_MsgResetsharedcounter *msg, int len);
283 static void pgstat_recv_resetsinglecounter(PgStat_MsgResetsinglecounter *msg, int len);
284 static void pgstat_recv_autovac(PgStat_MsgAutovacStart *msg, int len);
285 static void pgstat_recv_vacuum(PgStat_MsgVacuum *msg, int len);
286 static void pgstat_recv_analyze(PgStat_MsgAnalyze *msg, int len);
287 static void pgstat_recv_bgwriter(PgStat_MsgBgWriter *msg, int len);
288 static void pgstat_recv_funcstat(PgStat_MsgFuncstat *msg, int len);
289 static void pgstat_recv_funcpurge(PgStat_MsgFuncpurge *msg, int len);
290 static void pgstat_recv_recoveryconflict(PgStat_MsgRecoveryConflict *msg, int len);
291 static void pgstat_recv_deadlock(PgStat_MsgDeadlock *msg, int len);
292 static void pgstat_recv_tempfile(PgStat_MsgTempFile *msg, int len);
293
294
295 /* ------------------------------------------------------------
296  * Public functions called from postmaster follow
297  * ------------------------------------------------------------
298  */
299
300 /* ----------
301  * pgstat_init() -
302  *
303  *      Called from postmaster at startup. Create the resources required
304  *      by the statistics collector process.  If unable to do so, do not
305  *      fail --- better to let the postmaster start with stats collection
306  *      disabled.
307  * ----------
308  */
309 void
310 pgstat_init(void)
311 {
312         ACCEPT_TYPE_ARG3 alen;
313         struct addrinfo *addrs = NULL,
314                            *addr,
315                                 hints;
316         int                     ret;
317         fd_set          rset;
318         struct timeval tv;
319         char            test_byte;
320         int                     sel_res;
321         int                     tries = 0;
322
323 #define TESTBYTEVAL ((char) 199)
324
325         /*
326          * Create the UDP socket for sending and receiving statistic messages
327          */
328         hints.ai_flags = AI_PASSIVE;
329         hints.ai_family = PF_UNSPEC;
330         hints.ai_socktype = SOCK_DGRAM;
331         hints.ai_protocol = 0;
332         hints.ai_addrlen = 0;
333         hints.ai_addr = NULL;
334         hints.ai_canonname = NULL;
335         hints.ai_next = NULL;
336         ret = pg_getaddrinfo_all("localhost", NULL, &hints, &addrs);
337         if (ret || !addrs)
338         {
339                 ereport(LOG,
340                                 (errmsg("could not resolve \"localhost\": %s",
341                                                 gai_strerror(ret))));
342                 goto startup_failed;
343         }
344
345         /*
346          * On some platforms, pg_getaddrinfo_all() may return multiple addresses
347          * only one of which will actually work (eg, both IPv6 and IPv4 addresses
348          * when kernel will reject IPv6).  Worse, the failure may occur at the
349          * bind() or perhaps even connect() stage.      So we must loop through the
350          * results till we find a working combination. We will generate LOG
351          * messages, but no error, for bogus combinations.
352          */
353         for (addr = addrs; addr; addr = addr->ai_next)
354         {
355 #ifdef HAVE_UNIX_SOCKETS
356                 /* Ignore AF_UNIX sockets, if any are returned. */
357                 if (addr->ai_family == AF_UNIX)
358                         continue;
359 #endif
360
361                 if (++tries > 1)
362                         ereport(LOG,
363                         (errmsg("trying another address for the statistics collector")));
364
365                 /*
366                  * Create the socket.
367                  */
368                 if ((pgStatSock = socket(addr->ai_family, SOCK_DGRAM, 0)) == PGINVALID_SOCKET)
369                 {
370                         ereport(LOG,
371                                         (errcode_for_socket_access(),
372                         errmsg("could not create socket for statistics collector: %m")));
373                         continue;
374                 }
375
376                 /*
377                  * Bind it to a kernel assigned port on localhost and get the assigned
378                  * port via getsockname().
379                  */
380                 if (bind(pgStatSock, addr->ai_addr, addr->ai_addrlen) < 0)
381                 {
382                         ereport(LOG,
383                                         (errcode_for_socket_access(),
384                           errmsg("could not bind socket for statistics collector: %m")));
385                         closesocket(pgStatSock);
386                         pgStatSock = PGINVALID_SOCKET;
387                         continue;
388                 }
389
390                 alen = sizeof(pgStatAddr);
391                 if (getsockname(pgStatSock, (struct sockaddr *) & pgStatAddr, &alen) < 0)
392                 {
393                         ereport(LOG,
394                                         (errcode_for_socket_access(),
395                                          errmsg("could not get address of socket for statistics collector: %m")));
396                         closesocket(pgStatSock);
397                         pgStatSock = PGINVALID_SOCKET;
398                         continue;
399                 }
400
401                 /*
402                  * Connect the socket to its own address.  This saves a few cycles by
403                  * not having to respecify the target address on every send. This also
404                  * provides a kernel-level check that only packets from this same
405                  * address will be received.
406                  */
407                 if (connect(pgStatSock, (struct sockaddr *) & pgStatAddr, alen) < 0)
408                 {
409                         ereport(LOG,
410                                         (errcode_for_socket_access(),
411                         errmsg("could not connect socket for statistics collector: %m")));
412                         closesocket(pgStatSock);
413                         pgStatSock = PGINVALID_SOCKET;
414                         continue;
415                 }
416
417                 /*
418                  * Try to send and receive a one-byte test message on the socket. This
419                  * is to catch situations where the socket can be created but will not
420                  * actually pass data (for instance, because kernel packet filtering
421                  * rules prevent it).
422                  */
423                 test_byte = TESTBYTEVAL;
424
425 retry1:
426                 if (send(pgStatSock, &test_byte, 1, 0) != 1)
427                 {
428                         if (errno == EINTR)
429                                 goto retry1;    /* if interrupted, just retry */
430                         ereport(LOG,
431                                         (errcode_for_socket_access(),
432                                          errmsg("could not send test message on socket for statistics collector: %m")));
433                         closesocket(pgStatSock);
434                         pgStatSock = PGINVALID_SOCKET;
435                         continue;
436                 }
437
438                 /*
439                  * There could possibly be a little delay before the message can be
440                  * received.  We arbitrarily allow up to half a second before deciding
441                  * it's broken.
442                  */
443                 for (;;)                                /* need a loop to handle EINTR */
444                 {
445                         FD_ZERO(&rset);
446                         FD_SET(pgStatSock, &rset);
447
448                         tv.tv_sec = 0;
449                         tv.tv_usec = 500000;
450                         sel_res = select(pgStatSock + 1, &rset, NULL, NULL, &tv);
451                         if (sel_res >= 0 || errno != EINTR)
452                                 break;
453                 }
454                 if (sel_res < 0)
455                 {
456                         ereport(LOG,
457                                         (errcode_for_socket_access(),
458                                          errmsg("select() failed in statistics collector: %m")));
459                         closesocket(pgStatSock);
460                         pgStatSock = PGINVALID_SOCKET;
461                         continue;
462                 }
463                 if (sel_res == 0 || !FD_ISSET(pgStatSock, &rset))
464                 {
465                         /*
466                          * This is the case we actually think is likely, so take pains to
467                          * give a specific message for it.
468                          *
469                          * errno will not be set meaningfully here, so don't use it.
470                          */
471                         ereport(LOG,
472                                         (errcode(ERRCODE_CONNECTION_FAILURE),
473                                          errmsg("test message did not get through on socket for statistics collector")));
474                         closesocket(pgStatSock);
475                         pgStatSock = PGINVALID_SOCKET;
476                         continue;
477                 }
478
479                 test_byte++;                    /* just make sure variable is changed */
480
481 retry2:
482                 if (recv(pgStatSock, &test_byte, 1, 0) != 1)
483                 {
484                         if (errno == EINTR)
485                                 goto retry2;    /* if interrupted, just retry */
486                         ereport(LOG,
487                                         (errcode_for_socket_access(),
488                                          errmsg("could not receive test message on socket for statistics collector: %m")));
489                         closesocket(pgStatSock);
490                         pgStatSock = PGINVALID_SOCKET;
491                         continue;
492                 }
493
494                 if (test_byte != TESTBYTEVAL)   /* strictly paranoia ... */
495                 {
496                         ereport(LOG,
497                                         (errcode(ERRCODE_INTERNAL_ERROR),
498                                          errmsg("incorrect test message transmission on socket for statistics collector")));
499                         closesocket(pgStatSock);
500                         pgStatSock = PGINVALID_SOCKET;
501                         continue;
502                 }
503
504                 /* If we get here, we have a working socket */
505                 break;
506         }
507
508         /* Did we find a working address? */
509         if (!addr || pgStatSock == PGINVALID_SOCKET)
510                 goto startup_failed;
511
512         /*
513          * Set the socket to non-blocking IO.  This ensures that if the collector
514          * falls behind, statistics messages will be discarded; backends won't
515          * block waiting to send messages to the collector.
516          */
517         if (!pg_set_noblock(pgStatSock))
518         {
519                 ereport(LOG,
520                                 (errcode_for_socket_access(),
521                                  errmsg("could not set statistics collector socket to nonblocking mode: %m")));
522                 goto startup_failed;
523         }
524
525         pg_freeaddrinfo_all(hints.ai_family, addrs);
526
527         return;
528
529 startup_failed:
530         ereport(LOG,
531           (errmsg("disabling statistics collector for lack of working socket")));
532
533         if (addrs)
534                 pg_freeaddrinfo_all(hints.ai_family, addrs);
535
536         if (pgStatSock != PGINVALID_SOCKET)
537                 closesocket(pgStatSock);
538         pgStatSock = PGINVALID_SOCKET;
539
540         /*
541          * Adjust GUC variables to suppress useless activity, and for debugging
542          * purposes (seeing track_counts off is a clue that we failed here). We
543          * use PGC_S_OVERRIDE because there is no point in trying to turn it back
544          * on from postgresql.conf without a restart.
545          */
546         SetConfigOption("track_counts", "off", PGC_INTERNAL, PGC_S_OVERRIDE);
547 }
548
549 /*
550  * pgstat_reset_all() -
551  *
552  * Remove the stats file.  This is currently used only if WAL
553  * recovery is needed after a crash.
554  */
555 void
556 pgstat_reset_all(void)
557 {
558         unlink(pgstat_stat_filename);
559         unlink(PGSTAT_STAT_PERMANENT_FILENAME);
560 }
561
562 #ifdef EXEC_BACKEND
563
564 /*
565  * pgstat_forkexec() -
566  *
567  * Format up the arglist for, then fork and exec, statistics collector process
568  */
569 static pid_t
570 pgstat_forkexec(void)
571 {
572         char       *av[10];
573         int                     ac = 0;
574
575         av[ac++] = "postgres";
576         av[ac++] = "--forkcol";
577         av[ac++] = NULL;                        /* filled in by postmaster_forkexec */
578
579         av[ac] = NULL;
580         Assert(ac < lengthof(av));
581
582         return postmaster_forkexec(ac, av);
583 }
584 #endif   /* EXEC_BACKEND */
585
586
587 /*
588  * pgstat_start() -
589  *
590  *      Called from postmaster at startup or after an existing collector
591  *      died.  Attempt to fire up a fresh statistics collector.
592  *
593  *      Returns PID of child process, or 0 if fail.
594  *
595  *      Note: if fail, we will be called again from the postmaster main loop.
596  */
597 int
598 pgstat_start(void)
599 {
600         time_t          curtime;
601         pid_t           pgStatPid;
602
603         /*
604          * Check that the socket is there, else pgstat_init failed and we can do
605          * nothing useful.
606          */
607         if (pgStatSock == PGINVALID_SOCKET)
608                 return 0;
609
610         /*
611          * Do nothing if too soon since last collector start.  This is a safety
612          * valve to protect against continuous respawn attempts if the collector
613          * is dying immediately at launch.      Note that since we will be re-called
614          * from the postmaster main loop, we will get another chance later.
615          */
616         curtime = time(NULL);
617         if ((unsigned int) (curtime - last_pgstat_start_time) <
618                 (unsigned int) PGSTAT_RESTART_INTERVAL)
619                 return 0;
620         last_pgstat_start_time = curtime;
621
622         /*
623          * Okay, fork off the collector.
624          */
625 #ifdef EXEC_BACKEND
626         switch ((pgStatPid = pgstat_forkexec()))
627 #else
628         switch ((pgStatPid = fork_process()))
629 #endif
630         {
631                 case -1:
632                         ereport(LOG,
633                                         (errmsg("could not fork statistics collector: %m")));
634                         return 0;
635
636 #ifndef EXEC_BACKEND
637                 case 0:
638                         /* in postmaster child ... */
639                         /* Close the postmaster's sockets */
640                         ClosePostmasterPorts(false);
641
642                         /* Lose the postmaster's on-exit routines */
643                         on_exit_reset();
644
645                         /* Drop our connection to postmaster's shared memory, as well */
646                         PGSharedMemoryDetach();
647
648                         PgstatCollectorMain(0, NULL);
649                         break;
650 #endif
651
652                 default:
653                         return (int) pgStatPid;
654         }
655
656         /* shouldn't get here */
657         return 0;
658 }
659
660 void
661 allow_immediate_pgstat_restart(void)
662 {
663         last_pgstat_start_time = 0;
664 }
665
666 /* ------------------------------------------------------------
667  * Public functions used by backends follow
668  *------------------------------------------------------------
669  */
670
671
672 /* ----------
673  * pgstat_report_stat() -
674  *
675  *      Called from tcop/postgres.c to send the so far collected per-table
676  *      and function usage statistics to the collector.  Note that this is
677  *      called only when not within a transaction, so it is fair to use
678  *      transaction stop time as an approximation of current time.
679  * ----------
680  */
681 void
682 pgstat_report_stat(bool force)
683 {
684         /* we assume this inits to all zeroes: */
685         static const PgStat_TableCounts all_zeroes;
686         static TimestampTz last_report = 0;
687
688         TimestampTz now;
689         PgStat_MsgTabstat regular_msg;
690         PgStat_MsgTabstat shared_msg;
691         TabStatusArray *tsa;
692         int                     i;
693
694         /* Don't expend a clock check if nothing to do */
695         if ((pgStatTabList == NULL || pgStatTabList->tsa_used == 0)
696                 && !have_function_stats)
697                 return;
698
699         /*
700          * Don't send a message unless it's been at least PGSTAT_STAT_INTERVAL
701          * msec since we last sent one, or the caller wants to force stats out.
702          */
703         now = GetCurrentTransactionStopTimestamp();
704         if (!force &&
705                 !TimestampDifferenceExceeds(last_report, now, PGSTAT_STAT_INTERVAL))
706                 return;
707         last_report = now;
708
709         /*
710          * Scan through the TabStatusArray struct(s) to find tables that actually
711          * have counts, and build messages to send.  We have to separate shared
712          * relations from regular ones because the databaseid field in the message
713          * header has to depend on that.
714          */
715         regular_msg.m_databaseid = MyDatabaseId;
716         shared_msg.m_databaseid = InvalidOid;
717         regular_msg.m_nentries = 0;
718         shared_msg.m_nentries = 0;
719
720         for (tsa = pgStatTabList; tsa != NULL; tsa = tsa->tsa_next)
721         {
722                 for (i = 0; i < tsa->tsa_used; i++)
723                 {
724                         PgStat_TableStatus *entry = &tsa->tsa_entries[i];
725                         PgStat_MsgTabstat *this_msg;
726                         PgStat_TableEntry *this_ent;
727
728                         /* Shouldn't have any pending transaction-dependent counts */
729                         Assert(entry->trans == NULL);
730
731                         /*
732                          * Ignore entries that didn't accumulate any actual counts, such
733                          * as indexes that were opened by the planner but not used.
734                          */
735                         if (memcmp(&entry->t_counts, &all_zeroes,
736                                            sizeof(PgStat_TableCounts)) == 0)
737                                 continue;
738
739                         /*
740                          * OK, insert data into the appropriate message, and send if full.
741                          */
742                         this_msg = entry->t_shared ? &shared_msg : &regular_msg;
743                         this_ent = &this_msg->m_entry[this_msg->m_nentries];
744                         this_ent->t_id = entry->t_id;
745                         memcpy(&this_ent->t_counts, &entry->t_counts,
746                                    sizeof(PgStat_TableCounts));
747                         if (++this_msg->m_nentries >= PGSTAT_NUM_TABENTRIES)
748                         {
749                                 pgstat_send_tabstat(this_msg);
750                                 this_msg->m_nentries = 0;
751                         }
752                 }
753                 /* zero out TableStatus structs after use */
754                 MemSet(tsa->tsa_entries, 0,
755                            tsa->tsa_used * sizeof(PgStat_TableStatus));
756                 tsa->tsa_used = 0;
757         }
758
759         /*
760          * Send partial messages.  If force is true, make sure that any pending
761          * xact commit/abort gets counted, even if no table stats to send.
762          */
763         if (regular_msg.m_nentries > 0 ||
764                 (force && (pgStatXactCommit > 0 || pgStatXactRollback > 0)))
765                 pgstat_send_tabstat(&regular_msg);
766         if (shared_msg.m_nentries > 0)
767                 pgstat_send_tabstat(&shared_msg);
768
769         /* Now, send function statistics */
770         pgstat_send_funcstats();
771 }
772
773 /*
774  * Subroutine for pgstat_report_stat: finish and send a tabstat message
775  */
776 static void
777 pgstat_send_tabstat(PgStat_MsgTabstat *tsmsg)
778 {
779         int                     n;
780         int                     len;
781
782         /* It's unlikely we'd get here with no socket, but maybe not impossible */
783         if (pgStatSock == PGINVALID_SOCKET)
784                 return;
785
786         /*
787          * Report accumulated xact commit/rollback and I/O timings whenever we send
788          * a normal tabstat message
789          */
790         if (OidIsValid(tsmsg->m_databaseid))
791         {
792                 tsmsg->m_xact_commit = pgStatXactCommit;
793                 tsmsg->m_xact_rollback = pgStatXactRollback;
794                 tsmsg->m_block_time_read = pgStatBlockTimeRead;
795                 tsmsg->m_block_time_write = pgStatBlockTimeWrite;
796                 pgStatXactCommit = 0;
797                 pgStatXactRollback = 0;
798         }
799         else
800         {
801                 tsmsg->m_xact_commit = 0;
802                 tsmsg->m_xact_rollback = 0;
803                 tsmsg->m_block_time_read = 0;
804                 tsmsg->m_block_time_write = 0;
805         }
806
807         n = tsmsg->m_nentries;
808         len = offsetof(PgStat_MsgTabstat, m_entry[0]) +
809                 n * sizeof(PgStat_TableEntry);
810
811         pgstat_setheader(&tsmsg->m_hdr, PGSTAT_MTYPE_TABSTAT);
812         pgstat_send(tsmsg, len);
813 }
814
815 /*
816  * Subroutine for pgstat_report_stat: populate and send a function stat message
817  */
818 static void
819 pgstat_send_funcstats(void)
820 {
821         /* we assume this inits to all zeroes: */
822         static const PgStat_FunctionCounts all_zeroes;
823
824         PgStat_MsgFuncstat msg;
825         PgStat_BackendFunctionEntry *entry;
826         HASH_SEQ_STATUS fstat;
827
828         if (pgStatFunctions == NULL)
829                 return;
830
831         pgstat_setheader(&msg.m_hdr, PGSTAT_MTYPE_FUNCSTAT);
832         msg.m_databaseid = MyDatabaseId;
833         msg.m_nentries = 0;
834
835         hash_seq_init(&fstat, pgStatFunctions);
836         while ((entry = (PgStat_BackendFunctionEntry *) hash_seq_search(&fstat)) != NULL)
837         {
838                 PgStat_FunctionEntry *m_ent;
839
840                 /* Skip it if no counts accumulated since last time */
841                 if (memcmp(&entry->f_counts, &all_zeroes,
842                                    sizeof(PgStat_FunctionCounts)) == 0)
843                         continue;
844
845                 /* need to convert format of time accumulators */
846                 m_ent = &msg.m_entry[msg.m_nentries];
847                 m_ent->f_id = entry->f_id;
848                 m_ent->f_numcalls = entry->f_counts.f_numcalls;
849                 m_ent->f_time = INSTR_TIME_GET_MICROSEC(entry->f_counts.f_time);
850                 m_ent->f_time_self = INSTR_TIME_GET_MICROSEC(entry->f_counts.f_time_self);
851
852                 if (++msg.m_nentries >= PGSTAT_NUM_FUNCENTRIES)
853                 {
854                         pgstat_send(&msg, offsetof(PgStat_MsgFuncstat, m_entry[0]) +
855                                                 msg.m_nentries * sizeof(PgStat_FunctionEntry));
856                         msg.m_nentries = 0;
857                 }
858
859                 /* reset the entry's counts */
860                 MemSet(&entry->f_counts, 0, sizeof(PgStat_FunctionCounts));
861         }
862
863         if (msg.m_nentries > 0)
864                 pgstat_send(&msg, offsetof(PgStat_MsgFuncstat, m_entry[0]) +
865                                         msg.m_nentries * sizeof(PgStat_FunctionEntry));
866
867         have_function_stats = false;
868 }
869
870
871 /* ----------
872  * pgstat_vacuum_stat() -
873  *
874  *      Will tell the collector about objects he can get rid of.
875  * ----------
876  */
877 void
878 pgstat_vacuum_stat(void)
879 {
880         HTAB       *htab;
881         PgStat_MsgTabpurge msg;
882         PgStat_MsgFuncpurge f_msg;
883         HASH_SEQ_STATUS hstat;
884         PgStat_StatDBEntry *dbentry;
885         PgStat_StatTabEntry *tabentry;
886         PgStat_StatFuncEntry *funcentry;
887         int                     len;
888
889         if (pgStatSock == PGINVALID_SOCKET)
890                 return;
891
892         /*
893          * If not done for this transaction, read the statistics collector stats
894          * file into some hash tables.
895          */
896         backend_read_statsfile();
897
898         /*
899          * Read pg_database and make a list of OIDs of all existing databases
900          */
901         htab = pgstat_collect_oids(DatabaseRelationId);
902
903         /*
904          * Search the database hash table for dead databases and tell the
905          * collector to drop them.
906          */
907         hash_seq_init(&hstat, pgStatDBHash);
908         while ((dbentry = (PgStat_StatDBEntry *) hash_seq_search(&hstat)) != NULL)
909         {
910                 Oid                     dbid = dbentry->databaseid;
911
912                 CHECK_FOR_INTERRUPTS();
913
914                 /* the DB entry for shared tables (with InvalidOid) is never dropped */
915                 if (OidIsValid(dbid) &&
916                         hash_search(htab, (void *) &dbid, HASH_FIND, NULL) == NULL)
917                         pgstat_drop_database(dbid);
918         }
919
920         /* Clean up */
921         hash_destroy(htab);
922
923         /*
924          * Lookup our own database entry; if not found, nothing more to do.
925          */
926         dbentry = (PgStat_StatDBEntry *) hash_search(pgStatDBHash,
927                                                                                                  (void *) &MyDatabaseId,
928                                                                                                  HASH_FIND, NULL);
929         if (dbentry == NULL || dbentry->tables == NULL)
930                 return;
931
932         /*
933          * Similarly to above, make a list of all known relations in this DB.
934          */
935         htab = pgstat_collect_oids(RelationRelationId);
936
937         /*
938          * Initialize our messages table counter to zero
939          */
940         msg.m_nentries = 0;
941
942         /*
943          * Check for all tables listed in stats hashtable if they still exist.
944          */
945         hash_seq_init(&hstat, dbentry->tables);
946         while ((tabentry = (PgStat_StatTabEntry *) hash_seq_search(&hstat)) != NULL)
947         {
948                 Oid                     tabid = tabentry->tableid;
949
950                 CHECK_FOR_INTERRUPTS();
951
952                 if (hash_search(htab, (void *) &tabid, HASH_FIND, NULL) != NULL)
953                         continue;
954
955                 /*
956                  * Not there, so add this table's Oid to the message
957                  */
958                 msg.m_tableid[msg.m_nentries++] = tabid;
959
960                 /*
961                  * If the message is full, send it out and reinitialize to empty
962                  */
963                 if (msg.m_nentries >= PGSTAT_NUM_TABPURGE)
964                 {
965                         len = offsetof(PgStat_MsgTabpurge, m_tableid[0])
966                                 +msg.m_nentries * sizeof(Oid);
967
968                         pgstat_setheader(&msg.m_hdr, PGSTAT_MTYPE_TABPURGE);
969                         msg.m_databaseid = MyDatabaseId;
970                         pgstat_send(&msg, len);
971
972                         msg.m_nentries = 0;
973                 }
974         }
975
976         /*
977          * Send the rest
978          */
979         if (msg.m_nentries > 0)
980         {
981                 len = offsetof(PgStat_MsgTabpurge, m_tableid[0])
982                         +msg.m_nentries * sizeof(Oid);
983
984                 pgstat_setheader(&msg.m_hdr, PGSTAT_MTYPE_TABPURGE);
985                 msg.m_databaseid = MyDatabaseId;
986                 pgstat_send(&msg, len);
987         }
988
989         /* Clean up */
990         hash_destroy(htab);
991
992         /*
993          * Now repeat the above steps for functions.  However, we needn't bother
994          * in the common case where no function stats are being collected.
995          */
996         if (dbentry->functions != NULL &&
997                 hash_get_num_entries(dbentry->functions) > 0)
998         {
999                 htab = pgstat_collect_oids(ProcedureRelationId);
1000
1001                 pgstat_setheader(&f_msg.m_hdr, PGSTAT_MTYPE_FUNCPURGE);
1002                 f_msg.m_databaseid = MyDatabaseId;
1003                 f_msg.m_nentries = 0;
1004
1005                 hash_seq_init(&hstat, dbentry->functions);
1006                 while ((funcentry = (PgStat_StatFuncEntry *) hash_seq_search(&hstat)) != NULL)
1007                 {
1008                         Oid                     funcid = funcentry->functionid;
1009
1010                         CHECK_FOR_INTERRUPTS();
1011
1012                         if (hash_search(htab, (void *) &funcid, HASH_FIND, NULL) != NULL)
1013                                 continue;
1014
1015                         /*
1016                          * Not there, so add this function's Oid to the message
1017                          */
1018                         f_msg.m_functionid[f_msg.m_nentries++] = funcid;
1019
1020                         /*
1021                          * If the message is full, send it out and reinitialize to empty
1022                          */
1023                         if (f_msg.m_nentries >= PGSTAT_NUM_FUNCPURGE)
1024                         {
1025                                 len = offsetof(PgStat_MsgFuncpurge, m_functionid[0])
1026                                         +f_msg.m_nentries * sizeof(Oid);
1027
1028                                 pgstat_send(&f_msg, len);
1029
1030                                 f_msg.m_nentries = 0;
1031                         }
1032                 }
1033
1034                 /*
1035                  * Send the rest
1036                  */
1037                 if (f_msg.m_nentries > 0)
1038                 {
1039                         len = offsetof(PgStat_MsgFuncpurge, m_functionid[0])
1040                                 +f_msg.m_nentries * sizeof(Oid);
1041
1042                         pgstat_send(&f_msg, len);
1043                 }
1044
1045                 hash_destroy(htab);
1046         }
1047 }
1048
1049
1050 /* ----------
1051  * pgstat_collect_oids() -
1052  *
1053  *      Collect the OIDs of all objects listed in the specified system catalog
1054  *      into a temporary hash table.  Caller should hash_destroy the result
1055  *      when done with it.      (However, we make the table in CurrentMemoryContext
1056  *      so that it will be freed properly in event of an error.)
1057  * ----------
1058  */
1059 static HTAB *
1060 pgstat_collect_oids(Oid catalogid)
1061 {
1062         HTAB       *htab;
1063         HASHCTL         hash_ctl;
1064         Relation        rel;
1065         HeapScanDesc scan;
1066         HeapTuple       tup;
1067
1068         memset(&hash_ctl, 0, sizeof(hash_ctl));
1069         hash_ctl.keysize = sizeof(Oid);
1070         hash_ctl.entrysize = sizeof(Oid);
1071         hash_ctl.hash = oid_hash;
1072         hash_ctl.hcxt = CurrentMemoryContext;
1073         htab = hash_create("Temporary table of OIDs",
1074                                            PGSTAT_TAB_HASH_SIZE,
1075                                            &hash_ctl,
1076                                            HASH_ELEM | HASH_FUNCTION | HASH_CONTEXT);
1077
1078         rel = heap_open(catalogid, AccessShareLock);
1079         scan = heap_beginscan(rel, SnapshotNow, 0, NULL);
1080         while ((tup = heap_getnext(scan, ForwardScanDirection)) != NULL)
1081         {
1082                 Oid                     thisoid = HeapTupleGetOid(tup);
1083
1084                 CHECK_FOR_INTERRUPTS();
1085
1086                 (void) hash_search(htab, (void *) &thisoid, HASH_ENTER, NULL);
1087         }
1088         heap_endscan(scan);
1089         heap_close(rel, AccessShareLock);
1090
1091         return htab;
1092 }
1093
1094
1095 /* ----------
1096  * pgstat_drop_database() -
1097  *
1098  *      Tell the collector that we just dropped a database.
1099  *      (If the message gets lost, we will still clean the dead DB eventually
1100  *      via future invocations of pgstat_vacuum_stat().)
1101  * ----------
1102  */
1103 void
1104 pgstat_drop_database(Oid databaseid)
1105 {
1106         PgStat_MsgDropdb msg;
1107
1108         if (pgStatSock == PGINVALID_SOCKET)
1109                 return;
1110
1111         pgstat_setheader(&msg.m_hdr, PGSTAT_MTYPE_DROPDB);
1112         msg.m_databaseid = databaseid;
1113         pgstat_send(&msg, sizeof(msg));
1114 }
1115
1116
1117 /* ----------
1118  * pgstat_drop_relation() -
1119  *
1120  *      Tell the collector that we just dropped a relation.
1121  *      (If the message gets lost, we will still clean the dead entry eventually
1122  *      via future invocations of pgstat_vacuum_stat().)
1123  *
1124  *      Currently not used for lack of any good place to call it; we rely
1125  *      entirely on pgstat_vacuum_stat() to clean out stats for dead rels.
1126  * ----------
1127  */
1128 #ifdef NOT_USED
1129 void
1130 pgstat_drop_relation(Oid relid)
1131 {
1132         PgStat_MsgTabpurge msg;
1133         int                     len;
1134
1135         if (pgStatSock == PGINVALID_SOCKET)
1136                 return;
1137
1138         msg.m_tableid[0] = relid;
1139         msg.m_nentries = 1;
1140
1141         len = offsetof(PgStat_MsgTabpurge, m_tableid[0]) +sizeof(Oid);
1142
1143         pgstat_setheader(&msg.m_hdr, PGSTAT_MTYPE_TABPURGE);
1144         msg.m_databaseid = MyDatabaseId;
1145         pgstat_send(&msg, len);
1146 }
1147 #endif   /* NOT_USED */
1148
1149
1150 /* ----------
1151  * pgstat_reset_counters() -
1152  *
1153  *      Tell the statistics collector to reset counters for our database.
1154  * ----------
1155  */
1156 void
1157 pgstat_reset_counters(void)
1158 {
1159         PgStat_MsgResetcounter msg;
1160
1161         if (pgStatSock == PGINVALID_SOCKET)
1162                 return;
1163
1164         if (!superuser())
1165                 ereport(ERROR,
1166                                 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
1167                                  errmsg("must be superuser to reset statistics counters")));
1168
1169         pgstat_setheader(&msg.m_hdr, PGSTAT_MTYPE_RESETCOUNTER);
1170         msg.m_databaseid = MyDatabaseId;
1171         pgstat_send(&msg, sizeof(msg));
1172 }
1173
1174 /* ----------
1175  * pgstat_reset_shared_counters() -
1176  *
1177  *      Tell the statistics collector to reset cluster-wide shared counters.
1178  * ----------
1179  */
1180 void
1181 pgstat_reset_shared_counters(const char *target)
1182 {
1183         PgStat_MsgResetsharedcounter msg;
1184
1185         if (pgStatSock == PGINVALID_SOCKET)
1186                 return;
1187
1188         if (!superuser())
1189                 ereport(ERROR,
1190                                 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
1191                                  errmsg("must be superuser to reset statistics counters")));
1192
1193         if (strcmp(target, "bgwriter") == 0)
1194                 msg.m_resettarget = RESET_BGWRITER;
1195         else
1196                 ereport(ERROR,
1197                                 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1198                                  errmsg("unrecognized reset target: \"%s\"", target),
1199                                  errhint("Target must be \"bgwriter\".")));
1200
1201         pgstat_setheader(&msg.m_hdr, PGSTAT_MTYPE_RESETSHAREDCOUNTER);
1202         pgstat_send(&msg, sizeof(msg));
1203 }
1204
1205 /* ----------
1206  * pgstat_reset_single_counter() -
1207  *
1208  *      Tell the statistics collector to reset a single counter.
1209  * ----------
1210  */
1211 void
1212 pgstat_reset_single_counter(Oid objoid, PgStat_Single_Reset_Type type)
1213 {
1214         PgStat_MsgResetsinglecounter msg;
1215
1216         if (pgStatSock == PGINVALID_SOCKET)
1217                 return;
1218
1219         if (!superuser())
1220                 ereport(ERROR,
1221                                 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
1222                                  errmsg("must be superuser to reset statistics counters")));
1223
1224         pgstat_setheader(&msg.m_hdr, PGSTAT_MTYPE_RESETSINGLECOUNTER);
1225         msg.m_databaseid = MyDatabaseId;
1226         msg.m_resettype = type;
1227         msg.m_objectid = objoid;
1228
1229         pgstat_send(&msg, sizeof(msg));
1230 }
1231
1232 /* ----------
1233  * pgstat_report_autovac() -
1234  *
1235  *      Called from autovacuum.c to report startup of an autovacuum process.
1236  *      We are called before InitPostgres is done, so can't rely on MyDatabaseId;
1237  *      the db OID must be passed in, instead.
1238  * ----------
1239  */
1240 void
1241 pgstat_report_autovac(Oid dboid)
1242 {
1243         PgStat_MsgAutovacStart msg;
1244
1245         if (pgStatSock == PGINVALID_SOCKET)
1246                 return;
1247
1248         pgstat_setheader(&msg.m_hdr, PGSTAT_MTYPE_AUTOVAC_START);
1249         msg.m_databaseid = dboid;
1250         msg.m_start_time = GetCurrentTimestamp();
1251
1252         pgstat_send(&msg, sizeof(msg));
1253 }
1254
1255
1256 /* ---------
1257  * pgstat_report_vacuum() -
1258  *
1259  *      Tell the collector about the table we just vacuumed.
1260  * ---------
1261  */
1262 void
1263 pgstat_report_vacuum(Oid tableoid, bool shared, PgStat_Counter tuples)
1264 {
1265         PgStat_MsgVacuum msg;
1266
1267         if (pgStatSock == PGINVALID_SOCKET || !pgstat_track_counts)
1268                 return;
1269
1270         pgstat_setheader(&msg.m_hdr, PGSTAT_MTYPE_VACUUM);
1271         msg.m_databaseid = shared ? InvalidOid : MyDatabaseId;
1272         msg.m_tableoid = tableoid;
1273         msg.m_autovacuum = IsAutoVacuumWorkerProcess();
1274         msg.m_vacuumtime = GetCurrentTimestamp();
1275         msg.m_tuples = tuples;
1276         pgstat_send(&msg, sizeof(msg));
1277 }
1278
1279 /* --------
1280  * pgstat_report_analyze() -
1281  *
1282  *      Tell the collector about the table we just analyzed.
1283  * --------
1284  */
1285 void
1286 pgstat_report_analyze(Relation rel,
1287                                           PgStat_Counter livetuples, PgStat_Counter deadtuples)
1288 {
1289         PgStat_MsgAnalyze msg;
1290
1291         if (pgStatSock == PGINVALID_SOCKET || !pgstat_track_counts)
1292                 return;
1293
1294         /*
1295          * Unlike VACUUM, ANALYZE might be running inside a transaction that has
1296          * already inserted and/or deleted rows in the target table. ANALYZE will
1297          * have counted such rows as live or dead respectively. Because we will
1298          * report our counts of such rows at transaction end, we should subtract
1299          * off these counts from what we send to the collector now, else they'll
1300          * be double-counted after commit.      (This approach also ensures that the
1301          * collector ends up with the right numbers if we abort instead of
1302          * committing.)
1303          */
1304         if (rel->pgstat_info != NULL)
1305         {
1306                 PgStat_TableXactStatus *trans;
1307
1308                 for (trans = rel->pgstat_info->trans; trans; trans = trans->upper)
1309                 {
1310                         livetuples -= trans->tuples_inserted - trans->tuples_deleted;
1311                         deadtuples -= trans->tuples_updated + trans->tuples_deleted;
1312                 }
1313                 /* count stuff inserted by already-aborted subxacts, too */
1314                 deadtuples -= rel->pgstat_info->t_counts.t_delta_dead_tuples;
1315                 /* Since ANALYZE's counts are estimates, we could have underflowed */
1316                 livetuples = Max(livetuples, 0);
1317                 deadtuples = Max(deadtuples, 0);
1318         }
1319
1320         pgstat_setheader(&msg.m_hdr, PGSTAT_MTYPE_ANALYZE);
1321         msg.m_databaseid = rel->rd_rel->relisshared ? InvalidOid : MyDatabaseId;
1322         msg.m_tableoid = RelationGetRelid(rel);
1323         msg.m_autovacuum = IsAutoVacuumWorkerProcess();
1324         msg.m_analyzetime = GetCurrentTimestamp();
1325         msg.m_live_tuples = livetuples;
1326         msg.m_dead_tuples = deadtuples;
1327         pgstat_send(&msg, sizeof(msg));
1328 }
1329
1330 /* --------
1331  * pgstat_report_recovery_conflict() -
1332  *
1333  *      Tell the collector about a Hot Standby recovery conflict.
1334  * --------
1335  */
1336 void
1337 pgstat_report_recovery_conflict(int reason)
1338 {
1339         PgStat_MsgRecoveryConflict msg;
1340
1341         if (pgStatSock == PGINVALID_SOCKET || !pgstat_track_counts)
1342                 return;
1343
1344         pgstat_setheader(&msg.m_hdr, PGSTAT_MTYPE_RECOVERYCONFLICT);
1345         msg.m_databaseid = MyDatabaseId;
1346         msg.m_reason = reason;
1347         pgstat_send(&msg, sizeof(msg));
1348 }
1349
1350 /* --------
1351  * pgstat_report_deadlock() -
1352  *
1353  *      Tell the collector about a deadlock detected.
1354  * --------
1355  */
1356 void
1357 pgstat_report_deadlock(void)
1358 {
1359         PgStat_MsgDeadlock msg;
1360
1361         if (pgStatSock == PGINVALID_SOCKET || !pgstat_track_counts)
1362                 return;
1363
1364         pgstat_setheader(&msg.m_hdr, PGSTAT_MTYPE_DEADLOCK);
1365         msg.m_databaseid = MyDatabaseId;
1366         pgstat_send(&msg, sizeof(msg));
1367 }
1368
1369 /* --------
1370  * pgstat_report_tempfile() -
1371  *
1372  *      Tell the collector about a temporary file.
1373  * --------
1374  */
1375 void
1376 pgstat_report_tempfile(size_t filesize)
1377 {
1378         PgStat_MsgTempFile msg;
1379
1380         if (pgStatSock == PGINVALID_SOCKET || !pgstat_track_counts)
1381                 return;
1382
1383         pgstat_setheader(&msg.m_hdr, PGSTAT_MTYPE_TEMPFILE);
1384         msg.m_databaseid = MyDatabaseId;
1385         msg.m_filesize = filesize;
1386         pgstat_send(&msg, sizeof(msg));
1387 }
1388
1389
1390 /* ----------
1391  * pgstat_ping() -
1392  *
1393  *      Send some junk data to the collector to increase traffic.
1394  * ----------
1395  */
1396 void
1397 pgstat_ping(void)
1398 {
1399         PgStat_MsgDummy msg;
1400
1401         if (pgStatSock == PGINVALID_SOCKET)
1402                 return;
1403
1404         pgstat_setheader(&msg.m_hdr, PGSTAT_MTYPE_DUMMY);
1405         pgstat_send(&msg, sizeof(msg));
1406 }
1407
1408 /* ----------
1409  * pgstat_send_inquiry() -
1410  *
1411  *      Notify collector that we need fresh data.
1412  *      ts specifies the minimum acceptable timestamp for the stats file.
1413  * ----------
1414  */
1415 static void
1416 pgstat_send_inquiry(TimestampTz ts)
1417 {
1418         PgStat_MsgInquiry msg;
1419
1420         pgstat_setheader(&msg.m_hdr, PGSTAT_MTYPE_INQUIRY);
1421         msg.inquiry_time = ts;
1422         pgstat_send(&msg, sizeof(msg));
1423 }
1424
1425
1426 /*
1427  * Initialize function call usage data.
1428  * Called by the executor before invoking a function.
1429  */
1430 void
1431 pgstat_init_function_usage(FunctionCallInfoData *fcinfo,
1432                                                    PgStat_FunctionCallUsage *fcu)
1433 {
1434         PgStat_BackendFunctionEntry *htabent;
1435         bool            found;
1436
1437         if (pgstat_track_functions <= fcinfo->flinfo->fn_stats)
1438         {
1439                 /* stats not wanted */
1440                 fcu->fs = NULL;
1441                 return;
1442         }
1443
1444         if (!pgStatFunctions)
1445         {
1446                 /* First time through - initialize function stat table */
1447                 HASHCTL         hash_ctl;
1448
1449                 memset(&hash_ctl, 0, sizeof(hash_ctl));
1450                 hash_ctl.keysize = sizeof(Oid);
1451                 hash_ctl.entrysize = sizeof(PgStat_BackendFunctionEntry);
1452                 hash_ctl.hash = oid_hash;
1453                 pgStatFunctions = hash_create("Function stat entries",
1454                                                                           PGSTAT_FUNCTION_HASH_SIZE,
1455                                                                           &hash_ctl,
1456                                                                           HASH_ELEM | HASH_FUNCTION);
1457         }
1458
1459         /* Get the stats entry for this function, create if necessary */
1460         htabent = hash_search(pgStatFunctions, &fcinfo->flinfo->fn_oid,
1461                                                   HASH_ENTER, &found);
1462         if (!found)
1463                 MemSet(&htabent->f_counts, 0, sizeof(PgStat_FunctionCounts));
1464
1465         fcu->fs = &htabent->f_counts;
1466
1467         /* save stats for this function, later used to compensate for recursion */
1468         fcu->save_f_time = htabent->f_counts.f_time;
1469
1470         /* save current backend-wide total time */
1471         fcu->save_total = total_func_time;
1472
1473         /* get clock time as of function start */
1474         INSTR_TIME_SET_CURRENT(fcu->f_start);
1475 }
1476
1477 /*
1478  * find_funcstat_entry - find any existing PgStat_BackendFunctionEntry entry
1479  *              for specified function
1480  *
1481  * If no entry, return NULL, don't create a new one
1482  */
1483 PgStat_BackendFunctionEntry *
1484 find_funcstat_entry(Oid func_id)
1485 {
1486         if (pgStatFunctions == NULL)
1487                 return NULL;
1488
1489         return (PgStat_BackendFunctionEntry *) hash_search(pgStatFunctions,
1490                                                                                                            (void *) &func_id,
1491                                                                                                            HASH_FIND, NULL);
1492 }
1493
1494 /*
1495  * Calculate function call usage and update stat counters.
1496  * Called by the executor after invoking a function.
1497  *
1498  * In the case of a set-returning function that runs in value-per-call mode,
1499  * we will see multiple pgstat_init_function_usage/pgstat_end_function_usage
1500  * calls for what the user considers a single call of the function.  The
1501  * finalize flag should be TRUE on the last call.
1502  */
1503 void
1504 pgstat_end_function_usage(PgStat_FunctionCallUsage *fcu, bool finalize)
1505 {
1506         PgStat_FunctionCounts *fs = fcu->fs;
1507         instr_time      f_total;
1508         instr_time      f_others;
1509         instr_time      f_self;
1510
1511         /* stats not wanted? */
1512         if (fs == NULL)
1513                 return;
1514
1515         /* total elapsed time in this function call */
1516         INSTR_TIME_SET_CURRENT(f_total);
1517         INSTR_TIME_SUBTRACT(f_total, fcu->f_start);
1518
1519         /* self usage: elapsed minus anything already charged to other calls */
1520         f_others = total_func_time;
1521         INSTR_TIME_SUBTRACT(f_others, fcu->save_total);
1522         f_self = f_total;
1523         INSTR_TIME_SUBTRACT(f_self, f_others);
1524
1525         /* update backend-wide total time */
1526         INSTR_TIME_ADD(total_func_time, f_self);
1527
1528         /*
1529          * Compute the new total f_time as the total elapsed time added to the
1530          * pre-call value of f_time.  This is necessary to avoid double-counting
1531          * any time taken by recursive calls of myself.  (We do not need any
1532          * similar kluge for self time, since that already excludes any recursive
1533          * calls.)
1534          */
1535         INSTR_TIME_ADD(f_total, fcu->save_f_time);
1536
1537         /* update counters in function stats table */
1538         if (finalize)
1539                 fs->f_numcalls++;
1540         fs->f_time = f_total;
1541         INSTR_TIME_ADD(fs->f_time_self, f_self);
1542
1543         /* indicate that we have something to send */
1544         have_function_stats = true;
1545 }
1546
1547
1548 /* ----------
1549  * pgstat_initstats() -
1550  *
1551  *      Initialize a relcache entry to count access statistics.
1552  *      Called whenever a relation is opened.
1553  *
1554  *      We assume that a relcache entry's pgstat_info field is zeroed by
1555  *      relcache.c when the relcache entry is made; thereafter it is long-lived
1556  *      data.  We can avoid repeated searches of the TabStatus arrays when the
1557  *      same relation is touched repeatedly within a transaction.
1558  * ----------
1559  */
1560 void
1561 pgstat_initstats(Relation rel)
1562 {
1563         Oid                     rel_id = rel->rd_id;
1564         char            relkind = rel->rd_rel->relkind;
1565
1566         /* We only count stats for things that have storage */
1567         if (!(relkind == RELKIND_RELATION ||
1568                   relkind == RELKIND_INDEX ||
1569                   relkind == RELKIND_TOASTVALUE ||
1570                   relkind == RELKIND_SEQUENCE))
1571         {
1572                 rel->pgstat_info = NULL;
1573                 return;
1574         }
1575
1576         if (pgStatSock == PGINVALID_SOCKET || !pgstat_track_counts)
1577         {
1578                 /* We're not counting at all */
1579                 rel->pgstat_info = NULL;
1580                 return;
1581         }
1582
1583         /*
1584          * If we already set up this relation in the current transaction, nothing
1585          * to do.
1586          */
1587         if (rel->pgstat_info != NULL &&
1588                 rel->pgstat_info->t_id == rel_id)
1589                 return;
1590
1591         /* Else find or make the PgStat_TableStatus entry, and update link */
1592         rel->pgstat_info = get_tabstat_entry(rel_id, rel->rd_rel->relisshared);
1593 }
1594
1595 /*
1596  * get_tabstat_entry - find or create a PgStat_TableStatus entry for rel
1597  */
1598 static PgStat_TableStatus *
1599 get_tabstat_entry(Oid rel_id, bool isshared)
1600 {
1601         PgStat_TableStatus *entry;
1602         TabStatusArray *tsa;
1603         TabStatusArray *prev_tsa;
1604         int                     i;
1605
1606         /*
1607          * Search the already-used tabstat slots for this relation.
1608          */
1609         prev_tsa = NULL;
1610         for (tsa = pgStatTabList; tsa != NULL; prev_tsa = tsa, tsa = tsa->tsa_next)
1611         {
1612                 for (i = 0; i < tsa->tsa_used; i++)
1613                 {
1614                         entry = &tsa->tsa_entries[i];
1615                         if (entry->t_id == rel_id)
1616                                 return entry;
1617                 }
1618
1619                 if (tsa->tsa_used < TABSTAT_QUANTUM)
1620                 {
1621                         /*
1622                          * It must not be present, but we found a free slot instead. Fine,
1623                          * let's use this one.  We assume the entry was already zeroed,
1624                          * either at creation or after last use.
1625                          */
1626                         entry = &tsa->tsa_entries[tsa->tsa_used++];
1627                         entry->t_id = rel_id;
1628                         entry->t_shared = isshared;
1629                         return entry;
1630                 }
1631         }
1632
1633         /*
1634          * We ran out of tabstat slots, so allocate more.  Be sure they're zeroed.
1635          */
1636         tsa = (TabStatusArray *) MemoryContextAllocZero(TopMemoryContext,
1637                                                                                                         sizeof(TabStatusArray));
1638         if (prev_tsa)
1639                 prev_tsa->tsa_next = tsa;
1640         else
1641                 pgStatTabList = tsa;
1642
1643         /*
1644          * Use the first entry of the new TabStatusArray.
1645          */
1646         entry = &tsa->tsa_entries[tsa->tsa_used++];
1647         entry->t_id = rel_id;
1648         entry->t_shared = isshared;
1649         return entry;
1650 }
1651
1652 /*
1653  * find_tabstat_entry - find any existing PgStat_TableStatus entry for rel
1654  *
1655  * If no entry, return NULL, don't create a new one
1656  */
1657 PgStat_TableStatus *
1658 find_tabstat_entry(Oid rel_id)
1659 {
1660         PgStat_TableStatus *entry;
1661         TabStatusArray *tsa;
1662         int                     i;
1663
1664         for (tsa = pgStatTabList; tsa != NULL; tsa = tsa->tsa_next)
1665         {
1666                 for (i = 0; i < tsa->tsa_used; i++)
1667                 {
1668                         entry = &tsa->tsa_entries[i];
1669                         if (entry->t_id == rel_id)
1670                                 return entry;
1671                 }
1672         }
1673
1674         /* Not present */
1675         return NULL;
1676 }
1677
1678 /*
1679  * get_tabstat_stack_level - add a new (sub)transaction stack entry if needed
1680  */
1681 static PgStat_SubXactStatus *
1682 get_tabstat_stack_level(int nest_level)
1683 {
1684         PgStat_SubXactStatus *xact_state;
1685
1686         xact_state = pgStatXactStack;
1687         if (xact_state == NULL || xact_state->nest_level != nest_level)
1688         {
1689                 xact_state = (PgStat_SubXactStatus *)
1690                         MemoryContextAlloc(TopTransactionContext,
1691                                                            sizeof(PgStat_SubXactStatus));
1692                 xact_state->nest_level = nest_level;
1693                 xact_state->prev = pgStatXactStack;
1694                 xact_state->first = NULL;
1695                 pgStatXactStack = xact_state;
1696         }
1697         return xact_state;
1698 }
1699
1700 /*
1701  * add_tabstat_xact_level - add a new (sub)transaction state record
1702  */
1703 static void
1704 add_tabstat_xact_level(PgStat_TableStatus *pgstat_info, int nest_level)
1705 {
1706         PgStat_SubXactStatus *xact_state;
1707         PgStat_TableXactStatus *trans;
1708
1709         /*
1710          * If this is the first rel to be modified at the current nest level, we
1711          * first have to push a transaction stack entry.
1712          */
1713         xact_state = get_tabstat_stack_level(nest_level);
1714
1715         /* Now make a per-table stack entry */
1716         trans = (PgStat_TableXactStatus *)
1717                 MemoryContextAllocZero(TopTransactionContext,
1718                                                            sizeof(PgStat_TableXactStatus));
1719         trans->nest_level = nest_level;
1720         trans->upper = pgstat_info->trans;
1721         trans->parent = pgstat_info;
1722         trans->next = xact_state->first;
1723         xact_state->first = trans;
1724         pgstat_info->trans = trans;
1725 }
1726
1727 /*
1728  * pgstat_count_heap_insert - count a tuple insertion of n tuples
1729  */
1730 void
1731 pgstat_count_heap_insert(Relation rel, int n)
1732 {
1733         PgStat_TableStatus *pgstat_info = rel->pgstat_info;
1734
1735         if (pgstat_info != NULL)
1736         {
1737                 /* We have to log the effect at the proper transactional level */
1738                 int                     nest_level = GetCurrentTransactionNestLevel();
1739
1740                 if (pgstat_info->trans == NULL ||
1741                         pgstat_info->trans->nest_level != nest_level)
1742                         add_tabstat_xact_level(pgstat_info, nest_level);
1743
1744                 pgstat_info->trans->tuples_inserted += n;
1745         }
1746 }
1747
1748 /*
1749  * pgstat_count_heap_update - count a tuple update
1750  */
1751 void
1752 pgstat_count_heap_update(Relation rel, bool hot)
1753 {
1754         PgStat_TableStatus *pgstat_info = rel->pgstat_info;
1755
1756         if (pgstat_info != NULL)
1757         {
1758                 /* We have to log the effect at the proper transactional level */
1759                 int                     nest_level = GetCurrentTransactionNestLevel();
1760
1761                 if (pgstat_info->trans == NULL ||
1762                         pgstat_info->trans->nest_level != nest_level)
1763                         add_tabstat_xact_level(pgstat_info, nest_level);
1764
1765                 pgstat_info->trans->tuples_updated++;
1766
1767                 /* t_tuples_hot_updated is nontransactional, so just advance it */
1768                 if (hot)
1769                         pgstat_info->t_counts.t_tuples_hot_updated++;
1770         }
1771 }
1772
1773 /*
1774  * pgstat_count_heap_delete - count a tuple deletion
1775  */
1776 void
1777 pgstat_count_heap_delete(Relation rel)
1778 {
1779         PgStat_TableStatus *pgstat_info = rel->pgstat_info;
1780
1781         if (pgstat_info != NULL)
1782         {
1783                 /* We have to log the effect at the proper transactional level */
1784                 int                     nest_level = GetCurrentTransactionNestLevel();
1785
1786                 if (pgstat_info->trans == NULL ||
1787                         pgstat_info->trans->nest_level != nest_level)
1788                         add_tabstat_xact_level(pgstat_info, nest_level);
1789
1790                 pgstat_info->trans->tuples_deleted++;
1791         }
1792 }
1793
1794 /*
1795  * pgstat_update_heap_dead_tuples - update dead-tuples count
1796  *
1797  * The semantics of this are that we are reporting the nontransactional
1798  * recovery of "delta" dead tuples; so t_delta_dead_tuples decreases
1799  * rather than increasing, and the change goes straight into the per-table
1800  * counter, not into transactional state.
1801  */
1802 void
1803 pgstat_update_heap_dead_tuples(Relation rel, int delta)
1804 {
1805         PgStat_TableStatus *pgstat_info = rel->pgstat_info;
1806
1807         if (pgstat_info != NULL)
1808                 pgstat_info->t_counts.t_delta_dead_tuples -= delta;
1809 }
1810
1811
1812 /* ----------
1813  * AtEOXact_PgStat
1814  *
1815  *      Called from access/transam/xact.c at top-level transaction commit/abort.
1816  * ----------
1817  */
1818 void
1819 AtEOXact_PgStat(bool isCommit)
1820 {
1821         PgStat_SubXactStatus *xact_state;
1822
1823         /*
1824          * Count transaction commit or abort.  (We use counters, not just bools,
1825          * in case the reporting message isn't sent right away.)
1826          */
1827         if (isCommit)
1828                 pgStatXactCommit++;
1829         else
1830                 pgStatXactRollback++;
1831
1832         /*
1833          * Transfer transactional insert/update counts into the base tabstat
1834          * entries.  We don't bother to free any of the transactional state, since
1835          * it's all in TopTransactionContext and will go away anyway.
1836          */
1837         xact_state = pgStatXactStack;
1838         if (xact_state != NULL)
1839         {
1840                 PgStat_TableXactStatus *trans;
1841
1842                 Assert(xact_state->nest_level == 1);
1843                 Assert(xact_state->prev == NULL);
1844                 for (trans = xact_state->first; trans != NULL; trans = trans->next)
1845                 {
1846                         PgStat_TableStatus *tabstat;
1847
1848                         Assert(trans->nest_level == 1);
1849                         Assert(trans->upper == NULL);
1850                         tabstat = trans->parent;
1851                         Assert(tabstat->trans == trans);
1852                         /* count attempted actions regardless of commit/abort */
1853                         tabstat->t_counts.t_tuples_inserted += trans->tuples_inserted;
1854                         tabstat->t_counts.t_tuples_updated += trans->tuples_updated;
1855                         tabstat->t_counts.t_tuples_deleted += trans->tuples_deleted;
1856                         if (isCommit)
1857                         {
1858                                 /* insert adds a live tuple, delete removes one */
1859                                 tabstat->t_counts.t_delta_live_tuples +=
1860                                         trans->tuples_inserted - trans->tuples_deleted;
1861                                 /* update and delete each create a dead tuple */
1862                                 tabstat->t_counts.t_delta_dead_tuples +=
1863                                         trans->tuples_updated + trans->tuples_deleted;
1864                                 /* insert, update, delete each count as one change event */
1865                                 tabstat->t_counts.t_changed_tuples +=
1866                                         trans->tuples_inserted + trans->tuples_updated +
1867                                         trans->tuples_deleted;
1868                         }
1869                         else
1870                         {
1871                                 /* inserted tuples are dead, deleted tuples are unaffected */
1872                                 tabstat->t_counts.t_delta_dead_tuples +=
1873                                         trans->tuples_inserted + trans->tuples_updated;
1874                                 /* an aborted xact generates no changed_tuple events */
1875                         }
1876                         tabstat->trans = NULL;
1877                 }
1878         }
1879         pgStatXactStack = NULL;
1880
1881         /* Make sure any stats snapshot is thrown away */
1882         pgstat_clear_snapshot();
1883 }
1884
1885 /* ----------
1886  * AtEOSubXact_PgStat
1887  *
1888  *      Called from access/transam/xact.c at subtransaction commit/abort.
1889  * ----------
1890  */
1891 void
1892 AtEOSubXact_PgStat(bool isCommit, int nestDepth)
1893 {
1894         PgStat_SubXactStatus *xact_state;
1895
1896         /*
1897          * Transfer transactional insert/update counts into the next higher
1898          * subtransaction state.
1899          */
1900         xact_state = pgStatXactStack;
1901         if (xact_state != NULL &&
1902                 xact_state->nest_level >= nestDepth)
1903         {
1904                 PgStat_TableXactStatus *trans;
1905                 PgStat_TableXactStatus *next_trans;
1906
1907                 /* delink xact_state from stack immediately to simplify reuse case */
1908                 pgStatXactStack = xact_state->prev;
1909
1910                 for (trans = xact_state->first; trans != NULL; trans = next_trans)
1911                 {
1912                         PgStat_TableStatus *tabstat;
1913
1914                         next_trans = trans->next;
1915                         Assert(trans->nest_level == nestDepth);
1916                         tabstat = trans->parent;
1917                         Assert(tabstat->trans == trans);
1918                         if (isCommit)
1919                         {
1920                                 if (trans->upper && trans->upper->nest_level == nestDepth - 1)
1921                                 {
1922                                         trans->upper->tuples_inserted += trans->tuples_inserted;
1923                                         trans->upper->tuples_updated += trans->tuples_updated;
1924                                         trans->upper->tuples_deleted += trans->tuples_deleted;
1925                                         tabstat->trans = trans->upper;
1926                                         pfree(trans);
1927                                 }
1928                                 else
1929                                 {
1930                                         /*
1931                                          * When there isn't an immediate parent state, we can just
1932                                          * reuse the record instead of going through a
1933                                          * palloc/pfree pushup (this works since it's all in
1934                                          * TopTransactionContext anyway).  We have to re-link it
1935                                          * into the parent level, though, and that might mean
1936                                          * pushing a new entry into the pgStatXactStack.
1937                                          */
1938                                         PgStat_SubXactStatus *upper_xact_state;
1939
1940                                         upper_xact_state = get_tabstat_stack_level(nestDepth - 1);
1941                                         trans->next = upper_xact_state->first;
1942                                         upper_xact_state->first = trans;
1943                                         trans->nest_level = nestDepth - 1;
1944                                 }
1945                         }
1946                         else
1947                         {
1948                                 /*
1949                                  * On abort, update top-level tabstat counts, then forget the
1950                                  * subtransaction
1951                                  */
1952
1953                                 /* count attempted actions regardless of commit/abort */
1954                                 tabstat->t_counts.t_tuples_inserted += trans->tuples_inserted;
1955                                 tabstat->t_counts.t_tuples_updated += trans->tuples_updated;
1956                                 tabstat->t_counts.t_tuples_deleted += trans->tuples_deleted;
1957                                 /* inserted tuples are dead, deleted tuples are unaffected */
1958                                 tabstat->t_counts.t_delta_dead_tuples +=
1959                                         trans->tuples_inserted + trans->tuples_updated;
1960                                 tabstat->trans = trans->upper;
1961                                 pfree(trans);
1962                         }
1963                 }
1964                 pfree(xact_state);
1965         }
1966 }
1967
1968
1969 /*
1970  * AtPrepare_PgStat
1971  *              Save the transactional stats state at 2PC transaction prepare.
1972  *
1973  * In this phase we just generate 2PC records for all the pending
1974  * transaction-dependent stats work.
1975  */
1976 void
1977 AtPrepare_PgStat(void)
1978 {
1979         PgStat_SubXactStatus *xact_state;
1980
1981         xact_state = pgStatXactStack;
1982         if (xact_state != NULL)
1983         {
1984                 PgStat_TableXactStatus *trans;
1985
1986                 Assert(xact_state->nest_level == 1);
1987                 Assert(xact_state->prev == NULL);
1988                 for (trans = xact_state->first; trans != NULL; trans = trans->next)
1989                 {
1990                         PgStat_TableStatus *tabstat;
1991                         TwoPhasePgStatRecord record;
1992
1993                         Assert(trans->nest_level == 1);
1994                         Assert(trans->upper == NULL);
1995                         tabstat = trans->parent;
1996                         Assert(tabstat->trans == trans);
1997
1998                         record.tuples_inserted = trans->tuples_inserted;
1999                         record.tuples_updated = trans->tuples_updated;
2000                         record.tuples_deleted = trans->tuples_deleted;
2001                         record.t_id = tabstat->t_id;
2002                         record.t_shared = tabstat->t_shared;
2003
2004                         RegisterTwoPhaseRecord(TWOPHASE_RM_PGSTAT_ID, 0,
2005                                                                    &record, sizeof(TwoPhasePgStatRecord));
2006                 }
2007         }
2008 }
2009
2010 /*
2011  * PostPrepare_PgStat
2012  *              Clean up after successful PREPARE.
2013  *
2014  * All we need do here is unlink the transaction stats state from the
2015  * nontransactional state.      The nontransactional action counts will be
2016  * reported to the stats collector immediately, while the effects on live
2017  * and dead tuple counts are preserved in the 2PC state file.
2018  *
2019  * Note: AtEOXact_PgStat is not called during PREPARE.
2020  */
2021 void
2022 PostPrepare_PgStat(void)
2023 {
2024         PgStat_SubXactStatus *xact_state;
2025
2026         /*
2027          * We don't bother to free any of the transactional state, since it's all
2028          * in TopTransactionContext and will go away anyway.
2029          */
2030         xact_state = pgStatXactStack;
2031         if (xact_state != NULL)
2032         {
2033                 PgStat_TableXactStatus *trans;
2034
2035                 for (trans = xact_state->first; trans != NULL; trans = trans->next)
2036                 {
2037                         PgStat_TableStatus *tabstat;
2038
2039                         tabstat = trans->parent;
2040                         tabstat->trans = NULL;
2041                 }
2042         }
2043         pgStatXactStack = NULL;
2044
2045         /* Make sure any stats snapshot is thrown away */
2046         pgstat_clear_snapshot();
2047 }
2048
2049 /*
2050  * 2PC processing routine for COMMIT PREPARED case.
2051  *
2052  * Load the saved counts into our local pgstats state.
2053  */
2054 void
2055 pgstat_twophase_postcommit(TransactionId xid, uint16 info,
2056                                                    void *recdata, uint32 len)
2057 {
2058         TwoPhasePgStatRecord *rec = (TwoPhasePgStatRecord *) recdata;
2059         PgStat_TableStatus *pgstat_info;
2060
2061         /* Find or create a tabstat entry for the rel */
2062         pgstat_info = get_tabstat_entry(rec->t_id, rec->t_shared);
2063
2064         /* Same math as in AtEOXact_PgStat, commit case */
2065         pgstat_info->t_counts.t_tuples_inserted += rec->tuples_inserted;
2066         pgstat_info->t_counts.t_tuples_updated += rec->tuples_updated;
2067         pgstat_info->t_counts.t_tuples_deleted += rec->tuples_deleted;
2068         pgstat_info->t_counts.t_delta_live_tuples +=
2069                 rec->tuples_inserted - rec->tuples_deleted;
2070         pgstat_info->t_counts.t_delta_dead_tuples +=
2071                 rec->tuples_updated + rec->tuples_deleted;
2072         pgstat_info->t_counts.t_changed_tuples +=
2073                 rec->tuples_inserted + rec->tuples_updated +
2074                 rec->tuples_deleted;
2075 }
2076
2077 /*
2078  * 2PC processing routine for ROLLBACK PREPARED case.
2079  *
2080  * Load the saved counts into our local pgstats state, but treat them
2081  * as aborted.
2082  */
2083 void
2084 pgstat_twophase_postabort(TransactionId xid, uint16 info,
2085                                                   void *recdata, uint32 len)
2086 {
2087         TwoPhasePgStatRecord *rec = (TwoPhasePgStatRecord *) recdata;
2088         PgStat_TableStatus *pgstat_info;
2089
2090         /* Find or create a tabstat entry for the rel */
2091         pgstat_info = get_tabstat_entry(rec->t_id, rec->t_shared);
2092
2093         /* Same math as in AtEOXact_PgStat, abort case */
2094         pgstat_info->t_counts.t_tuples_inserted += rec->tuples_inserted;
2095         pgstat_info->t_counts.t_tuples_updated += rec->tuples_updated;
2096         pgstat_info->t_counts.t_tuples_deleted += rec->tuples_deleted;
2097         pgstat_info->t_counts.t_delta_dead_tuples +=
2098                 rec->tuples_inserted + rec->tuples_updated;
2099 }
2100
2101
2102 /* ----------
2103  * pgstat_fetch_stat_dbentry() -
2104  *
2105  *      Support function for the SQL-callable pgstat* functions. Returns
2106  *      the collected statistics for one database or NULL. NULL doesn't mean
2107  *      that the database doesn't exist, it is just not yet known by the
2108  *      collector, so the caller is better off to report ZERO instead.
2109  * ----------
2110  */
2111 PgStat_StatDBEntry *
2112 pgstat_fetch_stat_dbentry(Oid dbid)
2113 {
2114         /*
2115          * If not done for this transaction, read the statistics collector stats
2116          * file into some hash tables.
2117          */
2118         backend_read_statsfile();
2119
2120         /*
2121          * Lookup the requested database; return NULL if not found
2122          */
2123         return (PgStat_StatDBEntry *) hash_search(pgStatDBHash,
2124                                                                                           (void *) &dbid,
2125                                                                                           HASH_FIND, NULL);
2126 }
2127
2128
2129 /* ----------
2130  * pgstat_fetch_stat_tabentry() -
2131  *
2132  *      Support function for the SQL-callable pgstat* functions. Returns
2133  *      the collected statistics for one table or NULL. NULL doesn't mean
2134  *      that the table doesn't exist, it is just not yet known by the
2135  *      collector, so the caller is better off to report ZERO instead.
2136  * ----------
2137  */
2138 PgStat_StatTabEntry *
2139 pgstat_fetch_stat_tabentry(Oid relid)
2140 {
2141         Oid                     dbid;
2142         PgStat_StatDBEntry *dbentry;
2143         PgStat_StatTabEntry *tabentry;
2144
2145         /*
2146          * If not done for this transaction, read the statistics collector stats
2147          * file into some hash tables.
2148          */
2149         backend_read_statsfile();
2150
2151         /*
2152          * Lookup our database, then look in its table hash table.
2153          */
2154         dbid = MyDatabaseId;
2155         dbentry = (PgStat_StatDBEntry *) hash_search(pgStatDBHash,
2156                                                                                                  (void *) &dbid,
2157                                                                                                  HASH_FIND, NULL);
2158         if (dbentry != NULL && dbentry->tables != NULL)
2159         {
2160                 tabentry = (PgStat_StatTabEntry *) hash_search(dbentry->tables,
2161                                                                                                            (void *) &relid,
2162                                                                                                            HASH_FIND, NULL);
2163                 if (tabentry)
2164                         return tabentry;
2165         }
2166
2167         /*
2168          * If we didn't find it, maybe it's a shared table.
2169          */
2170         dbid = InvalidOid;
2171         dbentry = (PgStat_StatDBEntry *) hash_search(pgStatDBHash,
2172                                                                                                  (void *) &dbid,
2173                                                                                                  HASH_FIND, NULL);
2174         if (dbentry != NULL && dbentry->tables != NULL)
2175         {
2176                 tabentry = (PgStat_StatTabEntry *) hash_search(dbentry->tables,
2177                                                                                                            (void *) &relid,
2178                                                                                                            HASH_FIND, NULL);
2179                 if (tabentry)
2180                         return tabentry;
2181         }
2182
2183         return NULL;
2184 }
2185
2186
2187 /* ----------
2188  * pgstat_fetch_stat_funcentry() -
2189  *
2190  *      Support function for the SQL-callable pgstat* functions. Returns
2191  *      the collected statistics for one function or NULL.
2192  * ----------
2193  */
2194 PgStat_StatFuncEntry *
2195 pgstat_fetch_stat_funcentry(Oid func_id)
2196 {
2197         PgStat_StatDBEntry *dbentry;
2198         PgStat_StatFuncEntry *funcentry = NULL;
2199
2200         /* load the stats file if needed */
2201         backend_read_statsfile();
2202
2203         /* Lookup our database, then find the requested function.  */
2204         dbentry = pgstat_fetch_stat_dbentry(MyDatabaseId);
2205         if (dbentry != NULL && dbentry->functions != NULL)
2206         {
2207                 funcentry = (PgStat_StatFuncEntry *) hash_search(dbentry->functions,
2208                                                                                                                  (void *) &func_id,
2209                                                                                                                  HASH_FIND, NULL);
2210         }
2211
2212         return funcentry;
2213 }
2214
2215
2216 /* ----------
2217  * pgstat_fetch_stat_beentry() -
2218  *
2219  *      Support function for the SQL-callable pgstat* functions. Returns
2220  *      our local copy of the current-activity entry for one backend.
2221  *
2222  *      NB: caller is responsible for a check if the user is permitted to see
2223  *      this info (especially the querystring).
2224  * ----------
2225  */
2226 PgBackendStatus *
2227 pgstat_fetch_stat_beentry(int beid)
2228 {
2229         pgstat_read_current_status();
2230
2231         if (beid < 1 || beid > localNumBackends)
2232                 return NULL;
2233
2234         return &localBackendStatusTable[beid - 1];
2235 }
2236
2237
2238 /* ----------
2239  * pgstat_fetch_stat_numbackends() -
2240  *
2241  *      Support function for the SQL-callable pgstat* functions. Returns
2242  *      the maximum current backend id.
2243  * ----------
2244  */
2245 int
2246 pgstat_fetch_stat_numbackends(void)
2247 {
2248         pgstat_read_current_status();
2249
2250         return localNumBackends;
2251 }
2252
2253 /*
2254  * ---------
2255  * pgstat_fetch_global() -
2256  *
2257  *      Support function for the SQL-callable pgstat* functions. Returns
2258  *      a pointer to the global statistics struct.
2259  * ---------
2260  */
2261 PgStat_GlobalStats *
2262 pgstat_fetch_global(void)
2263 {
2264         backend_read_statsfile();
2265
2266         return &globalStats;
2267 }
2268
2269
2270 /* ------------------------------------------------------------
2271  * Functions for management of the shared-memory PgBackendStatus array
2272  * ------------------------------------------------------------
2273  */
2274
2275 static PgBackendStatus *BackendStatusArray = NULL;
2276 static PgBackendStatus *MyBEEntry = NULL;
2277 static char *BackendClientHostnameBuffer = NULL;
2278 static char *BackendAppnameBuffer = NULL;
2279 static char *BackendActivityBuffer = NULL;
2280 static Size BackendActivityBufferSize = 0;
2281
2282
2283 /*
2284  * Report shared-memory space needed by CreateSharedBackendStatus.
2285  */
2286 Size
2287 BackendStatusShmemSize(void)
2288 {
2289         Size            size;
2290
2291         size = mul_size(sizeof(PgBackendStatus), MaxBackends);
2292         size = add_size(size,
2293                                         mul_size(NAMEDATALEN, MaxBackends));
2294         size = add_size(size,
2295                                         mul_size(pgstat_track_activity_query_size, MaxBackends));
2296         size = add_size(size,
2297                                         mul_size(NAMEDATALEN, MaxBackends));
2298         return size;
2299 }
2300
2301 /*
2302  * Initialize the shared status array and several string buffers
2303  * during postmaster startup.
2304  */
2305 void
2306 CreateSharedBackendStatus(void)
2307 {
2308         Size            size;
2309         bool            found;
2310         int                     i;
2311         char       *buffer;
2312
2313         /* Create or attach to the shared array */
2314         size = mul_size(sizeof(PgBackendStatus), MaxBackends);
2315         BackendStatusArray = (PgBackendStatus *)
2316                 ShmemInitStruct("Backend Status Array", size, &found);
2317
2318         if (!found)
2319         {
2320                 /*
2321                  * We're the first - initialize.
2322                  */
2323                 MemSet(BackendStatusArray, 0, size);
2324         }
2325
2326         /* Create or attach to the shared appname buffer */
2327         size = mul_size(NAMEDATALEN, MaxBackends);
2328         BackendAppnameBuffer = (char *)
2329                 ShmemInitStruct("Backend Application Name Buffer", size, &found);
2330
2331         if (!found)
2332         {
2333                 MemSet(BackendAppnameBuffer, 0, size);
2334
2335                 /* Initialize st_appname pointers. */
2336                 buffer = BackendAppnameBuffer;
2337                 for (i = 0; i < MaxBackends; i++)
2338                 {
2339                         BackendStatusArray[i].st_appname = buffer;
2340                         buffer += NAMEDATALEN;
2341                 }
2342         }
2343
2344         /* Create or attach to the shared client hostname buffer */
2345         size = mul_size(NAMEDATALEN, MaxBackends);
2346         BackendClientHostnameBuffer = (char *)
2347                 ShmemInitStruct("Backend Client Host Name Buffer", size, &found);
2348
2349         if (!found)
2350         {
2351                 MemSet(BackendClientHostnameBuffer, 0, size);
2352
2353                 /* Initialize st_clienthostname pointers. */
2354                 buffer = BackendClientHostnameBuffer;
2355                 for (i = 0; i < MaxBackends; i++)
2356                 {
2357                         BackendStatusArray[i].st_clienthostname = buffer;
2358                         buffer += NAMEDATALEN;
2359                 }
2360         }
2361
2362         /* Create or attach to the shared activity buffer */
2363         BackendActivityBufferSize = mul_size(pgstat_track_activity_query_size,
2364                                                                                  MaxBackends);
2365         BackendActivityBuffer = (char *)
2366                 ShmemInitStruct("Backend Activity Buffer",
2367                                                 BackendActivityBufferSize,
2368                                                 &found);
2369
2370         if (!found)
2371         {
2372                 MemSet(BackendActivityBuffer, 0, size);
2373
2374                 /* Initialize st_activity pointers. */
2375                 buffer = BackendActivityBuffer;
2376                 for (i = 0; i < MaxBackends; i++)
2377                 {
2378                         BackendStatusArray[i].st_activity = buffer;
2379                         buffer += pgstat_track_activity_query_size;
2380                 }
2381         }
2382 }
2383
2384
2385 /* ----------
2386  * pgstat_initialize() -
2387  *
2388  *      Initialize pgstats state, and set up our on-proc-exit hook.
2389  *      Called from InitPostgres.  MyBackendId must be set,
2390  *      but we must not have started any transaction yet (since the
2391  *      exit hook must run after the last transaction exit).
2392  *      NOTE: MyDatabaseId isn't set yet; so the shutdown hook has to be careful.
2393  * ----------
2394  */
2395 void
2396 pgstat_initialize(void)
2397 {
2398         /* Initialize MyBEEntry */
2399         Assert(MyBackendId >= 1 && MyBackendId <= MaxBackends);
2400         MyBEEntry = &BackendStatusArray[MyBackendId - 1];
2401
2402         /* Set up a process-exit hook to clean up */
2403         on_shmem_exit(pgstat_beshutdown_hook, 0);
2404 }
2405
2406 /* ----------
2407  * pgstat_bestart() -
2408  *
2409  *      Initialize this backend's entry in the PgBackendStatus array.
2410  *      Called from InitPostgres.
2411  *      MyDatabaseId, session userid, and application_name must be set
2412  *      (hence, this cannot be combined with pgstat_initialize).
2413  * ----------
2414  */
2415 void
2416 pgstat_bestart(void)
2417 {
2418         TimestampTz proc_start_timestamp;
2419         Oid                     userid;
2420         SockAddr        clientaddr;
2421         volatile PgBackendStatus *beentry;
2422
2423         /*
2424          * To minimize the time spent modifying the PgBackendStatus entry, fetch
2425          * all the needed data first.
2426          *
2427          * If we have a MyProcPort, use its session start time (for consistency,
2428          * and to save a kernel call).
2429          */
2430         if (MyProcPort)
2431                 proc_start_timestamp = MyProcPort->SessionStartTime;
2432         else
2433                 proc_start_timestamp = GetCurrentTimestamp();
2434         userid = GetSessionUserId();
2435
2436         /*
2437          * We may not have a MyProcPort (eg, if this is the autovacuum process).
2438          * If so, use all-zeroes client address, which is dealt with specially in
2439          * pg_stat_get_backend_client_addr and pg_stat_get_backend_client_port.
2440          */
2441         if (MyProcPort)
2442                 memcpy(&clientaddr, &MyProcPort->raddr, sizeof(clientaddr));
2443         else
2444                 MemSet(&clientaddr, 0, sizeof(clientaddr));
2445
2446         /*
2447          * Initialize my status entry, following the protocol of bumping
2448          * st_changecount before and after; and make sure it's even afterwards. We
2449          * use a volatile pointer here to ensure the compiler doesn't try to get
2450          * cute.
2451          */
2452         beentry = MyBEEntry;
2453         do
2454         {
2455                 beentry->st_changecount++;
2456         } while ((beentry->st_changecount & 1) == 0);
2457
2458         beentry->st_procpid = MyProcPid;
2459         beentry->st_proc_start_timestamp = proc_start_timestamp;
2460         beentry->st_activity_start_timestamp = 0;
2461         beentry->st_state_start_timestamp = 0;
2462         beentry->st_xact_start_timestamp = 0;
2463         beentry->st_databaseid = MyDatabaseId;
2464         beentry->st_userid = userid;
2465         beentry->st_clientaddr = clientaddr;
2466         beentry->st_clienthostname[0] = '\0';
2467         beentry->st_waiting = false;
2468         beentry->st_state = STATE_UNDEFINED;
2469         beentry->st_appname[0] = '\0';
2470         beentry->st_activity[0] = '\0';
2471         /* Also make sure the last byte in each string area is always 0 */
2472         beentry->st_clienthostname[NAMEDATALEN - 1] = '\0';
2473         beentry->st_appname[NAMEDATALEN - 1] = '\0';
2474         beentry->st_activity[pgstat_track_activity_query_size - 1] = '\0';
2475
2476         beentry->st_changecount++;
2477         Assert((beentry->st_changecount & 1) == 0);
2478
2479         if (MyProcPort && MyProcPort->remote_hostname)
2480                 strlcpy(beentry->st_clienthostname, MyProcPort->remote_hostname, NAMEDATALEN);
2481
2482         /* Update app name to current GUC setting */
2483         if (application_name)
2484                 pgstat_report_appname(application_name);
2485 }
2486
2487 /*
2488  * Shut down a single backend's statistics reporting at process exit.
2489  *
2490  * Flush any remaining statistics counts out to the collector.
2491  * Without this, operations triggered during backend exit (such as
2492  * temp table deletions) won't be counted.
2493  *
2494  * Lastly, clear out our entry in the PgBackendStatus array.
2495  */
2496 static void
2497 pgstat_beshutdown_hook(int code, Datum arg)
2498 {
2499         volatile PgBackendStatus *beentry = MyBEEntry;
2500
2501         /*
2502          * If we got as far as discovering our own database ID, we can report what
2503          * we did to the collector.  Otherwise, we'd be sending an invalid
2504          * database ID, so forget it.  (This means that accesses to pg_database
2505          * during failed backend starts might never get counted.)
2506          */
2507         if (OidIsValid(MyDatabaseId))
2508                 pgstat_report_stat(true);
2509
2510         /*
2511          * Clear my status entry, following the protocol of bumping st_changecount
2512          * before and after.  We use a volatile pointer here to ensure the
2513          * compiler doesn't try to get cute.
2514          */
2515         beentry->st_changecount++;
2516
2517         beentry->st_procpid = 0;        /* mark invalid */
2518
2519         beentry->st_changecount++;
2520         Assert((beentry->st_changecount & 1) == 0);
2521 }
2522
2523
2524 /* ----------
2525  * pgstat_report_activity() -
2526  *
2527  *      Called from tcop/postgres.c to report what the backend is actually doing
2528  *      (usually "<IDLE>" or the start of the query to be executed).
2529  *
2530  * All updates of the status entry follow the protocol of bumping
2531  * st_changecount before and after.  We use a volatile pointer here to
2532  * ensure the compiler doesn't try to get cute.
2533  * ----------
2534  */
2535 void
2536 pgstat_report_activity(BackendState state, const char *cmd_str)
2537 {
2538         volatile PgBackendStatus *beentry = MyBEEntry;
2539         TimestampTz start_timestamp;
2540         TimestampTz current_timestamp;
2541         int                     len = 0;
2542
2543         TRACE_POSTGRESQL_STATEMENT_STATUS(cmd_str);
2544
2545         if (!beentry)
2546                 return;
2547
2548         /*
2549          * To minimize the time spent modifying the entry, fetch all the needed
2550          * data first.
2551          */
2552         current_timestamp = GetCurrentTimestamp();
2553
2554         if (!pgstat_track_activities && beentry->st_state != STATE_DISABLED)
2555         {
2556                 /*
2557                  * Track activities is disabled, but we have a non-disabled state set.
2558                  * That means the status changed - so as our last update, tell the
2559                  * collector that we disabled it and will no longer update.
2560                  */
2561                 beentry->st_changecount++;
2562                 beentry->st_state = STATE_DISABLED;
2563                 beentry->st_state_start_timestamp = current_timestamp;
2564                 beentry->st_changecount++;
2565                 Assert((beentry->st_changecount & 1) == 0);
2566                 return;
2567         }
2568
2569         /*
2570          * Fetch more data before we start modifying the entry
2571          */
2572         start_timestamp = GetCurrentStatementStartTimestamp();
2573         if (cmd_str != NULL)
2574         {
2575                 len = pg_mbcliplen(cmd_str, strlen(cmd_str),
2576                                                    pgstat_track_activity_query_size - 1);
2577         }
2578
2579         /*
2580          * Now update the status entry
2581          */
2582         beentry->st_changecount++;
2583
2584         beentry->st_state = state;
2585         beentry->st_state_start_timestamp = current_timestamp;
2586
2587         if (cmd_str != NULL)
2588         {
2589                 memcpy((char *) beentry->st_activity, cmd_str, len);
2590                 beentry->st_activity[len] = '\0';
2591                 beentry->st_activity_start_timestamp = start_timestamp;
2592         }
2593
2594         beentry->st_changecount++;
2595         Assert((beentry->st_changecount & 1) == 0);
2596 }
2597
2598 /* ----------
2599  * pgstat_report_appname() -
2600  *
2601  *      Called to update our application name.
2602  * ----------
2603  */
2604 void
2605 pgstat_report_appname(const char *appname)
2606 {
2607         volatile PgBackendStatus *beentry = MyBEEntry;
2608         int                     len;
2609
2610         if (!beentry)
2611                 return;
2612
2613         /* This should be unnecessary if GUC did its job, but be safe */
2614         len = pg_mbcliplen(appname, strlen(appname), NAMEDATALEN - 1);
2615
2616         /*
2617          * Update my status entry, following the protocol of bumping
2618          * st_changecount before and after.  We use a volatile pointer here to
2619          * ensure the compiler doesn't try to get cute.
2620          */
2621         beentry->st_changecount++;
2622
2623         memcpy((char *) beentry->st_appname, appname, len);
2624         beentry->st_appname[len] = '\0';
2625
2626         beentry->st_changecount++;
2627         Assert((beentry->st_changecount & 1) == 0);
2628 }
2629
2630 /*
2631  * Report current transaction start timestamp as the specified value.
2632  * Zero means there is no active transaction.
2633  */
2634 void
2635 pgstat_report_xact_timestamp(TimestampTz tstamp)
2636 {
2637         volatile PgBackendStatus *beentry = MyBEEntry;
2638
2639         if (!pgstat_track_activities || !beentry)
2640                 return;
2641
2642         /*
2643          * Update my status entry, following the protocol of bumping
2644          * st_changecount before and after.  We use a volatile pointer here to
2645          * ensure the compiler doesn't try to get cute.
2646          */
2647         beentry->st_changecount++;
2648         beentry->st_xact_start_timestamp = tstamp;
2649         beentry->st_changecount++;
2650         Assert((beentry->st_changecount & 1) == 0);
2651 }
2652
2653 /* ----------
2654  * pgstat_report_waiting() -
2655  *
2656  *      Called from lock manager to report beginning or end of a lock wait.
2657  *
2658  * NB: this *must* be able to survive being called before MyBEEntry has been
2659  * initialized.
2660  * ----------
2661  */
2662 void
2663 pgstat_report_waiting(bool waiting)
2664 {
2665         volatile PgBackendStatus *beentry = MyBEEntry;
2666
2667         if (!pgstat_track_activities || !beentry)
2668                 return;
2669
2670         /*
2671          * Since this is a single-byte field in a struct that only this process
2672          * may modify, there seems no need to bother with the st_changecount
2673          * protocol.  The update must appear atomic in any case.
2674          */
2675         beentry->st_waiting = waiting;
2676 }
2677
2678
2679 /* ----------
2680  * pgstat_read_current_status() -
2681  *
2682  *      Copy the current contents of the PgBackendStatus array to local memory,
2683  *      if not already done in this transaction.
2684  * ----------
2685  */
2686 static void
2687 pgstat_read_current_status(void)
2688 {
2689         volatile PgBackendStatus *beentry;
2690         PgBackendStatus *localtable;
2691         PgBackendStatus *localentry;
2692         char       *localappname,
2693                            *localactivity;
2694         int                     i;
2695
2696         Assert(!pgStatRunningInCollector);
2697         if (localBackendStatusTable)
2698                 return;                                 /* already done */
2699
2700         pgstat_setup_memcxt();
2701
2702         localtable = (PgBackendStatus *)
2703                 MemoryContextAlloc(pgStatLocalContext,
2704                                                    sizeof(PgBackendStatus) * MaxBackends);
2705         localappname = (char *)
2706                 MemoryContextAlloc(pgStatLocalContext,
2707                                                    NAMEDATALEN * MaxBackends);
2708         localactivity = (char *)
2709                 MemoryContextAlloc(pgStatLocalContext,
2710                                                    pgstat_track_activity_query_size * MaxBackends);
2711         localNumBackends = 0;
2712
2713         beentry = BackendStatusArray;
2714         localentry = localtable;
2715         for (i = 1; i <= MaxBackends; i++)
2716         {
2717                 /*
2718                  * Follow the protocol of retrying if st_changecount changes while we
2719                  * copy the entry, or if it's odd.  (The check for odd is needed to
2720                  * cover the case where we are able to completely copy the entry while
2721                  * the source backend is between increment steps.)      We use a volatile
2722                  * pointer here to ensure the compiler doesn't try to get cute.
2723                  */
2724                 for (;;)
2725                 {
2726                         int                     save_changecount = beentry->st_changecount;
2727
2728                         localentry->st_procpid = beentry->st_procpid;
2729                         if (localentry->st_procpid > 0)
2730                         {
2731                                 memcpy(localentry, (char *) beentry, sizeof(PgBackendStatus));
2732
2733                                 /*
2734                                  * strcpy is safe even if the string is modified concurrently,
2735                                  * because there's always a \0 at the end of the buffer.
2736                                  */
2737                                 strcpy(localappname, (char *) beentry->st_appname);
2738                                 localentry->st_appname = localappname;
2739                                 strcpy(localactivity, (char *) beentry->st_activity);
2740                                 localentry->st_activity = localactivity;
2741                         }
2742
2743                         if (save_changecount == beentry->st_changecount &&
2744                                 (save_changecount & 1) == 0)
2745                                 break;
2746
2747                         /* Make sure we can break out of loop if stuck... */
2748                         CHECK_FOR_INTERRUPTS();
2749                 }
2750
2751                 beentry++;
2752                 /* Only valid entries get included into the local array */
2753                 if (localentry->st_procpid > 0)
2754                 {
2755                         localentry++;
2756                         localappname += NAMEDATALEN;
2757                         localactivity += pgstat_track_activity_query_size;
2758                         localNumBackends++;
2759                 }
2760         }
2761
2762         /* Set the pointer only after completion of a valid table */
2763         localBackendStatusTable = localtable;
2764 }
2765
2766
2767 /* ----------
2768  * pgstat_get_backend_current_activity() -
2769  *
2770  *      Return a string representing the current activity of the backend with
2771  *      the specified PID.      This looks directly at the BackendStatusArray,
2772  *      and so will provide current information regardless of the age of our
2773  *      transaction's snapshot of the status array.
2774  *
2775  *      It is the caller's responsibility to invoke this only for backends whose
2776  *      state is expected to remain stable while the result is in use.  The
2777  *      only current use is in deadlock reporting, where we can expect that
2778  *      the target backend is blocked on a lock.  (There are corner cases
2779  *      where the target's wait could get aborted while we are looking at it,
2780  *      but the very worst consequence is to return a pointer to a string
2781  *      that's been changed, so we won't worry too much.)
2782  *
2783  *      Note: return strings for special cases match pg_stat_get_backend_activity.
2784  * ----------
2785  */
2786 const char *
2787 pgstat_get_backend_current_activity(int pid, bool checkUser)
2788 {
2789         PgBackendStatus *beentry;
2790         int                     i;
2791
2792         beentry = BackendStatusArray;
2793         for (i = 1; i <= MaxBackends; i++)
2794         {
2795                 /*
2796                  * Although we expect the target backend's entry to be stable, that
2797                  * doesn't imply that anyone else's is.  To avoid identifying the
2798                  * wrong backend, while we check for a match to the desired PID we
2799                  * must follow the protocol of retrying if st_changecount changes
2800                  * while we examine the entry, or if it's odd.  (This might be
2801                  * unnecessary, since fetching or storing an int is almost certainly
2802                  * atomic, but let's play it safe.)  We use a volatile pointer here to
2803                  * ensure the compiler doesn't try to get cute.
2804                  */
2805                 volatile PgBackendStatus *vbeentry = beentry;
2806                 bool            found;
2807
2808                 for (;;)
2809                 {
2810                         int                     save_changecount = vbeentry->st_changecount;
2811
2812                         found = (vbeentry->st_procpid == pid);
2813
2814                         if (save_changecount == vbeentry->st_changecount &&
2815                                 (save_changecount & 1) == 0)
2816                                 break;
2817
2818                         /* Make sure we can break out of loop if stuck... */
2819                         CHECK_FOR_INTERRUPTS();
2820                 }
2821
2822                 if (found)
2823                 {
2824                         /* Now it is safe to use the non-volatile pointer */
2825                         if (checkUser && !superuser() && beentry->st_userid != GetUserId())
2826                                 return "<insufficient privilege>";
2827                         else if (*(beentry->st_activity) == '\0')
2828                                 return "<command string not enabled>";
2829                         else
2830                                 return beentry->st_activity;
2831                 }
2832
2833                 beentry++;
2834         }
2835
2836         /* If we get here, caller is in error ... */
2837         return "<backend information not available>";
2838 }
2839
2840 /* ----------
2841  * pgstat_get_crashed_backend_activity() -
2842  *
2843  *      Return a string representing the current activity of the backend with
2844  *      the specified PID.  Like the function above, but reads shared memory with
2845  *      the expectation that it may be corrupt.  On success, copy the string
2846  *      into the "buffer" argument and return that pointer.  On failure,
2847  *      return NULL.
2848  *
2849  *      This function is only intended to be used by the postmaster to report the
2850  *      query that crashed a backend.  In particular, no attempt is made to
2851  *      follow the correct concurrency protocol when accessing the
2852  *      BackendStatusArray.  But that's OK, in the worst case we'll return a
2853  *      corrupted message.  We also must take care not to trip on ereport(ERROR).
2854  * ----------
2855  */
2856 const char *
2857 pgstat_get_crashed_backend_activity(int pid, char *buffer, int buflen)
2858 {
2859         volatile PgBackendStatus *beentry;
2860         int                     i;
2861
2862         beentry = BackendStatusArray;
2863
2864         /*
2865          * We probably shouldn't get here before shared memory has been set up,
2866          * but be safe.
2867          */
2868         if (beentry == NULL || BackendActivityBuffer == NULL)
2869                 return NULL;
2870
2871         for (i = 1; i <= MaxBackends; i++)
2872         {
2873                 if (beentry->st_procpid == pid)
2874                 {
2875                         /* Read pointer just once, so it can't change after validation */
2876                         const char *activity = beentry->st_activity;
2877                         const char *activity_last;
2878
2879                         /*
2880                          * We mustn't access activity string before we verify that it
2881                          * falls within the BackendActivityBuffer. To make sure that the
2882                          * entire string including its ending is contained within the
2883                          * buffer, subtract one activity length from the buffer size.
2884                          */
2885                         activity_last = BackendActivityBuffer + BackendActivityBufferSize
2886                                 - pgstat_track_activity_query_size;
2887
2888                         if (activity < BackendActivityBuffer ||
2889                                 activity > activity_last)
2890                                 return NULL;
2891
2892                         /* If no string available, no point in a report */
2893                         if (activity[0] == '\0')
2894                                 return NULL;
2895
2896                         /*
2897                          * Copy only ASCII-safe characters so we don't run into encoding
2898                          * problems when reporting the message; and be sure not to run
2899                          * off the end of memory.
2900                          */
2901                         ascii_safe_strlcpy(buffer, activity,
2902                                                            Min(buflen, pgstat_track_activity_query_size));
2903
2904                         return buffer;
2905                 }
2906
2907                 beentry++;
2908         }
2909
2910         /* PID not found */
2911         return NULL;
2912 }
2913
2914
2915 /* ------------------------------------------------------------
2916  * Local support functions follow
2917  * ------------------------------------------------------------
2918  */
2919
2920
2921 /* ----------
2922  * pgstat_setheader() -
2923  *
2924  *              Set common header fields in a statistics message
2925  * ----------
2926  */
2927 static void
2928 pgstat_setheader(PgStat_MsgHdr *hdr, StatMsgType mtype)
2929 {
2930         hdr->m_type = mtype;
2931 }
2932
2933
2934 /* ----------
2935  * pgstat_send() -
2936  *
2937  *              Send out one statistics message to the collector
2938  * ----------
2939  */
2940 static void
2941 pgstat_send(void *msg, int len)
2942 {
2943         int                     rc;
2944
2945         if (pgStatSock == PGINVALID_SOCKET)
2946                 return;
2947
2948         ((PgStat_MsgHdr *) msg)->m_size = len;
2949
2950         /* We'll retry after EINTR, but ignore all other failures */
2951         do
2952         {
2953                 rc = send(pgStatSock, msg, len, 0);
2954         } while (rc < 0 && errno == EINTR);
2955
2956 #ifdef USE_ASSERT_CHECKING
2957         /* In debug builds, log send failures ... */
2958         if (rc < 0)
2959                 elog(LOG, "could not send to statistics collector: %m");
2960 #endif
2961 }
2962
2963 /* ----------
2964  * pgstat_send_bgwriter() -
2965  *
2966  *              Send bgwriter statistics to the collector
2967  * ----------
2968  */
2969 void
2970 pgstat_send_bgwriter(void)
2971 {
2972         /* We assume this initializes to zeroes */
2973         static const PgStat_MsgBgWriter all_zeroes;
2974
2975         /*
2976          * This function can be called even if nothing at all has happened. In
2977          * this case, avoid sending a completely empty message to the stats
2978          * collector.
2979          */
2980         if (memcmp(&BgWriterStats, &all_zeroes, sizeof(PgStat_MsgBgWriter)) == 0)
2981                 return;
2982
2983         /*
2984          * Prepare and send the message
2985          */
2986         pgstat_setheader(&BgWriterStats.m_hdr, PGSTAT_MTYPE_BGWRITER);
2987         pgstat_send(&BgWriterStats, sizeof(BgWriterStats));
2988
2989         /*
2990          * Clear out the statistics buffer, so it can be re-used.
2991          */
2992         MemSet(&BgWriterStats, 0, sizeof(BgWriterStats));
2993 }
2994
2995
2996 /* ----------
2997  * PgstatCollectorMain() -
2998  *
2999  *      Start up the statistics collector process.      This is the body of the
3000  *      postmaster child process.
3001  *
3002  *      The argc/argv parameters are valid only in EXEC_BACKEND case.
3003  * ----------
3004  */
3005 NON_EXEC_STATIC void
3006 PgstatCollectorMain(int argc, char *argv[])
3007 {
3008         int                     len;
3009         PgStat_Msg      msg;
3010
3011 #ifndef WIN32
3012 #ifdef HAVE_POLL
3013         struct pollfd input_fd;
3014 #else
3015         struct timeval sel_timeout;
3016         fd_set          rfds;
3017 #endif
3018 #endif
3019
3020         IsUnderPostmaster = true;       /* we are a postmaster subprocess now */
3021
3022         MyProcPid = getpid();           /* reset MyProcPid */
3023
3024         MyStartTime = time(NULL);       /* record Start Time for logging */
3025
3026         /*
3027          * If possible, make this process a group leader, so that the postmaster
3028          * can signal any child processes too.  (pgstat probably never has any
3029          * child processes, but for consistency we make all postmaster child
3030          * processes do this.)
3031          */
3032 #ifdef HAVE_SETSID
3033         if (setsid() < 0)
3034                 elog(FATAL, "setsid() failed: %m");
3035 #endif
3036
3037         /*
3038          * Ignore all signals usually bound to some action in the postmaster,
3039          * except SIGQUIT.
3040          */
3041         pqsignal(SIGHUP, pgstat_sighup_handler);
3042         pqsignal(SIGINT, SIG_IGN);
3043         pqsignal(SIGTERM, SIG_IGN);
3044         pqsignal(SIGQUIT, pgstat_exit);
3045         pqsignal(SIGALRM, SIG_IGN);
3046         pqsignal(SIGPIPE, SIG_IGN);
3047         pqsignal(SIGUSR1, SIG_IGN);
3048         pqsignal(SIGUSR2, SIG_IGN);
3049         pqsignal(SIGCHLD, SIG_DFL);
3050         pqsignal(SIGTTIN, SIG_DFL);
3051         pqsignal(SIGTTOU, SIG_DFL);
3052         pqsignal(SIGCONT, SIG_DFL);
3053         pqsignal(SIGWINCH, SIG_DFL);
3054         PG_SETMASK(&UnBlockSig);
3055
3056         /*
3057          * Identify myself via ps
3058          */
3059         init_ps_display("stats collector process", "", "", "");
3060
3061         /*
3062          * Arrange to write the initial status file right away
3063          */
3064         last_statrequest = GetCurrentTimestamp();
3065         last_statwrite = last_statrequest - 1;
3066
3067         /*
3068          * Read in an existing statistics stats file or initialize the stats to
3069          * zero.
3070          */
3071         pgStatRunningInCollector = true;
3072         pgStatDBHash = pgstat_read_statsfile(InvalidOid, true);
3073
3074         /*
3075          * Setup the descriptor set for select(2).      Since only one bit in the set
3076          * ever changes, we need not repeat FD_ZERO each time.
3077          */
3078 #if !defined(HAVE_POLL) && !defined(WIN32)
3079         FD_ZERO(&rfds);
3080 #endif
3081
3082         /*
3083          * Loop to process messages until we get SIGQUIT or detect ungraceful
3084          * death of our parent postmaster.
3085          *
3086          * For performance reasons, we don't want to do a PostmasterIsAlive() test
3087          * after every message; instead, do it only when select()/poll() is
3088          * interrupted by timeout.      In essence, we'll stay alive as long as
3089          * backends keep sending us stuff often, even if the postmaster is gone.
3090          */
3091         for (;;)
3092         {
3093                 int                     got_data;
3094
3095                 /*
3096                  * Quit if we get SIGQUIT from the postmaster.
3097                  */
3098                 if (need_exit)
3099                         break;
3100
3101                 /*
3102                  * Reload configuration if we got SIGHUP from the postmaster.
3103                  */
3104                 if (got_SIGHUP)
3105                 {
3106                         ProcessConfigFile(PGC_SIGHUP);
3107                         got_SIGHUP = false;
3108                 }
3109
3110                 /*
3111                  * Write the stats file if a new request has arrived that is not
3112                  * satisfied by existing file.
3113                  */
3114                 if (last_statwrite < last_statrequest)
3115                         pgstat_write_statsfile(false);
3116
3117                 /*
3118                  * Wait for a message to arrive; but not for more than
3119                  * PGSTAT_SELECT_TIMEOUT seconds. (This determines how quickly we will
3120                  * shut down after an ungraceful postmaster termination; so it needn't
3121                  * be very fast.  However, on some systems SIGQUIT won't interrupt the
3122                  * poll/select call, so this also limits speed of response to SIGQUIT,
3123                  * which is more important.)
3124                  *
3125                  * We use poll(2) if available, otherwise select(2). Win32 has its own
3126                  * implementation.
3127                  */
3128 #ifndef WIN32
3129 #ifdef HAVE_POLL
3130                 input_fd.fd = pgStatSock;
3131                 input_fd.events = POLLIN | POLLERR;
3132                 input_fd.revents = 0;
3133
3134                 if (poll(&input_fd, 1, PGSTAT_SELECT_TIMEOUT * 1000) < 0)
3135                 {
3136                         if (errno == EINTR)
3137                                 continue;
3138                         ereport(ERROR,
3139                                         (errcode_for_socket_access(),
3140                                          errmsg("poll() failed in statistics collector: %m")));
3141                 }
3142
3143                 got_data = (input_fd.revents != 0);
3144 #else                                                   /* !HAVE_POLL */
3145
3146                 FD_SET(pgStatSock, &rfds);
3147
3148                 /*
3149                  * timeout struct is modified by select() on some operating systems,
3150                  * so re-fill it each time.
3151                  */
3152                 sel_timeout.tv_sec = PGSTAT_SELECT_TIMEOUT;
3153                 sel_timeout.tv_usec = 0;
3154
3155                 if (select(pgStatSock + 1, &rfds, NULL, NULL, &sel_timeout) < 0)
3156                 {
3157                         if (errno == EINTR)
3158                                 continue;
3159                         ereport(ERROR,
3160                                         (errcode_for_socket_access(),
3161                                          errmsg("select() failed in statistics collector: %m")));
3162                 }
3163
3164                 got_data = FD_ISSET(pgStatSock, &rfds);
3165 #endif   /* HAVE_POLL */
3166 #else                                                   /* WIN32 */
3167                 got_data = pgwin32_waitforsinglesocket(pgStatSock, FD_READ,
3168                                                                                            PGSTAT_SELECT_TIMEOUT * 1000);
3169 #endif
3170
3171                 /*
3172                  * If there is a message on the socket, read it and check for
3173                  * validity.
3174                  */
3175                 if (got_data)
3176                 {
3177                         len = recv(pgStatSock, (char *) &msg,
3178                                            sizeof(PgStat_Msg), 0);
3179                         if (len < 0)
3180                         {
3181                                 if (errno == EINTR)
3182                                         continue;
3183                                 ereport(ERROR,
3184                                                 (errcode_for_socket_access(),
3185                                                  errmsg("could not read statistics message: %m")));
3186                         }
3187
3188                         /*
3189                          * We ignore messages that are smaller than our common header
3190                          */
3191                         if (len < sizeof(PgStat_MsgHdr))
3192                                 continue;
3193
3194                         /*
3195                          * The received length must match the length in the header
3196                          */
3197                         if (msg.msg_hdr.m_size != len)
3198                                 continue;
3199
3200                         /*
3201                          * O.K. - we accept this message.  Process it.
3202                          */
3203                         switch (msg.msg_hdr.m_type)
3204                         {
3205                                 case PGSTAT_MTYPE_DUMMY:
3206                                         break;
3207
3208                                 case PGSTAT_MTYPE_INQUIRY:
3209                                         pgstat_recv_inquiry((PgStat_MsgInquiry *) &msg, len);
3210                                         break;
3211
3212                                 case PGSTAT_MTYPE_TABSTAT:
3213                                         pgstat_recv_tabstat((PgStat_MsgTabstat *) &msg, len);
3214                                         break;
3215
3216                                 case PGSTAT_MTYPE_TABPURGE:
3217                                         pgstat_recv_tabpurge((PgStat_MsgTabpurge *) &msg, len);
3218                                         break;
3219
3220                                 case PGSTAT_MTYPE_DROPDB:
3221                                         pgstat_recv_dropdb((PgStat_MsgDropdb *) &msg, len);
3222                                         break;
3223
3224                                 case PGSTAT_MTYPE_RESETCOUNTER:
3225                                         pgstat_recv_resetcounter((PgStat_MsgResetcounter *) &msg,
3226                                                                                          len);
3227                                         break;
3228
3229                                 case PGSTAT_MTYPE_RESETSHAREDCOUNTER:
3230                                         pgstat_recv_resetsharedcounter(
3231                                                                            (PgStat_MsgResetsharedcounter *) &msg,
3232                                                                                                    len);
3233                                         break;
3234
3235                                 case PGSTAT_MTYPE_RESETSINGLECOUNTER:
3236                                         pgstat_recv_resetsinglecounter(
3237                                                                            (PgStat_MsgResetsinglecounter *) &msg,
3238                                                                                                    len);
3239                                         break;
3240
3241                                 case PGSTAT_MTYPE_AUTOVAC_START:
3242                                         pgstat_recv_autovac((PgStat_MsgAutovacStart *) &msg, len);
3243                                         break;
3244
3245                                 case PGSTAT_MTYPE_VACUUM:
3246                                         pgstat_recv_vacuum((PgStat_MsgVacuum *) &msg, len);
3247                                         break;
3248
3249                                 case PGSTAT_MTYPE_ANALYZE:
3250                                         pgstat_recv_analyze((PgStat_MsgAnalyze *) &msg, len);
3251                                         break;
3252
3253                                 case PGSTAT_MTYPE_BGWRITER:
3254                                         pgstat_recv_bgwriter((PgStat_MsgBgWriter *) &msg, len);
3255                                         break;
3256
3257                                 case PGSTAT_MTYPE_FUNCSTAT:
3258                                         pgstat_recv_funcstat((PgStat_MsgFuncstat *) &msg, len);
3259                                         break;
3260
3261                                 case PGSTAT_MTYPE_FUNCPURGE:
3262                                         pgstat_recv_funcpurge((PgStat_MsgFuncpurge *) &msg, len);
3263                                         break;
3264
3265                                 case PGSTAT_MTYPE_RECOVERYCONFLICT:
3266                                         pgstat_recv_recoveryconflict((PgStat_MsgRecoveryConflict *) &msg, len);
3267                                         break;
3268
3269                                 case PGSTAT_MTYPE_DEADLOCK:
3270                                         pgstat_recv_deadlock((PgStat_MsgDeadlock *) &msg, len);
3271                                         break;
3272
3273                                 case PGSTAT_MTYPE_TEMPFILE:
3274                                         pgstat_recv_tempfile((PgStat_MsgTempFile *) &msg, len);
3275                                         break;
3276
3277                                 default:
3278                                         break;
3279                         }
3280                 }
3281                 else
3282                 {
3283                         /*
3284                          * We can only get here if the select/poll timeout elapsed. Check
3285                          * for postmaster death.
3286                          */
3287                         if (!PostmasterIsAlive())
3288                                 break;
3289                 }
3290         }                                                       /* end of message-processing loop */
3291
3292         /*
3293          * Save the final stats to reuse at next startup.
3294          */
3295         pgstat_write_statsfile(true);
3296
3297         exit(0);
3298 }
3299
3300
3301 /* SIGQUIT signal handler for collector process */
3302 static void
3303 pgstat_exit(SIGNAL_ARGS)
3304 {
3305         need_exit = true;
3306 }
3307
3308 /* SIGHUP handler for collector process */
3309 static void
3310 pgstat_sighup_handler(SIGNAL_ARGS)
3311 {
3312         got_SIGHUP = true;
3313 }
3314
3315
3316 /*
3317  * Lookup the hash table entry for the specified database. If no hash
3318  * table entry exists, initialize it, if the create parameter is true.
3319  * Else, return NULL.
3320  */
3321 static PgStat_StatDBEntry *
3322 pgstat_get_db_entry(Oid databaseid, bool create)
3323 {
3324         PgStat_StatDBEntry *result;
3325         bool            found;
3326         HASHACTION      action = (create ? HASH_ENTER : HASH_FIND);
3327
3328         /* Lookup or create the hash table entry for this database */
3329         result = (PgStat_StatDBEntry *) hash_search(pgStatDBHash,
3330                                                                                                 &databaseid,
3331                                                                                                 action, &found);
3332
3333         if (!create && !found)
3334                 return NULL;
3335
3336         /* If not found, initialize the new one. */
3337         if (!found)
3338         {
3339                 HASHCTL         hash_ctl;
3340
3341                 result->tables = NULL;
3342                 result->functions = NULL;
3343                 result->n_xact_commit = 0;
3344                 result->n_xact_rollback = 0;
3345                 result->n_blocks_fetched = 0;
3346                 result->n_blocks_hit = 0;
3347                 result->n_tuples_returned = 0;
3348                 result->n_tuples_fetched = 0;
3349                 result->n_tuples_inserted = 0;
3350                 result->n_tuples_updated = 0;
3351                 result->n_tuples_deleted = 0;
3352                 result->last_autovac_time = 0;
3353                 result->n_conflict_tablespace = 0;
3354                 result->n_conflict_lock = 0;
3355                 result->n_conflict_snapshot = 0;
3356                 result->n_conflict_bufferpin = 0;
3357                 result->n_conflict_startup_deadlock = 0;
3358                 result->n_temp_files = 0;
3359                 result->n_temp_bytes = 0;
3360                 result->n_deadlocks = 0;
3361                 result->n_block_time_read = 0;
3362                 result->n_block_time_write = 0;
3363
3364                 result->stat_reset_timestamp = GetCurrentTimestamp();
3365
3366                 memset(&hash_ctl, 0, sizeof(hash_ctl));
3367                 hash_ctl.keysize = sizeof(Oid);
3368                 hash_ctl.entrysize = sizeof(PgStat_StatTabEntry);
3369                 hash_ctl.hash = oid_hash;
3370                 result->tables = hash_create("Per-database table",
3371                                                                          PGSTAT_TAB_HASH_SIZE,
3372                                                                          &hash_ctl,
3373                                                                          HASH_ELEM | HASH_FUNCTION);
3374
3375                 hash_ctl.keysize = sizeof(Oid);
3376                 hash_ctl.entrysize = sizeof(PgStat_StatFuncEntry);
3377                 hash_ctl.hash = oid_hash;
3378                 result->functions = hash_create("Per-database function",
3379                                                                                 PGSTAT_FUNCTION_HASH_SIZE,
3380                                                                                 &hash_ctl,
3381                                                                                 HASH_ELEM | HASH_FUNCTION);
3382         }
3383
3384         return result;
3385 }
3386
3387
3388 /*
3389  * Lookup the hash table entry for the specified table. If no hash
3390  * table entry exists, initialize it, if the create parameter is true.
3391  * Else, return NULL.
3392  */
3393 static PgStat_StatTabEntry *
3394 pgstat_get_tab_entry(PgStat_StatDBEntry *dbentry, Oid tableoid, bool create)
3395 {
3396         PgStat_StatTabEntry *result;
3397         bool            found;
3398         HASHACTION      action = (create ? HASH_ENTER : HASH_FIND);
3399
3400         /* Lookup or create the hash table entry for this table */
3401         result = (PgStat_StatTabEntry *) hash_search(dbentry->tables,
3402                                                                                                  &tableoid,
3403                                                                                                  action, &found);
3404
3405         if (!create && !found)
3406                 return NULL;
3407
3408         /* If not found, initialize the new one. */
3409         if (!found)
3410         {
3411                 result->numscans = 0;
3412                 result->tuples_returned = 0;
3413                 result->tuples_fetched = 0;
3414                 result->tuples_inserted = 0;
3415                 result->tuples_updated = 0;
3416                 result->tuples_deleted = 0;
3417                 result->tuples_hot_updated = 0;
3418                 result->n_live_tuples = 0;
3419                 result->n_dead_tuples = 0;
3420                 result->changes_since_analyze = 0;
3421                 result->blocks_fetched = 0;
3422                 result->blocks_hit = 0;
3423                 result->vacuum_timestamp = 0;
3424                 result->vacuum_count = 0;
3425                 result->autovac_vacuum_timestamp = 0;
3426                 result->autovac_vacuum_count = 0;
3427                 result->analyze_timestamp = 0;
3428                 result->analyze_count = 0;
3429                 result->autovac_analyze_timestamp = 0;
3430                 result->autovac_analyze_count = 0;
3431         }
3432
3433         return result;
3434 }
3435
3436
3437 /* ----------
3438  * pgstat_write_statsfile() -
3439  *
3440  *      Tell the news.
3441  *      If writing to the permanent file (happens when the collector is
3442  *      shutting down only), remove the temporary file so that backends
3443  *      starting up under a new postmaster can't read the old data before
3444  *      the new collector is ready.
3445  * ----------
3446  */
3447 static void
3448 pgstat_write_statsfile(bool permanent)
3449 {
3450         HASH_SEQ_STATUS hstat;
3451         HASH_SEQ_STATUS tstat;
3452         HASH_SEQ_STATUS fstat;
3453         PgStat_StatDBEntry *dbentry;
3454         PgStat_StatTabEntry *tabentry;
3455         PgStat_StatFuncEntry *funcentry;
3456         FILE       *fpout;
3457         int32           format_id;
3458         const char *tmpfile = permanent ? PGSTAT_STAT_PERMANENT_TMPFILE : pgstat_stat_tmpname;
3459         const char *statfile = permanent ? PGSTAT_STAT_PERMANENT_FILENAME : pgstat_stat_filename;
3460         int                     rc;
3461
3462         /*
3463          * Open the statistics temp file to write out the current values.
3464          */
3465         fpout = AllocateFile(tmpfile, PG_BINARY_W);
3466         if (fpout == NULL)
3467         {
3468                 ereport(LOG,
3469                                 (errcode_for_file_access(),
3470                                  errmsg("could not open temporary statistics file \"%s\": %m",
3471                                                 tmpfile)));
3472                 return;
3473         }
3474
3475         /*
3476          * Set the timestamp of the stats file.
3477          */
3478         globalStats.stats_timestamp = GetCurrentTimestamp();
3479
3480         /*
3481          * Write the file header --- currently just a format ID.
3482          */
3483         format_id = PGSTAT_FILE_FORMAT_ID;
3484         rc = fwrite(&format_id, sizeof(format_id), 1, fpout);
3485         (void) rc;                                      /* we'll check for error with ferror */
3486
3487         /*
3488          * Write global stats struct
3489          */
3490         rc = fwrite(&globalStats, sizeof(globalStats), 1, fpout);
3491         (void) rc;                                      /* we'll check for error with ferror */
3492
3493         /*
3494          * Walk through the database table.
3495          */
3496         hash_seq_init(&hstat, pgStatDBHash);
3497         while ((dbentry = (PgStat_StatDBEntry *) hash_seq_search(&hstat)) != NULL)
3498         {
3499                 /*
3500                  * Write out the DB entry including the number of live backends. We
3501                  * don't write the tables or functions pointers, since they're of no
3502                  * use to any other process.
3503                  */
3504                 fputc('D', fpout);
3505                 rc = fwrite(dbentry, offsetof(PgStat_StatDBEntry, tables), 1, fpout);
3506                 (void) rc;                              /* we'll check for error with ferror */
3507
3508                 /*
3509                  * Walk through the database's access stats per table.
3510                  */
3511                 hash_seq_init(&tstat, dbentry->tables);
3512                 while ((tabentry = (PgStat_StatTabEntry *) hash_seq_search(&tstat)) != NULL)
3513                 {
3514                         fputc('T', fpout);
3515                         rc = fwrite(tabentry, sizeof(PgStat_StatTabEntry), 1, fpout);
3516                         (void) rc;                      /* we'll check for error with ferror */
3517                 }
3518
3519                 /*
3520                  * Walk through the database's function stats table.
3521                  */
3522                 hash_seq_init(&fstat, dbentry->functions);
3523                 while ((funcentry = (PgStat_StatFuncEntry *) hash_seq_search(&fstat)) != NULL)
3524                 {
3525                         fputc('F', fpout);
3526                         rc = fwrite(funcentry, sizeof(PgStat_StatFuncEntry), 1, fpout);
3527                         (void) rc;                      /* we'll check for error with ferror */
3528                 }
3529
3530                 /*
3531                  * Mark the end of this DB
3532                  */
3533                 fputc('d', fpout);
3534         }
3535
3536         /*
3537          * No more output to be done. Close the temp file and replace the old
3538          * pgstat.stat with it.  The ferror() check replaces testing for error
3539          * after each individual fputc or fwrite above.
3540          */
3541         fputc('E', fpout);
3542
3543         if (ferror(fpout))
3544         {
3545                 ereport(LOG,
3546                                 (errcode_for_file_access(),
3547                            errmsg("could not write temporary statistics file \"%s\": %m",
3548                                           tmpfile)));
3549                 FreeFile(fpout);
3550                 unlink(tmpfile);
3551         }
3552         else if (FreeFile(fpout) < 0)
3553         {
3554                 ereport(LOG,
3555                                 (errcode_for_file_access(),
3556                            errmsg("could not close temporary statistics file \"%s\": %m",
3557                                           tmpfile)));
3558                 unlink(tmpfile);
3559         }
3560         else if (rename(tmpfile, statfile) < 0)
3561         {
3562                 ereport(LOG,
3563                                 (errcode_for_file_access(),
3564                                  errmsg("could not rename temporary statistics file \"%s\" to \"%s\": %m",
3565                                                 tmpfile, statfile)));
3566                 unlink(tmpfile);
3567         }
3568         else
3569         {
3570                 /*
3571                  * Successful write, so update last_statwrite.
3572                  */
3573                 last_statwrite = globalStats.stats_timestamp;
3574
3575                 /*
3576                  * If there is clock skew between backends and the collector, we could
3577                  * receive a stats request time that's in the future.  If so, complain
3578                  * and reset last_statrequest.  Resetting ensures that no inquiry
3579                  * message can cause more than one stats file write to occur.
3580                  */
3581                 if (last_statrequest > last_statwrite)
3582                 {
3583                         char       *reqtime;
3584                         char       *mytime;
3585
3586                         /* Copy because timestamptz_to_str returns a static buffer */
3587                         reqtime = pstrdup(timestamptz_to_str(last_statrequest));
3588                         mytime = pstrdup(timestamptz_to_str(last_statwrite));
3589                         elog(LOG, "last_statrequest %s is later than collector's time %s",
3590                                  reqtime, mytime);
3591                         pfree(reqtime);
3592                         pfree(mytime);
3593
3594                         last_statrequest = last_statwrite;
3595                 }
3596         }
3597
3598         if (permanent)
3599                 unlink(pgstat_stat_filename);
3600 }
3601
3602
3603 /* ----------
3604  * pgstat_read_statsfile() -
3605  *
3606  *      Reads in an existing statistics collector file and initializes the
3607  *      databases' hash table (whose entries point to the tables' hash tables).
3608  * ----------
3609  */
3610 static HTAB *
3611 pgstat_read_statsfile(Oid onlydb, bool permanent)
3612 {
3613         PgStat_StatDBEntry *dbentry;
3614         PgStat_StatDBEntry dbbuf;
3615         PgStat_StatTabEntry *tabentry;
3616         PgStat_StatTabEntry tabbuf;
3617         PgStat_StatFuncEntry funcbuf;
3618         PgStat_StatFuncEntry *funcentry;
3619         HASHCTL         hash_ctl;
3620         HTAB       *dbhash;
3621         HTAB       *tabhash = NULL;
3622         HTAB       *funchash = NULL;
3623         FILE       *fpin;
3624         int32           format_id;
3625         bool            found;
3626         const char *statfile = permanent ? PGSTAT_STAT_PERMANENT_FILENAME : pgstat_stat_filename;
3627
3628         /*
3629          * The tables will live in pgStatLocalContext.
3630          */
3631         pgstat_setup_memcxt();
3632
3633         /*
3634          * Create the DB hashtable
3635          */
3636         memset(&hash_ctl, 0, sizeof(hash_ctl));
3637         hash_ctl.keysize = sizeof(Oid);
3638         hash_ctl.entrysize = sizeof(PgStat_StatDBEntry);
3639         hash_ctl.hash = oid_hash;
3640         hash_ctl.hcxt = pgStatLocalContext;
3641         dbhash = hash_create("Databases hash", PGSTAT_DB_HASH_SIZE, &hash_ctl,
3642                                                  HASH_ELEM | HASH_FUNCTION | HASH_CONTEXT);
3643
3644         /*
3645          * Clear out global statistics so they start from zero in case we can't
3646          * load an existing statsfile.
3647          */
3648         memset(&globalStats, 0, sizeof(globalStats));
3649
3650         /*
3651          * Set the current timestamp (will be kept only in case we can't load an
3652          * existing statsfile.
3653          */
3654         globalStats.stat_reset_timestamp = GetCurrentTimestamp();
3655
3656         /*
3657          * Try to open the status file. If it doesn't exist, the backends simply
3658          * return zero for anything and the collector simply starts from scratch
3659          * with empty counters.
3660          *
3661          * ENOENT is a possibility if the stats collector is not running or has
3662          * not yet written the stats file the first time.  Any other failure
3663          * condition is suspicious.
3664          */
3665         if ((fpin = AllocateFile(statfile, PG_BINARY_R)) == NULL)
3666         {
3667                 if (errno != ENOENT)
3668                         ereport(pgStatRunningInCollector ? LOG : WARNING,
3669                                         (errcode_for_file_access(),
3670                                          errmsg("could not open statistics file \"%s\": %m",
3671                                                         statfile)));
3672                 return dbhash;
3673         }
3674
3675         /*
3676          * Verify it's of the expected format.
3677          */
3678         if (fread(&format_id, 1, sizeof(format_id), fpin) != sizeof(format_id)
3679                 || format_id != PGSTAT_FILE_FORMAT_ID)
3680         {
3681                 ereport(pgStatRunningInCollector ? LOG : WARNING,
3682                                 (errmsg("corrupted statistics file \"%s\"", statfile)));
3683                 goto done;
3684         }
3685
3686         /*
3687          * Read global stats struct
3688          */
3689         if (fread(&globalStats, 1, sizeof(globalStats), fpin) != sizeof(globalStats))
3690         {
3691                 ereport(pgStatRunningInCollector ? LOG : WARNING,
3692                                 (errmsg("corrupted statistics file \"%s\"", statfile)));
3693                 goto done;
3694         }
3695
3696         /*
3697          * We found an existing collector stats file. Read it and put all the
3698          * hashtable entries into place.
3699          */
3700         for (;;)
3701         {
3702                 switch (fgetc(fpin))
3703                 {
3704                                 /*
3705                                  * 'D'  A PgStat_StatDBEntry struct describing a database
3706                                  * follows. Subsequently, zero to many 'T' and 'F' entries
3707                                  * will follow until a 'd' is encountered.
3708                                  */
3709                         case 'D':
3710                                 if (fread(&dbbuf, 1, offsetof(PgStat_StatDBEntry, tables),
3711                                                   fpin) != offsetof(PgStat_StatDBEntry, tables))
3712                                 {
3713                                         ereport(pgStatRunningInCollector ? LOG : WARNING,
3714                                                         (errmsg("corrupted statistics file \"%s\"",
3715                                                                         statfile)));
3716                                         goto done;
3717                                 }
3718
3719                                 /*
3720                                  * Add to the DB hash
3721                                  */
3722                                 dbentry = (PgStat_StatDBEntry *) hash_search(dbhash,
3723                                                                                                   (void *) &dbbuf.databaseid,
3724                                                                                                                          HASH_ENTER,
3725                                                                                                                          &found);
3726                                 if (found)
3727                                 {
3728                                         ereport(pgStatRunningInCollector ? LOG : WARNING,
3729                                                         (errmsg("corrupted statistics file \"%s\"",
3730                                                                         statfile)));
3731                                         goto done;
3732                                 }
3733
3734                                 memcpy(dbentry, &dbbuf, sizeof(PgStat_StatDBEntry));
3735                                 dbentry->tables = NULL;
3736                                 dbentry->functions = NULL;
3737
3738                                 /*
3739                                  * Don't collect tables if not the requested DB (or the
3740                                  * shared-table info)
3741                                  */
3742                                 if (onlydb != InvalidOid)
3743                                 {
3744                                         if (dbbuf.databaseid != onlydb &&
3745                                                 dbbuf.databaseid != InvalidOid)
3746                                                 break;
3747                                 }
3748
3749                                 memset(&hash_ctl, 0, sizeof(hash_ctl));
3750                                 hash_ctl.keysize = sizeof(Oid);
3751                                 hash_ctl.entrysize = sizeof(PgStat_StatTabEntry);
3752                                 hash_ctl.hash = oid_hash;
3753                                 hash_ctl.hcxt = pgStatLocalContext;
3754                                 dbentry->tables = hash_create("Per-database table",
3755                                                                                           PGSTAT_TAB_HASH_SIZE,
3756                                                                                           &hash_ctl,
3757                                                                    HASH_ELEM | HASH_FUNCTION | HASH_CONTEXT);
3758
3759                                 hash_ctl.keysize = sizeof(Oid);
3760                                 hash_ctl.entrysize = sizeof(PgStat_StatFuncEntry);
3761                                 hash_ctl.hash = oid_hash;
3762                                 hash_ctl.hcxt = pgStatLocalContext;
3763                                 dbentry->functions = hash_create("Per-database function",
3764                                                                                                  PGSTAT_FUNCTION_HASH_SIZE,
3765                                                                                                  &hash_ctl,
3766                                                                    HASH_ELEM | HASH_FUNCTION | HASH_CONTEXT);
3767
3768                                 /*
3769                                  * Arrange that following records add entries to this
3770                                  * database's hash tables.
3771                                  */
3772                                 tabhash = dbentry->tables;
3773                                 funchash = dbentry->functions;
3774                                 break;
3775
3776                                 /*
3777                                  * 'd'  End of this database.
3778                                  */
3779                         case 'd':
3780                                 tabhash = NULL;
3781                                 funchash = NULL;
3782                                 break;
3783
3784                                 /*
3785                                  * 'T'  A PgStat_StatTabEntry follows.
3786                                  */
3787                         case 'T':
3788                                 if (fread(&tabbuf, 1, sizeof(PgStat_StatTabEntry),
3789                                                   fpin) != sizeof(PgStat_StatTabEntry))
3790                                 {
3791                                         ereport(pgStatRunningInCollector ? LOG : WARNING,
3792                                                         (errmsg("corrupted statistics file \"%s\"",
3793                                                                         statfile)));
3794                                         goto done;
3795                                 }
3796
3797                                 /*
3798                                  * Skip if table belongs to a not requested database.
3799                                  */
3800                                 if (tabhash == NULL)
3801                                         break;
3802
3803                                 tabentry = (PgStat_StatTabEntry *) hash_search(tabhash,
3804                                                                                                         (void *) &tabbuf.tableid,
3805                                                                                                                  HASH_ENTER, &found);
3806
3807                                 if (found)
3808                                 {
3809                                         ereport(pgStatRunningInCollector ? LOG : WARNING,
3810                                                         (errmsg("corrupted statistics file \"%s\"",
3811                                                                         statfile)));
3812                                         goto done;
3813                                 }
3814
3815                                 memcpy(tabentry, &tabbuf, sizeof(tabbuf));
3816                                 break;
3817
3818                                 /*
3819                                  * 'F'  A PgStat_StatFuncEntry follows.
3820                                  */
3821                         case 'F':
3822                                 if (fread(&funcbuf, 1, sizeof(PgStat_StatFuncEntry),
3823                                                   fpin) != sizeof(PgStat_StatFuncEntry))
3824                                 {
3825                                         ereport(pgStatRunningInCollector ? LOG : WARNING,
3826                                                         (errmsg("corrupted statistics file \"%s\"",
3827                                                                         statfile)));
3828                                         goto done;
3829                                 }
3830
3831                                 /*
3832                                  * Skip if function belongs to a not requested database.
3833                                  */
3834                                 if (funchash == NULL)
3835                                         break;
3836
3837                                 funcentry = (PgStat_StatFuncEntry *) hash_search(funchash,
3838                                                                                                 (void *) &funcbuf.functionid,
3839                                                                                                                  HASH_ENTER, &found);
3840
3841                                 if (found)
3842                                 {
3843                                         ereport(pgStatRunningInCollector ? LOG : WARNING,
3844                                                         (errmsg("corrupted statistics file \"%s\"",
3845                                                                         statfile)));
3846                                         goto done;
3847                                 }
3848
3849                                 memcpy(funcentry, &funcbuf, sizeof(funcbuf));
3850                                 break;
3851
3852                                 /*
3853                                  * 'E'  The EOF marker of a complete stats file.
3854                                  */
3855                         case 'E':
3856                                 goto done;
3857
3858                         default:
3859                                 ereport(pgStatRunningInCollector ? LOG : WARNING,
3860                                                 (errmsg("corrupted statistics file \"%s\"",
3861                                                                 statfile)));
3862                                 goto done;
3863                 }
3864         }
3865
3866 done:
3867         FreeFile(fpin);
3868
3869         if (permanent)
3870                 unlink(PGSTAT_STAT_PERMANENT_FILENAME);
3871
3872         return dbhash;
3873 }
3874
3875 /* ----------
3876  * pgstat_read_statsfile_timestamp() -
3877  *
3878  *      Attempt to fetch the timestamp of an existing stats file.
3879  *      Returns TRUE if successful (timestamp is stored at *ts).
3880  * ----------
3881  */
3882 static bool
3883 pgstat_read_statsfile_timestamp(bool permanent, TimestampTz *ts)
3884 {
3885         PgStat_GlobalStats myGlobalStats;
3886         FILE       *fpin;
3887         int32           format_id;
3888         const char *statfile = permanent ? PGSTAT_STAT_PERMANENT_FILENAME : pgstat_stat_filename;
3889
3890         /*
3891          * Try to open the status file.  As above, anything but ENOENT is worthy
3892          * of complaining about.
3893          */
3894         if ((fpin = AllocateFile(statfile, PG_BINARY_R)) == NULL)
3895         {
3896                 if (errno != ENOENT)
3897                         ereport(pgStatRunningInCollector ? LOG : WARNING,
3898                                         (errcode_for_file_access(),
3899                                          errmsg("could not open statistics file \"%s\": %m",
3900                                                         statfile)));
3901                 return false;
3902         }
3903
3904         /*
3905          * Verify it's of the expected format.
3906          */
3907         if (fread(&format_id, 1, sizeof(format_id), fpin) != sizeof(format_id)
3908                 || format_id != PGSTAT_FILE_FORMAT_ID)
3909         {
3910                 ereport(pgStatRunningInCollector ? LOG : WARNING,
3911                                 (errmsg("corrupted statistics file \"%s\"", statfile)));
3912                 FreeFile(fpin);
3913                 return false;
3914         }
3915
3916         /*
3917          * Read global stats struct
3918          */
3919         if (fread(&myGlobalStats, 1, sizeof(myGlobalStats), fpin) != sizeof(myGlobalStats))
3920         {
3921                 ereport(pgStatRunningInCollector ? LOG : WARNING,
3922                                 (errmsg("corrupted statistics file \"%s\"", statfile)));
3923                 FreeFile(fpin);
3924                 return false;
3925         }
3926
3927         *ts = myGlobalStats.stats_timestamp;
3928
3929         FreeFile(fpin);
3930         return true;
3931 }
3932
3933 /*
3934  * If not already done, read the statistics collector stats file into
3935  * some hash tables.  The results will be kept until pgstat_clear_snapshot()
3936  * is called (typically, at end of transaction).
3937  */
3938 static void
3939 backend_read_statsfile(void)
3940 {
3941         TimestampTz cur_ts;
3942         TimestampTz min_ts;
3943         int                     count;
3944
3945         /* already read it? */
3946         if (pgStatDBHash)
3947                 return;
3948         Assert(!pgStatRunningInCollector);
3949
3950         /*
3951          * We set the minimum acceptable timestamp to PGSTAT_STAT_INTERVAL msec
3952          * before now.  This indirectly ensures that the collector needn't write
3953          * the file more often than PGSTAT_STAT_INTERVAL.  In an autovacuum
3954          * worker, however, we want a lower delay to avoid using stale data, so we
3955          * use PGSTAT_RETRY_DELAY (since the number of worker is low, this
3956          * shouldn't be a problem).
3957          *
3958          * Note that we don't recompute min_ts after sleeping; so we might end up
3959          * accepting a file a bit older than PGSTAT_STAT_INTERVAL.      In practice
3960          * that shouldn't happen, though, as long as the sleep time is less than
3961          * PGSTAT_STAT_INTERVAL; and we don't want to lie to the collector about
3962          * what our cutoff time really is.
3963          */
3964         cur_ts = GetCurrentTimestamp();
3965         if (IsAutoVacuumWorkerProcess())
3966                 min_ts = TimestampTzPlusMilliseconds(cur_ts, -PGSTAT_RETRY_DELAY);
3967         else
3968                 min_ts = TimestampTzPlusMilliseconds(cur_ts, -PGSTAT_STAT_INTERVAL);
3969
3970         /*
3971          * Loop until fresh enough stats file is available or we ran out of time.
3972          * The stats inquiry message is sent repeatedly in case collector drops
3973          * it; but not every single time, as that just swamps the collector.
3974          */
3975         for (count = 0; count < PGSTAT_POLL_LOOP_COUNT; count++)
3976         {
3977                 TimestampTz file_ts = 0;
3978
3979                 CHECK_FOR_INTERRUPTS();
3980
3981                 if (pgstat_read_statsfile_timestamp(false, &file_ts) &&
3982                         file_ts >= min_ts)
3983                         break;
3984
3985                 /* Not there or too old, so kick the collector and wait a bit */
3986                 if ((count % PGSTAT_INQ_LOOP_COUNT) == 0)
3987                         pgstat_send_inquiry(min_ts);
3988
3989                 pg_usleep(PGSTAT_RETRY_DELAY * 1000L);
3990         }
3991
3992         if (count >= PGSTAT_POLL_LOOP_COUNT)
3993                 elog(WARNING, "pgstat wait timeout");
3994
3995         /* Autovacuum launcher wants stats about all databases */
3996         if (IsAutoVacuumLauncherProcess())
3997                 pgStatDBHash = pgstat_read_statsfile(InvalidOid, false);
3998         else
3999                 pgStatDBHash = pgstat_read_statsfile(MyDatabaseId, false);
4000 }
4001
4002
4003 /* ----------
4004  * pgstat_setup_memcxt() -
4005  *
4006  *      Create pgStatLocalContext, if not already done.
4007  * ----------
4008  */
4009 static void
4010 pgstat_setup_memcxt(void)
4011 {
4012         if (!pgStatLocalContext)
4013                 pgStatLocalContext = AllocSetContextCreate(TopMemoryContext,
4014                                                                                                    "Statistics snapshot",
4015                                                                                                    ALLOCSET_SMALL_MINSIZE,
4016                                                                                                    ALLOCSET_SMALL_INITSIZE,
4017                                                                                                    ALLOCSET_SMALL_MAXSIZE);
4018 }
4019
4020
4021 /* ----------
4022  * pgstat_clear_snapshot() -
4023  *
4024  *      Discard any data collected in the current transaction.  Any subsequent
4025  *      request will cause new snapshots to be read.
4026  *
4027  *      This is also invoked during transaction commit or abort to discard
4028  *      the no-longer-wanted snapshot.
4029  * ----------
4030  */
4031 void
4032 pgstat_clear_snapshot(void)
4033 {
4034         /* Release memory, if any was allocated */
4035         if (pgStatLocalContext)
4036                 MemoryContextDelete(pgStatLocalContext);
4037
4038         /* Reset variables */
4039         pgStatLocalContext = NULL;
4040         pgStatDBHash = NULL;
4041         localBackendStatusTable = NULL;
4042         localNumBackends = 0;
4043 }
4044
4045
4046 /* ----------
4047  * pgstat_recv_inquiry() -
4048  *
4049  *      Process stat inquiry requests.
4050  * ----------
4051  */
4052 static void
4053 pgstat_recv_inquiry(PgStat_MsgInquiry *msg, int len)
4054 {
4055         if (msg->inquiry_time > last_statrequest)
4056                 last_statrequest = msg->inquiry_time;
4057 }
4058
4059
4060 /* ----------
4061  * pgstat_recv_tabstat() -
4062  *
4063  *      Count what the backend has done.
4064  * ----------
4065  */
4066 static void
4067 pgstat_recv_tabstat(PgStat_MsgTabstat *msg, int len)
4068 {
4069         PgStat_StatDBEntry *dbentry;
4070         PgStat_StatTabEntry *tabentry;
4071         int                     i;
4072         bool            found;
4073
4074         dbentry = pgstat_get_db_entry(msg->m_databaseid, true);
4075
4076         /*
4077          * Update database-wide stats.
4078          */
4079         dbentry->n_xact_commit += (PgStat_Counter) (msg->m_xact_commit);
4080         dbentry->n_xact_rollback += (PgStat_Counter) (msg->m_xact_rollback);
4081         dbentry->n_block_time_read += msg->m_block_time_read;
4082         dbentry->n_block_time_write += msg->m_block_time_write;
4083
4084         /*
4085          * Process all table entries in the message.
4086          */
4087         for (i = 0; i < msg->m_nentries; i++)
4088         {
4089                 PgStat_TableEntry *tabmsg = &(msg->m_entry[i]);
4090
4091                 tabentry = (PgStat_StatTabEntry *) hash_search(dbentry->tables,
4092                                                                                                         (void *) &(tabmsg->t_id),
4093                                                                                                            HASH_ENTER, &found);
4094
4095                 if (!found)
4096                 {
4097                         /*
4098                          * If it's a new table entry, initialize counters to the values we
4099                          * just got.
4100                          */
4101                         tabentry->numscans = tabmsg->t_counts.t_numscans;
4102                         tabentry->tuples_returned = tabmsg->t_counts.t_tuples_returned;
4103                         tabentry->tuples_fetched = tabmsg->t_counts.t_tuples_fetched;
4104                         tabentry->tuples_inserted = tabmsg->t_counts.t_tuples_inserted;
4105                         tabentry->tuples_updated = tabmsg->t_counts.t_tuples_updated;
4106                         tabentry->tuples_deleted = tabmsg->t_counts.t_tuples_deleted;
4107                         tabentry->tuples_hot_updated = tabmsg->t_counts.t_tuples_hot_updated;
4108                         tabentry->n_live_tuples = tabmsg->t_counts.t_delta_live_tuples;
4109                         tabentry->n_dead_tuples = tabmsg->t_counts.t_delta_dead_tuples;
4110                         tabentry->changes_since_analyze = tabmsg->t_counts.t_changed_tuples;
4111                         tabentry->blocks_fetched = tabmsg->t_counts.t_blocks_fetched;
4112                         tabentry->blocks_hit = tabmsg->t_counts.t_blocks_hit;
4113
4114                         tabentry->vacuum_timestamp = 0;
4115                         tabentry->vacuum_count = 0;
4116                         tabentry->autovac_vacuum_timestamp = 0;
4117                         tabentry->autovac_vacuum_count = 0;
4118                         tabentry->analyze_timestamp = 0;
4119                         tabentry->analyze_count = 0;
4120                         tabentry->autovac_analyze_timestamp = 0;
4121                         tabentry->autovac_analyze_count = 0;
4122                 }
4123                 else
4124                 {
4125                         /*
4126                          * Otherwise add the values to the existing entry.
4127                          */
4128                         tabentry->numscans += tabmsg->t_counts.t_numscans;
4129                         tabentry->tuples_returned += tabmsg->t_counts.t_tuples_returned;
4130                         tabentry->tuples_fetched += tabmsg->t_counts.t_tuples_fetched;
4131                         tabentry->tuples_inserted += tabmsg->t_counts.t_tuples_inserted;
4132                         tabentry->tuples_updated += tabmsg->t_counts.t_tuples_updated;
4133                         tabentry->tuples_deleted += tabmsg->t_counts.t_tuples_deleted;
4134                         tabentry->tuples_hot_updated += tabmsg->t_counts.t_tuples_hot_updated;
4135                         tabentry->n_live_tuples += tabmsg->t_counts.t_delta_live_tuples;
4136                         tabentry->n_dead_tuples += tabmsg->t_counts.t_delta_dead_tuples;
4137                         tabentry->changes_since_analyze += tabmsg->t_counts.t_changed_tuples;
4138                         tabentry->blocks_fetched += tabmsg->t_counts.t_blocks_fetched;
4139                         tabentry->blocks_hit += tabmsg->t_counts.t_blocks_hit;
4140                 }
4141
4142                 /* Clamp n_live_tuples in case of negative delta_live_tuples */
4143                 tabentry->n_live_tuples = Max(tabentry->n_live_tuples, 0);
4144                 /* Likewise for n_dead_tuples */
4145                 tabentry->n_dead_tuples = Max(tabentry->n_dead_tuples, 0);
4146
4147                 /*
4148                  * Add per-table stats to the per-database entry, too.
4149                  */
4150                 dbentry->n_tuples_returned += tabmsg->t_counts.t_tuples_returned;
4151                 dbentry->n_tuples_fetched += tabmsg->t_counts.t_tuples_fetched;
4152                 dbentry->n_tuples_inserted += tabmsg->t_counts.t_tuples_inserted;
4153                 dbentry->n_tuples_updated += tabmsg->t_counts.t_tuples_updated;
4154                 dbentry->n_tuples_deleted += tabmsg->t_counts.t_tuples_deleted;
4155                 dbentry->n_blocks_fetched += tabmsg->t_counts.t_blocks_fetched;
4156                 dbentry->n_blocks_hit += tabmsg->t_counts.t_blocks_hit;
4157         }
4158 }
4159
4160
4161 /* ----------
4162  * pgstat_recv_tabpurge() -
4163  *
4164  *      Arrange for dead table removal.
4165  * ----------
4166  */
4167 static void
4168 pgstat_recv_tabpurge(PgStat_MsgTabpurge *msg, int len)
4169 {
4170         PgStat_StatDBEntry *dbentry;
4171         int                     i;
4172
4173         dbentry = pgstat_get_db_entry(msg->m_databaseid, false);
4174
4175         /*
4176          * No need to purge if we don't even know the database.
4177          */
4178         if (!dbentry || !dbentry->tables)
4179                 return;
4180
4181         /*
4182          * Process all table entries in the message.
4183          */
4184         for (i = 0; i < msg->m_nentries; i++)
4185         {
4186                 /* Remove from hashtable if present; we don't care if it's not. */
4187                 (void) hash_search(dbentry->tables,
4188                                                    (void *) &(msg->m_tableid[i]),
4189                                                    HASH_REMOVE, NULL);
4190         }
4191 }
4192
4193
4194 /* ----------
4195  * pgstat_recv_dropdb() -
4196  *
4197  *      Arrange for dead database removal
4198  * ----------
4199  */
4200 static void
4201 pgstat_recv_dropdb(PgStat_MsgDropdb *msg, int len)
4202 {
4203         PgStat_StatDBEntry *dbentry;
4204
4205         /*
4206          * Lookup the database in the hashtable.
4207          */
4208         dbentry = pgstat_get_db_entry(msg->m_databaseid, false);
4209
4210         /*
4211          * If found, remove it.
4212          */
4213         if (dbentry)
4214         {
4215                 if (dbentry->tables != NULL)
4216                         hash_destroy(dbentry->tables);
4217                 if (dbentry->functions != NULL)
4218                         hash_destroy(dbentry->functions);
4219
4220                 if (hash_search(pgStatDBHash,
4221                                                 (void *) &(dbentry->databaseid),
4222                                                 HASH_REMOVE, NULL) == NULL)
4223                         ereport(ERROR,
4224                                         (errmsg("database hash table corrupted "
4225                                                         "during cleanup --- abort")));
4226         }
4227 }
4228
4229
4230 /* ----------
4231  * pgstat_recv_resetcounter() -
4232  *
4233  *      Reset the statistics for the specified database.
4234  * ----------
4235  */
4236 static void
4237 pgstat_recv_resetcounter(PgStat_MsgResetcounter *msg, int len)
4238 {
4239         HASHCTL         hash_ctl;
4240         PgStat_StatDBEntry *dbentry;
4241
4242         /*
4243          * Lookup the database in the hashtable.  Nothing to do if not there.
4244          */
4245         dbentry = pgstat_get_db_entry(msg->m_databaseid, false);
4246
4247         if (!dbentry)
4248                 return;
4249
4250         /*
4251          * We simply throw away all the database's table entries by recreating a
4252          * new hash table for them.
4253          */
4254         if (dbentry->tables != NULL)
4255                 hash_destroy(dbentry->tables);
4256         if (dbentry->functions != NULL)
4257                 hash_destroy(dbentry->functions);
4258
4259         dbentry->tables = NULL;
4260         dbentry->functions = NULL;
4261
4262         /*
4263          * Reset database-level stats too.      This should match the initialization
4264          * code in pgstat_get_db_entry().
4265          */
4266         dbentry->n_xact_commit = 0;
4267         dbentry->n_xact_rollback = 0;
4268         dbentry->n_blocks_fetched = 0;
4269         dbentry->n_blocks_hit = 0;
4270         dbentry->n_tuples_returned = 0;
4271         dbentry->n_tuples_fetched = 0;
4272         dbentry->n_tuples_inserted = 0;
4273         dbentry->n_tuples_updated = 0;
4274         dbentry->n_tuples_deleted = 0;
4275         dbentry->last_autovac_time = 0;
4276         dbentry->n_temp_bytes = 0;
4277         dbentry->n_temp_files = 0;
4278         dbentry->n_deadlocks = 0;
4279         dbentry->n_block_time_read = 0;
4280         dbentry->n_block_time_write = 0;
4281
4282         dbentry->stat_reset_timestamp = GetCurrentTimestamp();
4283
4284         memset(&hash_ctl, 0, sizeof(hash_ctl));
4285         hash_ctl.keysize = sizeof(Oid);
4286         hash_ctl.entrysize = sizeof(PgStat_StatTabEntry);
4287         hash_ctl.hash = oid_hash;
4288         dbentry->tables = hash_create("Per-database table",
4289                                                                   PGSTAT_TAB_HASH_SIZE,
4290                                                                   &hash_ctl,
4291                                                                   HASH_ELEM | HASH_FUNCTION);
4292
4293         hash_ctl.keysize = sizeof(Oid);
4294         hash_ctl.entrysize = sizeof(PgStat_StatFuncEntry);
4295         hash_ctl.hash = oid_hash;
4296         dbentry->functions = hash_create("Per-database function",
4297                                                                          PGSTAT_FUNCTION_HASH_SIZE,
4298                                                                          &hash_ctl,
4299                                                                          HASH_ELEM | HASH_FUNCTION);
4300 }
4301
4302 /* ----------
4303  * pgstat_recv_resetshared() -
4304  *
4305  *      Reset some shared statistics of the cluster.
4306  * ----------
4307  */
4308 static void
4309 pgstat_recv_resetsharedcounter(PgStat_MsgResetsharedcounter *msg, int len)
4310 {
4311         if (msg->m_resettarget == RESET_BGWRITER)
4312         {
4313                 /* Reset the global background writer statistics for the cluster. */
4314                 memset(&globalStats, 0, sizeof(globalStats));
4315                 globalStats.stat_reset_timestamp = GetCurrentTimestamp();
4316         }
4317
4318         /*
4319          * Presumably the sender of this message validated the target, don't
4320          * complain here if it's not valid
4321          */
4322 }
4323
4324 /* ----------
4325  * pgstat_recv_resetsinglecounter() -
4326  *
4327  *      Reset a statistics for a single object
4328  * ----------
4329  */
4330 static void
4331 pgstat_recv_resetsinglecounter(PgStat_MsgResetsinglecounter *msg, int len)
4332 {
4333         PgStat_StatDBEntry *dbentry;
4334
4335         dbentry = pgstat_get_db_entry(msg->m_databaseid, false);
4336
4337         if (!dbentry)
4338                 return;
4339
4340         /* Set the reset timestamp for the whole database */
4341         dbentry->stat_reset_timestamp = GetCurrentTimestamp();
4342
4343         /* Remove object if it exists, ignore it if not */
4344         if (msg->m_resettype == RESET_TABLE)
4345                 (void) hash_search(dbentry->tables, (void *) &(msg->m_objectid),
4346                                                    HASH_REMOVE, NULL);
4347         else if (msg->m_resettype == RESET_FUNCTION)
4348                 (void) hash_search(dbentry->functions, (void *) &(msg->m_objectid),
4349                                                    HASH_REMOVE, NULL);
4350 }
4351
4352 /* ----------
4353  * pgstat_recv_autovac() -
4354  *
4355  *      Process an autovacuum signalling message.
4356  * ----------
4357  */
4358 static void
4359 pgstat_recv_autovac(PgStat_MsgAutovacStart *msg, int len)
4360 {
4361         PgStat_StatDBEntry *dbentry;
4362
4363         /*
4364          * Store the last autovacuum time in the database's hashtable entry.
4365          */
4366         dbentry = pgstat_get_db_entry(msg->m_databaseid, true);
4367
4368         dbentry->last_autovac_time = msg->m_start_time;
4369 }
4370
4371 /* ----------
4372  * pgstat_recv_vacuum() -
4373  *
4374  *      Process a VACUUM message.
4375  * ----------
4376  */
4377 static void
4378 pgstat_recv_vacuum(PgStat_MsgVacuum *msg, int len)
4379 {
4380         PgStat_StatDBEntry *dbentry;
4381         PgStat_StatTabEntry *tabentry;
4382
4383         /*
4384          * Store the data in the table's hashtable entry.
4385          */
4386         dbentry = pgstat_get_db_entry(msg->m_databaseid, true);
4387
4388         tabentry = pgstat_get_tab_entry(dbentry, msg->m_tableoid, true);
4389
4390         tabentry->n_live_tuples = msg->m_tuples;
4391         /* Resetting dead_tuples to 0 is an approximation ... */
4392         tabentry->n_dead_tuples = 0;
4393
4394         if (msg->m_autovacuum)
4395         {
4396                 tabentry->autovac_vacuum_timestamp = msg->m_vacuumtime;
4397                 tabentry->autovac_vacuum_count++;
4398         }
4399         else
4400         {
4401                 tabentry->vacuum_timestamp = msg->m_vacuumtime;
4402                 tabentry->vacuum_count++;
4403         }
4404 }
4405
4406 /* ----------
4407  * pgstat_recv_analyze() -
4408  *
4409  *      Process an ANALYZE message.
4410  * ----------
4411  */
4412 static void
4413 pgstat_recv_analyze(PgStat_MsgAnalyze *msg, int len)
4414 {
4415         PgStat_StatDBEntry *dbentry;
4416         PgStat_StatTabEntry *tabentry;
4417
4418         /*
4419          * Store the data in the table's hashtable entry.
4420          */
4421         dbentry = pgstat_get_db_entry(msg->m_databaseid, true);
4422
4423         tabentry = pgstat_get_tab_entry(dbentry, msg->m_tableoid, true);
4424
4425         tabentry->n_live_tuples = msg->m_live_tuples;
4426         tabentry->n_dead_tuples = msg->m_dead_tuples;
4427
4428         /*
4429          * We reset changes_since_analyze to zero, forgetting any changes that
4430          * occurred while the ANALYZE was in progress.
4431          */
4432         tabentry->changes_since_analyze = 0;
4433
4434         if (msg->m_autovacuum)
4435         {
4436                 tabentry->autovac_analyze_timestamp = msg->m_analyzetime;
4437                 tabentry->autovac_analyze_count++;
4438         }
4439         else
4440         {
4441                 tabentry->analyze_timestamp = msg->m_analyzetime;
4442                 tabentry->analyze_count++;
4443         }
4444 }
4445
4446
4447 /* ----------
4448  * pgstat_recv_bgwriter() -
4449  *
4450  *      Process a BGWRITER message.
4451  * ----------
4452  */
4453 static void
4454 pgstat_recv_bgwriter(PgStat_MsgBgWriter *msg, int len)
4455 {
4456         globalStats.timed_checkpoints += msg->m_timed_checkpoints;
4457         globalStats.requested_checkpoints += msg->m_requested_checkpoints;
4458         globalStats.checkpoint_write_time += msg->m_checkpoint_write_time;
4459         globalStats.checkpoint_sync_time += msg->m_checkpoint_sync_time;
4460         globalStats.buf_written_checkpoints += msg->m_buf_written_checkpoints;
4461         globalStats.buf_written_clean += msg->m_buf_written_clean;
4462         globalStats.maxwritten_clean += msg->m_maxwritten_clean;
4463         globalStats.buf_written_backend += msg->m_buf_written_backend;
4464         globalStats.buf_fsync_backend += msg->m_buf_fsync_backend;
4465         globalStats.buf_alloc += msg->m_buf_alloc;
4466 }
4467
4468 /* ----------
4469  * pgstat_recv_recoveryconflict() -
4470  *
4471  *      Process a RECOVERYCONFLICT message.
4472  * ----------
4473  */
4474 static void
4475 pgstat_recv_recoveryconflict(PgStat_MsgRecoveryConflict *msg, int len)
4476 {
4477         PgStat_StatDBEntry *dbentry;
4478
4479         dbentry = pgstat_get_db_entry(msg->m_databaseid, true);
4480
4481         switch (msg->m_reason)
4482         {
4483                 case PROCSIG_RECOVERY_CONFLICT_DATABASE:
4484
4485                         /*
4486                          * Since we drop the information about the database as soon as it
4487                          * replicates, there is no point in counting these conflicts.
4488                          */
4489                         break;
4490                 case PROCSIG_RECOVERY_CONFLICT_TABLESPACE:
4491                         dbentry->n_conflict_tablespace++;
4492                         break;
4493                 case PROCSIG_RECOVERY_CONFLICT_LOCK:
4494                         dbentry->n_conflict_lock++;
4495                         break;
4496                 case PROCSIG_RECOVERY_CONFLICT_SNAPSHOT:
4497                         dbentry->n_conflict_snapshot++;
4498                         break;
4499                 case PROCSIG_RECOVERY_CONFLICT_BUFFERPIN:
4500                         dbentry->n_conflict_bufferpin++;
4501                         break;
4502                 case PROCSIG_RECOVERY_CONFLICT_STARTUP_DEADLOCK:
4503                         dbentry->n_conflict_startup_deadlock++;
4504                         break;
4505         }
4506 }
4507
4508 /* ----------
4509  * pgstat_recv_deadlock() -
4510  *
4511  *      Process a DEADLOCK message.
4512  * ----------
4513  */
4514 static void
4515 pgstat_recv_deadlock(PgStat_MsgDeadlock *msg, int len)
4516 {
4517         PgStat_StatDBEntry *dbentry;
4518
4519         dbentry = pgstat_get_db_entry(msg->m_databaseid, true);
4520
4521         dbentry->n_deadlocks++;
4522 }
4523
4524 /* ----------
4525  * pgstat_recv_tempfile() -
4526  *
4527  *      Process a TEMPFILE message.
4528  * ----------
4529  */
4530 static void
4531 pgstat_recv_tempfile(PgStat_MsgTempFile *msg, int len)
4532 {
4533         PgStat_StatDBEntry *dbentry;
4534
4535         dbentry = pgstat_get_db_entry(msg->m_databaseid, true);
4536
4537         dbentry->n_temp_bytes += msg->m_filesize;
4538         dbentry->n_temp_files += 1;
4539 }
4540
4541 /* ----------
4542  * pgstat_recv_funcstat() -
4543  *
4544  *      Count what the backend has done.
4545  * ----------
4546  */
4547 static void
4548 pgstat_recv_funcstat(PgStat_MsgFuncstat *msg, int len)
4549 {
4550         PgStat_FunctionEntry *funcmsg = &(msg->m_entry[0]);
4551         PgStat_StatDBEntry *dbentry;
4552         PgStat_StatFuncEntry *funcentry;
4553         int                     i;
4554         bool            found;
4555
4556         dbentry = pgstat_get_db_entry(msg->m_databaseid, true);
4557
4558         /*
4559          * Process all function entries in the message.
4560          */
4561         for (i = 0; i < msg->m_nentries; i++, funcmsg++)
4562         {
4563                 funcentry = (PgStat_StatFuncEntry *) hash_search(dbentry->functions,
4564                                                                                                    (void *) &(funcmsg->f_id),
4565                                                                                                                  HASH_ENTER, &found);
4566
4567                 if (!found)
4568                 {
4569                         /*
4570                          * If it's a new function entry, initialize counters to the values
4571                          * we just got.
4572                          */
4573                         funcentry->f_numcalls = funcmsg->f_numcalls;
4574                         funcentry->f_time = funcmsg->f_time;
4575                         funcentry->f_time_self = funcmsg->f_time_self;
4576                 }
4577                 else
4578                 {
4579                         /*
4580                          * Otherwise add the values to the existing entry.
4581                          */
4582                         funcentry->f_numcalls += funcmsg->f_numcalls;
4583                         funcentry->f_time += funcmsg->f_time;
4584                         funcentry->f_time_self += funcmsg->f_time_self;
4585                 }
4586         }
4587 }
4588
4589 /* ----------
4590  * pgstat_recv_funcpurge() -
4591  *
4592  *      Arrange for dead function removal.
4593  * ----------
4594  */
4595 static void
4596 pgstat_recv_funcpurge(PgStat_MsgFuncpurge *msg, int len)
4597 {
4598         PgStat_StatDBEntry *dbentry;
4599         int                     i;
4600
4601         dbentry = pgstat_get_db_entry(msg->m_databaseid, false);
4602
4603         /*
4604          * No need to purge if we don't even know the database.
4605          */
4606         if (!dbentry || !dbentry->functions)
4607                 return;
4608
4609         /*
4610          * Process all function entries in the message.
4611          */
4612         for (i = 0; i < msg->m_nentries; i++)
4613         {
4614                 /* Remove from hashtable if present; we don't care if it's not. */
4615                 (void) hash_search(dbentry->functions,
4616                                                    (void *) &(msg->m_functionid[i]),
4617                                                    HASH_REMOVE, NULL);
4618         }
4619 }