Switch PgStat_Kind from an enum to a uint32 type

michaelpq · michaelpq · commit 3188a4582a8c · 2024-08-02T04:49:34.000+09:00
A follow-up patch is planned to make cumulative statistics pluggable, and using a type is useful in the internal routines used by pgstats as PgStat_Kind may have a value that was not originally in the enum removed here, once made pluggable. While on it, this commit switches pgstat_is_kind_valid() to use PgStat_Kind rather than an int, to be more consistent with its existing callers. Some loops based on the stats kind IDs are switched to use PgStat_Kind rather than int, for consistency with the new time. Author: Michael Paquier Reviewed-by: Dmitry Dolgov, Bertrand Drouvot Discussion: https://postgr.es/m/Zmqm9j5EO0I4W8dx@paquier.xyz
diff --git a/src/backend/utils/activity/pgstat.c b/src/backend/utils/activity/pgstat.c
@@ -183,7 +183,7 @@ static void pgstat_prep_snapshot(void);
 static void pgstat_build_snapshot(void);
 static void pgstat_build_snapshot_fixed(PgStat_Kind kind);
 
-static inline bool pgstat_is_kind_valid(int ikind);
+static inline bool pgstat_is_kind_valid(PgStat_Kind kind);
 
 
 /* ----------
@@ -1089,7 +1089,7 @@ pgstat_build_snapshot(void)
 	/*
 	 * Build snapshot of all fixed-numbered stats.
 	 */
-	for (int kind = PGSTAT_KIND_FIRST_VALID; kind <= PGSTAT_KIND_LAST; kind++)
+	for (PgStat_Kind kind = PGSTAT_KIND_FIRST_VALID; kind <= PGSTAT_KIND_LAST; kind++)
 	{
 		const PgStat_KindInfo *kind_info = pgstat_get_kind_info(kind);
 
@@ -1286,7 +1286,7 @@ pgstat_flush_pending_entries(bool nowait)
 PgStat_Kind
 pgstat_get_kind_from_str(char *kind_str)
 {
-	for (int kind = PGSTAT_KIND_FIRST_VALID; kind <= PGSTAT_KIND_LAST; kind++)
+	for (PgStat_Kind kind = PGSTAT_KIND_FIRST_VALID; kind <= PGSTAT_KIND_LAST; kind++)
 	{
 		if (pg_strcasecmp(kind_str, pgstat_kind_infos[kind].name) == 0)
 			return kind;
@@ -1299,9 +1299,9 @@ pgstat_get_kind_from_str(char *kind_str)
 }
 
 static inline bool
-pgstat_is_kind_valid(int ikind)
+pgstat_is_kind_valid(PgStat_Kind kind)
 {
-	return ikind >= PGSTAT_KIND_FIRST_VALID && ikind <= PGSTAT_KIND_LAST;
+	return kind >= PGSTAT_KIND_FIRST_VALID && kind <= PGSTAT_KIND_LAST;
 }
 
 const PgStat_KindInfo *
@@ -1393,7 +1393,7 @@ pgstat_write_statsfile(XLogRecPtr redo)
 	write_chunk_s(fpout, &redo);
 
 	/* Write various stats structs for fixed number of objects */
-	for (int kind = PGSTAT_KIND_FIRST_VALID; kind <= PGSTAT_KIND_LAST; kind++)
+	for (PgStat_Kind kind = PGSTAT_KIND_FIRST_VALID; kind <= PGSTAT_KIND_LAST; kind++)
 	{
 		char	   *ptr;
 		const PgStat_KindInfo *info = pgstat_get_kind_info(kind);
@@ -1777,7 +1777,7 @@ pgstat_reset_after_failure(void)
 	TimestampTz ts = GetCurrentTimestamp();
 
 	/* reset fixed-numbered stats */
-	for (int kind = PGSTAT_KIND_FIRST_VALID; kind <= PGSTAT_KIND_LAST; kind++)
+	for (PgStat_Kind kind = PGSTAT_KIND_FIRST_VALID; kind <= PGSTAT_KIND_LAST; kind++)
 	{
 		const PgStat_KindInfo *kind_info = pgstat_get_kind_info(kind);
 
diff --git a/src/backend/utils/activity/pgstat_shmem.c b/src/backend/utils/activity/pgstat_shmem.c
@@ -197,7 +197,7 @@ StatsShmemInit(void)
 		pg_atomic_init_u64(&ctl->gc_request_count, 1);
 
 		/* initialize fixed-numbered stats */
-		for (int kind = PGSTAT_KIND_FIRST_VALID; kind <= PGSTAT_KIND_LAST; kind++)
+		for (PgStat_Kind kind = PGSTAT_KIND_FIRST_VALID; kind <= PGSTAT_KIND_LAST; kind++)
 		{
 			const PgStat_KindInfo *kind_info = pgstat_get_kind_info(kind);
 			char	   *ptr;
diff --git a/src/include/pgstat.h b/src/include/pgstat.h
@@ -33,26 +33,25 @@
 #define PG_STAT_TMP_DIR		"pg_stat_tmp"
 
 /* The types of statistics entries */
-typedef enum PgStat_Kind
-{
-	/* use 0 for INVALID, to catch zero-initialized data */
-	PGSTAT_KIND_INVALID = 0,
-
-	/* stats for variable-numbered objects */
-	PGSTAT_KIND_DATABASE,		/* database-wide statistics */
-	PGSTAT_KIND_RELATION,		/* per-table statistics */
-	PGSTAT_KIND_FUNCTION,		/* per-function statistics */
-	PGSTAT_KIND_REPLSLOT,		/* per-slot statistics */
-	PGSTAT_KIND_SUBSCRIPTION,	/* per-subscription statistics */
-
-	/* stats for fixed-numbered objects */
-	PGSTAT_KIND_ARCHIVER,
-	PGSTAT_KIND_BGWRITER,
-	PGSTAT_KIND_CHECKPOINTER,
-	PGSTAT_KIND_IO,
-	PGSTAT_KIND_SLRU,
-	PGSTAT_KIND_WAL,
-} PgStat_Kind;
+#define PgStat_Kind uint32
+
+/* use 0 for INVALID, to catch zero-initialized data */
+#define PGSTAT_KIND_INVALID 0
+
+/* stats for variable-numbered objects */
+#define PGSTAT_KIND_DATABASE	1	/* database-wide statistics */
+#define PGSTAT_KIND_RELATION	2	/* per-table statistics */
+#define PGSTAT_KIND_FUNCTION	3	/* per-function statistics */
+#define PGSTAT_KIND_REPLSLOT	4	/* per-slot statistics */
+#define PGSTAT_KIND_SUBSCRIPTION	5	/* per-subscription statistics */
+
+/* stats for fixed-numbered objects */
+#define PGSTAT_KIND_ARCHIVER	6
+#define PGSTAT_KIND_BGWRITER	7
+#define PGSTAT_KIND_CHECKPOINTER	8
+#define PGSTAT_KIND_IO	9
+#define PGSTAT_KIND_SLRU	10
+#define PGSTAT_KIND_WAL	11
 
 #define PGSTAT_KIND_FIRST_VALID PGSTAT_KIND_DATABASE
 #define PGSTAT_KIND_LAST PGSTAT_KIND_WAL

Original file line number	Diff line number	Diff line change
`@@ -183,7 +183,7 @@ static void pgstat_prep_snapshot(void);`
`183`	`183`	`static void pgstat_build_snapshot(void);`
`184`	`184`	`static void pgstat_build_snapshot_fixed(PgStat_Kind kind);`
`185`	`185`
`186`		`-static inline bool pgstat_is_kind_valid(int ikind);`
	`186`	`+static inline bool pgstat_is_kind_valid(PgStat_Kind kind);`
`187`	`187`
`188`	`188`
`189`	`189`	`/* ----------`
`@@ -1089,7 +1089,7 @@ pgstat_build_snapshot(void)`
`1089`	`1089`	`/*`
`1090`	`1090`	`* Build snapshot of all fixed-numbered stats.`
`1091`	`1091`	`*/`
`1092`		`- for (int kind = PGSTAT_KIND_FIRST_VALID; kind <= PGSTAT_KIND_LAST; kind++)`
	`1092`	`+ for (PgStat_Kind kind = PGSTAT_KIND_FIRST_VALID; kind <= PGSTAT_KIND_LAST; kind++)`
`1093`	`1093`	`{`
`1094`	`1094`	`const PgStat_KindInfo *kind_info = pgstat_get_kind_info(kind);`
`1095`	`1095`
`@@ -1286,7 +1286,7 @@ pgstat_flush_pending_entries(bool nowait)`
`1286`	`1286`	`PgStat_Kind`
`1287`	`1287`	`pgstat_get_kind_from_str(char *kind_str)`
`1288`	`1288`	`{`
`1289`		`- for (int kind = PGSTAT_KIND_FIRST_VALID; kind <= PGSTAT_KIND_LAST; kind++)`
	`1289`	`+ for (PgStat_Kind kind = PGSTAT_KIND_FIRST_VALID; kind <= PGSTAT_KIND_LAST; kind++)`
`1290`	`1290`	`{`
`1291`	`1291`	`if (pg_strcasecmp(kind_str, pgstat_kind_infos[kind].name) == 0)`
`1292`	`1292`	`return kind;`
`@@ -1299,9 +1299,9 @@ pgstat_get_kind_from_str(char *kind_str)`
`1299`	`1299`	`}`
`1300`	`1300`
`1301`	`1301`	`static inline bool`
`1302`		`-pgstat_is_kind_valid(int ikind)`
	`1302`	`+pgstat_is_kind_valid(PgStat_Kind kind)`
`1303`	`1303`	`{`
`1304`		`- return ikind >= PGSTAT_KIND_FIRST_VALID && ikind <= PGSTAT_KIND_LAST;`
	`1304`	`+ return kind >= PGSTAT_KIND_FIRST_VALID && kind <= PGSTAT_KIND_LAST;`
`1305`	`1305`	`}`
`1306`	`1306`
`1307`	`1307`	`const PgStat_KindInfo *`
`@@ -1393,7 +1393,7 @@ pgstat_write_statsfile(XLogRecPtr redo)`
`1393`	`1393`	`write_chunk_s(fpout, &redo);`
`1394`	`1394`
`1395`	`1395`	`/* Write various stats structs for fixed number of objects */`
`1396`		`- for (int kind = PGSTAT_KIND_FIRST_VALID; kind <= PGSTAT_KIND_LAST; kind++)`
	`1396`	`+ for (PgStat_Kind kind = PGSTAT_KIND_FIRST_VALID; kind <= PGSTAT_KIND_LAST; kind++)`
`1397`	`1397`	`{`
`1398`	`1398`	`char *ptr;`
`1399`	`1399`	`const PgStat_KindInfo *info = pgstat_get_kind_info(kind);`
`@@ -1777,7 +1777,7 @@ pgstat_reset_after_failure(void)`
`1777`	`1777`	`TimestampTz ts = GetCurrentTimestamp();`
`1778`	`1778`
`1779`	`1779`	`/* reset fixed-numbered stats */`
`1780`		`- for (int kind = PGSTAT_KIND_FIRST_VALID; kind <= PGSTAT_KIND_LAST; kind++)`
	`1780`	`+ for (PgStat_Kind kind = PGSTAT_KIND_FIRST_VALID; kind <= PGSTAT_KIND_LAST; kind++)`
`1781`	`1781`	`{`
`1782`	`1782`	`const PgStat_KindInfo *kind_info = pgstat_get_kind_info(kind);`
`1783`	`1783`
Original file line number	Diff line number	Diff line change
`@@ -197,7 +197,7 @@ StatsShmemInit(void)`
`197`	`197`	`pg_atomic_init_u64(&ctl->gc_request_count, 1);`
`198`	`198`
`199`	`199`	`/* initialize fixed-numbered stats */`
`200`		`- for (int kind = PGSTAT_KIND_FIRST_VALID; kind <= PGSTAT_KIND_LAST; kind++)`
	`200`	`+ for (PgStat_Kind kind = PGSTAT_KIND_FIRST_VALID; kind <= PGSTAT_KIND_LAST; kind++)`
`201`	`201`	`{`
`202`	`202`	`const PgStat_KindInfo *kind_info = pgstat_get_kind_info(kind);`
`203`	`203`	`char *ptr;`