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