pgstat_function.c File Reference

#include "postgres.h"
#include "fmgr.h"
#include "utils/inval.h"
#include "utils/pgstat_internal.h"
#include "utils/syscache.h"

Include dependency graph for pgstat_function.c:

Go to the source code of this file.

Functions
void	pgstat_create_function (Oid proid)
void	pgstat_drop_function (Oid proid)
void	pgstat_init_function_usage (FunctionCallInfo fcinfo, PgStat_FunctionCallUsage *fcu)
void	pgstat_end_function_usage (PgStat_FunctionCallUsage *fcu, bool finalize)
bool	pgstat_function_flush_cb (PgStat_EntryRef *entry_ref, bool nowait)
PgStat_FunctionCounts *	find_funcstat_entry (Oid func_id)
PgStat_StatFuncEntry *	pgstat_fetch_stat_funcentry (Oid func_id)

Variables
int	pgstat_track_functions = TRACK_FUNC_OFF
static instr_time	total_func_time

Function Documentation

find_funcstat_entry()

PgStat_FunctionCounts* find_funcstat_entry

(

Oid

func_id

)

Definition at line 223 of file pgstat_function.c.

{
    PgStat_EntryRef *entry_ref;
 
    entry_ref = pgstat_fetch_pending_entry(PGSTAT_KIND_FUNCTION, MyDatabaseId, func_id);
 
    if (entry_ref)
        return entry_ref->pending;
    return NULL;
}

References MyDatabaseId, PgStat_EntryRef::pending, pgstat_fetch_pending_entry(), and PGSTAT_KIND_FUNCTION.

Referenced by pg_stat_get_xact_function_calls().

pgstat_create_function()

void pgstat_create_function

(

Oid

proid

)

Definition at line 45 of file pgstat_function.c.

{
    pgstat_create_transactional(PGSTAT_KIND_FUNCTION,
                                MyDatabaseId,
                                proid);
}

References MyDatabaseId, pgstat_create_transactional(), and PGSTAT_KIND_FUNCTION.

Referenced by ProcedureCreate().

pgstat_drop_function()

void pgstat_drop_function

(

Oid

proid

)

Definition at line 60 of file pgstat_function.c.

{
    pgstat_drop_transactional(PGSTAT_KIND_FUNCTION,
                              MyDatabaseId,
                              proid);
}

References MyDatabaseId, pgstat_drop_transactional(), and PGSTAT_KIND_FUNCTION.

Referenced by RemoveFunctionById().

pgstat_end_function_usage()

void pgstat_end_function_usage	(	PgStat_FunctionCallUsage *	fcu,
		bool	finalize
	)

Definition at line 146 of file pgstat_function.c.

{
    PgStat_FunctionCounts *fs = fcu->fs;
    instr_time  total;
    instr_time  others;
    instr_time  self;
 
    /* stats not wanted? */
    if (fs == NULL)
        return;
 
    /* total elapsed time in this function call */
    INSTR_TIME_SET_CURRENT(total);
    INSTR_TIME_SUBTRACT(total, fcu->start);
 
    /* self usage: elapsed minus anything already charged to other calls */
    others = total_func_time;
    INSTR_TIME_SUBTRACT(others, fcu->save_total);
    self = total;
    INSTR_TIME_SUBTRACT(self, others);
 
    /* update backend-wide total time */
    INSTR_TIME_ADD(total_func_time, self);
 
    /*
     * Compute the new total_time as the total elapsed time added to the
     * pre-call value of total_time.  This is necessary to avoid
     * double-counting any time taken by recursive calls of myself.  (We do
     * not need any similar kluge for self time, since that already excludes
     * any recursive calls.)
     */
    INSTR_TIME_ADD(total, fcu->save_f_total_time);
 
    /* update counters in function stats table */
    if (finalize)
        fs->numcalls++;
    fs->total_time = total;
    INSTR_TIME_ADD(fs->self_time, self);
}

References PgStat_FunctionCallUsage::fs, INSTR_TIME_ADD, INSTR_TIME_SET_CURRENT, INSTR_TIME_SUBTRACT, PgStat_FunctionCounts::numcalls, PgStat_FunctionCallUsage::save_f_total_time, PgStat_FunctionCallUsage::save_total, PgStat_FunctionCounts::self_time, PgStat_FunctionCallUsage::start, total_func_time, and PgStat_FunctionCounts::total_time.

Referenced by call_pltcl_start_proc(), EventTriggerInvoke(), ExecCallTriggerFunc(), ExecEvalFuncExprFusage(), ExecEvalFuncExprStrictFusage(), ExecMakeFunctionResultSet(), ExecMakeTableFunctionResult(), ExecuteCallStmt(), and fmgr_security_definer().

pgstat_fetch_stat_funcentry()

PgStat_StatFuncEntry* pgstat_fetch_stat_funcentry

(

Oid

func_id

)

Definition at line 239 of file pgstat_function.c.

{
    return (PgStat_StatFuncEntry *)
        pgstat_fetch_entry(PGSTAT_KIND_FUNCTION, MyDatabaseId, func_id);
}

References MyDatabaseId, pgstat_fetch_entry(), and PGSTAT_KIND_FUNCTION.

Referenced by pg_stat_get_function_calls().

pgstat_function_flush_cb()

bool pgstat_function_flush_cb	(	PgStat_EntryRef *	entry_ref,
		bool	nowait
	)

Definition at line 193 of file pgstat_function.c.

{
    PgStat_FunctionCounts *localent;
    PgStatShared_Function *shfuncent;
 
    localent = (PgStat_FunctionCounts *) entry_ref->pending;
    shfuncent = (PgStatShared_Function *) entry_ref->shared_stats;
 
    /* localent always has non-zero content */
 
    if (!pgstat_lock_entry(entry_ref, nowait))
        return false;
 
    shfuncent->stats.numcalls += localent->numcalls;
    shfuncent->stats.total_time +=
        INSTR_TIME_GET_MICROSEC(localent->total_time);
    shfuncent->stats.self_time +=
        INSTR_TIME_GET_MICROSEC(localent->self_time);
 
    pgstat_unlock_entry(entry_ref);
 
    return true;
}

References INSTR_TIME_GET_MICROSEC, PgStat_FunctionCounts::numcalls, PgStat_StatFuncEntry::numcalls, PgStat_EntryRef::pending, pgstat_lock_entry(), pgstat_unlock_entry(), PgStat_FunctionCounts::self_time, PgStat_StatFuncEntry::self_time, PgStat_EntryRef::shared_stats, PgStatShared_Function::stats, PgStat_FunctionCounts::total_time, and PgStat_StatFuncEntry::total_time.

pgstat_init_function_usage()

void pgstat_init_function_usage	(	FunctionCallInfo	fcinfo,
		PgStat_FunctionCallUsage *	fcu
	)

Definition at line 72 of file pgstat_function.c.

{
    PgStat_EntryRef *entry_ref;
    PgStat_FunctionCounts *pending;
    bool        created_entry;
 
    if (pgstat_track_functions <= fcinfo->flinfo->fn_stats)
    {
        /* stats not wanted */
        fcu->fs = NULL;
        return;
    }
 
    entry_ref = pgstat_prep_pending_entry(PGSTAT_KIND_FUNCTION,
                                          MyDatabaseId,
                                          fcinfo->flinfo->fn_oid,
                                          &created_entry);
 
    /*
     * If no shared entry already exists, check if the function has been
     * deleted concurrently. This can go unnoticed until here because
     * executing a statement that just calls a function, does not trigger
     * cache invalidation processing. The reason we care about this case is
     * that otherwise we could create a new stats entry for an already dropped
     * function (for relations etc this is not possible because emitting stats
     * requires a lock for the relation to already have been acquired).
     *
     * It's somewhat ugly to have a behavioral difference based on
     * track_functions being enabled/disabled. But it seems acceptable, given
     * that there's already behavioral differences depending on whether the
     * function is the caches etc.
     *
     * For correctness it'd be sufficient to set ->dropped to true. However,
     * the accepted invalidation will commonly cause "low level" failures in
     * PL code, with an OID in the error message. Making this harder to
     * test...
     */
    if (created_entry)
    {
        AcceptInvalidationMessages();
        if (!SearchSysCacheExists1(PROCOID, ObjectIdGetDatum(fcinfo->flinfo->fn_oid)))
        {
            pgstat_drop_entry(PGSTAT_KIND_FUNCTION, MyDatabaseId,
                              fcinfo->flinfo->fn_oid);
            ereport(ERROR, errcode(ERRCODE_UNDEFINED_FUNCTION),
                    errmsg("function call to dropped function"));
        }
    }
 
    pending = entry_ref->pending;
 
    fcu->fs = pending;
 
    /* save stats for this function, later used to compensate for recursion */
    fcu->save_f_total_time = pending->total_time;
 
    /* save current backend-wide total time */
    fcu->save_total = total_func_time;
 
    /* get clock time as of function start */
    INSTR_TIME_SET_CURRENT(fcu->start);
}

References AcceptInvalidationMessages(), ereport, errcode(), errmsg(), ERROR, FunctionCallInfoBaseData::flinfo, FmgrInfo::fn_oid, PgStat_FunctionCallUsage::fs, INSTR_TIME_SET_CURRENT, MyDatabaseId, ObjectIdGetDatum(), PgStat_EntryRef::pending, pgstat_drop_entry(), PGSTAT_KIND_FUNCTION, pgstat_prep_pending_entry(), PgStat_FunctionCallUsage::save_f_total_time, PgStat_FunctionCallUsage::save_total, SearchSysCacheExists1, PgStat_FunctionCallUsage::start, total_func_time, and PgStat_FunctionCounts::total_time.

Referenced by call_pltcl_start_proc(), EventTriggerInvoke(), ExecCallTriggerFunc(), ExecEvalFuncExprFusage(), ExecEvalFuncExprStrictFusage(), ExecMakeFunctionResultSet(), ExecMakeTableFunctionResult(), ExecuteCallStmt(), and fmgr_security_definer().

Variable Documentation

pgstat_track_functions

int pgstat_track_functions = TRACK_FUNC_OFF

Definition at line 30 of file pgstat_function.c.

total_func_time

instr_time total_func_time

static

Definition at line 38 of file pgstat_function.c.

Referenced by pgstat_end_function_usage(), and pgstat_init_function_usage().