LCOV - code coverage report
Current view: top level - src/backend/statistics - stat_utils.c (source / functions) Hit Total Coverage
Test: PostgreSQL 19devel Lines: 216 236 91.5 %
Date: 2026-02-01 08:17:44 Functions: 13 13 100.0 %
Legend: Lines: hit not hit

          Line data    Source code
       1             : /*-------------------------------------------------------------------------
       2             :  * stat_utils.c
       3             :  *
       4             :  *    PostgreSQL statistics manipulation utilities.
       5             :  *
       6             :  * Code supporting the direct manipulation of statistics.
       7             :  *
       8             :  * Portions Copyright (c) 1996-2026, PostgreSQL Global Development Group
       9             :  * Portions Copyright (c) 1994, Regents of the University of California
      10             :  *
      11             :  * IDENTIFICATION
      12             :  *       src/backend/statistics/stat_utils.c
      13             :  *
      14             :  *-------------------------------------------------------------------------
      15             :  */
      16             : 
      17             : #include "postgres.h"
      18             : 
      19             : #include "access/htup_details.h"
      20             : #include "access/relation.h"
      21             : #include "catalog/index.h"
      22             : #include "catalog/namespace.h"
      23             : #include "catalog/pg_class.h"
      24             : #include "catalog/pg_collation.h"
      25             : #include "catalog/pg_database.h"
      26             : #include "catalog/pg_statistic.h"
      27             : #include "funcapi.h"
      28             : #include "miscadmin.h"
      29             : #include "nodes/nodeFuncs.h"
      30             : #include "statistics/stat_utils.h"
      31             : #include "storage/lmgr.h"
      32             : #include "utils/acl.h"
      33             : #include "utils/array.h"
      34             : #include "utils/builtins.h"
      35             : #include "utils/lsyscache.h"
      36             : #include "utils/rel.h"
      37             : #include "utils/syscache.h"
      38             : #include "utils/typcache.h"
      39             : 
      40             : /* Default values assigned to new pg_statistic tuples. */
      41             : #define DEFAULT_STATATT_NULL_FRAC      Float4GetDatum(0.0)  /* stanullfrac */
      42             : #define DEFAULT_STATATT_AVG_WIDTH      Int32GetDatum(0) /* stawidth, same as
      43             :                                                          * unknown */
      44             : #define DEFAULT_STATATT_N_DISTINCT     Float4GetDatum(0.0)  /* stadistinct, same as
      45             :                                                              * unknown */
      46             : 
      47             : static Node *statatt_get_index_expr(Relation rel, int attnum);
      48             : 
      49             : /*
      50             :  * Ensure that a given argument is not null.
      51             :  */
      52             : void
      53       10068 : stats_check_required_arg(FunctionCallInfo fcinfo,
      54             :                          struct StatsArgInfo *arginfo,
      55             :                          int argnum)
      56             : {
      57       10068 :     if (PG_ARGISNULL(argnum))
      58         108 :         ereport(ERROR,
      59             :                 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
      60             :                  errmsg("argument \"%s\" must not be null",
      61             :                         arginfo[argnum].argname)));
      62        9960 : }
      63             : 
      64             : /*
      65             :  * Check that argument is either NULL or a one dimensional array with no
      66             :  * NULLs.
      67             :  *
      68             :  * If a problem is found, emit a WARNING, and return false. Otherwise return
      69             :  * true.
      70             :  */
      71             : bool
      72        4128 : stats_check_arg_array(FunctionCallInfo fcinfo,
      73             :                       struct StatsArgInfo *arginfo,
      74             :                       int argnum)
      75             : {
      76             :     ArrayType  *arr;
      77             : 
      78        4128 :     if (PG_ARGISNULL(argnum))
      79        3400 :         return true;
      80             : 
      81         728 :     arr = DatumGetArrayTypeP(PG_GETARG_DATUM(argnum));
      82             : 
      83         728 :     if (ARR_NDIM(arr) != 1)
      84             :     {
      85           0 :         ereport(WARNING,
      86             :                 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
      87             :                  errmsg("argument \"%s\" must not be a multidimensional array",
      88             :                         arginfo[argnum].argname)));
      89           0 :         return false;
      90             :     }
      91             : 
      92         728 :     if (array_contains_nulls(arr))
      93             :     {
      94           6 :         ereport(WARNING,
      95             :                 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
      96             :                  errmsg("argument \"%s\" array must not contain null values",
      97             :                         arginfo[argnum].argname)));
      98           6 :         return false;
      99             :     }
     100             : 
     101         722 :     return true;
     102             : }
     103             : 
     104             : /*
     105             :  * Enforce parameter pairs that must be specified together (or not at all) for
     106             :  * a particular stakind, such as most_common_vals and most_common_freqs for
     107             :  * STATISTIC_KIND_MCV.
     108             :  *
     109             :  * If a problem is found, emit a WARNING, and return false. Otherwise return
     110             :  * true.
     111             :  */
     112             : bool
     113        4128 : stats_check_arg_pair(FunctionCallInfo fcinfo,
     114             :                      struct StatsArgInfo *arginfo,
     115             :                      int argnum1, int argnum2)
     116             : {
     117        4128 :     if (PG_ARGISNULL(argnum1) && PG_ARGISNULL(argnum2))
     118        3378 :         return true;
     119             : 
     120         750 :     if (PG_ARGISNULL(argnum1) || PG_ARGISNULL(argnum2))
     121             :     {
     122          42 :         int         nullarg = PG_ARGISNULL(argnum1) ? argnum1 : argnum2;
     123          42 :         int         otherarg = PG_ARGISNULL(argnum1) ? argnum2 : argnum1;
     124             : 
     125          42 :         ereport(WARNING,
     126             :                 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
     127             :                  errmsg("argument \"%s\" must be specified when argument \"%s\" is specified",
     128             :                         arginfo[nullarg].argname,
     129             :                         arginfo[otherarg].argname)));
     130             : 
     131          42 :         return false;
     132             :     }
     133             : 
     134         708 :     return true;
     135             : }
     136             : 
     137             : /*
     138             :  * A role has privileges to set statistics on the relation if any of the
     139             :  * following are true:
     140             :  *   - the role owns the current database and the relation is not shared
     141             :  *   - the role has the MAINTAIN privilege on the relation
     142             :  */
     143             : void
     144        3846 : RangeVarCallbackForStats(const RangeVar *relation,
     145             :                          Oid relId, Oid oldRelId, void *arg)
     146             : {
     147        3846 :     Oid        *locked_oid = (Oid *) arg;
     148        3846 :     Oid         table_oid = relId;
     149             :     HeapTuple   tuple;
     150             :     Form_pg_class form;
     151             :     char        relkind;
     152             : 
     153             :     /*
     154             :      * If we previously locked some other index's heap, and the name we're
     155             :      * looking up no longer refers to that relation, release the now-useless
     156             :      * lock.
     157             :      */
     158        3846 :     if (relId != oldRelId && OidIsValid(*locked_oid))
     159             :     {
     160           0 :         UnlockRelationOid(*locked_oid, ShareUpdateExclusiveLock);
     161           0 :         *locked_oid = InvalidOid;
     162             :     }
     163             : 
     164             :     /* If the relation does not exist, there's nothing more to do. */
     165        3846 :     if (!OidIsValid(relId))
     166          24 :         return;
     167             : 
     168             :     /* If the relation does exist, check whether it's an index. */
     169        3822 :     relkind = get_rel_relkind(relId);
     170        3822 :     if (relkind == RELKIND_INDEX ||
     171             :         relkind == RELKIND_PARTITIONED_INDEX)
     172         600 :         table_oid = IndexGetRelation(relId, false);
     173             : 
     174             :     /*
     175             :      * If retrying yields the same OID, there are a couple of extremely
     176             :      * unlikely scenarios we need to handle.
     177             :      */
     178        3822 :     if (relId == oldRelId)
     179             :     {
     180             :         /*
     181             :          * If a previous lookup found an index, but the current lookup did
     182             :          * not, the index was dropped and the OID was reused for something
     183             :          * else between lookups.  In theory, we could simply drop our lock on
     184             :          * the index's parent table and proceed, but in the interest of
     185             :          * avoiding complexity, we just error.
     186             :          */
     187           4 :         if (table_oid == relId && OidIsValid(*locked_oid))
     188           0 :             ereport(ERROR,
     189             :                     (errcode(ERRCODE_UNDEFINED_OBJECT),
     190             :                      errmsg("index \"%s\" was concurrently dropped",
     191             :                             relation->relname)));
     192             : 
     193             :         /*
     194             :          * If the current lookup found an index but a previous lookup either
     195             :          * did not find an index or found one with a different parent
     196             :          * relation, the relation was dropped and the OID was reused for an
     197             :          * index between lookups.  RangeVarGetRelidExtended() will have
     198             :          * already locked the index at this point, so we can't just lock the
     199             :          * newly discovered parent table OID without risking deadlock.  As
     200             :          * above, we just error in this case.
     201             :          */
     202           4 :         if (table_oid != relId && table_oid != *locked_oid)
     203           0 :             ereport(ERROR,
     204             :                     (errcode(ERRCODE_UNDEFINED_OBJECT),
     205             :                      errmsg("index \"%s\" was concurrently created",
     206             :                             relation->relname)));
     207             :     }
     208             : 
     209        3822 :     tuple = SearchSysCache1(RELOID, ObjectIdGetDatum(table_oid));
     210        3822 :     if (!HeapTupleIsValid(tuple))
     211           0 :         elog(ERROR, "cache lookup failed for OID %u", table_oid);
     212        3822 :     form = (Form_pg_class) GETSTRUCT(tuple);
     213             : 
     214             :     /* the relkinds that can be used with ANALYZE */
     215        3822 :     switch (form->relkind)
     216             :     {
     217        3804 :         case RELKIND_RELATION:
     218             :         case RELKIND_MATVIEW:
     219             :         case RELKIND_FOREIGN_TABLE:
     220             :         case RELKIND_PARTITIONED_TABLE:
     221        3804 :             break;
     222          18 :         default:
     223          18 :             ereport(ERROR,
     224             :                     (errcode(ERRCODE_WRONG_OBJECT_TYPE),
     225             :                      errmsg("cannot modify statistics for relation \"%s\"",
     226             :                             NameStr(form->relname)),
     227             :                      errdetail_relkind_not_supported(form->relkind)));
     228             :     }
     229             : 
     230        3804 :     if (form->relisshared)
     231           0 :         ereport(ERROR,
     232             :                 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
     233             :                  errmsg("cannot modify statistics for shared relation")));
     234             : 
     235             :     /* Check permissions */
     236        3804 :     if (!object_ownercheck(DatabaseRelationId, MyDatabaseId, GetUserId()))
     237             :     {
     238          24 :         AclResult   aclresult = pg_class_aclcheck(table_oid,
     239             :                                                   GetUserId(),
     240             :                                                   ACL_MAINTAIN);
     241             : 
     242          24 :         if (aclresult != ACLCHECK_OK)
     243          12 :             aclcheck_error(aclresult,
     244          12 :                            get_relkind_objtype(form->relkind),
     245          12 :                            NameStr(form->relname));
     246             :     }
     247             : 
     248        3792 :     ReleaseSysCache(tuple);
     249             : 
     250             :     /* Lock heap before index to avoid deadlock. */
     251        3792 :     if (relId != oldRelId && table_oid != relId)
     252             :     {
     253         600 :         LockRelationOid(table_oid, ShareUpdateExclusiveLock);
     254         600 :         *locked_oid = table_oid;
     255             :     }
     256             : }
     257             : 
     258             : 
     259             : /*
     260             :  * Find the argument number for the given argument name, returning -1 if not
     261             :  * found.
     262             :  */
     263             : static int
     264       27182 : get_arg_by_name(const char *argname, struct StatsArgInfo *arginfo)
     265             : {
     266             :     int         argnum;
     267             : 
     268      129918 :     for (argnum = 0; arginfo[argnum].argname != NULL; argnum++)
     269      129906 :         if (pg_strcasecmp(argname, arginfo[argnum].argname) == 0)
     270       27170 :             return argnum;
     271             : 
     272          12 :     ereport(WARNING,
     273             :             (errmsg("unrecognized argument name: \"%s\"", argname)));
     274             : 
     275          12 :     return -1;
     276             : }
     277             : 
     278             : /*
     279             :  * Ensure that a given argument matched the expected type.
     280             :  */
     281             : static bool
     282       27170 : stats_check_arg_type(const char *argname, Oid argtype, Oid expectedtype)
     283             : {
     284       27170 :     if (argtype != expectedtype)
     285             :     {
     286          24 :         ereport(WARNING,
     287             :                 (errmsg("argument \"%s\" has type %s, expected type %s",
     288             :                         argname, format_type_be(argtype),
     289             :                         format_type_be(expectedtype))));
     290          24 :         return false;
     291             :     }
     292             : 
     293       27146 :     return true;
     294             : }
     295             : 
     296             : /*
     297             :  * Check if attribute of an index is an expression, then retrieve the
     298             :  * expression if is it the case.
     299             :  *
     300             :  * If the attnum specified is known to be an expression, then we must
     301             :  * walk the list attributes up to the specified attnum to get the right
     302             :  * expression.
     303             :  */
     304             : static Node *
     305        1376 : statatt_get_index_expr(Relation rel, int attnum)
     306             : {
     307             :     List       *index_exprs;
     308             :     ListCell   *indexpr_item;
     309             : 
     310             :     /* relation is not an index */
     311        1376 :     if (rel->rd_rel->relkind != RELKIND_INDEX &&
     312        1362 :         rel->rd_rel->relkind != RELKIND_PARTITIONED_INDEX)
     313        1362 :         return NULL;
     314             : 
     315          14 :     index_exprs = RelationGetIndexExpressions(rel);
     316             : 
     317             :     /* index has no expressions to give */
     318          14 :     if (index_exprs == NIL)
     319           0 :         return NULL;
     320             : 
     321             :     /*
     322             :      * The index's attnum points directly to a relation attnum, hence it is
     323             :      * not an expression attribute.
     324             :      */
     325          14 :     if (rel->rd_index->indkey.values[attnum - 1] != 0)
     326           0 :         return NULL;
     327             : 
     328          14 :     indexpr_item = list_head(rel->rd_indexprs);
     329             : 
     330          14 :     for (int i = 0; i < attnum - 1; i++)
     331           0 :         if (rel->rd_index->indkey.values[i] == 0)
     332           0 :             indexpr_item = lnext(rel->rd_indexprs, indexpr_item);
     333             : 
     334          14 :     if (indexpr_item == NULL)   /* shouldn't happen */
     335           0 :         elog(ERROR, "too few entries in indexprs list");
     336             : 
     337          14 :     return (Node *) lfirst(indexpr_item);
     338             : }
     339             : 
     340             : /*
     341             :  * Translate variadic argument pairs from 'pairs_fcinfo' into a
     342             :  * 'positional_fcinfo' appropriate for calling relation_statistics_update() or
     343             :  * attribute_statistics_update() with positional arguments.
     344             :  *
     345             :  * Caller should have already initialized positional_fcinfo with a size
     346             :  * appropriate for calling the intended positional function, and arginfo
     347             :  * should also match the intended positional function.
     348             :  */
     349             : bool
     350        3860 : stats_fill_fcinfo_from_arg_pairs(FunctionCallInfo pairs_fcinfo,
     351             :                                  FunctionCallInfo positional_fcinfo,
     352             :                                  struct StatsArgInfo *arginfo)
     353             : {
     354             :     Datum      *args;
     355             :     bool       *argnulls;
     356             :     Oid        *types;
     357             :     int         nargs;
     358        3860 :     bool        result = true;
     359             : 
     360             :     /* clear positional args */
     361       45172 :     for (int i = 0; arginfo[i].argname != NULL; i++)
     362             :     {
     363       41312 :         positional_fcinfo->args[i].value = (Datum) 0;
     364       41312 :         positional_fcinfo->args[i].isnull = true;
     365             :     }
     366             : 
     367        3860 :     nargs = extract_variadic_args(pairs_fcinfo, 0, true,
     368             :                                   &args, &types, &argnulls);
     369             : 
     370        3860 :     if (nargs % 2 != 0)
     371           6 :         ereport(ERROR,
     372             :                 errmsg("variadic arguments must be name/value pairs"),
     373             :                 errhint("Provide an even number of variadic arguments that can be divided into pairs."));
     374             : 
     375             :     /*
     376             :      * For each argument name/value pair, find corresponding positional
     377             :      * argument for the argument name, and assign the argument value to
     378             :      * positional_fcinfo.
     379             :      */
     380       34680 :     for (int i = 0; i < nargs; i += 2)
     381             :     {
     382             :         int         argnum;
     383             :         char       *argname;
     384             : 
     385       30832 :         if (argnulls[i])
     386           6 :             ereport(ERROR,
     387             :                     (errmsg("name at variadic position %d is null", i + 1)));
     388             : 
     389       30826 :         if (types[i] != TEXTOID)
     390           0 :             ereport(ERROR,
     391             :                     (errmsg("name at variadic position %d has type %s, expected type %s",
     392             :                             i + 1, format_type_be(types[i]),
     393             :                             format_type_be(TEXTOID))));
     394             : 
     395       30826 :         if (argnulls[i + 1])
     396         306 :             continue;
     397             : 
     398       30520 :         argname = TextDatumGetCString(args[i]);
     399             : 
     400             :         /*
     401             :          * The 'version' argument is a special case, not handled by arginfo
     402             :          * because it's not a valid positional argument.
     403             :          *
     404             :          * For now, 'version' is accepted but ignored. In the future it can be
     405             :          * used to interpret older statistics properly.
     406             :          */
     407       30520 :         if (pg_strcasecmp(argname, "version") == 0)
     408        3338 :             continue;
     409             : 
     410       27182 :         argnum = get_arg_by_name(argname, arginfo);
     411             : 
     412       54352 :         if (argnum < 0 || !stats_check_arg_type(argname, types[i + 1],
     413       27170 :                                                 arginfo[argnum].argtype))
     414             :         {
     415          36 :             result = false;
     416          36 :             continue;
     417             :         }
     418             : 
     419       27146 :         positional_fcinfo->args[argnum].value = args[i + 1];
     420       27146 :         positional_fcinfo->args[argnum].isnull = false;
     421             :     }
     422             : 
     423        3848 :     return result;
     424             : }
     425             : 
     426             : /*
     427             :  * Derive type information from a relation attribute.
     428             :  *
     429             :  * This is needed for setting most slot statistics for all data types.
     430             :  *
     431             :  * This duplicates the logic in examine_attribute() but it will not skip the
     432             :  * attribute if the attstattarget is 0.
     433             :  *
     434             :  * This information, retrieved from pg_attribute and pg_type with some
     435             :  * specific handling for index expressions, is a prerequisite to calling
     436             :  * any of the other statatt_*() functions.
     437             :  */
     438             : void
     439        1376 : statatt_get_type(Oid reloid, AttrNumber attnum,
     440             :                  Oid *atttypid, int32 *atttypmod,
     441             :                  char *atttyptype, Oid *atttypcoll,
     442             :                  Oid *eq_opr, Oid *lt_opr)
     443             : {
     444        1376 :     Relation    rel = relation_open(reloid, AccessShareLock);
     445             :     Form_pg_attribute attr;
     446             :     HeapTuple   atup;
     447             :     Node       *expr;
     448             :     TypeCacheEntry *typcache;
     449             : 
     450        1376 :     atup = SearchSysCache2(ATTNUM, ObjectIdGetDatum(reloid),
     451             :                            Int16GetDatum(attnum));
     452             : 
     453             :     /* Attribute not found */
     454        1376 :     if (!HeapTupleIsValid(atup))
     455           0 :         ereport(ERROR,
     456             :                 (errcode(ERRCODE_UNDEFINED_COLUMN),
     457             :                  errmsg("column %d of relation \"%s\" does not exist",
     458             :                         attnum, RelationGetRelationName(rel))));
     459             : 
     460        1376 :     attr = (Form_pg_attribute) GETSTRUCT(atup);
     461             : 
     462        1376 :     if (attr->attisdropped)
     463           0 :         ereport(ERROR,
     464             :                 (errcode(ERRCODE_UNDEFINED_COLUMN),
     465             :                  errmsg("column %d of relation \"%s\" does not exist",
     466             :                         attnum, RelationGetRelationName(rel))));
     467             : 
     468        1376 :     expr = statatt_get_index_expr(rel, attr->attnum);
     469             : 
     470             :     /*
     471             :      * When analyzing an expression index, believe the expression tree's type
     472             :      * not the column datatype --- the latter might be the opckeytype storage
     473             :      * type of the opclass, which is not interesting for our purposes.  This
     474             :      * mimics the behavior of examine_attribute().
     475             :      */
     476        1376 :     if (expr == NULL)
     477             :     {
     478        1362 :         *atttypid = attr->atttypid;
     479        1362 :         *atttypmod = attr->atttypmod;
     480        1362 :         *atttypcoll = attr->attcollation;
     481             :     }
     482             :     else
     483             :     {
     484          14 :         *atttypid = exprType(expr);
     485          14 :         *atttypmod = exprTypmod(expr);
     486             : 
     487          14 :         if (OidIsValid(attr->attcollation))
     488           0 :             *atttypcoll = attr->attcollation;
     489             :         else
     490          14 :             *atttypcoll = exprCollation(expr);
     491             :     }
     492        1376 :     ReleaseSysCache(atup);
     493             : 
     494             :     /*
     495             :      * If it's a multirange, step down to the range type, as is done by
     496             :      * multirange_typanalyze().
     497             :      */
     498        1376 :     if (type_is_multirange(*atttypid))
     499           8 :         *atttypid = get_multirange_range(*atttypid);
     500             : 
     501             :     /* finds the right operators even if atttypid is a domain */
     502        1376 :     typcache = lookup_type_cache(*atttypid, TYPECACHE_LT_OPR | TYPECACHE_EQ_OPR);
     503        1376 :     *atttyptype = typcache->typtype;
     504        1376 :     *eq_opr = typcache->eq_opr;
     505        1376 :     *lt_opr = typcache->lt_opr;
     506             : 
     507             :     /*
     508             :      * Special case: collation for tsvector is DEFAULT_COLLATION_OID. See
     509             :      * compute_tsvector_stats().
     510             :      */
     511        1376 :     if (*atttypid == TSVECTOROID)
     512           2 :         *atttypcoll = DEFAULT_COLLATION_OID;
     513             : 
     514        1376 :     relation_close(rel, NoLock);
     515        1376 : }
     516             : 
     517             : /*
     518             :  * Derive element type information from the attribute type.  This information
     519             :  * is needed when the given type is one that contains elements of other types.
     520             :  *
     521             :  * The atttypid and atttyptype should be derived from a previous call to
     522             :  * statatt_get_type().
     523             :  */
     524             : bool
     525          52 : statatt_get_elem_type(Oid atttypid, char atttyptype,
     526             :                       Oid *elemtypid, Oid *elem_eq_opr)
     527             : {
     528             :     TypeCacheEntry *elemtypcache;
     529             : 
     530          52 :     if (atttypid == TSVECTOROID)
     531             :     {
     532             :         /*
     533             :          * Special case: element type for tsvector is text. See
     534             :          * compute_tsvector_stats().
     535             :          */
     536           2 :         *elemtypid = TEXTOID;
     537             :     }
     538             :     else
     539             :     {
     540             :         /* find underlying element type through any domain */
     541          50 :         *elemtypid = get_base_element_type(atttypid);
     542             :     }
     543             : 
     544          52 :     if (!OidIsValid(*elemtypid))
     545          18 :         return false;
     546             : 
     547             :     /* finds the right operator even if elemtypid is a domain */
     548          34 :     elemtypcache = lookup_type_cache(*elemtypid, TYPECACHE_EQ_OPR);
     549          34 :     if (!OidIsValid(elemtypcache->eq_opr))
     550           0 :         return false;
     551             : 
     552          34 :     *elem_eq_opr = elemtypcache->eq_opr;
     553             : 
     554          34 :     return true;
     555             : }
     556             : 
     557             : /*
     558             :  * Build an array with element type elemtypid from a text datum, used as
     559             :  * value of an attribute in a tuple to-be-inserted into pg_statistic.
     560             :  *
     561             :  * The typid and typmod should be derived from a previous call to
     562             :  * statatt_get_type().
     563             :  *
     564             :  * If an error is encountered, capture it and throw a WARNING, with "ok" set
     565             :  * to false.  If the resulting array contains NULLs, raise a WARNING and
     566             :  * set "ok" to false.  When the operation succeeds, set "ok" to true.
     567             :  */
     568             : Datum
     569        1330 : statatt_build_stavalues(const char *staname, FmgrInfo *array_in, Datum d, Oid typid,
     570             :                         int32 typmod, bool *ok)
     571             : {
     572        1330 :     LOCAL_FCINFO(fcinfo, 8);
     573             :     char       *s;
     574             :     Datum       result;
     575        1330 :     ErrorSaveContext escontext = {T_ErrorSaveContext};
     576             : 
     577        1330 :     escontext.details_wanted = true;
     578             : 
     579        1330 :     s = TextDatumGetCString(d);
     580             : 
     581        1330 :     InitFunctionCallInfoData(*fcinfo, array_in, 3, InvalidOid,
     582             :                              (Node *) &escontext, NULL);
     583             : 
     584        1330 :     fcinfo->args[0].value = CStringGetDatum(s);
     585        1330 :     fcinfo->args[0].isnull = false;
     586        1330 :     fcinfo->args[1].value = ObjectIdGetDatum(typid);
     587        1330 :     fcinfo->args[1].isnull = false;
     588        1330 :     fcinfo->args[2].value = Int32GetDatum(typmod);
     589        1330 :     fcinfo->args[2].isnull = false;
     590             : 
     591        1330 :     result = FunctionCallInvoke(fcinfo);
     592             : 
     593        1330 :     pfree(s);
     594             : 
     595        1330 :     if (escontext.error_occurred)
     596             :     {
     597           6 :         escontext.error_data->elevel = WARNING;
     598           6 :         ThrowErrorData(escontext.error_data);
     599           6 :         *ok = false;
     600           6 :         return (Datum) 0;
     601             :     }
     602             : 
     603        1324 :     if (array_contains_nulls(DatumGetArrayTypeP(result)))
     604             :     {
     605           6 :         ereport(WARNING,
     606             :                 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
     607             :                  errmsg("\"%s\" array must not contain null values", staname)));
     608           6 :         *ok = false;
     609           6 :         return (Datum) 0;
     610             :     }
     611             : 
     612        1318 :     *ok = true;
     613             : 
     614        1318 :     return result;
     615             : }
     616             : 
     617             : /*
     618             :  * Find and update the slot of a stakind, or use the first empty slot.
     619             :  *
     620             :  * Core statistics types expect the stakind value to be one of the
     621             :  * STATISTIC_KIND_* constants defined in pg_statistic.h, but types defined
     622             :  * by extensions are not restricted to those values.
     623             :  *
     624             :  * In the case of core statistics, the required staop is determined by the
     625             :  * stakind given and will either be a hardcoded oid, or the eq/lt operator
     626             :  * derived from statatt_get_type().  Likewise, types defined by extensions
     627             :  * have no such restriction.
     628             :  *
     629             :  * The stacoll value should be either the atttypcoll derived from
     630             :  * statatt_get_type(), or a hardcoded value required by that particular
     631             :  * stakind.
     632             :  *
     633             :  * The value/null pairs for stanumbers and stavalues should be calculated
     634             :  * based on the stakind, using statatt_build_stavalues() or constructed arrays.
     635             :  */
     636             : void
     637        2496 : statatt_set_slot(Datum *values, bool *nulls, bool *replaces,
     638             :                  int16 stakind, Oid staop, Oid stacoll,
     639             :                  Datum stanumbers, bool stanumbers_isnull,
     640             :                  Datum stavalues, bool stavalues_isnull)
     641             : {
     642             :     int         slotidx;
     643        2496 :     int         first_empty = -1;
     644             :     AttrNumber  stakind_attnum;
     645             :     AttrNumber  staop_attnum;
     646             :     AttrNumber  stacoll_attnum;
     647             : 
     648             :     /* find existing slot with given stakind */
     649       14976 :     for (slotidx = 0; slotidx < STATISTIC_NUM_SLOTS; slotidx++)
     650             :     {
     651       12480 :         stakind_attnum = Anum_pg_statistic_stakind1 - 1 + slotidx;
     652             : 
     653       16420 :         if (first_empty < 0 &&
     654        3940 :             DatumGetInt16(values[stakind_attnum]) == 0)
     655        2496 :             first_empty = slotidx;
     656       12480 :         if (DatumGetInt16(values[stakind_attnum]) == stakind)
     657           0 :             break;
     658             :     }
     659             : 
     660        2496 :     if (slotidx >= STATISTIC_NUM_SLOTS && first_empty >= 0)
     661        2496 :         slotidx = first_empty;
     662             : 
     663        2496 :     if (slotidx >= STATISTIC_NUM_SLOTS)
     664           0 :         ereport(ERROR,
     665             :                 (errmsg("maximum number of statistics slots exceeded: %d",
     666             :                         slotidx + 1)));
     667             : 
     668        2496 :     stakind_attnum = Anum_pg_statistic_stakind1 - 1 + slotidx;
     669        2496 :     staop_attnum = Anum_pg_statistic_staop1 - 1 + slotidx;
     670        2496 :     stacoll_attnum = Anum_pg_statistic_stacoll1 - 1 + slotidx;
     671             : 
     672        2496 :     if (DatumGetInt16(values[stakind_attnum]) != stakind)
     673             :     {
     674        2496 :         values[stakind_attnum] = Int16GetDatum(stakind);
     675        2496 :         replaces[stakind_attnum] = true;
     676             :     }
     677        2496 :     if (DatumGetObjectId(values[staop_attnum]) != staop)
     678             :     {
     679        2472 :         values[staop_attnum] = ObjectIdGetDatum(staop);
     680        2472 :         replaces[staop_attnum] = true;
     681             :     }
     682        2496 :     if (DatumGetObjectId(values[stacoll_attnum]) != stacoll)
     683             :     {
     684         644 :         values[stacoll_attnum] = ObjectIdGetDatum(stacoll);
     685         644 :         replaces[stacoll_attnum] = true;
     686             :     }
     687        2496 :     if (!stanumbers_isnull)
     688             :     {
     689        1862 :         values[Anum_pg_statistic_stanumbers1 - 1 + slotidx] = stanumbers;
     690        1862 :         nulls[Anum_pg_statistic_stanumbers1 - 1 + slotidx] = false;
     691        1862 :         replaces[Anum_pg_statistic_stanumbers1 - 1 + slotidx] = true;
     692             :     }
     693        2496 :     if (!stavalues_isnull)
     694             :     {
     695        1318 :         values[Anum_pg_statistic_stavalues1 - 1 + slotidx] = stavalues;
     696        1318 :         nulls[Anum_pg_statistic_stavalues1 - 1 + slotidx] = false;
     697        1318 :         replaces[Anum_pg_statistic_stavalues1 - 1 + slotidx] = true;
     698             :     }
     699        2496 : }
     700             : 
     701             : /*
     702             :  * Initialize values and nulls for a new pg_statistic tuple.
     703             :  *
     704             :  * The caller is responsible for allocating the arrays where the results are
     705             :  * stored, which should be of size Natts_pg_statistic.
     706             :  *
     707             :  * When using this routine for a tuple inserted into pg_statistic, reloid,
     708             :  * attnum and inherited flags should all be set.
     709             :  *
     710             :  * When using this routine for a tuple that is an element of a stxdexpr
     711             :  * array inserted into pg_statistic_ext_data, reloid, attnum and inherited
     712             :  * should be respectively set to InvalidOid, InvalidAttrNumber and false.
     713             :  */
     714             : void
     715        1250 : statatt_init_empty_tuple(Oid reloid, int16 attnum, bool inherited,
     716             :                          Datum *values, bool *nulls, bool *replaces)
     717             : {
     718        1250 :     memset(nulls, true, sizeof(bool) * Natts_pg_statistic);
     719        1250 :     memset(replaces, true, sizeof(bool) * Natts_pg_statistic);
     720             : 
     721             :     /* This must initialize non-NULL attributes */
     722        1250 :     values[Anum_pg_statistic_starelid - 1] = ObjectIdGetDatum(reloid);
     723        1250 :     nulls[Anum_pg_statistic_starelid - 1] = false;
     724        1250 :     values[Anum_pg_statistic_staattnum - 1] = Int16GetDatum(attnum);
     725        1250 :     nulls[Anum_pg_statistic_staattnum - 1] = false;
     726        1250 :     values[Anum_pg_statistic_stainherit - 1] = BoolGetDatum(inherited);
     727        1250 :     nulls[Anum_pg_statistic_stainherit - 1] = false;
     728             : 
     729        1250 :     values[Anum_pg_statistic_stanullfrac - 1] = DEFAULT_STATATT_NULL_FRAC;
     730        1250 :     nulls[Anum_pg_statistic_stanullfrac - 1] = false;
     731        1250 :     values[Anum_pg_statistic_stawidth - 1] = DEFAULT_STATATT_AVG_WIDTH;
     732        1250 :     nulls[Anum_pg_statistic_stawidth - 1] = false;
     733        1250 :     values[Anum_pg_statistic_stadistinct - 1] = DEFAULT_STATATT_N_DISTINCT;
     734        1250 :     nulls[Anum_pg_statistic_stadistinct - 1] = false;
     735             : 
     736             :     /* initialize stakind, staop, and stacoll slots */
     737        7500 :     for (int slotnum = 0; slotnum < STATISTIC_NUM_SLOTS; slotnum++)
     738             :     {
     739        6250 :         values[Anum_pg_statistic_stakind1 + slotnum - 1] = (Datum) 0;
     740        6250 :         nulls[Anum_pg_statistic_stakind1 + slotnum - 1] = false;
     741        6250 :         values[Anum_pg_statistic_staop1 + slotnum - 1] = ObjectIdGetDatum(InvalidOid);
     742        6250 :         nulls[Anum_pg_statistic_staop1 + slotnum - 1] = false;
     743        6250 :         values[Anum_pg_statistic_stacoll1 + slotnum - 1] = ObjectIdGetDatum(InvalidOid);
     744        6250 :         nulls[Anum_pg_statistic_stacoll1 + slotnum - 1] = false;
     745             :     }
     746        1250 : }

Generated by: LCOV version 1.16