public inbox for [email protected]
help / color / mirror / Atom feedFrom: Michael Paquier <[email protected]>
To: [email protected]
Subject: pgsql: Generate automatically code and documentation related to wait ev
Date: Wed, 05 Jul 2023 01:55:34 +0000
Message-ID: <[email protected]> (raw)
Generate automatically code and documentation related to wait events
The documentation and the code is generated automatically from a new
file called wait_event_names.txt, formatted in sections dedicated to
each wait event class (Timeout, Lock, IO, etc.) with three tab-separated
fields:
- C symbol in enums
- Format in the system views
- Description in the docs
Using this approach has several advantages, as we have proved to be
rather bad in maintaining this area of the tree across the years:
- The order of each item in the documentation and the code, which should
be alphabetical, has become incorrect multiple times, and the script
generating the code and documentation has a few rules to enforce that,
making the maintenance a no-brainer.
- Some wait events were added to the code, but not documented, so this
cannot be missed now.
- The order of the tables for each wait event class is enforced in the
documentation (the input .txt file does so as well for clarity, though
this is not mandatory).
- Less code, shaving 1.2k lines from the tree, with 1/3 of the savings
coming from the code, the rest from the documentation.
The wait event types "Lock" and "LWLock" still have their own code path
for their code, hence only the documentation is created for them. These
classes are listed with a special marker called WAIT_EVENT_DOCONLY in
the input file.
Adding a new wait event now requires only an update of
wait_event_names.txt, with "Lock" and "LWLock" treated as exceptions.
This commit has been tested with configure/Makefile, the CI and VPATH
build. clean, distclean and maintainer-clean were working fine.
Author: Bertrand Drouvot, Michael Paquier
Discussion: https://postgr.es/m/[email protected]
Branch
------
master
Details
-------
https://git.postgresql.org/pg/commitdiff/fa88928470b538c0ec0289e4d69ee12356c5a8ce
Modified Files
--------------
doc/src/sgml/.gitignore | 1 +
doc/src/sgml/Makefile | 4 +-
doc/src/sgml/filelist.sgml | 1 +
doc/src/sgml/meson.build | 12 +
doc/src/sgml/monitoring.sgml | 1271 +-------------------
src/backend/Makefile | 13 +-
src/backend/storage/lmgr/lwlocknames.txt | 4 +-
src/backend/utils/activity/.gitignore | 2 +
src/backend/utils/activity/Makefile | 12 +
.../utils/activity/generate-wait_event_types.pl | 263 ++++
src/backend/utils/activity/meson.build | 14 +
src/backend/utils/activity/wait_event.c | 611 +---------
src/backend/utils/activity/wait_event_names.txt | 371 ++++++
src/backend/utils/adt/lockfuncs.c | 3 +-
src/common/meson.build | 7 +-
src/include/Makefile | 2 +-
src/include/utils/.gitignore | 1 +
src/include/utils/meson.build | 19 +
src/include/utils/wait_event.h | 232 +---
src/test/ssl/t/002_scram.pl | 3 +-
src/tools/msvc/Solution.pm | 19 +
src/tools/msvc/clean.bat | 3 +
22 files changed, 757 insertions(+), 2111 deletions(-)
view thread (2+ messages)
reply
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: [email protected]
Cc: [email protected], [email protected]
Subject: Re: pgsql: Generate automatically code and documentation related to wait ev
In-Reply-To: <[email protected]>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox