test_custom_fixed_stats.c File Reference

#include "postgres.h"
#include "access/htup_details.h"
#include "funcapi.h"
#include "pgstat.h"
#include "utils/builtins.h"
#include "utils/pgstat_internal.h"
#include "utils/timestamp.h"

Include dependency graph for test_custom_fixed_stats.c:

Go to the source code of this file.

Data Structures
struct	PgStat_StatCustomFixedEntry
struct	PgStatShared_CustomFixedEntry

Macros
#define	PGSTAT_KIND_TEST_CUSTOM_FIXED_STATS   26
#define	FIXED_COMP(fld)   stat_snap->fld -= reset.fld;

Typedefs
typedef struct PgStat_StatCustomFixedEntry	PgStat_StatCustomFixedEntry
typedef struct PgStatShared_CustomFixedEntry	PgStatShared_CustomFixedEntry

Functions
	PG_MODULE_MAGIC_EXT (.name="test_custom_fixed_stats",.version=PG_VERSION)
static void	test_custom_stats_fixed_init_shmem_cb (void *stats)
static void	test_custom_stats_fixed_reset_all_cb (TimestampTz ts)
static void	test_custom_stats_fixed_snapshot_cb (void)
void	_PG_init (void)
	PG_FUNCTION_INFO_V1 (test_custom_stats_fixed_update)
Datum	test_custom_stats_fixed_update (PG_FUNCTION_ARGS)
	PG_FUNCTION_INFO_V1 (test_custom_stats_fixed_reset)
Datum	test_custom_stats_fixed_reset (PG_FUNCTION_ARGS)
	PG_FUNCTION_INFO_V1 (test_custom_stats_fixed_report)
Datum	test_custom_stats_fixed_report (PG_FUNCTION_ARGS)

Variables
static const PgStat_KindInfo	custom_stats

Macro Definition Documentation

FIXED_COMP

#define FIXED_COMP

(

fld

)

stat_snap->fld -= reset.fld;

PGSTAT_KIND_TEST_CUSTOM_FIXED_STATS

#define PGSTAT_KIND_TEST_CUSTOM_FIXED_STATS   26

Definition at line 65 of file test_custom_fixed_stats.c.

Typedef Documentation

PgStat_StatCustomFixedEntry

typedef struct PgStat_StatCustomFixedEntry PgStat_StatCustomFixedEntry

PgStatShared_CustomFixedEntry

typedef struct PgStatShared_CustomFixedEntry PgStatShared_CustomFixedEntry

Function Documentation

_PG_init()

void _PG_init

(

void

)

Definition at line 73 of file test_custom_fixed_stats.c.

{
    /* Register custom statistics kind */
    pgstat_register_kind(PGSTAT_KIND_TEST_CUSTOM_FIXED_STATS, &custom_stats);
}

References custom_stats, PGSTAT_KIND_TEST_CUSTOM_FIXED_STATS, and pgstat_register_kind().

PG_FUNCTION_INFO_V1() [1/3]

PG_FUNCTION_INFO_V1

(

test_custom_stats_fixed_report

)

PG_FUNCTION_INFO_V1() [2/3]

PG_FUNCTION_INFO_V1

(

test_custom_stats_fixed_reset

)

PG_FUNCTION_INFO_V1() [3/3]

PG_FUNCTION_INFO_V1

(

test_custom_stats_fixed_update

)

PG_MODULE_MAGIC_EXT()

PG_MODULE_MAGIC_EXT	(	.	name = "test_custom_fixed_stats",
		.	version = PG_VERSION
	)

test_custom_stats_fixed_init_shmem_cb()

static void test_custom_stats_fixed_init_shmem_cb ( void *  stats )

static

Definition at line 84 of file test_custom_fixed_stats.c.

{
    PgStatShared_CustomFixedEntry *stats_shmem =
        (PgStatShared_CustomFixedEntry *) stats;
 
    LWLockInitialize(&stats_shmem->lock, LWTRANCHE_PGSTATS_DATA);
}

References fb(), and LWLockInitialize().

test_custom_stats_fixed_report()

Datum test_custom_stats_fixed_report

(

PG_FUNCTION_ARGS

)

Definition at line 188 of file test_custom_fixed_stats.c.

{
    TupleDesc   tupdesc;
    Datum       values[2] = {0};
    bool        nulls[2] = {false};
    PgStat_StatCustomFixedEntry *stats;
 
    /* Take snapshot (applies reset offsets) */
    pgstat_snapshot_fixed(PGSTAT_KIND_TEST_CUSTOM_FIXED_STATS);
    stats = pgstat_get_custom_snapshot_data(PGSTAT_KIND_TEST_CUSTOM_FIXED_STATS);
 
    /* Build return tuple */
    tupdesc = CreateTemplateTupleDesc(2);
    TupleDescInitEntry(tupdesc, (AttrNumber) 1, "numcalls",
                       INT8OID, -1, 0);
    TupleDescInitEntry(tupdesc, (AttrNumber) 2, "stats_reset",
                       TIMESTAMPTZOID, -1, 0);
    TupleDescFinalize(tupdesc);
    BlessTupleDesc(tupdesc);
 
    values[0] = Int64GetDatum(stats->numcalls);
 
    /* Handle uninitialized timestamp (no reset yet) */
    if (stats->stat_reset_timestamp == 0)
    {
        nulls[1] = true;
    }
    else
    {
        values[1] = TimestampTzGetDatum(stats->stat_reset_timestamp);
    }
 
    /* Return as tuple */
    PG_RETURN_DATUM(HeapTupleGetDatum(heap_form_tuple(tupdesc, values, nulls)));
}

References BlessTupleDesc(), CreateTemplateTupleDesc(), fb(), heap_form_tuple(), HeapTupleGetDatum(), Int64GetDatum(), PgStat_StatCustomFixedEntry::numcalls, PG_RETURN_DATUM, pgstat_get_custom_snapshot_data(), PGSTAT_KIND_TEST_CUSTOM_FIXED_STATS, pgstat_snapshot_fixed(), PgStat_StatCustomFixedEntry::stat_reset_timestamp, TimestampTzGetDatum(), TupleDescFinalize(), TupleDescInitEntry(), and values.

test_custom_stats_fixed_reset()

Datum test_custom_stats_fixed_reset

(

PG_FUNCTION_ARGS

)

Definition at line 175 of file test_custom_fixed_stats.c.

{
    pgstat_reset_of_kind(PGSTAT_KIND_TEST_CUSTOM_FIXED_STATS);
 
    PG_RETURN_VOID();
}

References PG_RETURN_VOID, PGSTAT_KIND_TEST_CUSTOM_FIXED_STATS, and pgstat_reset_of_kind().

test_custom_stats_fixed_reset_all_cb()

static void test_custom_stats_fixed_reset_all_cb ( TimestampTz  ts )

static

Definition at line 97 of file test_custom_fixed_stats.c.

{
    PgStatShared_CustomFixedEntry *stats_shmem =
        pgstat_get_custom_shmem_data(PGSTAT_KIND_TEST_CUSTOM_FIXED_STATS);
 
    /* see explanation above PgStatShared_Archiver for the reset protocol */
    LWLockAcquire(&stats_shmem->lock, LW_EXCLUSIVE);
    pgstat_copy_changecounted_stats(&stats_shmem->reset_offset,
                                    &stats_shmem->stats,
                                    sizeof(stats_shmem->stats),
                                    &stats_shmem->changecount);
    stats_shmem->stats.stat_reset_timestamp = ts;
    LWLockRelease(&stats_shmem->lock);
}

References fb(), LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), pgstat_copy_changecounted_stats(), pgstat_get_custom_shmem_data(), and PGSTAT_KIND_TEST_CUSTOM_FIXED_STATS.

test_custom_stats_fixed_snapshot_cb()

static void test_custom_stats_fixed_snapshot_cb ( void  )

static

Definition at line 117 of file test_custom_fixed_stats.c.

{
    PgStatShared_CustomFixedEntry *stats_shmem =
        pgstat_get_custom_shmem_data(PGSTAT_KIND_TEST_CUSTOM_FIXED_STATS);
    PgStat_StatCustomFixedEntry *stat_snap =
        pgstat_get_custom_snapshot_data(PGSTAT_KIND_TEST_CUSTOM_FIXED_STATS);
    PgStat_StatCustomFixedEntry *reset_offset = &stats_shmem->reset_offset;
    PgStat_StatCustomFixedEntry reset;
 
    pgstat_copy_changecounted_stats(stat_snap,
                                    &stats_shmem->stats,
                                    sizeof(stats_shmem->stats),
                                    &stats_shmem->changecount);
 
    LWLockAcquire(&stats_shmem->lock, LW_SHARED);
    memcpy(&reset, reset_offset, sizeof(stats_shmem->stats));
    LWLockRelease(&stats_shmem->lock);
 
    /* Apply reset offsets */
#define FIXED_COMP(fld) stat_snap->fld -= reset.fld;
    FIXED_COMP(numcalls);
#undef FIXED_COMP
}

References fb(), FIXED_COMP, LW_SHARED, LWLockAcquire(), LWLockRelease(), memcpy(), pgstat_copy_changecounted_stats(), pgstat_get_custom_shmem_data(), pgstat_get_custom_snapshot_data(), PGSTAT_KIND_TEST_CUSTOM_FIXED_STATS, and reset().

test_custom_stats_fixed_update()

Datum test_custom_stats_fixed_update

(

PG_FUNCTION_ARGS

)

Definition at line 152 of file test_custom_fixed_stats.c.

{
    PgStatShared_CustomFixedEntry *stats_shmem;
 
    stats_shmem = pgstat_get_custom_shmem_data(PGSTAT_KIND_TEST_CUSTOM_FIXED_STATS);
 
    LWLockAcquire(&stats_shmem->lock, LW_EXCLUSIVE);
 
    pgstat_begin_changecount_write(&stats_shmem->changecount);
    stats_shmem->stats.numcalls++;
    pgstat_end_changecount_write(&stats_shmem->changecount);
 
    LWLockRelease(&stats_shmem->lock);
 
    PG_RETURN_VOID();
}

References fb(), LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), PG_RETURN_VOID, pgstat_begin_changecount_write(), pgstat_end_changecount_write(), pgstat_get_custom_shmem_data(), and PGSTAT_KIND_TEST_CUSTOM_FIXED_STATS.

Variable Documentation

custom_stats

const PgStat_KindInfo custom_stats

static

Initial value:

= {
    .name = "test_custom_fixed_stats",
    .fixed_amount = true,       
    .write_to_file = true,      
 
    .shared_size = sizeof(PgStatShared_CustomFixedEntry),
    .shared_data_off = offsetof(PgStatShared_CustomFixedEntry, stats),
    .shared_data_len = sizeof(((PgStatShared_CustomFixedEntry *) 0)->stats),
 
    .init_shmem_cb = test_custom_stats_fixed_init_shmem_cb,
    .reset_all_cb = test_custom_stats_fixed_reset_all_cb,
    .snapshot_cb = test_custom_stats_fixed_snapshot_cb,
}

Definition at line 48 of file test_custom_fixed_stats.c.

                                            {
    .name = "test_custom_fixed_stats",
    .fixed_amount = true,       /* exactly one entry */
    .write_to_file = true,      /* persist to stats file */
 
    .shared_size = sizeof(PgStatShared_CustomFixedEntry),
    .shared_data_off = offsetof(PgStatShared_CustomFixedEntry, stats),
    .shared_data_len = sizeof(((PgStatShared_CustomFixedEntry *) 0)->stats),
 
    .init_shmem_cb = test_custom_stats_fixed_init_shmem_cb,
    .reset_all_cb = test_custom_stats_fixed_reset_all_cb,
    .snapshot_cb = test_custom_stats_fixed_snapshot_cb,
};

Referenced by _PG_init().