Feedback-ID: i0fe9450f:Fastmail
Date: Tue, 3 Sep 2024 10:52:20 +0900
From: Michael Paquier <michael@paquier.xyz>
To: Postgres hackers <pgsql-hackers@lists.postgresql.org>
Subject: Add callback in pgstats for backend initialization 
Message-ID: <ZtZr1K4PLdeWclXY@paquier.xyz>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
	protocol="application/pgp-signature"; boundary="yvQLCtnfU9tfyJhS"
Content-Disposition: inline
Archived-At: <https://www.postgresql.org/message-id/ZtZr1K4PLdeWclXY%40paquier.xyz>
Precedence: bulk


--yvQLCtnfU9tfyJhS
Content-Type: multipart/mixed; boundary="91RdqAfIfD8eH+RB"
Content-Disposition: inline


--91RdqAfIfD8eH+RB
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

Hi all,

Currently, the backend-level initialization of pgstats happens in
pgstat_initialize(), where we are using a shortcut for the WAL stats,
with pgstat_init_wal().

I'd like to propose to add a callback for that, so as in-core or
custom pgstats kinds can assign custom actions when initializing a
backend.  The use-case I had for this one are pretty close to what we
do for WAL, where we would rely on a difference of state depending on
what may have existed before reaching the initialization path.  So
this can offer more precision.  Another case, perhaps less
interesting, is to be able to initialize some static backend state.

I wanted to get that sent for the current commit fest, but did not get
back in time to it.  Anyway, here it is.  This gives the simple patch
attached.

Thanks,
--
Michael

--91RdqAfIfD8eH+RB
Content-Type: text/x-diff; charset=us-ascii
Content-Disposition: attachment;
	filename="0001-Add-callback-for-backend-initialization-in-pgstats.patch"
Content-Transfer-Encoding: quoted-printable

=46rom 1e41a5155fb689f1d4ae8a5cfb244b824e913bae Mon Sep 17 00:00:00 2001
=46rom: Michael Paquier <michael@paquier.xyz>
Date: Tue, 3 Sep 2024 10:38:15 +0900
Subject: [PATCH] Add callback for backend initialization in pgstats

This is currently used by the WAL stats, and is now made available for
others as well.
---
 src/include/utils/pgstat_internal.h     |  7 +++++++
 src/backend/utils/activity/pgstat.c     | 14 ++++++++++++--
 src/backend/utils/activity/pgstat_wal.c |  2 +-
 3 files changed, 20 insertions(+), 3 deletions(-)

diff --git a/src/include/utils/pgstat_internal.h b/src/include/utils/pgstat=
_internal.h
index fb132e439d..53f7d5c98c 100644
--- a/src/include/utils/pgstat_internal.h
+++ b/src/include/utils/pgstat_internal.h
@@ -229,6 +229,12 @@ typedef struct PgStat_KindInfo
 	 */
 	uint32		pending_size;
=20
+	/*
+	 * Perform custom actions when initializing a backend (standalone or under
+	 * postmaster). Optional.
+	 */
+	void		(*init_backend_cb) (void);
+
 	/*
 	 * For variable-numbered stats: flush pending stats. Required if pending
 	 * data is used.
@@ -676,6 +682,7 @@ extern bool pgstat_flush_wal(bool nowait);
 extern void pgstat_init_wal(void);
 extern bool pgstat_have_pending_wal(void);
=20
+extern void pgstat_wal_init_backend_cb(void);
 extern void pgstat_wal_init_shmem_cb(void *stats);
 extern void pgstat_wal_reset_all_cb(TimestampTz ts);
 extern void pgstat_wal_snapshot_cb(void);
diff --git a/src/backend/utils/activity/pgstat.c b/src/backend/utils/activi=
ty/pgstat.c
index b2ca3f39b7..3b6983ff5d 100644
--- a/src/backend/utils/activity/pgstat.c
+++ b/src/backend/utils/activity/pgstat.c
@@ -441,6 +441,7 @@ static const PgStat_KindInfo pgstat_kind_builtin_infos[=
PGSTAT_KIND_BUILTIN_SIZE]
 		.shared_data_off =3D offsetof(PgStatShared_Wal, stats),
 		.shared_data_len =3D sizeof(((PgStatShared_Wal *) 0)->stats),
=20
+		.init_backend_cb =3D pgstat_wal_init_backend_cb,
 		.init_shmem_cb =3D pgstat_wal_init_shmem_cb,
 		.reset_all_cb =3D pgstat_wal_reset_all_cb,
 		.snapshot_cb =3D pgstat_wal_snapshot_cb,
@@ -604,10 +605,19 @@ pgstat_initialize(void)
=20
 	pgstat_attach_shmem();
=20
-	pgstat_init_wal();
-
 	pgstat_init_snapshot_fixed();
=20
+	/* Backend initialization callbacks */
+	for (PgStat_Kind kind =3D PGSTAT_KIND_MIN; kind <=3D PGSTAT_KIND_MAX; kin=
d++)
+	{
+		const PgStat_KindInfo *kind_info =3D pgstat_get_kind_info(kind);
+
+		if (kind_info =3D=3D NULL || kind_info->init_backend_cb =3D=3D NULL)
+			continue;
+
+		kind_info->init_backend_cb();
+	}
+
 	/* Set up a process-exit hook to clean up */
 	before_shmem_exit(pgstat_shutdown_hook, 0);
=20
diff --git a/src/backend/utils/activity/pgstat_wal.c b/src/backend/utils/ac=
tivity/pgstat_wal.c
index e2a3f6b865..8c19c3f2fd 100644
--- a/src/backend/utils/activity/pgstat_wal.c
+++ b/src/backend/utils/activity/pgstat_wal.c
@@ -138,7 +138,7 @@ pgstat_flush_wal(bool nowait)
 }
=20
 void
-pgstat_init_wal(void)
+pgstat_wal_init_backend_cb(void)
 {
 	/*
 	 * Initialize prevWalUsage with pgWalUsage so that pgstat_flush_wal() can
--=20
2.45.2


--91RdqAfIfD8eH+RB--

--yvQLCtnfU9tfyJhS
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iQIzBAABCgAdFiEEG72nH6vTowiyblFKnvQgOdbyQH0FAmbWa9QACgkQnvQgOdby
QH1D0g/+IpKyKMfVHW+PKQIQLPkcFH9sPpZQazuAr/OC9bH3wTVdvmJJcPaJ1HAX
n4t9ZM5D6Ove6RY8urdEjBP2CfvEqhA0ogJH9EWbA1V4MPjZijZ30I5mqCyvU65+
g/zwjo1Sfr+w54ntj4P5PtLY8TZ+EshrRIZkh0MGmfRfy4oCumkHbMW9fPv1xrFP
slVC81eNezZ2X1BCg8ilvq/XPeKJtKotsfMAeqeNIljDNbI67gjk1M1cCVsABxHg
X9t99pr4dN1jyILUtR9Jqg94JWuhuVEY2YtkL/9vloXUFccMnMfn7uZ94NgnvXyC
NXZLegzM1nL1mRmd7li2j+NNvILPo5k/fWc6hR/Y4EXLRujqiHIgw/42tDhzEXc3
jwmkkbVK0mHJQe8SMrQp0obum8zWTxsau9QRT2Ug8OMu0Bc7JgjXExSm5KNOWDPv
Q+qhEt9w3GjAz6F6bi2fms6anmKwZAdzRCSNrZNHHL3rYrJlqECnHVQVOUG6P7kj
7oxpL7bAT0wnkEflNVlLl1Dw3a8B+KpnJBOAIoSaJMwPPngG5g3gAAy+1oJk0LHv
PVG0zOnAI3nCnhWZUUcg8iUHdN3ruckFh7yKFa6cuwcysty9Mdlh+drw7jDnk2bF
XDXLqNi6bdB1DELheXCcw6yHDmdD1IJbG0an5vcmxf2Rz8dJOZ0=
=s9R9
-----END PGP SIGNATURE-----

--yvQLCtnfU9tfyJhS--