#include "postgres.h"
#include "access/xlog.h"
#include "executor/instrument.h"
#include "storage/bufmgr.h"
#include "storage/proc.h"
#include "storage/procarray.h"
#include "utils/memutils.h"
#include "utils/pgstat_internal.h"

Include dependency graph for pgstat_backend.c:

Macros
#define	WALSTAT_ACC(fld, var_to_add) (bktype_shstats->fld += var_to_add.fld)

Functions
void	pgstat_count_backend_io_op_time (IOObject io_object, IOContext io_context, IOOp io_op, instr_time io_time)

void	pgstat_count_backend_io_op (IOObject io_object, IOContext io_context, IOOp io_op, uint32 cnt, uint64 bytes)

PgStat_Backend *	pgstat_fetch_stat_backend (ProcNumber procNumber)

PgStat_Backend *	pgstat_fetch_stat_backend_by_pid (int pid, BackendType *bktype)

static void	pgstat_flush_backend_entry_io (PgStat_EntryRef *entry_ref)

static bool	pgstat_backend_wal_have_pending (void)

static void	pgstat_flush_backend_entry_wal (PgStat_EntryRef *entry_ref)

bool	pgstat_flush_backend (bool nowait, bits32 flags)

bool	pgstat_backend_flush_cb (bool nowait)

void	pgstat_create_backend (ProcNumber procnum)

bool	pgstat_tracks_backend_bktype (BackendType bktype)

void	pgstat_backend_reset_timestamp_cb (PgStatShared_Common *header, TimestampTz ts)

Variables
static PgStat_BackendPending	PendingBackendStats

static bool	backend_has_iostats = false

static WalUsage	prevBackendWalUsage

Macro Definition Documentation

◆ WALSTAT_ACC

#define WALSTAT_ACC	(	fld,
		var_to_add
	)	(bktype_shstats->fld += var_to_add.fld)

Function Documentation

◆ pgstat_backend_flush_cb()

bool pgstat_backend_flush_cb ( bool nowait )

Definition at line 314 of file pgstat_backend.c.

{
    return pgstat_flush_backend(nowait, PGSTAT_BACKEND_FLUSH_ALL);
}

References PGSTAT_BACKEND_FLUSH_ALL, and pgstat_flush_backend().

◆ pgstat_backend_reset_timestamp_cb()

void pgstat_backend_reset_timestamp_cb	(	PgStatShared_Common *	header,
		TimestampTz	ts
	)

Definition at line 401 of file pgstat_backend.c.

{
    ((PgStatShared_Backend *) header)->stats.stat_reset_timestamp = ts;
}

◆ pgstat_backend_wal_have_pending()

static bool pgstat_backend_wal_have_pending ( void )

inlinestatic

Definition at line 216 of file pgstat_backend.c.

{
    return (pgWalUsage.wal_records != prevBackendWalUsage.wal_records);
}

References pgWalUsage, prevBackendWalUsage, and WalUsage::wal_records.

Referenced by pgstat_flush_backend(), and pgstat_flush_backend_entry_wal().

◆ pgstat_count_backend_io_op()

void pgstat_count_backend_io_op	(	IOObject	io_object,
		IOContext	io_context,
		IOOp	io_op,
		uint32	cnt,
		uint64	bytes
	)

Definition at line 74 of file pgstat_backend.c.

{
    if (!pgstat_tracks_backend_bktype(MyBackendType))
        return;
 
    Assert(pgstat_tracks_io_op(MyBackendType, io_object, io_context, io_op));
 
    PendingBackendStats.pending_io.counts[io_object][io_context][io_op] += cnt;
    PendingBackendStats.pending_io.bytes[io_object][io_context][io_op] += bytes;
 
    backend_has_iostats = true;
    pgstat_report_fixed = true;
}

References Assert, backend_has_iostats, PgStat_PendingIO::bytes, PgStat_PendingIO::counts, fb(), MyBackendType, PgStat_BackendPending::pending_io, PendingBackendStats, pgstat_report_fixed, pgstat_tracks_backend_bktype(), and pgstat_tracks_io_op().

Referenced by pgstat_count_io_op().

◆ pgstat_count_backend_io_op_time()

void pgstat_count_backend_io_op_time	(	IOObject	io_object,
		IOContext	io_context,
		IOOp	io_op,
		instr_time	io_time
	)

Definition at line 56 of file pgstat_backend.c.

{
    Assert(track_io_timing || track_wal_io_timing);
 
    if (!pgstat_tracks_backend_bktype(MyBackendType))
        return;
 
    Assert(pgstat_tracks_io_op(MyBackendType, io_object, io_context, io_op));
 
    INSTR_TIME_ADD(PendingBackendStats.pending_io.pending_times[io_object][io_context][io_op],
                   io_time);
 
    backend_has_iostats = true;
    pgstat_report_fixed = true;
}

References Assert, backend_has_iostats, fb(), INSTR_TIME_ADD, MyBackendType, PgStat_BackendPending::pending_io, PgStat_PendingIO::pending_times, PendingBackendStats, pgstat_report_fixed, pgstat_tracks_backend_bktype(), pgstat_tracks_io_op(), track_io_timing, and track_wal_io_timing.

Referenced by pgstat_count_io_op_time().

◆ pgstat_create_backend()

void pgstat_create_backend ( ProcNumber procnum )

Definition at line 323 of file pgstat_backend.c.

{
    PgStat_EntryRef *entry_ref;
    PgStatShared_Backend *shstatent;
 
    entry_ref = pgstat_get_entry_ref_locked(PGSTAT_KIND_BACKEND, InvalidOid,
                                            MyProcNumber, false);
    shstatent = (PgStatShared_Backend *) entry_ref->shared_stats;
 
    /*
     * NB: need to accept that there might be stats from an older backend,
     * e.g. if we previously used this proc number.
     */
    memset(&shstatent->stats, 0, sizeof(shstatent->stats));
    pgstat_unlock_entry(entry_ref);
 
    MemSet(&PendingBackendStats, 0, sizeof(PgStat_BackendPending));
    backend_has_iostats = false;
 
    /*
     * Initialize prevBackendWalUsage with pgWalUsage so that
     * pgstat_backend_flush_cb() can calculate how much pgWalUsage counters
     * are increased by subtracting prevBackendWalUsage from pgWalUsage.
     */
    prevBackendWalUsage = pgWalUsage;
}

References backend_has_iostats, fb(), InvalidOid, MemSet, MyProcNumber, PendingBackendStats, pgstat_get_entry_ref_locked(), PGSTAT_KIND_BACKEND, pgstat_unlock_entry(), pgWalUsage, prevBackendWalUsage, and PgStat_EntryRef::shared_stats.

Referenced by pgstat_bestart_final().

◆ pgstat_fetch_stat_backend()

PgStat_Backend * pgstat_fetch_stat_backend ( ProcNumber procNumber )

Definition at line 93 of file pgstat_backend.c.

{
    PgStat_Backend *backend_entry;
 
    backend_entry = (PgStat_Backend *) pgstat_fetch_entry(PGSTAT_KIND_BACKEND,
                                                          InvalidOid, procNumber);
 
    return backend_entry;
}

References fb(), InvalidOid, pgstat_fetch_entry(), and PGSTAT_KIND_BACKEND.

Referenced by pgstat_fetch_stat_backend_by_pid().

◆ pgstat_fetch_stat_backend_by_pid()

PgStat_Backend * pgstat_fetch_stat_backend_by_pid	(	int	pid,
		BackendType *	bktype
	)

Definition at line 111 of file pgstat_backend.c.

{
    PGPROC     *proc;
    PgBackendStatus *beentry;
    ProcNumber  procNumber;
    PgStat_Backend *backend_stats;
 
    proc = BackendPidGetProc(pid);
    if (bktype)
        *bktype = B_INVALID;
 
    /* this could be an auxiliary process */
    if (!proc)
        proc = AuxiliaryPidGetProc(pid);
 
    if (!proc)
        return NULL;
 
    procNumber = GetNumberFromPGProc(proc);
 
    beentry = pgstat_get_beentry_by_proc_number(procNumber);
    if (!beentry)
        return NULL;
 
    /* check if the backend type tracks statistics */
    if (!pgstat_tracks_backend_bktype(beentry->st_backendType))
        return NULL;
 
    /* if PID does not match, leave */
    if (beentry->st_procpid != pid)
        return NULL;
 
    if (bktype)
        *bktype = beentry->st_backendType;
 
    /*
     * Retrieve the entry.  Note that "beentry" may be freed depending on the
     * value of stats_fetch_consistency, so do not access it from this point.
     */
    backend_stats = pgstat_fetch_stat_backend(procNumber);
    if (!backend_stats)
    {
        if (bktype)
            *bktype = B_INVALID;
        return NULL;
    }
 
    return backend_stats;
}

References AuxiliaryPidGetProc(), B_INVALID, BackendPidGetProc(), fb(), GetNumberFromPGProc, pgstat_fetch_stat_backend(), pgstat_get_beentry_by_proc_number(), and pgstat_tracks_backend_bktype().

Referenced by pg_stat_get_backend_io(), and pg_stat_get_backend_wal().

◆ pgstat_flush_backend()

bool pgstat_flush_backend	(	bool	nowait,
		bits32	flags
	)

Definition at line 271 of file pgstat_backend.c.

{
    PgStat_EntryRef *entry_ref;
    bool        has_pending_data = false;
 
    if (!pgstat_tracks_backend_bktype(MyBackendType))
        return false;
 
    /* Some IO data pending? */
    if ((flags & PGSTAT_BACKEND_FLUSH_IO) && backend_has_iostats)
        has_pending_data = true;
 
    /* Some WAL data pending? */
    if ((flags & PGSTAT_BACKEND_FLUSH_WAL) &&
        pgstat_backend_wal_have_pending())
        has_pending_data = true;
 
    if (!has_pending_data)
        return false;
 
    entry_ref = pgstat_get_entry_ref_locked(PGSTAT_KIND_BACKEND, InvalidOid,
                                            MyProcNumber, nowait);
    if (!entry_ref)
        return true;
 
    /* Flush requested statistics */
    if (flags & PGSTAT_BACKEND_FLUSH_IO)
        pgstat_flush_backend_entry_io(entry_ref);
 
    if (flags & PGSTAT_BACKEND_FLUSH_WAL)
        pgstat_flush_backend_entry_wal(entry_ref);
 
    pgstat_unlock_entry(entry_ref);
 
    return false;
}

References backend_has_iostats, fb(), InvalidOid, MyBackendType, MyProcNumber, PGSTAT_BACKEND_FLUSH_IO, PGSTAT_BACKEND_FLUSH_WAL, pgstat_backend_wal_have_pending(), pgstat_flush_backend_entry_io(), pgstat_flush_backend_entry_wal(), pgstat_get_entry_ref_locked(), PGSTAT_KIND_BACKEND, pgstat_tracks_backend_bktype(), and pgstat_unlock_entry().

Referenced by pgstat_backend_flush_cb(), pgstat_report_analyze(), pgstat_report_vacuum(), pgstat_report_wal(), WalSndLoop(), and WalSndWaitForWal().

◆ pgstat_flush_backend_entry_io()

static void pgstat_flush_backend_entry_io ( PgStat_EntryRef * entry_ref )

static

Definition at line 166 of file pgstat_backend.c.

{
    PgStatShared_Backend *shbackendent;
    PgStat_BktypeIO *bktype_shstats;
    PgStat_PendingIO pending_io;
 
    /*
     * This function can be called even if nothing at all has happened for IO
     * statistics.  In this case, avoid unnecessarily modifying the stats
     * entry.
     */
    if (!backend_has_iostats)
        return;
 
    shbackendent = (PgStatShared_Backend *) entry_ref->shared_stats;
    bktype_shstats = &shbackendent->stats.io_stats;
    pending_io = PendingBackendStats.pending_io;
 
    for (int io_object = 0; io_object < IOOBJECT_NUM_TYPES; io_object++)
    {
        for (int io_context = 0; io_context < IOCONTEXT_NUM_TYPES; io_context++)
        {
            for (int io_op = 0; io_op < IOOP_NUM_TYPES; io_op++)
            {
                instr_time  time;
 
                bktype_shstats->counts[io_object][io_context][io_op] +=
                    pending_io.counts[io_object][io_context][io_op];
                bktype_shstats->bytes[io_object][io_context][io_op] +=
                    pending_io.bytes[io_object][io_context][io_op];
                time = pending_io.pending_times[io_object][io_context][io_op];
 
                bktype_shstats->times[io_object][io_context][io_op] +=
                    INSTR_TIME_GET_MICROSEC(time);
            }
        }
    }
 
    /*
     * Clear out the statistics buffer, so it can be re-used.
     */
    MemSet(&PendingBackendStats.pending_io, 0, sizeof(PgStat_PendingIO));
 
    backend_has_iostats = false;
}

References backend_has_iostats, PgStat_PendingIO::bytes, PgStat_PendingIO::counts, fb(), INSTR_TIME_GET_MICROSEC, IOCONTEXT_NUM_TYPES, IOOBJECT_NUM_TYPES, IOOP_NUM_TYPES, MemSet, PgStat_BackendPending::pending_io, PgStat_PendingIO::pending_times, PendingBackendStats, and PgStat_EntryRef::shared_stats.

Referenced by pgstat_flush_backend().

◆ pgstat_flush_backend_entry_wal()

static void pgstat_flush_backend_entry_wal ( PgStat_EntryRef * entry_ref )

static

Definition at line 226 of file pgstat_backend.c.

{
    PgStatShared_Backend *shbackendent;
    PgStat_WalCounters *bktype_shstats;
    WalUsage    wal_usage_diff = {0};
 
    /*
     * This function can be called even if nothing at all has happened for WAL
     * statistics.  In this case, avoid unnecessarily modifying the stats
     * entry.
     */
    if (!pgstat_backend_wal_have_pending())
        return;
 
    shbackendent = (PgStatShared_Backend *) entry_ref->shared_stats;
    bktype_shstats = &shbackendent->stats.wal_counters;
 
    /*
     * Calculate how much WAL usage counters were increased by subtracting the
     * previous counters from the current ones.
     */
    WalUsageAccumDiff(&wal_usage_diff, &pgWalUsage, &prevBackendWalUsage);
 
#define WALSTAT_ACC(fld, var_to_add) \
    (bktype_shstats->fld += var_to_add.fld)
    WALSTAT_ACC(wal_buffers_full, wal_usage_diff);
    WALSTAT_ACC(wal_records, wal_usage_diff);
    WALSTAT_ACC(wal_fpi, wal_usage_diff);
    WALSTAT_ACC(wal_bytes, wal_usage_diff);
    WALSTAT_ACC(wal_fpi_bytes, wal_usage_diff);
#undef WALSTAT_ACC
 
    /*
     * Save the current counters for the subsequent calculation of WAL usage.
     */
    prevBackendWalUsage = pgWalUsage;
}

References fb(), pgstat_backend_wal_have_pending(), pgWalUsage, prevBackendWalUsage, PgStat_EntryRef::shared_stats, WALSTAT_ACC, and WalUsageAccumDiff().

Referenced by pgstat_flush_backend().

◆ pgstat_tracks_backend_bktype()

bool pgstat_tracks_backend_bktype ( BackendType bktype )

Definition at line 366 of file pgstat_backend.c.

{
    /*
     * List every type so that new backend types trigger a warning about
     * needing to adjust this switch.
     */
    switch (bktype)
    {
        case B_INVALID:
        case B_AUTOVAC_LAUNCHER:
        case B_DEAD_END_BACKEND:
        case B_ARCHIVER:
        case B_LOGGER:
        case B_BG_WRITER:
        case B_CHECKPOINTER:
        case B_IO_WORKER:
        case B_STARTUP:
            return false;
 
        case B_AUTOVAC_WORKER:
        case B_BACKEND:
        case B_BG_WORKER:
        case B_STANDALONE_BACKEND:
        case B_SLOTSYNC_WORKER:
        case B_WAL_RECEIVER:
        case B_WAL_SENDER:
        case B_WAL_SUMMARIZER:
        case B_WAL_WRITER:
            return true;
    }
 
    return false;
}