Age Owner Branch data TLA Line data Source code
1 : : /* -------------------------------------------------------------------------
2 : : *
3 : : * pgstat_replslot.c
4 : : * Implementation of replication slot statistics.
5 : : *
6 : : * This file contains the implementation of replication slot statistics. It is kept
7 : : * separate from pgstat.c to enforce the line between the statistics access /
8 : : * storage implementation and the details about individual types of
9 : : * statistics.
10 : : *
11 : : * Replication slot stats work a bit different than other variable-numbered
12 : : * stats. Slots do not have oids (so they can be created on physical
13 : : * replicas). Use the slot index as object id while running. However, the slot
14 : : * index can change when restarting. That is addressed by using the name when
15 : : * (de-)serializing. After a restart it is possible for slots to have been
16 : : * dropped while shut down, which is addressed by not restoring stats for
17 : : * slots that cannot be found by name when starting up.
18 : : *
19 : : * Copyright (c) 2001-2024, PostgreSQL Global Development Group
20 : : *
21 : : * IDENTIFICATION
22 : : * src/backend/utils/activity/pgstat_replslot.c
23 : : * -------------------------------------------------------------------------
24 : : */
25 : :
26 : : #include "postgres.h"
27 : :
28 : : #include "replication/slot.h"
29 : : #include "utils/pgstat_internal.h"
30 : :
31 : :
32 : : static int get_replslot_index(const char *name, bool need_lock);
33 : :
34 : :
35 : : /*
36 : : * Reset counters for a single replication slot.
37 : : *
38 : : * Permission checking for this function is managed through the normal
39 : : * GRANT system.
40 : : */
41 : : void
739 andres@anarazel.de 42 :CBC 4 : pgstat_reset_replslot(const char *name)
43 : : {
44 : : ReplicationSlot *slot;
45 : :
534 peter@eisentraut.org 46 [ - + ]: 4 : Assert(name != NULL);
47 : :
34 michael@paquier.xyz 48 :GNC 4 : LWLockAcquire(ReplicationSlotControlLock, LW_SHARED);
49 : :
50 : : /* Check if the slot exits with the given name. */
51 : 4 : slot = SearchNamedReplicationSlot(name, false);
52 : :
739 andres@anarazel.de 53 [ + + ]:CBC 4 : if (!slot)
54 [ + - ]: 1 : ereport(ERROR,
55 : : (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
56 : : errmsg("replication slot \"%s\" does not exist",
57 : : name)));
58 : :
59 : : /*
60 : : * Reset stats if it is a logical slot. Nothing to do for physical slots
61 : : * as we collect stats only for logical slots.
62 : : */
34 michael@paquier.xyz 63 [ + - ]:GNC 3 : if (SlotIsLogical(slot))
64 : 3 : pgstat_reset(PGSTAT_KIND_REPLSLOT, InvalidOid,
65 : 3 : ReplicationSlotIndex(slot));
66 : :
67 : 3 : LWLockRelease(ReplicationSlotControlLock);
755 andres@anarazel.de 68 :GIC 3 : }
69 : :
70 : : /*
71 : : * Report replication slot statistics.
72 : : *
73 : : * We can rely on the stats for the slot to exist and to belong to this
74 : : * slot. We can only get here if pgstat_create_replslot() or
75 : : * pgstat_acquire_replslot() have already been called.
76 : : */
77 : : void
739 andres@anarazel.de 78 :CBC 5139 : pgstat_report_replslot(ReplicationSlot *slot, const PgStat_StatReplSlotEntry *repSlotStat)
79 : : {
80 : : PgStat_EntryRef *entry_ref;
81 : : PgStatShared_ReplSlot *shstatent;
82 : : PgStat_StatReplSlotEntry *statent;
83 : :
84 : 5139 : entry_ref = pgstat_get_entry_ref_locked(PGSTAT_KIND_REPLSLOT, InvalidOid,
85 : 5139 : ReplicationSlotIndex(slot), false);
86 : 5139 : shstatent = (PgStatShared_ReplSlot *) entry_ref->shared_stats;
87 : 5139 : statent = &shstatent->stats;
88 : :
89 : : /* Update the replication slot statistics */
90 : : #define REPLSLOT_ACC(fld) statent->fld += repSlotStat->fld
91 : 5139 : REPLSLOT_ACC(spill_txns);
92 : 5139 : REPLSLOT_ACC(spill_count);
93 : 5139 : REPLSLOT_ACC(spill_bytes);
94 : 5139 : REPLSLOT_ACC(stream_txns);
95 : 5139 : REPLSLOT_ACC(stream_count);
96 : 5139 : REPLSLOT_ACC(stream_bytes);
97 : 5139 : REPLSLOT_ACC(total_txns);
98 : 5139 : REPLSLOT_ACC(total_bytes);
99 : : #undef REPLSLOT_ACC
100 : :
101 : 5139 : pgstat_unlock_entry(entry_ref);
755 102 : 5139 : }
103 : :
104 : : /*
105 : : * Report replication slot creation.
106 : : *
107 : : * NB: This gets called with ReplicationSlotAllocationLock already held, be
108 : : * careful about calling back into slot.c.
109 : : */
110 : : void
739 111 : 402 : pgstat_create_replslot(ReplicationSlot *slot)
112 : : {
113 : : PgStat_EntryRef *entry_ref;
114 : : PgStatShared_ReplSlot *shstatent;
115 : :
32 michael@paquier.xyz 116 [ - + ]:GNC 402 : Assert(LWLockHeldByMeInMode(ReplicationSlotAllocationLock, LW_EXCLUSIVE));
117 : :
739 andres@anarazel.de 118 :CBC 402 : entry_ref = pgstat_get_entry_ref_locked(PGSTAT_KIND_REPLSLOT, InvalidOid,
119 : 402 : ReplicationSlotIndex(slot), false);
120 : 402 : shstatent = (PgStatShared_ReplSlot *) entry_ref->shared_stats;
121 : :
122 : : /*
123 : : * NB: need to accept that there might be stats from an older slot, e.g.
124 : : * if we previously crashed after dropping a slot.
125 : : */
126 : 402 : memset(&shstatent->stats, 0, sizeof(shstatent->stats));
127 : :
128 : 402 : pgstat_unlock_entry(entry_ref);
129 : 402 : }
130 : :
131 : : /*
132 : : * Report replication slot has been acquired.
133 : : *
134 : : * This guarantees that a stats entry exists during later
135 : : * pgstat_report_replslot() calls.
136 : : *
137 : : * If we previously crashed, no stats data exists. But if we did not crash,
138 : : * the stats do belong to this slot:
139 : : * - the stats cannot belong to a dropped slot, pgstat_drop_replslot() would
140 : : * have been called
141 : : * - if the slot was removed while shut down,
142 : : * pgstat_replslot_from_serialized_name_cb() returning false would have
143 : : * caused the stats to be dropped
144 : : */
145 : : void
146 : 919 : pgstat_acquire_replslot(ReplicationSlot *slot)
147 : : {
554 148 : 919 : pgstat_get_entry_ref(PGSTAT_KIND_REPLSLOT, InvalidOid,
149 : 919 : ReplicationSlotIndex(slot), true, NULL);
755 150 : 919 : }
151 : :
152 : : /*
153 : : * Report replication slot drop.
154 : : */
155 : : void
739 156 : 341 : pgstat_drop_replslot(ReplicationSlot *slot)
157 : : {
32 michael@paquier.xyz 158 [ - + ]:GNC 341 : Assert(LWLockHeldByMeInMode(ReplicationSlotAllocationLock, LW_EXCLUSIVE));
159 : :
739 andres@anarazel.de 160 :CBC 341 : pgstat_drop_entry(PGSTAT_KIND_REPLSLOT, InvalidOid,
161 : 341 : ReplicationSlotIndex(slot));
162 : 341 : }
163 : :
164 : : /*
165 : : * Support function for the SQL-callable pgstat* functions. Returns
166 : : * a pointer to the replication slot statistics struct.
167 : : */
168 : : PgStat_StatReplSlotEntry *
169 : 47 : pgstat_fetch_replslot(NameData slotname)
170 : : {
171 : : int idx;
34 michael@paquier.xyz 172 :GNC 47 : PgStat_StatReplSlotEntry *slotentry = NULL;
173 : :
174 : 47 : LWLockAcquire(ReplicationSlotControlLock, LW_SHARED);
175 : :
176 : 47 : idx = get_replslot_index(NameStr(slotname), false);
177 : :
178 [ + + ]: 47 : if (idx != -1)
179 : 45 : slotentry = (PgStat_StatReplSlotEntry *) pgstat_fetch_entry(PGSTAT_KIND_REPLSLOT,
180 : : InvalidOid, idx);
181 : :
182 : 47 : LWLockRelease(ReplicationSlotControlLock);
183 : :
184 : 47 : return slotentry;
185 : : }
186 : :
187 : : void
554 andres@anarazel.de 188 :CBC 67 : pgstat_replslot_to_serialized_name_cb(const PgStat_HashKey *key, const PgStatShared_Common *header, NameData *name)
189 : : {
190 : : /*
191 : : * This is only called late during shutdown. The set of existing slots
192 : : * isn't allowed to change at this point, we can assume that a slot exists
193 : : * at the offset.
194 : : */
195 [ - + ]: 67 : if (!ReplicationSlotName(key->objoid, name))
554 andres@anarazel.de 196 [ # # ]:UBC 0 : elog(ERROR, "could not find name for replication slot index %u",
197 : : key->objoid);
739 andres@anarazel.de 198 :CBC 67 : }
199 : :
200 : : bool
201 : 38 : pgstat_replslot_from_serialized_name_cb(const NameData *name, PgStat_HashKey *key)
202 : : {
34 michael@paquier.xyz 203 :GNC 38 : int idx = get_replslot_index(NameStr(*name), true);
204 : :
205 : : /* slot might have been deleted */
739 andres@anarazel.de 206 [ + + ]:CBC 38 : if (idx == -1)
207 : 1 : return false;
208 : :
209 : 37 : key->kind = PGSTAT_KIND_REPLSLOT;
210 : 37 : key->dboid = InvalidOid;
211 : 37 : key->objoid = idx;
212 : :
213 : 37 : return true;
214 : : }
215 : :
216 : : void
217 : 8 : pgstat_replslot_reset_timestamp_cb(PgStatShared_Common *header, TimestampTz ts)
218 : : {
219 : 8 : ((PgStatShared_ReplSlot *) header)->stats.stat_reset_timestamp = ts;
220 : 8 : }
221 : :
222 : : static int
34 michael@paquier.xyz 223 :GNC 85 : get_replslot_index(const char *name, bool need_lock)
224 : : {
225 : : ReplicationSlot *slot;
226 : :
534 peter@eisentraut.org 227 [ - + ]:CBC 85 : Assert(name != NULL);
228 : :
34 michael@paquier.xyz 229 :GNC 85 : slot = SearchNamedReplicationSlot(name, need_lock);
230 : :
739 andres@anarazel.de 231 [ + + ]:CBC 85 : if (!slot)
232 : 3 : return -1;
233 : :
234 : 82 : return ReplicationSlotIndex(slot);
235 : : }
|
