Adjust for PostgreSQL 17

This commit updates several components to align with PostgreSQL 17,
including:

- Initialization steps for the JSON parser
- The list of lexical tokens assumed to be constants
- Handling of local_blk_read_time and local_blk_write_time
- Adjustments for the changes in pg_stat_statements_reset()

Author: horiguti

Makefile

@@ -1,7 +1,7 @@
 # pg_stat_plan/Makefile
 
 MODULES = pg_store_plans
-STOREPLANSVER = 1.8
+STOREPLANSVER = 1.9
 
 MODULE_big = pg_store_plans
 OBJS = pg_store_plans.o pgsp_json.o pgsp_json_text.o pgsp_explain.o
@@ -10,7 +10,7 @@ EXTENSION = pg_store_plans
 
 PG_VERSION := $(shell pg_config --version | sed "s/^PostgreSQL //" | sed "s/\.[0-9]*$$//")
 
-DATA = pg_store_plans--1.8.sql
+DATA = pg_store_plans--1.9.sql
 
 REGRESS = convert store
 REGRESS_OPTS = --temp-config=regress.conf
@@ -25,8 +25,8 @@ include $(top_builddir)/src/Makefile.global
 include $(top_srcdir)/contrib/contrib-global.mk
 endif
 
-STARBALL16 = pg_store_plans16-$(STOREPLANSVER).tar.gz
-STARBALLS = $(STARBALL16)
+STARBALL17 = pg_store_plans17-$(STOREPLANSVER).tar.gz
+STARBALLS = $(STARBALL17)
 
 TARSOURCES = Makefile *.c  *.h \
 	pg_store_plans--*.sql \
@@ -40,7 +40,7 @@ endif
 ## These entries need running server
 DBNAME = postgres
 
-rpms: rpm16
+rpms: rpm17
 
 $(STARBALLS): $(TARSOURCES)
 	if [ -h $(subst .tar.gz,,$@) ]; then rm $(subst .tar.gz,,$@); fi
@@ -52,8 +52,8 @@ $(STARBALLS): $(TARSOURCES)
 	tar -chzf $@ $(addprefix $(subst .tar.gz,,$@)/, $^)
 	rm $(subst .tar.gz,,$@)
 
-rpm16: $(STARBALL16)
-	MAKE_ROOT=`pwd` rpmbuild -bb SPECS/pg_store_plans16.spec
+rpm17: $(STARBALL17)
+	MAKE_ROOT=`pwd` rpmbuild -bb SPECS/pg_store_plans17.spec
 
 testfiles: convert.out convert.sql
 

SPECS/pg_store_plans16.spec renamed to SPECS/pg_store_plans17.spec

@@ -1,7 +1,7 @@
 # SPEC file for pg_store_plans
 # Copyright(c) 2024, NIPPON TELEGRAPH AND TELEPHONE CORPORATION
 
-%define _pgdir   /usr/pgsql-16
+%define _pgdir   /usr/pgsql-17
 %define _bindir  %{_pgdir}/bin
 %define _libdir  %{_pgdir}/lib
 %define _datadir %{_pgdir}/share
@@ -14,9 +14,9 @@
 %endif
 
 ## Set general information for pg_store_plans.
-Summary:    Record executed plans on PostgreSQL 16
-Name:       pg_store_plans16
-Version:    1.8
+Summary:    Record executed plans on PostgreSQL 17
+Name:       pg_store_plans17
+Version:    1.9
 Release:    1%{?dist}
 License:    BSD
 Group:      Applications/Databases
@@ -26,28 +26,28 @@ BuildRoot:  %{_tmppath}/%{name}-%{version}-%{release}-%(%{__id_u} -n)
 Vendor:     NIPPON TELEGRAPH AND TELEPHONE CORPORATION
 
 ## We use postgresql-devel package
-BuildRequires:  postgresql16-devel
-Requires:  postgresql16-libs
+BuildRequires:  postgresql17-devel
+Requires:  postgresql17-libs
 
 ## Description for "pg_store_plans"
 %description
 
 pg_store_plans provides capability to record statistics for every plan
 executed on PostgreSQL.
 
-Note that this package is available for only PostgreSQL 16.
+Note that this package is available for only PostgreSQL 17.
 
 %package llvmjit
-Requires: postgresql16-server, postgresql16-llvmjit
-Requires: pg_store_plans16 = 1.8
-Summary:  Just-in-time compilation support for pg_store_plans16
+Requires: postgresql17-server, postgresql17-llvmjit
+Requires: pg_store_plans17 = 1.9
+Summary:  Just-in-time compilation support for pg_store_plans17
 
 %description llvmjit
-Just-in-time compilation support for pg_store_plans16
+Just-in-time compilation support for pg_store_plans17
 
 ## pre work for build pg_store_plans
 %prep
-PATH=/usr/pgsql-16/bin:$PATH
+PATH=/usr/pgsql-17/bin:$PATH
 if [ "${MAKE_ROOT}" != "" ]; then
   pushd ${MAKE_ROOT}
   make clean %{name}-%{version}.tar.gz
@@ -58,14 +58,14 @@ if [ ! -d %{_rpmdir} ]; then mkdir -p %{_rpmdir}; fi
 
 ## Set variables for build environment
 %build
-PATH=/usr/pgsql-16/bin:$PATH
+PATH=/usr/pgsql-17/bin:$PATH
 pg_config
 make USE_PGXS=1 %{?_smp_mflags}
 
 ## Set variables for install
 %install
 rm -rf %{buildroot}
-PATH=/usr/pgsql-16/bin:$PATH
+PATH=/usr/pgsql-17/bin:$PATH
 make install DESTDIR=%{buildroot}
 
 %clean
@@ -75,7 +75,7 @@ rm -rf %{buildroot}
 %defattr(0755,root,root)
 %{_libdir}/pg_store_plans.so
 %defattr(0644,root,root)
-%{_datadir}/extension/pg_store_plans--1.8.sql
+%{_datadir}/extension/pg_store_plans--1.9.sql
 %{_datadir}/extension/pg_store_plans.control
 
 %files llvmjit
@@ -85,6 +85,8 @@ rm -rf %{buildroot}
 
 # History of pg_store_plans.
 %changelog
+* Mon Jan 20 2025 Kyotaro Horiguchi
+- Version 1.9. Support PostgreSQL 17.
 * Fri Feb 02 2024 Kyotaro Horiguchi
 - Version 1.8. Support PostgreSQL 16.
 * Wed Dec 14 2022 Kyotaro Horiguchi

expected/store.out

@@ -1,10 +1,9 @@
 SET client_min_messages = 'error';
 CREATE EXTENSION IF NOT EXISTS pg_store_plans;
 CREATE EXTENSION IF NOT EXISTS pg_stat_statements;
-SELECT pg_stat_statements_reset();
- pg_stat_statements_reset 
---------------------------
- 
+-- ignore the timestamp returned by pg_stat_statement_reset()
+SELECT FROM (SELECT pg_stat_statements_reset());
+--
 (1 row)
 
 SELECT pg_store_plans_reset();

pg_store_plans--1.8.sql renamed to pg_store_plans--1.9.sql

@@ -1,4 +1,4 @@
-/* pg_store_plans/pg_store_plans--1.8.sql */
+/* pg_store_plans/pg_store_plans--1.9.sql */
 
 -- complain if script is sourced in psql, rather than via CREATE EXTENSION
 \echo Use "CREATE EXTENSION pg_store_plans" to load this file. \quit
@@ -80,15 +80,17 @@ CREATE FUNCTION pg_store_plans(
     OUT local_blks_written int8,
     OUT temp_blks_read int8,
     OUT temp_blks_written int8,
-    OUT blk_read_time float8,
-    OUT blk_write_time float8,
+    OUT shared_blk_read_time float8,
+    OUT shared_blk_write_time float8,
+    OUT local_blk_read_time float8,
+    OUT local_blk_write_time float8,
     OUT temp_blk_read_time float8,
     OUT temp_blk_write_time float8,
     OUT first_call timestamptz,
     OUT last_call timestamptz
 )
 RETURNS SETOF record
-AS 'MODULE_PATHNAME', 'pg_store_plans_1_7'
+AS 'MODULE_PATHNAME', 'pg_store_plans_1_9'
 LANGUAGE C
 VOLATILE PARALLEL SAFE;
 

pg_store_plans.c

@@ -101,7 +101,9 @@ typedef enum pgspVersion
 {
 	PGSP_V1_5 = 0,
 	PGSP_V1_6,
-	PGSP_V1_7
+	PGSP_V1_7,
+	/* PGSP_V1_7 interface is used for v1.8 */
+	PGSP_V1_9
 } pgspVersion;
 
 /*
@@ -142,8 +144,19 @@ typedef struct Counters
 	int64		local_blks_written;	/* # of local disk blocks written */
 	int64		temp_blks_read; 	/* # of temp blocks read */
 	int64		temp_blks_written;	/* # of temp blocks written */
+#if PG_VERSION_NUM >= 170000
+	double		shared_blk_read_time;	/* time spent reading shared bloks,
+										   in msec */
+	double		shared_blk_write_time; 	/* time spent writing shared blocks,
+										   in msec */
+	double		local_blk_read_time;	/* time spent reading local blocks,
+										   in msec */
+	double		local_blk_write_time; 	/* time spent writing local blocks,
+										   in msec */
+#else
 	double		blk_read_time;		/* time spent reading, in msec */
 	double		blk_write_time; 	/* time spent writing, in msec */
+#endif
 	double		temp_blk_read_time;	/* time spent reading temp blocks,
 									   in msec */
 	double		temp_blk_write_time;/* time spent writing temp blocks,
@@ -321,6 +334,7 @@ PG_FUNCTION_INFO_V1(pg_store_plans_hash_query);
 PG_FUNCTION_INFO_V1(pg_store_plans);
 PG_FUNCTION_INFO_V1(pg_store_plans_1_6);
 PG_FUNCTION_INFO_V1(pg_store_plans_1_7);
+PG_FUNCTION_INFO_V1(pg_store_plans_1_9);
 PG_FUNCTION_INFO_V1(pg_store_plans_shorten);
 PG_FUNCTION_INFO_V1(pg_store_plans_normalize);
 PG_FUNCTION_INFO_V1(pg_store_plans_jsonplan);
@@ -1356,9 +1370,22 @@ pgsp_store(char *plan, queryid_t queryId,
 	e->counters.temp_blks_read += bufusage->temp_blks_read;
 	e->counters.temp_blks_written += bufusage->temp_blks_written;
 
-	e->counters.blk_read_time += INSTR_TIME_GET_MILLISEC(bufusage->blk_read_time);
-	e->counters.blk_write_time += INSTR_TIME_GET_MILLISEC(bufusage->blk_write_time);
-
+#if PG_VERSION_NUM >= 170000
+	e->counters.shared_blk_read_time +=
+		INSTR_TIME_GET_MILLISEC(bufusage->shared_blk_read_time);
+	e->counters.shared_blk_write_time +=
+		INSTR_TIME_GET_MILLISEC(bufusage->shared_blk_write_time);
+	e->counters.local_blk_read_time +=
+		INSTR_TIME_GET_MILLISEC(bufusage->local_blk_read_time);
+	e->counters.local_blk_write_time +=
+		INSTR_TIME_GET_MILLISEC(bufusage->local_blk_write_time);
+#else
+	e->counters.blk_read_time +=
+		INSTR_TIME_GET_MILLISEC(bufusage->blk_read_time);
+	e->counters.blk_write_time +=
+		INSTR_TIME_GET_MILLISEC(bufusage->blk_write_time);
+#endif
+	
 #if PG_VERSION_NUM >= 150000
 	e->counters.temp_blk_read_time += INSTR_TIME_GET_MILLISEC(bufusage->temp_blk_read_time);
 	e->counters.temp_blk_write_time += INSTR_TIME_GET_MILLISEC(bufusage->temp_blk_write_time);
@@ -1395,11 +1422,20 @@ pg_store_plans_reset(PG_FUNCTION_ARGS)
 #define PG_STORE_PLANS_COLS_V1_5	27
 #define PG_STORE_PLANS_COLS_V1_6	26
 #define PG_STORE_PLANS_COLS_V1_7	28
-#define PG_STORE_PLANS_COLS			28	/* maximum of above */
+#define PG_STORE_PLANS_COLS_V1_9	30
+#define PG_STORE_PLANS_COLS			30	/* maximum of above */
 
 /*
  * Retrieve statement statistics.
  */
+Datum
+pg_store_plans_1_9(PG_FUNCTION_ARGS)
+{
+	pg_store_plans_internal(fcinfo, PGSP_V1_9);
+
+	return (Datum) 0;
+}
+
 Datum
 pg_store_plans_1_7(PG_FUNCTION_ARGS)
 {
@@ -1658,8 +1694,14 @@ pg_store_plans_internal(FunctionCallInfo fcinfo,
 		values[i++] = Int64GetDatumFast(tmp.local_blks_written);
 		values[i++] = Int64GetDatumFast(tmp.temp_blks_read);
 		values[i++] = Int64GetDatumFast(tmp.temp_blks_written);
-		values[i++] = Float8GetDatumFast(tmp.blk_read_time);
-		values[i++] = Float8GetDatumFast(tmp.blk_write_time);
+		values[i++] = Float8GetDatumFast(tmp.shared_blk_read_time);
+		values[i++] = Float8GetDatumFast(tmp.shared_blk_write_time);
+
+		if (api_version >= PGSP_V1_9)
+		{
+			values[i++] = Float8GetDatumFast(tmp.local_blk_read_time);
+			values[i++] = Float8GetDatumFast(tmp.local_blk_write_time);
+		}
 
 		if (api_version >= PGSP_V1_7)
 		{
@@ -1673,15 +1715,18 @@ pg_store_plans_internal(FunctionCallInfo fcinfo,
 		Assert(i == (api_version == PGSP_V1_5 ? PG_STORE_PLANS_COLS_V1_5 :
 					 api_version == PGSP_V1_6 ? PG_STORE_PLANS_COLS_V1_6 :
 					 api_version == PGSP_V1_7 ? PG_STORE_PLANS_COLS_V1_7 :
+					 api_version == PGSP_V1_9 ? PG_STORE_PLANS_COLS_V1_9 :
 					 -1 /* fail if you forget to update this assert */ ));
 
 		tuplestore_putvalues(tupstore, tupdesc, values, nulls);
 	}
 
 	LWLockRelease(shared_state->lock);
 
+#if PG_VERSION_NUM < 170000
 	/* clean up and return the tuplestore */
 	tuplestore_donestoring(tupstore);
+#endif
 }
 
 /* Number of output arguments (columns) for pg_stat_statements_info */

pg_store_plans.control

@@ -1,5 +1,5 @@
 # pg_store_plans extension
 comment = 'track plan statistics of all SQL statements executed'
-default_version = '1.8'
+default_version = '1.9'
 module_pathname = '$libdir/pg_store_plans'
 relocatable = true

pgsp_json.c

@@ -23,6 +23,9 @@
 #else
 #include "common/jsonapi.h"
 #endif
+#if PG_VERSION_NUM >= 170000
+#include "mb/pg_wchar.h"
+#endif
 #include "pgsp_json.h"
 #include "pgsp_json_int.h"
 
@@ -42,6 +45,20 @@ enum pgsptokentype
     XCONST = 264,                  /* XCONST  */
     Op = 265,                      /* Op  */
     ICONST = 266,                  /* ICONST  */
+#if PG_VERSION_NUM >= 170000
+    CURRENT_CATALOG = 359,         /* CURRENT_CATALOG  */
+    CURRENT_DATE = 360,            /* CURRENT_DATE  */
+    CURRENT_ROLE = 361,            /* CURRENT_ROLE  */
+    CURRENT_SCHEMA = 362,          /* CURRENT_SCHEMA  */
+    CURRENT_TIME = 363,            /* CURRENT_TIME  */
+    CURRENT_TIMESTAMP = 364,       /* CURRENT_TIMESTAMP  */
+    CURRENT_USER = 365,            /* CURRENT_USER  */
+    FALSE_P = 418,                 /* FALSE_P  */
+    LOCALTIME = 512,               /* LOCALTIME  */
+    LOCALTIMESTAMP = 513,          /* LOCALTIMESTAMP  */
+    NULL_P = 552,                  /* NULL_P  */
+    TRUE_P = 708,                  /* TRUE_P  */
+#else
     CURRENT_CATALOG = 358,         /* CURRENT_CATALOG  */
     CURRENT_DATE = 359,            /* CURRENT_DATE  */
     CURRENT_ROLE = 360,            /* CURRENT_ROLE  */
@@ -54,6 +71,7 @@ enum pgsptokentype
     LOCALTIMESTAMP = 503,          /* LOCALTIMESTAMP  */
     NULL_P = 540,                  /* NULL_P  */
     TRUE_P = 689,                  /* TRUE_P  */
+#endif
 };
 #define JSONACTION_RETURN_SUCCESS() return JSON_SUCCESS
 #endif
@@ -1344,10 +1362,15 @@ run_pg_parse_json(JsonLexContext *lex, JsonSemAction *sem)
 void
 init_json_lex_context(JsonLexContext *lex, char *json)
 {
+#if PG_VERSION_NUM >= 170000
+	makeJsonLexContextCstringLen(lex, json, strlen(json),
+								 GetDatabaseEncoding(), true);
+#else
 	lex->input = lex->token_terminator = lex->line_start = json;
 	lex->line_number = 1;
 	lex->input_length = strlen(json);
 	lex->strval = makeStringInfo();
+#endif
 }
 
 static void

sql/store.sql

@@ -1,7 +1,8 @@
 SET client_min_messages = 'error';
 CREATE EXTENSION IF NOT EXISTS pg_store_plans;
 CREATE EXTENSION IF NOT EXISTS pg_stat_statements;
-SELECT pg_stat_statements_reset();
+-- ignore the timestamp returned by pg_stat_statement_reset()
+SELECT FROM (SELECT pg_stat_statements_reset());
 SELECT pg_store_plans_reset();
 
 DROP TABLE IF EXISTS t1;