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