summaryrefslogtreecommitdiff
path: root/src/backend/storage/lmgr/generate-lwlocknames.pl
blob: cd3e43c448aed010990c1f34ecc0572fe283805c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
#!/usr/bin/perl
#
# Generate lwlocknames.h from lwlocklist.h
# Copyright (c) 2000-2025, PostgreSQL Global Development Group

use strict;
use warnings FATAL => 'all';
use Getopt::Long;

my $output_path = '.';

my $lastlockidx = -1;

GetOptions('outdir:s' => \$output_path);

open my $lwlocklist, '<', $ARGV[0] or die;
open my $wait_event_names, '<', $ARGV[1] or die;

# Include PID in suffix in case parallel make runs this multiple times.
my $htmp = "$output_path/lwlocknames.h.tmp$$";
open my $h, '>', $htmp or die "Could not open $htmp: $!";

my $autogen =
  "/* autogenerated from src/include/storage/lwlocklist.h, do not edit */\n";
print $h $autogen;
print $h "/* there is deliberately not an #ifndef LWLOCKNAMES_H here */\n\n";


#
# First, record the predefined LWLocks and built-in tranches listed in
# wait_event_names.txt.  We'll cross-check those with the ones in lwlocklist.h.
#
my @wait_event_tranches;
my @wait_event_lwlocks;
my $record_lwlocks = 0;
my $in_tranches = 0;

while (<$wait_event_names>)
{
	chomp;

	# Check for end marker.
	if (/^# END OF PREDEFINED LWLOCKS/)
	{
		$in_tranches = 1;
		next;
	}

	# Skip comments and empty lines.
	next if /^#/;
	next if /^\s*$/;

	# Start recording LWLocks when we find the WaitEventLWLock section.
	if (/^Section: ClassName - WaitEventLWLock$/)
	{
		$record_lwlocks = 1;
		next;
	}

	# Go to the next line if we are not yet recording LWLocks.
	next if not $record_lwlocks;

	# Stop recording if we reach another section.
	last if /^Section:/;

	# Record the LWLock.
	(my $waiteventname, my $waitevendocsentence) = split(/\t/, $_);

	if ($in_tranches)
	{
		push(@wait_event_tranches, $waiteventname);
	}
	else
	{
		push(@wait_event_lwlocks, $waiteventname);
	}
}

#
# While gathering the list of predefined LWLocks, cross-check the lists in
# lwlocklist.h with the wait events we just recorded.
#
my $in_comment = 0;
my $lwlock_count = 0;
my $tranche_count = 0;
while (<$lwlocklist>)
{
	chomp;

	# Skip single-line C comments and empty lines
	next if m{^\s*/\*.*\*/$};
	next if /^\s*$/;

	# skip multiline C comments
	if ($in_comment == 1)
	{
		$in_comment = 0 if m{\*/};
		next;
	}
	elsif (m{^\s*/\*})
	{
		$in_comment = 1;
		next;
	}

	#
	# Gather list of predefined LWLocks and cross-check with the wait events.
	#
	if (/^PG_LWLOCK\((\d+),\s+(\w+)\)$/)
	{
		my ($lockidx, $lockname) = ($1, $2);

		die "lwlocklist.h not in order" if $lockidx < $lastlockidx;
		die "lwlocklist.h has duplicates" if $lockidx == $lastlockidx;

		die "$lockname defined in lwlocklist.h but missing from "
		  . "wait_event_names.txt"
		  if $lwlock_count >= scalar @wait_event_lwlocks;
		die "lists of predefined LWLocks do not match (first mismatch at "
		  . "$wait_event_lwlocks[$lwlock_count] in wait_event_names.txt and "
		  . "$lockname in lwlocklist.h)"
		  if $wait_event_lwlocks[$lwlock_count] ne $lockname;

		$lwlock_count++;

		while ($lastlockidx < $lockidx - 1)
		{
			++$lastlockidx;
		}
		$lastlockidx = $lockidx;

		# Add a "Lock" suffix to each lock name, as the C code depends on that.
		printf $h "#define %-32s (&MainLWLockArray[$lockidx].lock)\n",
		  $lockname . "Lock";

		next;
	}

	#
	# Cross-check the built-in LWLock tranches with the wait events.
	#
	if (/^PG_LWLOCKTRANCHE\((\w+),\s+(\w+)\)$/)
	{
		my ($tranche_id, $tranche_name) = ($1, $2);

		die "$tranche_name defined in lwlocklist.h but missing from "
		  . "wait_event_names.txt"
		  if $tranche_count >= scalar @wait_event_tranches;
		die
		  "lists of built-in LWLock tranches do not match (first mismatch at "
		  . "$wait_event_tranches[$tranche_count] in wait_event_names.txt and "
		  . "$tranche_name in lwlocklist.h)"
		  if $wait_event_tranches[$tranche_count] ne $tranche_name;

		$tranche_count++;

		next;
	}

	die "unable to parse lwlocklist.h line \"$_\"";
}

die
  "$wait_event_lwlocks[$lwlock_count] defined in wait_event_names.txt but "
  . " missing from lwlocklist.h"
  if $lwlock_count < scalar @wait_event_lwlocks;

die
  "$wait_event_tranches[$tranche_count] defined in wait_event_names.txt but "
  . "missing from lwlocklist.h"
  if $tranche_count < scalar @wait_event_tranches;

print $h "\n";
printf $h "#define NUM_INDIVIDUAL_LWLOCKS		%s\n", $lastlockidx + 1;

close $h;

rename($htmp, "$output_path/lwlocknames.h")
  || die "rename: $htmp to $output_path/lwlocknames.h: $!";

close $lwlocklist;