stat_utils.h File Reference

#include "fmgr.h"

Include dependency graph for stat_utils.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	StatsArgInfo

Typedefs
typedef struct RangeVar	RangeVar

Functions
void	stats_check_required_arg (FunctionCallInfo fcinfo, struct StatsArgInfo *arginfo, int argnum)
bool	stats_check_arg_array (FunctionCallInfo fcinfo, struct StatsArgInfo *arginfo, int argnum)
bool	stats_check_arg_pair (FunctionCallInfo fcinfo, struct StatsArgInfo *arginfo, int argnum1, int argnum2)
void	RangeVarCallbackForStats (const RangeVar *relation, Oid relId, Oid oldRelid, void *arg)
bool	stats_fill_fcinfo_from_arg_pairs (FunctionCallInfo pairs_fcinfo, FunctionCallInfo positional_fcinfo, struct StatsArgInfo *arginfo)

Typedef Documentation

RangeVar

typedef struct RangeVar RangeVar

Definition at line 19 of file stat_utils.h.

Function Documentation

RangeVarCallbackForStats()

void RangeVarCallbackForStats	(	const RangeVar *	relation,
		Oid	relId,
		Oid	oldRelid,
		void *	arg
	)

Definition at line 131 of file stat_utils.c.

{
    Oid        *locked_oid = (Oid *) arg;
    Oid         table_oid = relId;
    HeapTuple   tuple;
    Form_pg_class form;
    char        relkind;
 
    /*
     * If we previously locked some other index's heap, and the name we're
     * looking up no longer refers to that relation, release the now-useless
     * lock.
     */
    if (relId != oldRelId && OidIsValid(*locked_oid))
    {
        UnlockRelationOid(*locked_oid, ShareUpdateExclusiveLock);
        *locked_oid = InvalidOid;
    }
 
    /* If the relation does not exist, there's nothing more to do. */
    if (!OidIsValid(relId))
        return;
 
    /* If the relation does exist, check whether it's an index. */
    relkind = get_rel_relkind(relId);
    if (relkind == RELKIND_INDEX ||
        relkind == RELKIND_PARTITIONED_INDEX)
        table_oid = IndexGetRelation(relId, false);
 
    /*
     * If retrying yields the same OID, there are a couple of extremely
     * unlikely scenarios we need to handle.
     */
    if (relId == oldRelId)
    {
        /*
         * If a previous lookup found an index, but the current lookup did
         * not, the index was dropped and the OID was reused for something
         * else between lookups.  In theory, we could simply drop our lock on
         * the index's parent table and proceed, but in the interest of
         * avoiding complexity, we just error.
         */
        if (table_oid == relId && OidIsValid(*locked_oid))
            ereport(ERROR,
                    (errcode(ERRCODE_UNDEFINED_OBJECT),
                     errmsg("index \"%s\" was concurrently dropped",
                            relation->relname)));
 
        /*
         * If the current lookup found an index but a previous lookup either
         * did not find an index or found one with a different parent
         * relation, the relation was dropped and the OID was reused for an
         * index between lookups.  RangeVarGetRelidExtended() will have
         * already locked the index at this point, so we can't just lock the
         * newly discovered parent table OID without risking deadlock.  As
         * above, we just error in this case.
         */
        if (table_oid != relId && table_oid != *locked_oid)
            ereport(ERROR,
                    (errcode(ERRCODE_UNDEFINED_OBJECT),
                     errmsg("index \"%s\" was concurrently created",
                            relation->relname)));
    }
 
    tuple = SearchSysCache1(RELOID, ObjectIdGetDatum(table_oid));
    if (!HeapTupleIsValid(tuple))
        elog(ERROR, "cache lookup failed for OID %u", table_oid);
    form = (Form_pg_class) GETSTRUCT(tuple);
 
    /* the relkinds that can be used with ANALYZE */
    switch (form->relkind)
    {
        case RELKIND_RELATION:
        case RELKIND_MATVIEW:
        case RELKIND_FOREIGN_TABLE:
        case RELKIND_PARTITIONED_TABLE:
            break;
        default:
            ereport(ERROR,
                    (errcode(ERRCODE_WRONG_OBJECT_TYPE),
                     errmsg("cannot modify statistics for relation \"%s\"",
                            NameStr(form->relname)),
                     errdetail_relkind_not_supported(form->relkind)));
    }
 
    if (form->relisshared)
        ereport(ERROR,
                (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
                 errmsg("cannot modify statistics for shared relation")));
 
    /* Check permissions */
    if (!object_ownercheck(DatabaseRelationId, MyDatabaseId, GetUserId()))
    {
        AclResult   aclresult = pg_class_aclcheck(table_oid,
                                                  GetUserId(),
                                                  ACL_MAINTAIN);
 
        if (aclresult != ACLCHECK_OK)
            aclcheck_error(aclresult,
                           get_relkind_objtype(form->relkind),
                           NameStr(form->relname));
    }
 
    ReleaseSysCache(tuple);
 
    /* Lock heap before index to avoid deadlock. */
    if (relId != oldRelId && table_oid != relId)
    {
        LockRelationOid(table_oid, ShareUpdateExclusiveLock);
        *locked_oid = table_oid;
    }
}

References ACL_MAINTAIN, aclcheck_error(), ACLCHECK_OK, arg, elog, ereport, errcode(), errdetail_relkind_not_supported(), errmsg(), ERROR, get_rel_relkind(), get_relkind_objtype(), GETSTRUCT(), GetUserId(), HeapTupleIsValid, IndexGetRelation(), InvalidOid, LockRelationOid(), MyDatabaseId, NameStr, object_ownercheck(), ObjectIdGetDatum(), OidIsValid, pg_class_aclcheck(), ReleaseSysCache(), RangeVar::relname, SearchSysCache1(), ShareUpdateExclusiveLock, and UnlockRelationOid().

Referenced by attribute_statistics_update(), pg_clear_attribute_stats(), and relation_statistics_update().

stats_check_arg_array()

bool stats_check_arg_array	(	FunctionCallInfo	fcinfo,
		struct StatsArgInfo *	arginfo,
		int	argnum
	)

Definition at line 59 of file stat_utils.c.

{
    ArrayType  *arr;
 
    if (PG_ARGISNULL(argnum))
        return true;
 
    arr = DatumGetArrayTypeP(PG_GETARG_DATUM(argnum));
 
    if (ARR_NDIM(arr) != 1)
    {
        ereport(WARNING,
                (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                 errmsg("argument \"%s\" must not be a multidimensional array",
                        arginfo[argnum].argname)));
        return false;
    }
 
    if (array_contains_nulls(arr))
    {
        ereport(WARNING,
                (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                 errmsg("argument \"%s\" array must not contain null values",
                        arginfo[argnum].argname)));
        return false;
    }
 
    return true;
}

References ARR_NDIM, array_contains_nulls(), DatumGetArrayTypeP, ereport, errcode(), errmsg(), PG_ARGISNULL, PG_GETARG_DATUM, and WARNING.

Referenced by attribute_statistics_update().

stats_check_arg_pair()

bool stats_check_arg_pair	(	FunctionCallInfo	fcinfo,
		struct StatsArgInfo *	arginfo,
		int	argnum1,
		int	argnum2
	)

Definition at line 100 of file stat_utils.c.

{
    if (PG_ARGISNULL(argnum1) && PG_ARGISNULL(argnum2))
        return true;
 
    if (PG_ARGISNULL(argnum1) || PG_ARGISNULL(argnum2))
    {
        int         nullarg = PG_ARGISNULL(argnum1) ? argnum1 : argnum2;
        int         otherarg = PG_ARGISNULL(argnum1) ? argnum2 : argnum1;
 
        ereport(WARNING,
                (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                 errmsg("argument \"%s\" must be specified when argument \"%s\" is specified",
                        arginfo[nullarg].argname,
                        arginfo[otherarg].argname)));
 
        return false;
    }
 
    return true;
}

References ereport, errcode(), errmsg(), PG_ARGISNULL, and WARNING.

Referenced by attribute_statistics_update().

stats_check_required_arg()

void stats_check_required_arg	(	FunctionCallInfo	fcinfo,
		struct StatsArgInfo *	arginfo,
		int	argnum
	)

Definition at line 40 of file stat_utils.c.

{
    if (PG_ARGISNULL(argnum))
        ereport(ERROR,
                (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                 errmsg("argument \"%s\" must not be null",
                        arginfo[argnum].argname)));
}

References ereport, errcode(), errmsg(), ERROR, and PG_ARGISNULL.

Referenced by attribute_statistics_update(), pg_clear_attribute_stats(), and relation_statistics_update().

stats_fill_fcinfo_from_arg_pairs()

bool stats_fill_fcinfo_from_arg_pairs	(	FunctionCallInfo	pairs_fcinfo,
		FunctionCallInfo	positional_fcinfo,
		struct StatsArgInfo *	arginfo
	)

Definition at line 293 of file stat_utils.c.

{
    Datum      *args;
    bool       *argnulls;
    Oid        *types;
    int         nargs;
    bool        result = true;
 
    /* clear positional args */
    for (int i = 0; arginfo[i].argname != NULL; i++)
    {
        positional_fcinfo->args[i].value = (Datum) 0;
        positional_fcinfo->args[i].isnull = true;
    }
 
    nargs = extract_variadic_args(pairs_fcinfo, 0, true,
                                  &args, &types, &argnulls);
 
    if (nargs % 2 != 0)
        ereport(ERROR,
                errmsg("variadic arguments must be name/value pairs"),
                errhint("Provide an even number of variadic arguments that can be divided into pairs."));
 
    /*
     * For each argument name/value pair, find corresponding positional
     * argument for the argument name, and assign the argument value to
     * positional_fcinfo.
     */
    for (int i = 0; i < nargs; i += 2)
    {
        int         argnum;
        char       *argname;
 
        if (argnulls[i])
            ereport(ERROR,
                    (errmsg("name at variadic position %d is null", i + 1)));
 
        if (types[i] != TEXTOID)
            ereport(ERROR,
                    (errmsg("name at variadic position %d has type %s, expected type %s",
                            i + 1, format_type_be(types[i]),
                            format_type_be(TEXTOID))));
 
        if (argnulls[i + 1])
            continue;
 
        argname = TextDatumGetCString(args[i]);
 
        /*
         * The 'version' argument is a special case, not handled by arginfo
         * because it's not a valid positional argument.
         *
         * For now, 'version' is accepted but ignored. In the future it can be
         * used to interpret older statistics properly.
         */
        if (pg_strcasecmp(argname, "version") == 0)
            continue;
 
        argnum = get_arg_by_name(argname, arginfo);
 
        if (argnum < 0 || !stats_check_arg_type(argname, types[i + 1],
                                                arginfo[argnum].argtype))
        {
            result = false;
            continue;
        }
 
        positional_fcinfo->args[argnum].value = args[i + 1];
        positional_fcinfo->args[argnum].isnull = false;
    }
 
    return result;
}

References StatsArgInfo::argname, generate_unaccent_rules::args, FunctionCallInfoBaseData::args, ereport, errhint(), errmsg(), ERROR, extract_variadic_args(), format_type_be(), get_arg_by_name(), i, NullableDatum::isnull, pg_strcasecmp(), stats_check_arg_type(), TextDatumGetCString, types, and NullableDatum::value.

Referenced by pg_restore_attribute_stats(), and pg_restore_relation_stats().