Skip to content

Commit 14a9101

Browse files
tglsfdctglsfdc
committed
Drop the redundant "Lock" suffix from LWLock wait event names.
This was mostly confusing, especially since some wait events in this class had the suffix and some did not. While at it, stop exposing MainLWLockNames[] as a globally visible name; any code using that directly is almost certainly wrong, as its name has been misleading for some time. (GetLWLockIdentifier() is what to use instead.) Discussion: https://postgr.es/m/28683.1589405363@sss.pgh.pa.us
1 parent 8048404 commit 14a9101

File tree

4 files changed

+53
-49
lines changed

4 files changed

+53
-49
lines changed

‎doc/src/sgml/monitoring.sgml‎

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1750,31 +1750,31 @@ postgres 27093 0.0 0.0 30096 2752 ? Ss 11:34 0:00 postgres: ser
17501750

17511751
<tbody>
17521752
<row>
1753-
<entry><literal>AddinShmemInitLock</literal></entry>
1753+
<entry><literal>AddinShmemInit</literal></entry>
17541754
<entry>Waiting to manage an extension's space allocation in shared
17551755
memory.</entry>
17561756
</row>
17571757
<row>
1758-
<entry><literal>AutoFileLock</literal></entry>
1758+
<entry><literal>AutoFile</literal></entry>
17591759
<entry>Waiting to update the <filename>postgresql.auto.conf</filename>
17601760
file.</entry>
17611761
</row>
17621762
<row>
1763-
<entry><literal>AutovacuumLock</literal></entry>
1763+
<entry><literal>Autovacuum</literal></entry>
17641764
<entry>Waiting to read or update the current state of autovacuum
17651765
workers.</entry>
17661766
</row>
17671767
<row>
1768-
<entry><literal>AutovacuumScheduleLock</literal></entry>
1768+
<entry><literal>AutovacuumSchedule</literal></entry>
17691769
<entry>Waiting to ensure that a table selected for autovacuum
17701770
still needs vacuuming.</entry>
17711771
</row>
17721772
<row>
1773-
<entry><literal>BackgroundWorkerLock</literal></entry>
1773+
<entry><literal>BackgroundWorker</literal></entry>
17741774
<entry>Waiting to read or update background worker state.</entry>
17751775
</row>
17761776
<row>
1777-
<entry><literal>BtreeVacuumLock</literal></entry>
1777+
<entry><literal>BtreeVacuum</literal></entry>
17781778
<entry>Waiting to read or update vacuum-related information for a
17791779
B-tree index.</entry>
17801780
</row>
@@ -1792,15 +1792,15 @@ postgres 27093 0.0 0.0 30096 2752 ? Ss 11:34 0:00 postgres: ser
17921792
pool.</entry>
17931793
</row>
17941794
<row>
1795-
<entry><literal>CheckpointLock</literal></entry>
1795+
<entry><literal>Checkpoint</literal></entry>
17961796
<entry>Waiting to begin a checkpoint.</entry>
17971797
</row>
17981798
<row>
1799-
<entry><literal>CheckpointerCommLock</literal></entry>
1799+
<entry><literal>CheckpointerComm</literal></entry>
18001800
<entry>Waiting to manage fsync requests.</entry>
18011801
</row>
18021802
<row>
1803-
<entry><literal>CommitTsLock</literal></entry>
1803+
<entry><literal>CommitTs</literal></entry>
18041804
<entry>Waiting to read or update the last value set for a
18051805
transaction commit timestamp.</entry>
18061806
</row>
@@ -1809,16 +1809,16 @@ postgres 27093 0.0 0.0 30096 2752 ? Ss 11:34 0:00 postgres: ser
18091809
<entry>Waiting for I/O on a commit timestamp SLRU buffer.</entry>
18101810
</row>
18111811
<row>
1812-
<entry><literal>CommitTsSLRULock</literal></entry>
1812+
<entry><literal>CommitTsSLRU</literal></entry>
18131813
<entry>Waiting to access the commit timestamp SLRU cache.</entry>
18141814
</row>
18151815
<row>
1816-
<entry><literal>ControlFileLock</literal></entry>
1816+
<entry><literal>ControlFile</literal></entry>
18171817
<entry>Waiting to read or update the <filename>pg_control</filename>
18181818
file or create a new WAL file.</entry>
18191819
</row>
18201820
<row>
1821-
<entry><literal>DynamicSharedMemoryControlLock</literal></entry>
1821+
<entry><literal>DynamicSharedMemoryControl</literal></entry>
18221822
<entry>Waiting to read or update dynamic shared memory allocation
18231823
information.</entry>
18241824
</row>
@@ -1833,32 +1833,32 @@ postgres 27093 0.0 0.0 30096 2752 ? Ss 11:34 0:00 postgres: ser
18331833
about <quote>heavyweight</quote> locks.</entry>
18341834
</row>
18351835
<row>
1836-
<entry><literal>LogicalRepWorkerLock</literal></entry>
1836+
<entry><literal>LogicalRepWorker</literal></entry>
18371837
<entry>Waiting to read or update the state of logical replication
18381838
workers.</entry>
18391839
</row>
18401840
<row>
1841-
<entry><literal>MultiXactGenLock</literal></entry>
1841+
<entry><literal>MultiXactGen</literal></entry>
18421842
<entry>Waiting to read or update shared multixact state.</entry>
18431843
</row>
18441844
<row>
18451845
<entry><literal>MultiXactMemberBuffer</literal></entry>
18461846
<entry>Waiting for I/O on a multixact member SLRU buffer.</entry>
18471847
</row>
18481848
<row>
1849-
<entry><literal>MultiXactMemberSLRULock</literal></entry>
1849+
<entry><literal>MultiXactMemberSLRU</literal></entry>
18501850
<entry>Waiting to access the multixact member SLRU cache.</entry>
18511851
</row>
18521852
<row>
18531853
<entry><literal>MultiXactOffsetBuffer</literal></entry>
18541854
<entry>Waiting for I/O on a multixact offset SLRU buffer.</entry>
18551855
</row>
18561856
<row>
1857-
<entry><literal>MultiXactOffsetSLRULock</literal></entry>
1857+
<entry><literal>MultiXactOffsetSLRU</literal></entry>
18581858
<entry>Waiting to access the multixact offset SLRU cache.</entry>
18591859
</row>
18601860
<row>
1861-
<entry><literal>MultiXactTruncationLock</literal></entry>
1861+
<entry><literal>MultiXactTruncation</literal></entry>
18621862
<entry>Waiting to read or truncate multixact information.</entry>
18631863
</row>
18641864
<row>
@@ -1867,20 +1867,20 @@ postgres 27093 0.0 0.0 30096 2752 ? Ss 11:34 0:00 postgres: ser
18671867
buffer.</entry>
18681868
</row>
18691869
<row>
1870-
<entry><literal>NotifyQueueLock</literal></entry>
1870+
<entry><literal>NotifyQueue</literal></entry>
18711871
<entry>Waiting to read or update <command>NOTIFY</command> messages.</entry>
18721872
</row>
18731873
<row>
1874-
<entry><literal>NotifySLRULock</literal></entry>
1874+
<entry><literal>NotifySLRU</literal></entry>
18751875
<entry>Waiting to access the <command>NOTIFY</command> message SLRU
18761876
cache.</entry>
18771877
</row>
18781878
<row>
1879-
<entry><literal>OidGenLock</literal></entry>
1879+
<entry><literal>OidGen</literal></entry>
18801880
<entry>Waiting to allocate a new OID.</entry>
18811881
</row>
18821882
<row>
1883-
<entry><literal>OldSnapshotTimeMapLock</literal></entry>
1883+
<entry><literal>OldSnapshotTimeMap</literal></entry>
18841884
<entry>Waiting to read or update old snapshot control information.</entry>
18851885
</row>
18861886
<row>
@@ -1922,24 +1922,24 @@ postgres 27093 0.0 0.0 30096 2752 ? Ss 11:34 0:00 postgres: ser
19221922
serializable transactions.</entry>
19231923
</row>
19241924
<row>
1925-
<entry><literal>ProcArrayLock</literal></entry>
1925+
<entry><literal>ProcArray</literal></entry>
19261926
<entry>Waiting to access the shared per-process data structures
19271927
(typically, to get a snapshot or report a session's transaction
19281928
ID).</entry>
19291929
</row>
19301930
<row>
1931-
<entry><literal>RelationMappingLock</literal></entry>
1931+
<entry><literal>RelationMapping</literal></entry>
19321932
<entry>Waiting to read or update
19331933
a <filename>pg_filenode.map</filename> file (used to track the
19341934
filenode assignments of certain system catalogs).</entry>
19351935
</row>
19361936
<row>
1937-
<entry><literal>RelCacheInitLock</literal></entry>
1937+
<entry><literal>RelCacheInit</literal></entry>
19381938
<entry>Waiting to read or update a <filename>pg_internal.init</filename>
19391939
relation cache initialization file.</entry>
19401940
</row>
19411941
<row>
1942-
<entry><literal>ReplicationOriginLock</literal></entry>
1942+
<entry><literal>ReplicationOrigin</literal></entry>
19431943
<entry>Waiting to create, drop or use a replication origin.</entry>
19441944
</row>
19451945
<row>
@@ -1948,11 +1948,11 @@ postgres 27093 0.0 0.0 30096 2752 ? Ss 11:34 0:00 postgres: ser
19481948
origin.</entry>
19491949
</row>
19501950
<row>
1951-
<entry><literal>ReplicationSlotAllocationLock</literal></entry>
1951+
<entry><literal>ReplicationSlotAllocation</literal></entry>
19521952
<entry>Waiting to allocate or free a replication slot.</entry>
19531953
</row>
19541954
<row>
1955-
<entry><literal>ReplicationSlotControlLock</literal></entry>
1955+
<entry><literal>ReplicationSlotControl</literal></entry>
19561956
<entry>Waiting to read or update replication slot state.</entry>
19571957
</row>
19581958
<row>
@@ -1965,22 +1965,22 @@ postgres 27093 0.0 0.0 30096 2752 ? Ss 11:34 0:00 postgres: ser
19651965
buffer.</entry>
19661966
</row>
19671967
<row>
1968-
<entry><literal>SerializableFinishedListLock</literal></entry>
1968+
<entry><literal>SerializableFinishedList</literal></entry>
19691969
<entry>Waiting to access the list of finished serializable
19701970
transactions.</entry>
19711971
</row>
19721972
<row>
1973-
<entry><literal>SerializablePredicateListLock</literal></entry>
1973+
<entry><literal>SerializablePredicateList</literal></entry>
19741974
<entry>Waiting to access the list of predicate locks held by
19751975
serializable transactions.</entry>
19761976
</row>
19771977
<row>
1978-
<entry><literal>SerializableXactHashLock</literal></entry>
1978+
<entry><literal>SerializableXactHash</literal></entry>
19791979
<entry>Waiting to read or update information about serializable
19801980
transactions.</entry>
19811981
</row>
19821982
<row>
1983-
<entry><literal>SerialSLRULock</literal></entry>
1983+
<entry><literal>SerialSLRU</literal></entry>
19841984
<entry>Waiting to access the serializable transaction conflict SLRU
19851985
cache.</entry>
19861986
</row>
@@ -1995,16 +1995,16 @@ postgres 27093 0.0 0.0 30096 2752 ? Ss 11:34 0:00 postgres: ser
19951995
query.</entry>
19961996
</row>
19971997
<row>
1998-
<entry><literal>ShmemIndexLock</literal></entry>
1998+
<entry><literal>ShmemIndex</literal></entry>
19991999
<entry>Waiting to find or allocate space in shared memory.</entry>
20002000
</row>
20012001
<row>
2002-
<entry><literal>SInvalReadLock</literal></entry>
2002+
<entry><literal>SInvalRead</literal></entry>
20032003
<entry>Waiting to retrieve messages from the shared catalog invalidation
20042004
queue.</entry>
20052005
</row>
20062006
<row>
2007-
<entry><literal>SInvalWriteLock</literal></entry>
2007+
<entry><literal>SInvalWrite</literal></entry>
20082008
<entry>Waiting to add a message to the shared catalog invalidation
20092009
queue.</entry>
20102010
</row>
@@ -2013,54 +2013,54 @@ postgres 27093 0.0 0.0 30096 2752 ? Ss 11:34 0:00 postgres: ser
20132013
<entry>Waiting for I/O on a sub-transaction SLRU buffer.</entry>
20142014
</row>
20152015
<row>
2016-
<entry><literal>SubtransSLRULock</literal></entry>
2016+
<entry><literal>SubtransSLRU</literal></entry>
20172017
<entry>Waiting to access the sub-transaction SLRU cache.</entry>
20182018
</row>
20192019
<row>
2020-
<entry><literal>SyncRepLock</literal></entry>
2020+
<entry><literal>SyncRep</literal></entry>
20212021
<entry>Waiting to read or update information about the state of
20222022
synchronous replication.</entry>
20232023
</row>
20242024
<row>
2025-
<entry><literal>SyncScanLock</literal></entry>
2025+
<entry><literal>SyncScan</literal></entry>
20262026
<entry>Waiting to select the starting location of a synchronized table
20272027
scan.</entry>
20282028
</row>
20292029
<row>
2030-
<entry><literal>TablespaceCreateLock</literal></entry>
2030+
<entry><literal>TablespaceCreate</literal></entry>
20312031
<entry>Waiting to create or drop a tablespace.</entry>
20322032
</row>
20332033
<row>
2034-
<entry><literal>TwoPhaseStateLock</literal></entry>
2034+
<entry><literal>TwoPhaseState</literal></entry>
20352035
<entry>Waiting to read or update the state of prepared transactions.</entry>
20362036
</row>
20372037
<row>
2038-
<entry><literal>WALBufMappingLock</literal></entry>
2038+
<entry><literal>WALBufMapping</literal></entry>
20392039
<entry>Waiting to replace a page in WAL buffers.</entry>
20402040
</row>
20412041
<row>
20422042
<entry><literal>WALInsert</literal></entry>
20432043
<entry>Waiting to insert WAL data into a memory buffer.</entry>
20442044
</row>
20452045
<row>
2046-
<entry><literal>WALWriteLock</literal></entry>
2046+
<entry><literal>WALWrite</literal></entry>
20472047
<entry>Waiting for WAL buffers to be written to disk.</entry>
20482048
</row>
20492049
<row>
20502050
<entry><literal>XactBuffer</literal></entry>
20512051
<entry>Waiting for I/O on a transaction status SLRU buffer.</entry>
20522052
</row>
20532053
<row>
2054-
<entry><literal>XactSLRULock</literal></entry>
2054+
<entry><literal>XactSLRU</literal></entry>
20552055
<entry>Waiting to access the transaction status SLRU cache.</entry>
20562056
</row>
20572057
<row>
2058-
<entry><literal>XactTruncationLock</literal></entry>
2058+
<entry><literal>XactTruncation</literal></entry>
20592059
<entry>Waiting to execute <function>pg_xact_status</function> or update
20602060
the oldest transaction ID available to it.</entry>
20612061
</row>
20622062
<row>
2063-
<entry><literal>XidGenLock</literal></entry>
2063+
<entry><literal>XidGen</literal></entry>
20642064
<entry>Waiting to allocate a new transaction ID.</entry>
20652065
</row>
20662066
</tbody>

‎src/backend/storage/lmgr/generate-lwlocknames.pl‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
print $h "/* there is deliberately not an #ifndef LWLOCKNAMES_H here */\n\n";
2424
print $c $autogen, "\n";
2525

26-
print $c "const char *const MainLWLockNames[] = {";
26+
print $c "const char *const IndividualLWLockNames[] = {";
2727

2828
while (<$lwlocknames>)
2929
{
@@ -38,6 +38,10 @@
3838

3939
(my $lockname, my $lockidx) = ($1, $2);
4040

41+
my $trimmedlockname = $lockname;
42+
$trimmedlockname =~ s/Lock$//;
43+
die "lock names must end with 'Lock'" if $trimmedlockname eq $lockname;
44+
4145
die "lwlocknames.txt not in order" if $lockidx < $lastlockidx;
4246
die "lwlocknames.txt has duplicates" if $lockidx == $lastlockidx;
4347

@@ -47,7 +51,7 @@
4751
printf $c "%s \"<unassigned:%d>\"", $continue, $lastlockidx;
4852
$continue = ",\n";
4953
}
50-
printf $c "%s \"%s\"", $continue, $lockname;
54+
printf $c "%s \"%s\"", $continue, $trimmedlockname;
5155
$lastlockidx = $lockidx;
5256
$continue = ",\n";
5357

‎src/backend/storage/lmgr/lwlock.c‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ extern slock_t *ShmemLock;
111111
* There are three sorts of LWLock "tranches":
112112
*
113113
* 1. The individually-named locks defined in lwlocknames.h each have their
114-
* own tranche. The names of these tranches appear in MainLWLockNames[]
114+
* own tranche. The names of these tranches appear in IndividualLWLockNames[]
115115
* in lwlocknames.c.
116116
*
117117
* 2. There are some predefined tranches for built-in groups of locks.
@@ -125,6 +125,7 @@ extern slock_t *ShmemLock;
125125
* All these names are user-visible as wait event names, so choose with care
126126
* ... and do not forget to update the documentation's list of wait events.
127127
*/
128+
extern const char *const IndividualLWLockNames[]; /* in lwlocknames.c */
128129

129130
static const char *const BuiltinTrancheNames[] = {
130131
/* LWTRANCHE_XACT_BUFFER: */
@@ -781,7 +782,7 @@ GetLWTrancheName(uint16 trancheId)
781782
{
782783
/* Individual LWLock? */
783784
if (trancheId < NUM_INDIVIDUAL_LWLOCKS)
784-
return MainLWLockNames[trancheId];
785+
return IndividualLWLockNames[trancheId];
785786

786787
/* Built-in tranche? */
787788
if (trancheId < LWTRANCHE_FIRST_USER_DEFINED)

‎src/include/storage/lwlock.h‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,6 @@ typedef union LWLockMinimallyPadded
8888
} LWLockMinimallyPadded;
8989

9090
extern PGDLLIMPORT LWLockPadded *MainLWLockArray;
91-
extern const char *const MainLWLockNames[];
9291

9392
/* struct for storing named tranche information */
9493
typedef struct NamedLWLockTranche

0 commit comments

Comments
 (0)