diff --git a/LICENSE b/LICENSE index f4b38be..46c4b8f 100644 --- a/LICENSE +++ b/LICENSE @@ -1,7 +1,7 @@ pg_wait_sampling is released under the PostgreSQL License, a liberal Open Source license, similar to the BSD or MIT licenses. -Copyright (c) 2015-2017, Postgres Professional -Portions Copyright (c) 1996-2017, PostgreSQL Global Development Group +Copyright (c) 2015-2025, Postgres Professional +Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group Portions Copyright (c) 1994, The Regents of the University of California Permission to use, copy, modify, and distribute this software and its documentation for any purpose, without fee, and without a written agreement is hereby granted, provided that the above copyright notice and this paragraph and the following two paragraphs appear in all copies. diff --git a/collector.c b/collector.c index cd2762d..721299f 100644 --- a/collector.c +++ b/collector.c @@ -2,33 +2,33 @@ * collector.c * Collector of wait event history and profile. * - * Copyright (c) 2015-2016, Postgres Professional + * Copyright (c) 2015-2025, Postgres Professional * * IDENTIFICATION * contrib/pg_wait_sampling/pg_wait_sampling.c */ #include "postgres.h" -#include "catalog/pg_type.h" -#if PG_VERSION_NUM >= 130000 -#include "common/hashfn.h" -#endif -#include "funcapi.h" +#include + +#include "compat.h" #include "miscadmin.h" +#include "pg_wait_sampling.h" +#include "pgstat.h" #include "postmaster/bgworker.h" #include "postmaster/interrupt.h" #include "storage/ipc.h" -#include "storage/procarray.h" +#include "storage/latch.h" +#include "storage/lock.h" +#include "storage/lwlock.h" +#include "storage/proc.h" #include "storage/procsignal.h" #include "storage/shm_mq.h" -#include "storage/shm_toc.h" -#include "storage/spin.h" +#include "utils/guc.h" +#include "utils/hsearch.h" #include "utils/memutils.h" #include "utils/resowner.h" -#include "pgstat.h" - -#include "compat.h" -#include "pg_wait_sampling.h" +#include "utils/timestamp.h" static volatile sig_atomic_t shutdown_requested = false; @@ -73,10 +73,10 @@ alloc_history(History *observations, int count) static void realloc_history(History *observations, int count) { - HistoryItem *newitems; - int copyCount, - i, - j; + HistoryItem *newitems; + int copyCount, + i, + j; /* Allocate new array for history */ newitems = (HistoryItem *) palloc0(sizeof(HistoryItem) * count); @@ -114,7 +114,8 @@ realloc_history(History *observations, int count) static void handle_sigterm(SIGNAL_ARGS) { - int save_errno = errno; + int save_errno = errno; + shutdown_requested = true; if (MyProc) SetLatch(&MyProc->procLatch); @@ -129,6 +130,7 @@ get_next_observation(History *observations) { HistoryItem *result; + /* Check for wraparound */ if (observations->index >= observations->count) { observations->index = 0; @@ -149,7 +151,7 @@ probe_waits(History *observations, HTAB *profile_hash, { int i, newSize; - TimestampTz ts = GetCurrentTimestamp(); + TimestampTz ts = GetCurrentTimestamp(); /* Realloc waits history if needed */ newSize = pgws_historySize; @@ -160,9 +162,9 @@ probe_waits(History *observations, HTAB *profile_hash, LWLockAcquire(ProcArrayLock, LW_SHARED); for (i = 0; i < ProcGlobal->allProcCount; i++) { - HistoryItem item, - *observation; - PGPROC *proc = &ProcGlobal->allProcs[i]; + HistoryItem item, + *observation; + PGPROC *proc = &ProcGlobal->allProcs[i]; if (!pgws_should_sample_proc(proc, &item.pid, &item.wait_event_info)) continue; @@ -184,8 +186,8 @@ probe_waits(History *observations, HTAB *profile_hash, /* Write to the profile if needed */ if (write_profile) { - ProfileItem *profileItem; - bool found; + ProfileItem *profileItem; + bool found; if (!profile_pid) item.pid = 0; @@ -206,15 +208,16 @@ probe_waits(History *observations, HTAB *profile_hash, static void send_history(History *observations, shm_mq_handle *mqh) { - Size count, - i; - shm_mq_result mq_result; + Size count, + i; + shm_mq_result mq_result; if (observations->wraparound) count = observations->count; else count = observations->index; + /* Send array size first since receive_array expects this */ mq_result = shm_mq_send_compat(mqh, sizeof(count), &count, false, true); if (mq_result == SHM_MQ_DETACHED) { @@ -226,10 +229,10 @@ send_history(History *observations, shm_mq_handle *mqh) for (i = 0; i < count; i++) { mq_result = shm_mq_send_compat(mqh, - sizeof(HistoryItem), - &observations->items[i], - false, - true); + sizeof(HistoryItem), + &observations->items[i], + false, + true); if (mq_result == SHM_MQ_DETACHED) { ereport(WARNING, @@ -246,11 +249,12 @@ send_history(History *observations, shm_mq_handle *mqh) static void send_profile(HTAB *profile_hash, shm_mq_handle *mqh) { - HASH_SEQ_STATUS scan_status; - ProfileItem *item; - Size count = hash_get_num_entries(profile_hash); - shm_mq_result mq_result; + HASH_SEQ_STATUS scan_status; + ProfileItem *item; + Size count = hash_get_num_entries(profile_hash); + shm_mq_result mq_result; + /* Send array size first since receive_array expects this */ mq_result = shm_mq_send_compat(mqh, sizeof(count), &count, false, true); if (mq_result == SHM_MQ_DETACHED) { @@ -281,10 +285,7 @@ send_profile(HTAB *profile_hash, shm_mq_handle *mqh) static HTAB * make_profile_hash() { - HASHCTL hash_ctl; - - hash_ctl.hash = tag_hash; - hash_ctl.hcxt = TopMemoryContext; + HASHCTL hash_ctl; if (pgws_profileQueries) hash_ctl.keysize = offsetof(ProfileItem, count); @@ -293,7 +294,7 @@ make_profile_hash() hash_ctl.entrysize = sizeof(ProfileItem); return hash_create("Waits profile hash", 1024, &hash_ctl, - HASH_FUNCTION | HASH_ELEM); + HASH_ELEM | HASH_BLOBS); } /* @@ -302,8 +303,8 @@ make_profile_hash() static int64 millisecs_diff(TimestampTz tz1, TimestampTz tz2) { - long secs; - int microsecs; + long secs; + int microsecs; TimestampDifference(tz1, tz2, &secs, µsecs); @@ -317,26 +318,19 @@ millisecs_diff(TimestampTz tz1, TimestampTz tz2) void pgws_collector_main(Datum main_arg) { - HTAB *profile_hash = NULL; - History observations; - MemoryContext old_context, - collector_context; - TimestampTz current_ts, - history_ts, - profile_ts; + HTAB *profile_hash = NULL; + History observations; + MemoryContext old_context, + collector_context; + TimestampTz current_ts, + history_ts, + profile_ts; /* * Establish signal handlers. * - * We want CHECK_FOR_INTERRUPTS() to kill off this worker process just as - * it would a normal user backend. To make that happen, we establish a - * signal handler that is a stripped-down version of die(). We don't have - * any equivalent of the backend's command-read loop, where interrupts can - * be processed immediately, so make sure ImmediateInterruptOK is turned - * off. - * - * We also want to respond to the ProcSignal notifications. This is done - * in the upstream provided procsignal_sigusr1_handler, which is + * We want to respond to the ProcSignal notifications. This is done in + * the upstream provided procsignal_sigusr1_handler, which is * automatically used if a bgworker connects to a database. But since our * worker doesn't connect to any database even though it calls * InitPostgres, which will still initializze a new backend and thus @@ -357,7 +351,7 @@ pgws_collector_main(Datum main_arg) CurrentResourceOwner = ResourceOwnerCreate(NULL, "pg_wait_sampling collector"); collector_context = AllocSetContextCreate(TopMemoryContext, - "pg_wait_sampling context", ALLOCSET_DEFAULT_SIZES); + "pg_wait_sampling context", ALLOCSET_DEFAULT_SIZES); old_context = MemoryContextSwitchTo(collector_context); alloc_history(&observations, pgws_historySize); MemoryContextSwitchTo(old_context); @@ -369,12 +363,12 @@ pgws_collector_main(Datum main_arg) while (1) { - int rc; - shm_mq_handle *mqh; - int64 history_diff, - profile_diff; - bool write_history, - write_profile; + int rc; + shm_mq_handle *mqh; + int64 history_diff, + profile_diff; + bool write_history, + write_profile; /* We need an explicit call for at least ProcSignal notifications. */ CHECK_FOR_INTERRUPTS(); @@ -385,14 +379,14 @@ pgws_collector_main(Datum main_arg) ProcessConfigFile(PGC_SIGHUP); } - /* Wait calculate time to next sample for history or profile */ + /* Calculate time to next sample for history or profile */ current_ts = GetCurrentTimestamp(); history_diff = millisecs_diff(history_ts, current_ts); profile_diff = millisecs_diff(profile_ts, current_ts); - write_history = (history_diff >= (int64)pgws_historyPeriod); - write_profile = (profile_diff >= (int64)pgws_profilePeriod); + write_history = (history_diff >= (int64) pgws_historyPeriod); + write_profile = (profile_diff >= (int64) pgws_profilePeriod); if (write_history || write_profile) { @@ -421,8 +415,8 @@ pgws_collector_main(Datum main_arg) * shared memory. */ rc = WaitLatch(&MyProc->procLatch, WL_LATCH_SET | WL_TIMEOUT | WL_POSTMASTER_DEATH, - Min(pgws_historyPeriod - (int)history_diff, - pgws_historyPeriod - (int)profile_diff), PG_WAIT_EXTENSION); + Min(pgws_historyPeriod - (int) history_diff, + pgws_historyPeriod - (int) profile_diff), PG_WAIT_EXTENSION); if (rc & WL_POSTMASTER_DEATH) proc_exit(1); @@ -443,7 +437,7 @@ pgws_collector_main(Datum main_arg) if (request == HISTORY_REQUEST || request == PROFILE_REQUEST) { - shm_mq_result mq_result; + shm_mq_result mq_result; /* Send history or profile */ shm_mq_set_sender(pgws_collector_mq, MyProc); @@ -487,12 +481,6 @@ pgws_collector_main(Datum main_arg) MemoryContextReset(collector_context); - /* - * We're done. Explicitly detach the shared memory segment so that we - * don't get a resource leak warning at commit time. This will fire any - * on_dsm_detach callbacks we've registered, as well. Once that's done, - * we can go ahead and exit. - */ ereport(LOG, (errmsg("pg_wait_sampling collector shutting down"))); proc_exit(0); } diff --git a/compat.h b/compat.h index 5371ae2..32aef49 100644 --- a/compat.h +++ b/compat.h @@ -2,7 +2,7 @@ * compat.h * Definitions for function wrappers compatible between PG versions. * - * Copyright (c) 2015-2022, Postgres Professional + * Copyright (c) 2015-2025, Postgres Professional * * IDENTIFICATION * contrib/pg_wait_sampling/compat.h @@ -10,12 +10,8 @@ #ifndef __COMPAT_H__ #define __COMPAT_H__ -#include "postgres.h" - -#include "access/tupdesc.h" #include "miscadmin.h" #include "storage/shm_mq.h" -#include "utils/guc_tables.h" static inline shm_mq_result shm_mq_send_compat(shm_mq_handle *mqh, Size nbytes, const void *data, diff --git a/pg_wait_sampling.c b/pg_wait_sampling.c index 153d875..81c37ea 100644 --- a/pg_wait_sampling.c +++ b/pg_wait_sampling.c @@ -2,39 +2,41 @@ * pg_wait_sampling.c * Track information about wait events. * - * Copyright (c) 2015-2017, Postgres Professional + * Copyright (c) 2015-2025, Postgres Professional * * IDENTIFICATION * contrib/pg_wait_sampling/pg_wait_sampling.c */ #include "postgres.h" +#include + #include "access/htup_details.h" -#include "access/twophase.h" -#include "catalog/pg_type.h" -#include "fmgr.h" +#include "catalog/pg_type_d.h" +#include "executor/executor.h" #include "funcapi.h" #include "miscadmin.h" #include "optimizer/planner.h" +#include "pg_wait_sampling.h" #include "pgstat.h" -#include "postmaster/autovacuum.h" -#include "replication/walsender.h" #include "storage/ipc.h" -#include "storage/pg_shmem.h" -#include "storage/procarray.h" +#include "storage/latch.h" +#include "storage/lock.h" +#include "storage/lwlock.h" +#include "storage/proc.h" #include "storage/shm_mq.h" #include "storage/shm_toc.h" -#include "storage/spin.h" +#include "storage/shmem.h" #include "tcop/utility.h" #include "utils/builtins.h" -#include "utils/datetime.h" -#include "utils/guc_tables.h" #include "utils/guc.h" -#include "utils/memutils.h" /* TopMemoryContext. Actually for PG 9.6 only, - * but there should be no harm for others. */ +#include "utils/memutils.h" +#include "utils/timestamp.h" -#include "compat.h" -#include "pg_wait_sampling.h" +#if PG_VERSION_NUM < 150000 +#include "postmaster/autovacuum.h" +#include "replication/walsender.h" +#endif PG_MODULE_MAGIC; @@ -42,45 +44,52 @@ void _PG_init(void); static bool shmem_initialized = false; -/* Hooks */ -static ExecutorStart_hook_type prev_ExecutorStart = NULL; -static ExecutorRun_hook_type prev_ExecutorRun = NULL; +/* Hooks variables */ +static ExecutorStart_hook_type prev_ExecutorStart = NULL; +static ExecutorRun_hook_type prev_ExecutorRun = NULL; static ExecutorFinish_hook_type prev_ExecutorFinish = NULL; -static ExecutorEnd_hook_type prev_ExecutorEnd = NULL; -static planner_hook_type planner_hook_next = NULL; +static ExecutorEnd_hook_type prev_ExecutorEnd = NULL; +static planner_hook_type planner_hook_next = NULL; static ProcessUtility_hook_type prev_ProcessUtility = NULL; /* Current nesting depth of planner/Executor calls */ -static int nesting_level = 0; +static int nesting_level = 0; /* Pointers to shared memory objects */ -shm_mq *pgws_collector_mq = NULL; -uint64 *pgws_proc_queryids = NULL; -CollectorShmqHeader *pgws_collector_hdr = NULL; +shm_mq *pgws_collector_mq = NULL; +uint64 *pgws_proc_queryids = NULL; +CollectorShmqHeader *pgws_collector_hdr = NULL; /* Receiver (backend) local shm_mq pointers and lock */ static shm_mq *recv_mq = NULL; static shm_mq_handle *recv_mqh = NULL; static LOCKTAG queueTag; +/* Hook functions */ #if PG_VERSION_NUM >= 150000 static shmem_request_hook_type prev_shmem_request_hook = NULL; #endif static shmem_startup_hook_type prev_shmem_startup_hook = NULL; -static PGPROC * search_proc(int backendPid); +static PGPROC *search_proc(int backendPid); static PlannedStmt *pgws_planner_hook(Query *parse, #if PG_VERSION_NUM >= 130000 - const char *query_string, + const char *query_string, +#endif + int cursorOptions, ParamListInfo boundParams); +static +#if PG_VERSION_NUM >= 180000 +bool +#else +void #endif - int cursorOptions, ParamListInfo boundParams); -static void pgws_ExecutorStart(QueryDesc *queryDesc, int eflags); +pgws_ExecutorStart(QueryDesc *queryDesc, int eflags); static void pgws_ExecutorRun(QueryDesc *queryDesc, ScanDirection direction, uint64 count #if PG_VERSION_NUM >= 100000 && PG_VERSION_NUM < 180000 - , bool execute_once + ,bool execute_once #endif - ); +); static void pgws_ExecutorFinish(QueryDesc *queryDesc); static void pgws_ExecutorEnd(QueryDesc *queryDesc); static void pgws_ProcessUtility(PlannedStmt *pstmt, @@ -97,40 +106,39 @@ static void pgws_ProcessUtility(PlannedStmt *pstmt, #else char *completionTag #endif - ); +); /*---- GUC variables ----*/ typedef enum { - PGWS_PROFILE_QUERIES_NONE, /* profile no statements */ - PGWS_PROFILE_QUERIES_TOP, /* only top level statements */ - PGWS_PROFILE_QUERIES_ALL /* all statements, including nested ones */ + PGWS_PROFILE_QUERIES_NONE, /* profile no statements */ + PGWS_PROFILE_QUERIES_TOP, /* only top level statements */ + PGWS_PROFILE_QUERIES_ALL /* all statements, including nested ones */ } PGWSTrackLevel; static const struct config_enum_entry pgws_profile_queries_options[] = { - {"none", PGWS_PROFILE_QUERIES_NONE, false}, - {"off", PGWS_PROFILE_QUERIES_NONE, false}, - {"no", PGWS_PROFILE_QUERIES_NONE, false}, - {"false", PGWS_PROFILE_QUERIES_NONE, false}, - {"0", PGWS_PROFILE_QUERIES_NONE, false}, - {"top", PGWS_PROFILE_QUERIES_TOP, false}, - {"on", PGWS_PROFILE_QUERIES_TOP, false}, - {"yes", PGWS_PROFILE_QUERIES_TOP, false}, - {"true", PGWS_PROFILE_QUERIES_TOP, false}, - {"1", PGWS_PROFILE_QUERIES_TOP, false}, - {"all", PGWS_PROFILE_QUERIES_ALL, false}, - {NULL, 0, false} + {"none", PGWS_PROFILE_QUERIES_NONE, false}, + {"off", PGWS_PROFILE_QUERIES_NONE, false}, + {"no", PGWS_PROFILE_QUERIES_NONE, false}, + {"false", PGWS_PROFILE_QUERIES_NONE, false}, + {"0", PGWS_PROFILE_QUERIES_NONE, false}, + {"top", PGWS_PROFILE_QUERIES_TOP, false}, + {"on", PGWS_PROFILE_QUERIES_TOP, false}, + {"yes", PGWS_PROFILE_QUERIES_TOP, false}, + {"true", PGWS_PROFILE_QUERIES_TOP, false}, + {"1", PGWS_PROFILE_QUERIES_TOP, false}, + {"all", PGWS_PROFILE_QUERIES_ALL, false}, + {NULL, 0, false} }; -/* GUC variables */ -int pgws_historySize = 5000; -int pgws_historyPeriod = 10; -int pgws_profilePeriod = 10; -bool pgws_profilePid = true; -int pgws_profileQueries = PGWS_PROFILE_QUERIES_TOP; -bool pgws_sampleCpu = true; +int pgws_historySize = 5000; +int pgws_historyPeriod = 10; +int pgws_profilePeriod = 10; +bool pgws_profilePid = true; +int pgws_profileQueries = PGWS_PROFILE_QUERIES_TOP; +bool pgws_sampleCpu = true; #define pgws_enabled(level) \ ((pgws_profileQueries == PGWS_PROFILE_QUERIES_ALL) || \ @@ -146,10 +154,11 @@ bool pgws_sampleCpu = true; static int get_max_procs_count(void) { - int count = 0; + int count = 0; /* First, add the maximum number of backends (MaxBackends). */ #if PG_VERSION_NUM >= 150000 + /* * On pg15+, we can directly access the MaxBackends variable, as it will * have already been initialized in shmem_request_hook. @@ -157,35 +166,35 @@ get_max_procs_count(void) Assert(MaxBackends > 0); count += MaxBackends; #else + /* - * On older versions, we need to compute MaxBackends: bgworkers, autovacuum - * workers and launcher. - * This has to be in sync with the value computed in - * InitializeMaxBackends() (postinit.c) + * On older versions, we need to compute MaxBackends: bgworkers, + * autovacuum workers and launcher. This has to be in sync with the value + * computed in InitializeMaxBackends() (postinit.c) * - * Note that we need to calculate the value as it won't initialized when we - * need it during _PG_init(). + * Note that we need to calculate the value as it won't initialized when + * we need it during _PG_init(). * * Note also that the value returned during _PG_init() might be different * from the value returned later if some third-party modules change one of * the underlying GUC. This isn't ideal but can't lead to a crash, as the * value returned during _PG_init() is only used to ask for additional * shmem with RequestAddinShmemSpace(), and postgres has an extra 100kB of - * shmem to compensate some small unaccounted usage. So if the value later - * changes, we will allocate and initialize the new (and correct) memory - * size, which will either work thanks for the extra 100kB of shmem, of - * fail (and prevent postgres startup) due to an out of shared memory - * error. + * shmem to compensate some small unaccounted usage. So if the value + * later changes, we will allocate and initialize the new (and correct) + * memory size, which will either work thanks for the extra 100kB of + * shmem, of fail (and prevent postgres startup) due to an out of shared + * memory error. */ count += MaxConnections + autovacuum_max_workers + 1 - + max_worker_processes; + + max_worker_processes; /* * Starting with pg12, wal senders aren't part of MaxConnections anymore * and have to be accounted for. */ count += max_wal_senders; -#endif /* pg 15- */ +#endif /* pg 15- */ /* End of MaxBackends calculation. */ /* Add AuxiliaryProcs */ @@ -200,9 +209,9 @@ get_max_procs_count(void) static Size pgws_shmem_size(void) { - shm_toc_estimator e; - Size size; - int nkeys; + shm_toc_estimator e; + Size size; + int nkeys; shm_toc_initialize_estimator(&e); @@ -244,12 +253,13 @@ pgws_shmem_startup(void) bool found; Size segsize = pgws_shmem_size(); void *pgws; - shm_toc *toc; + shm_toc *toc; pgws = ShmemInitStruct("pg_wait_sampling", segsize, &found); if (!found) { + /* Create shared objects */ toc = shm_toc_create(PG_WAIT_SAMPLING_MAGIC, pgws, segsize); pgws_collector_hdr = shm_toc_allocate(toc, sizeof(CollectorShmqHeader)); @@ -257,12 +267,13 @@ pgws_shmem_startup(void) pgws_collector_mq = shm_toc_allocate(toc, COLLECTOR_QUEUE_SIZE); shm_toc_insert(toc, 1, pgws_collector_mq); pgws_proc_queryids = shm_toc_allocate(toc, - sizeof(uint64) * get_max_procs_count()); + sizeof(uint64) * get_max_procs_count()); shm_toc_insert(toc, 2, pgws_proc_queryids); MemSet(pgws_proc_queryids, 0, sizeof(uint64) * get_max_procs_count()); } else { + /* Attach to existing shared objects */ toc = shm_toc_attach(PG_WAIT_SAMPLING_MAGIC, pgws); pgws_collector_hdr = shm_toc_lookup(toc, 0, false); pgws_collector_mq = shm_toc_lookup(toc, 1, false); @@ -306,6 +317,7 @@ _PG_init(void) return; #if PG_VERSION_NUM < 150000 + /* * Request additional shared resources. (These are no-ops if we're not in * the postmaster process.) We'll allocate or attach to the shared @@ -324,22 +336,22 @@ _PG_init(void) */ #if PG_VERSION_NUM >= 150000 prev_shmem_request_hook = shmem_request_hook; - shmem_request_hook = pgws_shmem_request; + shmem_request_hook = pgws_shmem_request; #endif prev_shmem_startup_hook = shmem_startup_hook; - shmem_startup_hook = pgws_shmem_startup; - planner_hook_next = planner_hook; - planner_hook = pgws_planner_hook; - prev_ExecutorStart = ExecutorStart_hook; - ExecutorStart_hook = pgws_ExecutorStart; - prev_ExecutorRun = ExecutorRun_hook; - ExecutorRun_hook = pgws_ExecutorRun; - prev_ExecutorFinish = ExecutorFinish_hook; - ExecutorFinish_hook = pgws_ExecutorFinish; - prev_ExecutorEnd = ExecutorEnd_hook; - ExecutorEnd_hook = pgws_ExecutorEnd; - prev_ProcessUtility = ProcessUtility_hook; - ProcessUtility_hook = pgws_ProcessUtility; + shmem_startup_hook = pgws_shmem_startup; + planner_hook_next = planner_hook; + planner_hook = pgws_planner_hook; + prev_ExecutorStart = ExecutorStart_hook; + ExecutorStart_hook = pgws_ExecutorStart; + prev_ExecutorRun = ExecutorRun_hook; + ExecutorRun_hook = pgws_ExecutorRun; + prev_ExecutorFinish = ExecutorFinish_hook; + ExecutorFinish_hook = pgws_ExecutorFinish; + prev_ExecutorEnd = ExecutorEnd_hook; + ExecutorEnd_hook = pgws_ExecutorEnd; + prev_ProcessUtility = ProcessUtility_hook; + ProcessUtility_hook = pgws_ProcessUtility; /* Define GUC variables */ DefineCustomIntVariable("pg_wait_sampling.history_size", @@ -363,7 +375,7 @@ _PG_init(void) 1, INT_MAX, PGC_SIGHUP, - GUC_UNIT_MS, + 0, NULL, NULL, NULL); @@ -376,7 +388,7 @@ _PG_init(void) 1, INT_MAX, PGC_SIGHUP, - GUC_UNIT_MS, + 0, NULL, NULL, NULL); @@ -427,14 +439,15 @@ _PG_init(void) static PGPROC * search_proc(int pid) { - int i; + int i; if (pid == 0) return MyProc; for (i = 0; i < ProcGlobal->allProcCount; i++) { - PGPROC *proc = &ProcGlobal->allProcs[i]; + PGPROC *proc = &ProcGlobal->allProcs[i]; + if (proc->pid && proc->pid == pid) { return proc; @@ -476,28 +489,28 @@ pgws_should_sample_proc(PGPROC *proc, int *pid_p, uint32 *wait_event_info_p) typedef struct { - HistoryItem *items; - TimestampTz ts; + HistoryItem *items; + TimestampTz ts; } WaitCurrentContext; PG_FUNCTION_INFO_V1(pg_wait_sampling_get_current); Datum pg_wait_sampling_get_current(PG_FUNCTION_ARGS) { - FuncCallContext *funcctx; - WaitCurrentContext *params; + FuncCallContext *funcctx; + WaitCurrentContext *params; check_shmem(); if (SRF_IS_FIRSTCALL()) { - MemoryContext oldcontext; - TupleDesc tupdesc; + MemoryContext oldcontext; + TupleDesc tupdesc; funcctx = SRF_FIRSTCALL_INIT(); oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx); - params = (WaitCurrentContext *)palloc0(sizeof(WaitCurrentContext)); + params = (WaitCurrentContext *) palloc0(sizeof(WaitCurrentContext)); params->ts = GetCurrentTimestamp(); funcctx->user_fctx = params; @@ -517,8 +530,9 @@ pg_wait_sampling_get_current(PG_FUNCTION_ARGS) if (!PG_ARGISNULL(0)) { - HistoryItem *item; - PGPROC *proc; + /* pg_wait_sampling_get_current(pid int4) function */ + HistoryItem *item; + PGPROC *proc; proc = search_proc(PG_GETARG_UINT32(0)); params->items = (HistoryItem *) palloc0(sizeof(HistoryItem)); @@ -530,14 +544,15 @@ pg_wait_sampling_get_current(PG_FUNCTION_ARGS) } else { - int procCount = ProcGlobal->allProcCount, - i, - j = 0; + /* pg_wait_sampling_current view */ + int procCount = ProcGlobal->allProcCount, + i, + j = 0; params->items = (HistoryItem *) palloc0(sizeof(HistoryItem) * procCount); for (i = 0; i < procCount; i++) { - PGPROC *proc = &ProcGlobal->allProcs[i]; + PGPROC *proc = &ProcGlobal->allProcs[i]; if (!pgws_should_sample_proc(proc, ¶ms->items[j].pid, @@ -595,14 +610,15 @@ pg_wait_sampling_get_current(PG_FUNCTION_ARGS) } else { + /* nothing left */ SRF_RETURN_DONE(funcctx); } } typedef struct { - Size count; - ProfileItem *items; + Size count; + ProfileItem *items; } Profile; void @@ -616,17 +632,18 @@ pgws_init_lock_tag(LOCKTAG *tag, uint32 lock) tag->locktag_lockmethodid = USER_LOCKMETHOD; } +/* Get array (history or profile data) from shared memory */ static void * receive_array(SHMRequest request, Size item_size, Size *count) { - LOCKTAG collectorTag; - shm_mq_result res; - Size len, - i; - void *data; - Pointer result, - ptr; - MemoryContext oldctx; + LOCKTAG collectorTag; + shm_mq_result res; + Size len, + i; + void *data; + Pointer result, + ptr; + MemoryContext oldctx; /* Ensure nobody else trying to send request to queue */ pgws_init_lock_tag(&queueTag, PGWS_QUEUE_LOCK); @@ -647,9 +664,9 @@ receive_array(SHMRequest request, Size item_size, Size *count) shm_mq_set_receiver(recv_mq, MyProc); /* - * We switch to TopMemoryContext, so that recv_mqh is allocated there - * and is guaranteed to survive until before_shmem_exit callbacks are - * fired. Anyway, shm_mq_detach() will free handler on its own. + * We switch to TopMemoryContext, so that recv_mqh is allocated there and + * is guaranteed to survive until before_shmem_exit callbacks are fired. + * Anyway, shm_mq_detach() will free handler on its own. * * NB: we do not pass `seg` to shm_mq_attach(), so it won't set its own * callback, i.e. we do not interfere here with shm_mq_detach_callback(). @@ -659,10 +676,10 @@ receive_array(SHMRequest request, Size item_size, Size *count) MemoryContextSwitchTo(oldctx); /* - * Now we surely attached to the shm_mq and got collector's attention. - * If anything went wrong (e.g. Ctrl+C received from the client) we have - * to cleanup some things, i.e. detach from the shm_mq, so collector was - * able to continue responding to other requests. + * Now we surely attached to the shm_mq and got collector's attention. If + * anything went wrong (e.g. Ctrl+C received from the client) we have to + * cleanup some things, i.e. detach from the shm_mq, so collector was able + * to continue responding to other requests. * * PG_ENSURE_ERROR_CLEANUP() guaranties that cleanup callback will be * fired for both ERROR and FATAL. @@ -702,15 +719,15 @@ PG_FUNCTION_INFO_V1(pg_wait_sampling_get_profile); Datum pg_wait_sampling_get_profile(PG_FUNCTION_ARGS) { - Profile *profile; - FuncCallContext *funcctx; + Profile *profile; + FuncCallContext *funcctx; check_shmem(); if (SRF_IS_FIRSTCALL()) { - MemoryContext oldcontext; - TupleDesc tupdesc; + MemoryContext oldcontext; + TupleDesc tupdesc; funcctx = SRF_FIRSTCALL_INIT(); oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx); @@ -718,7 +735,7 @@ pg_wait_sampling_get_profile(PG_FUNCTION_ARGS) /* Receive profile from shmq */ profile = (Profile *) palloc0(sizeof(Profile)); profile->items = (ProfileItem *) receive_array(PROFILE_REQUEST, - sizeof(ProfileItem), &profile->count); + sizeof(ProfileItem), &profile->count); funcctx->user_fctx = profile; funcctx->max_calls = profile->count; @@ -819,15 +836,15 @@ PG_FUNCTION_INFO_V1(pg_wait_sampling_get_history); Datum pg_wait_sampling_get_history(PG_FUNCTION_ARGS) { - History *history; - FuncCallContext *funcctx; + History *history; + FuncCallContext *funcctx; check_shmem(); if (SRF_IS_FIRSTCALL()) { - MemoryContext oldcontext; - TupleDesc tupdesc; + MemoryContext oldcontext; + TupleDesc tupdesc; funcctx = SRF_FIRSTCALL_INIT(); oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx); @@ -835,7 +852,7 @@ pg_wait_sampling_get_history(PG_FUNCTION_ARGS) /* Receive history from shmq */ history = (History *) palloc0(sizeof(History)); history->items = (HistoryItem *) receive_array(HISTORY_REQUEST, - sizeof(HistoryItem), &history->count); + sizeof(HistoryItem), &history->count); funcctx->user_fctx = history; funcctx->max_calls = history->count; @@ -916,9 +933,9 @@ pgws_planner_hook(Query *parse, int cursorOptions, ParamListInfo boundParams) { - PlannedStmt *result; - int i = MyProc - ProcGlobal->allProcs; - uint64 save_queryId = 0; + PlannedStmt *result; + int i = MyProc - ProcGlobal->allProcs; + uint64 save_queryId = 0; if (pgws_enabled(nesting_level)) { @@ -933,15 +950,15 @@ pgws_planner_hook(Query *parse, if (planner_hook_next) result = planner_hook_next(parse, #if PG_VERSION_NUM >= 130000 - query_string, + query_string, #endif - cursorOptions, boundParams); + cursorOptions, boundParams); else result = standard_planner(parse, #if PG_VERSION_NUM >= 130000 - query_string, + query_string, #endif - cursorOptions, boundParams); + cursorOptions, boundParams); nesting_level--; if (nesting_level == 0) pgws_proc_queryids[i] = UINT64CONST(0); @@ -965,29 +982,43 @@ pgws_planner_hook(Query *parse, /* * ExecutorStart hook: save queryId for collector */ -static void +static +#if PG_VERSION_NUM >= 180000 +bool +#else +void +#endif pgws_ExecutorStart(QueryDesc *queryDesc, int eflags) { - int i = MyProc - ProcGlobal->allProcs; + int i = MyProc - ProcGlobal->allProcs; + if (pgws_enabled(nesting_level)) pgws_proc_queryids[i] = queryDesc->plannedstmt->queryId; if (prev_ExecutorStart) +#if PG_VERSION_NUM >= 180000 + return prev_ExecutorStart(queryDesc, eflags); +#else prev_ExecutorStart(queryDesc, eflags); +#endif else +#if PG_VERSION_NUM >= 180000 + return standard_ExecutorStart(queryDesc, eflags); +#else standard_ExecutorStart(queryDesc, eflags); +#endif } static void pgws_ExecutorRun(QueryDesc *queryDesc, - ScanDirection direction, - uint64 count + ScanDirection direction, + uint64 count #if PG_VERSION_NUM >= 100000 && PG_VERSION_NUM < 180000 - , bool execute_once + ,bool execute_once #endif - ) +) { - int i = MyProc - ProcGlobal->allProcs; - uint64 save_queryId = pgws_proc_queryids[i]; + int i = MyProc - ProcGlobal->allProcs; + uint64 save_queryId = pgws_proc_queryids[i]; nesting_level++; PG_TRY(); @@ -1025,8 +1056,8 @@ pgws_ExecutorRun(QueryDesc *queryDesc, static void pgws_ExecutorFinish(QueryDesc *queryDesc) { - int i = MyProc - ProcGlobal->allProcs; - uint64 save_queryId = pgws_proc_queryids[i]; + int i = MyProc - ProcGlobal->allProcs; + uint64 save_queryId = pgws_proc_queryids[i]; nesting_level++; PG_TRY(); @@ -1056,7 +1087,8 @@ pgws_ExecutorFinish(QueryDesc *queryDesc) static void pgws_ExecutorEnd(QueryDesc *queryDesc) { - int i = MyProc - ProcGlobal->allProcs; + int i = MyProc - ProcGlobal->allProcs; + if (nesting_level == 0) pgws_proc_queryids[i] = UINT64CONST(0); @@ -1081,10 +1113,10 @@ pgws_ProcessUtility(PlannedStmt *pstmt, #else char *completionTag #endif - ) +) { - int i = MyProc - ProcGlobal->allProcs; - uint64 save_queryId = 0; + int i = MyProc - ProcGlobal->allProcs; + uint64 save_queryId = 0; if (pgws_enabled(nesting_level)) { @@ -1096,18 +1128,18 @@ pgws_ProcessUtility(PlannedStmt *pstmt, PG_TRY(); { if (prev_ProcessUtility) - prev_ProcessUtility (pstmt, queryString, + prev_ProcessUtility(pstmt, queryString, #if PG_VERSION_NUM >= 140000 - readOnlyTree, + readOnlyTree, #endif - context, params, queryEnv, - dest, + context, params, queryEnv, + dest, #if PG_VERSION_NUM >= 130000 - qc + qc #else - completionTag + completionTag #endif - ); + ); else standard_ProcessUtility(pstmt, queryString, #if PG_VERSION_NUM >= 140000 @@ -1120,7 +1152,7 @@ pgws_ProcessUtility(PlannedStmt *pstmt, #else completionTag #endif - ); + ); nesting_level--; if (nesting_level == 0) pgws_proc_queryids[i] = UINT64CONST(0); diff --git a/pg_wait_sampling.h b/pg_wait_sampling.h index 141269a..dab773c 100644 --- a/pg_wait_sampling.h +++ b/pg_wait_sampling.h @@ -2,7 +2,7 @@ * pg_wait_sampling.h * Headers for pg_wait_sampling extension. * - * Copyright (c) 2015-2016, Postgres Professional + * Copyright (c) 2015-2025, Postgres Professional * * IDENTIFICATION * contrib/pg_wait_sampling/pg_wait_sampling.h @@ -10,11 +10,10 @@ #ifndef __PG_WAIT_SAMPLING_H__ #define __PG_WAIT_SAMPLING_H__ -#include "postgres.h" - -#include "storage/proc.h" +#include "datatype/timestamp.h" +#include "storage/latch.h" +#include "storage/lock.h" #include "storage/shm_mq.h" -#include "utils/timestamp.h" #define PG_WAIT_SAMPLING_MAGIC 0xCA94B107 #define COLLECTOR_QUEUE_SIZE (16 * 1024) @@ -24,26 +23,26 @@ typedef struct { - int pid; - uint32 wait_event_info; - uint64 queryId; - uint64 count; + int pid; + uint32 wait_event_info; + uint64 queryId; + uint64 count; } ProfileItem; typedef struct { - int pid; - uint32 wait_event_info; - uint64 queryId; - TimestampTz ts; + int pid; + uint32 wait_event_info; + uint64 queryId; + TimestampTz ts; } HistoryItem; typedef struct { - bool wraparound; - Size index; - Size count; - HistoryItem *items; + bool wraparound; + Size index; + Size count; + HistoryItem *items; } History; typedef enum @@ -56,22 +55,22 @@ typedef enum typedef struct { - Latch *latch; - SHMRequest request; + Latch *latch; + SHMRequest request; } CollectorShmqHeader; /* GUC variables */ -extern int pgws_historySize; -extern int pgws_historyPeriod; -extern int pgws_profilePeriod; +extern int pgws_historySize; +extern int pgws_historyPeriod; +extern int pgws_profilePeriod; extern bool pgws_profilePid; -extern int pgws_profileQueries; +extern int pgws_profileQueries; extern bool pgws_sampleCpu; /* pg_wait_sampling.c */ extern CollectorShmqHeader *pgws_collector_hdr; -extern shm_mq *pgws_collector_mq; -extern uint64 *pgws_proc_queryids; +extern shm_mq *pgws_collector_mq; +extern uint64 *pgws_proc_queryids; extern void pgws_init_lock_tag(LOCKTAG *tag, uint32 lock); extern bool pgws_should_sample_proc(PGPROC *proc, int *pid_p, uint32 *wait_event_info_p);