From 36f93fb3625e8f1753070d30ec81548a4dfe9eb1 Mon Sep 17 00:00:00 2001
From: Kyotaro Horiguchi <horiguchi.kyotaro@lab.ntt.co.jp>
Date: Wed, 23 Jan 2019 17:32:03 +0900
Subject: [PATCH 3/3] Remote setting feature for catcache statitics.

---
 src/backend/postmaster/pgstat.c    |  26 ++++++---
 src/backend/storage/ipc/ipci.c     |   3 +
 src/backend/utils/cache/catcache.c | 116 +++++++++++++++++++++++++++++++++++++
 src/include/catalog/pg_proc.dat    |   8 +++
 src/include/utils/catcache.h       |   6 ++
 5 files changed, 151 insertions(+), 8 deletions(-)

diff --git a/src/backend/postmaster/pgstat.c b/src/backend/postmaster/pgstat.c
index 2e8b7d0d91..338a407552 100644
--- a/src/backend/postmaster/pgstat.c
+++ b/src/backend/postmaster/pgstat.c
@@ -62,6 +62,7 @@
 #include "storage/sinvaladt.h"
 #include "utils/ascii.h"
 #include "utils/guc.h"
+#include "utils/catcache.h"
 #include "utils/memutils.h"
 #include "utils/ps_status.h"
 #include "utils/rel.h"
@@ -343,7 +344,7 @@ static void pgstat_recv_funcpurge(PgStat_MsgFuncpurge *msg, int len);
 static void pgstat_recv_recoveryconflict(PgStat_MsgRecoveryConflict *msg, int len);
 static void pgstat_recv_deadlock(PgStat_MsgDeadlock *msg, int len);
 static void pgstat_recv_tempfile(PgStat_MsgTempFile *msg, int len);
-static void pgstat_syscache_remove_statsfile(void);
+static void pgstat_remove_syscache_statsfile(void);
 
 /* ------------------------------------------------------------
  * Public functions called from postmaster follow
@@ -2990,7 +2991,10 @@ pgstat_beshutdown_hook(int code, Datum arg)
 
 	/* clear syscache statistics files and temprary settings */
 	if (MyBackendId != InvalidBackendId)
-		pgstat_syscache_remove_statsfile();
+	{
+		pgstat_remove_syscache_statsfile();
+		SetCatcacheStatsParam(0);
+	}
 
 	/*
 	 * Clear my status entry, following the protocol of bumping st_changecount
@@ -6432,7 +6436,7 @@ pgstat_get_syscachestat_filename(bool permanent, bool tempname, int backendid,
 
 /* removes syscache stats files of this backend */
 static void
-pgstat_syscache_remove_statsfile(void)
+pgstat_remove_syscache_statsfile(void)
 {
 	char	fname[MAXPGPATH];
 
@@ -6461,15 +6465,21 @@ pgstat_write_syscache_stats(bool force)
 	FILE	*fpout;
 	char	statfile[MAXPGPATH];
 	char	tmpfile[MAXPGPATH];
+	int		interval = pgstat_track_syscache_usage_interval;
+	int		interval_by_remote = GetCatcacheStatsParam();
+
+	/* remote setting overrides if any */
+	if (interval_by_remote > 0)
+		interval = interval_by_remote;
 
 	/* Return if we don't want it */
-	if (!force && pgstat_track_syscache_usage_interval <= 0)
+	if (!force && interval <= 0)
 	{
 		/* disabled. remove the statistics file if any */
 		if (last_report > 0)
 		{
 			last_report = 0;
-			pgstat_syscache_remove_statsfile();
+			pgstat_remove_syscache_statsfile();
 		}
 		return 0;
 	}
@@ -6479,10 +6489,10 @@ pgstat_write_syscache_stats(bool force)
 	TimestampDifference(last_report, now, &secs, &usecs);
 	elapsed = secs * 1000 + usecs / 1000;
 
-	if (!force && elapsed < pgstat_track_syscache_usage_interval)
+	if (!force && elapsed < interval)
 	{
 		/* not yet the time, inform the remaining time to the caller */
-		return pgstat_track_syscache_usage_interval - elapsed;
+		return interval - elapsed;
 	}
 
 	/* now update the stats */
@@ -6511,7 +6521,7 @@ pgstat_write_syscache_stats(bool force)
 		 * tell caller to wait for the next interval.
 		 */
 		RESUME_INTERRUPTS();
-		return pgstat_track_syscache_usage_interval;
+		return interval;
 	}
 
 	/* write out every catcache stats */
diff --git a/src/backend/storage/ipc/ipci.c b/src/backend/storage/ipc/ipci.c
index 2849e47d99..be5ee1f4ff 100644
--- a/src/backend/storage/ipc/ipci.c
+++ b/src/backend/storage/ipc/ipci.c
@@ -44,6 +44,7 @@
 #include "storage/procsignal.h"
 #include "storage/sinvaladt.h"
 #include "storage/spin.h"
+#include "utils/catcache.h"
 #include "utils/snapmgr.h"
 
 
@@ -148,6 +149,7 @@ CreateSharedMemoryAndSemaphores(bool makePrivate, int port)
 		size = add_size(size, BTreeShmemSize());
 		size = add_size(size, SyncScanShmemSize());
 		size = add_size(size, AsyncShmemSize());
+		size = add_size(size, CatcacheStatsShmemSize());
 #ifdef EXEC_BACKEND
 		size = add_size(size, ShmemBackendArraySize());
 #endif
@@ -267,6 +269,7 @@ CreateSharedMemoryAndSemaphores(bool makePrivate, int port)
 	BTreeShmemInit();
 	SyncScanShmemInit();
 	AsyncShmemInit();
+	CatcacheStatsShmemInit();
 
 #ifdef EXEC_BACKEND
 
diff --git a/src/backend/utils/cache/catcache.c b/src/backend/utils/cache/catcache.c
index 4a3b3094a0..7ff8cd22ca 100644
--- a/src/backend/utils/cache/catcache.c
+++ b/src/backend/utils/cache/catcache.c
@@ -22,14 +22,17 @@
 #include "access/tuptoaster.h"
 #include "access/valid.h"
 #include "access/xact.h"
+#include "catalog/pg_authid.h"
 #include "catalog/pg_collation.h"
 #include "catalog/pg_operator.h"
 #include "catalog/pg_type.h"
 #include "miscadmin.h"
+#include "pgstat.h"
 #ifdef CATCACHE_STATS
 #include "storage/ipc.h"		/* for on_proc_exit */
 #endif
 #include "storage/lmgr.h"
+#include "storage/procarray.h"
 #include "utils/builtins.h"
 #include "utils/datum.h"
 #include "utils/fmgroids.h"
@@ -94,6 +97,17 @@ TimestampTz	catcacheclock = 0;
 static double ageclass[SYSCACHE_STATS_NAGECLASSES]
 	= {0.05, 0.1, 1.0, 2.0, 3.0, 0.0};
 
+/* remote commanding facility */
+typedef struct CatcacheStatsParam
+{
+	int	interval;
+} CatcacheStatsParam;
+
+#define NumCatcacheStatsParam (MaxBackends + NUM_AUXPROCTYPES)
+
+static slock_t CatcacheStatsParamLock;
+static CatcacheStatsParam *CatcacheStatsParamArray = NULL;
+
 static inline HeapTuple SearchCatCacheInternal(CatCache *cache,
 					   int nkeys,
 					   Datum v1, Datum v2,
@@ -2310,3 +2324,105 @@ CatCacheGetStats(CatCache *cache, SysCacheStats *stats)
 		}
 	}
 }
+
+/* Report shared-memory space needed */
+Size
+CatcacheStatsShmemSize(void)
+{
+	Size size;
+
+	/* The same number of elements with backend status array */
+	size = mul_size(sizeof(CatcacheStatsParam), NumCatcacheStatsParam);
+
+	return size;
+}
+
+/* Initialize the shared parameter array for catcache statistics */
+void
+CatcacheStatsShmemInit(void)
+{
+	Size size;
+	bool found;
+
+	size = CatcacheStatsShmemSize();
+	CatcacheStatsParamArray = (CatcacheStatsParam *)
+		ShmemInitStruct("Backend Catcache Statistics Parameter Array",
+						size, &found);
+
+	if (!found)
+	{
+		/* We're the first, initilize it */
+		MemSet(CatcacheStatsParamArray, 0, size);
+	}
+
+	SpinLockInit(&CatcacheStatsParamLock);
+}
+
+/*
+ * SQL callable function to take catcache statistics of another backend
+ */
+Datum
+backend_catcache_stats(PG_FUNCTION_ARGS)
+{
+	int	target_pid = PG_GETARG_INT32(0);
+	int interval = PG_GETARG_INT32(1);
+	PGPROC *target_proc;
+
+	if (interval < 0)
+		ereport(ERROR,
+				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
+				 errmsg("interval must not be a negtive number")));
+
+	LWLockAcquire(ProcArrayLock, LW_SHARED);
+	target_proc = BackendPidGetProcWithLock(target_pid);
+
+	if (target_proc == NULL)
+		ereport(ERROR,
+				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
+				 errmsg("PID %d is not a PostgreSQL server process",
+						target_pid)));
+
+	/* The same condition to pg_signal_backend() */
+	if ((superuser_arg(target_proc->roleId) && !superuser()) ||
+		(!has_privs_of_role(GetUserId(), target_proc->roleId) &&
+		 !has_privs_of_role(GetUserId(), DEFAULT_ROLE_SIGNAL_BACKENDID)))
+		ereport(ERROR,
+				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
+				 errmsg("permission denied")));
+
+	if (target_proc->backendId == InvalidBackendId)
+		ereport(ERROR,
+				(errmsg("invalid backendid")));
+
+	SpinLockAcquire(&CatcacheStatsParamLock);
+	CatcacheStatsParamArray[target_proc->backendId - 1].interval = interval;
+	SpinLockRelease(&CatcacheStatsParamLock);
+	LWLockRelease(ProcArrayLock);
+
+	PG_RETURN_VOID();
+}
+
+/* returns catcache stats paramter of this backend */
+int
+GetCatcacheStatsParam(void)
+{
+	int interval;
+
+	Assert(MyBackendId != InvalidBackendId);
+
+	SpinLockAcquire(&CatcacheStatsParamLock);
+	interval = CatcacheStatsParamArray[MyBackendId - 1].interval;
+	SpinLockRelease(&CatcacheStatsParamLock);
+
+	return interval;
+}	
+
+/* sets catcache stats paramter of this backend */
+void
+SetCatcacheStatsParam(int interval)
+{
+	Assert(MyBackendId != InvalidBackendId);
+	SpinLockAcquire(&CatcacheStatsParamLock);
+	CatcacheStatsParamArray[MyBackendId - 1].interval = interval;
+	SpinLockRelease(&CatcacheStatsParamLock);
+}	
diff --git a/src/include/catalog/pg_proc.dat b/src/include/catalog/pg_proc.dat
index 11fc1f3075..8011d94d5d 100644
--- a/src/include/catalog/pg_proc.dat
+++ b/src/include/catalog/pg_proc.dat
@@ -10518,4 +10518,12 @@
   proargnames => '{rootrelid,relid,parentrelid,isleaf,level}',
   prosrc => 'pg_partition_tree' },
 
+# catcache statitics
+{ oid => '3424',
+  descr => 'take backend statistics of another backend',
+  proname => 'pg_backend_catcache_stats', proisstrict => 'f',
+  proretset => 'f', provolatile => 'v', proparallel => 'u',
+  prorettype => 'void', proargtypes => 'int4 int4',
+  prosrc => 'backend_catcache_stats' },
+
 ]
diff --git a/src/include/utils/catcache.h b/src/include/utils/catcache.h
index 4d51975920..69031f1a5e 100644
--- a/src/include/utils/catcache.h
+++ b/src/include/utils/catcache.h
@@ -24,6 +24,7 @@
 #include "access/skey.h"
 #include "datatype/timestamp.h"
 #include "lib/ilist.h"
+#include "utils/catcache.h"
 #include "utils/relcache.h"
 
 /*
@@ -212,6 +213,9 @@ GetCatCacheClock(void)
 	return catcacheclock;
 }
 
+extern Size CatcacheStatsShmemSize(void);
+extern void CatcacheStatsShmemInit(void);
+
 extern void CreateCacheMemoryContext(void);
 
 extern CatCache *InitCatCache(int id, Oid reloid, Oid indexoid,
@@ -254,5 +258,7 @@ extern void PrintCatCacheListLeakWarning(CatCList *list);
 /* defined in syscache.h */
 typedef struct syscachestats SysCacheStats;
 extern void CatCacheGetStats(CatCache *cache, SysCacheStats *syscachestats);
+extern void SetCatcacheStatsParam(int interval);
+extern int GetCatcacheStatsParam(void);
 
 #endif							/* CATCACHE_H */
-- 
2.16.3

