Age Owner Branch data TLA Line data Source code
1 : : /* ----------
2 : : * pgstat_internal.h
3 : : *
4 : : * Definitions for the PostgreSQL cumulative statistics system that should
5 : : * only be needed by files implementing statistics support (rather than ones
6 : : * reporting / querying stats).
7 : : *
8 : : * Copyright (c) 2001-2025, PostgreSQL Global Development Group
9 : : *
10 : : * src/include/utils/pgstat_internal.h
11 : : * ----------
12 : : */
13 : : #ifndef PGSTAT_INTERNAL_H
14 : : #define PGSTAT_INTERNAL_H
15 : :
16 : :
17 : : #include "common/hashfn_unstable.h"
18 : : #include "lib/dshash.h"
19 : : #include "lib/ilist.h"
20 : : #include "pgstat.h"
21 : : #include "storage/lwlock.h"
22 : : #include "utils/dsa.h"
23 : :
24 : :
25 : : /*
26 : : * Types related to shared memory storage of statistics.
27 : : *
28 : : * Per-object statistics are stored in the "shared stats" hashtable. That
29 : : * table's entries (PgStatShared_HashEntry) contain a pointer to the actual stats
30 : : * data for the object (the size of the stats data varies depending on the
31 : : * kind of stats). The table is keyed by PgStat_HashKey.
32 : : *
33 : : * Once a backend has a reference to a shared stats entry, it increments the
34 : : * entry's refcount. Even after stats data is dropped (e.g., due to a DROP
35 : : * TABLE), the entry itself can only be deleted once all references have been
36 : : * released.
37 : : *
38 : : * These refcounts, in combination with a backend local hashtable
39 : : * (pgStatEntryRefHash, with entries pointing to PgStat_EntryRef) in front of
40 : : * the shared hash table, mean that most stats work can happen without
41 : : * touching the shared hash table, reducing contention.
42 : : *
43 : : * Once there are pending stats updates for a table PgStat_EntryRef->pending
44 : : * is allocated to contain a working space for as-of-yet-unapplied stats
45 : : * updates. Once the stats are flushed, PgStat_EntryRef->pending is freed.
46 : : *
47 : : * Each stat kind in the shared hash table has a fixed member
48 : : * PgStatShared_Common as the first element.
49 : : */
50 : :
51 : : /*
52 : : * Struct for shared statistics hash entry key.
53 : : *
54 : : * NB: We assume that this struct contains no padding. Also, 8 bytes
55 : : * allocated for the object ID are good enough to ensure the uniqueness
56 : : * of the hash key, hence the addition of new fields is not recommended.
57 : : */
58 : : typedef struct PgStat_HashKey
59 : : {
60 : : PgStat_Kind kind; /* statistics entry kind */
61 : : Oid dboid; /* database ID. InvalidOid for shared objects. */
62 : : uint64 objid; /* object ID (table, function, etc.), or
63 : : * identifier. */
64 : : } PgStat_HashKey;
65 : :
66 : : /*
67 : : * Tracks if the stats file is being read, written or discarded, used in
68 : : * combination with the finish callback.
69 : : *
70 : : * These states allow plugins that create auxiliary data files to determine
71 : : * the current operation and perform any necessary file cleanup.
72 : : */
73 : : typedef enum PgStat_StatsFileOp
74 : : {
75 : : STATS_WRITE,
76 : : STATS_READ,
77 : : STATS_DISCARD,
78 : : } PgStat_StatsFileOp;
79 : :
80 : : /*
81 : : * PgStat_HashKey should not have any padding. Checking that the structure
82 : : * size matches with the sum of each field is a check simple enough to
83 : : * enforce this policy.
84 : : */
85 : : StaticAssertDecl((sizeof(PgStat_Kind) + sizeof(uint64) + sizeof(Oid)) ==
86 : : sizeof(PgStat_HashKey),
87 : : "PgStat_HashKey should have no padding");
88 : :
89 : : /*
90 : : * Shared statistics hash entry. Doesn't itself contain any stats, but points
91 : : * to them (with ->body). That allows the stats entries themselves to be of
92 : : * variable size.
93 : : */
94 : : typedef struct PgStatShared_HashEntry
95 : : {
96 : : PgStat_HashKey key; /* hash key */
97 : :
98 : : /*
99 : : * If dropped is set, backends need to release their references so that
100 : : * the memory for the entry can be freed. No new references may be made
101 : : * once marked as dropped.
102 : : */
103 : : bool dropped;
104 : :
105 : : /*
106 : : * Refcount managing lifetime of the entry itself (as opposed to the
107 : : * dshash entry pointing to it). The stats lifetime has to be separate
108 : : * from the hash table entry lifetime because we allow backends to point
109 : : * to a stats entry without holding a hash table lock (and some other
110 : : * reasons).
111 : : *
112 : : * As long as the entry is not dropped, 1 is added to the refcount
113 : : * representing that the entry should not be dropped. In addition each
114 : : * backend that has a reference to the entry needs to increment the
115 : : * refcount as long as it does.
116 : : *
117 : : * May only be incremented / decremented while holding at least a shared
118 : : * lock on the dshash partition containing the entry. It needs to be an
119 : : * atomic variable because multiple backends can increment the refcount
120 : : * with just a shared lock.
121 : : *
122 : : * When the refcount reaches 0 the entry needs to be freed.
123 : : */
124 : : pg_atomic_uint32 refcount;
125 : :
126 : : /*
127 : : * Counter tracking the number of times the entry has been reused.
128 : : *
129 : : * Set to 0 when the entry is created, and incremented by one each time
130 : : * the shared entry is reinitialized with pgstat_reinit_entry().
131 : : *
132 : : * May only be incremented / decremented while holding at least a shared
133 : : * lock on the dshash partition containing the entry. Like refcount, it
134 : : * needs to be an atomic variable because multiple backends can increment
135 : : * the generation with just a shared lock.
136 : : */
137 : : pg_atomic_uint32 generation;
138 : :
139 : : /*
140 : : * Pointer to shared stats. The stats entry always starts with
141 : : * PgStatShared_Common, embedded in a larger struct containing the
142 : : * PgStat_Kind specific stats fields.
143 : : */
144 : : dsa_pointer body;
145 : : } PgStatShared_HashEntry;
146 : :
147 : : /*
148 : : * Common header struct for PgStatShared_*.
149 : : */
150 : : typedef struct PgStatShared_Common
151 : : {
152 : : uint32 magic; /* just a validity cross-check */
153 : : /* lock protecting stats contents (i.e. data following the header) */
154 : : LWLock lock;
155 : : } PgStatShared_Common;
156 : :
157 : : /*
158 : : * A backend local reference to a shared stats entry. As long as at least one
159 : : * such reference exists, the shared stats entry will not be released.
160 : : *
161 : : * If there are pending stats update to the shared stats, these are stored in
162 : : * ->pending.
163 : : */
164 : : typedef struct PgStat_EntryRef
165 : : {
166 : : /*
167 : : * Pointer to the PgStatShared_HashEntry entry in the shared stats
168 : : * hashtable.
169 : : */
170 : : PgStatShared_HashEntry *shared_entry;
171 : :
172 : : /*
173 : : * Pointer to the stats data (i.e. PgStatShared_HashEntry->body), resolved
174 : : * as a local pointer, to avoid repeated dsa_get_address() calls.
175 : : */
176 : : PgStatShared_Common *shared_stats;
177 : :
178 : : /*
179 : : * Copy of PgStatShared_HashEntry->generation, keeping locally track of
180 : : * the shared stats entry "generation" retrieved (number of times reused).
181 : : */
182 : : uint32 generation;
183 : :
184 : : /*
185 : : * Pending statistics data that will need to be flushed to shared memory
186 : : * stats eventually. Each stats kind utilizing pending data defines what
187 : : * format its pending data has and needs to provide a
188 : : * PgStat_KindInfo->flush_pending_cb callback to merge pending entries
189 : : * into the shared stats hash table.
190 : : */
191 : : void *pending;
192 : : dlist_node pending_node; /* membership in pgStatPending list */
193 : : } PgStat_EntryRef;
194 : :
195 : :
196 : : /*
197 : : * Some stats changes are transactional. To maintain those, a stack of
198 : : * PgStat_SubXactStatus entries is maintained, which contain data pertaining
199 : : * to the current transaction and its active subtransactions.
200 : : */
201 : : typedef struct PgStat_SubXactStatus
202 : : {
203 : : int nest_level; /* subtransaction nest level */
204 : :
205 : : struct PgStat_SubXactStatus *prev; /* higher-level subxact if any */
206 : :
207 : : /*
208 : : * Statistics for transactionally dropped objects need to be
209 : : * transactionally dropped as well. Collect the stats dropped in the
210 : : * current (sub-)transaction and only execute the stats drop when we know
211 : : * if the transaction commits/aborts. To handle replicas and crashes,
212 : : * stats drops are included in commit / abort records.
213 : : */
214 : : dclist_head pending_drops;
215 : :
216 : : /*
217 : : * Tuple insertion/deletion counts for an open transaction can't be
218 : : * propagated into PgStat_TableStatus counters until we know if it is
219 : : * going to commit or abort. Hence, we keep these counts in per-subxact
220 : : * structs that live in TopTransactionContext. This data structure is
221 : : * designed on the assumption that subxacts won't usually modify very many
222 : : * tables.
223 : : */
224 : : PgStat_TableXactStatus *first; /* head of list for this subxact */
225 : : } PgStat_SubXactStatus;
226 : :
227 : :
228 : : /*
229 : : * Metadata for a specific kind of statistics.
230 : : */
231 : : typedef struct PgStat_KindInfo
232 : : {
233 : : /*
234 : : * Do a fixed number of stats objects exist for this kind of stats (e.g.
235 : : * bgwriter stats) or not (e.g. tables).
236 : : */
237 : : bool fixed_amount:1;
238 : :
239 : : /*
240 : : * Can stats of this kind be accessed from another database? Determines
241 : : * whether a stats object gets included in stats snapshots.
242 : : */
243 : : bool accessed_across_databases:1;
244 : :
245 : : /* Should stats be written to the on-disk stats file? */
246 : : bool write_to_file:1;
247 : :
248 : : /*
249 : : * Should the number of entries be tracked? For variable-numbered stats,
250 : : * to update its PgStat_ShmemControl.entry_counts.
251 : : */
252 : : bool track_entry_count:1;
253 : :
254 : : /*
255 : : * The size of an entry in the shared stats hash table (pointed to by
256 : : * PgStatShared_HashEntry->body). For fixed-numbered statistics, this is
257 : : * the size of an entry in PgStat_ShmemControl->custom_data.
258 : : */
259 : : uint32 shared_size;
260 : :
261 : : /*
262 : : * The offset of the statistics struct in the cached statistics snapshot
263 : : * PgStat_Snapshot, for fixed-numbered statistics.
264 : : */
265 : : uint32 snapshot_ctl_off;
266 : :
267 : : /*
268 : : * The offset of the statistics struct in the containing shared memory
269 : : * control structure PgStat_ShmemControl, for fixed-numbered statistics.
270 : : */
271 : : uint32 shared_ctl_off;
272 : :
273 : : /*
274 : : * The offset/size of statistics inside the shared stats entry. Used when
275 : : * [de-]serializing statistics to / from disk respectively. Separate from
276 : : * shared_size because [de-]serialization may not include in-memory state
277 : : * like lwlocks.
278 : : */
279 : : uint32 shared_data_off;
280 : : uint32 shared_data_len;
281 : :
282 : : /*
283 : : * The size of the pending data for this kind. E.g. how large
284 : : * PgStat_EntryRef->pending is. Used for allocations.
285 : : *
286 : : * 0 signals that an entry of this kind should never have a pending entry.
287 : : */
288 : : uint32 pending_size;
289 : :
290 : : /*
291 : : * Perform custom actions when initializing a backend (standalone or under
292 : : * postmaster). Optional.
293 : : */
294 : : void (*init_backend_cb) (void);
295 : :
296 : : /*
297 : : * For variable-numbered stats: flush pending stats. Required if pending
298 : : * data is used. See flush_static_cb when dealing with stats data that
299 : : * that cannot use PgStat_EntryRef->pending.
300 : : */
301 : : bool (*flush_pending_cb) (PgStat_EntryRef *sr, bool nowait);
302 : :
303 : : /*
304 : : * For variable-numbered stats: delete pending stats. Optional.
305 : : */
306 : : void (*delete_pending_cb) (PgStat_EntryRef *sr);
307 : :
308 : : /*
309 : : * For variable-numbered stats: reset the reset timestamp. Optional.
310 : : */
311 : : void (*reset_timestamp_cb) (PgStatShared_Common *header, TimestampTz ts);
312 : :
313 : : /*
314 : : * For variable-numbered stats. Optional.
315 : : */
316 : : void (*to_serialized_name) (const PgStat_HashKey *key,
317 : : const PgStatShared_Common *header, NameData *name);
318 : : bool (*from_serialized_name) (const NameData *name, PgStat_HashKey *key);
319 : :
320 : : /*
321 : : * For variable-numbered stats: read or write additional data related to
322 : : * an entry, in the stats file or optionally in a different file.
323 : : * Optional.
324 : : *
325 : : * to_serialized_data: write auxiliary data for an entry.
326 : : *
327 : : * from_serialized_data: read auxiliary data for an entry. Returns true
328 : : * on success, false on read error.
329 : : *
330 : : * "statfile" is a pointer to the on-disk stats file, named
331 : : * PGSTAT_STAT_PERMANENT_FILENAME. "key" is the hash key of the entry
332 : : * just written or read. "header" is a pointer to the stats data.
333 : : */
334 : : void (*to_serialized_data) (const PgStat_HashKey *key,
335 : : const PgStatShared_Common *header,
336 : : FILE *statfile);
337 : : bool (*from_serialized_data) (const PgStat_HashKey *key,
338 : : const PgStatShared_Common *header,
339 : : FILE *statfile);
340 : :
341 : : /*
342 : : * For fixed-numbered or variable-numbered statistics.
343 : : *
344 : : * Perform custom actions when done processing the on-disk stats file
345 : : * after all the stats entries have been processed. Optional.
346 : : *
347 : : * "status" tracks the operation done for the on-disk stats file (read,
348 : : * write, discard).
349 : : */
350 : : void (*finish) (PgStat_StatsFileOp status);
351 : :
352 : : /*
353 : : * For fixed-numbered statistics: Initialize shared memory state.
354 : : *
355 : : * "stats" is the pointer to the allocated shared memory area.
356 : : */
357 : : void (*init_shmem_cb) (void *stats);
358 : :
359 : : /*
360 : : * For fixed-numbered or variable-numbered statistics: Flush pending stats
361 : : * entries, for stats kinds that do not use PgStat_EntryRef->pending.
362 : : *
363 : : * Returns true if some of the stats could not be flushed, due to lock
364 : : * contention for example. Optional.
365 : : *
366 : : * "pgstat_report_fixed" needs to be set to trigger the flush of pending
367 : : * stats.
368 : : */
369 : : bool (*flush_static_cb) (bool nowait);
370 : :
371 : : /*
372 : : * For fixed-numbered statistics: Reset All.
373 : : */
374 : : void (*reset_all_cb) (TimestampTz ts);
375 : :
376 : : /*
377 : : * For fixed-numbered statistics: Build snapshot for entry
378 : : */
379 : : void (*snapshot_cb) (void);
380 : :
381 : : /* name of the kind of stats */
382 : : const char *const name;
383 : : } PgStat_KindInfo;
384 : :
385 : :
386 : : /*
387 : : * List of SLRU names that we keep stats for. There is no central registry of
388 : : * SLRUs, so we use this fixed list instead. The "other" entry is used for
389 : : * all SLRUs without an explicit entry (e.g. SLRUs in extensions).
390 : : *
391 : : * This is only defined here so that SLRU_NUM_ELEMENTS is known for later type
392 : : * definitions.
393 : : */
394 : : static const char *const slru_names[] = {
395 : : "commit_timestamp",
396 : : "multixact_member",
397 : : "multixact_offset",
398 : : "notify",
399 : : "serializable",
400 : : "subtransaction",
401 : : "transaction",
402 : : "other" /* has to be last */
403 : : };
404 : :
405 : : #define SLRU_NUM_ELEMENTS lengthof(slru_names)
406 : :
407 : :
408 : : /* ----------
409 : : * Types and definitions for different kinds of fixed-amount stats.
410 : : *
411 : : * Single-writer stats use the changecount mechanism to achieve low-overhead
412 : : * writes - they're obviously more performance critical than reads. Check the
413 : : * definition of struct PgBackendStatus for some explanation of the
414 : : * changecount mechanism.
415 : : *
416 : : * Because the obvious implementation of resetting single-writer stats isn't
417 : : * compatible with that (another backend needs to write), we don't scribble on
418 : : * shared stats while resetting. Instead, just record the current counter
419 : : * values in a copy of the stats data, which is protected by ->lock. See
420 : : * pgstat_fetch_stat_(archiver|bgwriter|checkpointer) for the reader side.
421 : : *
422 : : * The only exception to that is the stat_reset_timestamp in these structs,
423 : : * which is protected by ->lock, because it has to be written by another
424 : : * backend while resetting.
425 : : * ----------
426 : : */
427 : :
428 : : typedef struct PgStatShared_Archiver
429 : : {
430 : : /* lock protects ->reset_offset as well as stats->stat_reset_timestamp */
431 : : LWLock lock;
432 : : uint32 changecount;
433 : : PgStat_ArchiverStats stats;
434 : : PgStat_ArchiverStats reset_offset;
435 : : } PgStatShared_Archiver;
436 : :
437 : : typedef struct PgStatShared_BgWriter
438 : : {
439 : : /* lock protects ->reset_offset as well as stats->stat_reset_timestamp */
440 : : LWLock lock;
441 : : uint32 changecount;
442 : : PgStat_BgWriterStats stats;
443 : : PgStat_BgWriterStats reset_offset;
444 : : } PgStatShared_BgWriter;
445 : :
446 : : typedef struct PgStatShared_Checkpointer
447 : : {
448 : : /* lock protects ->reset_offset as well as stats->stat_reset_timestamp */
449 : : LWLock lock;
450 : : uint32 changecount;
451 : : PgStat_CheckpointerStats stats;
452 : : PgStat_CheckpointerStats reset_offset;
453 : : } PgStatShared_Checkpointer;
454 : :
455 : : /* Shared-memory ready PgStat_IO */
456 : : typedef struct PgStatShared_IO
457 : : {
458 : : /*
459 : : * locks[i] protects stats.stats[i]. locks[0] also protects
460 : : * stats.stat_reset_timestamp.
461 : : */
462 : : LWLock locks[BACKEND_NUM_TYPES];
463 : : PgStat_IO stats;
464 : : } PgStatShared_IO;
465 : :
466 : : typedef struct PgStatShared_SLRU
467 : : {
468 : : /* lock protects ->stats */
469 : : LWLock lock;
470 : : PgStat_SLRUStats stats[SLRU_NUM_ELEMENTS];
471 : : } PgStatShared_SLRU;
472 : :
473 : : typedef struct PgStatShared_Wal
474 : : {
475 : : /* lock protects ->stats */
476 : : LWLock lock;
477 : : PgStat_WalStats stats;
478 : : } PgStatShared_Wal;
479 : :
480 : :
481 : :
482 : : /* ----------
483 : : * Types and definitions for different kinds of variable-amount stats.
484 : : *
485 : : * Each struct has to start with PgStatShared_Common, containing information
486 : : * common across the different types of stats. Kind-specific data follows.
487 : : * ----------
488 : : */
489 : :
490 : : typedef struct PgStatShared_Database
491 : : {
492 : : PgStatShared_Common header;
493 : : PgStat_StatDBEntry stats;
494 : : } PgStatShared_Database;
495 : :
496 : : typedef struct PgStatShared_Relation
497 : : {
498 : : PgStatShared_Common header;
499 : : PgStat_StatTabEntry stats;
500 : : } PgStatShared_Relation;
501 : :
502 : : typedef struct PgStatShared_Function
503 : : {
504 : : PgStatShared_Common header;
505 : : PgStat_StatFuncEntry stats;
506 : : } PgStatShared_Function;
507 : :
508 : : typedef struct PgStatShared_Subscription
509 : : {
510 : : PgStatShared_Common header;
511 : : PgStat_StatSubEntry stats;
512 : : } PgStatShared_Subscription;
513 : :
514 : : typedef struct PgStatShared_ReplSlot
515 : : {
516 : : PgStatShared_Common header;
517 : : PgStat_StatReplSlotEntry stats;
518 : : } PgStatShared_ReplSlot;
519 : :
520 : : typedef struct PgStatShared_Backend
521 : : {
522 : : PgStatShared_Common header;
523 : : PgStat_Backend stats;
524 : : } PgStatShared_Backend;
525 : :
526 : : /*
527 : : * Central shared memory entry for the cumulative stats system.
528 : : *
529 : : * Fixed amount stats, the dynamic shared memory hash table for
530 : : * non-fixed-amount stats, as well as remaining bits and pieces are all
531 : : * reached from here.
532 : : */
533 : : typedef struct PgStat_ShmemControl
534 : : {
535 : : void *raw_dsa_area;
536 : :
537 : : /*
538 : : * Stats for variable-numbered objects are kept in this shared hash table.
539 : : * See comment above PgStat_Kind for details.
540 : : */
541 : : dshash_table_handle hash_handle; /* shared dbstat hash */
542 : :
543 : : /* Has the stats system already been shut down? Just a debugging check. */
544 : : bool is_shutdown;
545 : :
546 : : /*
547 : : * Whenever statistics for dropped objects could not be freed - because
548 : : * backends still have references - the dropping backend calls
549 : : * pgstat_request_entry_refs_gc() incrementing this counter. Eventually
550 : : * that causes backends to run pgstat_gc_entry_refs(), allowing memory to
551 : : * be reclaimed.
552 : : */
553 : : pg_atomic_uint64 gc_request_count;
554 : :
555 : : /*
556 : : * Counters for the number of entries associated to a single stats kind
557 : : * that uses variable-numbered objects stored in the shared hash table.
558 : : * These counters can be enabled on a per-kind basis, when
559 : : * track_entry_count is set. This counter is incremented each time a new
560 : : * entry is created (not reused) in the shared hash table, and is
561 : : * decremented each time an entry is freed from the shared hash table.
562 : : */
563 : : pg_atomic_uint64 entry_counts[PGSTAT_KIND_MAX];
564 : :
565 : : /*
566 : : * Stats data for fixed-numbered objects.
567 : : */
568 : : PgStatShared_Archiver archiver;
569 : : PgStatShared_BgWriter bgwriter;
570 : : PgStatShared_Checkpointer checkpointer;
571 : : PgStatShared_IO io;
572 : : PgStatShared_SLRU slru;
573 : : PgStatShared_Wal wal;
574 : :
575 : : /*
576 : : * Custom stats data with fixed-numbered objects, indexed by (PgStat_Kind
577 : : * - PGSTAT_KIND_CUSTOM_MIN).
578 : : */
579 : : void *custom_data[PGSTAT_KIND_CUSTOM_SIZE];
580 : :
581 : : } PgStat_ShmemControl;
582 : :
583 : :
584 : : /*
585 : : * Cached statistics snapshot
586 : : */
587 : : typedef struct PgStat_Snapshot
588 : : {
589 : : PgStat_FetchConsistency mode;
590 : :
591 : : /* time at which snapshot was taken */
592 : : TimestampTz snapshot_timestamp;
593 : :
594 : : bool fixed_valid[PGSTAT_KIND_BUILTIN_SIZE];
595 : :
596 : : PgStat_ArchiverStats archiver;
597 : :
598 : : PgStat_BgWriterStats bgwriter;
599 : :
600 : : PgStat_CheckpointerStats checkpointer;
601 : :
602 : : PgStat_IO io;
603 : :
604 : : PgStat_SLRUStats slru[SLRU_NUM_ELEMENTS];
605 : :
606 : : PgStat_WalStats wal;
607 : :
608 : : /*
609 : : * Data in snapshot for custom fixed-numbered statistics, indexed by
610 : : * (PgStat_Kind - PGSTAT_KIND_CUSTOM_MIN). Each entry is allocated in
611 : : * TopMemoryContext, for a size of PgStat_KindInfo->shared_data_len.
612 : : */
613 : : bool custom_valid[PGSTAT_KIND_CUSTOM_SIZE];
614 : : void *custom_data[PGSTAT_KIND_CUSTOM_SIZE];
615 : :
616 : : /* to free snapshot in bulk */
617 : : MemoryContext context;
618 : : struct pgstat_snapshot_hash *stats;
619 : : } PgStat_Snapshot;
620 : :
621 : :
622 : : /*
623 : : * Collection of backend-local stats state.
624 : : */
625 : : typedef struct PgStat_LocalState
626 : : {
627 : : PgStat_ShmemControl *shmem;
628 : : dsa_area *dsa;
629 : : dshash_table *shared_hash;
630 : :
631 : : /* the current statistics snapshot */
632 : : PgStat_Snapshot snapshot;
633 : : } PgStat_LocalState;
634 : :
635 : :
636 : : /*
637 : : * Inline functions defined further below.
638 : : */
639 : :
640 : : static inline void pgstat_begin_changecount_write(uint32 *cc);
641 : : static inline void pgstat_end_changecount_write(uint32 *cc);
642 : : static inline uint32 pgstat_begin_changecount_read(uint32 *cc);
643 : : static inline bool pgstat_end_changecount_read(uint32 *cc, uint32 cc_before);
644 : :
645 : : static inline void pgstat_copy_changecounted_stats(void *dst, void *src, size_t len,
646 : : uint32 *cc);
647 : :
648 : : static inline int pgstat_cmp_hash_key(const void *a, const void *b, size_t size, void *arg);
649 : : static inline uint32 pgstat_hash_hash_key(const void *d, size_t size, void *arg);
650 : : static inline size_t pgstat_get_entry_len(PgStat_Kind kind);
651 : : static inline void *pgstat_get_entry_data(PgStat_Kind kind, PgStatShared_Common *entry);
652 : : static inline void *pgstat_get_custom_shmem_data(PgStat_Kind kind);
653 : : static inline void *pgstat_get_custom_snapshot_data(PgStat_Kind kind);
654 : :
655 : :
656 : : /*
657 : : * Functions in pgstat.c
658 : : */
659 : :
660 : : extern const PgStat_KindInfo *pgstat_get_kind_info(PgStat_Kind kind);
661 : : extern void pgstat_register_kind(PgStat_Kind kind,
662 : : const PgStat_KindInfo *kind_info);
663 : :
664 : : #ifdef USE_ASSERT_CHECKING
665 : : extern void pgstat_assert_is_up(void);
666 : : #else
667 : : #define pgstat_assert_is_up() ((void)true)
668 : : #endif
669 : :
670 : : extern void pgstat_delete_pending_entry(PgStat_EntryRef *entry_ref);
671 : : extern PgStat_EntryRef *pgstat_prep_pending_entry(PgStat_Kind kind, Oid dboid,
672 : : uint64 objid,
673 : : bool *created_entry);
674 : : extern PgStat_EntryRef *pgstat_fetch_pending_entry(PgStat_Kind kind,
675 : : Oid dboid, uint64 objid);
676 : :
677 : : extern void *pgstat_fetch_entry(PgStat_Kind kind, Oid dboid, uint64 objid);
678 : : extern void pgstat_snapshot_fixed(PgStat_Kind kind);
679 : :
680 : :
681 : : /*
682 : : * Functions in pgstat_archiver.c
683 : : */
684 : :
685 : : extern void pgstat_archiver_init_shmem_cb(void *stats);
686 : : extern void pgstat_archiver_reset_all_cb(TimestampTz ts);
687 : : extern void pgstat_archiver_snapshot_cb(void);
688 : :
689 : : /*
690 : : * Functions in pgstat_backend.c
691 : : */
692 : :
693 : : /* flags for pgstat_flush_backend() */
694 : : #define PGSTAT_BACKEND_FLUSH_IO (1 << 0) /* Flush I/O statistics */
695 : : #define PGSTAT_BACKEND_FLUSH_WAL (1 << 1) /* Flush WAL statistics */
696 : : #define PGSTAT_BACKEND_FLUSH_ALL (PGSTAT_BACKEND_FLUSH_IO | PGSTAT_BACKEND_FLUSH_WAL)
697 : :
698 : : extern bool pgstat_flush_backend(bool nowait, bits32 flags);
699 : : extern bool pgstat_backend_flush_cb(bool nowait);
700 : : extern void pgstat_backend_reset_timestamp_cb(PgStatShared_Common *header,
701 : : TimestampTz ts);
702 : :
703 : : /*
704 : : * Functions in pgstat_bgwriter.c
705 : : */
706 : :
707 : : extern void pgstat_bgwriter_init_shmem_cb(void *stats);
708 : : extern void pgstat_bgwriter_reset_all_cb(TimestampTz ts);
709 : : extern void pgstat_bgwriter_snapshot_cb(void);
710 : :
711 : :
712 : : /*
713 : : * Functions in pgstat_checkpointer.c
714 : : */
715 : :
716 : : extern void pgstat_checkpointer_init_shmem_cb(void *stats);
717 : : extern void pgstat_checkpointer_reset_all_cb(TimestampTz ts);
718 : : extern void pgstat_checkpointer_snapshot_cb(void);
719 : :
720 : :
721 : : /*
722 : : * Functions in pgstat_database.c
723 : : */
724 : :
725 : : extern void pgstat_report_disconnect(Oid dboid);
726 : : extern void pgstat_update_dbstats(TimestampTz ts);
727 : : extern void AtEOXact_PgStat_Database(bool isCommit, bool parallel);
728 : :
729 : : extern PgStat_StatDBEntry *pgstat_prep_database_pending(Oid dboid);
730 : : extern void pgstat_reset_database_timestamp(Oid dboid, TimestampTz ts);
731 : : extern bool pgstat_database_flush_cb(PgStat_EntryRef *entry_ref, bool nowait);
732 : : extern void pgstat_database_reset_timestamp_cb(PgStatShared_Common *header, TimestampTz ts);
733 : :
734 : :
735 : : /*
736 : : * Functions in pgstat_function.c
737 : : */
738 : :
739 : : extern bool pgstat_function_flush_cb(PgStat_EntryRef *entry_ref, bool nowait);
740 : : extern void pgstat_function_reset_timestamp_cb(PgStatShared_Common *header, TimestampTz ts);
741 : :
742 : :
743 : : /*
744 : : * Functions in pgstat_io.c
745 : : */
746 : :
747 : : extern void pgstat_flush_io(bool nowait);
748 : :
749 : : extern bool pgstat_io_flush_cb(bool nowait);
750 : : extern void pgstat_io_init_shmem_cb(void *stats);
751 : : extern void pgstat_io_reset_all_cb(TimestampTz ts);
752 : : extern void pgstat_io_snapshot_cb(void);
753 : :
754 : :
755 : : /*
756 : : * Functions in pgstat_relation.c
757 : : */
758 : :
759 : : extern void AtEOXact_PgStat_Relations(PgStat_SubXactStatus *xact_state, bool isCommit);
760 : : extern void AtEOSubXact_PgStat_Relations(PgStat_SubXactStatus *xact_state, bool isCommit, int nestDepth);
761 : : extern void AtPrepare_PgStat_Relations(PgStat_SubXactStatus *xact_state);
762 : : extern void PostPrepare_PgStat_Relations(PgStat_SubXactStatus *xact_state);
763 : :
764 : : extern bool pgstat_relation_flush_cb(PgStat_EntryRef *entry_ref, bool nowait);
765 : : extern void pgstat_relation_delete_pending_cb(PgStat_EntryRef *entry_ref);
766 : : extern void pgstat_relation_reset_timestamp_cb(PgStatShared_Common *header, TimestampTz ts);
767 : :
768 : :
769 : : /*
770 : : * Functions in pgstat_replslot.c
771 : : */
772 : :
773 : : extern void pgstat_replslot_reset_timestamp_cb(PgStatShared_Common *header, TimestampTz ts);
774 : : extern void pgstat_replslot_to_serialized_name_cb(const PgStat_HashKey *key, const PgStatShared_Common *header, NameData *name);
775 : : extern bool pgstat_replslot_from_serialized_name_cb(const NameData *name, PgStat_HashKey *key);
776 : :
777 : :
778 : : /*
779 : : * Functions in pgstat_shmem.c
780 : : */
781 : :
782 : : extern void pgstat_attach_shmem(void);
783 : : extern void pgstat_detach_shmem(void);
784 : :
785 : : extern PgStat_EntryRef *pgstat_get_entry_ref(PgStat_Kind kind, Oid dboid, uint64 objid,
786 : : bool create, bool *created_entry);
787 : : extern bool pgstat_lock_entry(PgStat_EntryRef *entry_ref, bool nowait);
788 : : extern bool pgstat_lock_entry_shared(PgStat_EntryRef *entry_ref, bool nowait);
789 : : extern void pgstat_unlock_entry(PgStat_EntryRef *entry_ref);
790 : : extern bool pgstat_drop_entry(PgStat_Kind kind, Oid dboid, uint64 objid);
791 : : extern void pgstat_drop_all_entries(void);
792 : : extern void pgstat_drop_matching_entries(bool (*do_drop) (PgStatShared_HashEntry *, Datum),
793 : : Datum match_data);
794 : : extern PgStat_EntryRef *pgstat_get_entry_ref_locked(PgStat_Kind kind, Oid dboid, uint64 objid,
795 : : bool nowait);
796 : : extern void pgstat_reset_entry(PgStat_Kind kind, Oid dboid, uint64 objid, TimestampTz ts);
797 : : extern void pgstat_reset_entries_of_kind(PgStat_Kind kind, TimestampTz ts);
798 : : extern void pgstat_reset_matching_entries(bool (*do_reset) (PgStatShared_HashEntry *, Datum),
799 : : Datum match_data,
800 : : TimestampTz ts);
801 : :
802 : : extern void pgstat_request_entry_refs_gc(void);
803 : : extern PgStatShared_Common *pgstat_init_entry(PgStat_Kind kind,
804 : : PgStatShared_HashEntry *shhashent);
805 : :
806 : :
807 : : /*
808 : : * Functions in pgstat_slru.c
809 : : */
810 : :
811 : : extern bool pgstat_slru_flush_cb(bool nowait);
812 : : extern void pgstat_slru_init_shmem_cb(void *stats);
813 : : extern void pgstat_slru_reset_all_cb(TimestampTz ts);
814 : : extern void pgstat_slru_snapshot_cb(void);
815 : :
816 : :
817 : : /*
818 : : * Functions in pgstat_wal.c
819 : : */
820 : :
821 : : extern void pgstat_wal_init_backend_cb(void);
822 : : extern bool pgstat_wal_flush_cb(bool nowait);
823 : : extern void pgstat_wal_init_shmem_cb(void *stats);
824 : : extern void pgstat_wal_reset_all_cb(TimestampTz ts);
825 : : extern void pgstat_wal_snapshot_cb(void);
826 : :
827 : :
828 : : /*
829 : : * Functions in pgstat_subscription.c
830 : : */
831 : :
832 : : extern bool pgstat_subscription_flush_cb(PgStat_EntryRef *entry_ref, bool nowait);
833 : : extern void pgstat_subscription_reset_timestamp_cb(PgStatShared_Common *header, TimestampTz ts);
834 : :
835 : :
836 : : /*
837 : : * Functions in pgstat_xact.c
838 : : */
839 : :
840 : : extern PgStat_SubXactStatus *pgstat_get_xact_stack_level(int nest_level);
841 : : extern void pgstat_drop_transactional(PgStat_Kind kind, Oid dboid, uint64 objid);
842 : : extern void pgstat_create_transactional(PgStat_Kind kind, Oid dboid, uint64 objid);
843 : :
844 : :
845 : : /*
846 : : * Variables in pgstat.c
847 : : */
848 : :
849 : : /*
850 : : * Track if *any* pending fixed-numbered statistics should be flushed to
851 : : * shared memory.
852 : : *
853 : : * This flag can be switched to true by fixed-numbered statistics to let
854 : : * pgstat_report_stat() know if it needs to go through one round of
855 : : * reports, calling flush_static_cb for each fixed-numbered statistics
856 : : * kind. When this flag is not set, pgstat_report_stat() is able to do
857 : : * a fast exit, knowing that there are no pending fixed-numbered statistics.
858 : : *
859 : : * Statistics callbacks should never reset this flag; pgstat_report_stat()
860 : : * is in charge of doing that.
861 : : */
862 : : extern PGDLLIMPORT bool pgstat_report_fixed;
863 : :
864 : : /* Backend-local stats state */
865 : : extern PGDLLIMPORT PgStat_LocalState pgStatLocal;
866 : :
867 : : /* Helper functions for reading and writing of on-disk stats file */
868 : : extern void pgstat_write_chunk(FILE *fpout, void *ptr, size_t len);
869 : : extern bool pgstat_read_chunk(FILE *fpin, void *ptr, size_t len);
870 : : #define pgstat_read_chunk_s(fpin, ptr) pgstat_read_chunk(fpin, ptr, sizeof(*ptr))
871 : : #define pgstat_write_chunk_s(fpout, ptr) pgstat_write_chunk(fpout, ptr, sizeof(*ptr))
872 : :
873 : : /*
874 : : * Implementation of inline functions declared above.
875 : : */
876 : :
877 : : /*
878 : : * Helpers for changecount manipulation. See comments around struct
879 : : * PgBackendStatus for details.
880 : : */
881 : :
882 : : static inline void
1350 andres@anarazel.de 883 :CBC 13960 : pgstat_begin_changecount_write(uint32 *cc)
884 : : {
885 [ - + ]: 13960 : Assert((*cc & 1) == 0);
886 : :
887 : 13960 : START_CRIT_SECTION();
888 : 13960 : (*cc)++;
889 : 13960 : pg_write_barrier();
890 : 13960 : }
891 : :
892 : : static inline void
893 : 13960 : pgstat_end_changecount_write(uint32 *cc)
894 : : {
895 [ - + ]: 13960 : Assert((*cc & 1) == 1);
896 : :
897 : 13960 : pg_write_barrier();
898 : :
899 : 13960 : (*cc)++;
900 : :
901 [ - + ]: 13960 : END_CRIT_SECTION();
902 : 13960 : }
903 : :
904 : : static inline uint32
905 : 2727 : pgstat_begin_changecount_read(uint32 *cc)
906 : : {
907 : 2727 : uint32 before_cc = *cc;
908 : :
909 [ - + ]: 2727 : CHECK_FOR_INTERRUPTS();
910 : :
911 : 2727 : pg_read_barrier();
912 : :
913 : 2727 : return before_cc;
914 : : }
915 : :
916 : : /*
917 : : * Returns true if the read succeeded, false if it needs to be repeated.
918 : : */
919 : : static inline bool
920 : 2727 : pgstat_end_changecount_read(uint32 *cc, uint32 before_cc)
921 : : {
922 : : uint32 after_cc;
923 : :
924 : 2727 : pg_read_barrier();
925 : :
926 : 2727 : after_cc = *cc;
927 : :
928 : : /* was a write in progress when we started? */
929 [ - + ]: 2727 : if (before_cc & 1)
1350 andres@anarazel.de 930 :UBC 0 : return false;
931 : :
932 : : /* did writes start and complete while we read? */
1350 andres@anarazel.de 933 :CBC 2727 : return before_cc == after_cc;
934 : : }
935 : :
936 : :
937 : : /*
938 : : * helper function for PgStat_KindInfo->snapshot_cb
939 : : * PgStat_KindInfo->reset_all_cb callbacks.
940 : : *
941 : : * Copies out the specified memory area following change-count protocol.
942 : : */
943 : : static inline void
944 : 2727 : pgstat_copy_changecounted_stats(void *dst, void *src, size_t len,
945 : : uint32 *cc)
946 : : {
947 : : uint32 cc_before;
948 : :
949 : : do
950 : : {
951 : 2727 : cc_before = pgstat_begin_changecount_read(cc);
952 : :
953 : 2727 : memcpy(dst, src, len);
954 : : }
955 [ - + ]: 2727 : while (!pgstat_end_changecount_read(cc, cc_before));
956 : 2727 : }
957 : :
958 : : /* helpers for dshash / simplehash hashtables */
959 : : static inline int
960 : 5304353 : pgstat_cmp_hash_key(const void *a, const void *b, size_t size, void *arg)
961 : : {
1145 peter@eisentraut.org 962 [ + - - + ]: 5304353 : Assert(size == sizeof(PgStat_HashKey) && arg == NULL);
1350 andres@anarazel.de 963 : 5304353 : return memcmp(a, b, sizeof(PgStat_HashKey));
964 : : }
965 : :
966 : : static inline uint32
967 : 6424425 : pgstat_hash_hash_key(const void *d, size_t size, void *arg)
968 : : {
750 john.naylor@postgres 969 : 6424425 : const char *key = (const char *) d;
970 : :
1145 peter@eisentraut.org 971 [ + - - + ]: 6424425 : Assert(size == sizeof(PgStat_HashKey) && arg == NULL);
750 john.naylor@postgres 972 : 6424425 : return fasthash32(key, size, 0);
973 : : }
974 : :
975 : : /*
976 : : * The length of the data portion of a shared memory stats entry (i.e. without
977 : : * transient data such as refcounts, lwlocks, ...).
978 : : */
979 : : static inline size_t
1350 andres@anarazel.de 980 : 436674 : pgstat_get_entry_len(PgStat_Kind kind)
981 : : {
982 : 436674 : return pgstat_get_kind_info(kind)->shared_data_len;
983 : : }
984 : :
985 : : /*
986 : : * Returns a pointer to the data portion of a shared memory stats entry.
987 : : */
988 : : static inline void *
989 : 426154 : pgstat_get_entry_data(PgStat_Kind kind, PgStatShared_Common *entry)
990 : : {
991 : 426154 : size_t off = pgstat_get_kind_info(kind)->shared_data_off;
992 : :
993 [ + - - + ]: 426154 : Assert(off != 0 && off < PG_UINT32_MAX);
994 : :
995 : 426154 : return ((char *) (entry)) + off;
996 : : }
997 : :
998 : : /*
999 : : * Returns the number of entries counted for a stats kind.
1000 : : */
1001 : : static inline uint64
1002 : : pgstat_get_entry_count(PgStat_Kind kind)
1003 : : {
1004 : : Assert(pgstat_get_kind_info(kind)->track_entry_count);
1005 : :
1006 : : return pg_atomic_read_u64(&pgStatLocal.shmem->entry_counts[kind - 1]);
1007 : : }
1008 : :
1009 : : /*
1010 : : * Returns a pointer to the shared memory area of custom stats for
1011 : : * fixed-numbered statistics.
1012 : : */
1013 : : static inline void *
498 michael@paquier.xyz 1014 :GIC 11 : pgstat_get_custom_shmem_data(PgStat_Kind kind)
1015 : : {
1016 : 11 : int idx = kind - PGSTAT_KIND_CUSTOM_MIN;
1017 : :
1018 [ - + ]: 11 : Assert(pgstat_is_kind_custom(kind));
1019 [ - + ]: 11 : Assert(pgstat_get_kind_info(kind)->fixed_amount);
1020 : :
1021 : 11 : return pgStatLocal.shmem->custom_data[idx];
1022 : : }
1023 : :
1024 : : /*
1025 : : * Returns a pointer to the portion of custom data for fixed-numbered
1026 : : * statistics in the current snapshot.
1027 : : */
1028 : : static inline void *
1029 : 7 : pgstat_get_custom_snapshot_data(PgStat_Kind kind)
1030 : : {
1031 : 7 : int idx = kind - PGSTAT_KIND_CUSTOM_MIN;
1032 : :
1033 [ - + ]: 7 : Assert(pgstat_is_kind_custom(kind));
1034 [ - + ]: 7 : Assert(pgstat_get_kind_info(kind)->fixed_amount);
1035 : :
1036 : 7 : return pgStatLocal.snapshot.custom_data[idx];
1037 : : }
1038 : :
1039 : : #endif /* PGSTAT_INTERNAL_H */
|
